From 79b90cecdf83c6ae17162eff4b847ef9f3449865 Mon Sep 17 00:00:00 2001 From: William Yardley Date: Fri, 16 Aug 2024 14:49:33 -0700 Subject: [PATCH] docs: add note about acceptance tests While it is probably obvious, it may be good to provide a reminder to people about acceptance tests, to make sure they understand to use a temporary / sandbox project, and to keep an eye out for stray resources. For folks outside of Google's ecosystem, this is probably particularly important, especially as some tests create resources that can generate significant costs. --- docs/content/develop/test/run-tests.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/docs/content/develop/test/run-tests.md b/docs/content/develop/test/run-tests.md index 0165ac976b8b..2b8d50d31803 100644 --- a/docs/content/develop/test/run-tests.md +++ b/docs/content/develop/test/run-tests.md @@ -62,7 +62,8 @@ aliases: make testacc TEST=./google/services/container TESTARGS='-run=TestAccContainerNodePool' ``` - +> [!NOTE] +> Acceptance tests create actual infrastructure which can incur costs. Acceptance tests may not clean up after themselves if interrupted, so you may want to check for stray resources and / or billing charges. 1. Optional: Save verbose test output (including API requests and responses) to a file for analysis. @@ -89,14 +90,13 @@ aliases: make lint ``` - 1. Run acceptance tests for only modified resources. (Full test runs can take over 9 hours.) See [Go's documentation](https://pkg.go.dev/cmd/go#hdr-Testing_flags) for more information about `-run` and other flags. ```bash make testacc TEST=./google-beta/services/container TESTARGS='-run=TestAccContainerNodePool' ``` - - +> [!NOTE] +> Acceptance tests create actual infrastructure which can incur costs. Acceptance tests may not clean up after themselves if interrupted, so you may want to check for stray resources and / or billing charges. 1. Optional: Save verbose test output to a file for analysis. @@ -238,7 +238,6 @@ Configure Terraform to use locally-built binaries for `google` and `google-beta` ### Run manual tests - 1. [Generate the provider(s) you want to test]({{< ref "/get-started/generate-providers" >}}) 2. Build the provider(s) you want to test @@ -291,6 +290,5 @@ To stop using developer overrides, stop setting `TF_CLI_CONFIG_FILE` in the comm Terraform will resume its normal behaviour of pulling published provider versions from the public Registry. Any version constraints in your Terraform configuration will come back into effect. Also, you may need to run `terraform init` to download the required version of the provider into your project directory if you haven't already. - ## What's next? - [Create a pull request]({{< ref "/contribute/create-pr" >}})