Feat/service interfaces

[ciroque]

Addresses Issue #13

Uses the go generate command to run vburenin's ifacemaker that generates files containing interfaces based on the structs.

Also includes a script that writes the go:generate comment to each of the service files.

The general idea is that users of the library can now create mocks of the various Services. This ensures testing boundaries within a given code base coincide with the use of the library. That is, tests in user's code test only their code and can provide success / failure scenarios by mocking the required service and focus on the "Class Under Test".

[ciroque]

Hi @hbagdi ,

I was able to carve out some time to work on this. Finding the ifacemaker library was great. Made this pretty straightforward to accomplish.

Let me know if you would like me to change anything about the way this is done.

Thanks!

r/Steve

[hbagdi]

I had a brief look at this but I'm liking it so far! Nice job!

One key thing that is missing is to have a script to verify if the code-gen is up-to-date or not.
And then also integrate that with CI so that it can catch when a method is added to a service but not to the corresponding Interface.

[ciroque]

Would it be enough to run go generate in the travis.yml, like this:

before_install:
  - go generate ./kong

(I have not tested that yet)

[ciroque]

Oh interesting. I found this command that would fail the build if the interfaces were out of sync:

go generate -x ./... && git diff --exit-code; code=$?; git checkout -- .; (exit $code)

Lifted from: https://github.com/google/go-github/blob/master/.travis.yml#L24

It would not automatically generate the new interfaces, but would kick back to the dev to run go generate and commit the interface changes...

cool?

[hbagdi]

Yes, that would work.
All we need is to ensure that CI fails a commit if there is a function added onto the struct but it is not added in the interface.

[hbagdi]

Please make sure that CI is running and detecting the changes.

[hbagdi]

Please remove this.
You can add this to your global gitignore file:
https://davidwalsh.name/global-gitignore

[hbagdi]

Where is this script being used?

[hbagdi]

This is little bit of nitpick but I think it's important.
Can we move this just above the the declaration of the service?
This helps when someone is reading only part of the code or duplicating this into another service.

This comment applies to all the generate comments.

[hbagdi]

@ciroque Friendly ping. This is almost there.

[hbagdi]

@ciroque Friendly ping.

[hbagdi]

@ciroque Another friendly ping. :)

[hbagdi]

This would have been an amazing addition to the project. If someone else wants to take this up, please feel free!