test: Additional test to prevent regressions (#96)

* test: updating tests to be more comprehensive
* test: add test documentation
* test: update tag tests

---------

Signed-off-by: Daniel Butler <[email protected]>
Co-authored-by: Terraform IBM Modules Operations <[email protected]>
Co-authored-by: Renovate Bot <[email protected]>

Author: 3 people

cbr-rule-module/outputs.tf

@@ -2,17 +2,22 @@
 # Outputs
 ##############################################################################
 
+output "rule_description" {
+  value       = ibm_cbr_rule.cbr_rule.description
+  description = "CBR rule resource instance description"
+}
+
 output "rule_id" {
-  value       = join("", ibm_cbr_rule.cbr_rule[*].id)
+  value       = ibm_cbr_rule.cbr_rule.id
   description = "CBR rule resource instance id"
 }
 
 output "rule_crn" {
-  value       = join("", ibm_cbr_rule.cbr_rule[*].crn)
+  value       = ibm_cbr_rule.cbr_rule.crn
   description = "CBR rule resource instance crn"
 }
 
 output "rule_href" {
-  value       = join("", ibm_cbr_rule.cbr_rule[*].href)
+  value       = ibm_cbr_rule.cbr_rule.href
   description = "CBR rule resource href"
 }

cbr-zone-module/outputs.tf

@@ -2,17 +2,27 @@
 # Outputs
 ##############################################################################
 
+output "zone_names" {
+  value       = ibm_cbr_zone.cbr_zone.name
+  description = "CBR zone resource instance name"
+}
+
+output "zone_description" {
+  value       = var.zone_description
+  description = "CBR zone resource instance description"
+}
+
 output "zone_id" {
-  value       = join("", ibm_cbr_zone.cbr_zone[*].id)
+  value       = ibm_cbr_zone.cbr_zone.id
   description = "CBR zone resource instance id"
 }
 
 output "zone_crn" {
-  value       = join("", ibm_cbr_zone.cbr_zone[*].crn)
+  value       = ibm_cbr_zone.cbr_zone.crn
   description = "CBR zone resource instance crn"
 }
 
 output "zone_href" {
-  value       = join("", ibm_cbr_zone.cbr_zone[*].href)
+  value       = ibm_cbr_zone.cbr_zone.href
   description = "CBR zone resource instance link"
 }

examples/multizone-rule/main.tf

@@ -71,43 +71,77 @@ module "cbr_zone" {
   addresses        = local.zone_list[count.index].addresses
 }
 
+# Resource to create COS instance if create_cos_instance is true
+resource "ibm_resource_instance" "cos_instance" {
+  name              = "${var.prefix}-mz-rule-example"
+  resource_group_id = module.resource_group.resource_group_id
+  service           = "cloud-object-storage"
+  plan              = "standard"
+  location          = "global"
+  tags              = var.resource_tags
+}
+
 locals {
 
   # Merge zone ids to pass as contexts to the rule
   rule_contexts = [{
     attributes = [{
       name  = "networkZoneId"
-      value = join(",", ([for zone in module.cbr_zone : zone.zone_id]))
-    }]
+      value = module.cbr_zone[0].zone_id
+    }] }, {
+    attributes = [
+      {
+        name  = "networkZoneId"
+        value = module.cbr_zone[1].zone_id
+      }
+    ]
   }]
 
