luxolus
/
open-nomad
2
0
Fork 0
Code Issues 1 Pull Requests Packages Releases Wiki Activity

docs: API package tests need a binary with your changes (#13029) 

Add a note to the contributing guide pointing out that if you're
writing `api` package tests, you need to build a binary with any of
your changes.
This commit is contained in:
Tim Gross 2022-05-16 11:12:54 -04:00 committed by GitHub
parent 703a7954f4
commit f4703ab8a3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
contributing/testing.md
View File

@ -21,4 +21,11 @@ Each unit test should meet a few criteria:
- Log control - Log control
- Logging must go through the testing.T (use helper/testlog.HCLogger) - Logging must go through the testing.T (use helper/testlog.HCLogger)
- Avoid excessive logging in test cases - prefer failure messages - 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.