Get tags from keyword docs. robotframework#925

jussimalinen · jussimalinen · commit 23eee4b7c45a · 2015-05-27T14:51:18.000+03:00
diff --git a/atest/robot/keywords/keyword_tags.robot b/atest/robot/keywords/keyword_tags.robot
@@ -12,9 +12,11 @@ Library keyword tags with `keyword` decorator
     2    one
 
 Library keyword tags with documentation
-    [Tags]    not ready
     one    two words
 
+Library keyword tags with documentation and attribute
+    2    one    two words
+
 Invalid library keyword tags
     [Tags]    not ready
     [Template]    NONE
@@ -27,9 +29,14 @@ User keyword tags with `[Tags]` setting
     2    first
 
 User keyword tags with documentation
-    [Tags]    not ready
     3    one    two words
 
+User keyword tags with documentation and setting
+    2    3    one    two words
+
+Dynamic library keyword with tags
+    bar    foo
+
 *** Keywords ***
 Keyword tags should be
     [Arguments]    @{tags}
diff --git a/atest/testdata/keywords/DynamicLibraryWithKeywordTags.py b/atest/testdata/keywords/DynamicLibraryWithKeywordTags.py
@@ -0,0 +1,10 @@
+class DynamicLibraryWithKeywordTags(object):
+
+    def get_keyword_names(self):
+        return ['dynamic_library_keyword_with_tags']
+
+    def run_keyword(self, name, *args):
+        return None
+
+    def get_keyword_documentation(self, name):
+        return 'Summary line\nTags: foo, bar'
diff --git a/atest/testdata/keywords/LibraryWithKeywordTags.py b/atest/testdata/keywords/LibraryWithKeywordTags.py
@@ -13,6 +13,16 @@ def library_keyword_tags_with_decorator():
 
 
 def library_keyword_tags_with_documentation():
+    """Summary line
+
+    Tags: are read only from the last line
+
+    Tags: one, two words"""
+    pass
+
+
+@keyword(tags=['one', 2])
+def library_keyword_tags_with_documentation_and_attribute():
     """Tags: one, two words"""
     pass
 
diff --git a/atest/testdata/keywords/keyword_tags.robot b/atest/testdata/keywords/keyword_tags.robot
@@ -1,5 +1,6 @@
 *** Settings ***
-Library        LibraryWithKeywordTags.py
+Library         LibraryWithKeywordTags.py
+Library         DynamicLibraryWithKeywordTags.py
 
 *** Test Cases ***
 Library keyword tags with `robot_tags` attribute
@@ -11,6 +12,9 @@ Library keyword tags with `keyword` decorator
 Library keyword tags with documentation
     Library keyword tags with documentation
 
+Library keyword tags with documentation and attribute
+    Library keyword tags with documentation and attribute
+
 Invalid library keyword tags
     [Documentation]    FAIL No keyword with name 'Invalid library keyword tags' found.
     Invalid library keyword tags
@@ -21,6 +25,12 @@ User keyword tags with `[Tags]` setting
 User keyword tags with documentation
     User keyword tags with documentation
 
+User keyword tags with documentation and setting
+    User keyword tags with documentation and setting
+
+Dynamic library keyword with tags
+    Dynamic library keyword with tags
+
 *** Keywords ***
 User keyword tags with setting
     [Tags]    first    ${2}
@@ -31,3 +41,8 @@ User keyword tags with documentation
     ...    Tags: are ignored also here
     ...    Tags: one, two words, ${3}
     No Operation
+
+User keyword tags with documentation and setting
+    [Documentation]    Tags: one, two words, ${3}
+    [Tags]    one    ${2}
+    No Operation
diff --git a/src/robot/running/handlers.py b/src/robot/running/handlers.py
@@ -51,26 +51,27 @@ def InitHandler(library, method, docgetter=None):
 
 class _RunnableHandler(object):
     type = 'library'
-    _doc = ''
     _executed_in_dry_run = ('BuiltIn.Import Library',
                             'BuiltIn.Set Library Search Order')
 
-    def __init__(self, library, handler_name, handler_method):
+    def __init__(self, library, handler_name, handler_method, doc=''):
         self.library = library
         name = getattr(handler_method, 'robot_name', None) or handler_name
         self.name = utils.printable_name(name, code_style=True)
         self.arguments = self._parse_arguments(handler_method)
-        self.tags = self._get_tags(handler_method)
         self.pre_run_messages = None
         self._handler_name = handler_name
         self._method = self._get_initial_handler(library, handler_name,
                                                  handler_method)
         self._argument_resolver = self._get_argument_resolver(self.arguments)
+        doc, tags = utils.split_tags_from_doc(doc)
+        self._doc = doc
+        self.tags = self._get_tags_from_attribute(handler_method) + tags
 
     def _parse_arguments(self, handler_method):
         raise NotImplementedError
 
-    def _get_tags(self, handler_method):
+    def _get_tags_from_attribute(self, handler_method):
         return Tags(getattr(handler_method, 'robot_tags', ()))
 
     def _get_argument_resolver(self, argspec):
@@ -173,8 +174,8 @@ def _get_timeouts(self, context):
 class _PythonHandler(_RunnableHandler):
 
     def __init__(self, library, handler_name, handler_method):
-        _RunnableHandler.__init__(self, library, handler_name, handler_method)
-        self._doc = utils.getdoc(handler_method)
+        _RunnableHandler.__init__(self, library, handler_name, handler_method,
+                                  utils.getdoc(handler_method))
 
     def _parse_arguments(self, handler_method):
         return PythonArgumentParser().parse(handler_method, self.longname)
