Skip to main content

SQLAlchemy mock helpers.

Project description

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()
[]

History

0.3.1 (2018-03-28)

  • Added support for func calls in ExpressionMatcher. For example func.lower(column).

0.3.0 (2018-01-24)

  • Added support for .one() and .first() methods when stubbing data.

  • Fixed bug which incorrectly unified methods after iterating on mock.

0.2.0 (2018-01-13)

  • Added ability to stub real-data by filtering criteria. See #2.

0.1.1 (2018-01-12)

  • Fixed alembic typo in README. oops.

0.1.0 (2018-01-12)

  • First release on PyPI.

Credits

Development Lead

Contributors

License

The MIT License (MIT)

Copyright (c) 2018, Miroslav Shubernetskiy

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

Project details


Download files

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

Source Distribution

alchemy-mock-0.3.1.tar.gz (9.4 kB view details)

Uploaded Source

Built Distribution

alchemy_mock-0.3.1-py2.py3-none-any.whl (13.3 kB view details)

Uploaded Python 2Python 3

File details

Details for the file alchemy-mock-0.3.1.tar.gz.

File metadata

  • Download URL: alchemy-mock-0.3.1.tar.gz
  • Upload date:
  • Size: 9.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for alchemy-mock-0.3.1.tar.gz
Algorithm Hash digest
SHA256 7e16e8e64f92cb6ea717f57f6141a7cca0867e8620bda9bb5c02814e1cf13bee
MD5 7347dbc7f91ef07bf6e16392e5d1f5fd
BLAKE2b-256 39f75e1fc4b75794772d2f50a457bf455ff0483475942180afad3859ce282de6

See more details on using hashes here.

File details

Details for the file alchemy_mock-0.3.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for alchemy_mock-0.3.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 438eb2b2ed0e6bf20a6a728143dcc0e9839f455d929d2dcbda96bc189eb6a693
MD5 7cec3cbbc59dcbcdf8b82e851cb4d187
BLAKE2b-256 d0e785cea3aa28defde1dc67d0d9c0bbac015e6b35cbf2e5933f91736439f831

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page