Skip to main content

RabbitMQ process and client fixtures for pytest

Project description

https://raw.githubusercontent.com/ClearcodeHQ/pytest-rabbitmq/master/logo.png

pytest-rabbitmq

Latest PyPI version Wheel Status Supported Python Versions License

Package status

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

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

Configuration options

RabbitMQ option

Fixture factory argument

Command line option

pytest.ini option

Default

host

host

–rabbitmq-host

rabbitmq_host

127.0.0.1

RABBITMQ_NODE_PORT

port

–rabbitmq-port

rabbitmq_port

random

RABBITMQ_DIST_PORT

distribution_port

–rabbitmq-distribution-port

rabbitmq_distribution_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

    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

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-3.1.0.tar.gz (31.0 kB view details)

Uploaded Source

Built Distribution

pytest_rabbitmq-3.1.0-py3-none-any.whl (30.0 kB view details)

Uploaded Python 3

File details

Details for the file pytest_rabbitmq-3.1.0.tar.gz.

File metadata

  • Download URL: pytest_rabbitmq-3.1.0.tar.gz
  • Upload date:
  • Size: 31.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for pytest_rabbitmq-3.1.0.tar.gz
Algorithm Hash digest
SHA256 577ab6a3777b9f4ace29f3b4e8c6005b3e090c616600ae9933cab7d9c1581e10
MD5 b7d811288ad648a005e4eb6e2f35871a
BLAKE2b-256 ddd6a1909e030e4bc0d19414d77df620166da9bcf12330625ff958be2c21fff1

See more details on using hashes here.

File details

Details for the file pytest_rabbitmq-3.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for pytest_rabbitmq-3.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 11e231ab60973262a9f11383ec0f611e8b76770738bc36cf22b03f0851356482
MD5 b7dca1d66a47d0d16610b6b0fbf59d3c
BLAKE2b-256 67cac7b711a287b7dbc2d4a10f0c208128659fe20ce148ba87a153cff45ca19d

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