- Run tests from Tox, use generated environments.

- Run tests in TravisCI on multiple Ansible, Python versions and OSes.
- Create Docker container with Ansible.
- Split tests to seperate files.
- Moved everything test related to tests/ .
- Update pre-commit hooks.
- Merge .flake8 to tox.ini.
- Added shellcheck hook.
- Fixed issues found by shellcheck.
- Updated README (added usage, testing sections).

.flake8

-[flake8]
-exclude = ldap/ldap_attr.py

.gitignore

@@ -3,3 +3,4 @@
 *~
 ~*
 *.pyc
+tests/roles

.pre-commit-config.yaml

 -   repo: git://github.com/pre-commit/pre-commit-hooks
-    sha: 97b88d9610bcc03982ddac33caba98bb2b751f5f
+    sha: v0.8.0
     hooks:
     -   id: check-added-large-files
     -   id: check-yaml
     -   id: check-merge-conflict
     -   id: flake8
 -   repo: https://github.com/adarnimrod/shell-pre-commit
-    sha: v0.1.0
+    sha: v0.5.4
     hooks:
     -   id: shell-lint
-        files: collectd/collectd_facts|nginx/nginx_facts|ssl/dhparams
+        files: &shellscripts collectd/collectd_facts|nginx/nginx_facts|ssl/dhparams
+    -   id: shellcheck
+        files: *shellscripts
 -   repo: https://github.com/adarnimrod/ansible-pre-commit.git
-    sha: v0.4.0
+    sha: v0.6.0
     hooks:
     -   id: ansible-syntax-check
+        files: &playbook tests/playbook.yaml
 -   repo: https://github.com/willthames/ansible-lint
-    sha: 959ab0f525e9abb19cf75f34381015cf33695f61
+    sha: v3.4.13
     hooks:
     -   id: ansible-lint
-        files: playbook.yml
+        files: *playbook

.travis.yml

 ---
 language: python
-python: "2.7"
+python:
+    - "2.7"
 dist: trusty
 sudo: false
-services: [docker]
+services:
+    - docker
+group: beta
 cache:
   - pip
   - directories:
       - $HOME/.pre-commit
 
 env:
-  - DOCKER=ubuntu:trusty
-  - DOCKER=ubuntu:xenial
-  - DOCKER=debian:jessie
+- TOXENV: pre-commit
+- TOXENV: ansible2.3.1.0-image_ubuntu_xenial
+- TOXENV: ansible2.3.1.0-image_ubuntu_trusty
+- TOXENV: ansible2.3.1.0-image_ubuntu_precise
+- TOXENV: ansible2.3.1.0-image_debian_stretch
+- TOXENV: ansible2.3.1.0-image_debian_jessie
+- TOXENV: ansible2.3.1.0-image_debian_wheezy
+- TOXENV: ansible2.2.3.0-image_ubuntu_xenial
+- TOXENV: ansible2.2.3.0-image_ubuntu_trusty
+- TOXENV: ansible2.2.3.0-image_ubuntu_precise
+- TOXENV: ansible2.2.3.0-image_debian_stretch
+- TOXENV: ansible2.2.3.0-image_debian_jessie
+- TOXENV: ansible2.2.3.0-image_debian_wheezy
+- TOXENV: ansible2.1.6.0-image_ubuntu_xenial
+- TOXENV: ansible2.1.6.0-image_ubuntu_trusty
+- TOXENV: ansible2.1.6.0-image_ubuntu_precise
+- TOXENV: ansible2.1.6.0-image_debian_stretch
+- TOXENV: ansible2.1.6.0-image_debian_jessie
+- TOXENV: ansible2.1.6.0-image_debian_wheezy
+- TOXENV: ansible2.0.2.0-image_ubuntu_xenial
+- TOXENV: ansible2.0.2.0-image_ubuntu_trusty
+- TOXENV: ansible2.0.2.0-image_ubuntu_precise
+- TOXENV: ansible2.0.2.0-image_debian_stretch
+- TOXENV: ansible2.0.2.0-image_debian_jessie
+- TOXENV: ansible2.0.2.0-image_debian_wheezy
 
 install:
