Guide for running acceptance tests for a Terraform provider. Use this when asked to run an acceptance test or to run a test with the prefix `TestAcc`, when a test fails with missing environment variables, or when diagnosing a failing or suspiciously passing acceptance test.
The English summary is being prepared. Showing the original description.
Review the instructions the agent will receive before you install.
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:
Run go test -run=TestAccFeatureHappyPath -timeout 60m with the
following environment variables:
TF_ACC=1Default 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.
The acceptance tests may require additional environment variables for specific providers. To discover which ones:
PreCheck / testAccPreCheck function and search the
test files: grep -rn "os.Getenv" --include="*_test.go"..env.example for
documented test setup.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.
-count=1 option to ensure that go test does
not use a cached result.go test output. Use the -v option.TF_LOG=debug.TF_ACC_WORKING_DIR_PERSIST=1.A passing acceptance test may be a false negative. To "flip" a passing
acceptance test named TestAccFeatureHappyPath:
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.
No reviews yet. Tell others what you thought.
No login needed. Share how it worked for you, ask a question, or note where it did not run.
No comments yet. Be the first to write one.
Build Amazon Machine Images (AMIs) with Packer using the amazon-ebs builder. Use when creating custom AMIs for EC2 instances.
The English summary is being prepared. Showing the original description.
Build Azure managed images and Azure Compute Gallery images with Packer. Use when creating custom images for Azure VMs.
The English summary is being prepared. Showing the original description.
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.
The English summary is being prepared. Showing the original description.
Use this when scaffolding a new Terraform provider with the Plugin Framework: workspace layout, go module setup, provider server main.go, and a provider.go with schema and Configure. Also use when a user wants to start building a provider for a new API or asks how to begin a terraform-provider-* project.
The English summary is being prepared. Showing the original description.
Implement Terraform Provider actions using the Plugin Framework. Use when developing imperative operations that execute at lifecycle events (before/after create, update, destroy).
The English summary is being prepared. Showing the original description.
Implement Terraform provider configuration and authentication with the Plugin Framework: provider schema for credentials (Optional + Sensitive attributes), environment variable fallbacks, credential provider chains (static config, then environment variables, shared credentials file, and platform identity), unknown-value guards in Configure(), secret redaction, configure-time credential validation, and diagnostics that name every source tried. Use when implementing or reviewing a provider's Configure method or provider schema, adding authentication options (API keys, tokens, profiles, credentials files, assume-role), deciding how a provider should resolve credentials, debugging "no valid credential sources" or missing-credentials errors, or unit testing credential resolution.
The English summary is being prepared. Showing the original description.