fix: update DA to accept prefix as empty string ("") and mark as required in catalog manifest.<br>-add prefix for project name in apps DA <br>-prefix variable is mandatoryand can accept null (#152)

arya-girish-k · Arya Girish K · web-flow · commit 70e037e94c79 · 2025-03-14T15:58:40.000+05:30
* refactor: update prefix logic in DA

* Modified prefix description

* modified prefix value

* modfied prefix logic

* Update the logic

* Update common-dev-assets

* Resolved Precommit error

* Resolved Pre-commit error

* Updated the code

* Added prefix logic in apps variant

* SKIP UPGRADE TEST

* Updated the code

* Update prefix value and description

* removed default value

* updated cra-config.yaml

* Added prefix in test

* Resolved comments

---------

Co-authored-by: Arya Girish K &lt;arya.girish.k@ibm.com&gt;
diff --git a/cra-config.yaml b/cra-config.yaml
@@ -10,13 +10,15 @@ CRA_TARGETS:
       TF_VAR_app_name: "app-name"
       TF_VAR_image_reference: "icr.io/codeengine/helloworld"
       TF_VAR_project_name: "project-name"
+      TF_VAR_prefix: "test"
   - CRA_TARGET: "solutions/project" # Target directory for CRA scan. If not provided, the CRA Scan will not be run.
     CRA_IGNORE_RULES_FILE: "cra-tf-validate-ignore-rules.json" # CRA Ignore file to use. If not provided, it checks the repo root directory for `cra-tf-validate-ignore-rules.json`
     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_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.
     # SCC_REGION: "" # The IBM Cloud region that the SCC instance is in. If not provided, a default global value will be used.
     # CRA_ENVIRONMENT_VARIABLES:  # An optional map of environment variables for CRA, where the key is the variable name and value is the value. Useful for providing TF_VARs.
diff --git a/ibm_catalog.json b/ibm_catalog.json
@@ -140,6 +140,11 @@
                 }
               ]
             },
+            {
+              "key": "prefix",
+              "required": true,
+              "description": "Prefix to add to all projects created by this solution (e.g `prod`, `test`, `dev`). To not use any prefix value, you can enter the string `__NULL__`."
+            },
             {
               "key": "existing_resource_group"
             },
@@ -306,7 +311,9 @@
               ]
             },
             {
-              "key": "prefix"
+              "key": "prefix",
+              "required": true,
+              "description": "Prefix to add to all projects created by this solution (e.g `prod`, `test`, `dev`). To not use any prefix value, you can enter the string `__NULL__`."
             },
             {
               "key": "existing_resource_group"
@@ -329,10 +336,10 @@
               }
             },
             {
-              "key": "project_name"
+              "key": "cbr_rules"
             },
             {
-              "key": "cbr_rules"
+              "key": "project_name"
             }
           ]
         }
diff --git a/solutions/apps/main.tf b/solutions/apps/main.tf
@@ -9,14 +9,18 @@ module "resource_group" {
   existing_resource_group_name = var.existing_resource_group == true ? var.resource_group_name : null
 }
 
