Test keyword tags set by @Keyword. Issue #35, PR #37.

Author: pekkaklarck

src/robotremoteserver.py

@@ -190,18 +190,22 @@ class StaticRemoteLibrary(object):
 
     def __init__(self, library):
         self._library = library
-        self._robot_name_index = {}
+        self._names, self._robot_name_index = self._get_keyword_names(library)
 
-    def get_keyword_names(self):
+    def _get_keyword_names(self, library):
         names = []
-        for name, kw in inspect.getmembers(self._library):
+        robot_name_index = {}
+        for name, kw in inspect.getmembers(library):
             if is_function_or_method(kw):
                 if getattr(kw, 'robot_name', None):
                     names.append(kw.robot_name)
-                    self._robot_name_index[kw.robot_name] = name
+                    robot_name_index[kw.robot_name] = name
                 elif name[0] != '_':
                     names.append(name)
-        return names
+        return names, robot_name_index
+
+    def get_keyword_names(self):
+        return self._names
 
     def run_keyword(self, name, args, kwargs=None):
         kw = self._get_keyword(name)
@@ -238,9 +242,10 @@ def get_keyword_documentation(self, name):
         if name == '__init__' and inspect.ismodule(self._library):
             return ''
         keyword = self._get_keyword(name)
-        doc = inspect.getdoc(keyword) or ''
+        doc = (inspect.getdoc(keyword) or '').lstrip()
         if getattr(keyword, 'robot_tags', []):
-            doc += "\nTags: %s\n" % ', '.join(keyword.robot_tags)
+            tags = 'Tags: %s' % ', '.join(keyword.robot_tags)
+            doc = '%s\n\n%s' % (doc, tags) if doc else tags
         return doc
 
 

test/utest/run.py

@@ -8,6 +8,7 @@
 
 curdir = dirname(abspath(__file__))
 sys.path.insert(0, join(curdir, '..', '..', 'src'))
+sys.path.insert(0, join(curdir, '..', 'libs'))
 
 test_files = [f[:-3] for f in os.listdir(curdir)
               if f.startswith('test_') and f.endswith('.py')]

test/utest/test_keyword_decorator.py

@@ -0,0 +1,26 @@
+import unittest
+
+from KeywordDecorator import KeywordDecorator
+
+from test_robotremoteserver import NonServingRemoteServer
+
+
+class TestTags(unittest.TestCase):
+
+    def setUp(self):
+        self.server = NonServingRemoteServer(KeywordDecorator())
+
+    def test_tags(self):
+        self._assert_keyword_doc('tags', 'Tags: tag1, tag2')
+
+    def test_tags_with_doc(self):
+        self._assert_keyword_doc('Tags with doc (and custom name)',
+                                 'Keyword documentation.\n\nTags: tag1')
+
+    def _assert_keyword_doc(self, name, expected):
+        doc = self.server.get_keyword_documentation(name)
+        self.assertEqual(doc, expected)
+
+
+if __name__ == '__main__':
+    unittest.main()