feat: improved user experience for validating input variable values<br> * updated required terraform to be >= 1.9.0 (#643)

vkuma17 · web-flow · commit ccb964fdcc6f · 2025-04-23T13:52:04.000+05:30
diff --git a/README.md b/README.md
@@ -103,7 +103,7 @@ You need the following permissions to run this module.
 
 | Name | Version |
 |------|---------|
-| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.3.0 |
+| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.9.0 |
 | <a name="requirement_ibm"></a> [ibm](#requirement\_ibm) | >= 1.70.0, < 2.0.0 |
 
 ### Modules
diff --git a/examples/fscloud/version.tf b/examples/fscloud/version.tf
@@ -1,5 +1,5 @@
 terraform {
-  required_version = ">= 1.3.0"
+  required_version = ">= 1.9.0"
   required_providers {
     # Ensure that there is always 1 example locked into the lowest provider version of the range defined in the main
     # module's version.tf (zone or multi zone rule), and 1 example that will always use the latest provider version (fscloud multi service profile and multi resource rule).
diff --git a/examples/multi-resource-rule/version.tf b/examples/multi-resource-rule/version.tf
@@ -1,5 +1,5 @@
 terraform {
-  required_version = ">= 1.3.0"
+  required_version = ">= 1.9.0"
   required_providers {
     # Ensure that there is always 1 example locked into the lowest provider version of the range defined in the main
     # module's version.tf (zone or multi zone rule), and 1 example that will always use the latest provider version (fscloud multi service profile and multi resource rule).
diff --git a/examples/multi-service-profile/version.tf b/examples/multi-service-profile/version.tf
@@ -1,5 +1,5 @@
 terraform {
-  required_version = ">= 1.3.0"
+  required_version = ">= 1.9.0"
   required_providers {
     # Ensure that there is always 1 example locked into the lowest provider version of the range defined in the main
     # module's version.tf (zone or multi zone rule), and 1 example that will always use the latest provider version (fscloud multi service profile and multi resource rule).
diff --git a/examples/multizone-rule/version.tf b/examples/multizone-rule/version.tf
@@ -1,5 +1,5 @@
 terraform {
-  required_version = ">= 1.3.0"
+  required_version = ">= 1.9.0"
   required_providers {
     # Ensure that there is always 1 example locked into the lowest provider version of the range defined in the main
     # module's version.tf (zone or multi zone rule), and 1 example that will always use the latest provider version (fscloud multi service profile and multi resource rule).
diff --git a/examples/update-existing-zone-addresses/version.tf b/examples/update-existing-zone-addresses/version.tf
@@ -1,5 +1,5 @@
 terraform {
-  required_version = ">= 1.3.0"
+  required_version = ">= 1.9.0"
   required_providers {
     # Ensure that there is always 1 example locked into the lowest provider version of the range defined in the main
     # module's version.tf (zone or multi zone rule), and 1 example that will always use the latest provider version (fscloud multi service profile and multi resource rule).
diff --git a/examples/zone/version.tf b/examples/zone/version.tf
@@ -1,5 +1,5 @@
 terraform {
-  required_version = ">= 1.3.0"
+  required_version = ">= 1.9.0"
   required_providers {
     # Ensure that there is always 1 example locked into the lowest provider version of the range defined in the main
     # module's version.tf (zone or multi zone rule), and 1 example that will always use the latest provider version (fscloud multi service profile and multi resource rule).
diff --git a/modules/cbr-rule-module/README.md b/modules/cbr-rule-module/README.md
@@ -54,7 +54,7 @@ module "ibm_cbr" "rule" {
 
 | Name | Version |
 |------|---------|
-| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.3.0 |
+| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.9.0 |
 | <a name="requirement_ibm"></a> [ibm](#requirement\_ibm) | >= 1.70.0, < 2.0.0 |
 
 ### Modules
diff --git a/modules/cbr-rule-module/version.tf b/modules/cbr-rule-module/version.tf
@@ -1,5 +1,5 @@
 terraform {
-  required_version = ">= 1.3.0"
+  required_version = ">= 1.9.0"
   required_providers {
     # Pin to the lowest provider version of the range defined in the main module's version.tf to ensure lowest version still works
     ibm = {
diff --git a/modules/cbr-service-profile/README.md b/modules/cbr-service-profile/README.md
@@ -36,7 +36,7 @@ module "cbr_rule_multi_service_profile" {
 
 | Name | Version |
 |------|---------|
-| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.3.0 |
+| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.9.0 |
 | <a name="requirement_ibm"></a> [ibm](#requirement\_ibm) | >= 1.70.0, < 2.0.0 |
 
 ### Modules
diff --git a/modules/cbr-service-profile/main.tf b/modules/cbr-service-profile/main.tf
@@ -9,14 +9,7 @@ data "ibm_iam_account_settings" "iam_account_settings" {
 # CBR Rule for a list of target services
 ##############################################################################
 locals {
-  # tflint-ignore: terraform_unused_declarations
-  validate_zone_inputs = ((length(var.zone_vpc_crn_list) == 0) && (length(var.zone_service_ref_list) == 0)) ? tobool("Error: Provide a valid zone vpc and/or service references") : true
 
-  # tflint-ignore: terraform_unused_declarations
-  validate_location_and_service_name = [
-    for item in ["directlink", "globalcatalog-collection", "iam-groups", "user-management"] :
-    contains(keys(var.zone_service_ref_list), item) ? length(var.zone_service_ref_list[item].serviceRef_location) == 0 ? true : tobool("Error: The services 'directlink', 'globalcatalog-collection', 'iam-groups' and 'user-management' do not support location") : true
-  ]
 
   # Restrict and allow the api types as per the target service
   icd_api_types = ["crn:v1:bluemix:public:context-based-restrictions::::api-type:data-plane"]
diff --git a/modules/cbr-service-profile/variables.tf b/modules/cbr-service-profile/variables.tf
@@ -12,6 +12,13 @@ variable "zone_vpc_crn_list" {
   type        = list(string)
   default     = []
   description = "(List) VPC CRN for the zones"
+  validation {
+    condition = (
+      length(var.zone_vpc_crn_list) > 0 || length(var.zone_service_ref_list) > 0
+    )
+    error_message = "Error: Provide at least one of zone_vpc_crn_list or zone_service_ref_list."
+  }
+
 }
 
 variable "zone_service_ref_list" {
@@ -35,6 +42,16 @@ variable "zone_service_ref_list" {
     ])
     error_message = "Provide a valid target service name that is supported by context-based restrictions."
   }
+
+  validation {
+    condition = alltrue([
+      for item in ["directlink", "globalcatalog-collection", "iam-groups", "platform_service", "user-management"] :
+      contains(keys(var.zone_service_ref_list), item) ?
+      try(length(var.zone_service_ref_list[item].serviceRef_location), 0) == 0 :
+      true
+    ])
+    error_message = "Error: The services 'directlink', 'globalcatalog-collection', 'iam-groups', 'platform_service' and 'user-management' must not specify a serviceRef_location."
+  }
 }
 
 variable "target_service_details" {
diff --git a/modules/cbr-service-profile/version.tf b/modules/cbr-service-profile/version.tf
@@ -1,5 +1,5 @@
 terraform {
-  required_version = ">= 1.3.0"
+  required_version = ">= 1.9.0"
   required_providers {
     # Pin to the lowest provider version of the range defined in the main module's version.tf to ensure lowest version still works
     ibm = {
diff --git a/modules/cbr-zone-module/README.md b/modules/cbr-zone-module/README.md
@@ -32,7 +32,7 @@ module "ibm_cbr" "zone" {
 
 | Name | Version |
 |------|---------|
-| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.3.0 |
+| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.9.0 |
 | <a name="requirement_ibm"></a> [ibm](#requirement\_ibm) | >= 1.70.0, < 2.0.0 |
 
 ### Modules
diff --git a/modules/cbr-zone-module/main.tf b/modules/cbr-zone-module/main.tf
@@ -4,12 +4,6 @@
 # Creates CBR Zone
 ##############################################################################
 
-locals {
-  # tflint-ignore: terraform_unused_declarations
-  validate_zone_id_values = !var.use_existing_cbr_zone && (var.account_id == null || var.name == null) ? tobool("When passing values for var.zone_id, you must set var.use_existing_cbr_zone to true.") : true
-  # tflint-ignore: terraform_unused_declarations
-  validate_zone_id_vars = var.use_existing_cbr_zone && var.existing_zone_id == null ? tobool("When setting var.use_existing_cbr_zone to true, a value must be passed for var.zone_id.") : true
-}
 
 resource "ibm_cbr_zone" "cbr_zone" {
   count       = var.use_existing_cbr_zone ? 0 : 1
diff --git a/modules/cbr-zone-module/variables.tf b/modules/cbr-zone-module/variables.tf
@@ -231,4 +231,14 @@ variable "use_existing_cbr_zone" {
   type        = bool
   description = "Whether to update CBR zone using existing zone ID. This allows the inclusion of one or more addresses in an existing zone"
   default     = false
+  validation {
+    condition     = !var.use_existing_cbr_zone || var.existing_zone_id != null
+    error_message = "When setting use_existing_cbr_zone to true, a value must be passed for existing_zone_id."
+  }
+
+  validation {
+    condition     = var.use_existing_cbr_zone || (var.account_id != null && var.name != null)
+    error_message = "When setting use_existing_cbr_zone to false, a value must be passed for account_id and name."
+  }
+
 }
diff --git a/modules/cbr-zone-module/version.tf b/modules/cbr-zone-module/version.tf
@@ -1,5 +1,5 @@
 terraform {
-  required_version = ">= 1.3.0"
+  required_version = ">= 1.9.0"
   required_providers {
     # Pin to the lowest provider version of the range defined in the main module's version.tf to ensure lowest version still works
     ibm = {
diff --git a/modules/fscloud/README.md b/modules/fscloud/README.md
@@ -94,7 +94,7 @@ module "cbr_fscloud" {
 
 | Name | Version |
 |------|---------|
-| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.3.0 |
+| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.9.0 |
 | <a name="requirement_ibm"></a> [ibm](#requirement\_ibm) | >=1.70.0, < 2.0.0 |
 
 ### Modules
diff --git a/modules/fscloud/main.tf b/modules/fscloud/main.tf
@@ -153,11 +153,6 @@ locals {
 
 locals {
 
-  # tflint-ignore: terraform_unused_declarations
-  validate_location_and_service_name = [
-    for item in ["directlink", "globalcatalog-collection", "iam-groups", "user-management"] :
-    contains(keys(local.zone_final_service_ref_list), item) ? length(local.zone_final_service_ref_list[item].serviceRef_location) == 0 ? true : tobool("Error: The services 'directlink', 'globalcatalog-collection', 'iam-groups' and 'user-management' do not support location") : true
-  ]
   service_ref_zone_list = (length(local.zone_final_service_ref_list) > 0) ? {
     for service_ref, service_ref_details in local.zone_final_service_ref_list : service_ref => {
       name             = service_ref_details.zone_name == null ? "${var.prefix}-${service_ref}-service-zone" : service_ref_details.zone_name
diff --git a/modules/fscloud/variables.tf b/modules/fscloud/variables.tf
@@ -240,6 +240,17 @@ variable "zone_service_ref_list" {
 
   })
 
+  validation {
+    condition = alltrue([
+      for item in ["directlink", "globalcatalog-collection", "iam-groups", "platform_service", "user-management"] :
+      contains(keys(var.zone_service_ref_list), item) ?
+      (var.zone_service_ref_list[item] == null ||
+        (var.zone_service_ref_list[item] != null ? (var.zone_service_ref_list[item].serviceRef_location == null || try(length(var.zone_service_ref_list[item].serviceRef_location), 0) == 0 ? true : false) : true) ||
+      contains(var.skip_specific_services_for_zone_creation, item)) :
+      true
+    ])
+    error_message = "Error: The services 'directlink', 'globalcatalog-collection', 'iam-groups', 'platform_service' and 'user-management' must not specify a serviceRef_location."
+  }
   description = "(Optional) Provide a valid service reference with the customized name of the zone and location where the context-based restriction zones are created. If no value is specified for `serviceRef_location`, the zones are not scoped to any location and if no value is specified for `zone_name` default zone name with the prefix will be created."
 
   default = {}
diff --git a/modules/fscloud/version.tf b/modules/fscloud/version.tf
@@ -1,5 +1,5 @@
 terraform {
-  required_version = ">= 1.3.0"
+  required_version = ">= 1.9.0"
   required_providers {
     ibm = {
       source  = "IBM-Cloud/ibm"
diff --git a/version.tf b/version.tf
@@ -1,5 +1,5 @@
 terraform {
-  required_version = ">= 1.3.0"
+  required_version = ">= 1.9.0"
   required_providers {
     ibm = {
       source = "IBM-Cloud/ibm"
