Pythonでunittest.mockを利用してテストを書く方法を現役エンジニアが解説【初心者向け】

Pythonでunittest.mockを利用してテストを書く方法について、TechAcademyのメンター（現役エンジニア）が実際のコードを使用して、初心者向けに解説します。

Pythonについてそもそもよく分からないという方は、Pythonとは何なのか解説した記事を読むとさらに理解が深まります。

 

なお本記事は、TechAcademyのオンラインブートキャンプ、Python講座の内容をもとに紹介しています。

 

 

unittest.mockとは

unittestは、Pythonでユニットテスト(単体テスト)を行うためのモジュールです。ユニットテストを行うと、プログラムの品質を確保でき、コードの再利用性が向上します。

unittest.mockは、モックを用いたユニットテストを行うためのモジュールです。モック(mock)とは模型の意味です。ソフトウェアテストの分野では、本物と似た挙動を示すテスト用の部品を指します。

unittest.mockの使い方

以下のようにオブジェクトそのものや、オブジェクトの一部属性をモックに置き換えます。

メソッドを置き換える場合には、引数や戻り値など、モックの振る舞いも細かく制御できます。また、モックはモック自身に対する操作を記録しているので、操作内容が意図したものか検証(assert)するようなテストも実装できます。

import unittest.mock
obj1 = unittest.mock.MagicMock() # オブジェクトそのものをモックに置き換える場合
obj2.method = unittest.mock.MagicMock() # オブジェクトのメンバ変数をモックに置き換える場合

 

[PR] 未経験からWebエンジニアを目指す方法とは

実際に書いてみよう

サンプルコード

以下内容のbook.pyがあるとします。本と本棚を示すようなクラスです。BookShelfクラスは実装済ですが、Bookクラスは未実装です。

#class Book:
#    def __init__(self, title, author):
#        self._title = title
#        self._author = author
#    
#    def getTitle(self):
#        return self._title
#
#    def getAuthor(self):
#        return self._author

class BookShelf:
    def __init__(self):
        self._books = []

    def addBook(self, book):
        self._books.append(book)

    def listBooks(self):
        for b in self._books:
            title = b.getTitle()
            author = b.getAuthor()
            print(f'Title:{title}, Author:{author}')

以下内容のbook_test.pyがあるとします。book.pyをテストするためのコードです。Bookクラスが未実装のため、そのままではテストを十分に行えません。

このようなケースでも、下記のようにBookクラスの代わりにMagicMockクラスを用いると、BookShelfクラスをテストできます。

import unittest
import unittest.mock

import book

class TestBookShelf(unittest.TestCase):
    def testBookShelf(self):
        bookShelf = book.BookShelf()

        # 本来はBookクラスを使いたいが、まだ実装していない
        # book1 = book.Book(...)
        # book2 = book.Book(...)

        # 代わりにMagicMockクラスを使う
        book1 = unittest.mock.MagicMock()
        book2 = unittest.mock.MagicMock()
        bookShelf.addBook(book1)
        bookShelf.addBook(book2)
        bookShelf.listBooks()

        # book1, book2に対し、どのようなメソッド呼び出しがおこなわれたか確認する
        print(book1.method_calls)
        print(book2.method_calls)

if __name__ == '__main__':
    unittest.main()

 

実行結果

Title:<MagicMock name='mock.getTitle()' id='2335218843832'>, Author:<MagicMock name='mock.getAuthor()' id='2335218868856'>
Title:<MagicMock name='mock.getTitle()' id='2335218926984'>, Author:<MagicMock name='mock.getAuthor()' id='2335218956104'>
[call.getTitle(), call.getAuthor()]
[call.getTitle(), call.getAuthor()]
.
----------------------------------------------------------------------
Ran 1 test in 0.003s

OK

 

解説

Bookクラスを実装していない段階でも、BookShelfクラスの挙動をテストできました。MagicMockクラスが各種メソッドの呼び出しを記録するので、プログラムの実行履歴を追跡できました。

まとめ

 

監修してくれたメンター

橋本紘希（はしもとひろき） システムインテグレータ企業勤務のシステムエンジニア。 開発実績: Javaプログラムを用いた業務用Webアプリケーションや、基幹システム用バッチアプリケーションなどの設計構築試験。

 

 

TechAcademyでは、初心者でも、Pythonを使った人工知能（AI）や機械学習の基礎を習得できる、オンラインブートキャンプを開催しています。

また、現役エンジニアから学べる無料体験も実施しているので、ぜひ参加してみてください。