skip to navigation
skip to content

pytest-rabbitmq 1.1.1

RabbitMQ process and client fixtures for pytest

pytest-rabbitmq

Package 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:

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
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
Node name node –rabbitmq-node rabbitmq_node rabbitmq-test-{port}

Example usage:

  • pass it as an argument in your own fixture

    rabbitmq_proc = factories.rabbitmq_proc(port=8888)
    
  • use --rabbitmq-port command line option when you run your tests

    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:

    [pytest]
    rabbitmq_port = 8888
    

CHANGELOG

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
 
File Type Py Version Uploaded on Size
pytest-rabbitmq-1.1.1.tar.gz (md5) Source 2017-04-17 9KB
pytest_rabbitmq-1.1.1-py2.py3-none-any.whl (md5) Python Wheel py2.py3 2017-04-17 14KB