├── tests ├── .cache │ └── v │ │ └── cache │ │ └── lastfailed ├── test_fatal_assert │ ├── hosts │ ├── testresult.yml │ ├── ansible.cfg │ └── playbook.yml ├── test_simple_assert │ ├── hosts │ ├── ansible.cfg │ ├── playbook.yml │ └── testresult.yml ├── run-test └── test_assertive.py ├── test-requirements.txt ├── examples ├── ex-002 │ ├── environ │ ├── ansible.cfg │ └── playbook.yml ├── ex-003 │ ├── environ │ ├── ansible.cfg │ ├── playbook.yml │ └── testresult.yml ├── ex-004 │ ├── environ │ ├── ansible.cfg │ ├── hosts │ └── playbook.yml ├── ex-001.1 │ ├── ansible.cfg │ └── playbook.yml ├── ex-001.2 │ ├── ansible.cfg │ └── playbook.yml └── run-example ├── .gitignore ├── Makefile ├── .travis.yml ├── tox.ini ├── includefiles.awk ├── README.md.in ├── action_plugins └── assert.py ├── pandoc.css ├── callback_plugins └── assertive.py ├── README.md └── LICENSE /tests/.cache/v/cache/lastfailed: -------------------------------------------------------------------------------- 1 | {} -------------------------------------------------------------------------------- /test-requirements.txt: -------------------------------------------------------------------------------- 1 | pytest 2 | PyYAML 3 | -------------------------------------------------------------------------------- /examples/ex-002/environ: -------------------------------------------------------------------------------- 1 | export ASSERTIVE_FAIL_VERBOSE=1 2 | -------------------------------------------------------------------------------- /examples/ex-003/environ: -------------------------------------------------------------------------------- 1 | export ASSERTIVE_RECORD=testresult.yml 2 | -------------------------------------------------------------------------------- /examples/ex-004/environ: -------------------------------------------------------------------------------- 1 | export ASSERTIVE_RECORD=testresult.yml 2 | -------------------------------------------------------------------------------- /tests/test_fatal_assert/hosts: -------------------------------------------------------------------------------- 1 | localhost ansible_connection=local 2 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .cache 2 | .tox 3 | README.html 4 | .*.sw? 5 | __pycache__ 6 | -------------------------------------------------------------------------------- /tests/test_simple_assert/hosts: -------------------------------------------------------------------------------- 1 | localhost ansible_connection=local 2 | -------------------------------------------------------------------------------- /examples/ex-001.1/ansible.cfg: -------------------------------------------------------------------------------- 1 | [defaults] 2 | # we don't need retry files for running examples 3 | retry_files_enabled = no 4 | -------------------------------------------------------------------------------- /examples/ex-001.2/ansible.cfg: -------------------------------------------------------------------------------- 1 | [defaults] 2 | action_plugins = ../../action_plugins 3 | 4 | # we don't need retry files for running examples 5 | retry_files_enabled = no 6 | -------------------------------------------------------------------------------- /examples/ex-002/ansible.cfg: -------------------------------------------------------------------------------- 1 | [defaults] 2 | action_plugins = ../../action_plugins 3 | 4 | # we don't need retry files for running examples 5 | retry_files_enabled = no 6 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | all: README.md 2 | 3 | README.md: README.md.in 4 | awk -f includefiles.awk $< >$@ || rm -f $@ 5 | 6 | README.html: README.md 7 | pandoc --standalone --self-contained --css pandoc.css -o $@ $< 8 | 9 | clean: 10 | rm -f README.md 11 | -------------------------------------------------------------------------------- /tests/run-test: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | ex=$1 4 | 5 | cd ${0%/*} 6 | 7 | echo "# running example $ex" >&2 8 | ( 9 | cd $ex 10 | 11 | if [ -f hosts ]; then 12 | hostarg="-i hosts" 13 | fi 14 | 15 | exec ansible-playbook $hostarg playbook.yml 16 | ) 17 | -------------------------------------------------------------------------------- /examples/ex-003/ansible.cfg: -------------------------------------------------------------------------------- 1 | [defaults] 2 | action_plugins = ../../action_plugins 3 | callback_plugins = ../../callback_plugins 4 | 5 | stdout_callback = assertive 6 | show_custom_stats = yes 7 | 8 | # we don't need retry files for running examples 9 | retry_files_enabled = no 10 | -------------------------------------------------------------------------------- /examples/ex-004/ansible.cfg: -------------------------------------------------------------------------------- 1 | [defaults] 2 | action_plugins = ../../action_plugins 3 | callback_plugins = ../../callback_plugins 4 | 5 | stdout_callback = assertive 6 | show_custom_stats = yes 7 | 8 | # we don't need retry files for running examples 9 | retry_files_enabled = no 10 | -------------------------------------------------------------------------------- /examples/ex-004/hosts: -------------------------------------------------------------------------------- 1 | host1 ansible_host=localhost widgets_active=true gadgets_effective=true 2 | host2 ansible_host=localhost widgets_active=false gadgets_effective=true 3 | host3 ansible_host=localhost 4 | 5 | [webservers] 6 | host1 7 | host2 8 | 9 | [dbservers] 10 | host3 11 | -------------------------------------------------------------------------------- /examples/run-example: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | ex=$1 4 | 5 | cd ${0%/*} 6 | 7 | echo "# running example $ex" >&2 8 | ( 9 | cd $ex 10 | 11 | if [ -f environ ]; then 12 | . ./environ 13 | fi 14 | 15 | if [ -f hosts ]; then 16 | hostarg="-i hosts" 17 | fi 18 | 19 | exec ansible-playbook $hostarg playbook.yml 20 | ) 21 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: python 2 | python: 3 | - 2.7 4 | 5 | notifications: 6 | email: false 7 | 8 | env: 9 | - ANSIBLE_VERSION=devel 10 | - ANSIBLE_VERSION=v2.3.1.0-1 11 | - ANSIBLE_VERSION=v2.2.3.0-1 12 | 13 | before_install: 14 | - pip install tox 15 | - git clone --recursive --depth=1 -b $ANSIBLE_VERSION https://github.com/ansible/ansible 16 | - pip install ./ansible 17 | 18 | script: 19 | - tox 20 | -------------------------------------------------------------------------------- /tests/test_fatal_assert/testresult.yml: -------------------------------------------------------------------------------- 1 | groups: 2 | - hosts: {} 3 | name: example 003 4 | stats: 5 | assertions: 0 6 | assertions_failed: 0 7 | assertions_passed: 0 8 | assertions_skipped: 0 9 | stats: 10 | assertions: 0 11 | assertions_failed: 0 12 | assertions_passed: 0 13 | assertions_skipped: 0 14 | timing: 15 | test_finished_at: '2017-08-10T16:38:47.980791' 16 | test_started_at: '2017-08-10T16:38:47.294411' 17 | -------------------------------------------------------------------------------- /tests/test_fatal_assert/ansible.cfg: -------------------------------------------------------------------------------- 1 | [defaults] 2 | action_plugins = ../../action_plugins 3 | callback_plugins = ../../callback_plugins 4 | 5 | stdout_callback = assertive 6 | show_custom_stats = yes 7 | 8 | # we don't need retry files for running examples 9 | retry_files_enabled = no 10 | 11 | [assertive] 12 | # this causes the assertive plugin to write assertion results out 13 | # to a file named "testresult.yml". 14 | results = testresult.yml 15 | -------------------------------------------------------------------------------- /tests/test_simple_assert/ansible.cfg: -------------------------------------------------------------------------------- 1 | [defaults] 2 | action_plugins = ../../action_plugins 3 | callback_plugins = ../../callback_plugins 4 | 5 | stdout_callback = assertive 6 | show_custom_stats = yes 7 | 8 | # we don't need retry files for running examples 9 | retry_files_enabled = no 10 | 11 | [assertive] 12 | # this causes the assertive plugin to write assertion results out 13 | # to a file named "testresult.yml". 14 | results = testresult.yml 15 | -------------------------------------------------------------------------------- /tests/test_simple_assert/playbook.yml: -------------------------------------------------------------------------------- 1 | - hosts: localhost 2 | name: test simple assert 3 | vars: 4 | fruit: 5 | - apples 6 | - oranges 7 | tasks: 8 | - name: check that we have lemons 9 | assert: 10 | that: 11 | - "'lemons' in fruit" 12 | msg: we are missing lemons 13 | 14 | - name: check that we have apples 15 | assert: 16 | that: 17 | - "'apples' in fruit" 18 | msg: we are missing apples 19 | -------------------------------------------------------------------------------- /examples/ex-002/playbook.yml: -------------------------------------------------------------------------------- 1 | - hosts: localhost 2 | gather_facts: false 3 | name: example 002 4 | vars: 5 | fruit: 6 | - apples 7 | - oranges 8 | tasks: 9 | - name: check that we have lemons 10 | assert: 11 | that: 12 | - "'lemons' in fruit" 13 | msg: we are missing lemons 14 | 15 | - name: check that we have apples 16 | assert: 17 | that: 18 | - "'apples' in fruit" 19 | msg: we are missing apples 20 | -------------------------------------------------------------------------------- /examples/ex-003/playbook.yml: -------------------------------------------------------------------------------- 1 | - hosts: localhost 2 | gather_facts: false 3 | name: example 003 4 | vars: 5 | fruit: 6 | - apples 7 | - oranges 8 | tasks: 9 | - name: check that we have lemons 10 | assert: 11 | that: 12 | - "'lemons' in fruit" 13 | msg: we are missing lemons 14 | 15 | - name: check that we have apples 16 | assert: 17 | that: 18 | - "'apples' in fruit" 19 | msg: we are missing apples 20 | -------------------------------------------------------------------------------- /examples/ex-001.1/playbook.yml: -------------------------------------------------------------------------------- 1 | - hosts: localhost 2 | gather_facts: false 3 | name: example 001.1 4 | vars: 5 | fruit: 6 | - apples 7 | - oranges 8 | tasks: 9 | - name: check that we have lemons 10 | assert: 11 | that: 12 | - "'lemons' in fruit" 13 | msg: we are missing lemons 14 | 15 | - name: check that we have apples 16 | assert: 17 | that: 18 | - "'apples' in fruit" 19 | msg: we are missing apples 20 | -------------------------------------------------------------------------------- /examples/ex-001.2/playbook.yml: -------------------------------------------------------------------------------- 1 | - hosts: localhost 2 | gather_facts: false 3 | name: example 001.2 4 | vars: 5 | fruit: 6 | - apples 7 | - oranges 8 | tasks: 9 | - name: check that we have lemons 10 | assert: 11 | that: 12 | - "'lemons' in fruit" 13 | msg: we are missing lemons 14 | 15 | - name: check that we have apples 16 | assert: 17 | that: 18 | - "'apples' in fruit" 19 | msg: we are missing apples 20 | -------------------------------------------------------------------------------- /tests/test_fatal_assert/playbook.yml: -------------------------------------------------------------------------------- 1 | - hosts: localhost 2 | name: test fatal assert 3 | vars: 4 | fruit: 5 | - apples 6 | - oranges 7 | tasks: 8 | - name: check that we have lemons 9 | assert: 10 | fatal: true 11 | that: 12 | - "'lemons' in fruit" 13 | msg: we are missing lemons 14 | 15 | - name: check that we have apples 16 | assert: 17 | that: 18 | - "'apples' in fruit" 19 | msg: we are missing apples 20 | -------------------------------------------------------------------------------- /examples/ex-004/playbook.yml: -------------------------------------------------------------------------------- 1 | - hosts: webservers 2 | gather_facts: false 3 | name: test things on webservers 4 | tasks: 5 | - name: are widgets active? 6 | assert: 7 | that: widgets_active|bool 8 | 9 | - name: are gadgets effective? 10 | assert: 11 | that: gadgets_effective|bool 12 | 13 | - hosts: dbservers 14 | gather_facts: false 15 | name: test things on dbservers 16 | tasks: 17 | - name: is the pope catholic? 18 | assert: 19 | that: true 20 | -------------------------------------------------------------------------------- /tox.ini: -------------------------------------------------------------------------------- 1 | [tox] 2 | minversion = 2.0 3 | envlist = py37 4 | skipsdist = True 5 | 6 | [testenv] 7 | whitelist_externals = 8 | bash 9 | find 10 | rm 11 | env 12 | setenv = VIRTUAL_ENV={envdir} 13 | LANGUAGE=en_US 14 | LC_ALL=en_US.utf-8 15 | deps = -r{toxinidir}/test-requirements.txt 16 | commands = 17 | find . -type f -name "*.pyc" -delete 18 | passenv = 19 | http_proxy HTTP_PROXY https_proxy HTTPS_PROXY no_proxy NO_PROXY OS_DEBUG GENERATE_HASHES 20 | 21 | [testenv:py37] 22 | commands = 23 | {[testenv]commands} 24 | py.test tests 25 | 26 | [testenv:venv] 27 | commands = {posargs} 28 | -------------------------------------------------------------------------------- /includefiles.awk: -------------------------------------------------------------------------------- 1 | #!/usr/bin/awk -f 2 | 3 | # usage: 4 | # @verbatim 5 | /^@verbatim/ { 6 | if (NF == 3) { 7 | ftype=$2 8 | path=$3 9 | } else { 10 | ftype="" 11 | path=$2 12 | } 13 | 14 | printf "\n", path 15 | printf "```%s\n", ftype 16 | while ((getline line < path) > 0) { 17 | print line 18 | } 19 | printf "```\n" 20 | next 21 | } 22 | 23 | # usage: 24 | # @include 25 | /^@include/ { 26 | path = substr($0, 10) 27 | while ((getline line < path) > 0) { 28 | print line 29 | } 30 | next 31 | } 32 | 33 | # usage: 34 | # @run 35 | /^@run/ { 36 | cmd = substr($0, 6) 37 | printf "\n", cmd 38 | printf "```\n" 39 | while ((cmd | getline line) > 0) { 40 | print line 41 | } 42 | printf "```\n" 43 | next 44 | } 45 | 46 | # usage: 47 | # @ex 48 | /^@ex/ { 49 | ex = substr($0, 5) 50 | printf "\n", ex 51 | printf "```\n" 52 | while (("examples/run-example ex-" ex | getline line) > 0) { 53 | print line 54 | } 55 | printf "```\n" 56 | next 57 | } 58 | 59 | {print} 60 | -------------------------------------------------------------------------------- /examples/ex-003/testresult.yml: -------------------------------------------------------------------------------- 1 | groups: 2 | - hosts: 3 | localhost: 4 | stats: 5 | assertions: 2 6 | assertions_failed: 1 7 | assertions_passed: 1 8 | assertions_skipped: 0 9 | tests: 10 | - assertions: 11 | - test: '''lemons'' in fruit' 12 | testresult: failed 13 | msg: we are missing lemons 14 | name: check that we have lemons 15 | testresult: failed 16 | testtime: '2020-01-02T22:55:18.775504' 17 | - assertions: 18 | - test: '''apples'' in fruit' 19 | testresult: passed 20 | msg: All assertions passed 21 | name: check that we have apples 22 | testresult: passed 23 | testtime: '2020-01-02T22:55:18.839056' 24 | name: example 003 25 | stats: 26 | assertions: 2 27 | assertions_failed: 1 28 | assertions_passed: 1 29 | assertions_skipped: 0 30 | stats: 31 | assertions: 2 32 | assertions_failed: 1 33 | assertions_passed: 1 34 | assertions_skipped: 0 35 | timing: 36 | test_finished_at: '2020-01-02T22:55:18.840596' 37 | test_started_at: '2020-01-02T22:55:18.693114' 38 | -------------------------------------------------------------------------------- /tests/test_simple_assert/testresult.yml: -------------------------------------------------------------------------------- 1 | groups: 2 | - hosts: 3 | localhost: 4 | stats: 5 | assertions: 2 6 | assertions_failed: 1 7 | assertions_passed: 1 8 | assertions_skipped: 0 9 | tests: 10 | - assertions: 11 | - test: '''lemons'' in fruit' 12 | testresult: failed 13 | msg: we are missing lemons 14 | name: check that we have lemons 15 | testresult: failed 16 | testtime: '2017-08-10T16:38:49.186863' 17 | - assertions: 18 | - test: '''apples'' in fruit' 19 | testresult: passed 20 | msg: All assertions passed 21 | name: check that we have apples 22 | testresult: passed 23 | testtime: '2017-08-10T16:38:49.206439' 24 | name: example 003 25 | stats: 26 | assertions: 2 27 | assertions_failed: 1 28 | assertions_passed: 1 29 | assertions_skipped: 0 30 | stats: 31 | assertions: 2 32 | assertions_failed: 1 33 | assertions_passed: 1 34 | assertions_skipped: 0 35 | timing: 36 | test_finished_at: '2017-08-10T16:38:49.207694' 37 | test_started_at: '2017-08-10T16:38:48.504468' 38 | -------------------------------------------------------------------------------- /tests/test_assertive.py: -------------------------------------------------------------------------------- 1 | import os 2 | import pytest 3 | import shutil 4 | import subprocess 5 | import tempfile 6 | import unittest 7 | import yaml 8 | 9 | class TestAssertive(unittest.TestCase): 10 | def setUp(self): 11 | self.workspace = tempfile.mkdtemp(prefix='workspace') 12 | self.testresult = os.path.join(self.workspace, 'testresult.yml') 13 | os.environ['ASSERTIVE_RECORD'] = self.testresult 14 | 15 | def tearDown(self): 16 | shutil.rmtree(self.workspace) 17 | 18 | def test_simple_assert(self): 19 | subprocess.check_call(['tests/run-test', 'test_simple_assert']) 20 | with open(self.testresult) as fd: 21 | result = yaml.safe_load(fd) 22 | 23 | assert result['stats']['assertions'] == 2 24 | assert result['stats']['assertions_failed'] == 1 25 | assert result['stats']['assertions_passed'] == 1 26 | 27 | def test_fatal_assert(self): 28 | with pytest.raises(subprocess.CalledProcessError): 29 | subprocess.check_call(['tests/run-test', 'test_fatal_assert']) 30 | 31 | with open(self.testresult) as fd: 32 | result = yaml.safe_load(fd) 33 | 34 | assert result['stats']['assertions'] == 0 35 | -------------------------------------------------------------------------------- /README.md.in: -------------------------------------------------------------------------------- 1 | # Making assert more useful for infrastructure testing 2 | 3 | This project contains two [Ansible][] plugins: 4 | 5 | - A replacement for the core library `assert` action plugin. 6 | - The `assertive` stdout callback plugin 7 | 8 | [ansible]: http://www.ansible.com/ 9 | 10 | ## Supported Ansible versions 11 | 12 | These plugins are tested with Ansible versions 2.2.3.0 and 2.3.1.0 and 13 | with the current `devel` branch. 14 | 15 | ## About the assert module 16 | 17 | The `assert` module operates very much like the one in the core 18 | library, with two key differences: 19 | 20 | - By default, a failed `assert` will be marked as `changed` rather 21 | than `failed`. You can enable the stock behavior by specifying 22 | `fatal: true`. 23 | 24 | - The plugin will always evaluate all the tests in your `that` array 25 | (that is, it will continue to evaluate tests even after one has 26 | failed). The individual tests and their results are returned in the 27 | `assertions` key. 28 | 29 | - The plugin takes advantage of Ansible's custom statistics 30 | functionality to count the number of failed/passed/total assertions. 31 | 32 | ### Example 1 33 | 34 | Here is a simple playbook that contains two assertions: 35 | 36 | @verbatim yaml examples/ex-001.1/playbook.yml 37 | 38 | If we run this using the stock behavior, we will see the following: 39 | 40 | @ex 001.1 41 | 42 | That is, playbook execution will abort after the first assertion 43 | failure. If we activate the replacement `assert` plugin with the 44 | following `ansible.cfg`: 45 | 46 | @verbatim examples/ex-001.2/ansible.cfg 47 | 48 | Then we will see that an assertion failure shows up as `changed` 49 | rather than `failed`, allowing playbook execution to continue: 50 | 51 | @ex 001.2 52 | 53 | ### Example 2 54 | 55 | The return value from the `assert` action includes information about 56 | the assertions as well as metadata that can be consumed by the [custom 57 | statistics][] support in recent versions of Ansible. We could see the 58 | return value by instrumenting an `assert` task with a `register` 59 | directive and following it with a `debug` task, or we can enable the 60 | `fail_verbose` option by setting the `ASSERTIVE_FAIL_VERBOSE` 61 | environment variable. 62 | 63 | @verbatim examples/ex-002/environ 64 | 65 | Running the playbook from our earlier examples yields: 66 | 67 | @ex 002 68 | 69 | [custom statistics]: http://docs.ansible.com/ansible/latest/intro_configuration.html#show-custom-stats 70 | 71 | ## About the assertive callback plugin 72 | 73 | The `assertive` callback plugin operates very much like the default 74 | stdout callback plugin, but contains special support for the `assert` 75 | module: 76 | 77 | - It modifies the output of `assert` tasks to be more readable to 78 | provide more detail, and 79 | 80 | - It gathers per-host, per-play, and per-playbook-run assertion 81 | statistics, and 82 | 83 | - It can write assertion results to a YAML file. 84 | 85 | ### Example 3 86 | 87 | If we have a task similar to that in the first example: 88 | 89 | @verbatim yaml examples/ex-003/playbook.yml 90 | 91 | And we activate the `assertive` callback plugin using the following 92 | `ansible.cfg`: 93 | 94 | @verbatim examples/ex-003/ansible.cfg 95 | 96 | We see the following output: 97 | 98 | @ex 003 99 | 100 | As you can see, the `assertion` tasks now show details about both 101 | passed and failed assertions. There are custom statistics available 102 | that show details about passed, failed, and total assertions. 103 | 104 | We can record the results to a file by setting the `ASSERTIVE_RECORD` 105 | environment variable, as in: 106 | 107 | @verbatim examples/ex-003/environ 108 | 109 | The YAML file written out by the `assertive` plugin looks like 110 | this: 111 | 112 | @verbatim yaml examples/ex-003/testresult.yml 113 | 114 | ## Build status 115 | 116 | 117 | [![Build Status](https://travis-ci.org/larsks/ansible-assertive.svg?branch=master)](https://travis-ci.org/larsks/ansible-assertive) 118 | 119 | -------------------------------------------------------------------------------- /action_plugins/assert.py: -------------------------------------------------------------------------------- 1 | # This file is part of ansible_assertive 2 | # 3 | # The ansible_assertive plugin is free software: you can redistribute it and/or 4 | # modify it under the terms of the GNU General Public License as published by 5 | # the Free Software Foundation, either version 3 of the License, or (at your 6 | # option) any later version. 7 | # 8 | # The ansible_assertive plugin is distributed in the hope that it will be 9 | # useful, but WITHOUT ANY WARRANTY; without even the implied warranty of 10 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General 11 | # Public License for more details. 12 | # 13 | # You should have received a copy of the GNU General Public License 14 | # along with Ansible. If not, see . 15 | from __future__ import (absolute_import, division, print_function) 16 | __metaclass__ = type 17 | 18 | import os 19 | 20 | from ansible.errors import AnsibleError 21 | from ansible.playbook.conditional import Conditional 22 | from ansible.plugins.action import ActionBase 23 | from ansible.module_utils.six import string_types 24 | from ansible.module_utils.parsing.convert_bool import boolean 25 | 26 | 27 | class ActionModule(ActionBase): 28 | ''' Fail with custom message ''' 29 | 30 | TRANSFERS_FILES = False 31 | _VALID_ARGS = frozenset(( 32 | 'fail_msg', 'msg', 'success_msg', 'that', 33 | 'fatal')) 34 | 35 | def __init__(self, *args, **kwargs): 36 | super(ActionModule, self).__init__(*args, **kwargs) 37 | 38 | self.fail_verbose = ( 39 | os.environ.get( 40 | 'ASSERTIVE_FAIL_VERBOSE', '0').lower() 41 | in ['1', 'yes', 'true']) 42 | 43 | def run(self, tmp=None, task_vars=None): 44 | if task_vars is None: 45 | task_vars = dict() 46 | 47 | result = super(ActionModule, self).run(tmp, task_vars) 48 | del tmp # tmp no longer has any effect 49 | 50 | if 'that' not in self._task.args: 51 | raise AnsibleError('conditional required in "that" string') 52 | 53 | fail_msg = None 54 | success_msg = None 55 | 56 | fail_msg = self._task.args.get('fail_msg', self._task.args.get('msg')) 57 | if fail_msg is None: 58 | fail_msg = 'Assertion failed' 59 | elif isinstance(fail_msg, list): 60 | if not all(isinstance(x, string_types) for x in fail_msg): 61 | raise AnsibleError('Type of one of the elements in fail_msg or msg list is not string type') 62 | elif not isinstance(fail_msg, (string_types, list)): 63 | raise AnsibleError('Incorrect type for fail_msg or msg, expected a string or list and got %s' % type(fail_msg)) 64 | 65 | success_msg = self._task.args.get('success_msg') 66 | if success_msg is None: 67 | success_msg = 'All assertions passed' 68 | elif isinstance(success_msg, list): 69 | if not all(isinstance(x, string_types) for x in success_msg): 70 | raise AnsibleError('Type of one of the elements in success_msg list is not string type') 71 | elif not isinstance(success_msg, (string_types, list)): 72 | raise AnsibleError('Incorrect type for success_msg, expected a string or list and got %s' % type(success_msg)) 73 | 74 | # make sure the 'that' items are a list 75 | thats = self._task.args['that'] 76 | if not isinstance(thats, list): 77 | thats = [thats] 78 | 79 | # Now we iterate over the that items, temporarily assigning them 80 | # to the task's when value so we can evaluate the conditional using 81 | # the built in evaluate function. The when has already been evaluated 82 | # by this point, and is not used again, so we don't care about mangling 83 | # that value now 84 | cond = Conditional(loader=self._loader) 85 | results = [] 86 | 87 | for that in thats: 88 | cond.when = [that] 89 | test_result = cond.evaluate_conditional(templar=self._templar, all_vars=task_vars) 90 | this_result = { 91 | 'evaluated_to': test_result, 92 | 'assertion': that, 93 | } 94 | 95 | results.append(this_result) 96 | 97 | failed = any(not result['evaluated_to'] for result in results) 98 | changed_when_failed = not self._task.args.get('fatal', False) 99 | 100 | result.update({ 101 | 'assertions': results, 102 | 'changed': (failed and changed_when_failed), 103 | 'failed': (failed and not changed_when_failed), 104 | 'ansible_stats': { 105 | 'data': { 106 | 'assertions': 1, 107 | 'assertions_failed': 1 if failed else 0, 108 | 'assertions_passed': 0 if failed else 1, 109 | }, 110 | 'aggregate': True, 111 | 'per_host': True, 112 | }, 113 | }) 114 | 115 | if failed and self.fail_verbose: 116 | result['_ansible_verbose_always'] = True 117 | 118 | if failed: 119 | result['msg'] = fail_msg 120 | elif not failed: 121 | result['msg'] = success_msg 122 | 123 | return result 124 | -------------------------------------------------------------------------------- /pandoc.css: -------------------------------------------------------------------------------- 1 | /* 2 | * I add this to html files generated with pandoc. 3 | */ 4 | 5 | html { 6 | font-size: 100%; 7 | overflow-y: scroll; 8 | -webkit-text-size-adjust: 100%; 9 | -ms-text-size-adjust: 100%; 10 | } 11 | 12 | body { 13 | color: #444; 14 | font-family: Georgia, Palatino, 'Palatino Linotype', Times, 'Times New Roman', serif; 15 | font-size: 12px; 16 | line-height: 1.7; 17 | padding: 1em; 18 | margin: auto; 19 | max-width: 42em; 20 | background: #fefefe; 21 | } 22 | 23 | a { 24 | color: #0645ad; 25 | text-decoration: none; 26 | } 27 | 28 | a:visited { 29 | color: #0b0080; 30 | } 31 | 32 | a:hover { 33 | color: #06e; 34 | } 35 | 36 | a:active { 37 | color: #faa700; 38 | } 39 | 40 | a:focus { 41 | outline: thin dotted; 42 | } 43 | 44 | *::-moz-selection { 45 | background: rgba(255, 255, 0, 0.3); 46 | color: #000; 47 | } 48 | 49 | *::selection { 50 | background: rgba(255, 255, 0, 0.3); 51 | color: #000; 52 | } 53 | 54 | a::-moz-selection { 55 | background: rgba(255, 255, 0, 0.3); 56 | color: #0645ad; 57 | } 58 | 59 | a::selection { 60 | background: rgba(255, 255, 0, 0.3); 61 | color: #0645ad; 62 | } 63 | 64 | p { 65 | margin: 1em 0; 66 | } 67 | 68 | img { 69 | max-width: 100%; 70 | } 71 | 72 | h1, h2, h3, h4, h5, h6 { 73 | color: #111; 74 | line-height: 125%; 75 | margin-top: 2em; 76 | font-weight: normal; 77 | } 78 | 79 | h4, h5, h6 { 80 | font-weight: bold; 81 | } 82 | 83 | h1 { 84 | font-size: 2.5em; 85 | } 86 | 87 | h2 { 88 | font-size: 2em; 89 | } 90 | 91 | h3 { 92 | font-size: 1.5em; 93 | } 94 | 95 | h4 { 96 | font-size: 1.2em; 97 | } 98 | 99 | h5 { 100 | font-size: 1em; 101 | } 102 | 103 | h6 { 104 | font-size: 0.9em; 105 | } 106 | 107 | blockquote { 108 | color: #666666; 109 | margin: 0; 110 | padding-left: 3em; 111 | border-left: 0.5em #EEE solid; 112 | } 113 | 114 | hr { 115 | display: block; 116 | height: 2px; 117 | border: 0; 118 | border-top: 1px solid #aaa; 119 | border-bottom: 1px solid #eee; 120 | margin: 1em 0; 121 | padding: 0; 122 | } 123 | 124 | pre, code, kbd, samp { 125 | color: #000; 126 | font-family: monospace, monospace; 127 | _font-family: 'courier new', monospace; 128 | font-size: 0.98em; 129 | } 130 | 131 | pre { 132 | white-space: pre; 133 | white-space: pre-wrap; 134 | word-wrap: break-word; 135 | } 136 | 137 | b, strong { 138 | font-weight: bold; 139 | } 140 | 141 | dfn { 142 | font-style: italic; 143 | } 144 | 145 | ins { 146 | background: #ff9; 147 | color: #000; 148 | text-decoration: none; 149 | } 150 | 151 | mark { 152 | background: #ff0; 153 | color: #000; 154 | font-style: italic; 155 | font-weight: bold; 156 | } 157 | 158 | sub, sup { 159 | font-size: 75%; 160 | line-height: 0; 161 | position: relative; 162 | vertical-align: baseline; 163 | } 164 | 165 | sup { 166 | top: -0.5em; 167 | } 168 | 169 | sub { 170 | bottom: -0.25em; 171 | } 172 | 173 | ul, ol { 174 | margin: 1em 0; 175 | padding: 0 0 0 2em; 176 | } 177 | 178 | li p:last-child { 179 | margin-bottom: 0; 180 | } 181 | 182 | ul ul, ol ol { 183 | margin: .3em 0; 184 | } 185 | 186 | dl { 187 | margin-bottom: 1em; 188 | } 189 | 190 | dt { 191 | font-weight: bold; 192 | margin-bottom: .8em; 193 | } 194 | 195 | dd { 196 | margin: 0 0 .8em 2em; 197 | } 198 | 199 | dd:last-child { 200 | margin-bottom: 0; 201 | } 202 | 203 | img { 204 | border: 0; 205 | -ms-interpolation-mode: bicubic; 206 | vertical-align: middle; 207 | } 208 | 209 | figure { 210 | display: block; 211 | text-align: center; 212 | margin: 1em 0; 213 | } 214 | 215 | figure img { 216 | border: none; 217 | margin: 0 auto; 218 | } 219 | 220 | figcaption { 221 | font-size: 0.8em; 222 | font-style: italic; 223 | margin: 0 0 .8em; 224 | } 225 | 226 | table { 227 | margin-bottom: 2em; 228 | border-bottom: 1px solid #ddd; 229 | border-right: 1px solid #ddd; 230 | border-spacing: 0; 231 | border-collapse: collapse; 232 | } 233 | 234 | table th { 235 | padding: .2em 1em; 236 | background-color: #eee; 237 | border-top: 1px solid #ddd; 238 | border-left: 1px solid #ddd; 239 | } 240 | 241 | table td { 242 | padding: .2em 1em; 243 | border-top: 1px solid #ddd; 244 | border-left: 1px solid #ddd; 245 | vertical-align: top; 246 | } 247 | 248 | .author { 249 | font-size: 1.2em; 250 | text-align: center; 251 | } 252 | 253 | @media only screen and (min-width: 480px) { 254 | body { 255 | font-size: 14px; 256 | } 257 | } 258 | @media only screen and (min-width: 768px) { 259 | body { 260 | font-size: 16px; 261 | } 262 | } 263 | @media print { 264 | * { 265 | background: transparent !important; 266 | color: black !important; 267 | filter: none !important; 268 | -ms-filter: none !important; 269 | } 270 | 271 | body { 272 | font-size: 12pt; 273 | max-width: 100%; 274 | } 275 | 276 | a, a:visited { 277 | text-decoration: underline; 278 | } 279 | 280 | hr { 281 | height: 1px; 282 | border: 0; 283 | border-bottom: 1px solid black; 284 | } 285 | 286 | a[href]:after { 287 | content: " (" attr(href) ")"; 288 | } 289 | 290 | abbr[title]:after { 291 | content: " (" attr(title) ")"; 292 | } 293 | 294 | .ir a:after, a[href^="javascript:"]:after, a[href^="#"]:after { 295 | content: ""; 296 | } 297 | 298 | pre, blockquote { 299 | border: 1px solid #999; 300 | padding-right: 1em; 301 | page-break-inside: avoid; 302 | } 303 | 304 | tr, img { 305 | page-break-inside: avoid; 306 | } 307 | 308 | img { 309 | max-width: 100% !important; 310 | } 311 | 312 | @page :left { 313 | margin: 15mm 20mm 15mm 10mm; 314 | } 315 | 316 | @page :right { 317 | margin: 15mm 10mm 15mm 20mm; 318 | } 319 | 320 | p, h2, h3 { 321 | orphans: 3; 322 | widows: 3; 323 | } 324 | 325 | h2, h3 { 326 | page-break-after: avoid; 327 | } 328 | } 329 | -------------------------------------------------------------------------------- /callback_plugins/assertive.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | 3 | import datetime 4 | import os 5 | import sys 6 | import yaml 7 | 8 | from ansible import constants as C 9 | from ansible.parsing.yaml.objects import AnsibleUnicode 10 | from ansible.plugins.callback.default import CallbackModule as CallbackModule_default 11 | from ansible.utils.color import stringc 12 | 13 | try: 14 | from ansible.utils.unsafe_proxy import AnsibleUnsafeText 15 | except ImportError: 16 | from ansible.vars.unsafe_proxy import AnsibleUnsafeText 17 | 18 | if sys.version_info[0] >= 3: 19 | unicode = str 20 | 21 | stats = { 22 | 'assertions': 0, 23 | 'assertions_passed': 0, 24 | 'assertions_skipped': 0, 25 | 'assertions_failed': 0, 26 | } 27 | 28 | 29 | def unicode_representer(dumper, uni): 30 | node = yaml.ScalarNode(tag=u'tag:yaml.org,2002:str', value=str(uni)) 31 | return node 32 | 33 | 34 | yaml.add_representer(AnsibleUnicode, unicode_representer) 35 | yaml.add_representer(AnsibleUnsafeText, unicode_representer) 36 | 37 | 38 | class CallbackModule(CallbackModule_default): 39 | CALLBACK_VERSION = 2.0 40 | CALLBACK_TYPE = 'stdout' 41 | CALLBACK_NAME = 'assertive' 42 | 43 | def __init__(self, *args, **kwargs): 44 | super(CallbackModule, self).__init__(*args, **kwargs) 45 | self.stats = stats.copy() 46 | 47 | self.groups = [] 48 | self.group = None 49 | self.timing = {} 50 | 51 | self.record = os.environ.get('ASSERTIVE_RECORD') 52 | self.timing['test_started_at'] = str( 53 | datetime.datetime.utcnow().isoformat()) 54 | 55 | def start_host(self, hostname): 56 | self.group['hosts'][hostname] = { 57 | 'stats': stats.copy(), 58 | 'tests': [], 59 | } 60 | 61 | def start_group(self, name=None): 62 | self.group = { 63 | 'stats': stats.copy(), 64 | 'hosts': {}, 65 | } 66 | 67 | if name is not None: 68 | self.group['name'] = name 69 | 70 | def process_assert_result(self, result, skipped=False): 71 | '''process the results from a single assert: action. a single 72 | assert: may contain multiple tests.''' 73 | 74 | hostname = result._host.get_name() 75 | if hostname not in self.group['hosts']: 76 | self.start_host(hostname) 77 | thishost = self.group['hosts'][hostname] 78 | 79 | def inc_stats(key): 80 | self.stats[key] += 1 81 | self.group['stats'][key] += 1 82 | thishost['stats'][key] += 1 83 | 84 | # we get loop results one at a time through 85 | # v2_playbook_item_on_*, so we can ignore tasks 86 | # with loop results. 87 | if 'results' in result._result: 88 | return 89 | 90 | tests = [] 91 | testentry = { 92 | 'assertions': tests, 93 | 'testtime': datetime.datetime.utcnow().isoformat(), 94 | } 95 | 96 | if result._task.name: 97 | testentry['name'] = result._task.name 98 | 99 | if 'item' in result._result: 100 | testentry['item'] = result._result['item'] 101 | 102 | for assertion in result._result.get('assertions', [{}]): 103 | failed = not assertion.get('evaluated_to', True) 104 | 105 | inc_stats('assertions') 106 | 107 | if skipped: 108 | testresult = 'skipped' 109 | testcolor = C.COLOR_SKIP 110 | inc_stats('assertions_skipped') 111 | elif failed: 112 | testresult = 'failed' 113 | testcolor = C.COLOR_ERROR 114 | inc_stats('assertions_failed') 115 | else: 116 | testresult = 'passed' 117 | testcolor = C.COLOR_OK 118 | inc_stats('assertions_passed') 119 | 120 | thistest = { 121 | 'testresult': testresult, 122 | 'test': assertion.get('assertion'), 123 | } 124 | 125 | tests.append(thistest) 126 | 127 | prefix = stringc('%s: [%s]' % ( 128 | testresult, result._host.get_name()), testcolor) 129 | 130 | self._display.display('%s ASSERT(%s)' % ( 131 | prefix, 132 | assertion.get('assertion', '(skipped)'))) 133 | 134 | failed = any(test['testresult'] == 'failed' 135 | for test in tests) 136 | 137 | skipped = all(test['testresult'] == 'skipped' 138 | for test in tests) 139 | 140 | if 'msg' in result._result: 141 | testentry['msg'] = result._result['msg'] 142 | if failed: 143 | msg = 'failed: %s' % (result._result['msg']) 144 | self._display.display(stringc(msg, C.COLOR_ERROR)) 145 | 146 | if failed: 147 | testentry['testresult'] = 'failed' 148 | elif skipped: 149 | testentry['testresult'] = 'skipped' 150 | else: 151 | testentry['testresult'] = 'passed' 152 | 153 | thishost['tests'].append(testentry) 154 | 155 | def v2_runner_item_on_ok(self, result): 156 | if result._task.action == 'assert': 157 | self.process_assert_result(result) 158 | else: 159 | super(CallbackModule, self).v2_runner_item_on_ok(result) 160 | 161 | def v2_runner_on_ok(self, result): 162 | if result._task.action == 'assert': 163 | self.process_assert_result(result) 164 | else: 165 | super(CallbackModule, self).v2_runner_on_ok(result) 166 | 167 | def v2_runner_on_failed(self, result, ignore_errors=False): 168 | if not ignore_errors: 169 | super(CallbackModule, self).v2_runner_on_failed( 170 | result, ignore_errors=ignore_errors) 171 | else: 172 | self._display.display(stringc('failed (ignored): [%s]' % ( 173 | result._host.get_name(), 174 | ), C.COLOR_CHANGED)) 175 | 176 | def v2_runner_on_skipped(self, result): 177 | if result._task.action == 'assert': 178 | self.process_assert_result(result, skipped=True) 179 | else: 180 | super(CallbackModule, self).v2_runner_on_skipped(result) 181 | 182 | def v2_runner_item_on_skipped(self, result): 183 | if result._task.action == 'assert': 184 | self.process_assert_result(result, skipped=True) 185 | else: 186 | super(CallbackModule, self).v2_runner_item_on_skipped(result) 187 | 188 | def close_group(self): 189 | self.groups.append(self.group) 190 | self.group = None 191 | 192 | def v2_runner_on_start(self, host, tasks): 193 | pass 194 | 195 | def v2_playbook_on_play_start(self, play): 196 | super(CallbackModule, self).v2_playbook_on_play_start(play) 197 | self.close_group() 198 | self.start_group(play.get_name()) 199 | 200 | def v2_playbook_on_stats(self, stats): 201 | super(CallbackModule, self).v2_playbook_on_stats(stats) 202 | 203 | self.close_group() 204 | self.timing['test_finished_at'] = str( 205 | datetime.datetime.utcnow().isoformat()) 206 | 207 | if self.record is not None: 208 | self._display.display('Writing test results to %s' % ( 209 | self.record,)) 210 | 211 | report = { 212 | 'stats': self.stats, 213 | 'groups': [group for group in self.groups 214 | if group is not None], 215 | 'timing': self.timing, 216 | } 217 | 218 | with open(self.record, 'w') as fd: 219 | yaml.dump(report, fd, default_flow_style=False) 220 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Making assert more useful for infrastructure testing 2 | 3 | This project contains two [Ansible][] plugins: 4 | 5 | - A replacement for the core library `assert` action plugin. 6 | - The `assertive` stdout callback plugin 7 | 8 | [ansible]: http://www.ansible.com/ 9 | 10 | ## Supported Ansible versions 11 | 12 | These plugins are tested with Ansible versions 2.2.3.0 and 2.3.1.0 and 13 | with the current `devel` branch. 14 | 15 | ## About the assert module 16 | 17 | The `assert` module operates very much like the one in the core 18 | library, with two key differences: 19 | 20 | - By default, a failed `assert` will be marked as `changed` rather 21 | than `failed`. You can enable the stock behavior by specifying 22 | `fatal: true`. 23 | 24 | - The plugin will always evaluate all the tests in your `that` array 25 | (that is, it will continue to evaluate tests even after one has 26 | failed). The individual tests and their results are returned in the 27 | `assertions` key. 28 | 29 | - The plugin takes advantage of Ansible's custom statistics 30 | functionality to count the number of failed/passed/total assertions. 31 | 32 | ### Example 1 33 | 34 | Here is a simple playbook that contains two assertions: 35 | 36 | 37 | ```yaml 38 | - hosts: localhost 39 | gather_facts: false 40 | name: example 001.1 41 | vars: 42 | fruit: 43 | - apples 44 | - oranges 45 | tasks: 46 | - name: check that we have lemons 47 | assert: 48 | that: 49 | - "'lemons' in fruit" 50 | msg: we are missing lemons 51 | 52 | - name: check that we have apples 53 | assert: 54 | that: 55 | - "'apples' in fruit" 56 | msg: we are missing apples 57 | ``` 58 | 59 | If we run this using the stock behavior, we will see the following: 60 | 61 | 62 | ``` 63 | 64 | PLAY [example 001.1] ***************************************************************** 65 | 66 | TASK [check that we have lemons] ***************************************************** 67 | fatal: [localhost]: FAILED! => { 68 | "assertion": "'lemons' in fruit", 69 | "changed": false, 70 | "evaluated_to": false, 71 | "msg": "we are missing lemons" 72 | } 73 | 74 | PLAY RECAP *************************************************************************** 75 | localhost : ok=0 changed=0 unreachable=0 failed=1 skipped=0 rescued=0 ignored=0 76 | 77 | ``` 78 | 79 | That is, playbook execution will abort after the first assertion 80 | failure. If we activate the replacement `assert` plugin with the 81 | following `ansible.cfg`: 82 | 83 | 84 | ``` 85 | [defaults] 86 | action_plugins = ../../action_plugins 87 | 88 | # we don't need retry files for running examples 89 | retry_files_enabled = no 90 | ``` 91 | 92 | Then we will see that an assertion failure shows up as `changed` 93 | rather than `failed`, allowing playbook execution to continue: 94 | 95 | 96 | ``` 97 | 98 | PLAY [example 001.2] ***************************************************************** 99 | 100 | TASK [check that we have lemons] ***************************************************** 101 | changed: [localhost] 102 | 103 | TASK [check that we have apples] ***************************************************** 104 | ok: [localhost] 105 | 106 | PLAY RECAP *************************************************************************** 107 | localhost : ok=2 changed=1 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0 108 | 109 | ``` 110 | 111 | ### Example 2 112 | 113 | The return value from the `assert` action includes information about 114 | the assertions as well as metadata that can be consumed by the [custom 115 | statistics][] support in recent versions of Ansible. We could see the 116 | return value by instrumenting an `assert` task with a `register` 117 | directive and following it with a `debug` task, or we can enable the 118 | `fail_verbose` option by setting the `ASSERTIVE_FAIL_VERBOSE` 119 | environment variable. 120 | 121 | 122 | ``` 123 | export ASSERTIVE_FAIL_VERBOSE=1 124 | ``` 125 | 126 | Running the playbook from our earlier examples yields: 127 | 128 | 129 | ``` 130 | 131 | PLAY [example 002] ******************************************************************* 132 | 133 | TASK [check that we have lemons] ***************************************************** 134 | changed: [localhost] => { 135 | "ansible_stats": { 136 | "aggregate": true, 137 | "data": { 138 | "assertions": 1, 139 | "assertions_failed": 1, 140 | "assertions_passed": 0 141 | }, 142 | "per_host": true 143 | }, 144 | "assertions": [ 145 | { 146 | "assertion": "'lemons' in fruit", 147 | "evaluated_to": false 148 | } 149 | ], 150 | "changed": true, 151 | "msg": "we are missing lemons" 152 | } 153 | 154 | TASK [check that we have apples] ***************************************************** 155 | ok: [localhost] 156 | 157 | PLAY RECAP *************************************************************************** 158 | localhost : ok=2 changed=1 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0 159 | 160 | ``` 161 | 162 | [custom statistics]: http://docs.ansible.com/ansible/latest/intro_configuration.html#show-custom-stats 163 | 164 | ## About the assertive callback plugin 165 | 166 | The `assertive` callback plugin operates very much like the default 167 | stdout callback plugin, but contains special support for the `assert` 168 | module: 169 | 170 | - It modifies the output of `assert` tasks to be more readable to 171 | provide more detail, and 172 | 173 | - It gathers per-host, per-play, and per-playbook-run assertion 174 | statistics, and 175 | 176 | - It can write assertion results to a YAML file. 177 | 178 | ### Example 3 179 | 180 | If we have a task similar to that in the first example: 181 | 182 | 183 | ```yaml 184 | - hosts: localhost 185 | gather_facts: false 186 | name: example 003 187 | vars: 188 | fruit: 189 | - apples 190 | - oranges 191 | tasks: 192 | - name: check that we have lemons 193 | assert: 194 | that: 195 | - "'lemons' in fruit" 196 | msg: we are missing lemons 197 | 198 | - name: check that we have apples 199 | assert: 200 | that: 201 | - "'apples' in fruit" 202 | msg: we are missing apples 203 | ``` 204 | 205 | And we activate the `assertive` callback plugin using the following 206 | `ansible.cfg`: 207 | 208 | 209 | ``` 210 | [defaults] 211 | action_plugins = ../../action_plugins 212 | callback_plugins = ../../callback_plugins 213 | 214 | stdout_callback = assertive 215 | show_custom_stats = yes 216 | 217 | # we don't need retry files for running examples 218 | retry_files_enabled = no 219 | ``` 220 | 221 | We see the following output: 222 | 223 | 224 | ``` 225 | 226 | PLAY [example 003] ******************************************************************* 227 | 228 | TASK [check that we have lemons] ***************************************************** 229 | failed: [localhost] ASSERT('lemons' in fruit) 230 | failed: we are missing lemons 231 | 232 | TASK [check that we have apples] ***************************************************** 233 | passed: [localhost] ASSERT('apples' in fruit) 234 | 235 | PLAY RECAP *************************************************************************** 236 | localhost : ok=2 changed=1 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0 237 | 238 | 239 | CUSTOM STATS: ************************************************************************ 240 | localhost: { "assertions": 2, "assertions_failed": 1, "assertions_passed": 1} 241 | 242 | Writing test results to testresult.yml 243 | ``` 244 | 245 | As you can see, the `assertion` tasks now show details about both 246 | passed and failed assertions. There are custom statistics available 247 | that show details about passed, failed, and total assertions. 248 | 249 | We can record the results to a file by setting the `ANSIBLE_RECORD` 250 | environment variable, as in: 251 | 252 | 253 | ``` 254 | export ASSERTIVE_RECORD=testresult.yml 255 | ``` 256 | 257 | The YAML file written out by the `assertive` plugin looks like 258 | this: 259 | 260 | 261 | ```yaml 262 | groups: 263 | - hosts: 264 | localhost: 265 | stats: 266 | assertions: 2 267 | assertions_failed: 1 268 | assertions_passed: 1 269 | assertions_skipped: 0 270 | tests: 271 | - assertions: 272 | - test: '''lemons'' in fruit' 273 | testresult: failed 274 | msg: we are missing lemons 275 | name: check that we have lemons 276 | testresult: failed 277 | testtime: '2020-01-02T22:55:18.775504' 278 | - assertions: 279 | - test: '''apples'' in fruit' 280 | testresult: passed 281 | msg: All assertions passed 282 | name: check that we have apples 283 | testresult: passed 284 | testtime: '2020-01-02T22:55:18.839056' 285 | name: example 003 286 | stats: 287 | assertions: 2 288 | assertions_failed: 1 289 | assertions_passed: 1 290 | assertions_skipped: 0 291 | stats: 292 | assertions: 2 293 | assertions_failed: 1 294 | assertions_passed: 1 295 | assertions_skipped: 0 296 | timing: 297 | test_finished_at: '2020-01-02T22:55:18.840596' 298 | test_started_at: '2020-01-02T22:55:18.693114' 299 | ``` 300 | 301 | ## Build status 302 | 303 | 304 | [![Build Status](https://travis-ci.org/larsks/ansible-assertive.svg?branch=master)](https://travis-ci.org/larsks/ansible-assertive) 305 | 306 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------