added automatic listener detection

Signed-off-by: René <[email protected]>

Author: Snooz82

atest/ListenerCore.py

@@ -0,0 +1,66 @@
+from robot.api import logger
+
+
+from robotlibcore import DynamicCore, keyword
+
+
+class ListenerCore(DynamicCore):
+
+    ROBOT_LIBRARY_SCOPE = 'GLOBAL'
+
+    def __init__(self):
+        self.keyword_name = None
+        self.keyword_args = {}
+        self.ROBOT_LISTENER_API_VERSION = 2
+        second_comp = SecondComponent()
+        self.ROBOT_LIBRARY_LISTENER = second_comp.listener
+        components = [FirstComponent(), second_comp]
+        super().__init__(components)
+
+    @keyword
+    def listener_core(self, arg: str):
+        logger.info(arg)
+        assert arg == self.keyword_args.get("args", [None])[0], "First argument should be detected by listener, but was not."
+
+    def start_keyword(self, name, args):
+        self.keyword_name = name
+        self.keyword_args = args
+        logger.info(f"start: {name}")
+
+
+class FirstComponent:
+
+    def __init__(self):
+        self.ROBOT_LISTENER_API_VERSION = 2
+        self.suite_name = ''
+
+    def _start_suite(self, name, attrs):
+        self.suite_name = name
+        logger.console(f"start suite: {name}")
+
+    @keyword
+    def first_component(self, arg: str):
+        logger.info(arg)
+        assert arg == self.suite_name, f"Suite name '{self.suite_name}' should be detected by listener, but was not."
+
+
+class SecondComponent:
+
+    def __init__(self):
+        self.listener = ExternalListener()
+
+    @keyword
+    def second_component(self, arg: str):
+        logger.info(arg)
+        assert self.listener.test.name == arg, "Test case name should be detected by listener, but was not."
+
+
+class ExternalListener:
+
+    ROBOT_LISTENER_API_VERSION = 3
+
+    def __init__(self):
+        self.test = None
+
+    def start_test(self, test, _):
+        self.test = test

atest/tests_listener.robot

@@ -0,0 +1,13 @@
+*** Settings ***
+Library    ListenerCore.py
+
+
+*** Test Cases ***
+Automatic Listener
+    Listener Core    This is the first Argument
+
+External Listener
+    Second Component    External Listener
+
+No Listener
+    First Component    Tests Listener

src/robotlibcore.py

@@ -45,6 +45,7 @@ def __init__(self, library_components):
         self.attributes = {}
         self.add_library_components(library_components)
         self.add_library_components([self])
+        self._set_library_listeners(library_components)
 
     def add_library_components(self, library_components):
         self.keywords_spec["__init__"] = KeywordBuilder.build(self.__init__)
@@ -59,6 +60,39 @@ def add_library_components(self, library_components):
                     # method names as well as possible custom names.
                     self.attributes[name] = self.attributes[kw_name] = kw
 
+    def _set_library_listeners(self, library_components):
+        listeners = self._get_component_listeners(library_components)
+        listeners = self._insert_manually_registered_listeners(listeners)
+        listeners = self._insert_self_to_listeners(listeners)
+        if listeners:
+            self.ROBOT_LIBRARY_LISTENER = listeners
+
+    def _insert_self_to_listeners(self, component_listeners):
+        if self not in component_listeners:
+            try:
+                getattr(self, "ROBOT_LISTENER_API_VERSION")
+                return [self, *component_listeners]
+            except AttributeError:
+                pass
+        return component_listeners
+
+    def _insert_manually_registered_listeners(self, component_listeners: list) -> list:
+        try:
+            manually_registered_listener = getattr(self, "ROBOT_LIBRARY_LISTENER")
+            try:
+                return [*manually_registered_listener, *component_listeners]
+            except TypeError:
+                return [manually_registered_listener, *component_listeners]
+        except AttributeError:
+            return component_listeners
+
+    def _get_component_listeners(self, library_listeners):
+        return [
+            component
+            for component in library_listeners
+            if hasattr(component, "ROBOT_LISTENER_API_VERSION")
+        ]
+
     def __get_members(self, component):
         if inspect.ismodule(component):
             return inspect.getmembers(component)