Skip to content

Latest commit

 

History

History
101 lines (66 loc) · 2.84 KB

CONTRIBUTING.md

File metadata and controls

101 lines (66 loc) · 2.84 KB
Raw

Contributing to the google.cloud collection

Workflow summary

  1. Clone the repository.
  2. Make the desired code change.
  3. Add a changelog fragment to describe your change.
  4. Run integration tests locally and ensure they pass.
  5. Create a PR.

Cloning

The ansible-test command expects that the repository is in a directory that matches it's collection, under a directory ansible_collections. Clone ensuring that hierarchy:

mkdir -p $TARGET_DIR/ansible_collections/google
git clone <url> $TARGET_DIR/collections/google/cloud

Running tests

prequisites for all tests

  • Install the ansible package.
  • Some container runtime is necessary (e.g. podman or docker). The instructions use podman.

Running integration tests

Integration testing prequisites

Installing personal GCP credentials

The integration tests for this module require the use of real GCP credentials, and must provide ansible-test those values. They can be added by authoring the following in tests/integration/cloud-config-gcp.ini:

[default]
gcp_project: @PROJECT_ID
gcp_cred_file: @CRED_FILE
gcp_cred_kind: @CRED_KIND
gcp_cred_email: @EMAIL
gcp_folder_id: @TEST_FOLDER (to create test projects)

Setting up the project for testing

Some of the setup of the project itself is done outside of the test, and is expected to be configured beforehand.

For convenience, a bootstrap script is provided.

NOTE: running this script will make irreversible changes in your GCP project (e.g. create an AppEngine project):

bash ./scripts/bootstrap-project.sh $PROJECT_ID $SERVICE_ACCOUNT_NAME

Running

Run ansible-test integration. Currently some tests are disabled as test are being verified and added.

Role tests

Prequisites for role tests

If you would like to use podman, you must install the molecule[podman] package in PyPI:

pip install --upgrade molecule[podman]

Running role tests

Ansible roles are tested via molecule.

module debug --test -s ${ROLE}

Role is the name of the role (e.g. gcloud, gcsfuse).

Add -d podman if you would like to use the podman driver.

If the linting fails, that is generally due to ansible-lint, which can be run directly:

ansible-lint

Specific Tasks

The following enumerates detailed documentation for specific tasks related tot the codebase.

Updating the supported ansible-core version

  1. modify the ansible-integration-tests.yaml to the version of ansible-core that you would like to test against.
  2. (optional) update the version of ansible-core version required in meta/runtime.yaml.