feat: add integration tests (#11)

parabolic · bharathkkb · web-flow · commit 071d0d4be4d0 · 2020-10-23T19:09:24.000-05:00
* Add support for terraform 0.13 - Update the README - fix the tests (need test docker image update) - bump inspec-gcp version to the latest - remove bucket tests and add gcloud and gcp tests - set the versions to allow terraform 0.13 - change kitchen.yml to be more standardized * Slightly fix the variable names * - pin the image version to 0.12.0 * fix the variable description * bump the version of the developer tools to the latest * - pin the makefile version to 0.13 to be able to automatically get the patch versions - remove the integration test for the compute api - bump the project-factory module to the latest version (v9.0.0) - bump the providers to the latest versions (3.36.0) - re-ran the tests one more time, and they were successful ```sh Profile: simple_example Version: (not specified) Target: local:// ✔ gcloud: Gcloud checks: cloud router existence ✔ JSON from command: gcloud compute routers describe simple-example-crane --region=europe-west1 --project=ci-cloud-router-df88 --format=json name is expected to eq "simple-example- crane" ✔ JSON from command: gcloud compute routers describe simple-example-crane --region=europe-west1 --project=ci-cloud-router-df88 --format=json kind is expected to eq "compute#router" ✔ JSON from command: gcloud compute routers describe simple-example-crane --region=europe-west1 --project=ci-cloud-router-df88 --format=json region is expected to eq "https://www.g oogleapis.com/compute/v1/projects/ci-cloud-router-df88/regions/europe-west1" ✔ JSON from command: gcloud compute routers describe simple-example-crane --region=europe-west1 --project=ci-cloud-router-df88 --format=json selfLink is expected to eq "https://www .googleapis.com/compute/v1/projects/ci-cloud-router-df88/regions/europe-west1/routers/simple-example-crane" Profile Summary: 1 successful control, 0 control failures, 0 controls skipped Test Summary: 4 successful, 0 failures, 0 skipped $$$$$$ Finished verifying the 'local' system. $$$$$$ Verifying the 'inspec-gcp' system... Profile: simple_example Version: (not specified) Target: gcp://ci-account@ci-cloud-router-df88.iam.gserviceaccount.com ✔ gcp: GCP Resources ✔ Router simple-example-crane is expected to exist ✔ Router simple-example-crane name is expected to eq "simple-example-crane" ✔ Router simple-example-crane region is expected to match /\/europe-west1$/ ✔ Router dupe is expected not to exist Profile: Google Cloud Platform Resource Pack (inspec-gcp) Version: 1.7.0 Target: gcp://ci-account@ci-cloud-router-df88.iam.gserviceaccount.com No tests executed. Profile Summary: 1 successful control, 0 control failures, 0 controls skipped Test Summary: 4 successful, 0 failures, 0 skipped ``` * regen docs, fix header * address comments, hardcode example vars Co-authored-by: Bharath KKB <bharathkrishnakb@gmail.com>
diff --git a/Makefile b/Makefile
@@ -18,7 +18,7 @@
 # Make will use bash instead of sh
 SHELL := /usr/bin/env bash
 
-DOCKER_TAG_VERSION_DEVELOPER_TOOLS := 0.12.0
+DOCKER_TAG_VERSION_DEVELOPER_TOOLS := 0.12.2
 DOCKER_IMAGE_DEVELOPER_TOOLS := cft/developer-tools
 REGISTRY_URL := gcr.io/cloud-foundation-cicd
 
diff --git a/README.md b/README.md
@@ -25,13 +25,13 @@ Functional examples are included in the
 ## Inputs
 
 | Name | Description | Type | Default | Required |
-|------|-------------|:----:|:-----:|:-----:|
-| bgp | BGP information specific to this router. | any | `"null"` | no |
-| name | Name of the router | string | n/a | yes |
-| nats | NATs to deploy on this router. | any | `<list>` | no |
-| network | A reference to the network to which this router belongs | string | n/a | yes |
-| project | The project ID to deploy to | string | n/a | yes |
-| region | Region where the router resides | string | n/a | yes |
+|------|-------------|------|---------|:--------:|
+| bgp | BGP information specific to this router. | `any` | `null` | no |
+| name | Name of the router | `string` | n/a | yes |
+| nats | NATs to deploy on this router. | `any` | `[]` | no |
+| network | A reference to the network to which this router belongs | `string` | n/a | yes |
+| project | The project ID to deploy to | `string` | n/a | yes |
+| region | Region where the router resides | `string` | n/a | yes |
 
 ## Outputs
 
@@ -49,7 +49,7 @@ These sections describe requirements for using this module.
 
 The following dependencies must be available:
 
-- [Terraform][terraform] v0.12
+- [Terraform][terraform] v0.12 and above
 - [Terraform Provider for GCP][terraform-provider-gcp] plugin v2.0
 
 ### Service Account
diff --git a/build/int.cloudbuild.yaml b/build/int.cloudbuild.yaml
@@ -38,4 +38,4 @@ tags:
 - 'integration'
 substitutions:
   _DOCKER_IMAGE_DEVELOPER_TOOLS: 'cft/developer-tools'
-  _DOCKER_TAG_VERSION_DEVELOPER_TOOLS: '0.12.0'
+  _DOCKER_TAG_VERSION_DEVELOPER_TOOLS: '0.12.2'
diff --git a/build/lint.cloudbuild.yaml b/build/lint.cloudbuild.yaml
@@ -21,4 +21,4 @@ tags:
 - 'lint'
 substitutions:
   _DOCKER_IMAGE_DEVELOPER_TOOLS: 'cft/developer-tools'
-  _DOCKER_TAG_VERSION_DEVELOPER_TOOLS: '0.12.0'
+  _DOCKER_TAG_VERSION_DEVELOPER_TOOLS: '0.12.2'
diff --git a/examples/simple/main.tf b/examples/simple/main.tf
@@ -21,8 +21,8 @@ provider "google" {
 module "cloud_router" {
   source = "../../"
 
-  name    = "example-router"
-  project = "example-project"
-  network = "default"
+  name    = "test-router"
+  project = var.project
+  network = var.network
   region  = "us-central1"
 }
diff --git a/examples/simple/outputs.tf b/examples/simple/outputs.tf
@@ -0,0 +1,25 @@
+/**
+ * Copyright 2020 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.
+ */
+
+output "router_name" {
+  value       = module.cloud_router.router.name
+  description = "The name of the created router"
+}
+
+output "router_region" {
+  value       = module.cloud_router.router.region
+  description = "The region of the created router"
+}
diff --git a/examples/simple/variables.tf b/examples/simple/variables.tf
@@ -0,0 +1,25 @@
+/**
+ * Copyright 2020 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.
+ */
+
+variable "network" {
+  type        = string
+  description = "A reference to the network to which this router belongs"
+}
+
+variable "project" {
+  type        = string
+  description = "The GCP project ID"
+}
diff --git a/kitchen.yml b/kitchen.yml
@@ -15,29 +15,28 @@
 ---
 driver:
   name: terraform
+  verify_version: false
 
 provisioner:
   name: terraform
 
-verifier:
-  name: terraform
-
 platforms:
-  - name: default
+  - name: local
 
 suites:
-  - name: simple_example
+  - name: "simple_example"
     driver:
+      name: terraform
       root_module_directory: test/fixtures/simple_example/
     verifier:
-      color: false
+      name: terraform
+      color: true
       systems:
-        - name: simple_example local
+        - name: local
           backend: local
           controls:
             - gcloud
-            - gsutil
-        - name: simple_example gcp
+        - name: inspec-gcp
           backend: gcp
           controls:
             - gcp
diff --git a/test/fixtures/simple_example/main.tf b/test/fixtures/simple_example/main.tf
@@ -25,8 +25,18 @@ resource "random_pet" "main" {
 }
 
 module "example" {
-  source = "../../../examples/simple_example"
+  source = "../../../examples/simple"
 
-  project_id  = var.project_id
-  bucket_name = random_pet.main.id
+  project = var.project_id
+  network = module.vpc.network_name
+}
+
+module "vpc" {
+  source  = "terraform-google-modules/network/google"
+  version = "~> 2.5"
+
+  project_id   = var.project_id
+  network_name = "test-network"
+  routing_mode = "GLOBAL"
+  subnets      = []
 }
diff --git a/test/fixtures/simple_example/outputs.tf b/test/fixtures/simple_example/outputs.tf
@@ -14,12 +14,17 @@
  * limitations under the License.
  */
 
-output "bucket_name" {
-  description = "The name of the bucket."
-  value       = module.example.bucket_name
-}
-
 output "project_id" {
   description = "The ID of the project in which resources are provisioned."
   value       = var.project_id
 }
+
+output "cloud_router_name" {
+  description = "The name of the cloud router"
+  value       = module.example.router_name
+}
+
+output "region" {
+  description = "The region of the cloud router"
+  value       = module.example.router_region
+}
diff --git a/test/fixtures/simple_example/versions.tf b/test/fixtures/simple_example/versions.tf
@@ -15,5 +15,5 @@
  */
 
 terraform {
-  required_version = ">= 0.12"
+  required_version = ">=0.12.6, <0.14"
 }
diff --git a/test/integration/simple_example/controls/gcloud.rb b/test/integration/simple_example/controls/gcloud.rb
@@ -12,12 +12,17 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+project_id = attribute("project_id")
+region = attribute("region")
+cloud_router_name = attribute("cloud_router_name")
+
 control "gcloud" do
-  title "gcloud"
+  title "Gcloud checks: cloud router existence"
 
-  describe command("gcloud --project=#{attribute("project_id")} services list --enabled") do
-    its(:exit_status) { should eq 0 }
-    its(:stderr) { should eq "" }
-    its(:stdout) { should match "storage-api.googleapis.com" }
+  describe json({ command: "gcloud compute routers describe #{cloud_router_name} --region=#{region} --project=#{project_id} --format=json"}) do
+    its("name") { should eq cloud_router_name }
+    its("kind") { should eq "compute#router" }
+    its("region") { should eq "https://www.googleapis.com/compute/v1/projects/#{project_id}/regions/#{region}"}
+    its("selfLink") { should eq "https://www.googleapis.com/compute/v1/projects/#{project_id}/regions/#{region}/routers/#{cloud_router_name}"}
   end
 end
diff --git a/test/integration/simple_example/controls/gcp.rb b/test/integration/simple_example/controls/gcp.rb
@@ -12,10 +12,20 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+project_id = attribute("project_id")
+region = attribute("region")
+cloud_router_name = attribute("cloud_router_name")
+
 control "gcp" do
   title "GCP Resources"
 
-  describe google_storage_bucket(name: attribute("bucket_name")) do
+  describe google_compute_router(project: project_id, region: region, name: cloud_router_name) do
     it { should exist }
+    its("name") { should eq cloud_router_name }
+    its("region") { should match /\/#{region}$/ }
+  end
+
+  describe google_compute_router(project: project_id, region: region, name: "dupe") do
+    it { should_not exist }
   end
 end
diff --git a/test/integration/simple_example/controls/gsutil.rb b/test/integration/simple_example/controls/gsutil.rb
diff --git a/test/integration/simple_example/inspec.yml b/test/integration/simple_example/inspec.yml
@@ -2,11 +2,14 @@ name: simple_example
 depends:
   - name: inspec-gcp
     git: https://github.com/inspec/inspec-gcp.git
-    tag: v0.10.0
+    tag: v1.7.0
 attributes:
   - name: project_id
     required: true
     type: string
-  - name: bucket_name
+  - name: cloud_router_name
+    required: true
+    type: string
+  - name: region
     required: true
     type: string
diff --git a/test/setup/main.tf b/test/setup/main.tf
@@ -16,17 +16,17 @@
 
 module "project" {
   source  = "terraform-google-modules/project-factory/google"
-  version = "~> 3.0"
+  version = "~> 9.0.0"
 
-  name              = "ci-cloud_router"
+  name              = "ci-cloud-router"
   random_project_id = "true"
   org_id            = var.org_id
   folder_id         = var.folder_id
   billing_account   = var.billing_account
 
   activate_apis = [
     "cloudresourcemanager.googleapis.com",
-    "storage-api.googleapis.com",
-    "serviceusage.googleapis.com"
+    "serviceusage.googleapis.com",
+    "compute.googleapis.com"
   ]
 }
diff --git a/test/setup/versions.tf b/test/setup/versions.tf
@@ -15,13 +15,13 @@
  */
 
 terraform {
-  required_version = ">= 0.12"
+  required_version = ">=0.12.6, <0.14"
 }
 
 provider "google" {
-  version = "~> 2.13.0"
+  version = "~> 3.36.0"
 }
 
 provider "google-beta" {
-  version = "~> 2.13.0"
+  version = "~> 3.36.0"
 }
