playbooks

home / skills / hashicorp / agent-skills / run-acceptance-tests

run-acceptance-tests skill

/terraform/provider-development/skills/run-acceptance-tests

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

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

Review the files below or copy the command above to add this skill to your agents.

Files (1)
SKILL.md
1.7 KB
---
name: run-acceptance-tests
description: 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`.
license: MPL-2.0
metadata:
  copyright: Copyright IBM Corp. 2026
  version: "0.0.1"
---

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

To run a focussed acceptance test named `TestAccFeatureHappyPath`:

1. Run `go test -run=TestAccFeatureHappyPath` with the following environment
   variables:
   - `TF_ACC=1`
   
   Default to non-verbose test output.
1. The acceptance tests may require additional environment variables for
   specific providers. If the test output indicates missing environment
   variables, then suggest how to set up these environment variables securely.

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.
1. 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
   persistance 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.
1. If the test fails, then undo the edit and report a successful flip. Else,
   keep the edit and report an unsuccessful flip.

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

What environment variables are required?

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.