Repository files navigation

1. 🌍 Localstack Terraform Test Runner 🚀
2. 🎯 Purpose
3. 🔧 Installation
4. 🏃‍ How to Run
5. 🔍 How to Run Test Cases
6. 🔢 Default Environment Variables for Terraform Tests
7. ⚙️ Options
8. 🔐 Services

This utility serves as a test runner designed specifically for Localstack and Terraform. By leveraging it, users can execute test cases from the Hashicorp Terraform provider AWS against a Localstack Instance.

The primary objective behind this project is to segregate test cases from the Localstack repo and execute them against Localstack. This helps in obtaining parity metrics.

1. 📦 Clone the repository (including submodules):

git clone git@github.com:localstack/localstack-terraform-test.git --recurse-submodules

2. 🔀 Ensure you're on the latest version of the submodules:

git submodule update --init --recursive

3. 🚀 Install dependencies:

make install

• 🔑 (Pro-image only) Set theLOCALSTACK_AUTH_TOKEN environment variable.
• Apply the patch to the Terraform provider AWS:

python -m terraform_pytest.main patch

⚠️Note: The above operation isn't idempotent. Ensure you apply the patch only once.

• Construct a testing binary for the Golang module:

python -m terraform_pytest.main build -s s3

• Now you're all set to utilize thepython -m pytest commands to list and execute test cases derived from Golang.

• 📋 List all test cases from a specific service:

python -m pytest terraform-provider-aws/internal/service/<service> --collect-only -q

• 🚀 Execute a particular test case:

python -m pytest terraform-provider-aws/internal/service/<service>/<test-file> -k <test-case-name> --ls-start

or

python -m pytest terraform-provider-aws/internal/service/<service>/<test-file>::<test-case-name> --ls-start

• You can prepend additional environment variables to the command. For instance:

AWS_ALTERNATE_REGION='us-west-2' python -m pytest terraform-provider-aws/internal/service/<service>/<test-file>::<test-case-name> --ls-start

• --ls-start: Initializes the Localstack instance before test case execution. It triggers the CLI:

localstack start -d

• --gather-metrics: Gathers raw test metrics for a specific run. But first, make sure you manually install the extension:

localstack extensions initlocalstack extensions install "git+https://github.com/localstack/localstack-moto-test-coverage/#egg=collect-raw-metric-data-extension&subdirectory=collect-raw-metric-data-extension"

Remember to set theSERVICE environment variable for naming the metric file.

Executing this test suite is a time-intensive process. To cater to this, the following mechanisms are in place: