Refactor integration tests to include random names

This commit updates the integration test fixtures to allow for
randomized subnetwork names as well as randomized network names. Without
this commit the integration test fixtures will create VPC networks with
randomized names, but the subnetwork names will remain static. Because
subnetworks are regional resources, you can't have two subnetworks with
the same name tied to the same project and region. This means that
without adding randomness to subnetwork names, only 1 run of the
integration test pipeline can occur at any given time.

Normally a `random_string` resource is used to impart randomness into
resource names, but because of the way lookups are performed on the
`subnets` and `secondary_ranges` input variables, those variables cannot
contain computed values. To remedy this the test fixtures in
`test/fixtures/<scenario name>` now include an input variable named
`random_string_for_testing` that accepts a string to be appended on both
the network and subnetwork names. The `test/ci_integration.sh` script
has been modified to look for an environment variable named
`RANDOM_STRING_FOR_TESTING` and pass that to
`var.random_string_for_testing`. If that environment variable has not
been declared then a 5-character string is generated on the fly and
used.

This commit also contains an update to `Makefile` to ensure that
`test/ci_integration.sh` is sourced and the `setup_environment()`
function is called for any of the `docker_*` make targets. The
`Makefile` has also been modified to ensure that the environment
variables that are referenced by `test/ci_integration.sh` are being
passed down to the Docker container.

Author: glarizza

Makefile

@@ -84,50 +84,60 @@ docker_run:
 	docker run --rm -it \
 		-e CLOUDSDK_AUTH_CREDENTIAL_FILE_OVERRIDE=${CREDENTIALS_PATH} \
 		-e GOOGLE_APPLICATION_CREDENTIALS=${CREDENTIALS_PATH} \
-		-e TF_VAR_project_id \
+		-e PROJECT_ID \
+		-e SERVICE_ACCOUNT_JSON \
+		-e RANDOM_STRING_FOR_TESTING \
 		-v $(CURDIR):/cft/workdir \
 		${DOCKER_REPO_BASE_KITCHEN_TERRAFORM} \
-		/bin/bash
+		/bin/bash -c 'source test/ci_integration.sh && setup_environment && exec /bin/bash'
 
 .PHONY: docker_create
 docker_create:
 	docker run --rm -it \
 		-e CLOUDSDK_AUTH_CREDENTIAL_FILE_OVERRIDE=${CREDENTIALS_PATH} \
 		-e GOOGLE_APPLICATION_CREDENTIALS=${CREDENTIALS_PATH} \
-		-e TF_VAR_project_id \
+		-e PROJECT_ID \
+		-e SERVICE_ACCOUNT_JSON \
+		-e RANDOM_STRING_FOR_TESTING \
 		-v $(CURDIR):/cft/workdir \
 		${DOCKER_REPO_BASE_KITCHEN_TERRAFORM} \
-		/bin/bash -c "kitchen create"
+		/bin/bash -c "source test/ci_integration.sh && setup_environment && kitchen create"
 
 .PHONY: docker_converge
 docker_converge:
 	docker run --rm -it \
 		-e CLOUDSDK_AUTH_CREDENTIAL_FILE_OVERRIDE=${CREDENTIALS_PATH} \
 		-e GOOGLE_APPLICATION_CREDENTIALS=${CREDENTIALS_PATH} \
-		-e TF_VAR_project_id \
+		-e PROJECT_ID \
+		-e SERVICE_ACCOUNT_JSON \
+		-e RANDOM_STRING_FOR_TESTING \
 		-v $(CURDIR):/cft/workdir \
 		${DOCKER_REPO_BASE_KITCHEN_TERRAFORM} \
-		/bin/bash -c "kitchen converge && kitchen converge"
+		/bin/bash -c "source test/ci_integration.sh && setup_environment && kitchen converge && kitchen converge"
 
 .PHONY: docker_verify
 docker_verify:
 	docker run --rm -it \
 		-e CLOUDSDK_AUTH_CREDENTIAL_FILE_OVERRIDE=${CREDENTIALS_PATH} \
 		-e GOOGLE_APPLICATION_CREDENTIALS=${CREDENTIALS_PATH} \
-		-e TF_VAR_project_id \
+		-e PROJECT_ID \
+		-e SERVICE_ACCOUNT_JSON \
+		-e RANDOM_STRING_FOR_TESTING \
 		-v $(CURDIR):/cft/workdir \
 		${DOCKER_REPO_BASE_KITCHEN_TERRAFORM} \
-		/bin/bash -c "kitchen verify"
+		/bin/bash -c "source test/ci_integration.sh && setup_environment && kitchen verify"
 
 .PHONY: docker_destroy
 docker_destroy:
 	docker run --rm -it \
 		-e CLOUDSDK_AUTH_CREDENTIAL_FILE_OVERRIDE=${CREDENTIALS_PATH} \
 		-e GOOGLE_APPLICATION_CREDENTIALS=${CREDENTIALS_PATH} \
