Support get_keyword_tags method. Fixes robotframework#38

Author: pekkaklarck

README.rst

@@ -37,8 +37,9 @@ Supported library APIs
 Starting from the remote server version 1.1, Robot Framework's `static,
 hybrid and dynamic library APIs`__ are all supported. This includes setting
 custom name and tags for keywords using the `robot.api.deco.keyword`__
-decorator. Earlier versions support only the static and hybrid APIs and do
-not support the keyword decorator.
+decorator, although the support for tags requires using Robot Framework 3.0.2
+or newer. Earlier remote server versions support only the static and hybrid
+APIs and do not support the keyword decorator at all.
 
 For most parts these APIs work exactly like when using with Robot Framework
 normally. There main limitation is that logging using ``robot.api.logger`` or

src/robotremoteserver.py

@@ -184,6 +184,11 @@ def get_keyword_documentation(self, name):
  'Return ``True/False`` depending was server stopped or not.')
  return self._library.get_keyword_documentation(name)
 
+ def get_keyword_tags(self, name):
+ if name == 'stop_remote_server':
+ return []
+ return self._library.get_keyword_tags(name)
+
 
 class StoppableXMLRPCServer(SimpleXMLRPCServer):
  allow_reuse_address = True
@@ -320,11 +325,7 @@ def get_keyword_documentation(self, name):
  init = self._get_init(self._library)
  return inspect.getdoc(init) or ''
  keyword = self._get_keyword(name)
- doc = (inspect.getdoc(keyword) or '').lstrip()
- if getattr(keyword, 'robot_tags', []):
- tags = 'Tags: %s' % ', '.join(keyword.robot_tags)
- doc = '%s\n\n%s' % (doc, tags) if doc else tags
- return doc
+ return inspect.getdoc(keyword) or ''
 
  def _get_init(self, library):
  if inspect.ismodule(library):
@@ -342,6 +343,10 @@ def _is_valid_init(self, init):
  return init is not object.__init__
  return is_function_or_method(init)
 
+ def get_keyword_tags(self, name):
+ keyword = self._get_keyword(name)
+ return getattr(keyword, 'robot_tags', [])
+
 
 class HybridRemoteLibrary(StaticRemoteLibrary):
 
@@ -360,6 +365,8 @@ def __init__(self, library, get_keyword_names, run_keyword):
  = dynamic_method(library, 'get_keyword_arguments')
  self._get_keyword_documentation \
  = dynamic_method(library, 'get_keyword_documentation')
+ self._get_keyword_tags \
+ = dynamic_method(library, 'get_keyword_tags')
 
  def _get_kwargs_support(self, run_keyword):
  spec = inspect.getargspec(run_keyword)
@@ -381,6 +388,11 @@ def get_keyword_documentation(self, name):
  return self._get_keyword_documentation(name)
  return ''
 
+ def get_keyword_tags(self, name):
+ if self._get_keyword_tags:
+ return self._get_keyword_tags(name)
+ return []
+
 
 class KeywordRunner(object):
 

test/utest/test_dynamicargsdocs.py renamed to test/utest/test_dynamicargsdoctags.py

@@ -3,7 +3,7 @@
 from robotremoteserver import RemoteLibraryFactory
 
 
-class OwnArgsAndDocs(object):
+class OwnArgsDocTags(object):
 
  def get_keyword_names(self):
  return ['keyword']
@@ -17,8 +17,11 @@ def get_keyword_arguments(self, name):
  def get_keyword_documentation(self, name):
  return 'The doc for %s' % name
 
+ def get_keyword_tags(self, name):
+ return [name, 'tags']
 
-class OwnArgsAndDocsWithCamelCaseNames(object):
+
+class OwnArgsDocTagsWithCamelCaseNames(object):
 
  def getKeywordNames(self):
  return ['keyword']
@@ -32,8 +35,11 @@ def getKeywordArguments(self, name):
  def getKeywordDocumentation(self, name):
  return 'The doc for %s' % name
 
+ def getKeywordTags(self, name):
+ return [name, 'tags']
+
 
-class NoArgsOrDocs(object):
+class NoArgsDocTags(object):
 
  def get_keyword_names(self):
  return ['keyword']
@@ -42,7 +48,7 @@ def run_keyword(self, name, args, kwargs=None):
  pass
 
 
-class NoArgsOrDocsWithoutKwargs(object):
+class NoArgsDocTagsWithoutKwargs(object):
 
  def get_keyword_names(self):
  return ['keyword']
@@ -51,10 +57,10 @@ def run_keyword(self, name, args):
  pass
 
 
-class TestOwnArgsAndDocs(unittest.TestCase):
+class TestOwnArgsDocTags(unittest.TestCase):
 
  def setUp(self):
- self.lib = RemoteLibraryFactory(OwnArgsAndDocs())
+ self.lib = RemoteLibraryFactory(OwnArgsDocTags())
 
  def test_arguments(self):
  self.assertEqual(self.lib.get_keyword_arguments('keyword'),
@@ -64,34 +70,36 @@ def test_documentation(self):
  self.assertEqual(self.lib.get_keyword_documentation('keyword'),
  'The doc for keyword')
 
+ def test_tags(self):
+ self.assertEqual(self.lib.get_keyword_tags('keyword'),
+ ['keyword', 'tags'])
 
-class TestOwnArgsAndDocsWithCamelCaseNames(TestOwnArgsAndDocs):
+
+class TestOwnArgsDocTagsWithCamelCaseNames(TestOwnArgsDocTags):
 
  def setUp(self):
- self.lib = RemoteLibraryFactory(OwnArgsAndDocsWithCamelCaseNames())
+ self.lib = RemoteLibraryFactory(OwnArgsDocTagsWithCamelCaseNames())
 
 
-class TestNoArgsOrDocs(unittest.TestCase):
+class TestNoArgsDocTags(unittest.TestCase):
 
  def setUp(self):
- self.lib = RemoteLibraryFactory(NoArgsOrDocs())
+ self.lib = RemoteLibraryFactory(NoArgsDocTags())
 
- def test_arguments(self):
+ def test_arguments_with_kwargs(self):
  self.assertEqual(self.lib.get_keyword_arguments('keyword'),
  ['*varargs', '**kwargs'])
 
+ def test_arguments_without_kwargs(self):
+ self.lib = RemoteLibraryFactory(NoArgsDocTagsWithoutKwargs())
+ self.assertEqual(self.lib.get_keyword_arguments('keyword'),
+ ['*varargs'])
+
  def test_documentation(self):
  self.assertEqual(self.lib.get_keyword_documentation('keyword'), '')
 
-
-class TestNoArgsOrDocsWithoutKwargs(unittest.TestCase):
-
- def setUp(self):
- self.lib = RemoteLibraryFactory(NoArgsOrDocsWithoutKwargs())
-
- def test_arguments(self):
- self.assertEqual(self.lib.get_keyword_arguments('keyword'),
- ['*varargs'])
+ def test_tags(self):
+ self.assertEqual(self.lib.get_keyword_tags('keyword'), [])
 
 
 if __name__ == '__main__':

test/utest/test_keyword_decorator.py

@@ -11,15 +11,15 @@ def setUp(self):
  self.server = NonServingRemoteServer(KeywordDecorator())
 
  def test_tags(self):
- self._assert_keyword_doc('tags', 'Tags: tag1, tag2')
+ self._assert_tags_and_doc('tags', ['tag1', 'tag2'], '')
 
  def test_tags_with_doc(self):
- self._assert_keyword_doc('Tags with doc (and custom name)',
- 'Keyword documentation.\n\nTags: tag1')
+ self._assert_tags_and_doc('Tags with doc (and custom name)',
+  ['tag1'], 'Keyword documentation.')
 
- def _assert_keyword_doc(self, name, expected):
- doc = self.server.get_keyword_documentation(name)
- self.assertEqual(doc, expected)
+ def _assert_tags_and_doc(self, name, tags, doc):
+ self.assertEqual(self.server.get_keyword_tags(name), tags)
+ self.assertEqual(self.server.get_keyword_documentation(name), doc)
 
 
 if __name__ == '__main__':