web-dev-qa-db-ja.com

Flaskで<ModelClass> .query.filter_by（）をモックする方法-SqlAlchemy

簡単に言えば

Flask-SqlAlchemyでモデルクラスをテストする場合、モックされたモデルオブジェクトのリストを返すように、メソッド.query.filter_by()をどのようにモックできますか？

全詳細

以下のコードのようなモデルクラスがあるとしましょう

_from flask.ext.sqlalchemy import SQLAlchemy
db = SQLAlchemy()
class SomeModel(db.Model):
    # more column mapping and methods go here
_

次に、Flaskコードで

_SomeModel.query.filter_by(...)
_

テストコードでは、 Python unittest model with mocking を使用して、filter_by()呼び出しをモックして、モデルオブジェクトのリストを返します。設計されたテストケース。

どうすればそれに到達できますか？

p.s.

私のグーグル検索は この関連記事 ;しか見つかりませんでした。クラスの最初に@patch("flask_sqlalchemy.SignallingSession", autospec=True)を適用しても、私にはうまくいきません。

また、以下のコードスニペットのように関数をモックしようとしました

_@patch('app.model.some_model.SomeModel.query.filter_by')
def test_some_case(self, filterbyMOCK):
    # more test logic goes here
_

開始するとコードはすぐにエラーになります

_RuntimeError: application not registered on db instance and no application bound to current context
_

以下のスナップショットとして、PyCharm IDEからの完全なエラー。

_Traceback (most recent call last):
  File "/home/namgivu/NN/code/someproject-cloud/venv/local/lib/python2.7/site-packages/mock/mock.py", line 1297, in patched
    arg = patching.__enter__()
  File "/home/namgivu/NN/code/someproject-cloud/venv/local/lib/python2.7/site-packages/mock/mock.py", line 1353, in __enter__
    self.target = self.getter()
  File "/home/namgivu/NN/code/someproject-cloud/venv/local/lib/python2.7/site-packages/mock/mock.py", line 1523, in <lambda>
    getter = lambda: _importer(target)
  File "/home/namgivu/NN/code/someproject-cloud/venv/local/lib/python2.7/site-packages/mock/mock.py", line 1210, in _importer
    thing = _dot_lookup(thing, comp, import_path)
  File "/home/namgivu/NN/code/someproject-cloud/venv/local/lib/python2.7/site-packages/mock/mock.py", line 1197, in _dot_lookup
    return getattr(thing, comp)
  File "/home/namgivu/NN/code/someproject-cloud/venv/local/lib/python2.7/site-packages/flask_sqlalchemy/__init__.py", line 428, in __get__
    return type.query_class(mapper, session=self.sa.session())
  File "/home/namgivu/NN/code/someproject-cloud/venv/local/lib/python2.7/site-packages/sqlalchemy/orm/scoping.py", line 78, in __call__
    return self.registry()
  File "/home/namgivu/NN/code/someproject-cloud/venv/local/lib/python2.7/site-packages/sqlalchemy/util/_collections.py", line 990, in __call__
    return self.registry.setdefault(key, self.createfunc())
  File "/home/namgivu/NN/code/someproject-cloud/venv/local/lib/python2.7/site-packages/flask_sqlalchemy/__init__.py", line 136, in __init__
    self.app = db.get_app()
  File "/home/namgivu/NN/code/someproject-cloud/venv/local/lib/python2.7/site-packages/flask_sqlalchemy/__init__.py", line 809, in get_app
    raise RuntimeError('application not registered on db '
RuntimeError: application not registered on db instance and no application bound to current context
_
pythonflasksqlalchemymockingpython-unittest
12
Nam G VU

マッパークラス全体をモックする必要があります。マッパーのquery属性にアクセスすると、セッションがロードされます。

@patch('app.model.some_model.SomeModel')
def test_some_case(self, some_model_mock):
    filter_by_mock = some_model_mock.query.filter_by
    # more test logic goes here

.query属性は記述子オブジェクトです。これにアクセスすると、セッションへのバインドがトリガーされます。

別の方法は、 _QueryProperty.__get__メソッド （これは.query属性）;これは、実際のSomeModelインスタンスでmustテストする場合にのみ使用してください。

@patch('flask_sqlalchemy._QueryProperty.__get__')
def test_some_case(self, query_property_getter_mock):
    filter_by_mock = query_property_getter_mock.return_value.filter_by
    # more test logic goes here

デモ：

>>> from flask_sqlalchemy import SQLAlchemy
>>> db = SQLAlchemy()
>>> class SomeModel(db.Model):
...     id = db.Column(db.Integer, primary_key=True)
...
>>> from unittest import mock
>>> with mock.patch('__main__.SomeModel') as model_mock:
...     filter_by = model_mock.query.filter_by
...     SomeModel.query.filter_by(SomeModel.id == 'foo')
...
<MagicMock name='SomeModel.query.filter_by()' id='4438980312'>
>>> with mock.patch('flask_sqlalchemy._QueryProperty.__get__') as query_property_getter_mock:
...     filter_by_mock = query_property_getter_mock.return_value.filter_by
...     SomeModel.query.filter_by(SomeModel.id == 'foo')
...
<MagicMock name='__get__().filter_by()' id='4439035184'>
9
Martijn Pieters

Martijn Pietersの回答 からの要約

目標

  • .query.filter_by().all()の結果をモックしたい。 SomeModel.query.filter_by().all()

コード01

@patch('flask_sqlalchemy._QueryProperty.__get__')
def test (
  self,
  queryMOCK,
):

  #setup
  queryMOCK\
    .return_value.filter_by\
    .return_value.all\
    .return_value = [1,22] #empty list of current product_id

  #get actual
  modelObj = SomeModel.query.filter_by().all()
  print(modelObj)

コード02-上記と同様で、withを使用します

def test(self):
  with patch('flask_sqlalchemy._QueryProperty.__get__') as queryMOCK      #setup
    queryMOCK\
      .return_value.filter_by\
      .return_value.all\
      .return_value = [1,22] #empty list of current product_id

    #get actual
    modelObj = SomeModel.query.filter_by().all()
    print(modelObj)
4
Nam G VU