mirror of
https://github.com/ansible-collections/google.cloud.git
synced 2025-04-05 10:20:26 -07:00
1ec54b286d
- Updating and documenting changelog creation process. antsibull-changelog was chosen because it is the standard tooling recommended by Ansible developers. - Documenting the release process and several others so others can perform it in the future. - Updating the integration tests to test against 2.13, which the 1.1.0 final release will be certified for. - Created changelog and update galaxy.yaml for 1.1.0-beta, which will be the next release.
101 lines
2.8 KiB
Markdown
101 lines
2.8 KiB
Markdown
# Contributing to the google.cloud collection
|
|
|
|
## Workflow summary
|
|
|
|
1. [Clone the repository](#cloning).
|
|
1. Make the desired code change.
|
|
1. Add a [changelog fragment](https://docs.ansible.com/ansible/devel/community/development_process.html#changelogs-how-to) to describe your change.
|
|
1. [Run integration tests locally and ensure they pass](running-integration-tests).
|
|
1. 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:
|
|
|
|
```shell
|
|
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
|
|
```
|
|
|
|
#### 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
|
|
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](https://github.com/ansible-collections/google.cloud/issues/499).
|
|
|
|
## 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.
|
|
|
|
```sh
|
|
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](.github/workflows/ansible-integration-tests.yml) to the version of ansible-core that you would like to test against.
|
|
1. (optional) update the version of ansible-core version required in [meta/runtime.yaml](meta/runtime.yml).
|
|
|