holado 0.13.22__py3-none-any.whl

holado_test/behave/scenario/behave_step_tools.py

@@ -0,0 +1,157 @@
+
+#################################################
+# HolAdo (Holistic Automation do)
+#
+# (C) Copyright 2021-2025 by Eric Klumpp
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+# The Software is provided “as is”, without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the Software.
+#################################################
+
+import logging
+from holado_core.common.exceptions.functional_exception import FunctionalException
+from holado_test.scenario.step_tools import StepTools
+from holado_value.common.tables.value_table import ValueTable
+from holado_scripting.common.tools.evaluate_parameters import EvaluateParameters
+import behave
+from holado_core.common.tools.tools import Tools
+
+
+
+logger = logging.getLogger(__name__)
+
+
+class BehaveStepTools(StepTools):
+    """
+    Gives usefull tools for steps files.
+    
+    Warning: In some cases, use of both step matcher "parse" and a parameter type 
+             will have mistake behaviours.
+             For example, the result can be that steps of other files are missing at execution for behave
+             whereas they are well found and imported in behave.
+             If this happens, use step matcher "re"
+    """
+    
+    ############################################################################
+    ## Manage step definitions
+
+
+
+    
+    DEFAULT_STEP_MATCHER = "re"
+    
+    @classmethod    
+    def use_step_matcher(cls, name):
+        behave.use_step_matcher(name)
+    
+    @classmethod    
+    def use_step_matcher_default(cls):
+        cls.use_step_matcher(cls.DEFAULT_STEP_MATCHER)
+    
+    # @classmethod
+    # def import_types(cls, module, prefix="SRE_", do_upper=False):
+    #     res = []
+    #     for type_name in cls.__registered_types:
+    #         var_name = f"{prefix}{type_name}"
+    #         if do_upper:
+    #             var_name = var_name.upper()
+    #         if not hasattr(module, var_name):
+    #             setattr(module, var_name, cls.get_registered_type_pattern(type_name))
+    #             res.append(var_name)
+    #     logger.debug(f"Imported step parameter types in module '{module.__name__}' as variables: {res}")
+    #     return res
+    
+    @classmethod    
+    def register_type(cls, type_name, pattern, eval_func, **eval_func_kwargs):
+        super().register_type(type_name, pattern, eval_func, **eval_func_kwargs)
+        
+        # Register type in parse step matcher
+        func = cls.get_registered_type_function(type_name)
+        cls.use_step_matcher('parse')
+        behave.register_type(**{type_name:func})
+        cls.use_step_matcher_default()
+    
+    
+    
+    ############################################################################
+    ## Manage step multiline text
+    
+    @classmethod    
+    def get_step_multiline_text(cls, context, eval_params=EvaluateParameters.default_without_raise(), raise_exception_if_none=True, log_level=logging.DEBUG):
+        """
+        Get the step multiline text interpreted.
+        Note: parameter context can be the step context or the step object.
+        """
+        res = None
+        if hasattr(context, "text") and context.text is not None:
+            res = context.text.strip()
+            if eval_params.do_interpret:
+                res = cls._get_text_interpreter().interpret(res, eval_params=eval_params, log_level=log_level)
+            
+        if res is None and raise_exception_if_none:
+            raise FunctionalException(f"Multiline text is required under this step\n  context: {context}")
+        
+        return res
+        
+    
+    ############################################################################
+    ## Manage step table
+    
+    @classmethod
+    def _is_scenario_step_table(cls, table):
+        return isinstance(table, behave.model.Table)
+    
+    @classmethod
+    def get_step_table(cls, context, do_eval_once=True):
+        """
+        Get the step table interpreted.
+        Note: parameter context can be the step context or the step object.
+        """
+        if hasattr(context, "table") and context.table is not None:
+            if cls.has_table_header(context.table):
+                res = cls.convert_step_table_2_value_table_with_header(context.table, do_eval_once=do_eval_once)
+            else:
+                res = cls.convert_step_table_2_value_table(context.table, do_eval_once=do_eval_once)
+            return res
+        else:
+            return None
+        
+    @classmethod        
+    def _get_table_header(cls, table):
+        return table.headings
+
+    @classmethod
+    def _get_table_rows(cls, table):
+        return table
+ 
+    @classmethod
+    def convert_step_table_2_value_table(cls, table, do_eval_once=True):
+        if Tools.do_log(logger, logging.TRACE):  # @UndefinedVariable
+            logger.trace(f"Converting step table to scenario table (step table = {table})")
+
+        res = ValueTable()
+        
+        # Set header as row
+        previous_row = None
+        srow = cls._convert_step_table_row_2_value_table_row(cls._get_table_header(table), previous_row, do_eval_once=do_eval_once)
+        res.add_row(row=srow)
+        
+        # Set body
+        previous_row = srow
+        for row in cls._get_table_rows(table):
+            srow = cls._convert_step_table_row_2_value_table_row(row, previous_row, do_eval_once=do_eval_once)
+            res.add_row(row=srow)
+            previous_row = srow
+            
+        # Manage one cell table referencing a variable containing a table
+        res = cls._extract_inner_table_if_present(res, do_eval_once=do_eval_once)
+            
+        if Tools.do_log(logger, logging.DEBUG):
+            logger.debug(f"Converting step table to scenario table (step table = {table}) => {res}")
+        return res
+        
+        
+        

