Add Utils class with method to retrieve entrypoint function from call stack; refactor WebappInternal and PouiInternal classes to utilize new utility methods.

Author: vinioliveira-totvs

tir/technologies/core/base.py

@@ -21,6 +21,7 @@
 from tir.technologies.core.config import ConfigLoader
 from tir.technologies.core.language import LanguagePack
 from tir.technologies.core.third_party.xpath_soup import xpath_soup
+from tir.technologies.core.utils import Utils
 from selenium.webdriver.firefox.options import Options as FirefoxOpt
 from selenium.webdriver.firefox.service import Service as FirefoxService
 from selenium.webdriver.chrome.options import Options as ChromeOpt
@@ -116,6 +117,7 @@ def __init__(self, config_path="", autostart=True):
         self.language = LanguagePack(self.config.language) if self.config.language else ""
         self.log = Log(folder=self.config.log_folder, config_path=self.config_path)
         self.log.station = socket.gethostname()
+        self.utils = Utils()
         self.test_case = []
         self.last_test_case = None
         self.message = ""

tir/technologies/core/utils.py

@@ -0,0 +1,33 @@
+import inspect
+import os
+from typing import Iterable, Optional, Set
+
+
+class Utils:
+    """Shared utility methods for TIR technologies."""
+
+    def get_main_entrypoint_from_stack(
+        self,
+        target_modules: Optional[Iterable[str]] = None,
+        ignored_functions: Optional[Set[str]] = None,
+        fallback: str = "function_name"
+    ) -> str:
+        """Return the external entrypoint function from call stack.
+
+        Looks for the first stack frame whose filename ends with one of target modules
+        and whose function is not in ignored_functions.
+        """
+        modules = tuple(target_modules) if target_modules else ("tir/main.py",)
+        ignored = ignored_functions or {"__getattribute__", "_subscribe_routes", "__init__", "<lambda>"}
+
+        normalized_modules = tuple(
+            os.path.normpath(module).replace("\\", "/").lower()
+            for module in modules
+        )
+
+        for stack_item in inspect.stack():
+            filename = os.path.normpath(stack_item.filename).replace("\\", "/").lower()
+            if any(filename.endswith(module) for module in normalized_modules) and stack_item.function not in ignored:
+                return stack_item.function
+
+        return fallback

tir/technologies/poui_internal.py

@@ -2056,20 +2056,6 @@ def search_for_errors(self, check_help=True):
         self.restart_counter += 1
         self.log_error(message)
 
-    def get_function_from_stack(self):
-        """
-        [Internal]
-
-        Gets the function name that called the Webapp class from the call stack.
-
-        Usage:
-
-        >>> # Calling the method:
-        >>> self.get_function_from_stack()
-        """
-        stack_item = next(iter(filter(lambda x: x.filename == self.config.routine, inspect.stack())), None)
-        return stack_item.function if stack_item and stack_item.function else "function_name"
-
     def create_message(self, args, message_type=enum.MessageType.CORRECT):
         """
         [Internal]

tir/technologies/webapp_internal.py

@@ -1985,7 +1985,10 @@ def escape_to_main_menu(self):
             success = menu_screen and container_layers
 
             logger().debug(f'Check Menu Screen: {menu_screen}')
-            logger().debug(f'wa-dialog layers: {container_layers}')        
+            logger().debug(f'wa-dialog layers: {container_layers}')
+
+        if not success:
+            self.log_error('Home screen not found!')     
 
         # wait trasitions between screens to avoid errors in layers number
         self.wait_element_timeout(term=container_term, scrap_type=enum.ScrapType.CSS_SELECTOR,
@@ -4264,20 +4267,6 @@ def search_for_errors(self, check_help=True):
         self.restart_counter += 1
         self.log_error(message)
 
-    def get_function_from_stack(self):
-        """
-        [Internal]
-
-        Gets the function name that called the Webapp class from the call stack.
-
-        Usage:
-
-        >>> # Calling the method:
-        >>> self.get_function_from_stack()
-        """
-        stack_item = next(iter(filter(lambda x: x.filename == self.config.routine, inspect.stack())), None)
-        return stack_item.function if stack_item and stack_item.function else "function_name"
-
     def create_message(self, args, message_type=enum.MessageType.CORRECT):
         """
         [Internal]
@@ -8693,8 +8682,10 @@ def log_error(self, message, new_log_line=True, skip_restart=False, restart_coun
             system_info()
 
         stack_item = self.log.get_testcase_stack()
-        test_number = f"{stack_item.split('_')[-1]} -" if stack_item else ""
-        log_message = f"{test_number} {message}"
+        entrypoint_function = self.utils.get_main_entrypoint_from_stack()
+        entrypoint_prefix = f"[{entrypoint_function}] " if entrypoint_function and entrypoint_function != "function_name" else ""
+        test_number = f"{stack_item.split('_')[-1]} - " if stack_item else ""
+        log_message = f"{entrypoint_prefix}{test_number}{message}"
         self.message = log_message
         self.expected = False
         self.log.seconds = self.log.set_seconds(self.log.initial_time)