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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: pytest-rabbitmq-2.2.0.tar.gz
  • Upload date:
  • Size: 26.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.4.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.5

File hashes

Hashes for pytest-rabbitmq-2.2.0.tar.gz
Algorithm Hash digest
SHA256 ccd10723483379d39ef837fd37733cdd418d552366c5dbede24848cb8653f7b1
MD5 929fc1a66d50d520a7fa27315c72eda1
BLAKE2b-256 f104770d807ba59c4d87b50a9d99b687c58c684652efb7fcca9e2c6fbb9b627d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pytest_rabbitmq-2.2.0-py3-none-any.whl
  • Upload date:
  • Size: 26.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.4.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.5

File hashes

Hashes for pytest_rabbitmq-2.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 dc1a15826830c2b6292781443fceb37659d7527069e4874c96923fde415742cd
MD5 7c59ec7795da46fbc45563ee890aba44
BLAKE2b-256 81788ff601f79f6e99df41b56f5ac829743b8e9a86de7ca9a5cbcf57245eac0c

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