hashicorp / terraform-provider-assert

Offers functions to validate and assert values within Terraform configurations, simplifying variable validation and custom conditions.
https://registry.terraform.io/providers/hashicorp/assert/latest/docs
Mozilla Public License 2.0
36 stars 8 forks source link
assert golang provider terraform test

Terraform Provider: Assert

The Assert Terraform provider is intended for use when writing Terraform Tests, Variable Validation, Preconditions and Postconditions, or Continuous Validation. It serves as a way to verify that the values in your Terraform configuration meet specific criteria. The provider only contains functions to assert values, and does not manage any resources.

To use provider functions, declare the provider as a required provider in your Terraform configuration:

terraform {
  required_providers {
    assert = {
      source = "hashicorp/assert"
    }
  }
}

Continuous Validation

Simplify continuous validation checks that run as part of your Terraform workflow:

data "http" "terraform_io" {
  url = "https://www.terraform.io"
}

check "health_check" {
  assert {
    condition     = provider::assert::http_success(data.http.terraform_io.status_code)
    error_message = "${data.http.terraform_io.url} returned an unhealthy status code"
  }
}

Terraform Test

Test assertions in your Terraform configuration should be simple and easy to read:

run "ebs_volume_size" {
  command = plan
  assert {
    condition     = provider::assert::between(1, 100, aws_ebs_volume.example.size)
    error_message = "EBS volume size must be between 1 and 100 GiB"
  }
}

Variable Validation

Write simple validation rules for your Terraform variables:

variable "ebs_volume_size" {
  type = number
  validation {
    condition     = provider::assert::between(1, 100, var.ebs_volume_size)
    error_message = "EBS volume size must be between 1 and 100 GiB"
  }
}

License

Mozilla Public License v2.0