Skip to main content

Redis fixtures and fixture factories for Pytest.

Project description

pytest-redis

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 Redis database. It allows you to specify additional fixtures for Redis process and client.

How to use

Plugin contains two fixtures

  • redis - it’s a client fixture that has functional scope. After each test, it cleans Redis database for more reliable tests.

  • redis_proc - session scoped fixture, that starts Redis 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 redis client and process fixtures if you’d need to:

from pytest_redis import factories

redis_my_proc = factories.redis_proc(port=None, logsdir='/tmp')
redis_my = factories.redis('redis_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

Redis option

Fixture factory argument

Command line option

pytest.ini option

Default

executable

executable

–redis-exec

redis_exec

/usr/bin/redis-server

host

host

–redis-host

redis_host

127.0.0.1

port

port

–redis-port

redis_port

random

connection timeout

timeout

–redis-timeout

redis_timeout

30

number of databases

db_count

–redis-db-count

redis_db_count

8

Log directory location

logsdir

–redis-logsdir

redis_logsdir

$TMPDIR

Redis log verbosity level

loglevel

–redis-loglevel

redis_loglevel

notice

Example usage:

  • pass it as an argument in your own fixture

    redis_proc = factories.redis_proc(port=8888)
  • use --redis-port command line option when you run your tests

    py.test tests --redis-port=8888
  • specify your port as redis_port in your pytest.ini file.

    To do so, put a line like the following under the [pytest] section of your pytest.ini:

    [pytest]
    redis_port = 8888

Package resources

CHANGELOG

1.1.1

  • [cleanup] removed path.py dependency

1.1.0

  • [feature] - migrate usage of getfuncargvalue to getfixturevalue. require at least pytest 3.0.0

1.0.0

  • [enhancements] removed the possibility to pass the custom config. No need to include one in package now.

  • [enhancements] command line, pytest.ini and fixture factory options for setting custom number of databases in redis

  • [enhancements] command line, pytest.ini and fixture factory options for redis log verbosity

  • [enhancements] command line, pytest.ini and fixture factory options for modifying connection timeout

  • [enhancements] command line and pytest.ini options for modifying executable

  • [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-redis-1.1.1.tar.gz (8.8 kB view details)

Uploaded Source

Built Distribution

pytest_redis-1.1.1-py2.py3-none-any.whl (12.3 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file pytest-redis-1.1.1.tar.gz.

File metadata

File hashes

Hashes for pytest-redis-1.1.1.tar.gz
Algorithm Hash digest
SHA256 ce6c3813b774ae32b89c9087e6240f2dcadf3ee218f06cac7c5db46773886d35
MD5 49e8857f1c6381f9b5ec8982c030c850
BLAKE2b-256 5b6e1734595c73032017b4a88816f3a4dad98d8c8be4d1a7aee5fd55803ac026

See more details on using hashes here.

File details

Details for the file pytest_redis-1.1.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for pytest_redis-1.1.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 4a6515c609b9d7233c748d3bb13349afd3225d310dacf168c45da59d233a8b9c
MD5 abc5faf3931700cd33bd26e81c76f410
BLAKE2b-256 3e20c6ac096e6e51588919dbaf8c56caab56f241db124a3b199f21126a2fc1bb

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