pact-testgen 0.7.0
Generate Python test cases from Pact files, for easier provider verification.
License: MIT license
Requires Python: >=3.7
Keywords: pact_testgen

===================
Pact Test Generator
===================


.. image:: https://img.shields.io/pypi/v/pact-testgen.svg
        :target: https://pypi.python.org/pypi/pact-testgen

.. image:: https://img.shields.io/travis/pymetrics/pact-testgen.svg
        :target: https://travis-ci.com/pymetrics/pact-testgen

.. image:: https://readthedocs.org/projects/pact-testgen/badge/?version=latest
        :target: https://pact-testgen.readthedocs.io/en/latest/?version=latest
        :alt: Documentation Status




Generate Python test cases from Pact files, for easier provider verification.


* Free software: MIT license
* Documentation: https://pact-testgen.readthedocs.io.


Features
--------

* Test Pact contracts against your Python providers via unit tests. Get test isolation *for free*.
* ``pact-testgen`` creates test cases from your Pact files, with placeholders for defining provider states.


Getting Started
---------------

Install with pip
****************

::

    python -m pip install pact-testgen

Generate test files
*******************

Generate a ``provider_states.py`` and ``test_pact.py`` files in your tests directory:

::

    pact-testgen /tests/dir -f /path/to/pactfile.json

For more details, see the Usage_ section of the documentation.

Fill in the generated provider states file
******************************************

In your tests directory (passed as the first argument to ``pact-testgen``), you'll see a file named ``provider_states.py``. It will contain set up
functions matching the provider states defined in your pact file.

Before continuing, complete these functions so that they create the required states.

Run your tests
**************

Run your test suite as normal, being sure to check the the test runner has picked up
your new `test_pact.py` file.


Credits
-------

This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.

Logo `Admiranda Urbis Venetæ`_ from the British Library's King’s Topographical Collection.

Verification of test responses in generated test code is powered by pactman_.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
.. _`Admiranda Urbis Venetæ`: https://www.flickr.com/photos/britishlibrary/51196200069/
.. _`pactman`: https://github.com/reecetech/pactman
.. _Usage: https://pact-testgen.readthedocs.io/en/latest/usage.html


=======
History
=======

0.6.0 (2022-10-30)
------------------

* Test against Python 3.10, 3.11

0.5.0 (2022-02-04)
------------------

* Adds Pact Broker support.


0.4.3 (2021-09-20)
------------------

* Fix file handling for merge provider state file option.


0.4.2 (2021-09-18)
------------------

* Improve handling of request data.


0.4.1 (2021-09-17)
------------------

* Fix test method name missing `test_`.


0.4.0 (2021-09-16)
------------------

* Adds option to merge changes to provider state file (Python 3.9 only).
* Include structured provider state parameters from Pact v3 in provider
  state function names.
* Support null provider state, i.e. pact.given(None).


0.3.0 (2021-09-03)
------------------

* Provider state setup functions now raise NotImplementedError by default.
* Format output files with target line length option.
* Improve output to console, add quiet option.


0.2.1 (2021-09-01)
------------------

* Fix test client not setting content type.


0.2.0 (2021-09-01)
------------------

* Improve output for failed test cases.


0.1.2 (2021-08-25)
------------------

* Fix bump2version config


0.1.1 (2021-08-24)
------------------

* Fix templates missing from distributed package.


0.1.0 (2021-08-23)
------------------

* First release on PyPI.