Public | Automated Build

Last pushed: 22 days ago
Short Description
goodplay: Make your deployment play well.
Full Description


|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::
:alt: Build Status
:scale: 100%

.. |code-climate| image::
:alt: Code Climate
:scale: 100%

.. |code-coverage| image::
:alt: Code Coverage
:scale: 100%

.. |dependencies-status| image::
:alt: Dependencies Status
:scale: 100%

.. |docs-latest| image::
:alt: Documentation
:scale: 100%

.. |docs-stable| image::
:alt: Documentation
:scale: 100%

.. |gitter| image::
:alt: Join the chat at
:scale: 100%

.. |license| image::
:alt: License
:scale: 100%

.. |supported-ansible-versions| image::,2.4,2.5-blue.svg
:alt: Supported Ansible Versions
:scale: 100%

.. |supported-python-versions| image::
:alt: Supported Python Versions
:scale: 100%

.. |version| image::
:alt: Version
:scale: 100%


  • 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:
.. _Ansible inventories:
.. _Docker:
.. _Docker Compose:
.. _pytest:


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

.. _Semantic Versioning:


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

.. code-block:: bash

$ pip install goodplay

.. _pip:


#. 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:

Docker Pull Command
Source Repository