Lay groundwork for mocking and add initial workceptor unit tests #785
Conversation
AaronH88
force-pushed
the
mock_gen
branch
4 times, most recently
from
04424e6
to
3ae096b
Compare
pkg/workceptor/workceptor.go
Outdated
| // Netceptor is a interface to decouple workceptor from netceptor. | ||
| // it includes only the functions that netceptor uses. | ||
| // the interface name is work in progress. | ||
| type Netceptor interface { |
There was a problem hiding this comment.
The golang naming convention for interfaces is to use an er postfix, and while this works in most cases Netceptorer is difficult to read.
I originally had the interface name as a name pairing, outlining the interface relationship they represent, however WorkceptorsNetceptor while intuitive is overly verbose.
Other languages have the i convention, and while INetceptor would be easy to understand, it breaks the golang naming convention and is overly verbose, with i and interface both being written on the same line.
@shanemcd had the suggestion of using just Netceptor. It is the cleanest to look at however, not the most obvious to understand the relationship. The reader needs to understand that in order to call the concrete netceptor then namespace syntax needs to be used, e.g. netceptor.Netceptor, and also needs to understand the current package, and that this interface is implemented in the netceptor package.
I am leaning toward following Shanes suggestion, and hoping that any readers of the code base will pick up that the interface keyword is on this line and understand its special meaning.
shanemcd
changed the title
Addresses issue #796