Use tf dev override in integration test (#1588)

* Use tf dev override in integration test

* use go-plus terraform version to run integration test

* Fix tf config file

* not copy tf config file to /tmp

Author: iyabchen

.ci/cloudbuild-tests-integration.yaml

@@ -22,14 +22,13 @@ steps:
     args:
       [
         "-c",
-        "mv /terraform/$_TERRAFORM_VERSION /bin/terraform && /usr/bin/make test-integration",
+        "/usr/bin/make test-integration",
       ]
     env:
       - TEST_PROJECT=$_TEST_PROJECT
       - TEST_FOLDER_ID=$_TEST_FOLDER
       - TEST_ANCESTRY=$_TEST_ANCESTRY
       - TEST_ORG_ID=$_TEST_ORG
-      - TERRAFORM_VERSION=$_TERRAFORM_VERSION
 tags:
   - "ci"
   - "integration"

.gitignore

@@ -17,3 +17,6 @@ examples/*.tfstate*
 # binary
 ./cmd
 bin/
+
+# terraform config file for integration test
+tf-dev-override.tfrc

Dockerfile

@@ -1,6 +1,5 @@
-TERRAFORM_VERSION=0.12.31
-
 build_dir=./bin
+TF_CONFIG_FILE=tf-dev-override.tfrc
 
 build:
 	GO111MODULE=on go build -o ${build_dir}/tfplan2cai ./cmd/tfplan2cai
@@ -11,19 +10,24 @@ test:
 test-integration:
 	go version
 	terraform --version
-	go test -run=CLI ./...
+	./tf-dev-override.sh
+	TF_CLI_CONFIG_FILE="${PWD}/${TF_CONFIG_FILE}" go test -run=CLI ./...
 
 test-go-licenses:
 	cd .. && go version && go install github.com/google/go-licenses@latest
 	$$(go env GOPATH)/bin/go-licenses check ./... --ignore github.com/dnaeon/go-vcr
 
-build-docker:
-	docker build --build-arg TERRAFORM_VERSION=$(TERRAFORM_VERSION) -f ./Dockerfile -t terraform-google-conversion .
-
 run-docker:
-	docker run -it -v `pwd`:/terraform-google-conversion -v ${GOOGLE_APPLICATION_CREDENTIALS}:/terraform-google-conversion/credentials.json --entrypoint=/bin/bash --env TEST_PROJECT=${PROJECT_ID} --env GOOGLE_APPLICATION_CREDENTIALS=/terraform-google-conversion/credentials.json terraform-google-conversion;
+	docker run -it \
+	-v `pwd`:/terraform-google-conversion \
+	-v ${GOOGLE_APPLICATION_CREDENTIALS}:/terraform-google-conversion/credentials.json \
+	-w /terraform-google-conversion \
+	--entrypoint=/bin/bash \
+	--env TEST_PROJECT=${PROJECT_ID} \
+	--env GOOGLE_APPLICATION_CREDENTIALS=/terraform-google-conversion/credentials.json \
+	gcr.io/graphite-docker-images/go-plus;
 
 release:
 	./release.sh ${VERSION}
 
-.PHONY: test test-integration test-go-licenses build-docker run-docker release
+.PHONY: build test test-integration test-go-licenses run-docker release

Makefile

@@ -7,57 +7,44 @@ If you want to contribute to Terraform Google Conversion, check out the [contrib
 - [Contributing](#contributing)
   - [Table of Contents](#table-of-contents)
   - [Testing](#testing)
-    - [Docker](#docker)
+    - [Unit Test](#unit-test)
+    - [Integration Test](#integration-test)
     - [Add a new resource](#add-a-new-resource)
 
 
 ## Testing
 
-**Note:** Integration tests require a test project.
-
-```
+### Unit Test
+```bash
 # Unit tests
 make test
+```
 
-# Integration tests (interacts with real APIs)
-gcloud auth application-default login
-export TEST_PROJECT=my-project-id
-export TEST_CREDENTIALS=~/.config/gcloud/application_default_credentials.json
-make test-integration
+### Integration Test
 
-# Specific integration test
-make build
-go test -v -run=<test name or prefix> ./tfplan2cai/test
-```
+**Note:** Integration tests require a test project.
 
-### Docker
 It is better to run the integration tests inside a Docker container to match the CI/CD pipeline.
-First, build the Docker container:
 
-```
-make build-docker
-```
+The integration test installs the provider binary and creates a terraform dev override file tf-dev-override.tfrc. [Dev override](https://googlecloudplatform.github.io/magic-modules/develop/run-tests/#optional-test-manually) is to make sure the test runs against the provider version specified in the go module. You can place your own config within tf-dev-override.tfrc. If the file already exists, it will not be overwritten.
 
-For obtaining a credentials file, run
-```
-gcloud auth application-default login
-```
-
-Start the Docker container:
+```bash
+# Integration tests (interacts with real APIs)
 
-```
+# obtain credentials
+gcloud auth application-default login
 export TEST_PROJECT=my-project-id
-export GOOGLE_APPLICATION_CREDENTIALS=$(pwd)/credentials.json
+export TEST_CREDENTIALS=~/.config/gcloud/application_default_credentials.json
+
+# Spin up a docker container to run tests.
 make run-docker
-# install terraform, check Makefile for the default version of terraform.
-/install-terraform.sh
-```
 
-Finally, run the integration tests inside the container:
-```
+# Inside the docker container,
+# run this to setup dev override and run integration tests.
 make test-integration
 ```
 
+
 ### Add a new resource
 
 See [Add a new resource](./add_new_resource.md)

docs/contributing/index.md

@@ -0,0 +1,28 @@
+#!/bin/bash
+set -ex
+
+TF_CONFIG_FILE="tf-dev-override.tfrc"
+
+# required for go install terraform-provider-google-beta
+go mod download github.com/hashicorp/terraform-plugin-mux
+
+go install github.com/hashicorp/terraform-provider-google-beta
+
+# create terraform configuration file
+if ! [ -f $TF_CONFIG_FILE ];then
+  cat <<EOF > $TF_CONFIG_FILE
+  provider_installation {
+    # Developer overrides will stop Terraform from downloading the listed
+    # providers their origin provider registries.
+    dev_overrides {
+        "hashicorp/google-beta" = "$GOPATH/bin"
+    }
+    # For all other providers, install them directly from their origin provider
+    # registries as normal. If you omit this, Terraform will _only_ use
+    # the dev_overrides block, and so no other providers will be available.
+    # Without this, show "Failed to query available provider packages"
+    # at terraform init
+    direct{}
+  }
+EOF
+fi