terraform test command reads in Terraform testing files and executes the tests within.
test command, and the test file syntax, are particularly helpful for module authors who want to validate and test their shared modules. You can also use the
test command to validate root modules.
terraform test [options]
This command searches the current directory and the specified testing directory (
tests, by default) for any Terraform testing files, and executes the specified tests. Refer to Tests for more details on test files.
Terraform then executes a series of Terraform plan or apply commands according to the test files' specifications, and also validates the relevant plan and state files according to the test files' specifications.
Warning: The Terraform test command can create real infrastructure than can cost you money. Refer to the Terraform Test Cleanup section for best practices on ensuring created infrastructure is destroyed.
The following options apply to the Terraform
-filter=testfile- Limits the
terraform testoperation to the specified test files.
-json- Displays machine-readable JSON output for your testing results.
-test-directory=<relative directory>- Overrides the directory that Terraform looks into for test files. Note that Terraform always loads testing files within the main configuration directory. The default testing directory is
-verbose- Prints out the plan or state for each
runblock within a test file, based on the
commandattribute of each
Each Terraform test file will maintain all Terraform state it requires within memory as it executes, starting empty. This state is entirely separate from any existing state for the configuration under test, so you can safely execute Terraform test commands without affecting any live infrastructure.
test command creates real infrastructure. Once Terraform fully executes each test file, Terraform attempts to destroy any remaining infrastructure. If it cannot do this, Terraform reports a list of resources it created but could not destroy.
You should monitor the output of the test command closely to ensure Terraform removes the infrastructure it created or perform manual cleanup if not. We recommend creating dedicated testing accounts within the target providers that you can routinely and safely purge to ensure any accidental and costly resources aren't left behind.
Terraform also provides diagnostics explaining why it could not automatically clean up. You should review these diagnostics to ensure that future clean-up operations are successful.
You can execute tests remotely on Terraform Cloud using the
-cloud-run option accepts a private registry module source. This option associates the test run with your specified private module within the Terraform Cloud user interface.
You must provide a module from a private registry, not the public Terraform registry.
You must execute
terraform login before using this option, and ensure that your
hostname argument matches the private registry hostname of your target module.
The following directory structure represents an example directory tree for a Terraform module with tests and a setup module.
| |-- validations.tftest.hcl
| |-- outputs.tftest.hcl
At the root directory of the project, there are some typical Terraform configuration files:
variables.tf. The test files,
outputs.tftest.hcl, are within the default tests directory:
In addition, a setup module for the tests exists within the
In order to execute the tests you should run
terraform test from the root configuration directory as if running
terraform plan or
terraform apply. Despite the actual test files being in the nested
tests directory, Terraform executes from the main configuration directory.
Specific test files can be executed using the
Linux, Mac OS, and UNIX:
terraform test -filter=tests/validations.tftest.hcl
terraform test -filter='tests\validations.tftest.hcl'
terraform test -filter=tests\validations.tftest.hcl
In the above example the tests are in the default testing directory of
tests. Test files can also be included directly within the main configuration directory:
The location of the testing files does not affect the operation of
terraform test. All references to, and absolute file paths within, the testing files should be relative to the main configuration directory.
You can also use the
-test-directory argument to change the location of the testing files. For example,
terraform test -test-directory=testing would instruct Terraform to load tests from the directory
testing instead of
The testing directory must be beneath the main configuration directory, but it can be nested many times.
Note: Test files within the root configuration directory are always loaded, regardless of the
We do not recommend changing the default test directory. The option for customization is included for configuration authors who may have included a
tests submodule in their configuration before the
terraform test command was released. In general, the default test directory of
tests should always be used.