move to molecule 2.x (#108)

* move to molecule 2.x; add test scenarios; fix linter; modify guidelines

* convert bool to string, so molecule won't fail ¯\_(ツ)_/¯

* fix testinfra tests

* fix tests

* check for absent files

.travis.yml

@@ -1,3 +1,4 @@
+---
 sudo: required
 language: python
 cache: pip
@@ -10,14 +11,13 @@ env:
   - ANSIBLE='ansible>=2.4.0,<2.5.0' PROMETHEUS=2.2.1
   - ANSIBLE='ansible>=2.5.0,<2.6.0' PROMETHEUS=1.8.2
   - ANSIBLE='ansible>=2.5.0,<2.6.0' PROMETHEUS=2.2.1
+  - ANSIBLE='ansible>=2.5.0,<2.6.0'
 matrix:
   fast_finish: true
 install:
-  - pip install ${ANSIBLE} 'ansible-lint>=3.4.15' 'molecule==1.25.0' docker git-semver 'testinfra>=1.7.0,<=1.10.1' jmespath
-before_script:
-  - ansible-lint tests/playbook.yml
+  - pip install ${ANSIBLE} 'ansible-lint>=3.4.15' 'molecule>=2.13.0' docker git-semver 'testinfra>=1.7.0' jmespath
 script:
-  - molecule test
+  - molecule test --all
 deploy:
   provider: script
   skip_cleanup: true

.yamllint

@@ -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

CONTRIBUTING.md

@@ -4,9 +4,13 @@ This document provides an overview of how you can participate in improving this
 
 ## 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
 
@@ -29,13 +33,13 @@ Some great guidelines can be found [here](https://wiki.openstack.org/wiki/GitCom
 ## Releases
 
 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
@@ -53,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.
 

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017 Pawel Krupa and Roman Demachkovych
+Copyright (c) 2017-2018 Pawel Krupa, Roman Demachkovych
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -71,17 +71,21 @@ Due to similarities in templating engines, every templates should be wrapped in
 
 ## 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,<=1.10.1' jmespath
+pip install ansible 'ansible-lint>=3.4.15' 'molecule>2.13.0' docker 'testinfra>=1.7.0' jmespath
 ```
 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 us to test how new PRs will behave when used with multiple ansible versions and multiple operating systems. This also allows use to create test scenarios for different role configurations. As a result we have a quite large test matrix (42 parallel role executions in case of [ansible-prometheus](https://github.com/cloudalchemy/ansible-prometheus)) which will take more time than local testing, so please be patient.
 
 ## Changelog
 

defaults/main.yml

@@ -10,97 +10,99 @@ prometheus_web_external_url: ''
 prometheus_storage_retention: "30d"
 
 prometheus_config_flags_extra: {}
-#prometheus_config_flags_extra:
-#  storage.tsdb.retention: 15d
-#  alertmanager.timeout: 10s
+# prometheus_config_flags_extra:
+#   storage.tsdb.retention: 15d
+#   alertmanager.timeout: 10s
 
 prometheus_alertmanager_config: []
-#prometheus_alertmanager_config:
-#  - scheme: https
-#    path_prefix: /alertmanager
-#    basic_auth:
-#      username: user
-#      password: pass
-#    static_configs:
-#      - targets: ["127.0.0.1:9093"]
-#    proxy_url: "127.0.0.2"
+# prometheus_alertmanager_config:
+#   - scheme: https
+#     path_prefix: /alertmanager
+#     basic_auth:
+#       username: user
+#       password: pass
+#     static_configs:
+#       - targets: ["127.0.0.1:9093"]
+#     proxy_url: "127.0.0.2"
 
 prometheus_global:
   scrape_interval: 15s
   scrape_timeout: 10s
   evaluation_interval: 15s
 
 prometheus_remote_write: []
-#  - url: https://dev.kausal.co/prom/push
-#    basic_auth:
-#      password: FOO
+# prometheus_remote_write:
+#   - url: https://dev.kausal.co/prom/push
+#     basic_auth:
+#       password: FOO
 
 prometheus_remote_read: []
-#  - url: https://demo.cloudalchemy.org:9201/read
-#    basic_auth:
-#      password: FOO
+# prometheus_remote_read:
+#   - url: https://demo.cloudalchemy.org:9201/read
+#     basic_auth:
+#       password: FOO
 
 prometheus_external_labels:
   environment: "{{ ansible_fqdn | default(ansible_host) | default(inventory_hostname) }}"
 
 prometheus_targets:
   node:
-  - targets:
-    - localhost:9100
-    labels:
-      env: test
+    - targets:
+        - localhost:9100
+      labels:
+        env: test
 
 prometheus_scrape_configs:
-- job_name: "prometheus"
-  metrics_path: "{{ prometheus_metrics_path }}"
-  static_configs:
-  - targets:
-    - "{{ ansible_fqdn | default(ansible_host) | default('localhost') }}:9090"
-- job_name: "node"
-  file_sd_configs:
-  - files:
-    - "{{ prometheus_config_dir }}/file_sd/node.yml"
+  - job_name: "prometheus"
+    metrics_path: "{{ prometheus_metrics_path }}"
+    static_configs:
+      - targets:
+          - "{{ ansible_fqdn | default(ansible_host) | default('localhost') }}:9090"
+  - job_name: "node"
+    file_sd_configs:
+      - files:
+          - "{{ prometheus_config_dir }}/file_sd/node.yml"
 
 # Alternative config file name, searched in ansible templates path.
 prometheus_config_file: 'prometheus.yml.j2'
 
 prometheus_alert_rules:
-- alert: InstanceDown
-  expr: "up == 0"
-  for: 5m
-  labels:
-    severity: critical
-  annotations:
-    description: "{% raw %}{{ $labels.instance }} of job {{ $labels.job }} has been down for more than 5 minutes.{% endraw %}"
-    summary: "{% raw %}Instance {{ $labels.instance }} down{% endraw %}"
-- alert: CriticalCPULoad
-  expr: '(100 * (1 - avg(irate(node_cpu{job="node",mode="idle"}[5m])) BY (instance))) > 96'
-  for: 2m
-  labels:
-    severity: critical
-  annotations:
-    description: "{% raw %}{{ $labels.instance }} of job {{ $labels.job }} has Critical CPU load for more than 2 minutes.{% endraw %}"
-    summary: "{% raw %}Instance {{ $labels.instance }} - Critical CPU load{% endraw %}"
-- alert: CriticalRAMUsage
-  expr: '(1 - ((node_memory_MemFree + node_memory_Buffers + node_memory_Cached) / node_memory_MemTotal)) * 100 > 98'
-  for: 5m
-  labels:
-    severity: critical
-  annotations:
-    description: "{% raw %}{{ $labels.instance }} has Critical Memory Usage more than 5 minutes.{% endraw %}"
-    summary: "{% raw %}Instance {{ $labels.instance }} has Critical Memory Usage{% endraw %}"
-- alert: CriticalDiskSpace
-  expr: 'node_filesystem_free{job="node",filesystem!~"^/run(/|$)"} / node_filesystem_size{job="node"} < 0.1'
-  for: 4m
-  labels:
-    severity: critical
-  annotations:
-    description: "{% raw %}{{ $labels.instance }} of job {{ $labels.job }} has less than 10% space remaining.{% endraw %}"
-    summary: "{% raw %}Instance {{ $labels.instance }} - Critical disk space usage{% endraw %}"
-- alert: RebootRequired
-  expr: "node_reboot_required > 0"
-  labels:
-    severity: warning
-  annotations:
-    description: "{% raw %}{{ $labels.instance }} requires a reboot.{% endraw %}"
-    summary: "{% raw %}Instance {{ $labels.instance }} - reboot required{% endraw %}"
+  - alert: InstanceDown
+    expr: "up == 0"
+    for: 5m
+    labels:
+      severity: critical
+    annotations:
+      description: "{% raw %}{{ $labels.instance }} of job {{ $labels.job }} has been down for more than 5 minutes.{% endraw %}"
+      summary: "{% raw %}Instance {{ $labels.instance }} down{% endraw %}"
+  - alert: CriticalCPULoad
+    expr: '(100 * (1 - avg(irate(node_cpu{job="node",mode="idle"}[5m])) BY (instance))) > 96'
+    for: 2m
+    labels:
+      severity: critical
+    annotations:
+      description: "{% raw %}{{ $labels.instance }} of job {{ $labels.job }} has Critical CPU load for more than 2 minutes.{% endraw %}"
+      summary: "{% raw %}Instance {{ $labels.instance }} - Critical CPU load{% endraw %}"
+  - alert: CriticalRAMUsage
+    expr: '(1 - ((node_memory_MemFree + node_memory_Buffers + node_memory_Cached) / node_memory_MemTotal)) * 100 > 98'
+    for: 5m
+    labels:
+      severity: critical
+    annotations:
+      description: "{% raw %}{{ $labels.instance }} has Critical Memory Usage more than 5 minutes.{% endraw %}"
+      summary: "{% raw %}Instance {{ $labels.instance }} has Critical Memory Usage{% endraw %}"
+  - alert: CriticalDiskSpace
+    expr: 'node_filesystem_free{job="node",filesystem!~"^/run(/|$)"} / node_filesystem_size{job="node"} < 0.1'
+    for: 4m
+    labels:
+      severity: critical
+    annotations:
+      description: "{% raw %}{{ $labels.instance }} of job {{ $labels.job }} has less than 10% space remaining.{% endraw %}"
+      summary: "{% raw %}Instance {{ $labels.instance }} - Critical disk space usage{% endraw %}"
+  - alert: RebootRequired
+    expr: "node_reboot_required > 0"
+    labels:
+      severity: warning
+    annotations:
+      description: "{% raw %}{{ $labels.instance }} requires a reboot.{% endraw %}"
+      summary: "{% raw %}Instance {{ $labels.instance }} - reboot required{% endraw %}"

handlers/main.yml

@@ -2,7 +2,7 @@
 - name: restart prometheus
   become: true
   systemd:
-    daemon_reload: yes
+    daemon_reload: true
     name: prometheus
     state: restarted