@@ -211,9 +212,8 @@ def __init__(self, library, handler_name, dynamic_method, doc='',
                  argspec=None):
         self._argspec = argspec
         _RunnableHandler.__init__(self, library, handler_name,
-                                  dynamic_method.method)
+                                  dynamic_method.method, utils.unic(doc or ''))
         self._run_keyword_method_name = dynamic_method.name
-        self._doc = doc is not None and utils.unic(doc) or ''
         self._supports_kwargs = dynamic_method.supports_kwargs
         if argspec and argspec[-1].startswith('**'):
             if not self._supports_kwargs:
diff --git a/src/robot/running/userkeyword.py b/src/robot/running/userkeyword.py
@@ -87,9 +87,11 @@ def shortdoc(self):
     def init_keyword(self, variables):
         # TODO: Should use runner and not change internal state like this.
         # Timeouts should also be cleaned up in general.
-        self.doc = variables.replace_string(self._doc, ignore_errors=True)
+        doc = variables.replace_string(self._doc, ignore_errors=True)
+        doc, tags = utils.split_tags_from_doc(doc)
+        self.doc = doc
         self.tags = [variables.replace_string(tag, ignore_errors=True)
-                     for tag in self._tags]
+                     for tag in self._tags] + tags
         if self._timeout:
             self.timeout = KeywordTimeout(self._timeout.value,
                                           self._timeout.message,
diff --git a/src/robot/utils/__init__.py b/src/robot/utils/__init__.py
@@ -63,7 +63,7 @@
 from .robottypes import is_dict_like, is_list_like, is_str_like, type_name
 from .setter import setter
 from .text import (cut_long_message, format_assign_message,
-                   pad_console_length, get_console_length)
+                   pad_console_length, get_console_length, split_tags_from_doc)
 from .unic import prepr, unic
 from .utf8reader import Utf8Reader
 
diff --git a/src/robot/utils/text.py b/src/robot/utils/text.py
@@ -12,6 +12,8 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 
+import re
+
 from .charwidth import get_char_width
 from .misc import seq2str2
 from .unic import unic
@@ -21,6 +23,7 @@
 _MAX_ERROR_LINES = 40
 _MAX_ERROR_LINE_LENGTH = 78
 _ERROR_CUT_EXPLN = '    [ Message content over the limit has been removed. ]'
+_TAGS_RE = re.compile(r'\s*tags:(.*)', re.IGNORECASE)
 
 
 def cut_long_message(msg):
@@ -105,3 +108,16 @@ def _lose_width(text, diff):
         lost += get_console_length(text[-1])
         text = text[:-1]
     return text
+
+
+def split_tags_from_doc(doc):
+    doc = doc.rstrip()
+    tags = []
+    if not doc:
+        return doc, tags
+    lines = doc.splitlines()
+    match = _TAGS_RE.match(lines[-1])
+    if match:
+        doc = '\n'.join(lines[:-1]).rstrip()
+        tags = [tag.strip() for tag in match.group(1).split(',')]
+    return doc, tags
diff --git a/utest/utils/test_text.py b/utest/utils/test_text.py
@@ -4,7 +4,7 @@
 
 from robot.utils.text import cut_long_message, _count_line_lengths, \
     _MAX_ERROR_LINES, _MAX_ERROR_LINE_LENGTH, _ERROR_CUT_EXPLN,\
-    get_console_length, pad_console_length
+    get_console_length, pad_console_length, split_tags_from_doc
 
 
 class NoCutting(unittest.TestCase):
@@ -161,5 +161,40 @@ def test_cut_east_asian(self):
         assert_equal(pad_console_length(self.mixed_26, 11), u'012345\u6c49...')
 
 
+class TestDocSplitter(unittest.TestCase):
+
+    def test_doc_without_tags(self):
+        docs = ["Single doc line.",
+                """Hello, we dont have tags here.
+
+                No sir. No tags.""",
+                "Now Tags: must, start from beginning of the row",
+                "   We strip  the trailing whitespace  \n \n"]
+        for doc in docs:
+            self._assert_doc_and_tags(doc, doc.rstrip(), [])
+
+    def _assert_doc_and_tags(self, original, expected_doc, expected_tags):
+        doc, tags = split_tags_from_doc(original)
+        assert_equal(doc, expected_doc)
+        assert_equal(tags, expected_tags)
+
+    def test_doc_with_tags(self):
+        sets = [
+            ('Tags: foo, bar',                  '',             ['foo', 'bar']),
+            ('  Tags: foo   ',                  '',             ['foo']),
+            ('Hello\nTags: foo, bar',           'Hello',        ['foo', 'bar']),
+            ('Tags: bar\n   Tags: foo   ',      'Tags: bar',    ['foo']),
+            ('Tags: bar, Tags:, foo   ',        '',             ['bar', 'Tags:', 'foo']),
+            ('tags: foo',                       '',             ['foo']),
+            ('   tags: foo ,  bar  ',           '',             ['foo', 'bar']),
+            ('Hello\n   taGS: foo, bar',        'Hello',        ['foo', 'bar']),
+            (' Hello\n   taGS: f, b \n\n \n',   ' Hello',       ['f', 'b']),
+            ('Hello\nNl  \n  \nTags: foo',      'Hello\nNl',    ['foo']),
+        ]
+        for original, exp_doc, exp_tags in sets:
+            self._assert_doc_and_tags(original, exp_doc, exp_tags)
+            self._assert_doc_and_tags(original+'\n', exp_doc, exp_tags)
+
+
 if __name__ == '__main__':
     unittest.main()
