Terraform test framework (1.6+) - Step-by-Step Execution

Process Flow - Terraform test framework (1.6+)

Write test file with test blocks

↓

Run 'terraform test'

↓

Terraform initializes test environment

↓

Terraform applies test configuration

↓

Terraform runs test assertions

↓

Report test results: pass/fail

↓

Cleanup test environment

The Terraform test framework runs tests by applying configurations and checking assertions, then reports results and cleans up.

Execution Sample

Terraform

test "example" {
  config = "resource \"null_resource\" \"test\" {}"
  check "validate" {
    assert {
      condition = test_resource("null_resource.test").exists
    }
  }
}

This test defines a null resource and checks if it exists after applying.

Process Table

Step	Action	Evaluation	Result
1	Parse test block	Read test name and config	Test 'example' loaded
2	Initialize test environment	terraform init	Environment ready
3	Apply test config	terraform apply	null_resource.test created
4	Run check assertions	Check resource existence	null_resource.test exists: true
5	Report results	All checks passed	Test 'example' PASSED
6	Cleanup	Destroy test resources	Environment cleaned

💡 All test assertions passed, test framework completes successfully

Status Tracker

Variable	Start	After Step 3	After Step 4	Final
null_resource.test	not created	created	exists confirmed	destroyed

Key Moments - 2 Insights

Why does the test framework apply the configuration before checking assertions?

Because the resources must exist in the test environment to verify their state, as shown in steps 3 and 4 of the execution_table.

What happens if a check assertion fails during the test?

The test framework reports a failure at step 5 and stops further checks, indicating which assertion failed.

Visual Quiz - 3 Questions

Look at the execution_table, what is the state of null_resource.test after step 3?

A Not created

B Created

C Destroyed

D Unknown

💡 Hint

Check the 'Evaluation' and 'Result' columns at step 3 in execution_table

At which step does the test framework confirm that the resource exists?

A Step 2

B Step 3

C Step 4

D Step 5

💡 Hint

Look at the 'Action' and 'Evaluation' columns in execution_table for resource existence check

If the resource was not created successfully, how would the execution_table change?

A Step 3 result would show creation failed

B Step 4 would confirm existence

C Step 5 would report test passed

D Step 6 would skip cleanup

💡 Hint

Refer to step 3 and step 5 results in execution_table for success or failure outcomes

Concept Snapshot

Terraform test framework (1.6+):
- Write test blocks with config and checks
- Run 'terraform test' to execute
- Terraform applies config in isolated env
- Checks assert resource states
- Results show pass/fail
- Environment cleans up automatically

Full Transcript

The Terraform test framework lets you write tests as blocks with configuration and checks. When you run 'terraform test', it initializes a test environment, applies the configuration, and runs assertions to verify resource states. It reports whether tests pass or fail and then cleans up the environment. This process ensures your Terraform code works as expected in a safe, repeatable way.

Practice

1. What is the main purpose of the Terraform test framework introduced in version 1.6+?

easy

A. To monitor cloud resources for performance issues

B. To deploy infrastructure faster without manual approval

C. To write automated tests that check your infrastructure code works as expected

D. To replace Terraform CLI commands with a graphical interface

Solution

1. Step 1: Understand Terraform test framework purpose

   The framework is designed to let you write tests that run your Terraform code and verify resource attributes automatically.

2. Step 2: Compare options with framework purpose

   Only To write automated tests that check your infrastructure code works as expected correctly describes writing automated tests for infrastructure code. Other options describe unrelated features.

3. Final Answer:

   To write automated tests that check your infrastructure code works as expected -> Option C

4. Quick Check:

   Test framework purpose = automated infrastructure tests [OK]

Hint: Focus on testing infrastructure code correctness [OK]

Common Mistakes:

• Confusing testing with deployment speed
• Thinking it replaces CLI commands
• Mixing testing with monitoring

2. Which of the following is the correct syntax to define a Terraform test block in version 1.6+?

easy

A. module "test" { ... }

B. terraform_test "example" { ... }

C. resource "test" "example" { ... }

D. test "example" { ... }

Solution

1. Step 1: Recall Terraform test block syntax

   Terraform 1.6+ uses the test "name" { ... } block to define tests.

