Add log attachments and async error handler to agent

Changes:
- added custom Logger to support attachment in log messages;
- added error handler which will re-raise exceptions from async client-Python thread;
- updated examples with new logging posibilities.

Author: vakulich

README.rst

@@ -60,9 +60,10 @@ logging handler privided by plugin like bellow:
 .. code-block:: python
 
     import logging
-    # Import Report Portal handler to the test module.
-    from pytest_reportportal import RPlogHandler
+    # Import Report Portal logger and handler to the test module.
+    from pytest_reportportal import RPLogger, RPLogHandler
     # Setting up a logging.
+    logging.setLoggerClass(RPLogger)
     logger = logging.getLogger(__name__)
     logger.setLevel(logging.DEBUG)
     # Create handler for Report Portal.
@@ -79,6 +80,19 @@ logging handler privided by plugin like bellow:
         x = "this"
         logger.info("x is: %s", x)
         assert 'h' in x
+
+        # Message with an attachment.
+        import subprocess
+        free_memory = subprocess.check_output("free -h".split())
+        logger.info(
+            "Case1. Memory consumption",
+            attachment={
+                "name": "free_memory.txt",
+                "data": free_memory,
+                "mime": "application/octet-stream",
+            },
+        )
+
         # This debug message will not be sent to the Report Portal.
         logger.debug("Case1. Debug message")
 
@@ -98,4 +112,4 @@ Copyright Notice
 
 Licensed under the GPLv3_ license (see the LICENSE file).
 
-.. _GPLv3:  https://www.gnu.org/licenses/quick-guide-gplv3.html
+.. _GPLv3:  https://www.gnu.org/licenses/quick-guide-gplv3.html

pytest_reportportal/__init__.py

@@ -1,9 +1,42 @@
+import sys
 import logging
 
 from .service import PyTestService
 
 
-class RPlogHandler(logging.Handler):
+class RPLogger(logging.getLoggerClass()):
+
+    def __init__(self, name, level=0):
+        super(RPLogger, self).__init__(name, level=level)
+
+    def _log(self, level, msg, args, exc_info=None, extra=None,
+             attachment=None):
+        """
+        Low-level logging routine which creates a LogRecord and then calls
+        all the handlers of this logger to handle the record.
+        """
+        if logging._srcfile:
+            # IronPython doesn't track Python frames, so findCaller raises an
+            # exception on some versions of IronPython. We trap it here so that
+            # IronPython can use logging.
+            try:
+                fn, lno, func = self.findCaller()
+            except ValueError:
+                fn, lno, func = "(unknown file)", 0, "(unknown function)"
+        else:
+            fn, lno, func = "(unknown file)", 0, "(unknown function)"
+
+        if exc_info and not isinstance(exc_info, tuple):
+            exc_info = sys.exc_info()
+
+        record = self.makeRecord(
+            self.name, level, fn, lno, msg, args, exc_info, func, extra
+        )
+        record.attachment = attachment
+        self.handle(record)
+
+
+class RPLogHandler(logging.Handler):
 
     # Map loglevel codes from `logging` module to ReportPortal text names:
     _loglevel_map = {
@@ -17,7 +50,7 @@ class RPlogHandler(logging.Handler):
     _sorted_levelnos = sorted(_loglevel_map.keys(), reverse=True)
 
     def __init__(self, level=logging.NOTSET):
-        super(RPlogHandler, self).__init__(level)
+        super(RPLogHandler, self).__init__(level)
 
     def emit(self, record):
         try:
@@ -31,4 +64,8 @@ def emit(self, record):
             if level <= record.levelno:
                 break
 
-        return PyTestService.post_log(msg, loglevel=self._loglevel_map[level])
+        return PyTestService.post_log(
+            msg,
+            loglevel=self._loglevel_map[level],
+            attachment=record.__dict__.get("attachment", None),
+        )

pytest_reportportal/plugin.py

@@ -23,7 +23,10 @@ def pytest_runtest_makereport(self, item, call):
         report = (yield).get_result()
 
         if report.longrepr:
-            PyTestService.post_log(cgi.escape(report.longreprtext), loglevel='ERROR')
+            PyTestService.post_log(
+                cgi.escape(report.longreprtext),
+                loglevel='ERROR',
+            )
 
         if report.when == "setup":
 

pytest_reportportal/service.py

@@ -4,6 +4,10 @@
 from reportportal_client import ReportPortalServiceAsync
 
 
+def async_error_handler(exception):
+    raise exception
+
+
 def timestamp():
     return str(int(time() * 1000))
 
@@ -34,7 +38,8 @@ def init_service(self, endpoint, project, uuid):
             self.RP = ReportPortalServiceAsync(
                 endpoint=endpoint,
                 project=project,
-                token=uuid)
+                token=uuid,
+                error_handler=async_error_handler)
         else:
             logging.debug("The pytest is already initialized")
         return self.RP
@@ -98,13 +103,19 @@ def finish_launch(self, launch=None, status="rp_launch"):
                           "request_body={0}".format(fl_rq))
         self.RP.finish_launch(**fl_rq)
 
-    def post_log(self, message, loglevel='INFO'):
+    def post_log(self, message, loglevel='INFO', attachment=None):
         if loglevel not in self._loglevels:
-            logging.warning('Incorrect loglevel = {}. Force set to INFO. Avaliable levels: '
-                            '{}.'.format(loglevel, self._loglevels))
+            logging.warning('Incorrect loglevel = {}. Force set to INFO. '
+                            'Avaliable levels: {}.'
+                            .format(loglevel, self._loglevels))
             loglevel = 'INFO'
 
-        sl_rq = dict(time=timestamp(), message=message, level=loglevel)
+        sl_rq = dict(
+            time=timestamp(),
+            message=message,
+            level=loglevel,
+            attachment=attachment,
+        )
         self.RP.log(**sl_rq)