feat: Support has been removed from the DA for creating a new resource group<br>- existing_resource_group and resource_group_name inputs have been replaced by new input existing_resource_group_name (with a default value of Default) (#177)

akocbek · web-flow · commit ffe51984482f · 2025-04-07T15:28:48.000+01:00
BREAKING CHANGE: If you are upgrading from a previous release and creating a new resource group as part of the DA, resources will be recreated if you are not using the Default resource group
diff --git a/cra-config.yaml b/cra-config.yaml
@@ -6,7 +6,7 @@ CRA_TARGETS:
     PROFILE_ID: "fe96bd4d-9b37-40f2-b39f-a62760e326a3" # SCC profile ID (currently set to 'IBM Cloud Framework for Financial Services' '1.7.0' profile).
     CRA_ENVIRONMENT_VARIABLES:
       TF_VAR_provider_visibility: "public"
-      TF_VAR_resource_group_name: "resource_group_name_temp"
+      TF_VAR_existing_resource_group_name: "geretain-test-resources"
       TF_VAR_app_name: "app-name"
       TF_VAR_image_reference: "icr.io/codeengine/helloworld"
       TF_VAR_project_name: "project-name"
@@ -16,7 +16,7 @@ CRA_TARGETS:
     PROFILE_ID: "fe96bd4d-9b37-40f2-b39f-a62760e326a3" # SCC profile ID (currently set to 'IBM Cloud Framework for Financial Services' '1.7.0' profile).
     CRA_ENVIRONMENT_VARIABLES:
       TF_VAR_provider_visibility: "public"
-      TF_VAR_resource_group_name: "resource_group_name_temp"
+      TF_VAR_existing_resource_group_name: "geretain-test-resources"
       TF_VAR_project_name: "project-name"
       TF_VAR_prefix: "test"
     # SCC_INSTANCE_ID: "" # The SCC instance ID to use to download profile for CRA scan. If not provided, a default global value will be used.
diff --git a/ibm_catalog.json b/ibm_catalog.json
@@ -145,10 +145,16 @@
               "required": true
             },
             {
-              "key": "existing_resource_group"
-            },
-            {
-              "key": "resource_group_name"
+              "key": "existing_resource_group_name",
+              "required": true,
+              "custom_config": {
+                "type": "resource_group",
+                "grouping": "deployment",
+                "original_grouping": "deployment",
+                "config_constraints": {
+                  "identifier": "rg_name"
+                }
+              }
             },
             {
               "key": "region",
@@ -314,10 +320,16 @@
               "required": true
             },
             {
-              "key": "existing_resource_group"
-            },
-            {
-              "key": "resource_group_name"
+              "key": "existing_resource_group_name",
+              "required": true,
+              "custom_config": {
+                "type": "resource_group",
+                "grouping": "deployment",
+                "original_grouping": "deployment",
+                "config_constraints": {
+                  "identifier": "rg_name"
+                }
+              }
             },
             {
               "key": "region",
diff --git a/solutions/apps/catalogValidationValues.json.template b/solutions/apps/catalogValidationValues.json.template
@@ -1,6 +1,6 @@
 {
   "ibmcloud_api_key": $VALIDATION_APIKEY,
-  "resource_group_name": $PREFIX,
+  "existing_resource_group_name": "geretain-test-resources",
   "project_name": $PREFIX,
   "app_name": $PREFIX,
   "image_reference": "icr.io/codeengine/helloworld"
diff --git a/solutions/apps/main.tf b/solutions/apps/main.tf
@@ -5,8 +5,7 @@
 module "resource_group" {
   source                       = "terraform-ibm-modules/resource-group/ibm"
   version                      = "1.2.0"
-  resource_group_name          = var.existing_resource_group == false ? var.resource_group_name : null
-  existing_resource_group_name = var.existing_resource_group == true ? var.resource_group_name : null
+  existing_resource_group_name = var.existing_resource_group_name
 }
 
 locals {
diff --git a/solutions/apps/variables.tf b/solutions/apps/variables.tf
@@ -31,15 +31,10 @@ variable "prefix" {
   nullable    = true
 }
 
-variable "existing_resource_group" {
-  type        = bool
-  description = "Whether to use an existing resource group."
-  default     = false
-}
-
-variable "resource_group_name" {
+variable "existing_resource_group_name" {
   type        = string
-  description = "The name of a new or an existing resource group to provision the IBM Cloud Code Engine resources to."
+  description = "The name of an existing resource group to provision the resources."
+  default     = "Default"
 }
 
 variable "project_name" {
diff --git a/solutions/project/catalogValidationValues.json.template b/solutions/project/catalogValidationValues.json.template
@@ -1,6 +1,6 @@
 {
   "ibmcloud_api_key": $VALIDATION_APIKEY,
-  "resource_group_name": $PREFIX,
+  "existing_resource_group_name": "geretain-test-resources",
   "prefix": $PREFIX,
   "project_name": "project1"
 }
diff --git a/solutions/project/main.tf b/solutions/project/main.tf
@@ -5,12 +5,13 @@
 module "resource_group" {
   source                       = "terraform-ibm-modules/resource-group/ibm"
   version                      = "1.2.0"
-  resource_group_name          = var.existing_resource_group == false ? var.resource_group_name : null
-  existing_resource_group_name = var.existing_resource_group == true ? var.resource_group_name : null
+  existing_resource_group_name = var.existing_resource_group_name
 }
+
 locals {
   prefix = var.prefix != null ? trimspace(var.prefix) != "" ? "${var.prefix}-" : "" : ""
 }
+
 ########################################################################################################################
 # Code Engine Project
 ########################################################################################################################
diff --git a/solutions/project/variables.tf b/solutions/project/variables.tf
@@ -29,15 +29,10 @@ variable "region" {
   default     = "us-south"
 }
 
-variable "existing_resource_group" {
-  type        = bool
-  description = "Whether to use an existing resource group."
-  default     = false
-}
-
-variable "resource_group_name" {
+variable "existing_resource_group_name" {
   type        = string
-  description = "The name of a new or an existing resource group to provision the IBM Cloud Code Engine resources to."
+  description = "The name of an existing resource group to provision the resources."
+  default     = "Default"
 }
 
 variable "project_name" {
diff --git a/tests/pr_test.go b/tests/pr_test.go
@@ -17,6 +17,7 @@ const resourceGroup = "geretain-test-resources"
 const appsExampleDir = "examples/apps"
 const jobsExampleDir = "examples/jobs"
 const appsSolutionsDir = "solutions/apps"
+const projectSolutionsDir = "solutions/project"
 
 // Define a struct with fields that match the structure of the YAML data
 const yamlLocation = "../common-dev-assets/common-go-assets/common-permanent-resources.yaml"
@@ -132,8 +133,7 @@ func TestRunAppSolutionInSchematics(t *testing.T) {
 
 	options.TerraformVars = []testschematic.TestSchematicTerraformVar{
 		{Name: "ibmcloud_api_key", Value: options.RequiredEnvironmentVars["TF_VAR_ibmcloud_api_key"], DataType: "string", Secure: true},
-		{Name: "resource_group_name", Value: options.ResourceGroup, DataType: "string"},
-		{Name: "existing_resource_group", Value: true, DataType: "bool"},
+		{Name: "existing_resource_group_name", Value: options.ResourceGroup, DataType: "string"},
 		{Name: "prefix", Value: options.Prefix, DataType: "string"},
 		{Name: "app_name", Value: options.Prefix + "-app", DataType: "string"},
 		{Name: "image_reference", Value: "icr.io/codeengine/helloworld", DataType: "string"},
@@ -163,16 +163,15 @@ func TestRunUpgradeAppSolution(t *testing.T) {
 		},
 	}
 	options.TerraformVars = map[string]interface{}{
-		"ibmcloud_api_key":        options.RequiredEnvironmentVars["TF_VAR_ibmcloud_api_key"],
-		"resource_group_name":     resourceGroup,
-		"existing_resource_group": true,
-		"app_name":                options.Prefix + "-app",
-		"image_reference":         "icr.io/codeengine/helloworld",
-		"provider_visibility":     "public",
-		"prefix":                  options.Prefix,
-		"secrets":                 "{" + options.Prefix + "-secret:{format:\"generic\", data:{ key_1 : \"value_1\" }}}", // pragma: allowlist secret
-		"config_maps":             "{" + options.Prefix + "-cm:{data:{ key_1 : \"value_1\" }}}",
-		"project_name":            options.Prefix + "-pro",
+		"ibmcloud_api_key":             options.RequiredEnvironmentVars["TF_VAR_ibmcloud_api_key"],
+		"existing_resource_group_name": resourceGroup,
+		"app_name":                     options.Prefix + "-app",
+		"image_reference":              "icr.io/codeengine/helloworld",
+		"provider_visibility":          "public",
+		"prefix":                       options.Prefix,
+		"secrets":                      "{" + options.Prefix + "-secret:{format:\"generic\", data:{ key_1 : \"value_1\" }}}", // pragma: allowlist secret
+		"config_maps":                  "{" + options.Prefix + "-cm:{data:{ key_1 : \"value_1\" }}}",
+		"project_name":                 options.Prefix + "-pro",
 	}
 
 	output, err := options.RunTestUpgrade()
@@ -187,16 +186,15 @@ func TestUpgradeCEProjectDA(t *testing.T) {
 
 	options := testhelper.TestOptionsDefault(&testhelper.TestOptions{
 		Testing:      t,
-		TerraformDir: "solutions/project",
+		TerraformDir: projectSolutionsDir,
 		Prefix:       "ce-da",
 	})
 
 	options.TerraformVars = map[string]interface{}{
-		"resource_group_name":     resourceGroup,
-		"existing_resource_group": true,
-		"provider_visibility":     "public",
-		"prefix":                  options.Prefix,
-		"project_name":            "test-1",
+		"existing_resource_group_name": resourceGroup,
+		"provider_visibility":          "public",
+		"prefix":                       options.Prefix,
+		"project_name":                 "test-1",
 	}
 
 	output, err := options.RunTestUpgrade()
@@ -212,16 +210,15 @@ func TestDeployCEProjectDA(t *testing.T) {
 
 	options := testhelper.TestOptionsDefault(&testhelper.TestOptions{
 		Testing:      t,
-		TerraformDir: "solutions/project",
+		TerraformDir: projectSolutionsDir,
 		Prefix:       "ce-da",
 	})
 
 	options.TerraformVars = map[string]interface{}{
-		"resource_group_name":     resourceGroup,
-		"existing_resource_group": true,
-		"prefix":                  options.Prefix,
-		"provider_visibility":     "public",
-		"project_name":            "test-1",
+		"existing_resource_group_name": resourceGroup,
+		"prefix":                       options.Prefix,
+		"provider_visibility":          "public",
+		"project_name":                 "test-1",
 	}
 
 	output, err := options.RunTestConsistency()

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"ibmcloud_api_key": $VALIDATION_APIKEY,`
`3`		`- "resource_group_name": $PREFIX,`
	`3`	`+ "existing_resource_group_name": "geretain-test-resources",`
`4`	`4`	`"project_name": $PREFIX,`
`5`	`5`	`"app_name": $PREFIX,`
`6`	`6`	`"image_reference": "icr.io/codeengine/helloworld"`
Original file line number	Diff line number	Diff line change
`@@ -5,8 +5,7 @@`
`5`	`5`	`module "resource_group" {`
`6`	`6`	`source = "terraform-ibm-modules/resource-group/ibm"`
`7`	`7`	`version = "1.2.0"`
`8`		`- resource_group_name = var.existing_resource_group == false ? var.resource_group_name : null`
`9`		`- existing_resource_group_name = var.existing_resource_group == true ? var.resource_group_name : null`
	`8`	`+ existing_resource_group_name = var.existing_resource_group_name`
`10`	`9`	`}`
`11`	`10`
`12`	`11`	`locals {`