allow users to exclude some values

Author: drewmullen

.header.md

@@ -0,0 +1,5 @@
+
+# Terraform AWS Label Module
+The Terraform Amazon Web Services (AWS) Label module generates consistent label names and tags for Terraform resources.
+
+---

.terraform-docs.yaml

@@ -0,0 +1,12 @@
+formatter: markdown
+header-from: .header.md
+settings:
+  anchor: true
+  color: true
+  default: true
+  escape: true
+  html: true
+  indent: 2
+  required: true
+  sensitive: true
+  type: true

README.md

@@ -4,94 +4,48 @@ The Terraform Amazon Web Services (AWS) Label module generates consistent label
 
 ---
 
-## Inputs
-
-* ```region```
-    * description: AWS Region used to host Terraform resources.
-    * type: ``` string ```
-    * default: ``` us-west-1 ```
-    <br />
-
-* ```namespace```
-    * description: Namespace, generally your organization or department name (for example, ```AWS```)
-    * type: ``` string ```
-    * default: ``` testenv ```
-    <br />
-
-* ```env```
-    * description: Environment name (for example, ```sit```, ```uat```, or ```prod```)
-    * type: ``` string ```
-    * default: ``` testns ```
-    <br />
+## Requirements
 
-* ```account```
-    * description: AWS account name or number.
-    * type: ``` string ```
-    * default: ``` testacc ```
-    <br />
+| Name | Version |
+|------|---------|
+| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 3.68 |
+| <a name="requirement_awscc"></a> [awscc](#requirement\_awscc) | ~> 0.9 |
 
-* ```name```
-    * description: Stack name
-    * type: ``` string ```
-    * default: ``` testname ```
-    <br />
+## Providers
 
+No providers.
 
-* ```delimiter```
-    * description: Character such as a slash (/) used between ```name```, ```namespace```, and ```env``` to form the resource name.
-    * type: ``` string ```
-    * default: ``` - ```
-    <br />
+## Modules
 
-* ```attributes```
-    * description: Additional attributes.
-    * type: ``` list ```
-    * default: ``` [] ```
-    <br />
+No modules.
 
-* ```tags```
-    * description: Additional tags.
-    * type: ``` list(object({
-      key   = string
-      value = string
-      })) ```
-    * default: ``` [] ```
-    <br />
+## Resources
 
----
-
-## Usage
+No resources.
 
-    module "label" {
-      source    = "aws-ia/label/aws"
-      version   = "0.0.2"
-      region    = "us-east-1"
-      namespace = "my org"
-      env       = "sit"
-      account   = "aws-account-name"
-      name      = "deployment name"
-      delimiter = "-"
-      tags      = tomap({ propogate_at_launch = "true", "terraform" = "true" })
-    }
-
-For more information please see the `examples` folder.
+## Inputs
 
----
+| Name | Description | Type | Default | Required |
+|------|-------------|------|---------|:--------:|
+| <a name="input_account"></a> [account](#input\_account) | account, which could be AWS Account Name or Number | `any` | `null` | no |
+| <a name="input_attributes"></a> [attributes](#input\_attributes) | attributes, which could be used for additional attributes | `list` | `[]` | no |
+| <a name="input_delimiter"></a> [delimiter](#input\_delimiter) | delimiter, which could be used between name, namespace and env | `string` | `"-"` | no |
+| <a name="input_env"></a> [env](#input\_env) | environment, e.g. 'sit', 'uat', 'prod' etc | `any` | `null` | no |
+| <a name="input_id_order"></a> [id\_order](#input\_id\_order) | n/a | `list` | <pre>[<br>  "namespace",<br>  "account",<br>  "env",<br>  "name"<br>]</pre> | no |
+| <a name="input_name"></a> [name](#input\_name) | stack name | `any` | `null` | no |
+| <a name="input_namespace"></a> [namespace](#input\_namespace) | namespace, which could be your organization name, e.g. amazon | `any` | `null` | no |
+| <a name="input_region"></a> [region](#input\_region) | n/a | `string` | `"us-west-1"` | no |
+| <a name="input_tags"></a> [tags](#input\_tags) | tags, which could be used for additional tags | `any` | `[]` | no |
 
 ## Outputs
 
-* ```tags``` - List of tags.
-
-* ```id``` - ID of a tag delimited with a dash (-).
-
-* ```name``` - Stack name.
-
-* ```namespace``` - Namespace.
-
-* ```account``` - AWS account.
-
-* ```env``` - Environment name.
-
-* ```attributes``` - List of additional attributes.
-
----
+| Name | Description |
+|------|-------------|
+| <a name="output_account"></a> [account](#output\_account) | n/a |
+| <a name="output_attributes"></a> [attributes](#output\_attributes) | n/a |
+| <a name="output_env"></a> [env](#output\_env) | n/a |
+| <a name="output_id"></a> [id](#output\_id) | n/a |
+| <a name="output_name"></a> [name](#output\_name) | n/a |
+| <a name="output_namespace"></a> [namespace](#output\_namespace) | n/a |
+| <a name="output_tags"></a> [tags](#output\_tags) | n/a |
+| <a name="output_tags_aws"></a> [tags\_aws](#output\_tags\_aws) | n/a |

locals.tf

@@ -1,22 +1,32 @@
+# resource "null_resource" "default" {
+#   triggers = local.non_empty_vars_map
+
+#   lifecycle {
+#     create_before_destroy = true
+#   }
+# }
+
 locals {
+  order = ["namespace", "account", "env", "name"]
+  vars = {
+    name      = var.name
+    namespace = var.namespace
+    env       = var.env
+    account   = var.account
+  }
+  non_empty_vars     = [for k, v in local.vars : k if v != null]
+  non_empty_vars_map = { for k in local.non_empty_vars : k => local.vars[k] }
+
+  # using the order from var.id_order, create the delmitied id from vars that are actually passed
+  ordered_id = join(var.delimiter, compact(concat([for k in var.id_order : contains(local.non_empty_vars, k) ? lookup(local.vars, k) : null], var.attributes)))
   generated_tags_awscc = [
+    for k, v in local.non_empty_vars_map :
     {
-      "key" : "Name",
-      "value" : join("", null_resource.default.*.triggers.id)
-    },
-    {
-      "key" : "Namespace",
-      "value" : join("", null_resource.default.*.triggers.namespace),
-    },
-    {
-      "key" : "Account",
-      "value" : join("", null_resource.default.*.triggers.account)
-    },
-    {
-      "key" : "Env",
-      "value" : join("", null_resource.default.*.triggers.env)
+      key : k,
+      value : v
     }
   ]
+
   generated_tags_aws = { for tag in local.generated_tags_awscc : tag["key"] => tag["value"] }
 
   tags = try(
@@ -32,4 +42,4 @@ locals {
     # Tags are in awscc format. Converting to aws format
     merge(local.generated_tags_aws, { for tag in var.tags : tag["key"] => tag["value"] })
   )
-}
+}

main.tf

@@ -8,25 +8,21 @@ output "tags_aws" {
 }
 
 output "id" {
-  value = join("", null_resource.default.*.triggers.id)
+  value = local.ordered_id
 }
 
 output "name" {
-  value = join("", null_resource.default.*.triggers.name)
+  value = local.vars["name"]
 }
 
 output "namespace" {
-  value = join("", null_resource.default.*.triggers.namespace)
+  value = local.vars["namespace"]
 }
 
 output "account" {
-  value = join("", null_resource.default.*.triggers.account)
+  value = local.vars["account"]
 }
 
 output "env" {
-  value = join("", null_resource.default.*.triggers.env)
-}
-
-output "attributes" {
-  value = join("", null_resource.default.*.triggers.attributes)
+  value = local.vars["env"]
 }

output.tf

@@ -0,0 +1,23 @@
+## Requirements
+
+No requirements.
+
+## Providers
+
+No providers.
+
+## Modules
+
+No modules.
+
+## Resources
+
+No resources.
+
+## Inputs
+
+No inputs.
+
+## Outputs
+
+No outputs.

test/README.md

@@ -6,7 +6,7 @@ import (
 	"github.com/gruntwork-io/terratest/modules/terraform"
 )
 
-func validate(t *testing.T, terraformOptions *terraform.Options)  {
+func validate(t *testing.T, terraformOptions *terraform.Options) {
 	defer terraform.Destroy(t, terraformOptions)
 	terraform.InitAndApply(t, terraformOptions)
 }
@@ -30,4 +30,3 @@ func TestFormattedTags(t *testing.T) {
 
 	validate(t, terraformOptions)
 }
-

test/label_test.go

@@ -1,33 +1,40 @@
 variable "region" {
+  type    = string
   default = "us-west-1"
 }
 
 variable "namespace" {
+  type        = string
   description = "namespace, which could be your organization name, e.g. amazon"
-  default     = "testns"
+  default     = null
 }
 
 variable "env" {
+  type        = string
   description = "environment, e.g. 'sit', 'uat', 'prod' etc"
-  default     = "testenv"
+  default     = null
 }
 
 variable "account" {
+  type        = string
   description = "account, which could be AWS Account Name or Number"
-  default     = "testacc"
+  default     = null
 }
 
 variable "name" {
+  type        = string
   description = "stack name"
-  default     = "testname"
+  default     = null
 }
 
 variable "delimiter" {
+  type        = string
   description = "delimiter, which could be used between name, namespace and env"
   default     = "-"
 }
 
 variable "attributes" {
+  type        = list(any)
   default     = []
   description = "attributes, which could be used for additional attributes"
 }
@@ -37,3 +44,9 @@ variable "tags" {
   type        = any
   default     = []
 }
+
+variable "id_order" {
+  type    = list(any)
+  default = ["namespace", "account", "env", "name"]
+
+}

variable.tf

@@ -0,0 +1,21 @@
+terraform {
+  required_providers {
+    awscc = {
+      source  = "hashicorp/awscc"
+      version = "~> 0.9"
+    }
+    aws = {
+      source  = "hashicorp/aws"
+      version = ">= 3.68"
+    }
+  }
+}
+
+provider "awscc" {
+  user_agent = [{
+    product_name    = "terraform-aws-label"
+    product_version = "0.0.1"
+    comment         = "V1/AWS-D69B4015/376222271"
+  }]
+
+}