SQLAlchemy mock helpers.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
alchemy_mock unifying limit call Oct 3, 2018
.coveragerc
.editorconfig initial commit Jan 12, 2018
.gitignore
.importanizerc fixed handling of iterables in UnifiedAlchemyMagicMock Jan 13, 2018
.travis.yml initial commit Jan 12, 2018
AUTHORS.rst bumping version to 0.3.1 Mar 28, 2018
HISTORY.rst unifying limit call Oct 3, 2018
LICENSE.rst initial commit Jan 12, 2018
MANIFEST.in initial commit Jan 12, 2018
Makefile
README.rst fixed incorrect description in README [ci skip] Jan 14, 2018
requirements-dev.txt initial commit Jan 12, 2018
requirements.txt initial commit Jan 12, 2018
setup.cfg
setup.py initial commit Jan 12, 2018
tox.ini ignoring doctest exception details Jan 24, 2018

README.rst

SQLAlchemy Mock

https://badge.fury.io/py/alchemy-mock.png https://travis-ci.org/miki725/alchemy-mock.png?branch=master https://coveralls.io/repos/miki725/alchemy-mock/badge.png?branch=master

SQLAlchemy mock helpers.

Installing

You can install alchemy-mock using pip:

$ pip install alchemy-mock

Why?

SQLAlchemy is awesome. Unittests are great. Accessing DB during tests - not so much. This library provides easy way to mock SQLAlchemy's session in unittests while preserving ability to do sane asserts. Normally SQLAlchemy's expressions cannot be easily compared as comparison on binary expression produces yet another binary expression:

>>> type((Model.foo == 5) == (Model.bar == 5))
<class 'sqlalchemy.sql.elements.BinaryExpression'>

But they can be compared with this library:

>>> ExpressionMatcher(Model.foo == 5) == (Model.bar == 5)
False

Using

ExpressionMatcher can be directly used:

>>> from alchemy_mock.comparison import ExpressionMatcher
>>> ExpressionMatcher(Model.foo == 5) == (Model.foo == 5)
True

Alternatively AlchemyMagicMock can be used to mock out SQLAlchemy session:

>>> from alchemy_mock.mocking import AlchemyMagicMock
>>> session = AlchemyMagicMock()
>>> session.query(Model).filter(Model.foo == 5).all()

>>> session.query.return_value.filter.assert_called_once_with(Model.foo == 5)

In real world though session can be interacted with multiple times to query some data. In those cases UnifiedAlchemyMagicMock can be used which combines various calls for easier assertions:

>>> from alchemy_mock.mocking import UnifiedAlchemyMagicMock
>>> session = UnifiedAlchemyMagicMock()

>>> m = session.query(Model)
>>> q = m.filter(Model.foo == 5)
>>> if condition:
...     q = q.filter(Model.bar > 10).all()
>>> data1 = q.all()
>>> data2 = m.filter(Model.note == 'hello world').all()

>>> session.filter.assert_has_calls([
...     mock.call(Model.foo == 5, Model.bar > 10),
...     mock.call(Model.note == 'hello world'),
... ])

Also real-data can be stubbed by criteria:

>>> from alchemy_mock.mocking import UnifiedAlchemyMagicMock
>>> session = UnifiedAlchemyMagicMock(data=[
...     (
...         [mock.call.query(Model),
...          mock.call.filter(Model.foo == 5, Model.bar > 10)],
...         [Model(foo=5, bar=11)]
...     ),
...     (
...         [mock.call.query(Model),
...          mock.call.filter(Model.note == 'hello world')],
...         [Model(note='hello world')]
...     ),
...     (
...         [mock.call.query(AnotherModel),
...          mock.call.filter(Model.foo == 5, Model.bar > 10)],
...         [AnotherModel(foo=5, bar=17)]
...     ),
... ])
>>> session.query(Model).filter(Model.foo == 5).filter(Model.bar > 10).all()
[Model(foo=5, bar=11)]
>>> session.query(Model).filter(Model.note == 'hello world').all()
[Model(note='hello world')]
>>> session.query(AnotherModel).filter(Model.foo == 5).filter(Model.bar > 10).all()
[AnotherModel(foo=5, bar=17)]
>>> session.query(AnotherModel).filter(Model.note == 'hello world').all()
[]