Skip to content

Commit

Permalink
Access captures logs in teardown
Browse files Browse the repository at this point in the history
  • Loading branch information
boxed committed Jan 19, 2018
1 parent 01e37fe commit b9fb1cb
Show file tree
Hide file tree
Showing 4 changed files with 35 additions and 0 deletions.
1 change: 1 addition & 0 deletions AUTHORS
Expand Up @@ -9,6 +9,7 @@ Ahn Ki-Wook
Alexander Johnson
Alexei Kozlenok
Anatoly Bubenkoff
Anders Hovmöller
Andras Tim
Andreas Zeidler
Andrzej Ostrowski
Expand Down
12 changes: 12 additions & 0 deletions _pytest/logging.py
Expand Up @@ -128,6 +128,13 @@ def __init__(self, item):
def handler(self):
return self._item.catch_log_handler

def get_handler(self, when):
"""
Get the handler for a specified state of the tests.
Valid values for the when parameter are: 'setup', 'call' and 'teardown'.
"""
return self._item.catch_log_handlers.get(when)

@property
def text(self):
"""Returns the log text."""
Expand Down Expand Up @@ -287,11 +294,16 @@ def _runtest_for(self, item, when):
"""Implements the internals of pytest_runtest_xxx() hook."""
with catching_logs(LogCaptureHandler(),
formatter=self.formatter) as log_handler:
if not hasattr(item, 'catch_log_handlers'):
item.catch_log_handlers = {}
item.catch_log_handlers[when] = log_handler
item.catch_log_handler = log_handler
try:
yield # run test
finally:
del item.catch_log_handler
if when == 'teardown':
del item.catch_log_handlers

if self.print_logs:
# Add a captured log section to the report.
Expand Down
1 change: 1 addition & 0 deletions changelog/3117.feature
@@ -0,0 +1 @@
New member on the `_item` member of the `caplog` fixture: `catch_log_handlers`. This contains a dict for the logs for the different stages of the test (setup, call, teardown). So to access the logs for the setup phase in your tests you can get to them via `caplog._item.catch_log_handlers`.
21 changes: 21 additions & 0 deletions testing/logging/test_fixture.py
@@ -1,6 +1,7 @@
# -*- coding: utf-8 -*-
import logging

import pytest

logger = logging.getLogger(__name__)
sublogger = logging.getLogger(__name__ + '.baz')
Expand Down Expand Up @@ -68,3 +69,23 @@ def test_clear(caplog):
assert len(caplog.records)
caplog.clear()
assert not len(caplog.records)


@pytest.fixture
def logging_during_setup_and_teardown(caplog):
logger.info('a_setup_log')
yield
logger.info('a_teardown_log')
assert [x.message for x in caplog.get_handler('teardown').records] == ['a_teardown_log']


def test_caplog_captures_for_all_stages(caplog, logging_during_setup_and_teardown):
assert not caplog.records
assert not caplog.get_handler('call').records
logger.info('a_call_log')
assert [x.message for x in caplog.get_handler('call').records] == ['a_call_log']

assert [x.message for x in caplog.get_handler('setup').records] == ['a_setup_log']

# This reachers into private API, don't use this type of thing in real tests!
assert set(caplog._item.catch_log_handlers.keys()) == {'setup', 'call'}

0 comments on commit b9fb1cb

Please sign in to comment.