Proper package naming for testing with the Go language

by

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 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.
  • Strategy 2: The file 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]
  • Strategy 3: The file 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.

More Related Contents:

  1. Mock functions in Go
  2. Fill os.Stdin for function that reads from it
  3. Is it possible to mock a function imported from a package in golang?
  4. Testing os.Exit scenarios in Go with coverage information (coveralls.io/Goveralls)
  5. How to unit test a Go Gin handler function?
  6. Is there an easy way to stub out time.Now() globally during test?
  7. Is it possible to mock a function imported from a package?
  8. Example code for testing the filesystem in Golang
  9. What’s the difference between faking, mocking, and stubbing?
  10. What is the difference between integration and unit tests?
  11. How deep are your unit tests?
  12. When should I mock?
  13. NUnit vs. MbUnit vs. MSTest vs. xUnit.net [closed]
  14. Unit test naming best practices [closed]
  15. How to start working with GTest and CMake
  16. How do I unit-test saving file to the disk?
  17. How to terminate a program when it crashes? (which should just fail a unit test instead of getting stuck forever)
  18. Mocking $modal in AngularJS unit tests
  19. How to test Spring Data repositories?
  20. RSpec vs Cucumber (RSpec stories) [closed]
  21. How can I unit test a GUI?
  22. Mock framework vs MS Fakes frameworks
  23. Adding unit tests to legacy code [closed]
  24. Mocking AngularJS module dependencies in Jasmine unit tests
  25. Resharper runs UnitTest from different location
  26. How to mock specific methods but not all of them in Rust?
  27. How to specify test directory for mocha?
  28. Writing “unit testable” code?
  29. How do I trigger a keyup/keydown event in an angularjs unit test?
  30. Why should unit tests test only one thing?

Leave a Comment