Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gofrolist/molecule-action
GitHub Action for running molecule as part of your workflows!
https://github.com/gofrolist/molecule-action
ansible molecule
Last synced: about 18 hours ago
JSON representation
GitHub Action for running molecule as part of your workflows!
- Host: GitHub
- URL: https://github.com/gofrolist/molecule-action
- Owner: gofrolist
- License: mit
- Created: 2019-12-20T08:02:59.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-10-24T09:11:13.000Z (about 2 months ago)
- Last Synced: 2024-10-25T06:23:53.538Z (about 2 months ago)
- Topics: ansible, molecule
- Language: Smarty
- Homepage: https://molecule.readthedocs.io
- Size: 979 KB
- Stars: 54
- Watchers: 3
- Forks: 23
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Molecule for GitHub Action
[](https://hub.docker.com/r/gofrolist/molecule)
[](LICENSE)
[](https://github.com/semantic-release/semantic-release)
This GitHub action allows you to run [Molecule](https://molecule.readthedocs.io/en/stable/) to test [Ansible](https://www.ansible.com/) role.
## Inputs
```yaml
molecule_options:
description: |
Options:
--debug / --no-debug Enable or disable debug mode. Default is disabled.
-v, --verbose Increase Ansible verbosity level. Default is 0. [x>=0]
-c, --base-config TEXT Path to a base config (can be specified multiple times). If provided, Molecule will first load and deep merge the configurations in the specified order, and deep merge each scenario's molecule.yml on top. By default Molecule is looking for
'.config/molecule/config.yml' in current VCS repository and if not found it will look in user home. (None).
-e, --env-file TEXT The file to read variables from when rendering molecule.yml. (.env.yml)
--version
--help Show this message and exit.
required: false
molecule_command:
description: |
Commands:
check Use the provisioner to perform a Dry-Run (destroy, dependency, create, prepare, converge).
cleanup Use the provisioner to cleanup any changes made to external systems during the stages of testing.
converge Use the provisioner to configure instances (dependency, create, prepare converge).
create Use the provisioner to start the instances.
dependency Manage the role's dependencies.
destroy Use the provisioner to destroy the instances.
drivers List drivers.
idempotence Use the provisioner to configure the instances and parse the output to determine idempotence.
init Initialize a new role or scenario.
lint Lint the role (dependency, lint).
list List status of instances.
login Log in to one instance.
matrix List matrix of steps used to test instances.
prepare Use the provisioner to prepare the instances into a particular starting state.
reset Reset molecule temporary folders.
side-effect Use the provisioner to perform side-effects to the instances.
syntax Use the provisioner to syntax check the role.
test Test (dependency, lint, cleanup, destroy, syntax, create, prepare, converge, idempotence, side_effect, verify, cleanup, destroy).
verify Run automated tests against instances.
required: true
default: 'test'
molecule_args:
description: |
Arguments:
-s, --scenario-name TEXT Name of the scenario to target. (default)
-d, --driver-name [delegated|docker]
Name of driver to use. (delegated)
--all / --no-all Test all scenarios. Default is False.
--destroy [always|never] The destroy strategy used at the conclusion of a Molecule run (always).
--parallel / --no-parallel Enable or disable parallel mode. Default is disabled.
required: false
molecule_working_dir:
description: |
Path to another directory in the repository, where molecule command will be issued from.
Useful in those cases where Ansible roles are not in git repository root.
required: false
default: '${GITHUB_REPOSITORY}'
```
## Usage
To use the action simply create an `main.yml` (or choose custom `*.yml` name) in the `.github/workflows/` directory.
### Basic example:
```yaml
on: push
jobs:
molecule:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
with:
path: "${{ github.repository }}"
- uses: gofrolist/molecule-action@v2
```
>NOTE: By default molecule is going to look for configuration at `molecule/*/molecule.yml`, so if option `molecule-working-dir` is not provided,
>checkout action needs to place the file in ${{ github.repository }} in order for Molecule to find your role. If your role is placed somewhere else
>in the repository, ensure that `molecule-working-dir` is set up accordingly, in order to `cd` to that directory before issuing `molecule` command.
### Advanced example:
```yaml
name: Molecule
on:
push:
branches:
- master
pull_request:
branches:
- master
jobs:
molecule:
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
scenario:
- centos-8
- debian-10
- fedora-34
- oraclelinux-8
- ubuntu-20.04
steps:
- name: Checkout
uses: actions/checkout@v2
with:
path: "${{ github.repository }}"
- name: Molecule
uses: gofrolist/molecule-action@v2
with:
molecule_options: --debug --base-config molecule/_shared/base.yml
molecule_command: test
molecule_args: --scenario-name ${{ matrix.scenario }}
env:
ANSIBLE_FORCE_COLOR: '1'
```
> TIP: N.B. Use `gofrolist/molecule-action@v2` or any other valid tag, or branch, or commit SHA instead of `v2` to pin the action to use a specific version.
## Troubleshooting
If you see this error while you executing `apt_key` task
```
FAILED! => {"changed": false, "msg": "Failed to find required executable gpg in paths: /usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/snap/bin"}
```
That means your docker image require some python modules `gpg` and you can install them in molecule prepare step or embed it in your dockerfile.
```yaml
---
- name: Prepare
hosts: all
tasks:
- name: dependency for apt_key
apt:
name: python3-gpg
state: present
update_cache: true
```
If you see this error while you executing `pip` task
```
FAILED! => {"changed": false, "msg": "No package matching 'python-pip' is available"}
```
That means your docker image is missing `pip` and you can install them in molecule prepare step or embed it in your dockerfile.
```yaml
---
- name: Prepare
hosts: all
tasks:
- name: dependency for pip
apt:
name: python3-pip
state: present
update_cache: true
```
If you are trying to install any Python packages in order to run your Molecule
tests such as the OpenStack SDK and getting errors such as this:
```
fatal: [localhost]: FAILED! => {"changed": false, "msg": "openstacksdk is required for this module"}
```
You will need to do the following:
1. Switch the dependency driver to `shell` inside Molecule, like this:
```yaml
dependency:
name: shell
command: "${MOLECULE_SCENARIO_DIRECTORY}/tools/install-dependencies"
```
2. Once you have that, create a file in your scenario inside a `tools` folder
and place whatever you need inside of it, such as:
```bash
#!/bin/sh
# Install OpenStack SDK
pip install \
--extra-index-url https://vexxhost.github.io/wheels/alpine-3.15/ \
'openstacksdk<0.99.0'
```
You will have to manually install any other dependencies that you were using
Galaxy for, but that should be trivial to add with a few
simple `ansible-galaxy` commands.
## Maintenance
> Make the new release available to those binding to the major version tag: Move the major version
> tag (v1, v2, etc.) to point to the ref of the current release. This will act as the stable release
> for that major version. You should keep this tag updated to the most recent stable minor/patch
> release.
```sh
git tag -fa v2 -m "Update v2 tag" && git push origin v2 --force
```
**Reference**:
https://github.com/actions/toolkit/blob/master/docs/action-versioning.md#recommendations
## License
The Dockerfile and associated scripts and documentation in this project are released under the [MIT](license).