feat(terraform-recipe): resource group tagging

.gitignore

@@ -12,3 +12,5 @@ pkg/hq/test.logs
 pkg/recipes/terraform/test.tfvars
 
 cmd/example-infra/example-infra.log
+
+pkg/recipes/terraform/.plans/

pkg/recipes/terraform/backend_storage_settings.go

@@ -2,12 +2,14 @@ package terraform
 
 type BackendStorageSettings struct {
 	CreateResourceGroup bool
+	ResourceGroupTags   map[string]string
 	BlobContainerName   string
 	BlobContainerKey    string
 }
 
 var DefaultBackendStorageSettings = BackendStorageSettings{
 	CreateResourceGroup: true,
+	ResourceGroupTags:   map[string]string{},
 	BlobContainerName:   "tfstate",
 	BlobContainerKey:    "terraform.tfstate",
 }

pkg/recipes/terraform/tags.go

@@ -0,0 +1,18 @@
+package terraform
+
+import (
+	"fmt"
+	"strings"
+)
+
+// serializeTagsIntoAzureCliString converts the given tags from the map to a text that can be passed to an azure cli command
+// with the --tags parameter
+// The key and value will be quoted e.g. "This is a key"="This is a value" (to support key and value with spaces)
+func serializeTagsIntoAzureCliString(tags map[string]string) string {
+	var tagTexts []string
+	for key, value := range tags {
+		tagTexts = append(tagTexts, fmt.Sprintf("%q=%q", key, value))
+	}
+
+	return strings.Join(tagTexts, " ")
+}

pkg/recipes/terraform/tags_test.go

@@ -0,0 +1,19 @@
+package terraform
+
+import (
+	"github.com/stretchr/testify/assert"
+	"testing"
+)
+
+func Test_TagSerialization(t *testing.T) {
+	result := serializeTagsIntoAzureCliString(map[string]string{
+		"tag1":  "valueA",
+		"tag_b": "long string value",
+		"tag-c": "123",
+	})
+
+	// has to be asserted separately, because iterating go maps does not guarantee order!
+	assert.Contains(t, result, "\"tag1\"=\"valueA\"", result)
+	assert.Contains(t, result, "\"tag_b\"=\"long string value\"", result)
+	assert.Contains(t, result, "\"tag-c\"=\"123\"", result)
+}

pkg/recipes/terraform/terraform.go

@@ -92,7 +92,13 @@ type terraformWrapper struct {
 func (tf *terraformWrapper) Init() error {
 	if tf.storageSettings.CreateResourceGroup {
 		logrus.Info("Deploying the project " + tf.projectName + " resource group " + tf.resourceGroupName + "...")
-		_, err := tf.executor.Execute("az group create -l " + tf.region + " -n " + tf.resourceGroupName)
+
+		optionalTags := ""
+		if len(tf.storageSettings.ResourceGroupTags) > 0 {
+			optionalTags = " --tags " + serializeTagsIntoAzureCliString(tf.storageSettings.ResourceGroupTags)
+		}
+
+		_, err := tf.executor.Execute("az group create -l " + tf.region + " -n " + tf.resourceGroupName + optionalTags)
 
 		if err != nil {
 			return internal.ReturnErrorOrPanic(err)

pkg/recipes/terraform/terraform_test.go

@@ -191,10 +191,14 @@ type variablesStruct struct {
 func createSimpleTerraformWithDefaultSettings(projectName string) (Terraform, *executorMock) {
 	executor := &executorMock{}
 
+	backendStorageSettings := DefaultBackendStorageSettings
+	backendStorageSettings.ResourceGroupTags["test"] = "value"
+
 	return New(executor, projectName, "1234", "3214",
 		"westeurope", "testrg", "storeaccount",
 		// important to keep the current directory configured, since some tests rely on this
 		// location to verify that expected directories / files are created
 		filepath.Join("."),
-		DefaultBackendStorageSettings, DefaultDeploymentSettings), executor
+		backendStorageSettings,
+		DefaultDeploymentSettings), executor
 }