Server IP : 85.214.239.14 / Your IP : 18.118.30.153 Web Server : Apache/2.4.62 (Debian) System : Linux h2886529.stratoserver.net 4.9.0 #1 SMP Tue Jan 9 19:45:01 MSK 2024 x86_64 User : www-data ( 33) PHP Version : 7.4.18 Disable Function : pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wifcontinued,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_get_handler,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,pcntl_async_signals,pcntl_unshare, MySQL : OFF | cURL : OFF | WGET : ON | Perl : ON | Python : ON | Sudo : ON | Pkexec : OFF Directory : /lib/python3/dist-packages/ansible_collections/google/cloud/ |
Upload File : |
# 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 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 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).