holado_test/common/context/feature_context.py

@@ -0,0 +1,81 @@
+
+#################################################
+# HolAdo (Holistic Automation do)
+#
+# (C) Copyright 2021-2025 by Eric Klumpp
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+# The Software is provided “as is”, without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the Software.
+#################################################
+
+from builtins import super
+from holado.common.context.context import Context
+from holado_core.common.exceptions.technical_exception import TechnicalException
+from holado_scripting.common.tools.variable_manager import VariableManager
+from holado.common.context.session_context import SessionContext
+from holado_python.common.tools.datetime import DateTime
+
+class FeatureContext(Context):
+    def __init__(self, feature):
+        super().__init__("Feature")
+        
+        self.__feature = feature
+        
+        self.__start_date = DateTime.now()
+        self.__end_date = None
+        self.__scenarios = []
+    
+    def __str__(self):
+        return f"{{FeatureContext({id(self)}):{self.feature.name}}}"
+     
+    @property
+    def feature(self):
+        return self.__feature
+    
+    @property
+    def start_datetime(self):
+        return self.__start_date
+    
+    @property
+    def end_datetime(self):
+        return self.__end_date
+    
+    @property
+    def duration(self):
+        if self.__end_date is not None:
+            return (self.__end_date - self.__start_date).total_seconds()
+        else:
+            return None
+    
+    @property
+    def has_scenario(self):
+        return len(self.__scenarios) > 0
+    
+    @property
+    def current_scenario(self):
+        if not self.has_scenario:
+            raise TechnicalException("Feature has no scenario")
+        return self.__scenarios[-1]
+    
+    def add_scenario(self, scenario_context):
+        self.__scenarios.append(scenario_context)
+    
+    def end(self):
+        self.__end_date = DateTime.now()
+        
+    def has_variable_manager(self):
+        return self.has_object("variable_manager")
+        
+    def get_variable_manager(self) -> VariableManager:
+        if not self.has_variable_manager():
+            manager = VariableManager(SessionContext.instance().multitask_manager.get_thread_context().get_variable_manager())
+            self.set_object("variable_manager", manager)
+            file_path = SessionContext.instance().report_manager.current_feature_report.get_path("logs", "variable_update.log") if SessionContext.instance().with_session_path else None
+            manager.initialize(SessionContext.instance().dynamic_text_manager, SessionContext.instance().unique_value_manager,
+                               variable_update_log_file_path=file_path)
+        return self.get_object("variable_manager")
+    
+        

holado_test/common/context/scenario_context.py

