diff --git a/test/fixtures/components/terraform/.gitignore b/test/fixtures/components/terraform/.gitignore index 3bf6306..601c2f7 100644 --- a/test/fixtures/components/terraform/.gitignore +++ b/test/fixtures/components/terraform/.gitignore @@ -1,3 +1,4 @@ * !assert +!assert/** !assert/**/*.tf diff --git a/test/fixtures/components/terraform/assert/checks.tf b/test/fixtures/components/terraform/assert/full/checks.tf similarity index 100% rename from test/fixtures/components/terraform/assert/checks.tf rename to test/fixtures/components/terraform/assert/full/checks.tf diff --git a/test/fixtures/components/terraform/assert/context.tf b/test/fixtures/components/terraform/assert/full/context.tf similarity index 100% rename from test/fixtures/components/terraform/assert/context.tf rename to test/fixtures/components/terraform/assert/full/context.tf diff --git a/test/fixtures/components/terraform/assert/providers.tf b/test/fixtures/components/terraform/assert/full/providers.tf similarity index 100% rename from test/fixtures/components/terraform/assert/providers.tf rename to test/fixtures/components/terraform/assert/full/providers.tf diff --git a/test/fixtures/components/terraform/assert/remote-state.tf b/test/fixtures/components/terraform/assert/full/remote-state.tf similarity index 100% rename from test/fixtures/components/terraform/assert/remote-state.tf rename to test/fixtures/components/terraform/assert/full/remote-state.tf diff --git a/test/fixtures/components/terraform/assert/variables.tf b/test/fixtures/components/terraform/assert/full/variables.tf similarity index 100% rename from test/fixtures/components/terraform/assert/variables.tf rename to test/fixtures/components/terraform/assert/full/variables.tf diff --git a/test/fixtures/components/terraform/assert/versions.tf b/test/fixtures/components/terraform/assert/full/versions.tf similarity index 100% rename from test/fixtures/components/terraform/assert/versions.tf rename to test/fixtures/components/terraform/assert/full/versions.tf diff --git a/test/fixtures/components/terraform/assert/minimal/checks.tf b/test/fixtures/components/terraform/assert/minimal/checks.tf new file mode 100644 index 0000000..263bc9b --- /dev/null +++ b/test/fixtures/components/terraform/assert/minimal/checks.tf @@ -0,0 +1,11 @@ +check "that" { + assert { + condition = startswith(module.vpc.outputs.vpc_id, "vpc-") + error_message = "Err: VPC ID does not start with 'vpc-'" + } + + assert { + condition = startswith(module.vpc.outputs.vpc_id, "vpc-") + error_message = "Err: VPC ID does not start with 'vpc-'" + } +} diff --git a/test/fixtures/components/terraform/assert/minimal/context.tf b/test/fixtures/components/terraform/assert/minimal/context.tf new file mode 100644 index 0000000..5e0ef88 --- /dev/null +++ b/test/fixtures/components/terraform/assert/minimal/context.tf @@ -0,0 +1,279 @@ +# +# ONLY EDIT THIS FILE IN github.com/cloudposse/terraform-null-label +# All other instances of this file should be a copy of that one +# +# +# Copy this file from https://github.com/cloudposse/terraform-null-label/blob/master/exports/context.tf +# and then place it in your Terraform module to automatically get +# Cloud Posse's standard configuration inputs suitable for passing +# to Cloud Posse modules. +# +# curl -sL https://raw.githubusercontent.com/cloudposse/terraform-null-label/master/exports/context.tf -o context.tf +# +# Modules should access the whole context as `module.this.context` +# to get the input variables with nulls for defaults, +# for example `context = module.this.context`, +# and access individual variables as `module.this.`, +# with final values filled in. +# +# For example, when using defaults, `module.this.context.delimiter` +# will be null, and `module.this.delimiter` will be `-` (hyphen). +# + +module "this" { + source = "cloudposse/label/null" + version = "0.25.0" # requires Terraform >= 0.13.0 + + enabled = var.enabled + namespace = var.namespace + tenant = var.tenant + environment = var.environment + stage = var.stage + name = var.name + delimiter = var.delimiter + attributes = var.attributes + tags = var.tags + additional_tag_map = var.additional_tag_map + label_order = var.label_order + regex_replace_chars = var.regex_replace_chars + id_length_limit = var.id_length_limit + label_key_case = var.label_key_case + label_value_case = var.label_value_case + descriptor_formats = var.descriptor_formats + labels_as_tags = var.labels_as_tags + + context = var.context +} + +# Copy contents of cloudposse/terraform-null-label/variables.tf here + +variable "context" { + type = any + default = { + enabled = true + namespace = null + tenant = null + environment = null + stage = null + name = null + delimiter = null + attributes = [] + tags = {} + additional_tag_map = {} + regex_replace_chars = null + label_order = [] + id_length_limit = null + label_key_case = null + label_value_case = null + descriptor_formats = {} + # Note: we have to use [] instead of null for unset lists due to + # https://github.com/hashicorp/terraform/issues/28137 + # which was not fixed until Terraform 1.0.0, + # but we want the default to be all the labels in `label_order` + # and we want users to be able to prevent all tag generation + # by setting `labels_as_tags` to `[]`, so we need + # a different sentinel to indicate "default" + labels_as_tags = ["unset"] + } + description = <<-EOT + Single object for setting entire context at once. + See description of individual variables for details. + Leave string and numeric variables as `null` to use default value. + Individual variable settings (non-null) override settings in context object, + except for attributes, tags, and additional_tag_map, which are merged. + EOT + + validation { + condition = lookup(var.context, "label_key_case", null) == null ? true : contains(["lower", "title", "upper"], var.context["label_key_case"]) + error_message = "Allowed values: `lower`, `title`, `upper`." + } + + validation { + condition = lookup(var.context, "label_value_case", null) == null ? true : contains(["lower", "title", "upper", "none"], var.context["label_value_case"]) + error_message = "Allowed values: `lower`, `title`, `upper`, `none`." + } +} + +variable "enabled" { + type = bool + default = null + description = "Set to false to prevent the module from creating any resources" +} + +variable "namespace" { + type = string + default = null + description = "ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique" +} + +variable "tenant" { + type = string + default = null + description = "ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for" +} + +variable "environment" { + type = string + default = null + description = "ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'" +} + +variable "stage" { + type = string + default = null + description = "ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'" +} + +variable "name" { + type = string + default = null + description = <<-EOT + ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'. + This is the only ID element not also included as a `tag`. + The "name" tag is set to the full `id` string. There is no tag with the value of the `name` input. + EOT +} + +variable "delimiter" { + type = string + default = null + description = <<-EOT + Delimiter to be used between ID elements. + Defaults to `-` (hyphen). Set to `""` to use no delimiter at all. + EOT +} + +variable "attributes" { + type = list(string) + default = [] + description = <<-EOT + ID element. Additional attributes (e.g. `workers` or `cluster`) to add to `id`, + in the order they appear in the list. New attributes are appended to the + end of the list. The elements of the list are joined by the `delimiter` + and treated as a single ID element. + EOT +} + +variable "labels_as_tags" { + type = set(string) + default = ["default"] + description = <<-EOT + Set of labels (ID elements) to include as tags in the `tags` output. + Default is to include all labels. + Tags with empty values will not be included in the `tags` output. + Set to `[]` to suppress all generated tags. + **Notes:** + The value of the `name` tag, if included, will be the `id`, not the `name`. + Unlike other `null-label` inputs, the initial setting of `labels_as_tags` cannot be + changed in later chained modules. Attempts to change it will be silently ignored. + EOT +} + +variable "tags" { + type = map(string) + default = {} + description = <<-EOT + Additional tags (e.g. `{'BusinessUnit': 'XYZ'}`). + Neither the tag keys nor the tag values will be modified by this module. + EOT +} + +variable "additional_tag_map" { + type = map(string) + default = {} + description = <<-EOT + Additional key-value pairs to add to each map in `tags_as_list_of_maps`. Not added to `tags` or `id`. + This is for some rare cases where resources want additional configuration of tags + and therefore take a list of maps with tag key, value, and additional configuration. + EOT +} + +variable "label_order" { + type = list(string) + default = null + description = <<-EOT + The order in which the labels (ID elements) appear in the `id`. + Defaults to ["namespace", "environment", "stage", "name", "attributes"]. + You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present. + EOT +} + +variable "regex_replace_chars" { + type = string + default = null + description = <<-EOT + Terraform regular expression (regex) string. + Characters matching the regex will be removed from the ID elements. + If not set, `"/[^a-zA-Z0-9-]/"` is used to remove all characters other than hyphens, letters and digits. + EOT +} + +variable "id_length_limit" { + type = number + default = null + description = <<-EOT + Limit `id` to this many characters (minimum 6). + Set to `0` for unlimited length. + Set to `null` for keep the existing setting, which defaults to `0`. + Does not affect `id_full`. + EOT + validation { + condition = var.id_length_limit == null ? true : var.id_length_limit >= 6 || var.id_length_limit == 0 + error_message = "The id_length_limit must be >= 6 if supplied (not null), or 0 for unlimited length." + } +} + +variable "label_key_case" { + type = string + default = null + description = <<-EOT + Controls the letter case of the `tags` keys (label names) for tags generated by this module. + Does not affect keys of tags passed in via the `tags` input. + Possible values: `lower`, `title`, `upper`. + Default value: `title`. + EOT + + validation { + condition = var.label_key_case == null ? true : contains(["lower", "title", "upper"], var.label_key_case) + error_message = "Allowed values: `lower`, `title`, `upper`." + } +} + +variable "label_value_case" { + type = string + default = null + description = <<-EOT + Controls the letter case of ID elements (labels) as included in `id`, + set as tag values, and output by this module individually. + Does not affect values of tags passed in via the `tags` input. + Possible values: `lower`, `title`, `upper` and `none` (no transformation). + Set this to `title` and set `delimiter` to `""` to yield Pascal Case IDs. + Default value: `lower`. + EOT + + validation { + condition = var.label_value_case == null ? true : contains(["lower", "title", "upper", "none"], var.label_value_case) + error_message = "Allowed values: `lower`, `title`, `upper`, `none`." + } +} + +variable "descriptor_formats" { + type = any + default = {} + description = <<-EOT + Describe additional descriptors to be output in the `descriptors` output map. + Map of maps. Keys are names of descriptors. Values are maps of the form + `{ + format = string + labels = list(string) + }` + (Type is `any` so the map values can later be enhanced to provide additional options.) + `format` is a Terraform format string to be passed to the `format()` function. + `labels` is a list of labels, in order, to pass to `format()` function. + Label values will be normalized before being passed to `format()` so they will be + identical to how they appear in `id`. + Default is `{}` (`descriptors` output will be empty). + EOT +} + +#### End of copy of cloudposse/terraform-null-label/variables.tf diff --git a/test/fixtures/components/terraform/assert/minimal/providers.tf b/test/fixtures/components/terraform/assert/minimal/providers.tf new file mode 100644 index 0000000..5867a85 --- /dev/null +++ b/test/fixtures/components/terraform/assert/minimal/providers.tf @@ -0,0 +1,28 @@ +provider "aws" { + region = var.region + + # Profile is deprecated in favor of terraform_role_arn. When profiles are not in use, terraform_profile_name is null. + profile = module.iam_roles.terraform_profile_name + default_tags { + tags = var.default_tags + } + dynamic "assume_role" { + # module.iam_roles.terraform_role_arn may be null, in which case do not assume a role. + for_each = compact([module.iam_roles.terraform_role_arn]) + content { + role_arn = assume_role.value + } + } +} + +module "iam_roles" { + source = "cloudposse/components/aws//modules/account-map/modules/iam-roles" + version = "1.534.0" + context = module.this.context +} + +variable "default_tags" { + type = map(string) + description = "A map of tags to add to every resource" + default = {} +} diff --git a/test/fixtures/components/terraform/assert/minimal/remote-state.tf b/test/fixtures/components/terraform/assert/minimal/remote-state.tf new file mode 100644 index 0000000..bbded53 --- /dev/null +++ b/test/fixtures/components/terraform/assert/minimal/remote-state.tf @@ -0,0 +1,7 @@ +module "vpc" { + source = "cloudposse/stack-config/yaml//modules/remote-state" + version = "1.8.0" + + component = var.component + context = module.this.context +} diff --git a/test/fixtures/components/terraform/assert/minimal/variables.tf b/test/fixtures/components/terraform/assert/minimal/variables.tf new file mode 100644 index 0000000..d4b8740 --- /dev/null +++ b/test/fixtures/components/terraform/assert/minimal/variables.tf @@ -0,0 +1,9 @@ +variable "region" { + type = string + description = "AWS Region" +} + +variable "component" { + type = string + description = "Component name to verify" +} \ No newline at end of file diff --git a/test/fixtures/components/terraform/assert/minimal/versions.tf b/test/fixtures/components/terraform/assert/minimal/versions.tf new file mode 100644 index 0000000..cc73ffd --- /dev/null +++ b/test/fixtures/components/terraform/assert/minimal/versions.tf @@ -0,0 +1,10 @@ +terraform { + required_version = ">= 1.0.0" + + required_providers { + aws = { + source = "hashicorp/aws" + version = ">= 4.9.0" + } + } +} diff --git a/test/fixtures/stacks/catalog/tests/terraform.yaml b/test/fixtures/stacks/catalog/tests/full.yaml similarity index 85% rename from test/fixtures/stacks/catalog/tests/terraform.yaml rename to test/fixtures/stacks/catalog/tests/full.yaml index cba93e3..ea3959e 100644 --- a/test/fixtures/stacks/catalog/tests/terraform.yaml +++ b/test/fixtures/stacks/catalog/tests/full.yaml @@ -1,12 +1,12 @@ components: terraform: - vpc/terraform: + vpc/full: metadata: component: vpc settings: test: suite: terraform - test: two-private-subnets + test: full stage: subjectUnderTest vars: name: "vpc-terraform" @@ -27,14 +27,14 @@ components: vpc_flow_logs_enabled: false ipv4_primary_cidr_block: "172.16.0.0/16" - assert/terraform: + assert/full: metadata: - component: assert + component: assert/full settings: test: suite: terraform - test: two-private-subnets + test: full stage: assert vars: name: "assert" - component: "vpc/terraform" + component: "vpc/full" diff --git a/test/fixtures/stacks/catalog/tests/opentofu.yaml b/test/fixtures/stacks/catalog/tests/minimal.yaml similarity index 76% rename from test/fixtures/stacks/catalog/tests/opentofu.yaml rename to test/fixtures/stacks/catalog/tests/minimal.yaml index 5a12740..134d5aa 100644 --- a/test/fixtures/stacks/catalog/tests/opentofu.yaml +++ b/test/fixtures/stacks/catalog/tests/minimal.yaml @@ -1,16 +1,15 @@ components: terraform: - vpc/opentofu: - command: "tofu" + vpc/minimal: metadata: component: vpc settings: test: - suite: opentofu - test: two-private-subnets + suite: terraform + test: minimal stage: subjectUnderTest vars: - name: "vpc-tofu" + name: "vpc-terraform" availability_zones: - "a" - "b" @@ -28,15 +27,14 @@ components: vpc_flow_logs_enabled: false ipv4_primary_cidr_block: "172.16.0.0/16" - assert/opentofu: - command: "tofu" + assert/minimal: metadata: - component: assert + component: assert/minimal settings: test: - suite: opentofu - test: two-private-subnets + suite: terraform + test: minimal stage: assert vars: name: "assert" - component: "vpc/opentofu" + component: "vpc/minimal" diff --git a/test/fixtures/stacks/orgs/default/test/_defaults.yaml b/test/fixtures/stacks/orgs/default/test/_defaults.yaml index 058e017..2d5e74b 100644 --- a/test/fixtures/stacks/orgs/default/test/_defaults.yaml +++ b/test/fixtures/stacks/orgs/default/test/_defaults.yaml @@ -1,7 +1,7 @@ import: - catalog/account-map - - catalog/tests/terraform - - catalog/tests/opentofu + - catalog/tests/minimal + - catalog/tests/full terraform: backend_type: local diff --git a/test/go.mod b/test/go.mod index 6c30f03..2e51a62 100644 --- a/test/go.mod +++ b/test/go.mod @@ -3,7 +3,7 @@ module test go 1.23.0 require ( - github.com/cloudposse/test-helpers v0.12.1-0.20241223135828-88e2b782a08b + github.com/cloudposse/test-helpers v0.12.1-0.20241223202452-7d2d3d97be2b github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc // indirect github.com/gruntwork-io/terratest v0.47.1 // indirect github.com/mattn/go-zglob v0.0.3 // indirect diff --git a/test/go.sum b/test/go.sum index 6a9d3ad..bf23979 100644 --- a/test/go.sum +++ b/test/go.sum @@ -236,6 +236,8 @@ github.com/chzyer/test v0.0.0-20180213035817-a1ea475d72b1/go.mod h1:Q3SI9o4m/ZMn github.com/client9/misspell v0.3.4/go.mod h1:qj6jICC3Q7zFZvVWo7KLAzC3yx5G7kyvSDkc90ppPyw= github.com/cloudposse/test-helpers v0.12.1-0.20241223135828-88e2b782a08b h1:N++zaLsknhrUaPZuluG5VCcrrLOgaQvoq6WwdkEnmh4= github.com/cloudposse/test-helpers v0.12.1-0.20241223135828-88e2b782a08b/go.mod h1:1kSZLniIqKDtHu3ri5xDuXMH/7iUnthLImR/HkZG2T8= +github.com/cloudposse/test-helpers v0.12.1-0.20241223202452-7d2d3d97be2b h1:6erGKLtDAns3mFTmhGiYtLX7WqKDWWOx2XoEVyPNDOM= +github.com/cloudposse/test-helpers v0.12.1-0.20241223202452-7d2d3d97be2b/go.mod h1:1kSZLniIqKDtHu3ri5xDuXMH/7iUnthLImR/HkZG2T8= github.com/cncf/udpa/go v0.0.0-20191209042840-269d4d468f6f/go.mod h1:M8M6+tZqaGXZJjfX53e64911xZQV5JYwmTeXPW+k8Sc= github.com/cncf/udpa/go v0.0.0-20200629203442-efcf912fb354/go.mod h1:WmhPx2Nbnhtbo57+VJT5O0JRkEi1Wbu0z5j0R8u5Hbk= github.com/cncf/udpa/go v0.0.0-20201120205902-5459f2c99403/go.mod h1:WmhPx2Nbnhtbo57+VJT5O0JRkEi1Wbu0z5j0R8u5Hbk=