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

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

    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

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

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

Uploaded Source

Built Distribution

pytest_rabbitmq-2.2.1-py3-none-any.whl (26.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pytest-rabbitmq-2.2.1.tar.gz
  • Upload date:
  • Size: 26.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.11.0 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.10

File hashes

Hashes for pytest-rabbitmq-2.2.1.tar.gz
Algorithm Hash digest
SHA256 694ef26a6b85ec3b67428cd91a3abc35231c0a90adc70dbea59e94a6950dd07e
MD5 d17cae49b8080c2f97e63105fa9e04f6
BLAKE2b-256 63b13cb6f74a8f84fe1d9a52bb36a648a40ff8b7a8542667a605693ba68d719e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pytest_rabbitmq-2.2.1-py3-none-any.whl
  • Upload date:
  • Size: 26.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.11.0 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.10

File hashes

Hashes for pytest_rabbitmq-2.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a9306b3e8c53440663fbc1baa7d77f574b9612403192fafa09224cd8824e19c1
MD5 4d7b720183f306d7ad0d9a108dadd4e6
BLAKE2b-256 119ac1f5b50df8fd4b00d6744d1043cb7197a1b1be33a8b962d6a356940c169a

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