Metadata-Version: 2.1
Name: pytest-rabbitmq
Version: 2.2.1
Summary: RabbitMQ process and client fixtures for pytest
Home-page: https://github.com/ClearcodeHQ/pytest-rabbitmq
Maintainer: Grzegorz Śliwiński
Maintainer-email: fizyk+pypi@fizyk.net.pl
License: LGPLv3+
Keywords: tests,py.test,pytest,fixture,rabbitmq,messsage queue
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Testing
Classifier: Framework :: Pytest
Requires-Python: >=3.7
Description-Content-Type: text/x-rst
Provides-Extra: tests
License-File: COPYING
License-File: COPYING.lesser
License-File: AUTHORS.rst

.. image:: https://raw.githubusercontent.com/ClearcodeHQ/pytest-rabbitmq/master/logo.png
    :width: 100px
    :height: 100px
    
pytest-rabbitmq
===============

.. image:: https://img.shields.io/pypi/v/pytest-rabbitmq.svg
    :target: https://pypi.python.org/pypi/pytest-rabbitmq/
    :alt: Latest PyPI version

.. image:: https://img.shields.io/pypi/wheel/pytest-rabbitmq.svg
    :target: https://pypi.python.org/pypi/pytest-rabbitmq/
    :alt: Wheel Status

.. image:: https://img.shields.io/pypi/pyversions/pytest-rabbitmq.svg
    :target: https://pypi.python.org/pypi/pytest-rabbitmq/
    :alt: Supported Python Versions

.. image:: https://img.shields.io/pypi/l/pytest-rabbitmq.svg
    :target: https://pypi.python.org/pypi/pytest-rabbitmq/
    :alt: License

Package status
--------------

.. image:: https://travis-ci.org/ClearcodeHQ/pytest-rabbitmq.svg?branch=v2.2.1
    :target: https://travis-ci.org/ClearcodeHQ/pytest-rabbitmq
    :alt: Tests

.. image:: https://coveralls.io/repos/ClearcodeHQ/pytest-rabbitmq/badge.png?branch=v2.2.1
    :target: https://coveralls.io/r/ClearcodeHQ/pytest-rabbitmq?branch=v2.2.1
    :alt: Coverage Status

What is this?
=============

This is a pytest plugin, that enables you to test your code that relies on a running RabbitMQ Queues.
It allows you to specify additional fixtures for RabbitMQ process and client.

How to use
==========

Plugin contains two fixtures

* **rabbitmq** - it's a client fixture that has functional scope. After each test, it cleans RabbitMQ, cleans queues and exchanges for more reliable tests.
* **rabbitmq_proc** - session scoped fixture, that starts RabbitMQ instance at it's first use and stops at the end of the tests.

Simply include one of these fixtures into your tests fixture list.

You can also create additional rabbitmq client and process fixtures if you'd need to:


.. code-block:: python

    from pytest_rabbitmq import factories

    rabbitmq_my_proc = factories.rabbitmq_proc(
        port=None, logsdir='/tmp')
    rabbitmq_my = factories.rabbitmq('rabbitmq_my_proc')

.. note::

    Each RabbitMQ process fixture can be configured in a different way than the others through the fixture factory arguments.

Configuration
=============

You can define your settings in three ways, it's fixture factory argument, command line option and pytest.ini configuration option.
You can pick which you prefer, but remember that these settings are handled in the following order:

    * ``Fixture factory argument``
    * ``Command line option``
    * ``Configuration option in your pytest.ini file``

.. list-table:: Configuration options
   :header-rows: 1

   * - RabbitMQ option
     - Fixture factory argument
     - Command line option
     - pytest.ini option
     - Default
   * - host
     - host
     - --rabbitmq-host
     - rabbitmq_host
     - 127.0.0.1
   * - port
     - port
     - --rabbitmq-port
     - rabbitmq_port
     - random
   * - rabbitmqctl path
     - ctl
     - --rabbitmq-ctl
     - rabbitmq_ctl
     - /usr/lib/rabbitmq/bin/rabbitmqctl
   * - rabbitmq server path
     - server
     - --rabbitmq-server
     - rabbitmq_server
     - /usr/lib/rabbitmq/bin/rabbitmq-server
   * - Log directory location
     - logsdir
     - --rabbitmq-logsdir
     - rabbitmq_logsdir
     - $TMPDIR
   * - Plugin directory location
     - plugin_path
     - --rabbitmq-plugindir
     - rabbitmq_plugindir
     - $TMPDIR
   * - Node name
     - node
     - --rabbitmq-node
     - rabbitmq_node
     - rabbitmq-test-{port}


Example usage:

* pass it as an argument in your own fixture

    .. code-block:: python

        rabbitmq_proc = factories.rabbitmq_proc(port=8888)

* use ``--rabbitmq-port`` command line option when you run your tests

    .. code-block::

        py.test tests --rabbitmq-port=8888


* specify your port as ``rabbitmq_port`` in your ``pytest.ini`` file.

    To do so, put a line like the following under the ``[pytest]`` section of your ``pytest.ini``:

    .. code-block:: ini

        [pytest]
        rabbitmq_port = 8888

Package resources
-----------------

* Bug tracker: https://github.com/ClearcodeHQ/pytest-rabbitmq/issues

CHANGELOG
=========

2.2.1
----------

Bugfix
++++++

- require `port-for>=0.6.0` which introduced the `get_port` function

Misc
++++

- updated trove classifiers - added python 3.10 and pypy

2.2.0
----------

Bugfix
++++++

- rely on `get_port` functionality delivered by `port_for`
- Extended range of messages for list queues output

Misc
++++

- Migrate CI to github actions
- Support only python 3.7 and up

2.1.0
----------

Feature
+++++++
- Allow to configure plugin's location with the use of

  * **--rabbitmq-logsdir** command line argument
  * **rabbitmq_logsdir** ini file configuration option
  * **logsdir** factory argument

2.0.1
----------

- [fix] Adjust for mirakuru 2.2.0 and up

2.0.0
----------

- [cleanup] Move more rabbitmq related logic into the executor
- [enhancements] Base environment variables support on the mirakuru functionality itself
- [feature] Drop support for python 2.7. From now on, only support python 3.6 and up

1.1.2
----------

- [fix] Fix list queues functionality

1.1.1
----------

- [enhancemet] removed path.py dependency

1.1.0
----------

- [enhancements] adjust pytest-rabbitmq to pytest 3. require pytest 3.

1.0.0
----------

- [enhancements] command line and pytest.ini options for modifying rabbitmq node name
- [enhancements] command line and pytest.ini options for modifying server exec path
- [enhancements] command line and pytest.ini options for modifying ctl exec path
- [enhancements] command line and pytest.ini options for modifying host
- [enhancements] command line and pytest.ini options for modifying port
- [enhancements] command line and pytest.ini options for modifying logs directory destination


