Pythonのunittest.TestCaseのメソッド　assertLogs

2023年10月15日

unittest.TestCaseには assertLogs というメソッドが存在します。assertLogsアサーションは、指定したロガーが期待通りにログメッセージを生成したかどうかをテストするために使用されます。

以下は、unittest.TestCaseを使用してassertLogsアサーションを含むテストケースの例です：

python
import unittest
import logging

class MyTestCase(unittest.TestCase):
    def test_logging(self):
        logger = logging.getLogger("my_logger")
        with self.assertLogs(logger, level="INFO") as log_context:
            logger.info("これは情報ログメッセージです")
        self.assertEqual(log_context.output, ["INFO:my_logger:これは情報ログメッセージです"])

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

上記の例では、self.assertLogsアサーションを使用して、指定したロガーが指定したログレベルでログメッセージを生成したことを検証しています。log_contextコンテキストマネージャを使用して、ログメッセージをキャプチャし、それが期待通りに生成されたかをテストします。テストは成功するはずで、ログメッセージが期待通りに生成されない場合にはテストが失敗します。

assertLogsアサーションは、ログ処理を含むコードをテストする際に役立ちます。指定したロガーが特定のログメッセージを生成することを確認でき、テストケースが期待通りにログ出力を検証するのに役立ちます。

unittestフレームワークは、さまざまなアサーションメソッドを提供しており、テストケース内でさまざまな条件を検証するのに役立ちます。assertLogsアサーションはその一部です。