-		-e TF_VAR_project_id \
+		-e PROJECT_ID \
+		-e SERVICE_ACCOUNT_JSON \
+		-e RANDOM_STRING_FOR_TESTING \
 		-v $(CURDIR):/cft/workdir \
 		${DOCKER_REPO_BASE_KITCHEN_TERRAFORM} \
-		/bin/bash -c "kitchen destroy"
+		/bin/bash -c "source test/ci_integration.sh && setup_environment && kitchen destroy"
 
 .PHONY: test_integration_docker
 test_integration_docker: docker_create docker_converge docker_verify docker_destroy

examples/delete_default_gateway_routes/main.tf

@@ -15,30 +15,24 @@
  */
 
 locals {
-  network_name = "test-network-${random_string.random_suffix.result}"
-}
-
-resource "random_string" "random_suffix" {
-  length  = 4
-  upper   = "false"
-  special = "false"
+  subnet_01 = "${var.network_name}-subnet-01"
 }
 
 module "test-vpc-module" {
   source                                 = "../../"
   project_id                             = "${var.project_id}"
-  network_name                           = "${local.network_name}"
+  network_name                           = "${var.network_name}"
   delete_default_internet_gateway_routes = "true"
 
   subnets = [
     {
-      subnet_name   = "subnet-41"
+      subnet_name   = "${local.subnet_01}"
       subnet_ip     = "10.20.30.0/24"
       subnet_region = "us-west1"
     },
   ]
 
   secondary_ranges = {
-    subnet-41 = []
+    "${local.subnet_01}" = []
   }
 }

examples/delete_default_gateway_routes/variables.tf

@@ -17,3 +17,7 @@
 variable "project_id" {
   description = "The project ID to host the network in"
 }
+
+variable "network_name" {
+  description = "The name of the VPC network being created"
+}

examples/multi_vpc/main.tf

