From db73bc84815a9bf608a6c6127aa733f87a9306de Mon Sep 17 00:00:00 2001 From: Tim Gross Date: Mon, 16 May 2022 11:12:54 -0400 Subject: [PATCH] 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. --- contributing/testing.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/contributing/testing.md b/contributing/testing.md index 178273bf0..7df1533a7 100644 --- a/contributing/testing.md +++ b/contributing/testing.md @@ -21,4 +21,11 @@ Each unit test should meet a few criteria: - Log control - Logging must go through the testing.T (use helper/testlog.HCLogger) - - Avoid excessive logging in test cases - prefer failure messages \ No newline at end of file + - 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.