holado 0.2.1__py3-none-any.whl → 0.2.3__py3-none-any.whl

holado_core/common/block/scope_steps.py

@@ -0,0 +1,141 @@
+
+#################################################
+# 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
+import logging
+from holado_core.common.block.base import BaseScope
+from holado_core.common.block.block_steps import BlockSteps
+from holado_test.behave.behave import execute_steps
+from holado_core.common.tools.converters.converter import Converter
+from holado_core.common.exceptions.functional_exception import FunctionalException
+from holado_core.common.tools.tools import Tools
+from holado_python.standard_library.typing import Typing
+
+logger = logging.getLogger(__name__)
+
+
+class ScopeSteps(BaseScope):
+    '''
+    Scope block that should only contains steps.
+    This scope block is used when a new scope (function, for,...) is defined in a scenario.
+
+    When processing this scope, a 'context' is supposed to be passed as parameter to 'process' method
+    Warning: it remains possible to add any block, not only steps. Be carefull that added blocks are compatible with parameter 'context' passed to 'process' method.
+    '''
+    
+    def __init__(self, name, ID=None):
+        super().__init__(f"steps scope {name}", ID=ID)
+        
+    def add_steps(self, steps_str):
+        if Tools.do_log(logger, logging.DEBUG):
+            logger.debug(f"In scope '{self.name}', add steps:\n{steps_str}")
+        self.add_block( BlockSteps(steps_str) )
+    
+class ScopeForSteps(ScopeSteps):
+    def __init__(self, name, iter_var_name, iterable, ID=None, variable_manager=None, scope_manager=None):
+        super().__init__(name, ID=ID)
+        
+        self.__iter_var_name = iter_var_name
+        self.__iterable = iterable
+        
+        self.__variable_manager = variable_manager
+        self.__scope_manager = scope_manager
+    
+    def process(self, *args, **kwargs):
+        """
+        Process the scope.
+        Returns last scope step result
+        """
+        res = None
+        if Tools.do_log(logger, logging.DEBUG):
+            logger.debug(f"Processing scope [{self.name}]: begin")
+
+        self._process_start()
+        try:
+            for index, value in enumerate(self.__iterable):
+                execute_steps(u"""
+                    Given FOR_INDEX_{iter_var_name} = {index}
+                    """.format(iter_var_name=self.__iter_var_name, index=index))
+                self.__variable_manager.register_variable(self.__iter_var_name, value)
+                
+                if self.__scope_manager:
+                    level_already_exists = self.__scope_manager.has_scope_level("steps")
+                    origin_level = self.__scope_manager.scope_level("steps")
+                    if level_already_exists:
+                        self.__scope_manager.increase_scope_level("steps")
+                
+                try:
+                    self._process_blocks(*args, **kwargs)
+                finally:
+                    if self.__scope_manager:
+                        self.__scope_manager.reset_scope_level("steps", origin_level)
+        finally:
+            self._process_end()
+            if Tools.do_log(logger, logging.DEBUG):
+                logger.debug(f"Processing scope [{self.name}]: end")
+
+        return res
+    
+class ScopeWhileSteps(ScopeSteps):
+    def __init__(self, name, condition_expression, ID=None, expression_evaluator=None, scope_manager=None):
+        super().__init__(name, ID=ID)
+        
+        self.__condition_expression = condition_expression
+        
+        self.__expression_evaluator = expression_evaluator
+        self.__scope_manager = scope_manager
+    
+    def process(self, *args, **kwargs):
+        """
+        Process the scope.
+        Returns last scope step result
+        """
+        res = None
+        if Tools.do_log(logger, logging.DEBUG):
+            logger.debug(f"Processing scope [{self.name}]: begin")
+
+        self._process_start()
+        try:
+            n = 0
+            cond = self.__expression_evaluator.evaluate_python_expression(self.__condition_expression)
+            if not (isinstance(cond, bool) or Converter.is_boolean(cond)):
+                raise FunctionalException(f"Condition expression is not a boolean: [{self.__condition_expression}] => [{cond}] (type: {Typing.get_object_class_fullname(cond)})")
+            
+            while isinstance(cond, bool) and cond or Converter.is_boolean(cond) and Converter.to_boolean(cond):
+                n += 1
+                execute_steps(u"""
+                    Given WHILE_ITERATION = {n}
+                    """.format(n=n))
+                
+                if self.__scope_manager:
+                    level_already_exists = self.__scope_manager.has_scope_level("steps")
+                    origin_level = self.__scope_manager.scope_level("steps")
+                    if level_already_exists:
+                        self.__scope_manager.increase_scope_level("steps")
+                
+                try:
+                    self._process_blocks(*args, **kwargs)
+                finally:
+                    if self.__scope_manager:
+                        self.__scope_manager.reset_scope_level("steps", origin_level)
+                
+                cond = self.__expression_evaluator.evaluate_python_expression(self.__condition_expression)
+                if not (isinstance(cond, bool) or Converter.is_boolean(cond)):
+                    raise FunctionalException(f"Condition expression is not a boolean: [{self.__condition_expression}] => [{cond}] (type: {Typing.get_object_class_fullname(cond)})")
+        finally:
+            self._process_end()
+            if Tools.do_log(logger, logging.DEBUG):
+                logger.debug(f"Processing scope [{self.name}]: end")
+
+        return res
+    

