Merge pull request #17 from paulfantom/molecule2

[minor] molecule 2.x tests and support for ubuntu bionic and debian stretch

Author: paulfantom

.gitlab-ci.yml

@@ -4,17 +4,17 @@ cache: pip
 services:
   - docker
 env:
-  - ANSIBLE=2.2.3
-  - ANSIBLE=2.3.2
-  - ANSIBLE=2.4.2
+  - ANSIBLE='ansible>=2.3.0,<2.4.0'
+  - ANSIBLE='ansible>=2.4.0,<2.5.0'
+  - ANSIBLE='ansible>=2.5.0,<2.6.0'
 install:
-  - pip install ansible==${ANSIBLE} ansible-lint>=3.4.15 molecule==1.25.0 docker git-semver testinfra>=1.7.0
+  - pip install ${ANSIBLE} 'ansible-lint>=3.4.15' 'molecule>=2.13.0' docker git-semver 'testinfra>=1.7.0'
 script:
   - molecule test
 deploy:
   provider: script
   skip_cleanup: true
-  script: ./.travis/generatetag.sh
+  script: ./.travis/releaser.sh
   on:
     branch: master
 branches:

.travis.yml

@@ -0,0 +1,71 @@
+#!/bin/bash
+#
+# Copyright (C) 2018 Pawel Krupa (@paulfantom) - All Rights Reserved
+# Permission to copy and modify is granted under the MIT license
+#
+# Script to automatically do a couple of things:
+#   - generate a new tag according to semver (https://semver.org/)
+#   - generate CHANGELOG.md by using https://github.com/skywinder/github-changelog-generator
+#   - sync CHANGELOG with GitHub releases by using https://github.com/mattbrictson/chandler
+#
+# Tags are generated by searching for a keyword in last commit message. Keywords are:
+#  - [patch] or [fix] to bump patch number
+#  - [minor], [feature] or [feat] to bump minor number
+#  - [major] or [breaking change] to bump major number
+# All keywords MUST be surrounded with square braces.
+#
+# Script uses git mechanisms for locking, so it can be used in parallel builds
+#
+# Requirements:
+#   - GH_TOKEN variable set with GitHub token. Access level: repo.public_repo
+#   - docker
+#   - git-semver python package (pip install git-semver)
+
+# Exit when latest commit is tagged
+[[ $(git tag --points-at) ]] && exit 0
+
+# Some basic variables
+GIT_MAIL="paulfantom@gmail.com"
+GIT_USER="paulfantom"
+ORGANIZATION=$(echo "$TRAVIS_REPO_SLUG" | awk -F '/' '{print $1}')
+PROJECT=$(echo "$TRAVIS_REPO_SLUG" | awk -F '/' '{print $2}')
+GALAXY_URL="https://galaxy.ansible.com/${ORGANIZATION}/${PROJECT#ansible-}"
+
+# Git config
+git config --global user.email "${GIT_MAIL}"
+git config --global user.name "${GIT_USER}"
+GIT_URL=$(git config --get remote.origin.url)
+GIT_URL=${GIT_URL#*//}
+
+# Generate TAG
+GIT_TAG=none
+echo "Last commit message: $TRAVIS_COMMIT_MESSAGE"
+case "${TRAVIS_COMMIT_MESSAGE}" in
+  *"[patch]"*|*"[fix]"* )                GIT_TAG=$(git semver --next-patch) ;;
+  *"[minor]"*|*"[feat]"*|*"[feature]"* ) GIT_TAG=$(git semver --next-minor) ;;
+  *"[major]"*|*"[breaking change]"* )    GIT_TAG=$(git semver --next-major) ;;
+  *) echo "Keyword not detected. Doing nothing" ;;
+esac
+if [ "$GIT_TAG" != "none" ]; then
+    echo "Assigning new tag: $GIT_TAG"
+    git tag "$GIT_TAG" -a -m "Automatic tag generation for travis build no. $TRAVIS_BUILD_NUMBER"
+    git push "https://${GH_TOKEN}:@${GIT_URL}" --tags || exit 0
+fi
+
+# Generate CHANGELOG.md
+git checkout master
+git pull
+docker run -it --rm -v "$(pwd)":/usr/local/src/your-app ferrarimarco/github-changelog-generator \
+               -u "${ORGANIZATION}" -p "${PROJECT}" --token "${GH_TOKEN}" \
+               --release-url "${GALAXY_URL}" \
+               --unreleased-label "**Next release**" --no-compare-link
+
+git add CHANGELOG.md
+git commit -m '[ci skip] Automatic changelog update'
+
+git push "https://${GH_TOKEN}:@${GIT_URL}" || exit 0
+
+# Sync changelog to github releases
+if [ "$GIT_TAG" != "none" ]; then
+    docker run -e CHANDLER_GITHUB_API_TOKEN="${GH_TOKEN}" -v "$(pwd)":/chandler -ti whizark/chandler push "${GIT_TAG}"
+fi

