Merge pull request #43 from s0undt3ch/features/auto-logging

Automated logs reporting for pytest >= 3.3

Author: krasoffski

pytest_reportportal/listener.py

@@ -1,18 +1,37 @@
 import cgi
 import pytest
+import logging
 
 from .service import PyTestService
 
+try:
+    # This try/except can go away once we support pytest >= 3.3
+    import _pytest.logging
+    PYTEST_HAS_LOGGING_PLUGIN = True
+    from .rp_logging import RPLogHandler, patching_logger_class
+except ImportError:
+    PYTEST_HAS_LOGGING_PLUGIN = False
+
 
 class RPReportListener(object):
-    def __init__(self):
+    def __init__(self, log_level=logging.NOTSET):
         # Test Item result
         self.result = None
+        self._log_level = log_level
+        if PYTEST_HAS_LOGGING_PLUGIN:
+            self._log_handler = RPLogHandler(log_level, filter_reportportal_client_logs=True)
 
     @pytest.hookimpl(hookwrapper=True)
     def pytest_runtest_protocol(self, item):
         PyTestService.start_pytest_item(item)
-        yield
+        if PYTEST_HAS_LOGGING_PLUGIN:
+            # This check can go away once we support pytest >= 3.3
+            with patching_logger_class():
+                with _pytest.logging.catching_logs(self._log_handler,
+                                                   level=self._log_level):
+                    yield
+        else:
+            yield
         PyTestService.finish_pytest_item(self.result or 'SKIPPED')
 
     @pytest.hookimpl(hookwrapper=True)

pytest_reportportal/plugin.py

@@ -6,6 +6,13 @@
 from .service import PyTestService
 from .listener import RPReportListener
 
+try:
+    # This try/except can go away once we support pytest >= 3.3
+    import _pytest.logging
+    PYTEST_HAS_LOGGING_PLUGIN = True
+except ImportError:
+    PYTEST_HAS_LOGGING_PLUGIN = False
+
 
 def pytest_sessionstart(session):
     if session.config.getoption('--collect-only', default=False) is True:
@@ -45,7 +52,18 @@ def pytest_configure(config):
             "pytest report portal is not compatible with 'xdist' plugin.")
 
     # set Pytest_Reporter and configure it
-    config._reporter = RPReportListener()
+
+    if PYTEST_HAS_LOGGING_PLUGIN:
+        # This check can go away once we support pytest >= 3.3
+        try:
+            config._reporter = RPReportListener(
+                _pytest.logging.get_actual_log_level(config, 'rp_log_level')
+            )
+        except TypeError:
+            # No log level set either in INI or CLI
+            config._reporter = RPReportListener()
+    else:
+        config._reporter = RPReportListener()
 
     if hasattr(config, '_reporter'):
         config.pluginmanager.register(config._reporter)
@@ -69,6 +87,19 @@ def pytest_addoption(parser):
         dest='rp_launch',
         help='Launch name (overrides rp_launch config option)')
 
+    if PYTEST_HAS_LOGGING_PLUGIN:
+        group.addoption(
+            '--rp-log-level',
+            dest='rp_log_level',
+            default=logging.NOTSET,
+            help='Logging level for automated log records reporting'
+        )
+        parser.addini(
+            'rp_log_level',
+            default=logging.NOTSET,
+            help='Logging level for automated log records reporting'
+        )
+
     parser.addini(
         'rp_uuid',
         help='UUID')

pytest_reportportal/rp_logging.py

@@ -1,5 +1,7 @@
 import sys
 import logging
+from contextlib import contextmanager
+from functools import wraps
 
 from .service import PyTestService
 
@@ -48,8 +50,19 @@ class RPLogHandler(logging.Handler):
     }
     _sorted_levelnos = sorted(_loglevel_map.keys(), reverse=True)
 
-    def __init__(self, level=logging.NOTSET):
+    def __init__(self, level=logging.NOTSET,
+                 filter_reportportal_client_logs=False):
         super(RPLogHandler, self).__init__(level)
+        self.filter_reportportal_client_logs = filter_reportportal_client_logs
+
+    def filter(self, record):
+        if self.filter_reportportal_client_logs is False:
+            return True
+        if record.name.startswith('reportportal_client'):
+            # Don't send reportportal_client logs.
+            # Specially because we'll hit a max recursion issue
+            return False
+        return True
 
     def emit(self, record):
         msg = ''
@@ -70,3 +83,52 @@ def emit(self, record):
             loglevel=self._loglevel_map[level],
             attachment=record.__dict__.get('attachment', None),
         )
+
+
+@contextmanager
+def patching_logger_class():
+    logger_class = logging.getLoggerClass()
+    original_log = logger_class._log
+    original_makeRecord = logger_class.makeRecord
+
+    try:
+        def wrap_log(original_func):
+            @wraps(original_func)
+            def _log(self, *args, **kwargs):
+                attachment = kwargs.pop('attachment', None)
+                if attachment is not None:
+                    kwargs.setdefault('extra', {}).update(
+                        {'attachment': attachment})
+                return original_func(self, *args, **kwargs)
+            return _log
+
+        def wrap_makeRecord(original_func):
+            @wraps(original_func)
+            def makeRecord(self, name, level, fn, lno, msg, args, exc_info,
+                           func=None, extra=None, sinfo=None):
+                if extra is not None:
+                    attachment = extra.pop('attachment', None)
+                else:
+                    attachment = None
+                try:
+                    # Python 3.5
+                    record = original_func(self, name, level, fn, lno, msg,
+                                           args, exc_info, func=func,
+                                           extra=extra, sinfo=sinfo)
+                except TypeError:
+                    # Python 2.7
+                    record = original_func(self, name, level, fn, lno, msg,
+                                           args, exc_info, func=func,
+                                           extra=extra)
+                record.attachment = attachment
+                return record
+            return makeRecord
+
+        logger_class._log = wrap_log(logger_class._log)
+        logger_class.makeRecord = wrap_makeRecord(logger_class.makeRecord)
+
+        yield
+
+    finally:
+        logger_class._log = original_log
+        logger_class.makeRecord = original_makeRecord