> run-acceptance-tests
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`.
curl "https://skillshub.wtf/hashicorp/agent-skills/run-acceptance-tests?format=md"An acceptance test is a Go test function with the prefix TestAcc.
To run a focussed acceptance test named TestAccFeatureHappyPath:
-
Run
go test -run=TestAccFeatureHappyPathwith the following environment variables:TF_ACC=1
Default to non-verbose test output.
-
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.
- Run the test again. Use the
-count=1option to ensure thatgo testdoes not use a cached result. - Offer verbose
go testoutput. Use the-voption. - Offer debug-level logging. Enable debug-level logging with the environment
variable
TF_LOG=debug. - 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:
- Edit the value of one of the TestCheckFuncs in one of the TestSteps in the TestCase.
- Run the acceptance test. Expect the test to fail.
- If the test fails, then undo the edit and report a successful flip. Else, keep the edit and report an unsuccessful flip.
> related_skills --same-repo
> provider-test-patterns
Terraform provider acceptance test patterns using terraform-plugin-testing with the Plugin Framework. Covers test structure, TestCase/TestStep fields, ConfigStateChecks with custom statecheck.StateCheck implementations, plan checks, CompareValue for cross-step assertions, config helpers, import testing with ImportStateKind, sweepers, and scenario patterns (basic, update, disappears, validation, regression), and ephemeral resource testing with the echoprovider package. Use when writing, reviewing
> provider-resources
Implement Terraform Provider resources and data sources using the Plugin Framework. Use when developing CRUD operations, schema design, state management, and acceptance testing for provider resources.
> provider-actions
Implement Terraform Provider actions using the Plugin Framework. Use when developing imperative operations that execute at lifecycle events (before/after create, update, destroy).
> new-terraform-provider
Use this when scaffolding a new Terraform provider.