Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
92 lines (64 loc) · 2.97 KB

CONTRIBUTING.md

File metadata and controls

92 lines (64 loc) · 2.97 KB

Contributing

This document provides guidelines for contributing to the module.

Dependencies

The following dependencies must be installed on the development system:

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 behavior of the root module, submodules, and example modules. Additions, changes, and fixes should be accompanied with tests.

The general strategy for these tests is to verify the behavior of the example modules, 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 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"

With these settings in place, you can prepare a test project using Docker:

make docker_test_prepare

Interactive Execution

  1. Run make docker_run to start the testing Docker container in interactive mode.

  2. Run cft test list to list all the test.

  3. Run cft test run all --stage init --verbose to initialize the working directory for an example module.

  4. Run cft test run <TEST_NAME> --stage apply --verbose to apply the example module.

  5. Run cft test run <TEST_NAME> --stage verify --verbose to test the example module.

  6. Run cft test run <TEST_NAME> --stage teardown --verbose 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.