質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

ただいまの
回答率

88.83%

Pythonのunittestとmockを組み合わせた際のsetUpの使い方

解決済

回答 1

投稿 編集

  • 評価
  • クリップ 2
  • VIEW 2,332

nakamiri

score 7

 前提・実現したいこと

26.6.3.4. Applying the same patch to every test method
上記ドキュメントを参考に、全てのテストメソッドに同じpatchを当てた状態のインスタンスをsetUp内で生成して、
各テストケースで利用するようなテストを書きたいと思っています。

この時にMockオブジェクトに想定のものが上手く反映されず、
どのように使ったらよいか教えてもらえませんでしょうか。

 発生している問題・エラーメッセージ

setUp内でpather.start()で返されるMockオブジェクトに対して、
以下のように設定をした場合、patchを当てたクラスの方では想定のMockオブジェクトではなく、
何も設定されていないMockオブジェクトが渡っているようです。
(patchを当てたいのはconfigparser.ConfigParserです)

# test_hoge,py
from unittest import TestCase, mock
from libs.hoge import Hoge

class TestHoge(TestCase):

    def setUp(self):
        pathcer = mock.patch('libs.hoge.ConfigParser')
        self.addCleanup(pathcer.stop)
        self.conf_mock = pathcer.start()

        # この辺でMagicMockに諸々の挙動を入れたい
        self.conf_mock.get = mock.MagicMock(side_effect=self._side_effect)
        self.conf_mock.getboolean.return_value = False
        self.conf_mock.getint.return_value = 5

        # ↑で入れたMagicMockを使ってインスタンス化したい
        self.hoge = Hoge()

    def _side_effect(self, section, option):
        return "{0}-{1}".format(section, option)

    def test_test(self):
        a = self.hoge

        # 何かする
# libs/hoge.py
from configparser import ConfigParser
from definitions import CONFIG_PATH

class Hoge(object):

    def __init__(self):
        # このコードで実行するとMagicMockが↑で挙動を入れたものではない、新規のが入ってくるように見える
        conf = ConfigParser()
        conf.read(CONFIG_PATH)

        self.host = conf.get('settings', 'host')
        self.user = conf.get('settings', 'user')
        self.pwd = conf.get('settings', 'pwd')
        self.flag = conf.getboolean('settings', 'flag')
        self.port = conf.getint('settings', 'port')

   def nanka_method(self):
       # ...

 試したこと

関数に対してのpatchは上手くできていました。
他に色々パスを変えたりなどして試してみたのですが、全てうまく行かなかった形でした。
やり方問わずテストケース全体にカジュアルにMockを当てた状態の初期化されたインスタンスを使う方法があれば、
そちらのやり方でも構いませんので教えて頂けるとありがたいです。

 試したこと1

test_hoge.py のコンストラクタ内で以下のようなコードでのMockへの値追加も試しましたが、変わらずでした

# test_hoge.py:__init__
        ConfigParser.get = mock.MagicMock(side_effect=self._side_effect)
        ConfigParser.getboolean.return_value = False
        ConfigParser.getint.return_value = 5

 試したこと2

関数へのMockは以下のような形でやって上手く行っていました。

# test_hoge.py
from unittest import TestCase, mock
from libs.hoge import Hoge

def _side_effect(self, section, option):
    return "{0}-{1}".format(section, option)

class TestHoge(TestCase):

    @mock.patch('libs.hoge.ConfigParser.get', side_effect=_side_effect)
    @mock.patch('libs.hoge.ConfigParser.getboolean', return_value=False)
    @mock.patch('libs.hoge.ConfigParser.getint', return_value=5)
    def test_test(self):
        a = Hoge()

        # 何かする

 試したこと3

関数へのMockですが、この形だと上手く入りませんでした
初期化のタイミングが異なるとかなのでしょうか...?

# test_hoge.py
from unittest import TestCase, mock
from libs.hoge import Hoge

def _side_effect(self, section, option):
    return "{0}-{1}".format(section, option)

class TestHoge(TestCase):

    @mock.patch('libs.hoge.ConfigParser')
    def test_test(self, parser):
        parser.get = mock.MagicMock(side_effect=_side_effect)
        conf_parser.getboolean.return_value = False
        conf_parser.getin.return_value = 5

        a = Hoge()

        # 何かする

 補足情報(FW/ツールのバージョンなど)

  • PyCharm CE 2016.3
  • Python 3.6.5
  • macOS Sierra 10.12.6
  • 気になる質問をクリップする

    クリップした質問は、後からいつでもマイページで確認できます。

    またクリップした質問に回答があった際、通知やメールを受け取ることができます。

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 過去に投稿した質問と同じ内容の質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

回答 1

checkベストアンサー

+2

モック難しいですね。テストケース全体にカジュアルにモックを適用するならテストケースクラス自体をpatch()でデコレートしてあげるとスッキリ書ける気がします。

from configparser import ConfigParser
from io import StringIO
from textwrap import dedent
from unittest import main
from unittest.mock import Mock
from unittest.mock import patch
from unittest import TestCase


class ConfigWrapper(object):
    def __init__(self):
        conf = ConfigParser()
        conf.read_file(StringIO(dedent('''
            [settings]
            host = host
            user = user
            pwd = pwd
        ''')))
        self.host = conf.get('settings', 'host')
        self.user = conf.get('settings', 'user')
        self.pwd = conf.get('settings', 'pwd')


ConfigMock = Mock()
instance = ConfigMock()
instance.get = lambda *args: '-'.join(map(str, args))
instance.getboolean.return_value = False
instance.getint.return_value = 5


@patch(__name__ + '.ConfigParser', new=ConfigMock)
class Test(TestCase):
    def test_settings(self):
        config = ConfigWrapper()
        self.assertEqual(config.host, 'host')


if __name__ == '__main__':
    main()

あとモックを結構作り込むんだったら、普通に自分でモックを書いた方が、モックの使い方に悩むこともなく良いんじゃないかと思いました。

class ConfigMock:
    def read_file(self, *_, **__):
        pass

    def get(self, *args):
        return '-'.join(map(str, args))

    def getboolean(self, *_, **__):
        return False

    def getint(self, *_, **__):
        return 5

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2018/04/09 11:42

    ありがとうございます!
    `ConfigParser` の箇所はライブラリ側でテストがあるので、
    そこ自体の処理をモックでスキップさせたかったので、自分でモックを書くやり方でうまくできました!

    全体にモックを書けるならクラス自体にかけたほうが楽なんですね。
    併せて教えていただきありがとうございます。

    キャンセル

15分調べてもわからないことは、teratailで質問しよう!

  • ただいまの回答率 88.83%
  • 質問をまとめることで、思考を整理して素早く解決
  • テンプレート機能で、簡単に質問をまとめられる

関連した質問

同じタグがついた質問を見る