chore: Update to new blueprints test framework (#77)

Author: morgante

CONTRIBUTING.md

@@ -27,9 +27,8 @@ Integration tests are used to verify the behaviour of the root module,
 submodules, and example modules. Additions, changes, and fixes should
 be accompanied with tests.
 
-The integration tests are run using [Kitchen][kitchen],
-[Kitchen-Terraform][kitchen-terraform], and [InSpec][inspec]. These
-tools are packaged within a Docker image for convenience.
+The integration tests are run using Golang and
+are packaged within a Docker image for convenience.
 
 The general strategy for these tests is to verify the behaviour of the
 [example modules](./examples/), thus ensuring that the root module,
@@ -63,18 +62,7 @@ noninteractively, using the prepared test project.
 
 ### Interactive Execution
 
-1. Run `make docker_run` to start the testing Docker container in
-   interactive mode.
-
-1. Run `kitchen_do create <EXAMPLE_NAME>` to initialize the working
-   directory for an example module.
-
-1. Run `kitchen_do converge <EXAMPLE_NAME>` to apply the example module.
-
-1. Run `kitchen_do verify <EXAMPLE_NAME>` to test the example module.
-
-1. Run `kitchen_do destroy <EXAMPLE_NAME>` to destroy the example module
-   state.
+Review the [framework documentation](https://pkg.go.dev/github.com/GoogleCloudPlatform/cloud-foundation-toolkit/infra/blueprint-test#readme-4-test-execution) to learn how to execute tests.
 
 ## Linting and Formatting
 
@@ -90,9 +78,6 @@ Run `make docker_test_lint`.
 [gofmt]: https://golang.org/cmd/gofmt/
 [google-cloud-sdk]: https://cloud.google.com/sdk/install
 [hadolint]: https://github.com/hadolint/hadolint
-[inspec]: https://inspec.io/
-[kitchen-terraform]: https://github.com/newcontext-oss/kitchen-terraform
-[kitchen]: https://kitchen.ci/
 [make]: https://en.wikipedia.org/wiki/Make_(software)
 [shellcheck]: https://www.shellcheck.net/
 [terraform-docs]: https://github.com/segmentio/terraform-docs

Makefile

@@ -18,7 +18,7 @@
 # Make will use bash instead of sh
 SHELL := /usr/bin/env bash
 
-DOCKER_TAG_VERSION_DEVELOPER_TOOLS := 1.0
+DOCKER_TAG_VERSION_DEVELOPER_TOOLS := 1
 DOCKER_IMAGE_DEVELOPER_TOOLS := cft/developer-tools
 REGISTRY_URL := gcr.io/cloud-foundation-cicd
 

README.md

@@ -19,7 +19,7 @@ If you find incompatibilities using Terraform `>=0.13`, please open an issue.
 
 If you haven't [upgraded][terraform-0.13-upgrade] and need a Terraform
 0.12.x-compatible version of this module, the last released version
-intended for Terraform 0.12.x is [v1.5.0](https://registry.terraform.io/modules/terraform-google-modules/-event-function/google/v1.5.0).
+intended for Terraform 0.12.x is [v1.6.0](https://registry.terraform.io/modules/terraform-google-modules/-event-function/google/v1.6.0).
 
 ## Usage
 
@@ -100,8 +100,7 @@ from which this module will be invoked:
 
 - [Terraform](https://www.terraform.io/downloads.html) >= 0.13.0
 - [Terraform Provider for Archive][terraform-provider-archive-site]
-  v1.2
-- [Terraform Provider for Google Cloud Platform][terraform-provider-gcp-site] v2.5
+- [Terraform Provider for Google Cloud Platform][terraform-provider-gcp-site]
 
 ### IAM Roles
 

build/int.cloudbuild.yaml

@@ -23,19 +23,19 @@ steps:
   - 'TF_VAR_billing_account=$_BILLING_ACCOUNT'
 - id: create
   name: 'gcr.io/cloud-foundation-cicd/$_DOCKER_IMAGE_DEVELOPER_TOOLS:$_DOCKER_TAG_VERSION_DEVELOPER_TOOLS'
-  args: ['/bin/bash', '-c', 'source /usr/local/bin/task_helper_functions.sh && kitchen_do create']
+  args: ['/bin/bash', '-c', 'source /usr/local/bin/task_helper_functions.sh && source_test_env && init_credentials && cd test/integration && RUN_STAGE=init go test -v ./... -p 1']
 - id: converge
   name: 'gcr.io/cloud-foundation-cicd/$_DOCKER_IMAGE_DEVELOPER_TOOLS:$_DOCKER_TAG_VERSION_DEVELOPER_TOOLS'
-  args: ['/bin/bash', '-c', 'source /usr/local/bin/task_helper_functions.sh && kitchen_do converge']
+  args: ['/bin/bash', '-c', 'source /usr/local/bin/task_helper_functions.sh && source_test_env && init_credentials && cd test/integration && RUN_STAGE=apply go test -v ./... -p 1']
 - id: verify
   name: 'gcr.io/cloud-foundation-cicd/$_DOCKER_IMAGE_DEVELOPER_TOOLS:$_DOCKER_TAG_VERSION_DEVELOPER_TOOLS'
-  args: ['/bin/bash', '-c', 'source /usr/local/bin/task_helper_functions.sh && kitchen_do verify']
+  args: ['/bin/bash', '-c', 'source /usr/local/bin/task_helper_functions.sh && source_test_env && init_credentials && cd test/integration && RUN_STAGE=verify go test -v ./... -p 1']
 - id: destroy
   name: 'gcr.io/cloud-foundation-cicd/$_DOCKER_IMAGE_DEVELOPER_TOOLS:$_DOCKER_TAG_VERSION_DEVELOPER_TOOLS'
-  args: ['/bin/bash', '-c', 'source /usr/local/bin/task_helper_functions.sh && kitchen_do destroy']
+  args: ['/bin/bash', '-c', 'source /usr/local/bin/task_helper_functions.sh && source_test_env && init_credentials && cd test/integration && RUN_STAGE=teardown go test -v ./... -p 1']
 tags:
 - 'ci'
 - 'integration'
 substitutions:
   _DOCKER_IMAGE_DEVELOPER_TOOLS: 'cft/developer-tools'
-  _DOCKER_TAG_VERSION_DEVELOPER_TOOLS: '1.0'
+  _DOCKER_TAG_VERSION_DEVELOPER_TOOLS: '1'

examples/automatic-labelling-from-repository/README.md

@@ -32,6 +32,8 @@ this directory:
 | Name | Description |
 |------|-------------|
 | compute\_instance\_name | The name of the unlabelled Compute instance. |
+| project\_id | The ID of the project to which resources are applied. |
+| zone | The zone in which resources are applied. |
 
 <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 

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

@@ -18,3 +18,13 @@ output "compute_instance_name" {
   value       = google_compute_instance.main.name
   description = "The name of the unlabelled Compute instance."
 }
+
+output "project_id" {
+  value       = var.project_id
+  description = "The ID of the project to which resources are applied."
+}
+
+output "zone" {
+  value       = var.zone
+  description = "The zone in which resources are applied."
+}

test/integration/automatic-labelling-projects/controls/automatically_labelled.rb renamed to examples/delete-vms-without-cmek/test.yaml

@@ -1,23 +1,20 @@
-# Copyright 2019 Google LLC
+# Copyright 2021 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
 #
-#     https://www.apache.org/licenses/LICENSE-2.0
+#      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.
 
-
-# frozen_string_literal: true
-require "json"
-
-control "automatically labelled" do
-  describe google_project(project: attribute("test_project_id")).label_value_by_key('test') do
-    it {should match '^(foobar)$' }
-  end
-end
+apiVersion: blueprints.cloud.google.com/v1alpha1
+kind: BlueprintTest
+metadata:
+  name: delete-vms-without-cmek
+spec:
+  skip: true

examples/dynamic-files/README.md

@@ -27,6 +27,7 @@ this directory:
 | Name | Description |
 |------|-------------|
 | function\_name | The name of the function created |
+| project\_id | The project in which resources are applied. |
 | random\_file\_string | The content of the terraform created file in the source directory. |
 | region | The region in which resources are applied. |
 

examples/dynamic-files/outputs.tf

@@ -14,6 +14,11 @@
  * limitations under the License.
  */
 
+output "project_id" {
+  value       = var.project_id
+  description = "The project in which resources are applied."
+}
+
 output "region" {
   value       = var.region
   description = "The region in which resources are applied."