
Skill
run-acceptance-tests
run acceptance tests for Terraform providers
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`.
SKILL.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.
More skills from the agent-skills repository
View all 17 skillsaws-ami-builder
build Amazon Machine Images with Packer
Apr 6AWSDeploymentInfrastructure as CodePackerazure-image-builder
build Azure managed images with Packer
Apr 6AzureDeploymentPackerazure-verified-modules
develop certified Azure Verified Modules
Apr 6AzureComplianceInfrastructure as CodeTerraformnew-terraform-provider
scaffold new Terraform providers
Apr 6Plugin DevelopmentTemplatesTerraformprovider-actions
implement Terraform Provider lifecycle actions
Apr 6API DevelopmentPlugin DevelopmentTerraformprovider-docs
generate and review Terraform provider documentation
Apr 6DocumentationTechnical WritingTerraform
More from HashiCorp
View publisherprovider-resources
implement Terraform Provider resources and data sources
agent-skills
Apr 6API DevelopmentPlugin DevelopmentTerraformprovider-test-patterns
implement Terraform provider acceptance test patterns
agent-skills
Apr 6Plugin DevelopmentQATerraformTestingpush-to-registry
push Packer build metadata to HCP registry
agent-skills
Apr 6DeploymentGovernanceHCPPackerrefactor-module
refactor Terraform configurations into reusable modules
agent-skills
Apr 6ArchitectureInfrastructure as CodeTerraformterraform-policy
write and test Terraform policy files
agent-skills
Jul 18ComplianceInfrastructure as CodeSecurityTerraform