Skip to main content

RabbitMQ process and client fixtures for pytest

Project description

pytest-rabbitmq

Latest PyPI version Wheel Status Supported Python Versions License

Package status

Tests Coverage Status Requirements 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')

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

Package resources

CHANGELOG

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pytest-rabbitmq-1.0.0.tar.gz (9.3 kB view details)

Uploaded Source

Built Distribution

pytest_rabbitmq-1.0.0-py2.py3-none-any.whl (14.3 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file pytest-rabbitmq-1.0.0.tar.gz.

File metadata

File hashes

Hashes for pytest-rabbitmq-1.0.0.tar.gz
Algorithm Hash digest
SHA256 a3be7fccbbfec73aab6169405d798ef80f1dd879dda6e09308f3588836be6318
MD5 ce826b4962285740111dd00388942620
BLAKE2b-256 41184c8e81e51169971dc864177bd75b5a21e9a8c288dca56e999e8b5f5ce094

See more details on using hashes here.

File details

Details for the file pytest_rabbitmq-1.0.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for pytest_rabbitmq-1.0.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 c7ef238c272a775c881902b17a11a992bb3dd57f9ecfc922dfd34df7278c2daf
MD5 a02dd8145197097b187ddaa9ea9c1aa2
BLAKE2b-256 6c7ac08ed99d2f61647f93b8223c7e35ec453c1841b719cac64002b8e58201f3

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page