Code quality with molecule, tox, and Travis. (#9)

* Set role_name explicitly to avoid using repo name

* Remove symlinks

The symlinks in this role do not play nicely with PBR, which is a
dependency of Kayobe, a project that uses this role.

* yamllint warning  truthy value should be one of [false, true]

* yamllint error    wrong indentation

* [502] All tasks should be named

* ansible-lint [702] Use 'galaxy_tags' rather than 'categories'

* ansible-lint [206] Variables should have spaces before and after: {{ var_name }}

* Yaml style

* Markdown lint MD022 MD031

* adding Molecule testing

* TODO: archlinux container has no python.

* molecule linted

* molecule verify

* test requirements

* test matrix

* Travis testing with tox

Author: bbaassssiiee

.travis.yml

@@ -0,0 +1,17 @@
+---
+sudo: required
+language: python
+services:
+  - docker
+
+before_install:
+  - sudo apt-get -qq update
+
+install:
+  - pip install -r requirements.txt
+
+script:
+  - tox
+
+notifications:
+  webhooks: https://galaxy.ansible.com/api/v1/notifications/

README.md

@@ -5,6 +5,7 @@ timezone
 
 Role Variables
 --------------
+
 ```
 
 # Default timezone.  Must be a valid tz database time zone.
@@ -14,7 +15,6 @@ timezone: UTC
 
 Example Playbook
 -------------------------
-### playbook.yml
 
 ```
 

meta/main.yml

@@ -6,23 +6,24 @@ galaxy_info:
   license: license (Apache 2.0)
   min_ansible_version: 1.9
   platforms:
-  - name: Ubuntu
-    versions:
-    - precise
-    - trusty
-  - name: Debian
-    versions:
-    - squeeze
-    - wheezy
-    - jessie
-  - name: EL
-    versions:
-    - 6
-    - 7
-  - name: Fedora
-    versions:
-    - 19
-    - 20
-  categories:
-  - system
-dependencies: []
+    - name: Ubuntu
+      versions:
+        - precise
+        - trusty
+    - name: Debian
+      versions:
+        - squeeze
+        - wheezy
+        - jessie
+    - name: EL
+      versions:
+        - 6
+        - 7
+    - name: Fedora
+      versions:
+        - 19
+        - 20
+  galaxy_tags:
+    - system
+  role_name: timezone
+dependencies: []

molecule/default/Dockerfile.j2

@@ -0,0 +1,14 @@
+# Molecule managed
+
+{% if item.registry is defined %}
+FROM {{ item.registry.url }}/{{ item.image }}
+{% else %}
+FROM {{ item.image }}
+{% endif %}
+
+RUN if [ $(command -v apt-get) ]; then apt-get update && apt-get upgrade -y && apt-get install -y python sudo bash ca-certificates && apt-get clean; \
+    elif [ $(command -v dnf) ]; then dnf makecache && dnf --assumeyes install python sudo python-devel python2-dnf bash && dnf clean all; \
+    elif [ $(command -v yum) ]; then yum makecache fast && yum update -y && yum install -y python sudo yum-plugin-ovl bash && sed -i 's/plugins=0/plugins=1/g' /etc/yum.conf && yum clean all; \
+    elif [ $(command -v zypper) ]; then zypper refresh && zypper update -y && zypper install -y python sudo bash python-xml && zypper clean -a; \
+    elif [ $(command -v apk) ]; then apk update && apk add --no-cache python sudo bash ca-certificates; \
+    elif [ $(command -v xbps-install) ]; then xbps-install -Syu && xbps-install -y python sudo bash ca-certificates && xbps-remove -O; fi

molecule/default/INSTALL.rst

@@ -0,0 +1,26 @@
+*******
+Docker driver installation guide
+*******
+
+Requirements
+============
+
+* General molecule dependencies (see https://molecule.readthedocs.io/en/latest/installation.html)
+* Docker Engine
+* docker-py
+* docker
+
+Install
+=======
+
+Ansible < 2.6
+
+.. code-block:: bash
+
+    $ sudo pip install docker-py
+
+Ansible >= 2.6
+
+.. code-block:: bash
+
+    $ sudo pip install docker

molecule/default/molecule.yml

@@ -0,0 +1,31 @@
+---
+dependency:
+  name: galaxy
+  requirements_file: requirements.yml
+driver:
+  name: docker
+verifier:
+  name: goss
+  lint:
+    name: yamllint
+platforms:
+  - name: timezone-centos7
+    image: centos:7
+    privileged: true
+  - name: timezone-centos6
+    image: centos:6
+    privileged: true
+  - name: timezone-debian
+    image: debian
+    privileged: true
+provisioner:
+  name: ansible
+  config_options:
+    defaults:
+      remote_tmp: /tmp
+  playbooks:
+    converge: playbook.yml
+  lint:
+    name: ansible-lint
+scenario:
+  name: default

molecule/default/playbook.yml

@@ -0,0 +1,7 @@
+---
+- hosts: all
+
+  vars:
+    timezone: 'America/New_York'
+  roles:
+    - role: ansible-timezone

molecule/default/tests/test_timezone.yml

@@ -0,0 +1,17 @@
+---
+
+file:
+  /etc/localtime:
+    exists: true
+    mode: "0777"
+    owner: root
+    group: root
+    filetype: symlink
+    contains: []
+  /usr/share/zoneinfo:
+    exists: true
+    mode: "0755"
+    owner: root
+    group: root
+    filetype: directory
+    contains: []

molecule/default/verify.yml

@@ -0,0 +1,56 @@
+---
+# This is an example playbook to execute goss tests.
+# Tests need distributed to the appropriate ansible host/groups
+# prior to execution by `goss validate`.
+
+- name: Verify
+  hosts: all
+  become: true
+  vars:
+    goss_version: v0.3.2
+    goss_arch: amd64
+    goss_dst: /usr/local/bin/goss
+    # yamllint disable-line rule:line-length
+    goss_sha256sum: 2f6727375db2ea0f81bee36e2c5be78ab5ab8d5981f632f761b25e4003e190ec
+    # yamllint disable-line rule:line-length
+    goss_url: "https://github.com/aelsabbahy/goss/releases/download/{{ goss_version }}/goss-linux-{{ goss_arch }}"
+    goss_test_directory: /tmp
+    goss_format: documentation
+  tasks:
+    - name: Download and install Goss
+      get_url:
+        url: "{{ goss_url }}"
+        dest: "{{ goss_dst }}"
+        sha256sum: "{{ goss_sha256sum }}"
+        mode: 0755
+      register: download_goss
+      until: download_goss is succeeded
+      retries: 3
+
+    - name: Copy Goss tests to remote
+      copy:
+        src: "{{ item }}"
+        dest: "{{ goss_test_directory }}/{{ item | basename }}"
+      with_fileglob:
+        - "{{ lookup('env', 'MOLECULE_VERIFIER_TEST_DIRECTORY') }}/test_*.yml"
+
+    - name: Register test files
+      shell: "ls {{ goss_test_directory }}/test_*.yml"
+      register: test_files
+
+    - name: Execute Goss tests
+      # yamllint disable-line rule:line-length
+      command: "{{ goss_dst }} -g {{ item }} validate --format {{ goss_format }}"
+      register: test_results
+      with_items: "{{ test_files.stdout_lines }}"
+
+    - name: Display details about the Goss results
+      debug:
+        msg: "{{ item.stdout_lines }}"
+      with_items: "{{ test_results.results }}"
+
+    - name: Fail when tests fail
+      fail:
+        msg: "Goss failed to validate"
+      when: item.rc != 0
+      with_items: "{{ test_results.results }}"

requirements.txt

@@ -0,0 +1,3 @@
+tox
+molecule
+docker