hashicorp/agent-skills

run-acceptance-tests

Guide for running acceptance tests for a Terraform provider.

查看源码
仓库原始内容

按源仓库内容呈现,保留标题、案例、代码、表格、链接以及原文引用的演示图片。

An acceptance test is a Go test function with the prefix TestAcc.

Before running: acceptance tests create real infrastructure against the provider's live API, which may incur cost. Confirm the configured credentials point at a test account before proceeding.

To run a focused acceptance test named TestAccFeatureHappyPath:

  1. Run go test -run=TestAccFeatureHappyPath -timeout 60m with the

following environment variables:

  • TF_ACC=1

Default to non-verbose test output. Always pass an explicit -timeout: go test kills any test run after 10 minutes by default, and acceptance tests routinely exceed that.

  1. The acceptance tests may require additional environment variables for

specific providers. To discover which ones:

  • Read the test's PreCheck / testAccPreCheck function and search the

test files: grep -rn "os.Getenv" --include="*_test.go".

  • Check the repository's README, CONTRIBUTING, or .env.example for

documented test setup.

  • The provider's Configure method shows how credentials are resolved;

use the provider-configuration skill (if available) to understand a credential provider chain.

Set the variables for the single test invocation (EXAMPLE_API_KEY=... TF_ACC=1 go test ...) rather than exporting them into the shell profile, and never write secret values into files inside the repository.

To diagnose a failing acceptance test, use these options, in order. These options are cumulative: each option includes all the options above it.

  1. Run the test again. Use the -count=1 option to ensure that go test does

not use a cached result.

  1. Offer verbose go test output. Use the -v option.
  2. Offer debug-level logging. Enable debug-level logging with the environment

variable TF_LOG=debug.

  1. Offer to persist the acceptance test's Terraform workspace. Enable

persistence with the environment variable TF_ACC_WORKING_DIR_PERSIST=1.

A passing acceptance test may be a false negative. To "flip" a passing acceptance test named TestAccFeatureHappyPath:

  1. Edit the value of one of the TestCheckFuncs in one of the TestSteps in the

TestCase.

  1. Run the acceptance test. Expect the test to fail.
  2. If the test fails, then undo the edit and report a successful flip. Else,

keep the edit and report an unsuccessful flip.

If a test run is interrupted, real resources may be left behind; run the provider's sweepers if it registers them (see the provider-test-patterns skill's sweeper reference, if available). For writing or restructuring tests, use the provider-test-patterns skill.

来自同一仓库

更多 Skills

全部 Skills
hashicorp
官方

aws-ami-builder

Build Amazon Machine Images (AMIs) with Packer using the amazon-ebs builder. Use when creating custom AMIs for EC2 instances.

安装量
1
GitHub Stars
864
最近更新
9月4日
hashicorp
官方

azure-image-builder

Build Azure managed images and Azure Compute Gallery images with Packer. Use when creating custom images for Azure VMs.

安装量
1
GitHub Stars
864
最近更新
9月4日
hashicorp
官方

azure-verified-modules

Azure Verified Modules (AVM) requirements and best practices for developing certified Azure Terraform modules. Use when creating or reviewing Azure modules that need AVM certification.

安装量
1
GitHub Stars
864
最近更新
9月4日
hashicorp
官方

new-terraform-provider

To scaffold a new Terraform provider with Plugin Framework: 1. If I am already in a Terraform provider workspace, then confirm that I want to create a new workspace. If I do not want to create a new workspace, then skip all remaining steps. 1. Create a new workspace root directory. The root directory name should be prefixed with "terraform provider ". Perform all subsequent steps in this new workspace. 1. Initialize a new Go module. 1. Run go get u github.com/hashicorp/terraform plugin framework@latest . 1. Write a main.go file that follows the example. 1. Write an internal/provider/provider.go file that follows the example. Rename the demo provider, the DEMO environment variables, and the authentication attributes to match the target API. 1. Remove TODO comments from main.go and provider.go . 1. Run go mod tidy 1. Run go build o /dev/null 1. Run go test ./... The scaffold resolves crede

安装量
1
GitHub Stars
864
最近更新
9月4日