.travis/generatetag.sh

@@ -0,0 +1,14 @@
+extends: default
+ignore: |
+  .travis/
+  .travis.yml
+  meta/
+
+rules:
+  braces:
+    max-spaces-inside: 1
+    level: error
+  brackets:
+    max-spaces-inside: 1
+    level: error
+  line-length: disable

.travis/releaser.sh

@@ -1,12 +1,16 @@
 # Contributor Guideline
 
-This document provides an overview of how you can participate in improving this project or extending it. We are grateful for all your help: bug reports and fixes, code contributions, documentation or ideas. Feel free to join, I appreciate your support!!
+This document provides an overview of how you can participate in improving this project or extending it. We are grateful for all your help: bug reports and fixes, code contributions, documentation or ideas. Feel free to join, we appreciate your support!!
 
 ## Communication
 
+### IRC
+
+You can talk with us on #cloudalchemy channel on freenode.
+
 ### GitHub repositories
 
-Much of the issues, goals and ideas are tracked in the respective projects in GitHub. Please use this channel to report bugs and post ideas.
+Much of the issues, goals and ideas are tracked in the respective projects in GitHub. Please use this channel to report bugs.
 
 ## git and GitHub
 
@@ -28,7 +32,15 @@ Some great guidelines can be found [here](https://wiki.openstack.org/wiki/GitCom
 
 ## Releases
 
-Generally I try to stick to semantic versioning, where every accepted PR is treated as patch or minor feature and version is released accordingly by CI pipeline.
+We try to stick to semantic versioning and our releases are made by CI pipeline. It is done by assigning a keyword (in a way similar to travis [`[ci skip]`](https://docs.travis-ci.com/user/customizing-the-build#Skipping-a-build)) to a commit with merge request. Available keywords are (square brackets are important!):
+ 
+* `[patch]`, `[fix]` - for PATCH version release
+* `[minor]`, `[feature]`, `[feat]` - for MINOR version release
+* `[major]`, `[breaking change]` - for MAJOR version release
+ 
+## Changelog
+ 
+Changelog is generateg automatically on every merged Pull Request and all information is taken from github issues, PRs and labels.
 
 ## Expectations
 
@@ -45,13 +57,16 @@ We try to provide production ready ansible roles which should be as much zero-co
 
 ### Add tests
 
-We try to have as much tests written in testinfra framework as possible, so when you copy file, some template or starting some server just add couple of lines in [/tests/test)default.py](test_default.py) file. If you want to know how to write tests in testinfra, go to their [docs](http://testinfra.readthedocs.io/en/latest/index.html).
+Currently we are using two test scenarios located in [/molecule](molecule) directory. First ([default](molecule/default/molecule.yml)) one is testing default configuration without any additional variables, second one ([alternative](molecule/alternative/molecule.yml)) is testing what happens when many variables from [/defaults/main.yml](defaults/main.yml) are changed. When adding new functionalities please add tests to proper scenarios. Tests are written in testinfra framework and are located in `/tests` subdirectory of scenario directory (for example default tests are in [/molecule/default/tests](molecule/default/tests)).
+More information about:
+  - [testinfra](http://testinfra.readthedocs.io/en/latest/index.html)
+  - [molecule](https://molecule.readthedocs.io/en/latest/index.html)
 
 ### Follow best practices
 
 Please follow [ansible best practices](http://docs.ansible.com/ansible/latest/playbooks_best_practices.html) and especially provide meaningful names to tasks and even comments where needed.
 
-Our test framework automatically lints code with [`ansible-lint`](https://github.com/willthames/ansible-lint) command so be sure to follow it's rules.
+Our test framework automatically lints code with [`yamllint`](https://yamllint.readthedocs.io) and [`ansible-lint`](https://github.com/willthames/ansible-lint) programs so be sure to follow their rules.
 
 Remember: Code is generally read much more often than written.
 

.yamllint

@@ -46,17 +46,21 @@ Use it in a playbook as follows:
 
 ## Local Testing
 
-The preferred way of locally testing the role is to use Docker and [molecule](https://github.com/metacloud/molecule) (v1.25). You will have to install Docker on your system. See Get started for a Docker package suitable to for your system.
+The preferred way of locally testing the role is to use Docker and [molecule](https://github.com/metacloud/molecule) (v2.x). You will have to install Docker on your system. See Get started for a Docker package suitable to for your system.
 All packages you need to can be specified in one line:
 ```sh
-pip install ansible ansible-lint>=3.4.15 molecule==1.25.0 docker testinfra>=1.7.0
+pip install ansible 'ansible-lint>=3.4.15' 'molecule>2.13.0' docker 'testinfra>=1.7.0' jmespath
 ```
-This should be similiar to one listed in `.travis.yml` file in `install` section. 
+This should be similar to one listed in `.travis.yml` file in `install` section.
 After installing test suit you can run test by running
 ```sh
-molecule test
+molecule test --all
 ```
-For more information about molecule go to their [docs](http://molecule.readthedocs.io/en/stable-1.25/).
+For more information about molecule go to their [docs](http://molecule.readthedocs.io/en/latest/).
+
+## Travis CI
+
+Combining molecule and travis CI allows to test how new PRs will behave when used with multiple ansible versions and multiple operating systems. This also allows to create test scenarios for different role configurations. As a result test matrix is quite large and takes more time than local testing, so please be patient.
 
 ## Contributing
 

CONTRIBUTING.md

@@ -1,18 +1,20 @@
 ---
 galaxy_info:
-  author: Pawel Krupa (paulfantom), donat-b
+  author: donat-b, Pawel Krupa (paulfantom)
   description: Fast, secure, efficient backup program
   license: MIT
   min_ansible_version: 2.2
   platforms:
   - name: Ubuntu
     versions:
+    - bionic
     - xenial
   - name: EL
     versions:
     - 7
   - name: Debian
     versions:
+    - stretch
     - jessie
   galaxy_tags:
     - system

README.md

@@ -0,0 +1,37 @@
+---
+- name: Create
+  hosts: localhost
+  connection: local
+  gather_facts: false
+  no_log: "{{ not lookup('env', 'MOLECULE_DEBUG') | bool }}"
+  tasks:
+    - name: Create molecule instance(s)
+      docker_container:
+        name: "{{ item.name }}"
+        docker_host: "{{ item.docker_host | default('unix://var/run/docker.sock') }}"
+        hostname: "{{ item.name }}"
+        image: "{{ item.image }}"
+        state: started
+        recreate: false
+        log_driver: json-file
+        command: "{{ item.command | default(omit) }}"
+        privileged: "{{ item.privileged | default(omit) }}"
+        volumes: "{{ item.volumes | default(omit) }}"
+        capabilities: "{{ item.capabilities | default(omit) }}"
+        exposed_ports: "{{ item.exposed_ports | default(omit) }}"
+        published_ports: "{{ item.published_ports | default(omit) }}"
+        ulimits: "{{ item.ulimits | default(omit) }}"
+        networks: "{{ item.networks | default(omit) }}"
+        dns_servers: "{{ item.dns_servers | default(omit) }}"
+      register: server
+      with_items: "{{ molecule_yml.platforms }}"
+      async: 7200
+      poll: 0
+
+    - name: Wait for instance(s) creation to complete
+      async_status:
+        jid: "{{ item.ansible_job_id }}"
+      register: docker_jobs
+      until: docker_jobs.finished
+      retries: 300
+      with_items: "{{ server.results }}"

meta/main.yml

@@ -0,0 +1,32 @@
+---
+- name: Destroy
+  hosts: localhost
+  connection: local
+  gather_facts: false
+  no_log: "{{ not lookup('env', 'MOLECULE_DEBUG') | bool }}"
+  tasks:
+    - name: Destroy molecule instance(s)
+      docker_container:
+        name: "{{ item.name }}"
+        docker_host: "{{ item.docker_host | default('unix://var/run/docker.sock') }}"
+        state: absent
+        force_kill: "{{ item.force_kill | default(true) }}"
+      register: server
+      with_items: "{{ molecule_yml.platforms }}"
+      async: 7200
+      poll: 0
+
+    - name: Wait for instance(s) deletion to complete
+      async_status:
+        jid: "{{ item.ansible_job_id }}"
+      register: docker_jobs
+      until: docker_jobs.finished
+      retries: 300
+      with_items: "{{ server.results }}"
+
+    - name: Delete docker network(s)
+      docker_network:
+        name: "{{ item }}"
+        docker_host: "{{ item.docker_host | default('unix://var/run/docker.sock') }}"
+        state: absent
+      with_items: "{{ molecule_yml.platforms | molecule_get_docker_networks }}"

molecule/default/create.yml

@@ -0,0 +1,54 @@
+---
+dependency:
+  name: galaxy
+driver:
+  name: docker
+lint:
+  name: yamllint
+platforms:
+  - name: bionic
+    image: paulfantom/ubuntu-molecule:18.04
+    privileged: true
+    volumes:
+      - /sys/fs/cgroup:/sys/fs/cgroup:ro
+  - name: xenial
+    image: paulfantom/ubuntu-molecule:16.04
+    privileged: true
+    volumes:
+      - /sys/fs/cgroup:/sys/fs/cgroup:ro
+  - name: stretch
+    image: paulfantom/debian-molecule:9
+    privileged: true
+    volumes:
+      - /sys/fs/cgroup:/sys/fs/cgroup:ro
+  - name: jessie
+    image: paulfantom/debian-molecule:8
+    privileged: true
+    volumes:
+      - /sys/fs/cgroup:/sys/fs/cgroup:ro
+  - name: centos7
+    image: paulfantom/centos-molecule:7
+    privileged: true
+    volumes:
+      - /sys/fs/cgroup:/sys/fs/cgroup:ro
+  - name: fedora
+    image: paulfantom/fedora-molecule:27
+    privileged: true
+    volumes:
+      - /sys/fs/cgroup:/sys/fs/cgroup:ro
+provisioner:
+  name: ansible
+  lint:
+    name: ansible-lint
+  playbooks:
+    create: create.yml
+    prepare: prepare.yml
+    converge: playbook.yml
+    destroy: destroy.yml
+scenario:
+  name: default
+verifier:
+  name: testinfra
+  lint:
+    name: flake8
+    enabled: true

molecule/default/destroy.yml

@@ -1,11 +1,7 @@
 ---
-- hosts: all
-  any_errors_fatal: yes
-  pre_tasks:
-  - name: Ensure cron.d exists in docker containers
-    file:
-      state: 'directory'
-      path: '/etc/cron.d'
+- name: Default use-case scenario
+  hosts: all
+  any_errors_fatal: true
   roles:
     - ansible-restic
   vars:

molecule/default/molecule.yml

@@ -0,0 +1,9 @@
+---
+- name: Prepare
+  hosts: all
+  gather_facts: false
+  tasks:
+  - name: Ensure cron.d exists in docker containers
+    file:
+      state: 'directory'
+      path: '/etc/cron.d'

tests/playbook.yml molecule/default/playbook.yml

@@ -1,6 +1,8 @@
-from testinfra.utils.ansible_runner import AnsibleRunner
+import os
+import testinfra.utils.ansible_runner
 
-testinfra_hosts = AnsibleRunner('.molecule/ansible_inventory').get_hosts('all')
+testinfra_hosts = testinfra.utils.ansible_runner.AnsibleRunner(
+    os.environ['MOLECULE_INVENTORY_FILE']).get_hosts('all')
 
 
 def test_binary(host):