skilld
All skills
hashicorp avatar

/run-acceptance-tests

@4451cec official
by hashicorphashicorp/agent-skills880 stars
130

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.

Ask your Agent

Use this Skill: https://skilld.dev/gh/hashicorp/agent-skills/run-acceptance-tests

This session only. Nothing lands on disk.

SKILL.md

≈74 tokens always: the name and description. ≈656 when used: this file.

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.

Source: SKILL.md on GitHub

Third-party checks

1 warning16d5 checks · Risk SAFE
  • Gen Agent Trust Hub16d

    This skill provides guidance for running and diagnosing Go acceptance tests for Terraform providers. It follows security best practices for handling sensitive credentials during test execution.

  • Socket16d

    No alerts

  • Snyk16d

    Risk: LOW · No issues

  • Runlayer7mo

    1/1 file flagged

  • ZeroLeaks5mo

    Score: 93/100 · 2 sections analyzed

Provenance

Signed by skilld at 4451cec. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub 3 days ago.

Activeupdated 2 months ago

Capability

Other metadata
metadata
{
  "lifecycle-status": "active",
  "copyright": "Copyright IBM Corp. 2026",
  "version": "0.0.1"
}

Topics

README badge

README badge for hashicorp/agent-skills/run-acceptance-tests

What it does

Runs Terraform provider acceptance tests (Go test functions prefixed with `TestAcc`) with the `TF_ACC=1` environment variable. Provides escalating diagnostics for failures using `-count=1`, `-v`, `TF_LOG=debug`, and workspace persistence, plus a method to validate test reliability by intentionally breaking assertions.

Generated from the current SKILL.md.

Frequently asked

What environment variables do I need to run acceptance tests?
At minimum, set TF_ACC=1. Provider-specific acceptance tests may require additional environment variables; the skill guides you to set these securely based on test output.
How do I run a single acceptance test?
Use `go test -run=TestAccFeatureHappyPath` with TF_ACC=1 set. The skill defaults to non-verbose output unless you add the -v flag.
What should I do if an acceptance test fails?
First re-run with -count=1 to bypass cache. If it still fails, add -v for verbose output, then enable TF_LOG=debug for debug-level logging. You can also set TF_ACC_WORKING_DIR_PERSIST=1 to keep the Terraform workspace for inspection.
What does it mean to flip a passing acceptance test?
Flipping means intentionally breaking a test by editing one of its TestCheckFuncs, re-running it to confirm it fails, then undoing the edit. This validates that the test actually catches failures rather than passing falsely.

Generated from the current SKILL.md. These answers refresh after source changes.