Documentation

Introduction

Terratest provides a variety of helper functions and patterns for common infrastructure testing tasks. Learn more about Terratest basic usage.

Quick start

Learn how to start with Terratest.

Examples

Examples are the best way to start testing Terraform, Docker, Packer, Kubernetes, AWS, GCP, and more with Terratest.

Package by package overview

Learn more about Terratest modules and how they can help you test different types infrastructure.

GoDoc

Browse Terratest methods and types in GoDoc.

Testing Terragrunt

Learn how to test Terragrunt configurations with Terratest.

Pinning a Terratest version

Lock your tests to a specific Terratest release.

Unit tests, integration tests, end-to-end tests

See the talk about unit tests, integration tests, end-to-end tests, dependency injection, test parallelism, retries, error handling, and static analysis.

Testing environment

Learn more about testing environments.

Namespacing

Learn how to avoid conflicts due to duplicated identifiers.

Cleanup

Since automated tests with Terratest deploy real resources into real environments, you'll want to make sure your tests always cleanup after themselves.

Timeouts and logging

Long-running infrastructure tests may exceed timeouts or can be killed if they do not prompt logs.

Avoid test caching

Since Go 1.10, test results are automatically cached. See how to turn off caching test results.

Error handling

Learn how to handle errors.

Iterating locally using Docker

If you're writing scripts (i.e., Bash, Python, or Go), you should be able to test them locally using Docker. Docker containers typically build 10x faster and start 100x faster than real servers.

Iterating locally using test stages

Learn more about Terratest's `teststructure`.

Alternative testing tools

Learn more about alternatives to Terratest, and how Terratest compares to other testing tools.

Idempotent

Test that your Terraform configuration results in consistent deployments.

Picking EC2 instance types

Pick EC2 instance types that are available in the current AWS region.

Tools and Plugins

Additional tools and plugins for terratest to make integration with existing workflows easier.

Overview

Summary of breaking changes in Terratest v1.0.0 and where to look first.

Azure modules

Migrate Azure tests from Terratest pre-v1 to v1.0.0.

v2 overview

What changes when you move from Terratest v1 to v2, and the order to do it in.

Rewriting imports

The mechanical part of the v2 migration, and the places a blind find-and-replace gets it wrong.

Import map

Every v1 import path and what it becomes in v2.

Behavior changes

The two v2 changes the compiler will not find for you. Both are in the k8s module.

Contributing

Terratest is an open source project, and contributions from the community are very welcome!

Support

Need help?

License

This code is released under the Apache 2.0 License. Read more here.