Proper package naming for testing with the Go language
You should use strategy 1 whenever possible. You can use the special foo_test
package name to avoid import cycles, but that's mostly there so the standard library can be tested with the same mechanism. For example, strings
cannot be tested with strategy 1 since the testing
package depends on strings
. As you said, with strategy 2 or 3 you don't have access to the package's private identifiers, so it's usually better to not use it unless you have to.
The fundamental difference between the three strategies you've listed is whether or not the test code is in the same package as the code under test. The decision to use package myfunc
or package myfunc_test
in the test file depends on whether you want to perform white-box or black-box testing.
There's nothing wrong with using both methods in a project. For instance, you could have myfunc_whitebox_test.go
and myfunx_blackbox_test.go
.
Test Code Package Comparison
- Black-box Testing: Use
package myfunc_test
, which will ensure you're only using the exported identifiers. - White-box Testing: Use
package myfunc
so that you have access to the non-exported identifiers. Good for unit tests that require access to non-exported variables, functions, and methods.
Comparison of Strategies Listed in Question
- Strategy 1: The file
myfunc_test.go
usespackage myfunc
— In this case the test code inmyfunc_test.go
will be in the same package as the code being tested inmyfunc.go
, which ismyfunc
in this example. - Strategy 2: The file
myfunc_test.go
usespackage myfunc_test
— In this case the test code inmyfunc_test.go
"will be compiled as a separate package, and then linked and run with the main test binary." [Source: Lines 58–59 in the test.go source code] - Strategy 3: The file
myfunc_test.go
usespackage myfunc_test
but importsmyfunc
using the dot notation — This is a variant of Strategy 2, but uses the dot notation to importmyfunc
.
It depends on the scope of your tests. High level tests (integration, acceptance, etc...) should probably be placed in a separate package to ensure that you are using the package via the exported API.
If you have a large package with a lot of internals that need to be put under test then use the same package for your tests. But that's not an invitation for your tests to access any bit of private state. That would make refactoring a nightmare. When I write structs in go I am often implementing interfaces. It is those interface methods that I invoke from my tests, not all of the helper methods/functions individually.