Add HTML support to exceptions exposed via robot.api.

pekkaklarck · pekkaklarck · commit eed154f8d50e · 2021-03-03T16:00:56.000+02:00
Exposing these exceptions was proposed by robotframework#3685 and this enhancement can be considered to be part of that. Fixes robotframework#3866 that explicitly asked to add HTML support to these excpetions. A functional change caused by this change is that these exceptions now require a message. That means, for example, that raise SkipExecution doesn't work anymore and you need to use raise SkipExecution('Some message') instead. I consider that good but if someone has use cases for raising these exceptions without a message changing this can be still changed.
diff --git a/atest/robot/running/skip.robot b/atest/robot/running/skip.robot
@@ -3,10 +3,13 @@ Suite Setup     Run Tests  --skip skip-this --SkipOnFailure skip-on-failure --no
 Resource        atest_resource.robot
 
 *** Test Cases ***
-Skip Keyword
+Skip keyword
     Check Test Case    ${TEST NAME}
 
-Skip with Library Keyword
+Skip with SkipExecution exception in library
+    Check Test Case    ${TEST NAME}
+
+Skip with SkipExecution exception in library using HTML
     Check Test Case    ${TEST NAME}
 
 Skip with custom exception
diff --git a/atest/robot/running/test_case_status.robot b/atest/robot/running/test_case_status.robot
@@ -54,5 +54,11 @@ Test Setup And Teardown Fails
 robot.api.Failure
     Check Test Case    ${TEST NAME}
 
+robot.api.Failure with HTML message
+    Check Test Case    ${TEST NAME}
+
 robot.api.Error
     Check Test Case    ${TEST NAME}
+
+robot.api.Error with HTML message
+    Check Test Case    ${TEST NAME}
diff --git a/atest/testdata/running/StandardExceptions.py b/atest/testdata/running/StandardExceptions.py
@@ -1,9 +1,9 @@
 from robot.api import Failure, Error
 
 
-def failure(msg='I failed my duties'):
-    raise Failure(msg)
+def failure(msg='I failed my duties', html=False):
+    raise Failure(msg, html)
 
 
-def error(msg='I errored my duties'):
-    raise Error(msg)
+def error(msg='I errored my duties', html=False):
+    raise Error(msg, html=html)
diff --git a/atest/testdata/running/skip/skip.robot b/atest/testdata/running/skip/skip.robot
@@ -5,16 +5,21 @@ Library            skiplib.py
 ${TEST_OR_TASK}    Test
 
 *** Test Cases ***
-Skip Keyword
+Skip keyword
     [Documentation]    SKIP Skipped with Skip keyword.
     Skip
     Fail    Should not be executed!
 
-Skip with Library Keyword
+Skip with SkipExecution exception in library
     [Documentation]    SKIP Show must not got on
     Skip with Message    Show must not got on
     Fail    Should not be executed!
 
+Skip with SkipExecution exception in library using HTML
+    [Documentation]    SKIP *HTML* Show <b>must</b> not got on
+    Skip with Message    Show <b>must</b> not got on    html=True
+    Fail    Should not be executed!
+
 Skip with custom exception
     [Documentation]    SKIP CustomSkipException: Skipped with custom exception.
     Skip with custom exception
diff --git a/atest/testdata/running/skip/skiplib.py b/atest/testdata/running/skip/skiplib.py
@@ -5,8 +5,8 @@ class CustomSkipException(Exception):
     ROBOT_SKIP_EXECUTION = True
 
 
-def skip_with_message(msg):
-    raise SkipExecution(msg)
+def skip_with_message(msg, html=False):
+    raise SkipExecution(msg, html)
 
 
 def skip_with_custom_exception():
diff --git a/atest/testdata/running/test_case_status.robot b/atest/testdata/running/test_case_status.robot
@@ -83,10 +83,18 @@ robot.api.Failure
     [Documentation]    FAIL I failed my duties
     Failure
 
+robot.api.Failure with HTML message
+    [Documentation]    FAIL *HTML* <b>BANG!</b>
+    Failure    <b>BANG!</b>    True
+
 robot.api.Error
     [Documentation]    FAIL I errored my duties
     Error
 
+robot.api.Error with HTML message
+    [Documentation]    FAIL *HTML* <b>BANG!</b>
+    Error    <b>BANG!</b>    True
+
 *** Keyword ***
 Do Nothing
     No operation
diff --git a/src/robot/api/exceptions.py b/src/robot/api/exceptions.py
@@ -26,11 +26,18 @@ class Failure(AssertionError):
     """Report failed validation.
 
     There is no practical difference in using this exception compared to using
-    the standard ``AssertionError``. The main benefit of using this exception is
-    that its name is consistent with other exceptions in this module.
+    the standard ``AssertionError``. The main benefits are HTML support and that
+    the name of this exception is consistent with other exceptions in this module.
     """
     ROBOT_SUPPRESS_NAME = True
 
+    def __init__(self, message, html=False):
+        """
+        :param message: Exception message.
+        :param html: When ``True``, message is considered to be HTML and not escaped.
+        """
+        AssertionError.__init__(self, message if not html else '*HTML* ' + message)
+
 
 class ContinuableFailure(Failure):
     """Report failed validation but allow continuing execution."""
@@ -43,12 +50,20 @@ class Error(RuntimeError):
     Failures related to the system not behaving as expected should typically be
     reported using the :class:`Failure` exception or the standard ``AssertionError``.
     This exception can be used, for example, if the keyword is used incorrectly.
-    There is no practical difference, other than consistent naming with other
-    exceptions in this module, compared to using this exception and the standard
-    ``RuntimeError``.
+
+    There is no practical difference in using this exception compared to using
+    the standard ``RuntimeError``. The main benefits are HTML support and that
+    the name of this exception is consistent with other exceptions in this module.
     """
     ROBOT_SUPPRESS_NAME = True
 
+    def __init__(self, message, html=False):
+        """
+        :param message: Exception message.
+        :param html: When ``True``, message is considered to be HTML and not escaped.
+        """
+        RuntimeError.__init__(self, message if not html else '*HTML* ' + message)
+
 
 class FatalError(Error):
     """Report error that stops the whole execution."""
@@ -60,3 +75,10 @@ class SkipExecution(Exception):
     """Mark the executed test or task skipped."""
     ROBOT_SKIP_EXECUTION = True
     ROBOT_SUPPRESS_NAME = True
+
+    def __init__(self, message, html=False):
+        """
+        :param message: Exception message.
+        :param html: When ``True``, message is considered to be HTML and not escaped.
+        """
+        Exception.__init__(self, message if not html else '*HTML* ' + message)