holado_core/common/criterias/and_criteria.py

@@ -0,0 +1,61 @@
+#################################################
+# 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 holado_core.common.criterias.tools.criteria_context import CriteriaContext
+from holado_core.common.criterias.tools.criteria_parameters import CriteriaParameters
+import logging
+
+logger = logging.getLogger(__name__)
+
+
+
+class AndCriteria(object):
+    """ Criteria that makes a logical or between added criterias.
+    """
+    
+    def __init__(self):
+        self.__criterias = []
+    
+    @property
+    def criterias(self):
+        return self.__criterias
+    
+    def add_criteria(self, criteria):
+        """
+        Add a criteria in and validation.
+        @param criteria Criteria
+        """
+        self.__criterias.append(criteria)
+        
+    def validate_element(self, element, criteria_context: CriteriaContext, criteria_parameters: CriteriaParameters):
+        return super().validate_element(element, criteria_context, criteria_parameters) \
+            and self.__validate_criterias(element, criteria_context, criteria_parameters)
+
+    def __validate_criterias(self, element, criteria_context, criteria_parameters):
+        res = True
+        sub_parameters = criteria_parameters.get_next_level()
+        
+        for criteria in self.criterias:
+            if not criteria.validate(element, criteria_context, sub_parameters):
+                res = False
+                break
+        
+        return res
+
+    def __str__(self):
+        res_criterias = []
+        for index, criteria in self.criterias:
+            res_criterias.append(f"{index}:{{{criteria}}}")
+        return super().__str__() + "&{" + "&".join(res_criterias) + "}"
+    
+    
+    

holado_core/common/criterias/criteria.py

