run-acceptance-tests_skill

This skill guides you to run Terraform provider acceptance tests using TestAcc prefix with go test -run and TF_ACC, plus debugging steps.

Shell
Official

196

GitHub Stars

1

Bundled Files

2 months ago

Catalog Refreshed

4 months ago

First Indexed

Readme & install

Copy the install command, review bundled files from the catalogue, and read any extended description pulled from the listing source.

Installation

Preview and clipboard use veilstrat where the catalogue uses aiagentskills.

npx veilstrat add skill hashicorp/agent-skills --skill run-acceptance-tests

SKILL.md1.7 KB

Overview

This skill guides you through running and diagnosing acceptance tests for a Terraform provider. It focuses on tests with the TestAcc prefix and provides step-by-step commands, environment settings, and escalation options for troubleshooting. Use it when you need to run a single focused test or to debug intermittent failures.

How this skill works

Acceptance tests are Go test functions whose names start with TestAcc. To run a specific test, execute go test with -run and set TF_ACC=1 in the environment. When a test fails, follow the layered diagnostic options: re-run without cache, enable verbose output, enable debug logging, and optionally persist the Terraform workspace for deeper inspection.

When to use it

Run a single acceptance test by name (TestAcc prefix) for focused validation.
Diagnose failing acceptance tests or intermittent CI failures.
Verify provider behavior against real cloud resources.
Attempt to reproduce a passing test suspected of being a false negative.

Best practices

Always set TF_ACC=1 when running acceptance tests to enable live-provider integration.
Use -count=1 to avoid cached go test results when diagnosing failures.
Escalate diagnostics cumulatively: start with -v, add TF_LOG=debug, then persist the workspace if needed.
Provide any provider-specific environment variables securely (use secrets manager or CI protected variables).
When reproducing a false negative, edit a TestCheckFunc then revert after confirming the test fails.

Example use cases

Run a focused test: TF_ACC=1 go test -run=TestAccFeatureHappyPath
Ensure no cached results when debugging: TF_ACC=1 go test -count=1 -run=TestAccFeatureHappyPath
Get verbose output: TF_ACC=1 go test -v -run=TestAccFeatureHappyPath
Enable debug logs: TF_ACC=1 TF_LOG=debug go test -v -run=TestAccFeatureHappyPath
Persist Terraform workspace for post-failure inspection: TF_ACC=1 TF_ACC_WORKING_DIR_PERSIST=1 go test -v -run=TestAccFeatureHappyPath

FAQ

TF_ACC=1 is required. Many providers need additional credentials or endpoints; consult the provider docs and set those values securely via a secrets manager or CI protected variables.

How do I diagnose a flaky acceptance test?

Run the test with -count=1, then add -v for verbose output. If still unclear, set TF_LOG=debug. If you need to inspect generated Terraform state or plan files, enable TF_ACC_WORKING_DIR_PERSIST=1.

How can I confirm a passing test is not a false negative?

Edit a TestCheckFunc value in a TestCase step and run the test expecting failure. If it fails, revert your change and report a successful flip; if it still passes, investigate further as the test may be blind to the issue.