@@ -0,0 +1,169 @@
+
+#################################################
+# HolAdo (Holistic Automation do)
+#
+# (C) Copyright 2021-2025 by Eric Klumpp
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+# The Software is provided “as is”, without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the Software.
+#################################################
+
+from builtins import super
+from holado_scripting.text.interpreter.text_interpreter import TextInterpreter
+from holado_scripting.common.tools.dynamic_text_manager import DynamicTextManager
+from holado_scripting.common.tools.variable_manager import VariableManager
+from holado.common.context.context import Context
+import logging
+from holado_scripting.common.tools.expression_evaluator import ExpressionEvaluator
+from holado.common.context.session_context import SessionContext
+from holado_core.common.block.scope_manager import ScopeManager
+from holado_core.common.block.block_manager import BlockManager
+from holado_core.common.exceptions.technical_exception import TechnicalException
+from holado_scripting.text.verifier.text_verifier import TextVerifier
+from holado_multitask.multitasking.multitask_manager import MultitaskManager
+from holado_python.common.tools.datetime import DateTime
+
+logger = logging.getLogger(__name__)
+
+
+class ScenarioContext(Context):
+    def __init__(self, scenario):
+        super().__init__("Scenario", with_post_process=True)
+        
+        self.__scenario = scenario
+        
+        self.__start_date = DateTime.now()
+        self.__end_date = None
+        
+        self.__main_thread_uid = SessionContext.instance().multitask_manager.main_thread_uid
+        self.__steps_by_thread_uid = {}
+        
+    def __str__(self):
+        return f"{{ScenarioContext({id(self)}):{self.scenario.name}}}"
+
+    @property
+    def scenario(self):
+        return self.__scenario
+    
+    @property
+    def start_datetime(self):
+        return self.__start_date
+    
+    @property
+    def end_datetime(self):
+        return self.__end_date
+    
+    @property
+    def duration(self):
+        if self.__end_date is not None:
+            return (self.__end_date - self.__start_date).total_seconds()
+        else:
+            return None
+    
+    def get_nb_steps(self, thread_uid=None):
+        if thread_uid is None:
+            thread_uid = MultitaskManager.get_thread_uid()
+        if thread_uid in self.__steps_by_thread_uid:
+            return len(self.__steps_by_thread_uid[thread_uid])
+        else:
+            return 0
+        
+    def has_step(self, thread_uid=None):
+        if thread_uid is None:
+            thread_uid = MultitaskManager.get_thread_uid()
+        return thread_uid in self.__steps_by_thread_uid and len(self.__steps_by_thread_uid[thread_uid]) > 0
+    
+    def get_current_step(self, thread_uid=None):
+        return self.get_step(-1, thread_uid=thread_uid)
+    
+    def add_step(self, step_context, thread_uid=None):
+        if thread_uid is None:
+            thread_uid = MultitaskManager.get_thread_uid()
+        if thread_uid not in self.__steps_by_thread_uid:
+            self.__steps_by_thread_uid[thread_uid] = []
+        self.__steps_by_thread_uid[thread_uid].append(step_context)
+    
+    def get_step(self, index, thread_uid=None):
+        if thread_uid is None:
+            thread_uid = MultitaskManager.get_thread_uid()
+        if not self.has_step(thread_uid):
+            raise TechnicalException(f"Scenario has no step (for thread UID '{thread_uid}'")
+        if index >= len(self.__steps_by_thread_uid[thread_uid]):
+            raise TechnicalException(f"Step index exceeds number of steps in thread of UID '{thread_uid}' (index {index} >= {len(self.__steps_by_thread_uid[thread_uid])})")
+        return self.__steps_by_thread_uid[thread_uid][index]
+    
+    @property
+    def block_manager(self):
+        if not self.has_object("block_manager"):
+            self.set_object("block_manager", BlockManager())
+        return self.get_object("block_manager")
+    
+    @property
+    def scope_manager(self):
+        if not self.has_object("scope_manager"):
+            self.set_object("scope_manager", ScopeManager())
+        return self.get_object("scope_manager")
+
+
+    def has_dynamic_text_manager(self):
+        return self.has_object("dynamic_text_manager")
+        
+    def get_dynamic_text_manager(self) -> DynamicTextManager:
+        if not self.has_dynamic_text_manager():
+            dynamic_text_manager = DynamicTextManager("scenario")
+            self.set_object("dynamic_text_manager", dynamic_text_manager)
+            dynamic_text_manager.initialize(SessionContext.instance().unique_value_manager)
+        return self.get_object("dynamic_text_manager")
+        
+    def has_text_interpreter(self):
+        return self.has_object("text_interpreter")
+        
+    def get_text_interpreter(self):
+        if not self.has_text_interpreter():
+            interpreter = TextInterpreter()
+            self.set_object("text_interpreter", interpreter)
+            interpreter.initialize(self.get_variable_manager(), self.get_expression_evaluator(), self.get_text_verifier(), self.get_dynamic_text_manager())
+        return self.get_object("text_interpreter")
+        
+    def has_text_verifier(self):
+        return self.has_object("text_verifier")
+        
+    def get_text_verifier(self):
+        if not self.has_text_verifier():
+            verifier = TextVerifier()
+            self.set_object("text_verifier", verifier)
+            verifier.initialize(self.get_variable_manager(), self.get_expression_evaluator(), self.get_text_interpreter())
+        return self.get_object("text_verifier")
+        
+    def has_variable_manager(self):
+        return self.has_object("variable_manager")
+        
+    def get_variable_manager(self) -> VariableManager:
+        if not self.has_variable_manager():
+            manager = VariableManager(SessionContext.instance().get_feature_context().get_variable_manager())
+            self.set_object("variable_manager", manager)
+            file_path = SessionContext.instance().report_manager.current_scenario_report.get_path("logs", "variable_update.log") if SessionContext.instance().with_session_path else None
+            manager.initialize(self.get_dynamic_text_manager(), SessionContext.instance().unique_value_manager,
+                               variable_update_log_file_path=file_path)
+        return self.get_object("variable_manager")
+    
+    def has_expression_evaluator(self):
+        return self.has_object("expression_evaluator")
+    
+    def get_expression_evaluator(self) -> ExpressionEvaluator:
+        if not self.has_expression_evaluator():
+            evaluator = ExpressionEvaluator()
+            self.set_object("expression_evaluator", evaluator)
+            uvm = SessionContext.instance().unique_value_manager
+            evaluator.initialize(self.get_dynamic_text_manager(), uvm, self.get_text_interpreter(), self.get_variable_manager())
+        return self.get_object("expression_evaluator")
+    
+    def end(self):
+        # End scenario
+        self.__end_date = DateTime.now()
+
+
+        

