Update testing to Cloud Build

 * Fixed #262
 * Removed softlinks to tfvars from tests
 * Set `gsuit` provider version same for all examples
 * Disable `full` test (issue # 275)

.kitchen.yml

@@ -27,31 +27,31 @@ verifier:
       backend: local
 
 suites:
-  - name: full
-    driver:
-      name: terraform
-      command_timeout: 1800
-      root_module_directory: test/fixtures/full
-
   - name: minimal
     driver:
       name: terraform
       command_timeout: 1800
       root_module_directory: test/fixtures/minimal
-
-  - name: "shared_vpc_no_subnets"
-    driver:
-      name: "terraform"
-      command_timeout: 1800
-      root_module_directory: test/fixtures/shared_vpc_no_subnets/
-    verifier:
-      name: terraform
-      systems:
-        - name: inspec-gcp
-          backend: gcp
-          controls:
-            - gcp
-        - name: local
-          backend: local
-          controls:
-            - gcloud
+# Disabled due to issue #275
+# (https://github.com/terraform-google-modules/terraform-google-project-factory/issues/275)
+#  - name: full
+#    driver:
+#      name: terraform
+#      command_timeout: 1800
+#      root_module_directory: test/fixtures/full
+#  - name: "shared_vpc_no_subnets"
+#    driver:
+#      name: "terraform"
+#      command_timeout: 1800
+#      root_module_directory: test/fixtures/shared_vpc_no_subnets/
+#    verifier:
+#      name: terraform
+#      systems:
+#        - name: inspec-gcp
+#          backend: gcp
+#          controls:
+#            - gcp
+#        - name: local
+#          backend: local
+#          controls:
+#            - gcloud

CHANGELOG.md

@@ -8,6 +8,10 @@ Extending the adopted spec, each change should have a link to its corresponding
 
 ## [Unreleased]
 
+### Changed
+
+- Update testing to use Cloud Build. [#264]
+
 ### [3.3.0] - 2019-09-18
 
 ### Fixed
@@ -224,6 +228,7 @@ Extending the adopted spec, each change should have a link to its corresponding
 [0.2.1]: https://github.com/terraform-google-modules/terraform-google-project-factory/compare/v0.2.0...v0.2.1
 [0.2.0]: https://github.com/terraform-google-modules/terraform-google-project-factory/compare/v0.1.0...v0.2.0
 
+[#264]: https://github.com/terraform-google-modules/terraform-google-project-factory/pull/264
 [#261]: https://github.com/terraform-google-modules/terraform-google-project-factory/pull/261
 [#259]: https://github.com/terraform-google-modules/terraform-google-project-factory/pull/259
 [#253]: https://github.com/terraform-google-modules/terraform-google-project-factory/pull/253

CONTRIBUTING.md

@@ -0,0 +1,192 @@
+# Contributing
+
+This document provides guidelines for contributing to the Google Cloud Project Factory Terraform Module.
+
+## Dependencies
+
+The following dependencies must be installed on the development system:
+
+- [Docker Engine][docker-engine]
+- [Google Cloud SDK][google-cloud-sdk]
+- [make]
+
+### File structure
+
+The project has the following folders and files:
+
+- /: root folder
+- /examples: examples for using this module
+- /scripts: Scripts for specific tasks on module (see Infrastructure section on
+  this file)
+- /test: Folders with files for testing the module (see Testing section on this
+  file)
+- /helpers: Optional helper scripts for ease of use
+- /main.tf: main file for this module, contains all the resources to create
+- /variables.tf: all the variables for the module
+- /output.tf: the outputs of the module
+- /readme.md: this file
+
+## Generating Documentation for Inputs and Outputs
+
+The Inputs and Outputs tables in the READMEs of the root module,
+submodules, and example modules are automatically generated based on
+the `variables` and `outputs` of the respective modules. These tables
+must be refreshed if the module interfaces are changed.
+
+### Execution
+
+Run `make generate_docs` to generate new Inputs and Outputs tables.
+
+## Integration Testing
+
+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 general strategy for these tests is to verify the behaviour of the
+[example modules](./examples/), thus ensuring that the root module,
+submodules, and example modules are all functionally correct.
+
+### Test Environment
+The easiest way to test the module is in an isolated test project. The setup for such a project is defined in [test/setup](./test/setup/) directory.
+
+To use this setup, you need a service account with Project Creator access on a folder. Export the Service Account credentials to your environment like so:
+
+```
+export SERVICE_ACCOUNT_JSON=$(< credentials.json)
+```
+
+You will also need to set a few environment variables:
+```
+export TF_VAR_org_id="your_org_id"
+export TF_VAR_folder_id="your_folder_id"
+export TF_VAR_billing_account="your_billing_account_id"
+export TF_VAR_gsuite_admin_email="your_gsuite_admin_email"
+export TF_VAR_gsuite_domain="your_gsuite_domain"
+```
+
+With these settings in place, you can prepare a test project using Docker:
+
+```
+make docker_test_prepare
+```
+
+### Noninteractive Execution
+
+Run `make docker_test_integration` to test all of the example modules
+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.
+
+## Linting and Formatting
+
+Many of the files in the repository can be linted or formatted to
+maintain a standard of quality.
+
+### Execution
+
+Run `make docker_test_lint`.
+
+## Releasing New Versions
+
+New versions can be released by pushing tags to this repository's origin on
+GitHub. There is a Make target to facilitate the process:
+
+```
+make release-new-version
+```
+
+The new version must be documented in [CHANGELOG.md](CHANGELOG.md) for the
+target to work.
+
+See the Terraform documentation for more info on [releasing new
+versions][release-new-version].
+
+[release-new-version]: https://www.terraform.io/docs/registry/modules/publish.html#releasing-new-versions
+[docker-engine]: https://www.docker.com/products/docker-engine
+[flake8]: http://flake8.pycqa.org/en/latest/
+[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
+[terraform]: https://terraform.io/
+
+---------------------------------------------------------------------------------------------------
+
+Two test-kitchen instances are defined:
+
+- `full-local` - Test coverage for all project-factory features.
+- `full-minimal` - Test coverage for a minimal set of project-factory features.
+
+#### Setup
+
+1. Configure the [test fixtures](#test-configuration).
+2. Download a Service Account key with the necessary [permissions](#permissions)
+   and put it in the module's root directory with the name `credentials.json`.
+3. Add appropriate variables to your environment
+
+   ```
+   export BILLING_ACCOUNT_ID="YOUR_BILLUNG_ACCOUNT"
+   export DOMAIN="YOUR_DOMAIN"
+   export FOLDER_ID="YOUR_FOLDER_ID"
+   export GROUP_NAME="YOUR_GROUP_NAME"
+   export ADMIN_ACCOUNT_EMAIL="YOUR_ADMIN_ACCOUNT_EMAIL"
+   export ORG_ID="YOUR_ORG_ID"
+   export PROJECT_ID="YOUR_PROJECT_ID"
+   CREDENTIALS_FILE="credentials.json"
+   export SERVICE_ACCOUNT_JSON=`cat ${CREDENTIALS_FILE}`
+   ```
+
+4. Run the testing container in interactive mode.
+    ```
+    make docker_run
+    ```
+
+    The module root directory will be loaded into the Docker container at `/cft/workdir/`.
+5. Run kitchen-terraform to test the infrastructure.
+
+    1. `kitchen create` creates Terraform state.
+    2. `kitchen converge` creates the underlying resources. You can run `kitchen converge minimal` to only create the minimal fixture.
+    3. `kitchen verify` tests the created infrastructure. Run `kitchen verify minimal` to run the smaller test suite.
+    4. `kitchen destroy` removes the created infrastructure. Run `kitchen destroy minimal` to remove the smaller test suite.
+
+Alternatively, you can simply run `make test_integration_docker` to run all the
+test steps non-interactively.
+
+#### Test configuration
+
+Each test-kitchen instance is configured with a `terraform.tfvars` file in the
+test fixture directory. For convenience, these are symlinked to a single shared file:
+
+```sh
+cp "test/fixtures/shared/terraform.tfvars.example" \
+  "test/fixtures/shared/terraform.tfvars"
+$EDITOR "test/fixtures/shared/terraform.tfvars"
+done
+```
+
+Integration tests can be run within a pre-configured docker container. Tests can
+be run without user interaction for quick validation, or with user interaction
+during development.

LICENSE

@@ -199,4 +199,5 @@
    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.
+   limitations under the License.
+