-  - pip install pre_commit ansible | cat
-
-before_script:
-  - docker run --detach --name $(echo $DOCKER | sed 's/:/_/g') $DOCKER tail -f /.dockerenv
+  - pip install tox-travis | cat
 
 script:
-  - pre-commit run --all-files
-  - ansible-playbook -i $(echo $DOCKER | sed 's/:/_/g'), -c docker -vv playbook.yml
+  - tox
 
 notifications:
   email: false
+  on_failure: never

README.rst

@@ -35,6 +35,11 @@ Modules
 - nginx_facts
 - dhparams
 
+Usage
+-----
+
+See example usage in the test playbooks under :code:`tests/`.
+
 License
 -------
 
@@ -44,7 +49,12 @@ This software is licensed under the AGPL v3+ license (see the
 Testing
 -------
 
-Currently the only tests are `pre-commit <http://www.pre-commit.com/>`_ hooks.
+Modules are tested on Ubuntu Precise, Trusty and Xenial and Debian Wheezy,
+Jessie and Stretch with Ansible version 2.0.2.0, 2.1.6.0, 2.2.3.0 and 2.3.1.0
+in `TravisCI <https://travis-ci.org/adarnimrod/ansible-modules>`_. To tests
+require `Tox <https://tox.readthedocs.io/>`_ and `Docker
+<https://docker.com>`_. `Pre-commit <http://pre-commit.com/>`_ is also setup
+for this project.
 
 Author
 ------

collectd/collectd_facts

 #!/bin/sh -e
+# shellcheck disable=SC1090
 . "$1"
 
 fail ()
@@ -7,6 +8,6 @@ fail ()
     exit
 }
 
-which collectd 2>&1 > /dev/null || fail "Can't find collectd executable."
+which collectd > /dev/null 2>&1 || fail "Can't find collectd executable."
 
 collectd -h 2>&1 | sed -n 's/[a-zA-Z ]*\([0-9]*\)\.\([0-9]*\)\.\([0-9]*\).*/{"changed": false, "ansible_facts": {"collectd": {"major":\1, "minor":\2, "patch":\3, "version":"\1.\2.\3"}}}/p'

nginx/nginx_facts

 #!/bin/sh -e
+# shellcheck disable=SC1090
 . "$1"
 
 fail ()
@@ -7,6 +8,6 @@ fail ()
     exit
 }
 
-which nginx 2>&1 > /dev/null || fail "Can't find nginx executable."
+which nginx > /dev/null 2>&1 || fail "Can't find nginx executable."
 
 nginx -v 2>&1 | sed -n 's/[a-zA-Z :\/]*\([0-9]*\)\.\([0-9]*\)\.\([0-9]\)*.*$/{"changed": false, "ansible_facts": {"nginx": {"major":\1, "minor":\2, "patch":\3, "version":"\1.\2.\3"}}}/gp'

playbook.yml

----
-- hosts: all
-  gather_facts: False
-  tasks:
-  - name: Update APT sources
-    raw: DEBIAN_FRONTEND=noninteractive apt-get update
-    changed_when: False
-
-  - name: APT install Python
-    raw: DEBIAN_FRONTEND=noninteractive apt-get install -qy python2.7 python
-    register: debian_bootstrap_install_python
-    changed_when: "'Unpacking' in debian_bootstrap_install_python.stdout"
-
-  - name: Gather facts
-    setup:
-
-  - name: APT install
-    apt:
-      name: ['nginx-light', 'collectd-core', 'openssl']
-      state: present
-      install_recommends: no
-
-  - name: Collectd facts
-    collectd_facts:
-    register: collectd_facts
-
-  - name: Debug
-    debug:
-      var: collectd_facts
-      verbosity: 2
-
-  - name: Assertions
-    assert:
-      that:
-      - collectd_facts|changed == False
-      - collectd.major is number
-      - collectd.minor is number
-      - collectd.patch is number
-      - collectd.version is defined
-
-  - name: Nginx facts
-    nginx_facts:
-    register: nginx_facts
-
-  - name: Debug
-    debug:
-      var: nginx_facts
-      verbosity: 2
-
-  - name: Assertions
-    assert:
-      that:
-      - nginx_facts|changed == False
-      - nginx.major is number
-      - nginx.minor is number
-      - nginx.patch is number
-      - nginx.version is defined
-
-  - name: DH params for missing file
-    ignore_errors: True
-    dhparams:
-      path: /etc/ssl/dhparams.pem
-    register: missing_dhparams
-
-  - name: Debug
-    debug:
-      var: missing_dhparams
-      verbosity: 2
-
-  - name: Assertions
-    assert:
-      that:
-      - missing_dhparams.bits == 0
-      - missing_dhparams|failed == True
-      - missing_dhparams|changed == False
-
-  - name: Generate DH params
-    command: openssl dhparam -out /etc/ssl/dhparams.pem 2048
-    changed_when: True
-
-  - name: DH params for existing file
-    dhparams:
-      path: /etc/ssl/dhparams.pem
-    register: existing_dhparams
-
-  - name: Debug
-    debug:
-      var: existing_dhparams
-      verbosity: 2
-
-  - name: Assertions
-    assert:
-      that:
-      - existing_dhparams.bits == 2048
-      - existing_dhparams|failed == False
-      - existing_dhparams|changed == False
-      - existing_dhparams.path == '/etc/ssl/dhparams.pem'