-  pg_resource = [{
+  rule_resources = [{
     attributes = [
       {
         name     = "accountId"
         value    = data.ibm_iam_account_settings.iam_account_settings.account_id
-        operator = ""
+        operator = "stringEquals"
+      },
+      {
+        name     = "resourceGroupId",
+        value    = module.resource_group.resource_group_id
+        operator = "stringEquals"
+      },
+      {
+        name     = "serviceInstance"
+        value    = ibm_resource_instance.cos_instance.guid
+        operator = "stringEquals"
       },
       {
         name     = "serviceName"
         value    = "cloud-object-storage"
-        operator = ""
+        operator = "stringEquals"
       }
     ],
-    tags = [
-      {
-        name  = "terraform-rule"
-        value = "allow-cos"
+    # Note these are access tags and all iam access tags must be present on the resource for the rule to match
+    tags = [for tag in var.existing_access_tags : {
+      name  = split(":", tag)[0]
+      value = split(":", tag)[1]
       }
     ]
   }]
 }
 
+# Dont forget to add the access tags
+resource "ibm_resource_tag" "attach_tags" {
+  count       = length(var.existing_access_tags) == 0 ? 0 : 1
+  resource_id = ibm_resource_instance.cos_instance.crn
+  tags        = var.existing_access_tags
+  tag_type    = "access"
+}
+
 module "cbr_rule" {
   source           = "../../cbr-rule-module"
-  rule_description = var.rule_description
+  rule_description = "${var.prefix} ${var.rule_description}"
   enforcement_mode = var.enforcement_mode
   rule_contexts    = local.rule_contexts
-  resources        = local.pg_resource
+  resources        = local.rule_resources
   operations       = []
 }

examples/multizone-rule/outputs.tf

@@ -17,11 +17,31 @@ output "zone_href" {
   description = "CBR zone resource instance href"
 }
 
+output "cos_guid" {
+  value       = ibm_resource_instance.cos_instance.guid
+  description = "COS guid (used in tests)"
+}
+
+output "account_id" {
+  value       = data.ibm_iam_account_settings.iam_account_settings.id
+  description = "Account ID (used in tests)"
+}
+
+output "resource_group_id" {
+  value       = module.resource_group.resource_group_id
+  description = "Resource group ID (used for tests)"
+}
+
 output "rule_id" {
   value       = module.cbr_rule.rule_id
   description = "CBR rule resource instance id"
 }
 
+output "rule_description" {
+  value       = module.cbr_rule.rule_description
+  description = "CBR rule description"
+}
+
 output "rule_crn" {
   value       = module.cbr_rule.rule_crn
   description = "CBR rule resource instance crn"

examples/multizone-rule/variables.tf

@@ -28,14 +28,19 @@ variable "resource_tags" {
   default     = []
 }
 
+variable "existing_access_tags" {
+  type        = list(string)
+  description = "Optional list of existing access tags to be added https://cloud.ibm.com/docs/account?topic=account-tag&interface=ui#create"
+  default     = []
+}
 ##############################################################
 # CBR
 ##############################################################
 
 variable "rule_description" {
   type        = string
   description = "(Optional, String) The description of the rule"
-  default     = null
+  default     = "multizone-rule"
 }
 
 variable "enforcement_mode" {

examples/zone/outputs.tf

@@ -7,6 +7,26 @@ output "vpc_id" {
   description = "VPC id"
 }
 
+output "vpc_crn" {
+  value       = resource.ibm_is_vpc.example_vpc.crn
+  description = "VPC crn"
+}
+
+output "account_id" {
+  description = "account id"
+  value       = data.ibm_iam_account_settings.iam_account_settings.id
+}
+
+output "zone_name" {
+  value       = module.ibm_cbr_zone.zone_names
+  description = "cbr_zone resource instance name"
+}
+
+output "zone_description" {
+  value       = module.ibm_cbr_zone.zone_description
+  description = "cbr_zone resource instance description"
+}
+
 output "zone_id" {
   value       = module.ibm_cbr_zone.zone_id
   description = "cbr_zone resource instance id"

module-metadata.json

@@ -244,25 +244,41 @@
         "rule_crn": {
           "name": "rule_crn",
           "description": "CBR rule resource instance crn",
+          "value": "ibm_cbr_rule.cbr_rule.crn",
           "pos": {
             "filename": "cbr-rule-module/outputs.tf",
-            "line": 10
-          }
+            "line": 15
+          },
+          "type": "TypeString",
+          "cloud_data_type": "crn"
+        },
+        "rule_description": {
+          "name": "rule_description",
+          "description": "CBR rule resource instance description",
+          "value": "ibm_cbr_rule.cbr_rule.description",
+          "pos": {
+            "filename": "cbr-rule-module/outputs.tf",
+            "line": 5
+          },
+          "type": "TypeString"
         },
         "rule_href": {
           "name": "rule_href",
           "description": "CBR rule resource href",
+          "value": "ibm_cbr_rule.cbr_rule.href",
           "pos": {
             "filename": "cbr-rule-module/outputs.tf",
-            "line": 15
-          }
+            "line": 20
+          },
+          "type": "TypeString"
         },
         "rule_id": {
           "name": "rule_id",
           "description": "CBR rule resource instance id",
+          "value": "ibm_cbr_rule.cbr_rule.id",
           "pos": {
             "filename": "cbr-rule-module/outputs.tf",
-            "line": 5
+            "line": 10
           }
         }
       },
@@ -304,26 +320,52 @@
         "zone_crn": {
           "name": "zone_crn",
           "description": "CBR zone resource instance crn",
+          "value": "ibm_cbr_zone.cbr_zone.crn",
+          "pos": {
+            "filename": "cbr-zone-module/outputs.tf",
+            "line": 20
+          },
+          "type": "TypeString",
+          "cloud_data_type": "crn"
+        },
+        "zone_description": {
+          "name": "zone_description",
+          "description": "(Optional, String) The description of the zone",
+          "value": "var.zone_description",
           "pos": {
             "filename": "cbr-zone-module/outputs.tf",
             "line": 10
-          }
+          },
+          "type": "string"
         },
         "zone_href": {
           "name": "zone_href",
           "description": "CBR zone resource instance link",
+          "value": "ibm_cbr_zone.cbr_zone.href",
           "pos": {
             "filename": "cbr-zone-module/outputs.tf",
-            "line": 15
-          }
+            "line": 25
+          },
+          "type": "TypeString"
         },
         "zone_id": {
           "name": "zone_id",
           "description": "CBR zone resource instance id",
+          "value": "ibm_cbr_zone.cbr_zone.id",
           "pos": {
             "filename": "cbr-zone-module/outputs.tf",
-            "line": 5
+            "line": 15
           }
+        },
+        "zone_names": {
+          "name": "zone_names",
+          "description": "CBR zone resource instance name",
+          "value": "ibm_cbr_zone.cbr_zone.name",
+          "pos": {
+            "filename": "cbr-zone-module/outputs.tf",
+            "line": 5
+          },
+          "type": "TypeString"
         }
       },
       "pos": {

tests/go.mod

@@ -3,6 +3,9 @@ module github.com/terraform-ibm-modules/terraform-ibm-cbr
 go 1.20
 
 require (
+	github.com/IBM/go-sdk-core/v5 v5.13.1
+	github.com/IBM/platform-services-go-sdk v0.32.2
+	github.com/gruntwork-io/terratest v0.41.15
 	github.com/stretchr/testify v1.8.2
 	github.com/terraform-ibm-modules/ibmcloud-terratest-wrapper v1.8.1
 )