pytest-redis 1.0.0

pytest-redis

Package 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

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

CHANGELOG

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