[Python3 unittest] importしたモジュールをmockで置き換え、assert_called_with()を使いたい

Question

やりたいことは題名の通りです。
より具体的に書くと、次のソースコード中の、orders.OrderCreate()メソッドに渡された引数をテストしたいです。

※ソースコード及びテストコードは、大分簡略化しているので、このままでは動かない可能性があります

テスト対象のソースコード

# target.py

from oandapyV20 import API
import oandapyV20.endpoints.orders as orders


class TargetClass():
    def __init__(self):
        self.__api_client = API(access_token='hoge', environment='practice')

    def target_method(number_str):
        data = {'hoge': int(number_str)}
        # テストしたい部分: このメソッドに渡された引数をテストしたい
        #   data引数に渡された値をテストしたい（実際はめんどうな変換を色々しているが、サンプルとしてinteger型への変換を掲載しています）
        request_obj = orders.OrderCreate(accountID='hoge', data=data)

        response = self.__api_client.request(request_obj)
        return response

試したこと（テストコード）

patch を使って次のようなことを試してみましたが、うまくいきませんでした。

# tests/test_target.py

import target
import unittest
from unittest.mock import patch, MagicMock


class TestClient(unittest.TestCase):
    @classmethod
    def setUpClass(cls):
        cls.__client = target.TargetClass()

    def test_order_args(self):
        data = {'hoge': 111}

        orders_mock = MagicMock()
        with patch('oandapyV20.endpoints.orders', return_value=orders_mock):
            self.__client.target_method('111')

        orders_mock.OrderCreate.assert_called_with('hoge', data)

実行結果

$ pytest tests

# 略

E           AssertionError: expected call not found.
E           Expected: OrderCreate('hoge', {'hoge': 111})
E           Actual: not called.

# 略

not called とあるので、OrderCreateの引数が一致しなかったのではなく、そもそもorders_mock.OrderCreateが呼ばれていないという状態です。
なので、patchの書き方が間違っている、ということまではわかっています。
ですが、どうかけば正しい書き方になるのかがわかっていません。（patchはよく使っているのですが...）

その他

時間がないため、掲載したソースの動作確認をすることが今はできないのですが、動くようにする必要があれば修正したいと思います。

Answer 1

そもそもorders_mock.OrderCreateが呼ばれていないという状態です。

patchのreturn_value が orders_mock を返すようになっていて、
orders_mockからは何も呼ばれていません。

同様に patchのreturn_valueにMagicMock()を指定したコードでエラーを確認後、

• patchの return_value と モック生成 (with patch ... as)
• assert_called_withの引数

にて修正を確認出来ました。

---

patchにrturn_valueを指定する場合

# ※ patch対象はOrderCreate(関数)

# (1) return_value は、orders.OrderCreate 呼び出しで期待する戻り値 
# 必要ならば実際に期待する値に置き換え

# (2) with patch(...) as mock:

with patch('oandapyV20.endpoints.orders.OrderCreate', return_value=111) as mock:
   self.__client.target_method('111')

# (3) キーワード引数
# print(mock.mock_calls) で確認

mock.assert_called_with(accountID='hoge', data=data)

---

モジュールにパッチを充てる場合は

with patch('oandapyV20.endpoints.orders') as orders_mock:
    # 必要ならば、return_valueを設定
    # orders_mock.OrderCreate.return_value = 111
    self.__client.target_method('111')

orders_mock.OrderCreate.assert_called_with(accountID='hoge', data=data)

ライブラリはインストールしてません。
orders.py に関数 OrderCreateを仮実装して動作確認後に、
パッチの文字列を 'oandapyV20.endpoints.orders' に置き換えました。

Comments

[siruku6]

回答ありがとうございます！

モジュールにパッチを充てる場合は 、
　`with patch('module_name', return_value=mock_method):`
ではなく、
　`with patch('module_name') as mock_method:`
なのですね！
（そして、return_valueをつかうときは、また違う書き方になるんですね）

試してみますので、結果報告まで少々お待ちください...

[siruku6]

ありがとうございます！
示していただいたパターンのうち

with patch('oandapyV20.endpoints.orders.OrderCreate', return_value=111) as mock:

の書き方で無事テストすることができました！
大変助かりました。

今後もテストの書き方を学んでいきたいと思います。