ssl/dhparams

 #!/bin/sh -e
+# shellcheck disable=SC1090
 . "$1"
 
 fail ()
@@ -7,11 +8,12 @@ fail ()
     exit
 }
 
+# shellcheck disable=SC2154
 test -z "$path" && fail "Parameter 'path' is not set."
 test ! -r "$path" && fail "Can't access 'path'."
 test ! -f "$path" && fail "Parameter 'path' doesn't exists or is not a file."
 
-bits="$(openssl dhparam -in $path -text -noout \
+bits="$(openssl dhparam -in "$path" -text -noout \
     | sed -n 's/[a-zA-Z#0-9 \-]*Parameters: (\([0-9]*\) bit)/\1/p')"
 
 echo "{ \"changed\": false, \"path\": \"$path\", \"bits\": $bits }"

ansible.cfg → tests/ansible.cfg

 [defaults]
-library = ./
+library = ../
 host_key_checking = False
+roles_path = ./roles/
+callback_whitelist = profile_tasks

tests/collectd.yml

+---
+- name: APT install
+  apt:
+    name: collectd-core
+    state: latest
+    install_recommends: no
+
+- name: Collectd facts
+  collectd_facts:
+  register: collectd_facts
+
+- name: Debug
+  debug:
+    var: collectd_facts
+
+- name: Assertions
+  assert:
+    that:
+    - collectd_facts|changed == False
+    - collectd.major is number
+    - collectd.minor is number
+    - collectd.patch is number
+    - collectd.version is defined

tests/nginx.yml

+---
+- name: APT install
+  apt:
+    name: nginx-light
+    state: latest
+    install_recommends: no
+
+- name: Nginx facts
+  nginx_facts:
+  register: nginx_facts
+
+- name: Debug
+  debug:
+    var: nginx_facts
+
+- name: Assertions
+  assert:
+    that:
+    - nginx_facts|changed == False
+    - nginx.major is number
+    - nginx.minor is number
+    - nginx.patch is number
+    - nginx.version is defined

tests/playbook.yaml

+---
+- hosts: localhost
+  connection: local
+  gather_facts: False
+  become: False
+  tasks:
+      - name: Assertion
+        assert:
+            that:
+                - distro is defined
+                - release is defined
+
+      - name: Remove existing Docker container
+        # Use the command module instead of docker/ docker-container for
+        # consistency across different versions of Ansible.
+        command: 'docker rm -f ansible_modules_{{ distro }}_{{ release }}'
+        register: docker_rm
+        failed_when: "docker_rm|failed and 'no such container' not in docker_rm.stderr|lower"
+        changed_when: "'no such container' not in docker_rm.stderr|lower"
+
+      - name: Create Docker container
+        # Use the command module instead of docker/ docker-container for
+        # consistency across different versions of Ansible.
+        command: 'docker run --detach --name ansible_modules_{{ distro }}_{{ release }} {{ distro }}:{{ release }} tail -f /.dockerenv'
+        changed_when: True
+
+      - name: Add Docker container to inventory
+        add_host:
+            name: 'ansible_modules_{{ distro }}_{{ release }}'
+            ansible_connection: docker
+            ansible_user: root
+            groups: containers
+
+- hosts: containers
+  gather_facts: False
+  roles:
+      - name: debian-bootstrap
+  post_tasks:
+  - name: Include test tasks
+    with_fileglob: '{{ playbook_dir }}/*.yml'
+    include: '{{ item }}'
+
+- hosts: localhost
+  connection: local
+  become: False
+  gather_facts: False
+  tasks:
+      - name: Remove existing Docker container
+        # Use the command module instead of docker/ docker-container for
+        # consistency across different versions of Ansible.
+        command: 'docker rm -f ansible_modules_{{ distro }}_{{ release }}'
+        register: docker_rm
+        failed_when: "docker_rm|failed and 'no such container' not in docker_rm.stderr|lower"
+        changed_when: "'no such container' not in docker_rm.stderr|lower"

