Pythonのログをテストで検証する方法

class TestLogging(unittest.TestCase):

def setUp(self):
# ロガーを取得
self.logger = logging.getLogger('my_app')
self.logger.setLevel(logging.DEBUG)

# メモリ上にログをキャプチャするためのハンドラを作成
self.log_stream = StringIO()
self.handler = logging.StreamHandler(self.log_stream)
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
self.handler.setFormatter(formatter)

# 既存のハンドラを削除し、新しいハンドラを追加
if self.logger.hasHandlers():
self.logger.handlers.clear()
self.logger.addHandler(self.handler)

def tearDown(self):
# ハンドラを削除してクリーンアップ
self.logger.removeHandler(self.handler)
self.handler.close()

def test_info_log_output(self):
self.logger.info("This is an informational message.")
# キャプチャされたログの内容を取得
log_output = self.log_stream.getvalue()
self.assertIn("This is an informational message.", log_output)
self.assertIn("INFO", log_output)

def test_error_log_with_exception(self):
try:
result = 1 / 0
except ZeroDivisionError:
self.logger.error("An error occurred during division.", exc_info=True)

log_output = self.log_stream.getvalue()
self.assertIn("An error occurred during division.", log_output)
self.assertIn("ERROR", log_output)
# exc_info=True で例外情報も記録されているか確認することも可能
self.assertIn("ZeroDivisionError", log_output)

class TestLoggingWithPatch(unittest.TestCase):

@patch('logging.getLogger')
def test_log_message_is_called(self, mock_get_logger):
# モックオブジェクトを作成
mock_logger = MagicMock()
mock_get_logger.return_value = mock_logger

# テスト対象の関数やメソッドを呼び出し（ここでログが出力されることを期待）
# 例: logger.info("Some message") のようなログ出力が発生する処理
logging.getLogger('my_app').info("This is a test log.")

# モックされたloggerのinfoメソッドが呼び出されたことを確認
mock_logger.info.assert_called_once_with("This is a test log.")

@patch('logging.Logger.error')
def test_error_handling_logs_correctly(self, mock_error_method):
# エラーが発生する処理をシミュレート
def process_data():
try:
# エラーを引き起こす処理
1 / 0
except Exception as e:
logging.getLogger('my_app').error(f"Error processing data: {e}", exc_info=True)

process_data()

# errorメソッドが特定のメッセージとともに呼び出されたことを確認
# exc_info=True の場合、引数はタプルになることがあるため、より柔軟なチェックが必要
mock_error_method.assert_called_once()
call_args, call_kwargs = mock_error_method.call_args
message = call_args[0]
self.assertIn("Error processing data", message)
self.assertIn("ZeroDivisionError", message)
self.assertTrue(call_kwargs.get('exc_info', False))

class LogCaptureHandler(logging.Handler):
def __init__(self):
super().__init__()
self.stream = StringIO()
self.formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
self.setFormatter(self.formatter)

def emit(self, record):
self.stream.write(self.format(record) + 'n')

def get_logs(self):
return self.stream.getvalue()

def close(self):
self.stream.close()
super().close()

class BaseLoggingTest(unittest.TestCase):
def setUp(self):
self.logger = logging.getLogger('my_app')
self.logger.setLevel(logging.DEBUG)
self.log_capture_handler = LogCaptureHandler()
if self.logger.hasHandlers():
self.logger.handlers.clear()
self.logger.addHandler(self.log_capture_handler)

def tearDown(self):
self.logger.removeHandler(self.log_capture_handler)
self.log_capture_handler.close()

def assertLogContains(self, message_part):
logs = self.log_capture_handler.get_logs()
self.assertIn(message_part, logs)

def assertLogError(self, message_part):
logs = self.log_capture_handler.get_logs()
self.assertIn(f"ERROR - {message_part}", logs)

class MyFeatureTests(BaseLoggingTest):
def test_feature_logs_successfully(self):
# テスト対象のコードでログを出力
self.logger.info("Feature X started.")
# ... Feature X の処理 ...
self.logger.info("Feature X completed successfully.")

self.assertLogContains("Feature X started.")
self.assertLogContains("Feature X completed successfully.")

def test_feature_handles_error_with_log(self):
# エラーが発生する処理
try:
raise ValueError("Something went wrong in feature X")
except ValueError as e:
self.logger.error(f"Error in Feature X: {e}", exc_info=True)

self.assertLogContains("Error in Feature X")
self.assertLogError("Error in Feature X")