Support `locals` block inside `tftest.hcl` Terraform Test file.

[sheeeng]

Terraform Version

terraform version
Terraform v1.7.2
on darwin_arm64

Use Cases

We don't want to repeat the same template string inside tftest.hcl Terraform Test file.

Please support locals block inside tftest.hcl Terraform Test file.

Attempted Solutions

locals {
  variable_name = "${run.setup_tests.variable_value_one}_${run.setup_tests.variable_value_two}"
}

$ terraform init -backend=false && terraform test --verbose --verbose
Initializing modules...
╷
│ Error: Unsupported block type
│ 
│   on tests/main.tftest.hcl line 13:
│   13: locals {
│ 
│ Blocks of type "locals" are not expected here.

Proposal

No response

References

No response

[crw]

Thanks for this feature request! If you are viewing this issue and would like to indicate your interest, please use the 👍 reaction on the issue description to upvote this issue. We also welcome additional use case descriptions. Thanks again!

[JohnEricson]

I want this feature as well to be able to define asserts once and then use them in several run blocks in the same *.tftest.hcl file. It's not possible to use variables { .. } for this as I need to use variables in the variable values resulting in Variables may not be used here. errors.

What I want to do:

variables {
  # Not a module variable. Used for reusing asserts in all runs.
  assert_test = {
    a = {
      expected = "test_a_correct_value"
      error_message = "Not the expected value in Test A"
    },
    b = {
      expected = "test_b_correct_value"
      error_message = "Not the expected value in Test B"
    }
  }
}

run "run_1" {
  command = plan

  variables {
    mode = "1"
  }

  assert {
    condition     = output.a == var.assert_test.a.expected
    error_message = var.assert_test.a.error_message
  }
}

run "run_2" {
  command = plan

  variables {
    mode = "2"
  }

  assert {
    condition     = output.a == var.assert_test.a.expected
    error_message = var.assert_test.a.error_message
  }
}

[nwsparks]

this would be very useful when dealing with complex conditions. here is an example of evaluating a single rule from a list of rules in a lifecycle policy

    condition = anytrue([
      for k,v in aws_s3_bucket_lifecycle_configuration.lifecycle.rule:
      v.expiration[0].days == 10  &&
      length(v.noncurrent_version_expiration) == 0 &&
      contains(keys(v.filter[0].and[0].tags), "key1") &&
      contains(keys(v.filter[0].and[0].tags), "key2") if strcontains(v.id, "Tag key1,key2")
    ])

if locals were supported i could first extract the rule into a local and then do a more simple and clear comparison of what i am looking for rather than being forced into the complexity shown here.

i guess in my case id like the ability to use locals within a run block.

[brettcurtis]

Something like this would be nice too.

locals {
  workspaces = {
    "default"                        = { environment = "mock-environment", region = "mock-region", zone = "mock-zone" }
    "main-sandbox"                   = { environment = "sandbox", region = null, zone = null }
    "us-east1-sandbox"               = { environment = "sandbox", region = "us-east1", zone = null }
    "us-east1-a-sandbox"             = { environment = "sandbox", region = "us-east1", zone = "a" }
    "us-east1-a-test-sandbox"        = { environment = "sandbox", region = "us-east1", zone = "a" }
    "main-non-production"            = { environment = "non-production", region = null, zone = null }
    "us-east1-non-production"        = { environment = "non-production", region = "us-east1", zone = null }
    "us-east1-a-non-production"      = { environment = "non-production", region = "us-east1", zone = "a" }
    "us-east1-a-test-non-production" = { environment = "non-production", region = "us-east1", zone = "a" }
    "main-production"                = { environment = "production", region = null, zone = null }
    "us-east1-production"            = { environment = "production", region = "us-east1", zone = null }
    "us-east1-a-production"          = { environment = "production", region = "us-east1", zone = "a" }
    "us-east1-a-test_production"     = { environment = "production", region = "us-east1", zone = "a" }
    "broken-workspace"               = { environment = null, region = null, zone = null }
  }
}

# Generate tests dynamically
dynamic "run" {
  for_each = local.workspaces
  content {
    name    = run.key
    command = apply

    module {
      source = "./tests/fixtures/default"
    }

    variables {
      workspace = run.key
    }

    assert {
      condition     = output.environment == run.value.environment
      error_message = "Expected ${run.value.environment} for ${run.key} workspace"
    }

    assert {
      condition     = output.region == run.value.region
      error_message = "Expected ${run.value.region} for ${run.key} workspace"
    }

    assert {
      condition     = output.zone == run.value.zone
      error_message = "Expected ${run.value.zone} for ${run.key} workspace"
    }
  }
}

variables {
  cost_center         = "mock-cost-center"
  data_classification = "mock-data-classification"
  email               = "mock-team@osinfra.io"
  repository          = "mock-owner/mock-repository"
  team                = "mock-team"
}

[liamcervante]

Hi everyone! From Terraform v1.13, you will be able to reference run block outputs and other variables from the variables block in Terraform Test files. While not exactly the same as supporting locals blocks directly, this should enable the same set of use cases. Thanks!

[github-actions]

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.