README
¶
terraform-plugin-testing
terraform-plugin-testing is a helper module for testing Terraform providers. Terraform acceptance tests use real Terraform configurations to exercise the code in real plan, apply, refresh, and destroy life cycles. When run from the root of a Terraform Provider codebase, Terraform’s testing framework compiles the current provider in-memory and executes the provided configuration in developer defined steps, creating infrastructure along the way.
Go Compatibility
This project follows the support policy of Go as its support policy. The two latest major releases of Go are supported by the project.
Currently, that means Go 1.21 or later must be used when including this project as a dependency.
Contributing
License
Directories
¶
| Path | Synopsis |
|---|---|
|
Package config implements functionality for supporting native Terraform configuration and variables for testing purposes.
|
Package config implements functionality for supporting native Terraform configuration and variables for testing purposes. |
|
helper
|
|
|
internal
|
|
|
addrs
Package addrs contains types that represent "addresses", which are references to specific objects within a Terraform configuration or state.
|
Package addrs contains types that represent "addresses", which are references to specific objects within a Terraform configuration or state. |
|
configs/configschema
Package configschema contains types for describing the expected structure of a configuration block whose shape is not known until runtime.
|
Package configschema contains types for describing the expected structure of a configuration block whose shape is not known until runtime. |
|
plugintest
Package plugintest contains utilities to help with writing tests for Terraform plugins.
|
Package plugintest contains utilities to help with writing tests for Terraform plugins. |
|
testing
Package testing contains functionality and helpers for unit testing within this Go module.
|
Package testing contains functionality and helpers for unit testing within this Go module. |
|
testing/testprovider
Package testprovider is a declarative provider for implementing unit testing within this Go module.
|
Package testprovider is a declarative provider for implementing unit testing within this Go module. |
|
testing/testsdk
Package testsdk provides a lightweight terraform-plugin-go SDK for implementing unit testing within this Go module.
|
Package testsdk provides a lightweight terraform-plugin-go SDK for implementing unit testing within this Go module. |
|
testing/testsdk/datasource
Package datasource provides testsdk handling of the data resource concept.
|
Package datasource provides testsdk handling of the data resource concept. |
|
testing/testsdk/provider
Package provider provides testsdk handling of the provider concept.
|
Package provider provides testsdk handling of the provider concept. |
|
testing/testsdk/providerserver
Package providerserver provides testsdk handling of serving a provider.
|
Package providerserver provides testsdk handling of serving a provider. |
|
testing/testsdk/resource
Package resource provides testsdk handling of the managed resource concept.
|
Package resource provides testsdk handling of the managed resource concept. |
|
tfdiags
Package tfdiags is a utility package for representing errors and warnings in a manner that allows us to produce good messages for the user.
|
Package tfdiags is a utility package for representing errors and warnings in a manner that allows us to produce good messages for the user. |
|
Package knownvalue contains the known value interface, and types implementing the known value interface.
|
Package knownvalue contains the known value interface, and types implementing the known value interface. |
|
Package plancheck contains the plan check interface, request/response structs, and common plan check implementations.
|
Package plancheck contains the plan check interface, request/response structs, and common plan check implementations. |
|
Package statecheck contains the state check interface, request/response structs, and common state check implementations.
|
Package statecheck contains the state check interface, request/response structs, and common state check implementations. |
|
Package tfjsonpath implements terraform-json path functionality, which defines traversals into Terraform JSON data, for testing purposes.
|
Package tfjsonpath implements terraform-json path functionality, which defines traversals into Terraform JSON data, for testing purposes. |
|
Package tfversion contains the Terraform version check interface, request/response structs, and common version check implementations.
|
Package tfversion contains the Terraform version check interface, request/response structs, and common version check implementations. |
Click to show internal directories.
Click to hide internal directories.