Added support for Terrafrom 0.12

- Migrated to terraform 0.12 syntax - Added variables type validation. - Added provider version restriction. - Added/upgraded helper functions - Replaced MD markers for doc generator, removed old script - Bumbed version, updaed CHANGELOG and README - Upgraded tf validator and md doc generator fucntions to latest versions. - Added versions.tf with restriction to TF 0.12 - Fixed Makefile bug reported in terraform-google-modules#5 - Fixed broken docker image variables reported in terraform-google-modules#6 - Upgraded to new docker image - Fixed `make create | converge | verify | dsetroy` calls reported in terraform-google-modules#8 - Fixed linters calls. Docker and Python warnings to be addressed in terraform-google-modules#5 - Addressed [hadolint issue](terraform-google-modules/terraform-google-project-factory#252)
ivankorn · Jul 31, 2019 · cfb0afb · cfb0afb
1 parent 56aacc3
commit cfb0afb
Show file tree

Hide file tree

Showing 19 changed files with 1,048 additions and 179 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,8 +6,14 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this
 project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
+
+## [0.2.0] 2019-YY-ZZ
+
 ### Changed
+ - Supported version of Terraform is 0.12. [#4]
 
 ## [0.1.0]
 ### ADDED
 - Initial module release with basic functionality.
+
+[#4]: https://github.com/terraform-google-modules/terraform-google-memorystore/pull/4
diff --git a/Makefile b/Makefile
@@ -16,16 +16,24 @@
 SHELL := /usr/bin/env bash
 
 # Docker build config variables
+CREDENTIALS_PATH 			?= /cft/workdir/credentials.json
+DOCKER_ORG 				:= gcr.io/cloud-foundation-cicd
+DOCKER_TAG_BASE_KITCHEN_TERRAFORM 	?= 2.3.0
+DOCKER_REPO_BASE_KITCHEN_TERRAFORM 	:= ${DOCKER_ORG}/cft/kitchen-terraform:${DOCKER_TAG_BASE_KITCHEN_TERRAFORM}
+
+# Below is left for building docker images locally only
+# Which currently doesn't work. There is an issue to address that
+# https://github.com/terraform-google-modules/terraform-google-memorystore/issues/7
 BUILD_TERRAFORM_VERSION ?= 0.11.10
 BUILD_CLOUD_SDK_VERSION ?= 216.0.0
 BUILD_PROVIDER_GOOGLE_VERSION ?= 1.19.1
 BUILD_PROVIDER_GSUITE_VERSION ?= 0.1.10
-DOCKER_IMAGE_TERRAFORM := cftk/terraform
+DOCKER_IMAGE_TERRAFORM := ${DOCKER_ORG}/cft/terraform
 DOCKER_TAG_TERRAFORM ?= ${BUILD_TERRAFORM_VERSION}_${BUILD_CLOUD_SDK_VERSION}_${BUILD_PROVIDER_GOOGLE_VERSION}_${BUILD_PROVIDER_GSUITE_VERSION}
 BUILD_RUBY_VERSION ?= 2.5.3
-DOCKER_IMAGE_KITCHEN_TERRAFORM := cftk/kitchen_terraform
+DOCKER_IMAGE_KITCHEN_TERRAFORM := ${DOCKER_ORG}/cft/kitchen-terraform
 DOCKER_TAG_KITCHEN_TERRAFORM ?= ${BUILD_TERRAFORM_VERSION}_${BUILD_CLOUD_SDK_VERSION}_${BUILD_PROVIDER_GOOGLE_VERSION}_${BUILD_PROVIDER_GSUITE_VERSION}
-
+## -- Read the comment above
 
 all: check_shell check_python check_golang check_terraform check_docker check_base_files test_check_headers check_headers check_trailing_whitespace generate_docs ## Run all linters and update documentation
 
@@ -45,12 +53,12 @@ check_golang: ## Lint Go source files
 	@source test/make.sh && golang
 
 .PHONY: check_terraform
-check_terraform:
-	@source ## Lint Terraform source files
+check_terraform: ## Lint Terraform source files
+	@source test/make.sh && check_terraform
 
 .PHONY: check_docker
 check_docker: ## Lint Dockerfiles
-	@source test/make.sh && docker
+	@source test/make.sh && check_docker
 
 .PHONY: check_base_files
 check_base_files:
@@ -67,12 +75,11 @@ check_trailing_whitespace:
 .PHONY: test_check_headers
 test_check_headers:
 	@echo "Testing the validity of the header check"
-	@python test/test_verify_boilerplate.py
+	@source test/make.sh && check_headers
 
 .PHONY: check_headers
 check_headers: ## Check that source files have appropriate boilerplate
-	@echo "Checking file headers"
-	@python test/verify_boilerplate.py
+	@source test/make.sh && check_headers
 
 # Integration tests
 .PHONY: test_integration
@@ -114,36 +121,51 @@ docker_build_kitchen_terraform:
 .PHONY: docker_run
 docker_run: ## Launch a shell within the Docker test environment
 	docker run --rm -it \
-		-v $(CURDIR):/cftk/workdir \
-		${DOCKER_IMAGE_KITCHEN_TERRAFORM}:${DOCKER_TAG_KITCHEN_TERRAFORM} \
+		-e SERVICE_ACCOUNT_JSON \
+		-e CLOUDSDK_AUTH_CREDENTIAL_FILE_OVERRIDE=${CREDENTIALS_PATH} \
+		-e GOOGLE_APPLICATION_CREDENTIALS=${CREDENTIALS_PATH} \
+		-v $(CURDIR):/cft/workdir \
+		${DOCKER_REPO_BASE_KITCHEN_TERRAFORM} \
 		/bin/bash
 
 .PHONY: docker_create
 docker_create: ## Run `kitchen create` within the Docker test environment
 	docker run --rm -it \
-		-v $(CURDIR):/cftk/workdir \
-		${DOCKER_IMAGE_KITCHEN_TERRAFORM}:${DOCKER_TAG_KITCHEN_TERRAFORM} \
+		-e SERVICE_ACCOUNT_JSON \
+		-e CLOUDSDK_AUTH_CREDENTIAL_FILE_OVERRIDE=${CREDENTIALS_PATH} \
+		-e GOOGLE_APPLICATION_CREDENTIALS=${CREDENTIALS_PATH} \
+		-v $(CURDIR):/cft/workdir \
+		${DOCKER_REPO_BASE_KITCHEN_TERRAFORM} \
 		/bin/bash -c "kitchen create"
 
 .PHONY: docker_converge
 docker_converge: ## Run `kitchen converge` within the Docker test environment
 	docker run --rm -it \
-		-v $(CURDIR):/cftk/workdir \
-		${DOCKER_IMAGE_KITCHEN_TERRAFORM}:${DOCKER_TAG_KITCHEN_TERRAFORM} \
+		-e SERVICE_ACCOUNT_JSON \
+		-e CLOUDSDK_AUTH_CREDENTIAL_FILE_OVERRIDE=${CREDENTIALS_PATH} \
+		-e GOOGLE_APPLICATION_CREDENTIALS=${CREDENTIALS_PATH} \
+		-v $(CURDIR):/cft/workdir \
+		${DOCKER_REPO_BASE_KITCHEN_TERRAFORM} \
 		/bin/bash -c "kitchen converge && kitchen converge"
 
 .PHONY: docker_verify
 docker_verify: ## Run `kitchen verify` within the Docker test environment
 	docker run --rm -it \
-		-v $(CURDIR):/cftk/workdir \
-		${DOCKER_IMAGE_KITCHEN_TERRAFORM}:${DOCKER_TAG_KITCHEN_TERRAFORM} \
+		-e SERVICE_ACCOUNT_JSON \
+		-e CLOUDSDK_AUTH_CREDENTIAL_FILE_OVERRIDE=${CREDENTIALS_PATH} \
+		-e GOOGLE_APPLICATION_CREDENTIALS=${CREDENTIALS_PATH} \
+		-v $(CURDIR):/cft/workdir \
+		${DOCKER_REPO_BASE_KITCHEN_TERRAFORM} \
 		/bin/bash -c "kitchen verify"
 
 .PHONY: docker_destroy
 docker_destroy: ## Run `kitchen destroy` within the Docker test environment
 	docker run --rm -it \
-		-v $(CURDIR):/cftk/workdir \
-		${DOCKER_IMAGE_KITCHEN_TERRAFORM}:${DOCKER_TAG_KITCHEN_TERRAFORM} \
+		-e SERVICE_ACCOUNT_JSON \
+		-e CLOUDSDK_AUTH_CREDENTIAL_FILE_OVERRIDE=${CREDENTIALS_PATH} \
+		-e GOOGLE_APPLICATION_CREDENTIALS=${CREDENTIALS_PATH} \
+		-v $(CURDIR):/cft/workdir \
+		${DOCKER_REPO_BASE_KITCHEN_TERRAFORM} \
 		/bin/bash -c "kitchen destroy"
 
 .PHONY: test_integration_docker

diff --git a/README.md b/README.md
@@ -2,6 +2,10 @@
 
 A Terraform module for creating a fully functional Google Memorystore (redis) instance.
 
+## Compatibility
+This module is meant for use with Terraform 0.12. If you haven't [upgraded](https://www.terraform.io/upgrade-guides/0-12.html) and need a Terraform 0.11.x-compatible version of this module, the last released version intended for Terraform 0.11.x
+is [0.1.0](https://registry.terraform.io/modules/terraform-google-modules/memorystore/google/0.1.0).
+
 ## Usage
 
 Check the [examples/](./examples/) directory for more.
@@ -16,25 +20,24 @@ module "memorystore" {
 }
 ```
 
-[^]: (autogen_docs_start)
-
+<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 ## Inputs
 
 | Name | Description | Type | Default | Required |
 |------|-------------|:----:|:-----:|:-----:|
-| alternative\_location\_id | The alternative zone where the instance will be provisioned. | string | `` | no |
-| authorized\_network | The name of the memorystore authorized network. | string | `` | no |
-| display\_name | An arbitrary and optional user-provided name for the instance. | string | `` | no |
-| enable\_apis | Enable required APIs for Cloud Memorystore. | string | `true` | no |
-| labels | The resource labels to represent user provided metadata. | map | `<map>` | no |
-| location\_id | The zone where the instance will be provisioned. | string | `` | no |
-| memory\_size\_gb | Redis memory size in GiB. | string | - | yes |
-| name | The ID of the instance or a fully qualified identifier for the instance. | string | - | yes |
-| project | The ID of the project in which the resource belongs to. | string | - | yes |
-| redis\_version | The version of Redis software. | string | `` | no |
-| region | The GCP region to use. | string | `` | no |
-| reserved\_ip\_range | The CIDR range of internal addresses that are reserved for this instance. | string | `` | no |
-| tier | The service tier of the instance. | string | `STANDARD_HA` | no |
+| alternative\_location\_id | The alternative zone where the instance will be provisioned. | string | `"null"` | no |
+| authorized\_network | The full name of the Google Compute Engine network to which the instance is connected. If left unspecified, the default network will be used. | string | `"null"` | no |
+| display\_name | An arbitrary and optional user-provided name for the instance. | string | `"null"` | no |
+| enable\_apis | Enable required APIs for Cloud Memorystore. | bool | `"true"` | no |
+| labels | The resource labels to represent user provided metadata. | object | `<map>` | no |
+| location\_id | The zone where the instance will be provisioned. If not provided, the service will choose a zone for the instance. For STANDARD_HA tier, instances will be created across two zones for protection against zonal failures. If [alternativeLocationId] is also provided, it must be different from [locationId]. | string | `"null"` | no |
+| memory\_size\_gb | Redis memory size in GiB. Defaulted to 1 GiB | number | `"1"` | no |
+| name | The ID of the instance or a fully qualified identifier for the instance. | string | n/a | yes |
+| project | The ID of the project in which the resource belongs to. | string | n/a | yes |
+| redis\_version | The version of Redis software. | string | `"null"` | no |
+| region | The GCP region to use. | string | `"null"` | no |
+| reserved\_ip\_range | The CIDR range of internal addresses that are reserved for this instance. | string | `"null"` | no |
+| tier | The service tier of the instance. https://cloud.google.com/memorystore/docs/redis/reference/rest/v1/projects.locations.instances#Tier | string | `"STANDARD_HA"` | no |
 
 ## Outputs
 
@@ -45,7 +48,7 @@ module "memorystore" {
 | id | The memorystore instance ID. |
 | region | The region the instance lives in. |
 
-[^]: (autogen_docs_end)
+<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 
 ## File structure
 
@@ -65,11 +68,17 @@ The project has the following folders and files:
 
 ### Requirements
 
+- Terraform is [installed](#software-dependencies) on the machine where Terraform is executed.
 - An existing google cloud project
 - The `redis.googleapis.com` API should be enabled
 - A service account key
 - Docker
 
+### Software Dependencies
+### Terraform
+- [Terraform](https://www.terraform.io/downloads.html) >= 0.12.0
+- [terraform-provider-google](https://github.com/terraform-providers/terraform-provider-google) >= v2.5.0
+
 ### Running Integration Tests
 
 Tests are run inside of an existing google cloud project.

diff --git a/examples/basic/memorystore.tf b/examples/basic/memorystore.tf
@@ -1,5 +1,5 @@
 /**
- * Copyright 2018 Google LLC
+ * Copyright 2019 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -15,7 +15,8 @@
  */
 
 module "memorystore" {
-  source  = "git::ssh://git@github.com/terraform-google-modules/terraform-google-memorystore"
-  name    = "memorystore"
-  project = "memorystore"
+  source         = "git::ssh://git@github.com/terraform-google-modules/terraform-google-memorystore"
+  name           = "memorystore"
+  project        = "memorystore"
+  memory_size_gb = "1"
 }
diff --git a/examples/basic/versions.tf b/examples/basic/versions.tf
@@ -0,0 +1,19 @@
+/**
+ * Copyright 2019 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+terraform {
+  required_version = ">= 0.12"
+}
diff --git a/helpers/combine_docfiles.py b/helpers/combine_docfiles.py