From 41f9315a49faf851e3175c6b661c2778442cb5eb Mon Sep 17 00:00:00 2001 From: Jeff Geerling Date: Wed, 26 Sep 2018 22:13:32 -0500 Subject: [PATCH] Switch tests to use Molecule. --- .gitignore | 3 +- .travis.yml | 40 ++++++++++--------- defaults/main.yml | 6 +-- meta/main.yml | 31 +++++++------- molecule/default/molecule.yml | 27 +++++++++++++ .../test.yml => molecule/default/playbook.yml | 9 ++--- molecule/default/tests/test_default.py | 14 +++++++ molecule/default/yaml-lint.yml | 6 +++ tasks/docker-users.yml | 2 +- tasks/setup-Debian.yml | 4 +- tests/README.md | 11 ----- 11 files changed, 97 insertions(+), 56 deletions(-) create mode 100644 molecule/default/molecule.yml rename tests/test.yml => molecule/default/playbook.yml (56%) create mode 100644 molecule/default/tests/test_default.py create mode 100644 molecule/default/yaml-lint.yml delete mode 100644 tests/README.md diff --git a/.gitignore b/.gitignore index c9b2377..f56f5b5 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ *.retry -tests/test.sh +*/__pycache__ +*.pyc diff --git a/.travis.yml b/.travis.yml index 07a44c9..adca0ce 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,28 +1,32 @@ --- +language: python services: docker env: - - distro: centos7 - - distro: ubuntu1804 - - distro: ubuntu1604 - - distro: ubuntu1404 - - distro: debian9 - - distro: fedora27 + global: + - ROLE_NAME: docker + matrix: + - MOLECULE_DISTRO: centos7 + MOLECULE_DOCKER_COMMAND: /usr/lib/systemd/systemd + - MOLECULE_DISTRO: ubuntu1804 + - MOLECULE_DISTRO: ubuntu1604 + - MOLECULE_DISTRO: ubuntu1404 + - MOLECULE_DISTRO: debian9 + - MOLECULE_DISTRO: fedora27 + +install: + # Install test dependencies. + - pip install molecule docker + +before_script: + # Use actual Ansible Galaxy role name for the project directory. + - cd ../ + - mv ansible-role-$ROLE_NAME geerlingguy.$ROLE_NAME + - cd geerlingguy.$ROLE_NAME script: - # Configure test script so we can run extra tests after playbook is run. - - export container_id=$(date +%s) - - export cleanup=false - - # Download test shim. - - wget -O ${PWD}/tests/test.sh https://gist.githubusercontent.com/geerlingguy/73ef1e5ee45d8694570f334be385e181/raw/ - - chmod +x ${PWD}/tests/test.sh - # Run tests. - - ${PWD}/tests/test.sh - - # Test whether Docker is running correctly (Dockerception!). - - docker exec --tty ${container_id} docker run hello-world + - molecule test notifications: webhooks: https://galaxy.ansible.com/api/v1/notifications/ diff --git a/defaults/main.yml b/defaults/main.yml index c12e9e9..2bcb620 100644 --- a/defaults/main.yml +++ b/defaults/main.yml @@ -6,11 +6,11 @@ docker_package_state: present # Service options. docker_service_state: started -docker_service_enabled: yes +docker_service_enabled: true docker_restart_handler_state: restarted # Docker Compose options. -docker_install_compose: True +docker_install_compose: true docker_compose_version: "1.22.0" docker_compose_path: /usr/local/bin/docker-compose @@ -18,7 +18,7 @@ docker_compose_path: /usr/local/bin/docker-compose docker_apt_release_channel: stable docker_apt_arch: amd64 docker_apt_repository: "deb [arch={{ docker_apt_arch }}] https://download.docker.com/linux/{{ ansible_distribution|lower }} {{ ansible_distribution_release }} {{ docker_apt_release_channel }}" -docker_apt_ignore_key_error: True +docker_apt_ignore_key_error: true # Used only for RedHat/CentOS/Fedora. docker_yum_repo_url: https://download.docker.com/linux/{{ (ansible_distribution == "Fedora") | ternary("fedora","centos") }}/docker-{{ docker_edition }}.repo diff --git a/meta/main.yml b/meta/main.yml index 939d881..0dfa4cd 100644 --- a/meta/main.yml +++ b/meta/main.yml @@ -8,21 +8,22 @@ galaxy_info: license: "license (BSD, MIT)" min_ansible_version: 2.4 platforms: - - name: EL - versions: - - 6 - - 7 - - name: Fedora - versions: - - all - - name: Debian - versions: - - jessie - - name: Ubuntu - versions: - - trusty - - xenial - - bionic + - name: EL + versions: + - 6 + - 7 + - name: Fedora + versions: + - all + - name: Debian + versions: + - jessie + - stretch + - name: Ubuntu + versions: + - trusty + - xenial + - bionic galaxy_tags: - web - system diff --git a/molecule/default/molecule.yml b/molecule/default/molecule.yml new file mode 100644 index 0000000..0339702 --- /dev/null +++ b/molecule/default/molecule.yml @@ -0,0 +1,27 @@ +--- +dependency: + name: galaxy +driver: + name: docker +lint: + name: yamllint + options: + config-file: molecule/default/yaml-lint.yml +platforms: + - name: instance + image: geerlingguy/docker-${MOLECULE_DISTRO:-centos7}-ansible + command: ${MOLECULE_DOCKER_COMMAND:-"sleep infinity"} + privileged: true + pre_build_image: true +provisioner: + name: ansible + lint: + name: ansible-lint + playbooks: + converge: ${MOLECULE_PLAYBOOK:-playbook.yml} +scenario: + name: default +verifier: + name: testinfra + lint: + name: flake8 diff --git a/tests/test.yml b/molecule/default/playbook.yml similarity index 56% rename from tests/test.yml rename to molecule/default/playbook.yml index cdbbb3f..dad331d 100644 --- a/tests/test.yml +++ b/molecule/default/playbook.yml @@ -1,13 +1,12 @@ --- -- hosts: all +- name: Converge + hosts: all + become: true pre_tasks: - name: Update apt cache. apt: update_cache=yes cache_valid_time=600 when: ansible_os_family == 'Debian' - - name: Install test dependencies. - package: name=curl state=present - roles: - - role_under_test + - role: geerlingguy.docker diff --git a/molecule/default/tests/test_default.py b/molecule/default/tests/test_default.py new file mode 100644 index 0000000..eedd64a --- /dev/null +++ b/molecule/default/tests/test_default.py @@ -0,0 +1,14 @@ +import os + +import testinfra.utils.ansible_runner + +testinfra_hosts = testinfra.utils.ansible_runner.AnsibleRunner( + os.environ['MOLECULE_INVENTORY_FILE']).get_hosts('all') + + +def test_hosts_file(host): + f = host.file('/etc/hosts') + + assert f.exists + assert f.user == 'root' + assert f.group == 'root' diff --git a/molecule/default/yaml-lint.yml b/molecule/default/yaml-lint.yml new file mode 100644 index 0000000..7aeec5a --- /dev/null +++ b/molecule/default/yaml-lint.yml @@ -0,0 +1,6 @@ +--- +extends: default +rules: + line-length: + max: 200 + level: warning diff --git a/tasks/docker-users.yml b/tasks/docker-users.yml index afebd9a..b3b6e0f 100644 --- a/tasks/docker-users.yml +++ b/tasks/docker-users.yml @@ -3,5 +3,5 @@ user: name: "{{ item }}" groups: docker - append: yes + append: true with_items: "{{ docker_users }}" diff --git a/tasks/setup-Debian.yml b/tasks/setup-Debian.yml index 312de84..914797e 100644 --- a/tasks/setup-Debian.yml +++ b/tasks/setup-Debian.yml @@ -29,11 +29,11 @@ - name: Add Docker apt key (alternative for older systems without SNI). shell: "curl -sSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -" args: - warn: no + warn: false when: add_repository_key is failed - name: Add Docker repository. apt_repository: repo: "{{ docker_apt_repository }}" state: present - update_cache: yes + update_cache: true diff --git a/tests/README.md b/tests/README.md deleted file mode 100644 index 6fb2117..0000000 --- a/tests/README.md +++ /dev/null @@ -1,11 +0,0 @@ -# Ansible Role tests - -To run the test playbook(s) in this directory: - - 1. Install and start Docker. - 1. Download the test shim (see .travis.yml file for the URL) into `tests/test.sh`: - - `wget -O tests/test.sh https://gist.githubusercontent.com/geerlingguy/73ef1e5ee45d8694570f334be385e181/raw/` - 1. Make the test shim executable: `chmod +x tests/test.sh`. - 1. Run (from the role root directory) `distro=[distro] playbook=[playbook] ./tests/test.sh` - -If you don't want the container to be automatically deleted after the test playbook is run, add the following environment variables: `cleanup=false container_id=$(date +%s)`