Parsing plugins

Author: aaltat

atest/tests.robot

@@ -1,9 +1,11 @@
 *** Settings ***
 Library     ${LIBRARY}.py
 
+
 *** Variables ***
 ${LIBRARY}      DynamicLibrary
 
+
 *** Test Cases ***
 Keyword names
     Keyword in main
@@ -12,9 +14,7 @@ Keyword names
     Method
     Custom name
     Cust omna me
-    IF    $LIBRARY == "ExtendExistingLibrary"
-        Keyword in extending library
-    END
+    IF    $LIBRARY == "ExtendExistingLibrary"    Keyword in extending library
 
 Method without @keyword are not keyowrds
     [Documentation]    FAIL GLOB:    No keyword with name 'Not keyword' found.*
@@ -45,6 +45,7 @@ Embedded arguments
     Embedded arguments "work"
     embeDded ArgumeNtS "Work but this fails"
 
+
 *** Keywords ***
 Return value should be
     [Arguments]    ${expected}    ${keyword}    @{args}    &{kwargs}

atest/tests_types.robot

@@ -2,9 +2,11 @@
 Library     DynamicTypesLibrary.py
 Library     DynamicTypesAnnotationsLibrary.py    xxx
 
+
 *** Variables ***
 ${CUSTOM NONE} =    ${None}
 
+
 *** Test Cases ***
 Keyword Default Argument As Abject None
     ${return} =    DynamicTypesLibrary.Keyword None    ${None}
@@ -56,7 +58,8 @@ Varargs and KeywordArgs With Typing Hints
     ...    1    2    3    4    # varargs
     ...    other=True    # other argument
     ...    key1=1    key2=2    # kwargs
-    Should Match    ${return}
+    Should Match
+    ...    ${return}
     ...    this_is_mandatory: <class 'str'>, (1, 2, 3, 4): <class 'tuple'>, True: <class 'bool'>, {'key1': 1, 'key2': 2}: <class 'dict'>
 
 Enum Conversion Should Work
@@ -109,9 +112,8 @@ Python 3.10 New Type Hints
         Should Be Equal    ${types}    arg: {"key": 1}, type: <class 'str'>
     END
 
+
 *** Keywords ***
 Import DynamicTypesAnnotationsLibrary In Python 3.10 Only
     ${py3} =    DynamicTypesLibrary.Is Python 3 10
-    IF    ${py3}
-        Import Library    Python310Library.py
-    END
+    IF    ${py3}    Import Library    Python310Library.py

src/robotlibcore.py

@@ -285,24 +285,28 @@ def __init__(self, argument_specification=None, documentation=None, argument_typ
 
 
 class PluginParser:
+    def __init__(self, base_class: typing.Any):
+        self._base_class = base_class
 
     def parse_plugins(self, plugins: str) -> typing.List:
-        libraries = []
+        imported_plugins = []
         importer = Importer("test library")
         for parsed_plugin in self._string_to_modules(plugins):
             plugin = importer.import_class_or_module(parsed_plugin.module)
             if not inspect.isclass(plugin):
                 message = f"Importing test library: '{parsed_plugin.module}' failed."
                 raise DataError(message)
-            plugin = plugin(self, *parsed_plugin.args, **parsed_plugin.kw_args)
-            if not isinstance(plugin, LibraryComponent):
+            plugin = plugin(*parsed_plugin.args, **parsed_plugin.kw_args)
+            if self._base_class and not isinstance(plugin, self._base_class):
                 message = (
                     "Plugin does not inherit SeleniumLibrary.base.LibraryComponent"
                 )
                 raise PluginError(message)
-            self._store_plugin_keywords(plugin)
-            libraries.append(plugin)
-        return libraries
+            imported_plugins.append(plugin)
+        return imported_plugins
+
+    def get_plugin_keyword(self, plugins: typing.List):
+        pass
 
     def _string_to_modules(self, modules):
         parsed_modules = []

utest/helpers/my_plugin_test.py

@@ -0,0 +1,30 @@
+from robot.api.deco import keyword
+
+
+class TestClass:
+
+    @keyword
+    def new_keyword(self, arg: int) -> int:
+        return arg + self.not_keyword()
+
+    def not_keyword(self):
+        return 1
+
+
+class LibraryBase:
+
+    def __init__(self):
+        self.x = 1
+
+    def base(self):
+        return 2
+
+
+class TestClassWithBase(LibraryBase):
+
+    @keyword
+    def another_keywor(self) -> int:
+        return 2 * 2
+
+    def normal_method(self):
+        return "xxx"

utest/run.py

@@ -14,6 +14,8 @@
 src = join(curdir, "..", "src")
 sys.path.insert(0, src)
 sys.path.insert(0, atest_dir)
+helpers = join(curdir, "helpers")
+sys.path.append(helpers)
 
 parser = argparse.ArgumentParser()
 parser.add_argument("--no-cov", dest="cov", action="store_false")
@@ -22,6 +24,7 @@
 args = parser.parse_args()
 
 pytest_args = [
+    f"--ignore={helpers}",
     "-p",
     "no:cacheprovider",
     "--junitxml=%s" % xunit_report,

utest/test_plugin_api.py

@@ -1,11 +1,12 @@
 import pytest
 
 from robotlibcore import Module, PluginParser
+import my_plugin_test
 
 
 @pytest.fixture(scope="module")
 def plugin_parser() -> PluginParser:
-    return PluginParser()
+    return PluginParser(None)
 
 
 def test_no_plugins_parsing(plugin_parser):
@@ -35,3 +36,15 @@ def test_plugins_string_to_modules(plugin_parser):
     assert result == [
         Module("PluginWithKwArgs.py", [], {"kw1": "Text1", "kw2": "Text2"}),
     ]
+
+
+def test_parse_plugins(plugin_parser):
+    plugins = plugin_parser.parse_plugins("my_plugin_test.TestClass")
+    assert len(plugins) == 1
+    assert isinstance(plugins[0], my_plugin_test.TestClass)
+    plugins = plugin_parser.parse_plugins("my_plugin_test.TestClass,my_plugin_test.TestClassWithBase")
+    assert len(plugins) == 2
+    assert isinstance(plugins[0], my_plugin_test.TestClass)
+    assert isinstance(plugins[1], my_plugin_test.TestClassWithBase)
+    
+