holado_test/common/context/step_context.py

@@ -0,0 +1,66 @@
+
+#################################################
+# HolAdo (Holistic Automation do)
+#
+# (C) Copyright 2021-2025 by Eric Klumpp
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+# The Software is provided “as is”, without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the Software.
+#################################################
+
+from builtins import super
+from holado.common.context.context import Context
+import logging
+from holado_python.common.tools.datetime import DateTime
+
+logger = logging.getLogger(__name__)
+
+
+class StepContext(Context):
+    def __init__(self, step, do_start=True):
+        super().__init__("Step")
+        
+        self.__step = step
+        self.__status = None
+        
+        self.__start_date = DateTime.now() if do_start else None
+        self.__end_date = None
+    
+    def __str__(self):
+        return f"{{StepContext({id(self)}):{self.step.keyword} {self.step.name}}}"
+
+    @property
+    def step(self):
+        return self.__step
+    
+    @property
+    def status(self):
+        return self.__status
+    
+    @status.setter
+    def status(self, status):
+        self.__status = status
+    
+    @property
+    def start_datetime(self):
+        return self.__start_date
+    
+    @property
+    def end_datetime(self):
+        return self.__end_date
+    
+    @property
+    def duration(self):
+        if self.__start_date is not None and self.__end_date is not None:
+            return (self.__end_date - self.__start_date).total_seconds()
+        else:
+            return None
+    
+    def end(self):
+        self.__end_date = DateTime.now()
+    
+
+        

holado_test/common/exceptions/undefined_step_exception.py

@@ -0,0 +1,21 @@
+
+#################################################
+# HolAdo (Holistic Automation do)
+#
+# (C) Copyright 2021-2025 by Eric Klumpp
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+# The Software is provided “as is”, without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the Software.
+#################################################
+
+from builtins import super
+from holado_core.common.exceptions.technical_exception import TechnicalException
+
+class UndefinedStepException(TechnicalException):
+    def __init__(self, message):
+        super().__init__(message)
+        
+