I have seen several different test package naming strategies within Go and wanted to know what pros and cons of each are and which one I should use.
Strategy 1:
File name: github.com/user/myfunc.go
package myfunc
Test file name: github.com/user/myfunc_test.go
package myfunc
See bzip2 for an example.
Strategy 2:
File name: github.com/user/myfunc.go
package myfunc
Test file name: github.com/user/myfunc_test.go
package myfunc_test
import (
"github.com/user/myfunc"
)
See wire for an example.
Strategy 3:
File name: github.com/user/myfunc.go
package myfunc
Test file name: github.com/user/myfunc_test.go
package myfunc_test
import (
. "myfunc"
)
See strings for an example.
The Go standard library seems to use a mixture of strategy 1 and 2. Which of all three should I use? It's a pain appending package *_test to my testing packages as it means I can't test my package private methods but maybe there is a hidden advantage I am not aware of?
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.
package myfunc_test, which will ensure you're only using the exported identifiers.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.myfunc_test.go uses package myfunc — In this case the test code in myfunc_test.go will be in the same package as the code being tested in myfunc.go, which is myfunc in this example.myfunc_test.go uses package myfunc_test — In this case the test code in myfunc_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]myfunc_test.go uses package myfunc_test but imports myfunc using the dot notation — This is a variant of Strategy 2, but uses the dot notation to import myfunc.Collected from the Internet
Please contact [email protected] to delete if infringement.
Comments