pytest-redis
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 three fixtures
-
- redisdb - This is a redis client fixture. It constructs a redis client and cleans redis database after the test.
- It relies on redis_proc fixture, and as such the redis process is started at the very beginning of the first test using this fixture, and stopped after the last test finishes.
- redis_proc - session scoped fixture, that starts Redis instance at it's first use and stops at the end of the tests.
- redis_nooproc - a nooprocess fixture, that's connecting to already running redis
Simply include one of these fixtures into your tests fixture list.
#
def test_redis(redisdb):
"""Check that it's actually working on redis database."""
redisdb.set('test1', 'test')
redisdb.set('test2', 'test')
my_functionality = MyRedisBasedComponent()
my_functionality.do_something()
assert my_functionality.did_something
assert redisdb.get("did_it") == 1
For the example above works like following:
- pytest runs tests
- redis_proc starts redis database server
- redisdb creates client connection to the server
- test itself runs and finishes
- redisdb cleans up the redis
- redis_proc stops server (if that was the last test using it)
- pytest ends running tests
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)
redis_my = factories.redisdb('redis_my_proc')
def test_my_redis(redis_my):
"""Check that it's actually working on redis database."""
redis_my.set('test1', 'test')
redis_my.set('test2', 'test')
my_functionality = MyRedisBasedComponent()
my_functionality.do_something()
assert my_functionality.did_something
assert redis_my.get("did_it") == 1
Note
Each Redis process fixture can be configured in a different way than the others through the fixture factory arguments.
Connecting to already existing redis database
Some projects are using already running redis servers (ie on docker instances). In order to connect to them, one would be using the redis_nooproc fixture.
redis_external = factories.redisdb('redis_nooproc')
def test_redis(redis_external):
"""Check that it's actually working on redis database."""
redis_external.set('test1', 'test')
redis_external.set('test2', 'test')
my_functionality = MyRedisBasedComponent()
my_functionality.do_something()
assert my_functionality.did_something
assert redis_external.get("did_it") == 1
By default the redis_nooproc fixture would connect to Redis instance using 6379 port. Standard configuration options apply to it.
These are the configuration options that are working on all levels with the redis_nooproc fixture:
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:
Configuration options
Fixture factory argumentCommand line optionConfiguration option in your pytest.ini file
| Redis server option | Fixture factory argument | Command line option | pytest.ini option | Noop process fixture | Default |
|---|---|---|---|---|---|
| executable | executable | --redis-exec | redis_exec |
|
/usr/bin/redis-server |
| host | host | --redis-host | redis_host | host | 127.0.0.1 |
| port | port | --redis-port | redis_port | 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 |
| 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 |
|
"" |
| Redis test instance data directory path | datadir | --redis-datadir | redis_datadir |
|
"" |
Example usage:
pass it as an argument in your own fixture
redis_proc = factories.redis_proc(port=8888)
use
--redis-portcommand line option when you run your testspy.test tests --redis-port=8888
specify your port as
redis_portin yourpytest.inifile.To do so, put a line like the following under the
[pytest]section of yourpytest.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 |
Package resources
- Bug tracker: https://github.com/ClearcodeHQ/pytest-redis/issues
299 Dec 24, 2022
354 Feb 17, 2021
12 Dec 4, 2022
1 Jul 11, 2022
11 Nov 8, 2022
21 Nov 1, 2022
2 Aug 20, 2022
170 Dec 2, 2022
9 Dec 9, 2022
1k Jan 3, 2023
871 Dec 25, 2022
3k Jan 5, 2023
909 Dec 15, 2022