RabbitMQ process and client fixtures for pytest
Project description
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')
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
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
File details
Details for the file pytest_rabbitmq-2.0.1-py3-none-any.whl
.
File metadata
- Download URL: pytest_rabbitmq-2.0.1-py3-none-any.whl
- Upload date:
- Size: 27.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.8.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | a290e064cd21f68bc0974598d6bf9ef056ca44388e707574e8f740527a504c71 |
|
MD5 | 3d004a06757fc48f9147859f85c4c2db |
|
BLAKE2b-256 | 6801b8964dd6061b4e8cccfdfb40d2d9f7c652d3eaed49e33fd8007121eb20e7 |