@@ -0,0 +1,78 @@
+#################################################
+# 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 holado_core.common.exceptions.technical_exception import TechnicalException
+from holado_core.common.tools.tools import Tools
+from holado_core.common.criterias.tools.criteria_context import CriteriaContext,\
+    ContainerCriteriaContext
+from holado_core.common.criterias.tools.criteria_parameters import CriteriaParameters
+from holado.holado_config import Config
+import logging
+import abc
+
+logger = logging.getLogger(__name__)
+
+
+
+class Criteria(object):
+    """ Base class of a family used to validate elements.
+    """
+    __metaclass__ = abc.ABCMeta
+    
+    def validate(self, element, criteria_context: CriteriaContext, criteria_parameters: CriteriaParameters):
+        """ Verify if element verifies expected criteria.
+        If element is None and criteria_context is a ContainerCriteriaContext, criteria_context.container is used as element
+        @param element Element to validate
+        @param criteria_context Criteria context
+        @param criteria_parameters Criteria parameters
+        @return True if given element verifies expected criteria
+        """
+        if element is None:
+            if isinstance(criteria_context, ContainerCriteriaContext) and criteria_context.container is not None:
+                return self.validate(criteria_context.container, criteria_context, criteria_parameters)
+            else:
+                raise TechnicalException("Find context has no container")
+            
+        # Prepare analyze time spent
+        if criteria_parameters.analyze_time_spent:
+            start = Tools.timer_s()
+        
+        res = self.validate_element(element, criteria_context, criteria_parameters)
+        
+        # Analyze time spent
+        if criteria_parameters.analyze_time_spent:
+            duration = Tools.timer_s() - start
+            if duration > Config.threshold_warn_time_spent_s:
+                logger.warning(f"{self._get_indent_string_level(criteria_parameters)}[{self}].validate({element}) -> {res} (took {duration} s)")
+        
+        return res
+
+    def validate_element(self, element, criteria_context: CriteriaContext, criteria_parameters: CriteriaParameters):
+        return True
+
+    def __str__(self):
+        return self.__class__.__name__
+
+    def reset(self):
+        """ Reset the criteria."""
+        pass
+    
+    def _get_indent_string_level(self, criteria_parameters: CriteriaParameters=None, level=None):
+        if level is not None:
+            return Tools.get_indent_string(level * 4)
+        elif criteria_parameters is not None:
+            return self._get_indent_string_level(level=criteria_parameters.find_level)
+        else:
+            raise TechnicalException("level or criteria_parameters must be defined")
+    
+    
+    

holado_core/common/criterias/or_criteria.py

@@ -0,0 +1,64 @@
+#################################################
+# 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 holado_core.common.criterias.tools.criteria_context import CriteriaContext
+from holado_core.common.criterias.tools.criteria_parameters import CriteriaParameters
+import logging
+
+logger = logging.getLogger(__name__)
+
+
+
+class OrCriteria(object):
+    """ Criteria that makes a logical or between added criterias.
+    """
+    
+    def __init__(self):
+        self.__criterias = []
+    
+    @property
+    def criterias(self):
+        return self.__criterias
+    
+    def add_criteria(self, criteria):
+        """
+        Add a criteria in or validation.
+        @param criteria Criteria
+        """
+        self.__criterias.append(criteria)
+        
+    def validate_element(self, element, criteria_context: CriteriaContext, criteria_parameters: CriteriaParameters):
+        return super().validate_element(element, criteria_context, criteria_parameters) \
+            and self.__validate_criterias(element, criteria_context, criteria_parameters)
+
+    def __validate_criterias(self, element, criteria_context, criteria_parameters):
+        if len(self.criterias) == 0:
+            return True
+        
+        res = False
+        sub_parameters = criteria_parameters.get_next_level()
+        
+        for criteria in self.criterias:
+            if criteria.validate(element, criteria_context, sub_parameters):
+                res = True
+                break
+        
+        return res
+
+    def __str__(self):
+        res_criterias = []
+        for index, criteria in self.criterias:
+            res_criterias.append(f"{index}:{{{criteria}}}")
+        return super().__str__() + "&{" + "|".join(res_criterias) + "}"
+    
+    
+    

holado_core/common/criterias/tools/criteria_context.py

@@ -0,0 +1,20 @@
+#################################################
+# 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 self 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 self 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 holado_core.common.finders.tools.find_context import FindContext,\
+    WithRootContainerFindContext, ContainerFindContext
+
+
+CriteriaContext = FindContext
+WithRootContainerCriteriaContext = WithRootContainerFindContext
+ContainerCriteriaContext = ContainerFindContext
+

holado_core/common/criterias/tools/criteria_parameters.py

@@ -0,0 +1,18 @@
+#################################################
+# 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 self 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 self 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 holado_core.common.finders.tools.find_parameters import FindParameters
+
+
+CriteriaParameters = FindParameters
+
+

holado_core/common/drivers/driver.py