tests/requirements.yaml

+---
+- src: adarnimrod.debian-bootstrap
+  name: debian-bootstrap

tests/ssl.yml

+---
+- name: APT install
+  apt:
+    name: openssl
+    state: latest
+    install_recommends: no
+
+- name: DH params for missing file
+  ignore_errors: True
+  dhparams:
+    path: /etc/ssl/dhparams.pem
+  register: missing_dhparams
+
+- name: Debug
+  debug:
+    var: missing_dhparams
+
+- name: Assertions
+  assert:
+    that:
+    - missing_dhparams.bits == 0
+    - missing_dhparams|failed == True
+    - missing_dhparams|changed == False
+
+- name: Generate DH params
+  command: openssl dhparam -out /etc/ssl/dhparams.pem 2048
+  changed_when: True
+
+- name: DH params for existing file
+  dhparams:
+    path: /etc/ssl/dhparams.pem
+  register: existing_dhparams
+
+- name: Debug
+  debug:
+    var: existing_dhparams
+
+- name: Assertions
+  assert:
+    that:
+    - existing_dhparams.bits == 2048
+    - existing_dhparams|failed == False
+    - existing_dhparams|changed == False
+    - existing_dhparams.path == '/etc/ssl/dhparams.pem'

tox.ini

+[tox]
+skip_install = True
+skipsdist = True
+envlist = ansible{2.3.1.0,2.2.3.0,2.1.6.0,2.0.2.0}-image_{ubuntu_xenial,ubuntu_trusty,ubuntu_precise,debian_stretch,debian_jessie,debian_wheezy}, pre-commit
+
+[testenv]
+basepython = python2.7
+deps =
+    ansible2.3.1.0: ansible==2.3.1.0
+    ansible2.2.3.0: ansible==2.2.3.0
+    ansible2.1.6.0: ansible==2.1.6.0
+    ansible2.0.2.0: ansible==2.0.2.0
+    docker-py>=1.7.0
+passenv = TERM HOME VBOX* ANSIBLE_*
+setenv =
+    ANSIBLE_VERBOSITY=2
+changedir = {toxinidir}/tests/
+commands =
+    ansible-galaxy install -r requirements.yaml
+    image_ubuntu_xenial:  ansible-playbook playbook.yaml -e "distro=ubuntu release=xenial"  -i localhost, {posargs}
+    image_ubuntu_trusty:  ansible-playbook playbook.yaml -e "distro=ubuntu release=trusty"  -i localhost, {posargs}
+    image_ubuntu_precise: ansible-playbook playbook.yaml -e "distro=ubuntu release=precise" -i localhost, {posargs}
+    image_debian_stretch: ansible-playbook playbook.yaml -e "distro=debian release=stretch" -i localhost, {posargs}
+    image_debian_jessie:  ansible-playbook playbook.yaml -e "distro=debian release=jessie"  -i localhost, {posargs}
+    image_debian_wheezy:  ansible-playbook playbook.yaml -e "distro=debian release=wheezy"  -i localhost, {posargs}
+
+[testenv:pre-commit]
+deps =
+    pre-commit
+    ansible
+passenv = TERM HOME VBOX* ANSIBLE_*
+setenv =
+    ANSIBLE_ROLES_PATH={toxinidir}/tests/roles
+changedir = {toxinidir}/
+commands =
+    ansible-galaxy install -r tests/requirements.yaml
+    pre-commit run --all-files
+
+[flake8]
+exclude = ldap/ldap_attr.py