fix: added a fix to the projects DA variation to address a bug where the order of projects outputs was not consistent (#100)

BREAKING CHANGE: In order to fix this issue, the code was refactored in a way where your code engine projects may be destroyed and recreated. If upgrading from an older version of the DA and your plan has identified your projects to be recreated, bare in mind that any apps running in those projects will also be destroyed.

Author: daniel-butler-irl

solutions/projects/main.tf

@@ -23,8 +23,8 @@ module "resource_group" {
 ########################################################################################################################
 
 module "project" {
-  for_each          = toset(local.projects)
+  count             = length(local.projects)
   source            = "../../modules/project"
-  name              = each.value
+  name              = local.projects[count.index]
   resource_group_id = module.resource_group.resource_group_id
 }

solutions/projects/outputs.tf

@@ -11,50 +11,50 @@ output "project_name_id_map" {
 # As a workaround, we will output the first 5 projects individually. If a project does not exist, the output will be null.
 output "project_1_name" {
   description = "Name of the first project."
-  value       = length(values(module.project)) > 0 ? values(module.project)[0].name : null
+  value       = length(module.project) > 0 ? module.project[0].name : null
 }
 
 output "project_1_id" {
   description = "ID of the first project."
-  value       = length(values(module.project)) > 0 ? values(module.project)[0].project_id : null
+  value       = length(module.project) > 0 ? module.project[0].project_id : null
 }
 
 output "project_2_name" {
   description = "Name of the second project."
-  value       = length(values(module.project)) > 1 ? values(module.project)[1].name : null
+  value       = length(module.project) > 1 ? module.project[1].name : null
 }
 
 output "project_2_id" {
   description = "ID of the second project."
-  value       = length(values(module.project)) > 1 ? values(module.project)[1].project_id : null
+  value       = length(module.project) > 1 ? module.project[1].project_id : null
 }
 
 output "project_3_name" {
   description = "Name of the third project."
-  value       = length(values(module.project)) > 2 ? values(module.project)[2].name : null
+  value       = length(module.project) > 2 ? module.project[2].name : null
 }
 
 output "project_3_id" {
   description = "ID of the third project."
-  value       = length(values(module.project)) > 2 ? values(module.project)[2].project_id : null
+  value       = length(module.project) > 2 ? module.project[2].project_id : null
 }
 
 output "project_4_name" {
   description = "Name of the fourth project."
-  value       = length(values(module.project)) > 3 ? values(module.project)[3].name : null
+  value       = length(module.project) > 3 ? module.project[3].name : null
 }
 
 output "project_4_id" {
   description = "ID of the fourth project."
-  value       = length(values(module.project)) > 3 ? values(module.project)[3].project_id : null
+  value       = length(module.project) > 3 ? module.project[3].project_id : null
 }
 
 output "project_5_name" {
   description = "Name of the fifth project."
-  value       = length(values(module.project)) > 4 ? values(module.project)[4].name : null
+  value       = length(module.project) > 4 ? module.project[4].name : null
 }
 
 output "project_5_id" {
   description = "ID of the fifth project."
-  value       = length(values(module.project)) > 4 ? values(module.project)[4].project_id : null
+  value       = length(module.project) > 4 ? module.project[4].project_id : null
 }

tests/pr_test.go

@@ -2,6 +2,7 @@
 package test
 
 import (
+	"fmt"
 	"log"
 	"os"
 	"testing"
@@ -174,6 +175,30 @@ func TestRunUpgradeAppSolution(t *testing.T) {
 	}
 }
 
+func TestUpgradeCEProjectsDA(t *testing.T) {
+	t.Parallel()
+
+	options := testhelper.TestOptionsDefault(&testhelper.TestOptions{
+		Testing:      t,
+		TerraformDir: "solutions/projects",
+		Prefix:       "ce-da",
+	})
+
+	options.TerraformVars = map[string]interface{}{
+		"resource_group_name":     resourceGroup,
+		"existing_resource_group": true,
+		"prefix":                  options.Prefix,
+		"project_names":           "[\"test-1\", \"test-2\", \"test-3\", \"test-4\", \"test-5\"]",
+	}
+
+	output, err := options.RunTestUpgrade()
+
+	if !options.UpgradeTestSkipped {
+		assert.Nil(t, err, "This should not have errored")
+		assert.NotNil(t, output, "Expected some output")
+	}
+}
+
 func TestDeployCEProjectsDA(t *testing.T) {
 	t.Parallel()
 
@@ -187,10 +212,23 @@ func TestDeployCEProjectsDA(t *testing.T) {
 		"resource_group_name":     resourceGroup,
 		"existing_resource_group": true,
 		"prefix":                  options.Prefix,
-		"project_names":           "[\"test-1\", \"test-2\"]",
+		"project_names":           "[\"test-1\", \"test-2\", \"test-3\", \"test-4\", \"test-5\"]",
 	}
 
 	output, err := options.RunTestConsistency()
+
 	assert.Nil(t, err, "This should not have errored")
 	assert.NotNil(t, output, "Expected some output")
+
+	// Check outputs for project names in correct order
+	expectedOutputs := []string{"project_1_name", "project_2_name", "project_3_name", "project_4_name", "project_5_name"}
+	_, outputErr := testhelper.ValidateTerraformOutputs(options.LastTestTerraformOutputs, expectedOutputs...)
+	if assert.NoErrorf(t, outputErr, "Some outputs not found or nil") {
+		assert.Equal(t, fmt.Sprintf("%s-test-1", options.Prefix), options.LastTestTerraformOutputs["project_1_name"], "Project 1 name not as expected")
+		assert.Equal(t, fmt.Sprintf("%s-test-2", options.Prefix), options.LastTestTerraformOutputs["project_2_name"], "Project 2 name not as expected")
+		assert.Equal(t, fmt.Sprintf("%s-test-3", options.Prefix), options.LastTestTerraformOutputs["project_3_name"], "Project 3 name not as expected")
+		assert.Equal(t, fmt.Sprintf("%s-test-4", options.Prefix), options.LastTestTerraformOutputs["project_4_name"], "Project 4 name not as expected")
+		assert.Equal(t, fmt.Sprintf("%s-test-5", options.Prefix), options.LastTestTerraformOutputs["project_5_name"], "Project 5 name not as expected")
+	}
+
 }