This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

Redis fixtures and fixture factories for Pytest.

Project Description

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

  • redisdb - 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')

Note

Each RabbitMQ process fixture can be configured in a different way than the others through the fixture factory arguments.

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 server 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
Whether to enable logging to the system logger syslog –redis-syslog redis_syslog False
Log directory location logsdir –redis-logsdir redis_logsdir $TMPDIR
Redis log verbosity level loglevel –redis-loglevel redis_loglevel notice
Compress dump files compress –redis-compress redis_compress True
Add checksum to RDB files checksum –redis-rdbcompress redis_rdbchecksum False
Save configuration save –redis-save redis_save “”

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
    

Options below are for configuring redis client fixture.

Redis client option Fixture factory argument Command line option pytest.ini option Default
decode_response decode –redis-decode redis_decode False

CHANGELOG

1.3.2

  • [bugfix] - close file descriptor when reading redis version (by brunsgaard)

1.3.1

  • [bugfix] do not run redis explicitly with shell=True

1.3.0

  • [enhancement] RedisExecutor now provides attribute with path to unixsocket
  • [enhancement] redis client fixture now connects to redis through unixsocket by default
  • [enhancement] Version check got moved to executor, to be run just before starting Redis Server
  • [feature] ability to configure decode_responses for redis client in command line, pytest.ini or factory argument.
  • [bugfix] set decode_responses to False, same as StrictRedis default
  • [enhancement] ability to change decode_responses value

1.2.1

  • [bugfix] raise specific error in case the redis executable path has been misconfigured or does not exists

1.2.0

  • [feature] ability to configure syslog-enabled for redis in command line, pytest.ini or factory argument.
  • [feature] ability to configure rdbchecksum for redis in command line, pytest.ini or factory argument.
  • [feature] ability to configure rdbcompression for redis in command line, pytest.ini or factory argument.
  • [ehnacement] - RedisExecutor handling parameters and their translation to redis values if needed.
  • [feature] ability to configure save option for redis in command line, pytest.ini or factory argument.

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
Release History

Release History

This version
History Node

1.3.2

History Node

1.3.1

History Node

1.3.0

History Node

1.2.1

History Node

1.2.0

History Node

1.1.1

History Node

1.1.0

History Node

1.0.0

Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
pytest_redis-1.3.2-py2.py3-none-any.whl (15.8 kB) Copy SHA256 Checksum SHA256 py2.py3 Wheel May 28, 2017
pytest-redis-1.3.2.tar.gz (11.9 kB) Copy SHA256 Checksum SHA256 Source May 28, 2017

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting