feat: add support to return default resource group when strings 'Default' or 'default' are passed (#747)

Author: ocofaigh

README.md

@@ -6,7 +6,7 @@
 [![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com/)
 [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
 
-This module returns the ID for the name of a resource group. It can also create a group from a name and return the ID. The module will return the ID of the default resource group if no name is passed.
+This module returns the ID for the name of a resource group. It can also create a group from a name and return the ID. The module will return the ID of the default resource group if no name is passed, or if the string "Default" or "default" is passed (even if that is not the name of the actual default resource group in the account).
 
 <!-- Below content is automatically populated via pre-commit hook -->
 <!-- BEGIN OVERVIEW HOOK -->
@@ -27,23 +27,39 @@ Create new Resource group:
 ```hcl
 module "resource_group" {
   source              = "terraform-ibm-modules/resource-group/ibm"
-  version             = "X.X.X" # Replace "X.X.X" with a release version to lock into a specific release
+  version             = "X.Y.Z" # Replace "X.Y.Z" with a release version to lock into a specific release
   resource_group_name = "new-resource-group"
 }
 ```
 Return ID of an existing Resource group:
 ```hcl
 module "resource_group" {
   source                       = "terraform-ibm-modules/resource-group/ibm"
-  version                      = "X.X.X" # Replace "X.X.X" with a release version to lock into a specific release
+  version                      = "X.Y.Z" # Replace "X.Y.Z" with a release version to lock into a specific release
   existing_resource_group_name = "existing-resource-group"
 }
 ```
-Return ID of the default Resource group:
+Return ID of the default Resource group by passing no name:
+```hcl
+module "resource_group" {
+  source  = "terraform-ibm-modules/resource-group/ibm"
+  version = "X.Y.Z" # Replace "X.Y.Z" with a release version to lock into a specific release
+}
+```
+Return ID of the default Resource group by the string "Default":
+```hcl
+module "resource_group" {
+  source                       = "terraform-ibm-modules/resource-group/ibm"
+  version                      = "X.Y.Z" # Replace "X.Y.Z" with a release version to lock into a specific release
+  existing_resource_group_name = "Default"
+}
+```
+Return ID of the default Resource group by the string "default":
 ```hcl
 module "resource_group" {
   source                       = "terraform-ibm-modules/resource-group/ibm"
-  version                      = "X.X.X" # Replace "X.X.X" with a release version to lock into a specific release
+  version                      = "X.Y.Z" # Replace "X.Y.Z" with a release version to lock into a specific release
+  existing_resource_group_name = "default"
 }
 ```
 
@@ -78,7 +94,7 @@ No modules.
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
-| <a name="input_existing_resource_group_name"></a> [existing\_resource\_group\_name](#input\_existing\_resource\_group\_name) | Name of the existing resource group. When null, set to the account's default resource group. | `string` | `null` | no |
+| <a name="input_existing_resource_group_name"></a> [existing\_resource\_group\_name](#input\_existing\_resource\_group\_name) | Name of an existing resource group. When set to `null`, `default` or `Default` the accounts default resource group is returned. | `string` | `null` | no |
 | <a name="input_resource_group_name"></a> [resource\_group\_name](#input\_resource\_group\_name) | Name of the resource group to create. Required if not using existing resource group | `string` | `null` | no |
 
 ### Outputs

examples/default-resource-group/main.tf

@@ -1,3 +1,4 @@
 module "resource_group" {
-  source = "../../"
+  source                       = "../../"
+  existing_resource_group_name = var.existing_resource_group_name # values of null, "Default" or "default" will all return default resource group in account
 }

examples/default-resource-group/variables.tf

@@ -3,3 +3,9 @@ variable "ibmcloud_api_key" {
   description = "The IBM Cloud API Token"
   sensitive   = true
 }
+
+variable "existing_resource_group_name" {
+  type        = string
+  description = "Name of an existing resource group. When set to `null`, `default` or `Default` the accounts default resource group is returned."
+  default     = null
+}

examples/existing-resource-group/catalogValidationValues.json.template

@@ -1,4 +1,4 @@
 module "resource_group" {
   source                       = "../../"
-  existing_resource_group_name = var.resource_group_name
+  existing_resource_group_name = var.existing_resource_group_name
 }

examples/existing-resource-group/main.tf

@@ -4,7 +4,7 @@ variable "ibmcloud_api_key" {
   sensitive   = true
 }
 
-variable "resource_group_name" {
+variable "existing_resource_group_name" {
   type        = string
-  description = "Resource group name"
+  description = "Existing Resource group name"
 }

examples/existing-resource-group/variables.tf

@@ -5,19 +5,20 @@
 # Otherwise it will look up a provided existing resource group or the account's default resource group
 ##############################################################################
 
-# Use a local variable to determine if the default resource group should be used
 locals {
-  # Use the local variable to decide which resource group name to use
-  existing_resource_group_name = var.existing_resource_group_name != null ? var.existing_resource_group_name : var.resource_group_name == null ? data.ibm_resource_group.default[0].name : null
+  # when resource_group_name is null, lookup account default group if existing_resource_group_name is null, "Default" or "default"
+  lookup_default_group         = var.resource_group_name != null ? false : var.existing_resource_group_name != null ? lower(var.existing_resource_group_name) == "default" ? true : false : true
+  lookup_existing_group        = var.resource_group_name == null && !local.lookup_default_group ? true : false
+  existing_resource_group_name = var.existing_resource_group_name != null ? lower(var.existing_resource_group_name) == "default" ? data.ibm_resource_group.default[0].name : var.existing_resource_group_name : var.resource_group_name == null ? data.ibm_resource_group.default[0].name : null
 }
 
 data "ibm_resource_group" "default" {
-  count      = var.existing_resource_group_name == null && var.resource_group_name == null ? 1 : 0
+  count      = local.lookup_default_group ? 1 : 0
   is_default = "true"
 }
 
 data "ibm_resource_group" "existing_resource_group" {
-  count = var.resource_group_name != null ? 0 : 1
+  count = local.lookup_existing_group ? 1 : 0
   name  = local.existing_resource_group_name
 }
 

examples/new-resource-group/catalogValidationValues.json.template

@@ -4,11 +4,11 @@
 
 output "resource_group_name" {
   description = "Resource group name"
-  value       = var.resource_group_name == null ? data.ibm_resource_group.existing_resource_group[0].name : ibm_resource_group.resource_group[0].name
+  value       = var.resource_group_name == null ? local.lookup_default_group ? data.ibm_resource_group.default[0].name : data.ibm_resource_group.existing_resource_group[0].name : ibm_resource_group.resource_group[0].name
 }
 
 output "resource_group_id" {
   description = "Resource group ID"
-  value       = var.resource_group_name == null ? data.ibm_resource_group.existing_resource_group[0].id : ibm_resource_group.resource_group[0].id
+  value       = var.resource_group_name == null ? local.lookup_default_group ? data.ibm_resource_group.default[0].id : data.ibm_resource_group.existing_resource_group[0].id : ibm_resource_group.resource_group[0].id
 }
 ##############################################################################

main.tf

@@ -75,7 +75,7 @@ func TestRunExistingGroupExample(t *testing.T) {
 		})
 
 		options.TerraformVars = map[string]interface{}{
-			"resource_group_name": terraform.Output(t, existingTerraformOptions, "resource_group_name"),
+			"existing_resource_group_name": terraform.Output(t, existingTerraformOptions, "resource_group_name"),
 		}
 
 		output, err := options.RunTestConsistency()
@@ -96,7 +96,7 @@ func TestRunExistingGroupExample(t *testing.T) {
 	}
 }
 
-func TestRunDefaultGroupExample(t *testing.T) {
+func TestRunDefaultGroupExampleUsingNull(t *testing.T) {
 	t.Parallel()
 
 	options := testhelper.TestOptionsDefault(&testhelper.TestOptions{
@@ -110,8 +110,43 @@ func TestRunDefaultGroupExample(t *testing.T) {
 	assert.Equal(t, output.RawPlan.OutputChanges["resource_group_name"].After.(string), "Default")
 }
 
+func TestRunDefaultGroupExampleUsingCapDefault(t *testing.T) {
+	t.Parallel()
+
+	options := testhelper.TestOptionsDefault(&testhelper.TestOptions{
+		Testing:      t,
+		TerraformDir: defaultGroupExampleTerraformDir,
+	})
+
+	options.TerraformVars = map[string]interface{}{
+		"existing_resource_group_name": "Default",
+	}
+
+	output, err := options.RunTestConsistency()
+	assert.Nil(t, err, "This should not have errored")
+	assert.NotEmpty(t, output.RawPlan.OutputChanges["resource_group_id"].After.(string))
+	assert.Equal(t, output.RawPlan.OutputChanges["resource_group_name"].After.(string), "Default")
+}
+
+func TestRunDefaultGroupExampleUsingLowerDefault(t *testing.T) {
+	t.Parallel()
+
+	options := testhelper.TestOptionsDefault(&testhelper.TestOptions{
+		Testing:      t,
+		TerraformDir: defaultGroupExampleTerraformDir,
+	})
+
+	options.TerraformVars = map[string]interface{}{
+		"existing_resource_group_name": "default",
+	}
+
+	output, err := options.RunTestConsistency()
+	assert.Nil(t, err, "This should not have errored")
+	assert.NotEmpty(t, output.RawPlan.OutputChanges["resource_group_id"].After.(string))
+	assert.Equal(t, output.RawPlan.OutputChanges["resource_group_name"].After.(string), "Default")
+}
+
 func TestRunUpgradeExample(t *testing.T) {
-	t.Skip()
 	t.Parallel()
 
 	options := testhelper.TestOptionsDefault(&testhelper.TestOptions{