![PyPI version](https://badge.fury.io/py/rethinkdb-mock.svg)
RethinkDB Mock
Formerly known as MockThink by Scivey, this is a continuation of that work released under a new name.
Rethinkdb-mock is an in-process Python clone of RethinkDB's API. For testing.
MockThink provides a stub connection object which can be passed to normal ReQL queries. Instead of being serialized and sent to the server, the ReQL AST is run through an interpreter in the same process. "Tables" and "databases" are based on data given to the MockThink constructor.
Avoiding network calls (for tests themselves as well as setup/teardown) makes testing queries with MockThink orders of magnitude faster.
Install
pip install rethinkdb-mock
pipenv install --dev rethinkdb-mock
Usage
Basic
from pprint import pprint
from rethinkdb_mock import MockThink
import rethinkdb as r
db = MockThink({
'dbs': {
'tara': {
'tables': {
'people': [
{'id': 'john-id', 'name': 'John'},
{'id': 'sam-id', 'name': 'Sam'}
]
}
}
}
})
with db.connect() as conn:
result = r.db('tara').table('people').map(
lambda doc: doc.merge({'also_name': doc['name']})
).run(conn)
pprint(list(result))
r.db('tara').table('people').update(
{'likes_fonz': True}
).run(conn)
result = r.db('tara').table('people').run(conn)
pprint(list(result))
with db.connect() as conn:
result = r.db('tara').table('people').run(conn)
pprint(list(result))
Full support for secondary indexes
from pprint import pprint
from rethinkdb_mock import MockThink
import rethinkdb as r
db = MockThink({
'dbs': {
'tara': {
'tables': {
'people': [
{'id': 'john-id', 'first_name': 'John', 'last_name': 'Generic'},
{'id': 'sam-id', 'first_name': 'Sam', 'last_name': 'Dull'},
{'id': 'adam-id', 'first_name': 'Adam', 'last_name': 'Average'}
]
}
}
}
})
with db.connect() as conn:
r.db('tara').table('people').index_create(
'full_name',
lambda doc: doc['last_name'] + doc['first_name']
).run(conn)
r.db('tara').table('people').index_wait().run(conn)
result = r.db('tara').table('people').get_all(
'GenericJohn', 'AverageAdam', index='full_name'
).run(conn)
pprint(list(result))
Testing
The most confusing test failures are those caused by errors in test frameworks and harnesses themselves.
This means they need to be tested very thoroughly.
The main testing is a suite of functional tests which are targeted at the individual query level,
e.g. testing all the ways in which r.merge
might be called.
These are all complete ReQL queries, but avoid complexity beyond the target query to make failures easier to diagnose.
The integration tests cover more complicated queries, e.g. eq_join
->map
->eq_join
->map
.
Both the functional and integration tests have two modes of execution, rethinkdb_mock
and rethink
. The second mode runs the same tests against a running RethinkDB instance, and is much slower due to the network calls. rethinkdb_mock
mode is for testing MockThink's behavior against our expectations; rethink
mode is for testing our expectations against reality.
Run tests
pip install pipenv
pipenv sync --dev
pipenv run test
Run tests against a live server
The docker folder contains a dockerfile that grabs rethinkdb and runs the python tests
Simply running the below command outputs the results
docker-compose up --build
Code formatting
The tox.ini
file contains the configuration for code formatting
pip install pipenv
pipenv sync --dev
pipenv run isort
pipenv run lint
License
The MIT License (MIT)