@@ -15,12 +15,15 @@
  */
 
 locals {
-  network_01_name = "test-network-301"
-  network_02_name = "test-network-302"
+  network_01_subnet_01 = "${var.network_01_name}-subnet-01"
+  network_01_subnet_02 = "${var.network_01_name}-subnet-02"
+  network_01_subnet_03 = "${var.network_01_name}-subnet-03"
+  network_02_subnet_01 = "${var.network_02_name}-subnet-01"
+  network_02_subnet_02 = "${var.network_02_name}-subnet-02"
 
   network_01_routes = [
     {
-      name              = "${local.network_01_name}-egress-inet"
+      name              = "${var.network_01_name}-egress-inet"
       description       = "route through IGW to access internet"
       destination_range = "0.0.0.0/0"
       tags              = "egress-inet"
@@ -30,14 +33,14 @@ locals {
 
   network_02_routes = [
     {
-      name              = "${local.network_02_name}-egress-inet"
+      name              = "${var.network_02_name}-egress-inet"
       description       = "route through IGW to access internet"
       destination_range = "0.0.0.0/0"
       tags              = "egress-inet"
       next_hop_internet = "true"
     },
     {
-      name              = "${local.network_02_name}-testapp-proxy"
+      name              = "${var.network_02_name}-testapp-proxy"
       description       = "route through proxy to reach app"
       destination_range = "10.50.10.0/24"
       tags              = "app-proxy"
@@ -46,40 +49,28 @@ locals {
   ]
 }
 
-resource "random_string" "random_suffix_01" {
-  length  = 4
-  upper   = "false"
-  special = "false"
-}
-
-resource "random_string" "random_suffix_02" {
-  length  = 4
-  upper   = "false"
-  special = "false"
-}
-
 module "test-vpc-module-01" {
   source       = "../../"
   project_id   = "${var.project_id}"
-  network_name = "test-network-${random_string.random_suffix_01.result}"
+  network_name = "${var.network_01_name}"
 
   subnets = [
     {
-      subnet_name           = "${local.network_01_name}-subnet-01"
+      subnet_name           = "${local.network_01_subnet_01}"
       subnet_ip             = "10.10.10.0/24"
       subnet_region         = "us-west1"
       subnet_private_access = "false"
       subnet_flow_logs      = "true"
     },
     {
-      subnet_name           = "${local.network_01_name}-subnet-02"
+      subnet_name           = "${local.network_01_subnet_02}"
       subnet_ip             = "10.10.20.0/24"
       subnet_region         = "us-west1"
       subnet_private_access = "false"
       subnet_flow_logs      = "true"
     },
     {
-      subnet_name           = "${local.network_01_name}-subnet-03"
+      subnet_name           = "${local.network_01_subnet_03}"
       subnet_ip             = "10.10.30.0/24"
       subnet_region         = "us-west1"
       subnet_private_access = "false"
@@ -88,25 +79,25 @@ module "test-vpc-module-01" {
   ]
 
   secondary_ranges = {
-    "${local.network_01_name}-subnet-01" = [
+    "${local.network_01_subnet_01}" = [
       {
-        range_name    = "${local.network_01_name}-subnet-01-01"
+        range_name    = "${local.network_01_subnet_01}-01"
         ip_cidr_range = "192.168.64.0/24"
       },
       {
-        range_name    = "${local.network_01_name}-subnet-01-02"
+        range_name    = "${local.network_01_subnet_01}-02"
         ip_cidr_range = "192.168.65.0/24"
       },
     ]
 
-    "${local.network_01_name}-subnet-02" = [
+    "${local.network_01_subnet_02}" = [
       {
-        range_name    = "${local.network_01_name}-subnet-02-01"
+        range_name    = "${local.network_02_subnet_01}-01"
         ip_cidr_range = "192.168.74.0/24"
       },
     ]
 
-    "${local.network_01_name}-subnet-03" = []
+    "${local.network_01_subnet_03}" = []
   }
 
   routes = "${local.network_01_routes}"
@@ -115,18 +106,18 @@ module "test-vpc-module-01" {
 module "test-vpc-module-02" {
   source       = "../../"
   project_id   = "${var.project_id}"
-  network_name = "test-network-${random_string.random_suffix_02.result}"
+  network_name = "${var.network_02_name}"
 
   subnets = [
     {
-      subnet_name           = "${local.network_02_name}-subnet-01"
+      subnet_name           = "${local.network_02_subnet_01}"
       subnet_ip             = "10.10.40.0/24"
       subnet_region         = "us-west1"
       subnet_private_access = "false"
       subnet_flow_logs      = "true"
     },
     {
-      subnet_name           = "${local.network_02_name}-subnet-02"
+      subnet_name           = "${local.network_02_subnet_02}"
       subnet_ip             = "10.10.50.0/24"
       subnet_region         = "us-west1"
       subnet_private_access = "false"
@@ -135,14 +126,14 @@ module "test-vpc-module-02" {
   ]
 
   secondary_ranges = {
-    "${local.network_02_name}-subnet-01" = [
+    "${local.network_02_subnet_01}" = [
       {
-        range_name    = "${local.network_02_name}-subnet-02-01"
+        range_name    = "${local.network_02_subnet_02}-01"
         ip_cidr_range = "192.168.75.0/24"
       },
     ]
 
-    "${local.network_02_name}-subnet-02" = []
+    "${local.network_02_subnet_02}" = []
   }
 
   routes = "${local.network_02_routes}"

examples/multi_vpc/variables.tf

@@ -17,3 +17,11 @@
 variable "project_id" {
   description = "The project ID to host the network in"
 }
+
+variable "network_01_name" {
+  description = "The name of the first VPC network being created"
+}
+
+variable "network_02_name" {
+  description = "The name of the second VPC network being created"
+}

examples/secondary_ranges/main.tf

@@ -15,57 +15,53 @@
  */
 
 locals {
-  network_name = "test-network-${random_string.random_suffix.result}"
-}
-
-resource "random_string" "random_suffix" {
-  length  = 4
-  upper   = "false"
-  special = "false"
+  subnet_01 = "${var.network_name}-subnet-01"
+  subnet_02 = "${var.network_name}-subnet-02"
+  subnet_03 = "${var.network_name}-subnet-03"
 }
 
 module "vpc-secondary-ranges" {
   source       = "../../"
   project_id   = "${var.project_id}"
-  network_name = "${local.network_name}"
+  network_name = "${var.network_name}"
 
   subnets = [
     {
-      subnet_name   = "secondary-ranges-subnet-01"
+      subnet_name   = "${local.subnet_01}"
       subnet_ip     = "10.10.10.0/24"
       subnet_region = "us-west1"
     },
     {
-      subnet_name           = "secondary-ranges-subnet-02"
+      subnet_name           = "${local.subnet_02}"
       subnet_ip             = "10.10.20.0/24"
       subnet_region         = "us-west1"
       subnet_private_access = "true"
       subnet_flow_logs      = "true"
     },
     {
-      subnet_name   = "secondary-ranges-subnet-03"
+      subnet_name   = "${local.subnet_03}"
       subnet_ip     = "10.10.30.0/24"
       subnet_region = "us-west1"
     },
   ]
 
   secondary_ranges = {
-    secondary-ranges-subnet-01 = [
+    "${local.subnet_01}" = [
       {
-        range_name    = "subnet-01-01"
+        range_name    = "${local.subnet_01}-01"
         ip_cidr_range = "192.168.64.0/24"
       },
       {
-        range_name    = "subnet-01-02"
+        range_name    = "${local.subnet_01}-02"
         ip_cidr_range = "192.168.65.0/24"
       },
     ]
 
-    secondary-ranges-subnet-02 = []
+    "${local.subnet_02}" = []
 
-    secondary-ranges-subnet-03 = [
+    "${local.subnet_03}" = [
       {
-        range_name    = "subnet-03-01"
+        range_name    = "${local.subnet_03}-01"
         ip_cidr_range = "192.168.66.0/24"
       },
     ]

examples/secondary_ranges/variables.tf

@@ -17,3 +17,7 @@
 variable "project_id" {
   description = "The project ID to host the network in"
 }
+
+variable "network_name" {
+  description = "The name of the VPC network being created"
+}