fix: allow prefix as empty string, set default value as devand upda…

…tes resource group logic to handle `existing_resource_group` (#48) * refactor: Updated DA prefix and resource group logic, added related variables * fix: Update cra-config.yaml * fix: Update variable.tf * fix: Update pr_test.go * fix:: Update prefix logic and resolved comments --------- Co-authored-by: Arya Girish K <[email protected]>
terraform-ibm-modules · Feb 3, 2025 · a78308b · a78308b
1 parent 41698e8
commit a78308b
Show file tree

Hide file tree

Showing 7 changed files with 38 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -189,7 +189,7 @@ No modules.
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
 | <a name="input_config_repo"></a> [config\_repo](#input\_config\_repo) | The URL for the repository storing the configuration to use for the application to run through Enterprise Application Service on IBM Cloud. | `string` | `null` | no |
-| <a name="input_ease_name"></a> [ease\_name](#input\_ease\_name) | The name for the newly provisioned Enterprise Application Service instance. | `string` | n/a | yes |
+| <a name="input_ease_name"></a> [ease\_name](#input\_ease\_name) | The name for the newly provisioned Enterprise Application Service instance. | `string` | `"instance"` | no |
 | <a name="input_maven_repository_password"></a> [maven\_repository\_password](#input\_maven\_repository\_password) | Maven repository authentication password if needed. Default to null. | `string` | `null` | no |
 | <a name="input_maven_repository_username"></a> [maven\_repository\_username](#input\_maven\_repository\_username) | Maven repository authentication username if needed. Default to null. | `string` | `null` | no |
 | <a name="input_plan"></a> [plan](#input\_plan) | The desired pricing plan for Enterprise Application Service instance. | `string` | `"standard"` | no |

diff --git a/cra-config.yaml b/cra-config.yaml
@@ -10,3 +10,4 @@ CRA_TARGETS:
       TF_VAR_source_repo: "https://github.com/tim-openliberty-appflow-test/sample-getting-started"
       TF_VAR_repos_git_token_secret_crn: "crn:v1:bluemix:public:secrets-manager:us-south:a/abac0df06b644a9cabc6e44f55b3880e:79c6d411-c18f-4670-b009-b0044a238667:secret:825a3797-1bc8-f47a-611a-c9bd2b0ef846" # pragma: allowlist secret
       TF_VAR_subscription_id_secret_crn: "crn:v1:bluemix:public:secrets-manager:us-south:a/abac0df06b644a9cabc6e44f55b3880e:79c6d411-c18f-4670-b009-b0044a238667:secret:71363d27-db8d-dd07-c72b-59ecb3884a8f" # pragma: allowlist secret
+      TF_VAR_resource_group_name: "Default"
diff --git a/ibm_catalog.json b/ibm_catalog.json
@@ -87,7 +87,13 @@
                 "required": true
               },
               {
-                "key": "resource_group"
+                "key": "use_existing_resource_group"
+              },
+              {
+                "key": "resource_group_name"
+              },
+              {
+                "key": "ease_name"
               },
               {
                 "key": "region",
@@ -102,8 +108,8 @@
               },
               {
                 "key": "prefix",
-                "default_value": "",
-                "required": true
+                "required": true,
+                "description": "Prefix to add to all resources created by this solution. To not use any prefix value, you can enter the string `__NULL__`."
               },
               {
                 "key": "plan",

diff --git a/solutions/standard/main.tf b/solutions/standard/main.tf
@@ -1,5 +1,6 @@
 locals {
   sleep_create = "30s"
+  prefix       = var.prefix != null ? (var.prefix != "" ? var.prefix : null) : null
 }
 
 ########################################################################################################################
@@ -10,8 +11,8 @@ module "resource_group" {
   source  = "terraform-ibm-modules/resource-group/ibm"
   version = "1.1.6"
   # if an existing resource group is not set (null) create a new one using prefix
-  resource_group_name          = var.resource_group == null ? "${var.prefix}-resource-group" : null
-  existing_resource_group_name = var.resource_group
+  resource_group_name          = var.use_existing_resource_group == false ? try("${local.prefix}-${var.resource_group_name}", var.resource_group_name) : null
+  existing_resource_group_name = var.use_existing_resource_group == true ? var.resource_group_name : null
 }
 
 ########################################################################################################################
@@ -82,7 +83,7 @@ locals {
 
 module "ease" {
   source            = "../../"
-  ease_name         = "${var.prefix}-app"
+  ease_name         = try("${var.prefix}-${var.ease_name}", var.ease_name)
   resource_group_id = module.resource_group.resource_group_id
   tags              = var.resource_tags
   plan              = var.plan

diff --git a/solutions/standard/variables.tf b/solutions/standard/variables.tf
@@ -16,14 +16,25 @@ variable "resource_tags" {
 
 variable "prefix" {
   type        = string
-  description = "Prefix to append to all resources created by this deployable architecture"
-  default     = "ease-da"
+  description = "Prefix to add to all resources created by this deployable architecture . To not use any prefix value, you can set this value to `null` or an empty string."
+  default     = "dev"
 }
 
-variable "resource_group" {
+variable "use_existing_resource_group" {
+  type        = bool
+  description = "Whether to use an existing resource group."
+  default     = false
+}
+
+variable "resource_group_name" {
   type        = string
-  description = "The name of an existing resource group to provision resources in to. If not set a new resource group will be created using the prefix variable value"
-  default     = null
+  description = "The name of a new or an existing resource group to provision resources in to. If not set a new resource group will be created using the prefix variable value"
+}
+
+variable "ease_name" {
+  type        = string
+  description = "The name for the newly provisioned Enterprise Application Service instance."
+  default     = "instance"
 }
 
 variable "plan" {

diff --git a/tests/pr_test.go b/tests/pr_test.go
@@ -174,7 +174,12 @@ func TestRunDrCompleteExample(t *testing.T) {
 func TestRunUpgradeExample(t *testing.T) {
 	t.Parallel()
 
-	options := setupOptions(t, "ease-upgrade", basicExampleDir, nil)
+	extTerraformVars := map[string]interface{}{
+		"subscription_id_secret_crn": subscriptionIdSecretCRN,
+		"plan":                       testPlan,
+	}
+
+	options := setupOptions(t, "ease-upgrade", basicExampleDir, extTerraformVars)
 
 	output, err := options.RunTestUpgrade()
 	if !options.UpgradeTestSkipped {

diff --git a/variables.tf b/variables.tf
@@ -10,6 +10,7 @@ variable "resource_group_id" {
 variable "ease_name" {
   type        = string
   description = "The name for the newly provisioned Enterprise Application Service instance."
+  default     = "instance"
 }
 
 variable "tags" {