Newer
Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
# Contributing guide
## External software
Please read the tools documentations and the associated best practices.
- [Ansible documentation](https://docs.ansible.com/ansible/latest/)
- [Molecule documentation](https://molecule.readthedocs.io/en/latest/)
- [TestInfra documentation](https://testinfra.readthedocs.io/en/latest/)
## Developpement environment
Install all [required tools](requirements.md) and then execute:
```sh
cd /root/envsetup
make requirements-dev
```
Then install [docker](https://docs.docker.com/engine/install/debian/) (it is used to deploy components in container).
## Test
To check that your "code" is compliant:
```sh
make lint
```
To run Ansible tests:
```sh
# 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`.