Merge pull request #25 from terraform-google-modules/aaron-lane-0.12

Release 0.12

Author: morgante

CHANGELOG.md

@@ -5,10 +5,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/) and this
 project adheres to [Semantic Versioning](http://semver.org/).
 
-## [Unreleased] - major
+## [Unreleased]
+
+## [1.0.0] - 2019-YY-ZZ
 
 ### Changed
 
+- Supported version of Terraform is 0.12. [#23]
 - Support aggregated log exports by integrating log-export module. [#18]
 
 ## [0.1.0] - 2019-04-03
@@ -20,4 +23,5 @@ project adheres to [Semantic Versioning](http://semver.org/).
 [Unreleased]: https://github.com/terraform-google-modules/terraform-google-event-function/compare/v0.1.0...HEAD
 [0.1.0]: https://github.com/terraform-google-modules/terraform-google-event-function/releases/tag/v0.1.0
 
+[#23]: https://github.com/terraform-google-modules/terraform-google-event-function/pull/23
 [#18]: https://github.com/terraform-google-modules/terraform-google-event-function/pull/18

Makefile

@@ -21,7 +21,7 @@ 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 	?= 1.0.0
+DOCKER_TAG_BASE_KITCHEN_TERRAFORM 	?= 2.3.0
 DOCKER_REPO_BASE_KITCHEN_TERRAFORM 	:= ${DOCKER_ORG}/cft/kitchen-terraform:${DOCKER_TAG_BASE_KITCHEN_TERRAFORM}
 
 all: check generate_docs
@@ -76,48 +76,59 @@ version:
 .PHONY: docker_run
 docker_run:
 	docker run --rm -it \
-		-e CLOUDSDK_AUTH_CREDENTIAL_FILE_OVERRIDE=${CREDENTIALS_PATH} \
+		-e PROJECT_ID \
+		-e SERVICE_ACCOUNT_JSON \
 		-e GOOGLE_APPLICATION_CREDENTIALS=${CREDENTIALS_PATH} \
 		-v $(CURDIR):/cft/workdir \
 		${DOCKER_REPO_BASE_KITCHEN_TERRAFORM} \
-		/bin/bash
+		/bin/bash -c "source test/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 PROJECT_ID \
+		-e SERVICE_ACCOUNT_JSON \
 		-e GOOGLE_APPLICATION_CREDENTIALS=${CREDENTIALS_PATH} \
 		-v $(CURDIR):/cft/workdir \
 		${DOCKER_REPO_BASE_KITCHEN_TERRAFORM} \
-		/bin/bash -c "kitchen create"
+		/bin/bash -c "source test/integration.sh && setup_environment && kitchen create"
 
 .PHONY: docker_converge
 docker_converge:
 	docker run --rm -it \
-		-e CLOUDSDK_AUTH_CREDENTIAL_FILE_OVERRIDE=${CREDENTIALS_PATH} \
+		-e PROJECT_ID \
+		-e SERVICE_ACCOUNT_JSON \
 		-e GOOGLE_APPLICATION_CREDENTIALS=${CREDENTIALS_PATH} \
 		-v $(CURDIR):/cft/workdir \
 		${DOCKER_REPO_BASE_KITCHEN_TERRAFORM} \
-		/bin/bash -c "kitchen converge && kitchen converge"
+		/bin/bash -c "source test/integration.sh && setup_environment && kitchen converge"
 
 .PHONY: docker_verify
 docker_verify:
 	docker run --rm -it \
-		-e CLOUDSDK_AUTH_CREDENTIAL_FILE_OVERRIDE=${CREDENTIALS_PATH} \
+		-e PROJECT_ID \
+		-e SERVICE_ACCOUNT_JSON \
 		-e GOOGLE_APPLICATION_CREDENTIALS=${CREDENTIALS_PATH} \
 		-v $(CURDIR):/cft/workdir \
 		${DOCKER_REPO_BASE_KITCHEN_TERRAFORM} \
-		/bin/bash -c "kitchen verify"
+		/bin/bash -c "source test/integration.sh && setup_environment && kitchen verify"
 
 .PHONY: docker_destroy
 docker_destroy:
 	docker run --rm -it \
-		-e CLOUDSDK_AUTH_CREDENTIAL_FILE_OVERRIDE=${CREDENTIALS_PATH} \
+		-e PROJECT_ID \
+		-e SERVICE_ACCOUNT_JSON \
 		-e GOOGLE_APPLICATION_CREDENTIALS=${CREDENTIALS_PATH} \
 		-v $(CURDIR):/cft/workdir \
 		${DOCKER_REPO_BASE_KITCHEN_TERRAFORM} \
-		/bin/bash -c "kitchen destroy"
+		/bin/bash -c "source test/integration.sh && setup_environment && kitchen destroy"
 
 .PHONY: test_integration_docker
-test_integration_docker: docker_create docker_converge docker_verify docker_destroy
-	@echo "Running test-kitchen tests in docker"
+test_integration_docker:
+	docker run --rm -it \
+		-e PROJECT_ID \
+		-e SERVICE_ACCOUNT_JSON \
+		-e GOOGLE_APPLICATION_CREDENTIALS=${CREDENTIALS_PATH} \
+		-v $(CURDIR):/cft/workdir \
+		${DOCKER_REPO_BASE_KITCHEN_TERRAFORM} \
+		make test_integration

README.md

@@ -13,6 +13,12 @@ Alternatively, the
 configures a function sourced from a Cloud Source Repositories
 repository.
 
+## 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/event-function/google/0.1.0).
+
+
 ## Usage
 
 The
@@ -57,11 +63,11 @@ order to invoke this module.
 The following software dependencies must be installed on the system
 from which this module will be invoked:
 
-- [Terraform][terraform-site] v0.11.Z
+- [Terraform][terraform-site] v0.12.Z
 - [Terraform Provider for Archive][terraform-provider-archive-site]
   v1.2.Z
 - [Terraform Provider for Google Cloud Platform][terraform-provider-gcp-site]
-  v2.1.Z
+  v2.5.Z
 
 ### IAM Roles
 

examples/automatic-labelling-from-localhost/function_source/index.js

@@ -49,7 +49,7 @@ authenticate = callback => {
  * @param {!Function} callback A callback function to signal completion.
  */
 fetchLabels = ({ authClient, instance, project, zone }, callback) => {
-  console.log("Fetching labels");
+  console.log("Fetching labels for " + instance);
   compute.instances.get(
     { auth: authClient, instance, project, zone }, (error, response) => {
       if (error) {
@@ -84,7 +84,7 @@ fetchLabels = ({ authClient, instance, project, zone }, callback) => {
 storeLabels =
   ({ authClient, instance, labelFingerprint, labels, project, zone },
     callback) => {
-    console.log("Storing labels");
+    console.log("Storing labels for " + instance);
     compute.instances.setLabels(
       {
         auth: authClient,

examples/automatic-labelling-from-localhost/main.tf

@@ -15,7 +15,7 @@
  */
 
 terraform {
-  required_version = "~> 0.11.0"
+  required_version = "~> 0.12.0"
 }
 
 provider "archive" {
@@ -31,7 +31,7 @@ provider "random" {
 }
 
 provider "null" {
-  version = "~> 1.0"
+  version = "~> 2.1"
 }
 
 resource "random_pet" "main" {
@@ -42,8 +42,8 @@ module "event_project_log_entry" {
   source = "../../modules/event-project-log-entry"
 
   filter     = "protoPayload.@type=\"type.googleapis.com/google.cloud.audit.AuditLog\" protoPayload.methodName:insert operation.first=true"
-  name       = "${random_pet.main.id}"
-  project_id = "${var.project_id}"
+  name       = random_pet.main.id
+  project_id = var.project_id
 }
 
 module "localhost_function" {
@@ -56,10 +56,10 @@ module "localhost_function" {
     LABEL_KEY = "principal-email"
   }
 
-  event_trigger    = "${module.event_project_log_entry.function_event_trigger}"
-  name             = "${random_pet.main.id}"
-  project_id       = "${var.project_id}"
-  region           = "${var.region}"
+  event_trigger    = module.event_project_log_entry.function_event_trigger
+  name             = random_pet.main.id
+  project_id       = var.project_id
+  region           = var.region
   source_directory = "${path.module}/function_source"
   runtime          = "nodejs8"
 }
@@ -69,25 +69,31 @@ resource "null_resource" "wait_for_function" {
     command = "sleep 60"
   }
 
-  depends_on = ["module.localhost_function"]
+  depends_on = [module.localhost_function]
 }
 
 resource "google_compute_instance" "main" {
-  boot_disk = {
-    initialize_params = {
+  boot_disk {
+    initialize_params {
       image = "debian-cloud/debian-9"
     }
   }
 
   machine_type = "f1-micro"
   name         = "unlabelled-${random_pet.main.id}"
-  zone         = "${var.zone}"
+  zone         = var.zone
+
+  lifecycle {
+    ignore_changes = [
+      labels,
+    ]
+  }
 
-  network_interface = {
+  network_interface {
     network = "default"
   }
 
-  project = "${var.project_id}"
+  project = var.project_id
 
-  depends_on = ["null_resource.wait_for_function"]
+  depends_on = [null_resource.wait_for_function]
 }

examples/automatic-labelling-from-localhost/outputs.tf

@@ -15,6 +15,6 @@
  */
 
 output "compute_instance_name" {
-  value       = "${google_compute_instance.main.name}"
+  value       = google_compute_instance.main.name
   description = "The name of the unlabelled Compute instance."
 }

examples/automatic-labelling-from-localhost/variables.tf

@@ -15,16 +15,16 @@
  */
 
 variable "project_id" {
-  type        = "string"
+  type        = string
   description = "The ID of the project to which resources will be applied."
 }
 
 variable "region" {
-  type        = "string"
+  type        = string
   description = "The region in which resources will be applied."
 }
 
 variable "zone" {
-  type        = "string"
+  type        = string
   description = "The zone in which resources will be applied."
 }

examples/automatic-labelling-from-repository/.gitignore

@@ -0,0 +1 @@
+/function_source_copy

examples/automatic-labelling-from-repository/function_source/index.js

@@ -49,7 +49,7 @@ authenticate = callback => {
  * @param {!Function} callback A callback function to signal completion.
  */
 fetchLabels = ({ authClient, instance, project, zone }, callback) => {
-  console.log("Fetching labels");
+  console.log("Fetching labels for " + instance);
   compute.instances.get(
     { auth: authClient, instance, project, zone }, (error, response) => {
       if (error) {
@@ -84,7 +84,7 @@ fetchLabels = ({ authClient, instance, project, zone }, callback) => {
 storeLabels =
   ({ authClient, instance, labelFingerprint, labels, project, zone },
     callback) => {
-    console.log("Storing labels");
+    console.log("Storing labels for " + instance);
     compute.instances.setLabels(
       {
         auth: authClient,

examples/automatic-labelling-from-repository/main.tf

@@ -15,7 +15,7 @@
  */
 
 terraform {
-  required_version = "~> 0.11.0"
+  required_version = "~> 0.12.0"
 }
 
 provider "archive" {
@@ -31,28 +31,28 @@ provider "random" {
 }
 
 provider "null" {
-  version = "~> 1.0"
+  version = "~> 2.1"
 }
 
 resource "random_pet" "main" {
   separator = "-"
 }
 
 resource "google_sourcerepo_repository" "main" {
-  name    = "${random_pet.main.id}"
-  project = "${var.project_id}"
+  name    = random_pet.main.id
+  project = var.project_id
 }
 
 resource "null_resource" "configure_repository" {
-  triggers {
-    repository_url = "${google_sourcerepo_repository.main.url}"
+  triggers = {
+    repository_url = google_sourcerepo_repository.main.url
   }
 
   provisioner "local-exec" {
     command = "${path.module}/scripts/configure_repository.sh"
 
-    environment {
-      REMOTE_URL                = "${google_sourcerepo_repository.main.url}"
+    environment = {
+      REMOTE_URL                = google_sourcerepo_repository.main.url
       REPOSITORY_DIRECTORY      = "${path.module}/function_source"
       REPOSITORY_COPY_DIRECTORY = "${path.module}/function_source_copy"
     }
@@ -64,15 +64,15 @@ data "null_data_source" "main" {
     source_repository_url = "https://source.developers.google.com/projects/${var.project_id}/repos/${random_pet.main.id}/moveable-aliases/master/paths/"
   }
 
-  depends_on = ["null_resource.configure_repository"]
+  depends_on = [null_resource.configure_repository]
 }
 
 module "event_project_log_entry" {
   source = "../../modules/event-project-log-entry"
 
   filter     = "protoPayload.@type=\"type.googleapis.com/google.cloud.audit.AuditLog\" protoPayload.methodName:insert operation.first=true"
-  name       = "${random_pet.main.id}"
-  project_id = "${var.project_id}"
+  name       = random_pet.main.id
+  project_id = var.project_id
 }
 
 module "repository_function" {
@@ -86,37 +86,43 @@ module "repository_function" {
     LABEL_KEY = "principal-email"
   }
 
-  event_trigger         = "${module.event_project_log_entry.function_event_trigger}"
-  name                  = "${random_pet.main.id}"
-  project_id            = "${var.project_id}"
-  region                = "${var.region}"
-  source_repository_url = "${data.null_data_source.main.outputs["source_repository_url"]}"
+  event_trigger         = module.event_project_log_entry.function_event_trigger
+  name                  = random_pet.main.id
+  project_id            = var.project_id
+  region                = var.region
+  source_repository_url = data.null_data_source.main.outputs["source_repository_url"]
 }
 
 resource "null_resource" "wait_for_function" {
   provisioner "local-exec" {
     command = "sleep 60"
   }
 
-  depends_on = ["module.repository_function"]
+  depends_on = [module.repository_function]
 }
 
 resource "google_compute_instance" "main" {
-  boot_disk = {
-    initialize_params = {
+  boot_disk {
+    initialize_params {
       image = "debian-cloud/debian-9"
     }
   }
 
   machine_type = "f1-micro"
   name         = "unlabelled-${random_pet.main.id}"
-  zone         = "${var.zone}"
+  zone         = var.zone
+
+  lifecycle {
+    ignore_changes = [
+      labels,
+    ]
+  }
 
-  network_interface = {
+  network_interface {
     network = "default"
   }
 
-  project = "${var.project_id}"
+  project = var.project_id
 
-  depends_on = ["null_resource.wait_for_function"]
+  depends_on = [null_resource.wait_for_function]
 }