Update docs and API usage in tests #2
Conversation
Style: `check` is not covered by the `flushmu` mutex.
- Standardize on using `New()` vs `NewCirconusMetrics()` - Move most of the public tests to a dedicated `_test` package to test the public interface of the package. - Stand up an `-impl_test.go` file to peak behind the curtains and test the implementation.
|
Flush is part of the public interface. I don't understand the need to break up the testing file. |
|
It's not strictly necessary to split out, but it does help expose and document the canonical usage of the public API. |
|
If it is just to isolate the access of an internal flag |
|
Totally. Like I said, feel free to reject this PR. My point was to illustrate the concept. For only two tests it's silly, but it becomes useful as you approach 100% test coverage.
|
Test the public interface in a standalone
_test.gofile and then spin off the private implementation checks into an-impl_test.gofile that has the necessary visibility. I didn't tease out the semantics of what was supposed to be happening in theTestFlush()call to see what could be split out. The intent of this PR is two fold:Flush()test it would be ideal to test in the public API test, however that would necessitate the creation of aForceFlush()method or something like that, which is the only reason I didn't keepFlush()in the public API test function.Feel free to reject this PR.