@@ -0,0 +1,153 @@
+#################################################
+# 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 self 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 self 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
+import abc
+from holado_core.common.exceptions.technical_exception import TechnicalException
+from holado.common.handlers.object import DeleteableObject
+from holado_core.common.exceptions.functional_exception import FunctionalException
+from holado_core.common.finders.tools.find_builder import FindBuilder
+from holado.common.handlers.enums import ObjectStates
+
+logger = logging.getLogger(__name__)
+
+
+
+class Driver(DeleteableObject):
+    """ Base class for drivers.
+    """
+    __metaclass__ = abc.ABCMeta
+    
+    def __init__(self, name=None):
+        super().__init__(name or "Driver")
+        
+        self.__internal_driver = None
+        self.__internal_api = None
+        
+        # Tools
+        self.__text_verifier = None
+        self.__find_builder = None      # Builder used to create default find context and parameters
+    
+    @property
+    def _has_internal_driver(self):
+        """
+        @return If internal driver is defined
+        """
+        return self.__internal_driver is not None
+    
+    @property
+    def internal_driver(self):
+        """
+        @return Internal driver
+        """
+        if not self._has_internal_driver():
+            raise TechnicalException("Internal driver is not defined.")
+        return self.__internal_driver
+    
+    @internal_driver.setter
+    def internal_driver(self, internal_driver):
+        self.__internal_driver = internal_driver
+    
+    @property
+    def internal_api(self):
+        """
+        @return Internal API
+        """
+        if self.__internal_api is None:
+            raise TechnicalException("Internal API is not defined.")
+        return self.__internal_api
+    
+    @property
+    def text_verifier(self):
+        """
+        @return Text verifier to use
+        """
+        if self.__text_verifier is None:
+            raise TechnicalException("Text verifier is not defined")
+        return self.__text_verifier
+    
+    @text_verifier.setter
+    def text_verifier(self, text_verifier):
+        """
+        @param text_verifier Text verifier to use
+        """
+        self.__text_verifier = text_verifier
+    
+    @property
+    def find_builder(self):
+        """
+        @return Find builder (if not set a default one is instantiated)
+        """
+        if self.__find_builder is None:
+            self.__find_builder = FindBuilder()
+        return self.__find_builder
+    
+    @find_builder.setter
+    def find_builder(self, find_builder):
+        """
+        @param find_builder Find builder to use rather than default
+        """
+        self.__find_builder = find_builder
+    
+    def initialize(self):
+        """
+        Initialize driver
+        """
+        self.__internal_api = self._initialize_internal_api()
+    
+    def _initialize_internal_api(self):
+        """
+        Method used internally at driver initialization, in order to instantiate the appropriate internal API type.
+        @return a new internal API instance
+        """
+        raise NotImplementedError
+
+    def is_open(self):
+        """
+        @return True if driver is open
+        """
+        return self._has_internal_driver()
+    
+    def _verify_is_open(self):
+        if not self.is_open():
+            raise FunctionalException("Driver is not opened")
+    
+    def open(self):
+        """
+        Open driver
+        """
+        self.object_state = ObjectStates.Opening
+        self._close_driver()
+        self.object_state = ObjectStates.Open
+
+    def _open_driver(self):
+        """
+        Implement open process
+        """
+        raise NotImplementedError
+    
+    def close(self):
+        """
+        Close driver
+        """
+        self.object_state = ObjectStates.Closing
+        self._close_driver()
+        self.object_state = ObjectStates.Closed
+    
+    def _close_driver(self):
+        """
+        Implement close process
+        """
+        raise NotImplementedError
+    
+    
+    

holado_core/common/drivers/element_driver.py

@@ -0,0 +1,30 @@
+#################################################
+# 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 self 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 self 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
+import abc
+from holado_core.common.drivers.driver import Driver
+
+logger = logging.getLogger(__name__)
+
+
+
+class ElementDriver(Driver):
+    """ Base class for element drivers.
+    """
+    __metaclass__ = abc.ABCMeta
+    
+    def __init__(self, name=None):
+        super().__init__(name or "ElementDriver")
+    
+    
+