Add helper to resolve test/task in messages

yanne · yanne · commit bec3a19abbc8 · 2020-10-01T11:55:16.000+03:00
diff --git a/src/robot/utils/__init__.py b/src/robot/utils/__init__.py
@@ -51,7 +51,7 @@
 from .importer import Importer
 from .match import eq, Matcher, MultiMatcher
 from .misc import (plural_or_not, printable_name, roundup, seq2str,
-                   seq2str2)
+                   seq2str2, test_or_task)
 from .normalizing import lower, normalize, normalize_whitespace, NormalizedDict
 from .platform import (IRONPYTHON, JAVA_VERSION, JYTHON, PY_VERSION,
                        PY2, PY3, PYPY, UNIXY, WINDOWS, RERAISED_EXCEPTIONS)
diff --git a/src/robot/utils/misc.py b/src/robot/utils/misc.py
@@ -16,6 +16,7 @@
 from __future__ import division
 
 from operator import add, sub
+import re
 
 from .platform import PY2
 from .robottypes import is_integer
@@ -124,3 +125,17 @@ def seq2str2(sequence):
     if not sequence:
         return '[ ]'
     return '[ %s ]' % ' | '.join(unic(item) for item in sequence)
+
+
+def test_or_task(text, rpa):
+    """If `rpa` is True, replaces occurrences of `{test}` in `text` with `task`."""
+    def t(match):
+        if not rpa:
+            return match.group(1)
+        try:
+            return {
+                'TEST': 'TASK', 'Test': 'Task', 'test': 'task'
+            }[match.group(1)]
+        except KeyError:
+            raise ValueError("Invalid input string '%s'." % text)
+    return re.sub('{(.*)}', t, text)
diff --git a/utest/utils/test_misc.py b/utest/utils/test_misc.py
@@ -1,7 +1,9 @@
 import unittest
 
-from robot.utils.asserts import assert_equal
-from robot.utils import printable_name, seq2str, roundup, plural_or_not, IRONPYTHON
+from robot.utils.asserts import assert_equal, assert_raises_with_msg
+from robot.utils import (
+    printable_name, seq2str, roundup, plural_or_not, IRONPYTHON, test_or_task
+)
 
 
 class TestRoundup(unittest.TestCase):
@@ -155,5 +157,28 @@ def test_plural_or_not(self):
             assert_equal(plural_or_not(plural), 's')
 
 
+
+class TestTestOrTask(unittest.TestCase):
+
+    def test_test_or_task(self):
+        for inp, rpa, exp in [
+            ('{Test}', False, 'Test'),
+            ('{test}', False, 'test'),
+            ('{TEST}', False, 'TEST'),
+            ('{Test}', True, 'Task'),
+            ('{test}', True, 'task'),
+            ('{TEST}', True, 'TASK'),
+            ('Contains {test}', False, 'Contains test'),
+            ('Contains {TEST}', True, 'Contains TASK'),
+            ('Does not contain match', False, 'Does not contain match')
+        ]:
+            assert_equal(test_or_task(inp, rpa), exp)
+
+    def test_test_or_task_fails_with_invalid_pattern_in_braces(self):
+        assert_raises_with_msg(
+            ValueError, "Invalid input string '{TeSt}'.",
+            test_or_task, '{TeSt}', True)
+
+
 if __name__ == "__main__":
     unittest.main()
