Include exception traceback when logging using logging.exception

pekkaklarck · pekkaklarck · commit dc5c0c7f20c0 · 2021-03-03T23:58:13.000+02:00
Fixes robotframework#3828.
diff --git a/atest/resources/atest_resource.robot b/atest/resources/atest_resource.robot
@@ -143,10 +143,14 @@ Get Output File
     [Return]    ${file}
 
 File Should Contain
-    [Arguments]    ${path}    @{expected}
+    [Arguments]    ${path}    @{expected}    ${count}=None
     ${exp} =    Catenate    @{expected}
     ${file} =    Get Output File    ${path}
-    Should Contain    ${file}    ${exp}
+    IF    not ${count}
+        Should Contain    ${file}    ${exp}
+    ELSE
+        Should Contain X Times    ${file}    ${exp}    ${count}
+    END
 
 File Should Not Contain
     [Arguments]    ${path}    @{expected}
@@ -213,8 +217,8 @@ Stderr Should Be Empty
     Should Be Empty    ${stderr}    Errors in test execution:\n${stderr}
 
 Stderr Should Contain
-    [Arguments]    @{expected}
-    File Should Contain    ${STDERR_FILE}    @{expected}
+    [Arguments]    @{expected}    ${count}=None
+    File Should Contain    ${STDERR_FILE}    @{expected}    count=${count}
 
 Stderr Should Not Contain
     [Arguments]    @{expected}
@@ -229,8 +233,8 @@ Stderr Should Contain Regexp
     File Should Contain Regexp    ${STDERR_FILE}    @{expected}
 
 Stdout Should Contain
-    [Arguments]    @{expected}
-    File Should Contain    ${STDOUT_FILE}    @{expected}
+    [Arguments]    @{expected}    ${count}=None
+    File Should Contain    ${STDOUT_FILE}    @{expected}    count=${count}
 
 Stdout Should Not Contain
     [Arguments]    @{expected}
diff --git a/atest/robot/test_libraries/logging_with_logging.robot b/atest/robot/test_libraries/logging_with_logging.robot
@@ -28,6 +28,16 @@ Log with custom levels
     Check log message    ${tc.kws[0].msgs[4]}    between warning and error    WARN
     Check log message    ${tc.kws[0].msgs[5]}    above error    ERROR
 
+Log exception
+    ${tc} =    Check test case    ${TEST NAME}
+    ${message} =    Catenate    SEPARATOR=\n
+    ...    Error occurred!
+    ...    Traceback (most recent call last):
+    ...    ${SPACE*2}File "*", line 54, in log_exception
+    ...    ${SPACE*4}raise ValueError('Bang!')
+    ...    ValueError: Bang!
+    Check log message    ${tc.kws[0].msgs[0]}    ${message}    ERROR    pattern=True
+
 Messages below threshold level are ignored fully
     ${tc}=    Check test case    ${TEST NAME}
     Should be empty    ${tc.kws[0].msgs}
@@ -63,4 +73,4 @@ Logging when timeout is in use
     Check log message    ${tc.kws[0].msgs[1]}    something
 
 Suppress errors from logging module
-    Stderr Should Not Contain    Traceback
+    Stderr Should Contain    Traceback    count=1
diff --git a/atest/testdata/test_libraries/LibUsingPyLogging.py b/atest/testdata/test_libraries/LibUsingPyLogging.py
@@ -49,6 +49,12 @@ def log_with_custom_levels():
     logging.log(logging.WARNING+5, 'between warning and error')
     logging.log(logging.ERROR*100,'above error')
 
+def log_exception():
+    try:
+        raise ValueError('Bang!')
+    except ValueError:
+        logging.exception('Error occurred!')
+
 def log_invalid_message():
     logging.info(InvalidMessage())
 
diff --git a/atest/testdata/test_libraries/logging_with_logging.robot b/atest/testdata/test_libraries/logging_with_logging.robot
@@ -15,6 +15,9 @@ Log with custom levels
     [Setup]    Set log level    trace
     Log with custom levels
 
+Log exception
+    Log exception
+
 Messages below threshold level are ignored fully
     [Setup]    Set log level    warn
     Log invalid message
diff --git a/src/robot/output/pyloggingconf.py b/src/robot/output/pyloggingconf.py
@@ -15,6 +15,7 @@
 
 from contextlib import contextmanager
 import logging
+import traceback
 
 from robot.utils import get_error_details, unic
 
@@ -58,6 +59,9 @@ class RobotHandler(logging.Handler):
 
     def emit(self, record):
         message, error = self._get_message(record)
+        if record.exc_info:
+            tb_lines = traceback.format_exception(*record.exc_info)
+            message = ''.join([message, '\n'] + tb_lines).rstrip()
         method = self._get_logger_method(record.levelno)
         method(message)
         if error:
