chore: Terraform Example Code Optimized (#421)

marifse · web-flow · commit 734b15581058 · 2024-04-25T08:48:33.000+01:00
diff --git a/cra-config.yaml b/cra-config.yaml
@@ -4,8 +4,6 @@ CRA_TARGETS:
   - CRA_TARGET: "examples/multizone-rule" # 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: "0e6e7b5a-817d-4344-ab6f-e5d7a9c49520" # SCC profile ID (currently set to the FSCloud 1.4.0 profile).
-    # 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.
-    #   TF_VAR_sample: "sample value"
-    #   TF_VAR_other:  "another value"
+    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.
+      TF_VAR_region: "us-south"
+      TF_VAR_prefix: "multizone-rule"
diff --git a/examples/fscloud/variables.tf b/examples/fscloud/variables.tf
@@ -7,13 +7,11 @@ variable "ibmcloud_api_key" {
 variable "prefix" {
   type        = string
   description = "Prefix to append to all vpc_zone_list, service_ref_zone_list and cbr_rule_description created by this submodule"
-  default     = "fs"
 }
 
 variable "region" {
   description = "Name of the region to deploy into"
   type        = string
-  default     = "us-south"
 }
 
 variable "resource_group" {
diff --git a/examples/fscloud/version.tf b/examples/fscloud/version.tf
@@ -1,10 +1,11 @@
 terraform {
   required_version = ">= 1.3.0, <1.7.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
+    # 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).
     ibm = {
       source  = "IBM-Cloud/ibm"
-      version = "1.62.0"
+      version = ">= 1.62.0"
     }
   }
 }
diff --git a/examples/multi-resource-rule/main.tf b/examples/multi-resource-rule/main.tf
@@ -4,7 +4,7 @@
 
 module "resource_group" {
   source  = "terraform-ibm-modules/resource-group/ibm"
-  version = "1.1.4"
+  version = "1.1.5"
   # 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
diff --git a/examples/multi-resource-rule/variables.tf b/examples/multi-resource-rule/variables.tf
@@ -7,13 +7,11 @@ variable "ibmcloud_api_key" {
 variable "prefix" {
   type        = string
   description = "Prefix to append to all resources created by this example"
-  default     = "test-terraform-multirule"
 }
 
 variable "region" {
   description = "Name of the Region to deploy into"
   type        = string
-  default     = "us-south"
 }
 
 variable "resource_group" {
diff --git a/examples/multi-resource-rule/version.tf b/examples/multi-resource-rule/version.tf
@@ -1,10 +1,11 @@
 terraform {
-  required_version = ">= 1.3.0"
+  required_version = ">= 1.3.0, <1.7.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
+    # 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).
     ibm = {
       source  = "IBM-Cloud/ibm"
-      version = "1.62.0"
+      version = ">= 1.62.0"
     }
   }
 }
diff --git a/examples/multi-service-profile/main.tf b/examples/multi-service-profile/main.tf
@@ -4,7 +4,7 @@
 
 module "resource_group" {
   source  = "terraform-ibm-modules/resource-group/ibm"
-  version = "1.1.4"
+  version = "1.1.5"
   # 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
diff --git a/examples/multi-service-profile/variables.tf b/examples/multi-service-profile/variables.tf
@@ -7,13 +7,11 @@ variable "ibmcloud_api_key" {
 variable "prefix" {
   type        = string
   description = "Prefix to append to all resources created by this example"
-  default     = "test-terraform-multiservice"
 }
 
 variable "region" {
   description = "Name of the Region to deploy into"
   type        = string
-  default     = "us-south"
 }
 
 variable "location" {
diff --git a/examples/multi-service-profile/version.tf b/examples/multi-service-profile/version.tf
@@ -1,10 +1,11 @@
 terraform {
   required_version = ">= 1.3.0, <1.7.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
+    # 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).
     ibm = {
       source  = "IBM-Cloud/ibm"
-      version = "1.62.0"
+      version = ">= 1.62.0"
     }
   }
 }
diff --git a/examples/multizone-rule/README.md b/examples/multizone-rule/README.md
@@ -2,5 +2,7 @@
 
 An end-to-end example that uses the module's default variable values. This example uses the IBM Cloud Provider to automate the following infrastructure::
 
+ - Creates a VPC
+ - Creates a VPC Subnet
  - Create two zones for context-based restrictions.
  - Create a rule for context-based restrictions that uses the zone and attaches the service to it.
diff --git a/examples/multizone-rule/main.tf b/examples/multizone-rule/main.tf
@@ -11,7 +11,7 @@ data "ibm_iam_account_settings" "iam_account_settings" {
 
 module "resource_group" {
   source  = "terraform-ibm-modules/resource-group/ibm"
-  version = "1.1.4"
+  version = "1.1.5"
   # 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
diff --git a/examples/multizone-rule/variables.tf b/examples/multizone-rule/variables.tf
@@ -7,13 +7,11 @@ variable "ibmcloud_api_key" {
 variable "prefix" {
   type        = string
   description = "Prefix to append to all resources created by this example"
-  default     = "test-terraform-multizone"
 }
 
 variable "region" {
   description = "Name of the Region to deploy into"
   type        = string
-  default     = "us-south"
 }
 
 variable "resource_group" {
diff --git a/examples/multizone-rule/version.tf b/examples/multizone-rule/version.tf
@@ -1,7 +1,8 @@
 terraform {
   required_version = ">= 1.3.0, <1.7.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
+    # 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).
     ibm = {
       source  = "IBM-Cloud/ibm"
       version = "1.62.0"
diff --git a/examples/zone/README.md b/examples/zone/README.md
@@ -1,3 +1,8 @@
 # Zone example
 
-Example that creates a zone for context-based restrictions.
+Example that creates a zone for context-based restrictions. This example uses the IBM Cloud Provider to automate the following infrastructure:
+
+- Creates a VPC
+- Creates a Public Gateway
+- Creates a VPC Subnet
+- Creates a CBR Zone for the VPC
diff --git a/examples/zone/main.tf b/examples/zone/main.tf
@@ -11,7 +11,7 @@ data "ibm_iam_account_settings" "iam_account_settings" {
 
 module "resource_group" {
   source  = "terraform-ibm-modules/resource-group/ibm"
-  version = "1.1.4"
+  version = "1.1.5"
   # 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
diff --git a/examples/zone/variables.tf b/examples/zone/variables.tf
@@ -7,13 +7,11 @@ variable "ibmcloud_api_key" {
 variable "prefix" {
   type        = string
   description = "Prefix to append to all resources created by this example"
-  default     = "example-cbr-new"
 }
 
 variable "region" {
   description = "Name of the Region to deploy into"
   type        = string
-  default     = "us-south"
 }
 
 variable "resource_group" {
diff --git a/examples/zone/version.tf b/examples/zone/version.tf
@@ -1,7 +1,8 @@
 terraform {
   required_version = ">= 1.3.0, <1.7.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
+    # 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).
     ibm = {
       source  = "IBM-Cloud/ibm"
       version = "1.62.0"
diff --git a/tests/pr_test.go b/tests/pr_test.go
@@ -290,11 +290,15 @@ func TestFSCloudInSchematics(t *testing.T) {
 		TemplateFolder:         fsCloudExampleTerraformDir,
 		Tags:                   []string{"test-schematic"},
 		DeleteWorkspaceOnFail:  false,
+		Prefix:                 "fs",
+		Region:                 "us-south",
 		WaitJobCompleteMinutes: 60,
 	})
 
 	options.TerraformVars = []testschematic.TestSchematicTerraformVar{
 		{Name: "ibmcloud_api_key", Value: options.RequiredEnvironmentVars["TF_VAR_ibmcloud_api_key"], DataType: "string", Secure: true},
+		{Name: "prefix", Value: options.Prefix, DataType: "string"},
+		{Name: "region", Value: options.Region, DataType: "string"},
 	}
 
 	err := options.RunSchematicTest()

Original file line number	Diff line number	Diff line change
`@@ -7,13 +7,11 @@ variable "ibmcloud_api_key" {`
`7`	`7`	`variable "prefix" {`
`8`	`8`	`type = string`
`9`	`9`	`description = "Prefix to append to all vpc_zone_list, service_ref_zone_list and cbr_rule_description created by this submodule"`
`10`		`- default = "fs"`
`11`	`10`	`}`
`12`	`11`
`13`	`12`	`variable "region" {`
`14`	`13`	`description = "Name of the region to deploy into"`
`15`	`14`	`type = string`
`16`		`- default = "us-south"`
`17`	`15`	`}`
`18`	`16`
`19`	`17`	`variable "resource_group" {`
Original file line number	Diff line number	Diff line change
`@@ -1,10 +1,11 @@`
`1`	`1`	`terraform {`
`2`	`2`	`required_version = ">= 1.3.0, <1.7.0"`
`3`	`3`	`required_providers {`
`4`		`- # Pin to the lowest provider version of the range defined in the main module's version.tf to ensure lowest version still works`
	`4`	`+ # Ensure that there is always 1 example locked into the lowest provider version of the range defined in the main`
	`5`	`+ # 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).`
`5`	`6`	`ibm = {`
`6`	`7`	`source = "IBM-Cloud/ibm"`
`7`		`- version = "1.62.0"`
	`8`	`+ version = ">= 1.62.0"`
`8`	`9`	`}`
`9`	`10`	`}`
`10`	`11`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,10 +1,11 @@`
`1`	`1`	`terraform {`
`2`		`- required_version = ">= 1.3.0"`
	`2`	`+ required_version = ">= 1.3.0, <1.7.0"`
`3`	`3`	`required_providers {`
`4`		`- # Pin to the lowest provider version of the range defined in the main module's version.tf to ensure lowest version still works`
	`4`	`+ # Ensure that there is always 1 example locked into the lowest provider version of the range defined in the main`
	`5`	`+ # 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).`
`5`	`6`	`ibm = {`
`6`	`7`	`source = "IBM-Cloud/ibm"`
`7`		`- version = "1.62.0"`
	`8`	`+ version = ">= 1.62.0"`
`8`	`9`	`}`
`9`	`10`	`}`
`10`	`11`	`}`