2022-03-15 12:42:43 +00:00
|
|
|
# Writing Tests
|
|
|
|
|
|
|
|
|
|
The Nomad repository strives to maintain comprehensive unit test coverage. Any new
|
|
|
|
|
features, bug fixes, or refactoring should include additional or updated test cases
|
|
|
|
|
demonstrating correct functionality.
|
|
|
|
|
|
|
|
|
|
Each unit test should meet a few criteria:
|
|
|
|
|
|
|
|
|
|
- Use testify
|
|
|
|
|
- Prefer using require.* functions
|
|
|
|
|
|
|
|
|
|
- Undo any changes to the environment
|
|
|
|
|
- Set environment variables must be unset
|
|
|
|
|
- Scratch files/dirs must be removed (use t.TempDir)
|
|
|
|
|
- Consumed ports must be freed (e.g. TestServer.Cleanup, freeport.Return)
|
|
|
|
|
|
|
|
|
|
- Able to run in parallel
|
|
|
|
|
- All package level Test* functions should start with ci.Parallel
|
|
|
|
|
- Always use dynamic scratch dirs, files
|
|
|
|
|
- Always get ports from helpers (TestServer, TestClient, TestAgent, freeport.Get)
|
|
|
|
|
|
|
|
|
|
- Log control
|
|
|
|
|
- Logging must go through the testing.T (use helper/testlog.HCLogger)
|
2022-05-16 15:12:54 +00:00
|
|
|
- Avoid excessive logging in test cases - prefer failure messages
|
|
|
|
|
|
|
|
|
|
## API tests
|
|
|
|
|
|
|
|
|
|
Testing in the `api` package requires an already-built Nomad
|
|
|
|
|
binary. If you're writing `api` tests, you'll need to build a Nomad
|
|
|
|
|
binary (ex. with `make dev`) that includes any changes your API
|
|
|
|
|
exercises.
|
