reorg and add tests for optional attrs

Author: drewmullen

examples/basic/main.tf

@@ -5,11 +5,11 @@ provider "awscc" {
 module "labels" {
   source = "../.."
 
-  name      = "measurements"
-  namespace = "link"
+  name      = var.name
+  namespace = var.namespace
 
-  env     = "sandbox"
-  account = "sandbox001"
+  env     = var.env
+  account = var.account
 
   region = var.region
   tags = [

examples/basic/outputs.tf

@@ -1,3 +1,7 @@
 output "tags" {
   value = module.labels.tags
-}
+}
+
+output "id" {
+  value = module.labels.id
+}

examples/basic/variables.tf

@@ -3,3 +3,27 @@ variable "region" {
   default     = "eu-west-1"
   description = "What AWS region to deploy resources in."
 }
+
+variable "namespace" {
+  type        = string
+  description = "namespace, which could be your organization name, e.g. amazon"
+  default     = "link"
+}
+
+variable "env" {
+  type        = string
+  description = "environment, e.g. 'sit', 'uat', 'prod' etc"
+  default     = "sandbox"
+}
+
+variable "account" {
+  type        = string
+  description = "account, which could be AWS Account Name or Number"
+  default     = "sandbox001"
+}
+
+variable "name" {
+  type        = string
+  description = "stack name"
+  default     = "measurements"
+}

locals.tf

@@ -1,9 +1,9 @@
 locals {
   vars = {
-    name      = var.name
     namespace = var.namespace
-    env       = var.env
     account   = var.account
+    env       = var.env
+    name      = var.name
   }
   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] }

output.tf

@@ -1,4 +1,3 @@
-
 output "tags" {
   value = local.tags
 }

test/examples_basic_test.go

@@ -0,0 +1,22 @@
+package test
+
+import (
+	"testing"
+
+	"github.com/gruntwork-io/terratest/modules/terraform"
+)
+
+func Validate(t *testing.T, terraformOptions *terraform.Options) {
+	defer terraform.Destroy(t, terraformOptions)
+	terraform.InitAndApply(t, terraformOptions)
+}
+
+func TestBasic(t *testing.T) {
+	t.Parallel()
+
+	terraformOptions := &terraform.Options{
+		TerraformDir: "../examples/basic",
+	}
+
+	Validate(t, terraformOptions)
+}

test/examples_formatted_tags_test.go

@@ -0,0 +1,17 @@
+package test
+
+import (
+	"testing"
+
+	"github.com/gruntwork-io/terratest/modules/terraform"
+)
+
+func TestFormattedTags(t *testing.T) {
+	t.Parallel()
+
+	terraformOptions := &terraform.Options{
+		TerraformDir: "../examples/formatted_tags",
+	}
+
+	Validate(t, terraformOptions)
+}

test/label_test.go

@@ -1,32 +1,95 @@
 package test
 
 import (
+	"strings"
 	"testing"
 
 	"github.com/gruntwork-io/terratest/modules/terraform"
+	"github.com/stretchr/testify/assert"
 )
 
-func validate(t *testing.T, terraformOptions *terraform.Options) {
+const (
+	namespace_value = "mynamespace"
+	account_value   = "myaccount"
+	env_value       = "myenv"
+	name_value      = "myname"
+	delimiter       = "-"
+	module_dir      = "../"
+)
+
+func TestAllVarsInId(t *testing.T) {
+	all_vars_expected := []string{namespace_value, account_value, env_value, name_value}
+	all_vars_expected_id := strings.Join(all_vars_expected, delimiter)
+
+	terraformOptions := &terraform.Options{
+		TerraformDir: module_dir,
+		Vars: map[string]interface{}{
+			"namespace": namespace_value,
+			"account":   account_value,
+			"env":       env_value,
+			"name":      name_value,
+		},
+	}
 	defer terraform.Destroy(t, terraformOptions)
 	terraform.InitAndApply(t, terraformOptions)
+
+	// Validate `id` only made of optionally passed vars, env-name
+	output_id := terraform.Output(t, terraformOptions, "id")
+	assert.Equal(t, all_vars_expected_id, output_id)
+
+	// Validate `tags` only made of optionally passed vars, env-name
+	output_tags := terraform.OutputListOfObjects(t, terraformOptions, "tags")
+	assert.Equal(t, len(all_vars_expected), len(output_tags))
+
+	// Validate `tags_aws` made of all passed, namespace-account-env-name
+	output_tags_aws := terraform.OutputMap(t, terraformOptions, "tags_aws")
+	assert.Equal(t, len(all_vars_expected), len(output_tags_aws))
 }
 
-func TestBasic(t *testing.T) {
-	t.Parallel()
+func TestOptionalVarsInId(t *testing.T) {
+	opt_vars_expected := []string{env_value, name_value}
+	opt_vars_expected_id := strings.Join(opt_vars_expected, delimiter)
 
 	terraformOptions := &terraform.Options{
-		TerraformDir: "../examples/basic",
+		TerraformDir: module_dir,
+		Vars: map[string]interface{}{
+			"env":  env_value,
+			"name": name_value,
+		},
 	}
+	defer terraform.Destroy(t, terraformOptions)
+	terraform.InitAndApply(t, terraformOptions)
+
+	// Validate `id` only made of optionally passed vars, env-name
+	output_id := terraform.Output(t, terraformOptions, "id")
+	assert.Equal(t, opt_vars_expected_id, output_id)
 
-	validate(t, terraformOptions)
+	// Validate `tags` only made of optionally passed vars, env-name
+	output_tags := terraform.OutputListOfObjects(t, terraformOptions, "tags")
+	assert.Equal(t, len(opt_vars_expected), len(output_tags))
+
+	// Validate `tags_aws` only made of optionally passed vars, env-name
+	output_tags_aws := terraform.OutputMap(t, terraformOptions, "tags_aws")
+	assert.Equal(t, len(opt_vars_expected), len(output_tags_aws))
 }
 
-func TestFormattedTags(t *testing.T) {
-	t.Parallel()
+func TestOptionalVarsInIdReordered(t *testing.T) {
+	reordered_opt_vars_expected := []string{name_value, env_value}
+	reordered_opt_vars_expected_id := strings.Join(reordered_opt_vars_expected, delimiter)
+	reordered := []string{"name", "env"}
 
 	terraformOptions := &terraform.Options{
-		TerraformDir: "../examples/formatted_tags",
+		TerraformDir: module_dir,
+		Vars: map[string]interface{}{
+			"env":      env_value,
+			"name":     name_value,
+			"id_order": reordered,
+		},
 	}
+	defer terraform.Destroy(t, terraformOptions)
+	terraform.InitAndApply(t, terraformOptions)
 
-	validate(t, terraformOptions)
+	// Validate `id` only made of optionally passed vars, env-name
+	output_id_reordered := terraform.Output(t, terraformOptions, "id")
+	assert.Equal(t, reordered_opt_vars_expected_id, output_id_reordered)
 }