2. Step 2: Eliminate incorrect syntax options

   Options B, C, and D use incorrect block types or resource/module keywords not related to tests.

3. Final Answer:

   test "example" { ... } -> Option D

4. Quick Check:

   Test block syntax = test "name" [OK]

Hint: Look for the exact 'test' block keyword [OK]

Common Mistakes:

• Using resource or module instead of test block
• Adding extra prefixes like terraform_test
• Confusing test block with resource block

3. Given this Terraform test snippet, what will the test check?

test "check_instance" {
  config = {
    resource "aws_instance" "example" {
      ami           = "ami-123456"
      instance_type = "t2.micro"
    }
  }
  check { 
    resource = "aws_instance.example"
    attribute = "instance_type"
    equals = "t2.micro"
  }
}

medium

A. It checks if the AMI ID is 't2.micro'

B. It checks if the instance type of aws_instance.example is 't2.micro'

C. It verifies the instance is running

D. It validates the resource name is 'aws_instance.example'

Solution

1. Step 1: Analyze the check block

   The check block specifies resource "aws_instance.example", attribute "instance_type", and expects it to equal "t2.micro".

2. Step 2: Match check with options

   It checks if the instance type of aws_instance.example is 't2.micro' correctly states the test checks the instance_type attribute equals "t2.micro". Other options misunderstand attribute or resource checks.

3. Final Answer:

   It checks if the instance type of aws_instance.example is 't2.micro' -> Option B

4. Quick Check:

   Check attribute equals instance_type = t2.micro [OK]

Hint: Focus on attribute and equals fields in check block [OK]

Common Mistakes:

• Confusing AMI ID with instance type
• Assuming runtime status is checked
• Misreading resource name as attribute

4. This Terraform test code fails to run. What is the most likely error?

test "fail_test" {
  config = {
    resource "aws_s3_bucket" "bucket" {
      bucket = "my-bucket"
    }
  }
  check {
    resource = "aws_s3_bucket.bucket"
    attribute = "name"
    equals = "my-bucket"
  }
}

medium

A. The attribute 'name' does not exist for aws_s3_bucket resource

B. The resource block is missing required 'region' argument

C. The test block name cannot contain underscores

D. The equals value must be a number, not a string

Solution

1. Step 1: Check attribute correctness

   The aws_s3_bucket resource uses 'bucket' as the attribute for bucket name, not 'name'. Using 'name' causes the test to fail.

2. Step 2: Verify other options

   Region is usually set in provider, not required here. Test names can have underscores. Equals can be string. So only attribute error is valid.

3. Final Answer:

   The attribute 'name' does not exist for aws_s3_bucket resource -> Option A

4. Quick Check:

   Attribute must match resource schema [OK]

Hint: Check attribute names match resource documentation [OK]

Common Mistakes:

• Using wrong attribute names
• Assuming region is required in resource block
• Thinking test names have naming restrictions
• Confusing data types in equals

5. You want to write a Terraform test that verifies multiple attributes of an AWS EC2 instance, including instance_type and tags. Which approach correctly uses the Terraform test framework to check both attributes in one test?

hard

A. Use multiple check blocks inside one test block, each checking one attribute

B. Create separate test blocks for each attribute check

C. Combine attributes in one check block using a list for attribute and equals

D. Use a single check block with a map for attribute and equals

Solution

1. Step 1: Understand multiple attribute checks in Terraform tests

   The Terraform test framework allows multiple check blocks inside one test block to verify different attributes separately.

2. Step 2: Evaluate options for correctness

   Using multiple check blocks inside one test block, each checking one attribute, correctly verifies different attributes separately. Combining attributes into a single check block using a list or map is not supported. Creating separate test blocks for each attribute check works but is less efficient.

3. Final Answer:

   Use multiple check blocks inside one test block, each checking one attribute -> Option A

4. Quick Check:

   Multiple checks = multiple check blocks [OK]

Hint: Use one check block per attribute inside test [OK]

Common Mistakes:

• Trying to check multiple attributes in one check block
• Splitting checks into many test blocks unnecessarily
• Using unsupported data structures in check block