diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index d3016f7593bb9f6586c37e14838d741a23349191..83a18d25e58ca7adc2e526f0ed30b12263cb0c13 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -6,17 +6,30 @@ - id: check-xml - id: check-yaml - id: check-merge-conflict + - id: flake8 + - id: check-symlinks - repo: https://www.shore.co.il/git/ansible-pre-commit - sha: v0.4.0 + sha: 0fadd691465b97db8992cfc66650f630e433324b hooks: - id: ansible-syntax-check always_run: true files: tests/playbook.yml - args: ['tests/playbook.yml'] + args: + - tests/playbook.yml - repo: https://github.com/willthames/ansible-lint - sha: v3.4.4 + sha: 959ab0f525e9abb19cf75f34381015cf33695f61 hooks: - id: ansible-lint always_run: true files: tests/playbook.yml - args: ['tests/playbook.yml'] + args: + - tests/playbook.yml +- repo: local + hooks: + - id: piprot + name: piprot + description: Check up-to-date Python requirements + language: system + entry: piprot --quiet --outdated tests/requirements.txt + files: requirements.txt + always_run: true diff --git a/README.rst b/README.rst index 8c4c9b2b29bb832a0034e3101e3a76de64c33035..ea351094e16c002852f3510205655525288837d3 100644 --- a/README.rst +++ b/README.rst @@ -23,7 +23,38 @@ your :code:`pf.conf`. Requirements ------------ -See :code:`meta/main.yml` and assertions at top of :code:`tasks/main.yml`. +See :code:`meta/main.yml`, :code:`requirements.yml` and assertions at top of +:code:`tasks/main.yml`. + +Adding the role as a dependency +------------------------------- + +Add the following to your :code:`meta/main.yml`: + +.. code:: yaml + + dependencies: + - src: https://www.shore.co.il/git/ansible-role-example + scm: git + name: example + +When :code: `ansible-galaxy` downloads your role it will also download its +dependencies, ensuring this role will be present and run everytime your role +runs. + +Adding the role to your playbooks +--------------------------------- + +Add the following to your :code:`requirements.yml`: + +.. code:: yaml + + - src: https://www.shore.co.il/git/ansible-role-example + scm: git + name: example + +and update your roles by running :code: `ansible-galaxy install -r +requirements.yml`. Role Variables -------------- @@ -43,17 +74,21 @@ See :code:`tests/playbook.yml`. Testing ------- -To install the dependencies: +Testing requires Virtualbox and Vagrant (out of scope for this documentation). +Install the Python dependencies, add pre-commit hooks by running: .. code:: shell - ansible-galaxy install git+file://$(pwd),$(git rev-parse --abbrev-ref HEAD) -p .molecule/roles + pip install -r tests/requirements.txt + pre-commit install To run the full test suite: .. code:: shell - molecule test + ansible-galaxy install git+file://$(pwd),$(git rev-parse --abbrev-ref HEAD) -p .molecule/roles + pre-commit run --all-files + molecule test --platform all License ------- diff --git a/ansible.cfg b/ansible.cfg index 10b3da5cfa1edbc2186229872bd129f0e34222c8..2bc7613f4df5ddc0fe0f2719df832ddfff4bfe62 100644 --- a/ansible.cfg +++ b/ansible.cfg @@ -1,6 +1,10 @@ [defaults] +library = library host_key_checking = False retry_files_enabled = False -roles_path = roles:../:../../:.molecule/roles +roles_path = .molecule/roles:.molecule/../roles:../:../../ command_warnings = True deprecation_warnings = True + +[ssh_connection] +pipelining = True diff --git a/molecule.yml b/molecule.yml index aeaba9448ec5896c060040e1a2477302f6a38c6c..e98775a270e7ea8498149662ae3e2c06ab1f1477 100644 --- a/molecule.yml +++ b/molecule.yml @@ -1,12 +1,10 @@ --- ansible: - verbose: v + verbose: vv playbook: tests/playbook.yml diff: True - -molecule: - testinfra_dir: tests - ansible_config_template: ansible.cfg + config_file: ../ansible.cfg + requirements_file: tests/requirements.yml vagrant: providers: diff --git a/tests/playbook.yml b/tests/playbook.yml index e81d9eb38eb68739fa661e9e2e7df989a0478bc7..62d08274f7267cb35226879da106124a7dfa9037 100644 --- a/tests/playbook.yml +++ b/tests/playbook.yml @@ -1,15 +1,15 @@ --- -- hosts: all +- hosts: ansible-role-bgp-spamd-openbsd gather_facts: false - roles: [ansible-role-openbsd-bootstrap] + roles: [openbsd_bootstrap] - hosts: all - vars: - spamd_alloweddomains: ["{{ ansible_domain }}"] pre_tasks: - name: Include pf.conf.bgp-spamd lineinfile: line: include "/etc/pf.conf.bgp-spamd" dest: /etc/pf.conf state: present - roles: [ansible-role-bgp-spamd] + roles: + - role: ansible-role-bgp-spamd + spamd_alloweddomains: ["{{ ansible_domain }}"] diff --git a/tests/requirements.txt b/tests/requirements.txt new file mode 100644 index 0000000000000000000000000000000000000000..0588c359a06c17f6d8a27f8d19be6cf89b2758b8 --- /dev/null +++ b/tests/requirements.txt @@ -0,0 +1,6 @@ +ansible==2.2.0.0 +testinfra==1.4.3 +molecule==1.13.0 +ansible-lint==3.4.4 +pre-commit==0.9.3 +piprot==0.9.7 diff --git a/tests/requirements.yml b/tests/requirements.yml new file mode 100644 index 0000000000000000000000000000000000000000..a23176d30fc46ed95cc733d4d0b898345206f2fa --- /dev/null +++ b/tests/requirements.yml @@ -0,0 +1,4 @@ +--- +- src: https://www.shore.co.il/git/ansible-role-openbsd-bootstrap + scm: git + name: openbsd_bootstrap