contrib.md

Contributing guide

External software

Please read the tools documentations and the associated best practices.

• Ansible documentation
• Molecule documentation
• TestInfra documentation

Developpement environment

Install all required tools and then execute:

cd /root/envsetup
make requirements-dev

Then install docker (it is used to deploy components in container).

Test

To check that your "code" is compliant:

make lint

To run Ansible tests:

# run default test
make test

# show debug logs
DEBUG=1 make test

# do not destroy tests containers
KEEP=1 make test

If you add/modify a role, please write relevants tests in molecule/default/tests.