+locals {
+  prefix = var.prefix != null ? trimspace(var.prefix) != "" ? "${var.prefix}-" : "" : ""
+}
+
 ########################################################################################################################
 # Code Engine instance
 ########################################################################################################################
 
 module "code_engine" {
   source              = "../.."
   resource_group_id   = module.resource_group.resource_group_id
-  project_name        = var.project_name
+  project_name        = var.project_name != null ? "${local.prefix}${var.project_name}" : null
   existing_project_id = var.existing_project_id
   cbr_rules           = var.cbr_rules
   apps = {
diff --git a/solutions/apps/variables.tf b/solutions/apps/variables.tf
@@ -25,6 +25,12 @@ variable "region" {
   default     = "us-south"
 }
 
+variable "prefix" {
+  type        = string
+  description = "Prefix added to the project created by this solution (e.g `prod`, `test`, `dev`). To not use any prefix value, you can set this value to `null` or an empty string."
+  nullable    = true
+}
+
 variable "existing_resource_group" {
   type        = bool
   description = "Whether to use an existing resource group."
diff --git a/solutions/project/main.tf b/solutions/project/main.tf
@@ -8,14 +8,16 @@ module "resource_group" {
   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
 }
-
+locals {
+  prefix = var.prefix != null ? trimspace(var.prefix) != "" ? "${var.prefix}-" : "" : ""
+}
 ########################################################################################################################
 # Code Engine Project
 ########################################################################################################################
 
 module "project" {
   source            = "../../modules/project"
-  name              = var.prefix != null ? "${var.prefix}-${var.project_name}" : var.project_name
+  name              = "${local.prefix}${var.project_name}"
   resource_group_id = module.resource_group.resource_group_id
   cbr_rules         = var.cbr_rules
 }
diff --git a/solutions/project/variables.tf b/solutions/project/variables.tf
@@ -19,8 +19,7 @@ variable "provider_visibility" {
 }
 variable "prefix" {
   type        = string
-  description = "Prefix added to the project created by this solution."
-  default     = null
+  description = "Prefix added to the project created by this solution (e.g `prod`, `test`, `dev`). To not use any prefix value, you can set this value to `null` or an empty string."
   nullable    = true
 }
 
diff --git a/tests/pr_test.go b/tests/pr_test.go
@@ -129,6 +129,7 @@ func TestRunAppSolutionInSchematics(t *testing.T) {
 		{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: "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"},
 		{Name: "secrets", Value: "{" + options.Prefix + "-secret:{format:\"generic\", data:{ key_1 : \"value_1\" }}}", DataType: "object"}, // pragma: allowlist secret
@@ -163,6 +164,7 @@ func TestRunUpgradeAppSolution(t *testing.T) {
 		"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",

Original file line number	Diff line number	Diff line change
`@@ -140,6 +140,11 @@`
`140`	`140`	`}`
`141`	`141`	`]`
`142`	`142`	`},`
	`143`	`+ {`
	`144`	`+ "key": "prefix",`
	`145`	`+ "required": true,`
	`146`	+ "description": "Prefix to add to all projects created by this solution (e.g `prod`, `test`, `dev`). To not use any prefix value, you can enter the string `__NULL__`."
	`147`	`+ },`
`143`	`148`	`{`
`144`	`149`	`"key": "existing_resource_group"`
`145`	`150`	`},`
`@@ -306,7 +311,9 @@`
`306`	`311`	`]`
`307`	`312`	`},`
`308`	`313`	`{`
`309`		`- "key": "prefix"`
	`314`	`+ "key": "prefix",`
	`315`	`+ "required": true,`
	`316`	+ "description": "Prefix to add to all projects created by this solution (e.g `prod`, `test`, `dev`). To not use any prefix value, you can enter the string `__NULL__`."
`310`	`317`	`},`
`311`	`318`	`{`
`312`	`319`	`"key": "existing_resource_group"`
`@@ -329,10 +336,10 @@`
`329`	`336`	`}`
`330`	`337`	`},`
`331`	`338`	`{`
`332`		`- "key": "project_name"`
	`339`	`+ "key": "cbr_rules"`
`333`	`340`	`},`
`334`	`341`	`{`
`335`		`- "key": "cbr_rules"`
	`342`	`+ "key": "project_name"`
`336`	`343`	`}`
`337`	`344`	`]`
`338`	`345`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,8 +19,7 @@ variable "provider_visibility" {`
`19`	`19`	`}`
`20`	`20`	`variable "prefix" {`
`21`	`21`	`type = string`
`22`		`- description = "Prefix added to the project created by this solution."`
`23`		`- default = null`
	`22`	+ description = "Prefix added to the project created by this solution (e.g `prod`, `test`, `dev`). To not use any prefix value, you can set this value to `null` or an empty string."
`24`	`23`	`nullable = true`
`25`	`24`	`}`
`26`	`25`