run-acceptance-tests

作者: hashicorp

使用结构化故障排除方法执行并诊断Terraform提供商的Go验收测试。通过设置TF_ACC=1环境变量并运行go test -run=TestAccFeatureHappyPath来执行聚焦验收测试。逐步诊断失败原因:使用-count=1重试,通过-v启用详细输出,通过TF_LOG=debug激活调试日志,并通过TF_ACC_WORKING_DIR_PERSIST=1持久化Terraform工作目录。通过故意破坏TestCheckFunc并重新运行测试来验证测试可靠性...

npx skills add https://github.com/hashicorp/agent-skills --skill run-acceptance-tests

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.

来自 hashicorp 的更多技能

provider-framework-migration
hashicorp
将Terraform provider资源和数据源从Plugin SDKv2迁移到Plugin Framework:在一个provider中混合使用两个插件(terraform-plugin-mux,…)
provider-configuration
hashicorp
使用Plugin Framework实现Terraform provider配置和认证:provider schema用于凭据(Optional + Sensitive属性),…
provider-ephemeral-resources
hashicorp
使用Plugin Framework实现Terraform provider的临时资源:Open/Renew/Close生命周期、临时schema设计、通过…注册
terraform-test
hashicorp
关于使用断言、模拟和模块验证编写及运行Terraform测试的全面指南。使用.tftest.hcl语法编写测试文件,通过运行块在计划或应用模式下执行,支持顺序和并行执行,并可选择状态隔离。对资源属性、输出和数据源进行断言条件验证;使用expect_failures确保无效输入被正确拒绝。模拟提供程序(Terraform 1.7.0+)可模拟基础设施行为,无需...
terraform-policy
hashicorp
编写、测试或转换Terraform策略文件(.policy.hcl、.policytest.hcl、Sentinel→tfpolicy)。触发词:policy.hcl、policytest、convert sentinel、tfpolicy、…
terraform-search-import
hashicorp
使用 Terraform Search 查询发现现有云资源,并将其批量导入 Terraform 管理。适用于将未管理的基础设施纳入管理时…
aws-ami-builder
hashicorp
使用Packer的amazon-ebs构建器创建自定义Amazon Machine Images。通过HCL模板自动化从源AMI创建AMI的过程,并利用配置器(shell脚本、文件上传、配置管理)进行自定义。支持通过ami_regions实现多区域AMI分发,以及按名称、所有者和虚拟化类型灵活过滤源AMI。通过环境变量、AWS凭证文件或IAM实例配置文件进行身份验证;包含模板的验证和构建命令...
tfctl
hashicorp
使用 tfctl CLI 与 HCP Terraform / Terraform Cloud / Terraform Enterprise 交互。完整 API 覆盖。适用于任何 HCP Terraform 或 Terraform Cloud 或…