goodplay

goodplay

|version| |docs-stable| |supported-ansible-versions| |supported-python-versions| |license| |gitter|

goodplay is an Apache2-licensed test framework for testing Ansible 2.x roles and playbooks as well as running full integration tests for your software.

|build-status| |docs-latest| |code-climate| |code-coverage| |dependencies-status|

.. |build-status| image:: https://img.shields.io/travis/goodplay/goodplay/master.svg :alt: Build Status :scale: 100% :target: https://travis-ci.org/goodplay/goodplay

.. |code-climate| image:: https://img.shields.io/codeclimate/github/goodplay/goodplay.svg :alt: Code Climate :scale: 100% :target: https://codeclimate.com/github/goodplay/goodplay

.. |code-coverage| image:: https://img.shields.io/codecov/c/github/goodplay/goodplay.svg :alt: Code Coverage :scale: 100% :target: https://codecov.io/github/goodplay/goodplay

.. |dependencies-status| image:: https://img.shields.io/requires/github/goodplay/goodplay.svg?label=dependencies :alt: Dependencies Status :scale: 100% :target: https://requires.io/github/goodplay/goodplay/requirements/

.. |docs-latest| image:: https://img.shields.io/badge/docs-latest-brightgreen.svg :alt: Documentation :scale: 100% :target: https://docs.goodplay.io/en/latest/

.. |docs-stable| image:: https://img.shields.io/badge/docs-stable-brightgreen.svg :alt: Documentation :scale: 100% :target: https://docs.goodplay.io/en/stable/

.. |gitter| image:: https://badges.gitter.im/goodplay/goodplay.svg :alt: Join the chat at https://gitter.im/goodplay/goodplay :scale: 100% :target: https://gitter.im/goodplay/goodplay?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge

.. |license| image:: https://img.shields.io/pypi/l/goodplay.svg :alt: License :scale: 100% :target: https://github.com/goodplay/goodplay/blob/master/LICENSE

.. |supported-ansible-versions| image:: https://img.shields.io/badge/ansible-2.5%20|%202.6%20|%202.7-blue.svg :alt: Supported Ansible Versions :scale: 100% :target: https://docs.ansible.com/

.. |supported-python-versions| image:: https://img.shields.io/pypi/pyversions/goodplay.svg :alt: Supported Python Versions :scale: 100% :target: https://pypi.python.org/pypi/goodplay

.. |version| image:: https://img.shields.io/pypi/v/goodplay.svg :alt: Version :scale: 100% :target: https://pypi.python.org/pypi/goodplay

Features

• define your test environments via Docker Compose_ and Ansible inventories_
• write your tests as Ansible 2.x playbook tasks_
• resolve and auto-install Ansible role dependencies prior to test run
• run your tests within Docker_ container(s), an already existing test environment, or on localhost
• built as a pytest_ plugin to have a solid test runner foundation, plus you can run your goodplay tests together with your other tests

.. _Ansible 2.x playbook tasks: https://docs.ansible.com/playbooks.html .. _Ansible inventories: https://docs.ansible.com/ansible/intro_inventory.html .. _Docker: https://www.docker.com/ .. _Docker Compose: https://docs.docker.com/compose/ .. _pytest: https://pytest.org/

Versioning

goodplay will use Semantic Versioning_ when reaching v1.0.0. Until then, the minor version is used for backwards-incompatible changes.

.. _Semantic Versioning: http://semver.org/

Installation

Installing goodplay is simple with pip_, just run this in your terminal:

.. code-block:: bash

$ pip install goodplay

.. _pip: https://pip.readthedocs.org/

Contributing

#. Check for open issues or open a fresh issue to start a discussion around a feature idea or bug. #. Fork the repository_ on GitHub to start making your changes to the master branch (or branch off of it). #. Write a test which shows that the bug was fixed or that the feature works as expected. #. Send a pull request. Make sure to add yourself to AUTHORS_.

Just don't forget to check out our CONTRIBUTING_ guidelines — it includes few technical details that will make the process a lot smoother.

.. _the repository: https://github.com/goodplay/goodplay .. _AUTHORS: https://github.com/goodplay/goodplay/blob/master/AUTHORS.rst .. _CONTRIBUTING: https://github.com/goodplay/goodplay/blob/master/CONTRIBUTING.rst