hashicorp/agent-skills

run-acceptance-tests

Guide for running acceptance tests for a Terraform provider.

Quelltext ansehen

Verwendung

  1. Installationsbefehl kopieren und das Quellpaket vor der Installation in der eigenen Agentenumgebung prüfen.
  2. Benötigte Werkzeuge, Zugangsdaten und Hosts im Original prüfen.
  3. Eingabe und gewünschtes Ergebnis beschreiben und die Ausgabe mit den Quellen abgleichen.
npx skills add https://github.com/hashicorp/agent-skills --skill run-acceptance-tests

Vor dem Start

  • Die Installation umfasst weder Modellabo noch API-Kontingent oder Dateizugriffsrechte.
  • Sterne und Installationen zeigen Aktivität, keine unabhängige Qualitäts- oder Sicherheitsprüfung.
Originales Skill-Dokument

Aus dem Quell-Repository gerendert; Überschriften, Beispiele, Code, Tabellen, Links und Bilder bleiben erhalten.

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.

  1. 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.

  1. Offer verbose go test output. Use the -v option.
  2. 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

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.

  1. Run the acceptance test. Expect the test to fail.
  2. 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.

Verwandte Aufgaben

aus demselben Repository

Weitere Skills

Alle Skills
hashicorp
Offiziell

terraform-test

Comprehensive guide for writing and running Terraform tests. Use when creating test files (.tftest.hcl), writing test scenarios with run blocks, validating infrastructure behavior with assertions, mocking providers and data sources, testing module outputs and resource configurations, or troubleshooting Terraform test syntax and execution.

Installationen / 1h
1
GitHub Stars
935
Aktualisiert
4. Nov.
hashicorp
Offiziell

terraform-style-guide

Generate Terraform HCL code following HashiCorp's official style conventions and best practices. Use when writing, reviewing, or generating Terraform configurations.

Installationen / 1h
4
GitHub Stars
929
Aktualisiert
4. Nov.
hashicorp
Offiziell

provider-docs

Create, update, and review Terraform provider documentation for Terraform Registry using HashiCorp-recommended patterns, tfplugindocs templates, and schema descriptions. Use when adding or changing provider configuration, resources, data sources, ephemeral resources, list resources, functions, actions, or guides; when validating generated docs; and when troubleshooting missing or incorrect Registry documentation.

Installationen / 1h
1
GitHub Stars
922
Aktualisiert
4. Nov.
hashicorp
Offiziell

provider-resources

Implement Terraform Provider resources and data sources using the Plugin Framework: CRUD operations, schema design, plan modifiers and validators, not-found handling, waiters for eventually consistent APIs, import support, resource design principles, and required acceptance test coverage. Use when adding or changing a resource or data source, deciding whether an API concept should be a resource, wiring a resource to the provider's configured client, handling drift or resource-not-found, or revie

Installationen / 1h
1
GitHub Stars
922
Aktualisiert
4. Nov.