test: add plan validation test (#216)

Co-authored-by: Jordan-Williams2 <[email protected]>

Author: jor2

tests/pr_test.go

@@ -13,6 +13,8 @@ import (
 	"strings"
 	"testing"
 
+	"github.com/gruntwork-io/terratest/modules/logger"
+	"github.com/gruntwork-io/terratest/modules/terraform"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 	"github.com/terraform-ibm-modules/ibmcloud-terratest-wrapper/cloudinfo"
@@ -236,6 +238,63 @@ func TestRunUpgradeCompleteExample(t *testing.T) {
 	}
 }
 
+func TestPlanValidation(t *testing.T) {
+	options := testhelper.TestOptionsDefault(&testhelper.TestOptions{
+		Testing:       t,
+		TerraformDir:  standardSolutionTerraformDir,
+		Prefix:        "validate-plan",
+		ResourceGroup: resourceGroup,
+		Region:        "us-south", // skip VPC region picker
+	})
+	options.TestSetup()
+	options.TerraformOptions.NoColor = true
+	options.TerraformOptions.Logger = logger.Discard
+	options.TerraformOptions.Vars = map[string]interface{}{
+		"prefix":              options.Prefix,
+		"region":              "us-south",
+		"mysql_version":       "8.0",
+		"provider_visibility": "public",
+		"resource_group_name": options.Prefix,
+	}
+
+	// Test the DA when using an existing KMS instance
+	var standardSolutionWithExistingKms = map[string]interface{}{
+		"access_tags":               permanentResources["accessTags"],
+		"existing_kms_instance_crn": permanentResources["hpcs_south_crn"],
+	}
+
+	// Test the DA when using IBM owned encryption key
+	var standardSolutionWithUseIbmOwnedEncKey = map[string]interface{}{
+		"use_ibm_owned_encryption_key": true,
+	}
+
+	// Create a map of the variables
+	tfVarsMap := map[string]map[string]interface{}{
+		"standardSolutionWithExistingKms":       standardSolutionWithExistingKms,
+		"standardSolutionWithUseIbmOwnedEncKey": standardSolutionWithUseIbmOwnedEncKey,
+	}
+
+	_, initErr := terraform.InitE(t, options.TerraformOptions)
+	if assert.Nil(t, initErr, "This should not have errored") {
+		// Iterate over the slice of maps
+		for name, tfVars := range tfVarsMap {
+			t.Run(name, func(t *testing.T) {
+				// Iterate over the keys and values in each map
+				for key, value := range tfVars {
+					options.TerraformOptions.Vars[key] = value
+				}
+				output, err := terraform.PlanE(t, options.TerraformOptions)
+				assert.Nil(t, err, "This should not have errored")
+				assert.NotNil(t, output, "Expected some output")
+				// Delete the keys from the map
+				for key := range tfVars {
+					delete(options.TerraformOptions.Vars, key)
+				}
+			})
+		}
+	}
+}
+
 func GetRandomAdminPassword(t *testing.T) string {
 	// Generate a 15 char long random string for the admin_pass
 	randomBytes := make([]byte, 13)