run-acceptance-tests

by hashicorp

Execute and diagnose Go acceptance tests for Terraform providers with structured troubleshooting. Run focused acceptance tests using go test -run=TestAccFeatureHappyPath with TF_ACC=1 environment variable Diagnose failures progressively: retry with -count=1 , enable verbose output with -v , activate debug logging via TF_LOG=debug , and persist Terraform workspace with TF_ACC_WORKING_DIR_PERSIST=1 Validate test reliability by intentionally breaking a TestCheckFunc, re-running the test to...

npx skills add https://github.com/hashicorp/agent-skills --skill run-acceptance-tests
Download ZIPGitHub
816

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.

  2. 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.
  2. Offer verbose go test output. Use the -v option.
  3. Offer debug-level logging. Enable debug-level logging with the environment variable TF_LOG=debug.
  4. 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.
  2. Run the acceptance test. Expect the test to fail.
  3. 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.

More skills from hashicorp

provider-actions
hashicorp
Implement Terraform Provider actions using the Plugin Framework. Use when developing imperative operations that execute at lifecycle events (before/after…
official
new-terraform-provider
hashicorp
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…
official
terraform-test
hashicorp
Comprehensive guide for writing and running Terraform tests. Use when creating test files (.tftest.hcl), writing test scenarios with run blocks, validating…
official
terraform-test
hashicorp
Comprehensive guide for writing and running Terraform tests with assertions, mocking, and module validation. Write test files using .tftest.hcl syntax with run blocks that execute in plan or apply mode, supporting sequential and parallel execution with optional state isolation Assert conditions on resource attributes, outputs, and data sources; use expect_failures to validate that invalid inputs are properly rejected Mock providers (Terraform 1.7.0+) simulate infrastructure behavior without...
official
provider-actions
hashicorp
Implement imperative Terraform Provider actions at resource lifecycle events using the Plugin Framework. Supports before/after create and before/after update lifecycle triggers (destroy events not available in Terraform 1.14.0) Requires proper schema definition with correct framework types, ElementType for collections, and validators for input validation Includes progress reporting, timeout management, and comprehensive error handling for long-running operations Implements polling and...
official
aws-ami-builder
hashicorp
Build custom Amazon Machine Images with Packer's amazon-ebs builder. Automates AMI creation from source AMIs using HCL templates with provisioners for customization (shell scripts, file uploads, configuration management) Supports multi-region AMI distribution via ami_regions and flexible source AMI filtering by name, owner, and virtualization type Authenticates via environment variables, AWS credentials file, or IAM instance profiles; includes validation and build commands for template...
official
new-terraform-provider
hashicorp
Scaffold a new Terraform provider using the Plugin Framework. Generates a new Go module workspace with the standard "terraform-provider-" naming convention and initializes required dependencies Provides a template main.go file following HashiCorp's Plugin Framework patterns, with TODO markers for customization Validates the setup by running build and test commands to ensure the provider compiles and passes initial checks Handles workspace management by confirming intent before creating a new...
official
azure-verified-modules
hashicorp
Certification requirements and best practices for Azure Terraform modules seeking AVM compliance. Enforces provider version constraints (azurerm >= 4.0, < 5.0; azapi >= 2.0, < 3.0) and prohibits git-based module references in favor of pinned Terraform registry sources Mandates lower snake_casing for all identifiers, precise variable types, discrete output attributes via anti-corruption layer pattern, and alphabetically ordered locals Requires feature toggle variables for new resources added...
official