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

holado_value/common/tools/value.py

@@ -0,0 +1,164 @@
+
+#################################################
+# 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 str
+from holado_core.common.exceptions.technical_exception import TechnicalException
+from holado_core.common.tools.tools import Tools
+from holado.common.context.session_context import SessionContext
+import logging
+from holado_value.common.tools.value_types import ValueTypes
+from functools import total_ordering
+from holado_scripting.common.tools.evaluate_parameters import EvaluateParameters
+from holado.holado_config import Config
+from holado.common.handlers.undefined import undefined_value
+from holado_python.standard_library.typing import Typing
+
+logger = logging.getLogger(__name__)
+
+
+@total_ordering
+class Value(object):
+    
+    def __init__(self, original_value=undefined_value, value=undefined_value, do_eval_once=True, eval_params=undefined_value):
+        """
+        @summary: Constructor
+        @param original_value: Original value - can be a string or any object
+        @param value: Value - can be a string or any object
+        """
+        self.__value_original = undefined_value
+        self.__type = None
+        self.__value = undefined_value
+        
+        # Manage value evaluation
+        self.__value_to_eval = undefined_value
+        self.__value_evaluated = undefined_value
+        # By default, raise on interpret and variable evaluation error, but not on eval error
+        self.__eval_params_default = eval_params if eval_params is not undefined_value else EvaluateParameters.default().with_raise_on_eval_error(False)
+        self.__do_eval_once = do_eval_once
+        
+        self.__extract_value_information(original_value, value)
+        if Tools.do_log(logger, logging.TRACE):  # @UndefinedVariable
+            logger.trace(f"New Value: value_original=[{self.__value_original}] ; type=[{self.value_type.name}] ; value=[{self.__value}] ; value_to_eval=[{self.__value_to_eval}]")
+        
+    def _verify_valid_compared_object(self, other, raise_exception=True):
+        res = isinstance(other, Value)
+        if not res and raise_exception:
+            return TechnicalException(f"Unmanaged comparison between types '{self.__class__.__name__}' and '{other.__class__.__name__}'")
+        
+    def __eq__(self, other):
+        self._verify_valid_compared_object(other)
+        if isinstance(other, Value):
+            return (self.get_value() == other.get_value())
+        else:
+            return TechnicalException(f"Unmanaged comparison between types '{self.__class__.__name__}' and '{other.__class__.__name__}'")
+    
+    def __lt__(self, other):
+        self._verify_valid_compared_object(other)
+        if isinstance(other, Value):
+            return (self.get_value() < other.get_value())
+        else:
+            return TechnicalException(f"Unmanaged comparison between types '{self.__class__.__name__}' and '{other.__class__.__name__}'")
+
+    @property
+    def string_value(self):
+        value = self.get_value()
+        
+        if value is undefined_value:
+            return Config.NOT_APPLICABLE_SYMBOL
+        if value is None:
+            return Config.NONE_SYMBOL
+        else:
+            return str(value)
+    
+    @property
+    def value_original(self):
+        """
+        @summary: Return the original value
+        """
+        return self.__value_original
+    
+    @property
+    def value_type(self):
+        return self.__type
+    
+    @property
+    def value_before_eval(self):
+        """
+        @summary: Return the value before evaluation
+        """
+        return self.__value_to_eval
+    
+    @property
+    def value(self):
+        """
+        @summary: Return the value, after evaluation if needed
+        """
+        return self.get_value(raise_if_undefined=True)
+    
+    def get_value(self, raise_if_undefined=False, eval_params=undefined_value):
+        if self.__value_to_eval is not undefined_value:
+            if self.__value_evaluated is undefined_value or not self.__do_eval_once:
+                eval_params = eval_params if eval_params is not undefined_value else self.__eval_params_default
+                self.__value_evaluated = self.__get_expression_evaluator().evaluate_expression_of_information(self.__type, self.__value_to_eval, eval_params=eval_params)
+            res = self.__value_evaluated
+        else:
+            res = self.__value
+        
+        if res is undefined_value and raise_if_undefined:
+            msg = "Value is undefined"
+            if self.value_type == ValueTypes.NotApplicable:
+                msg += " (Not Applicable)"
+            raise ValueError(f"Value is undefined (value type: {self.value_type.name} ; original value: [{self.value_original}] (type: {Typing.get_object_class_fullname(self.value_original)}))")
+        return res
+    
+    def represent(self, indent = 0, do_evaluation = False):
+        res_list = []
+        
+        res_list.append(Tools.get_indent_string(indent))
+        
+        if self.__type in [ValueTypes.String, ValueTypes.DynamicString, ValueTypes.ThreadDynamicString, ValueTypes.UniqueString]:
+            if do_evaluation:
+                res_list.append("'")
+                res_list.append(self.string_value)
+                res_list.append("'")
+            else:
+                res_list.append(str(self.value_original))
+        elif self.__type in [ValueTypes.Boolean, ValueTypes.Integer, ValueTypes.Float, ValueTypes.Null, ValueTypes.NotApplicable, ValueTypes.Symbol, ValueTypes.Generic]:
+            if do_evaluation:
+                res_list.append(self.string_value)
+            else:
+                res_list.append(str(self.value_original))
+        else:
+            raise TechnicalException("Unmanaged value type '{}'".format(self.__type.name))
+        
+        return "".join(res_list)
+        
+    def __extract_value_information(self, value_original, value):
+        # Define original value
+        if value_original is not undefined_value and not (value_original is None and value not in [undefined_value, None]):
+            self.__value_original = value_original
+        elif value is not undefined_value:
+            if value is not None and isinstance(value, str):
+                self.__value_original = f"'{value}'"
+            else:
+                self.__value_original = value
+        
+        # Define value information from original value
+        self.__type, self.__value, self.__value_to_eval = self.__get_expression_evaluator().extract_expression_information(self.value_original)
+        
+    def __get_expression_evaluator(self):
+        if SessionContext.instance().has_scenario_context():
+            return SessionContext.instance().get_scenario_context().get_expression_evaluator()
+        else:
+            return SessionContext.instance().expression_evaluator
+        

holado_value/common/tools/value_types.py

@@ -0,0 +1,35 @@
+
+#################################################
+# 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.common.handlers.enums import AutoNumber
+
+
+class ValueTypes(AutoNumber):
+    """
+    @summary: Value types in scenario
+    """
+    
+    Undefined = ()
+    Boolean = ()
+    Integer = ()
+    Float = ()
+    String = ()
+    DynamicString = ()
+    ThreadDynamicString = ()
+    UniqueString = ()
+    Null = ()
+    NotApplicable = ()
+    Merged = ()
+    Symbol = ()
+    Generic = ()
+

holado_value/tests/behave/steps/__init__.py

@@ -0,0 +1,16 @@
+# -*- coding: utf-8 -*-
+
+#################################################
+# 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 .xxx import *

holado_value/tests/behave/steps/private/__init__.py

@@ -0,0 +1,16 @@
+# -*- coding: utf-8 -*-
+
+#################################################
+# 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 .xxx import *

holado_ws/__init__.py

@@ -0,0 +1,16 @@
+# -*- coding: utf-8 -*-
+
+#################################################
+# 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.
+#################################################
+
+
+

holado_ws/api/ws/TODO.txt

@@ -0,0 +1,2 @@
+Client WS
+Client WS dynamic

holado_ws/tests/behave/steps/__init__.py

@@ -0,0 +1,16 @@
+# -*- coding: utf-8 -*-
+
+#################################################
+# 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 .api.web_service_steps import *

holado_ws/tests/behave/steps/api/web_service_steps.py

@@ -0,0 +1,189 @@
+# -*- coding: utf-8 -*-
+
+#################################################
+# 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.tools.tools import Tools
+from holado_core.common.tables.table_with_header import TableWithHeader
+from holado_value.common.tables.comparators.table_2_value_table_comparator import Table2ValueTable_Comparator
+from holado_core.common.tables.table_manager import TableManager
+from holado_value.common.tables.value_table_manager import ValueTableManager
+from holado.common.context.session_context import SessionContext
+from holado_core.common.exceptions.functional_exception import FunctionalException
+from holado_core.common.exceptions.technical_exception import TechnicalException
+from holado_test.behave.behave import *
+from holado_test.behave.scenario.behave_step_tools import BehaveStepTools
+from holado_value.common.tables.converters.value_table_converter import ValueTableConverter
+from holado_test.scenario.step_tools import StepTools
+from holado_python.standard_library.typing import Typing
+
+logger = logging.getLogger(__name__)
+
+
+# Configure module to use internally
+try:
+    from suds.sudsobject import Printer, Object, Facade  # @UnresolvedImport @UnusedImport
+    import suds.client  # @UnresolvedImport
+    from suds.cache import NoCache  # @UnresolvedImport
+    with_suds = True
+    if Tools.do_log(logger, logging.DEBUG):
+        logger.debug("Module 'suds' will be used in web service steps")
+except Exception as exc:
+    with_suds_exception = exc
+    with_suds = False
+
+if not with_suds:
+    try:
+        import zeep  # @UnresolvedImport
+        from zeep.transports import Transport  # @UnresolvedImport
+        with_zeep = True
+        if Tools.do_log(logger, logging.DEBUG):
+            logger.debug("Module 'zeep' will be used in web service steps")
+    except Exception as exc:
+        with_zeep_exception = exc
+        with_zeep = False
+
+if not with_suds and not with_zeep:
+    if Tools.do_log(logger, logging.DEBUG):
+        logger.debug(f"Web service module is not available. No package was found to manage web service steps (managed packages: suds, zeep).\nInitialization failed with suds on error: {with_suds_exception}\nInitialization failed with zeep on error: {with_zeep_exception}")
+
+
+def __get_scenario_context():
+    return SessionContext.instance().get_scenario_context()
+
+def __get_text_interpreter():
+    return __get_scenario_context().get_text_interpreter()
+
+def __get_variable_manager():
+    return __get_scenario_context().get_variable_manager()
+
+@Given(r"open web service client for WSDL (?P<wsdl_file>{Str})")
+def step_impl(context, wsdl_file):
+    wsdl_file = StepTools.evaluate_scenario_parameter(wsdl_file)
+    
+    if with_suds:
+        context.ws_client = suds.client.Client(wsdl_file, cache=NoCache())
+    elif with_zeep:
+        transport = Transport(cache=None)
+        context.ws_client = zeep.Client(wsdl_file, transport=transport)
+    else:
+        raise TechnicalException("No module was found to manage web service steps (managed modules: suds, zeep)")
+
+@Given(r"open (?P<ws_name>{Str}) web service client")
+def step_impl(context, ws_name):  # @DuplicatedSignature
+    ws_name = StepTools.evaluate_scenario_parameter(ws_name)
+    
+    wsdl_file = 'http://10.0.3.247/{}/?wsdl'.format(ws_name)
+    step = u"Given open web service client for WSDL '{}'".format(wsdl_file)
+    execute_steps(step)
+
+@Given(r'close web service client')
+def step_impl(context):  # @DuplicatedSignature
+    del context.ws_client
+
+@When(r"(?P<var_name>{Variable}) = call web service (?P<method_name>{Str}) with parameters")
+def step_impl(context, var_name, method_name):  # @DuplicatedSignature
+    var_name = StepTools.evaluate_variable_name(var_name)
+    method_name = StepTools.evaluate_scenario_parameter(method_name)
+    table = BehaveStepTools.convert_step_table_2_value_table_with_header(context.table)
+    parameters = ValueTableConverter.convert_name_value_table_2_dict(table)
+    logger.info("call web service '{}' with parameters [{}]".format(method_name, parameters))
+    
+    # Verify web service method
+    if not hasattr(context, 'ws_client') or context.ws_client is None:
+        raise FunctionalException("No web service is opened")
+    try:
+        method = getattr(context.ws_client.service, method_name)
+    except:
+        raise FunctionalException("Method '{}' doesn't exist in web service".format(method_name))
+    
+    # Call web service method
+    result = method(**parameters)
+
+    # Store result in variable
+    logger.info("result of web service '{}': [{}]".format(method_name, result))
+    __get_variable_manager().register_variable(var_name, result)
+
+
+@Given(r"(?P<var_name>{Variable}) = new (?P<type_name>{Str}) from web service")
+def step_impl(context, var_name, type_name):  # @DuplicatedSignature
+    var_name = StepTools.evaluate_variable_name(var_name)
+    type_name = StepTools.evaluate_string_parameter(type_name)
+    # Verify web service
+    if not hasattr(context, 'ws_client') or context.ws_client is None:
+        raise FunctionalException("No web service is opened")
+
+    table = BehaveStepTools.convert_step_table_2_value_table_with_header(context.table)
+    
+    # Create object instance
+    if with_suds:
+        obj = context.ws_client.factory.create(type_name)
+    elif with_zeep:
+        obj = getattr(context.ws_client.type_factory('asgard.api_reseaux.tns'), type_name)()
+    else:
+        raise TechnicalException("No module was found to manage web service steps (managed modules: suds, zeep)")
+    
+    # Fill object
+    if type_name == "stringArray":
+        # Verify table structure
+        ValueTableManager.verify_table_is_value_table(table)
+        
+        # Fill stringArray
+        for row in table.rows:
+            obj.string.append(row.get_cell(0).value)
+    else:
+        ValueTableManager.set_object_attributes_according_name_value_table(obj, table)
+    
+    # Store in variable
+    __get_variable_manager().register_variable(var_name, obj)
+
+@Then(r"(?P<object_string>{Str}) is (?P<type_name>{Str}) from web service")
+def step_impl(context, object_string, type_name):  # @DuplicatedSignature
+    obj = StepTools.evaluate_scenario_parameter(object_string)
+    type_name = StepTools.evaluate_string_parameter(type_name)
+    table = BehaveStepTools.convert_step_table_2_value_table_with_header(context.table)
+    
+    # Verify web service
+    if not hasattr(context, 'ws_client') or context.ws_client is None:
+        raise FunctionalException("No web service is opened")
+    
+    if with_suds:
+        ws_obj = context.ws_client.factory.create(type_name)
+    elif with_zeep:
+        ws_obj = getattr(context.ws_client.type_factory('asgard.api_reseaux.tns'), type_name)()
+    else:
+        raise TechnicalException("No module was found to manage web service steps (managed modules: suds, zeep)")
+        
+    if isinstance(obj, Typing.get_object_class(ws_obj)):
+        if type_name == "stringArray":
+            # Convert stringArray to table
+            obj_table = TableWithHeader()
+            obj_table.header.add_cells_from_contents(["Value"])
+            for obj_str in obj.string:
+                obj_table.add_row(cells_content=[obj_str])
+            
+            # Compare tables
+            comparator = Table2ValueTable_Comparator()
+            comparator.equals(obj_table, table)
+        else:
+            # Convert object to table
+            obj_table = TableManager.convert_object_attributes_2_name_value_table(obj)
+            
+            # Compare tables
+            comparator = Table2ValueTable_Comparator()
+            comparator.equals(obj_table, table)
+    else:
+        raise FunctionalException("Object is of type '{}' (expected type: '{}' ; type_name: '{}')".format(Typing.get_object_class_fullname(obj), Typing.get_object_class_fullname(ws_obj), type_name))
+
+

holado_yaml/__init__.py

@@ -0,0 +1,31 @@
+# -*- coding: utf-8 -*-
+
+#################################################
+# 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.
+#################################################
+
+
+def dependencies():
+    """
+    Return None or the list of names of modules it depend on
+    """
+    return None
+
+def register():
+    """
+    Register the services of this module
+    """
+    # from holado.common.context.session_context import SessionContext
+    
+    # from holado_xxx.xxx import XXXManager
+    # SessionContext.instance().services.register_service_type("xxx_manager", XXXManager)
+    pass
+

holado_yaml/tests/behave/steps/__init__.py

@@ -0,0 +1,16 @@
+# -*- coding: utf-8 -*-
+
+#################################################
+# 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 .yaml_steps import *

holado_yaml/tests/behave/steps/yaml_steps.py

@@ -0,0 +1,64 @@
+# -*- coding: utf-8 -*-
+
+#################################################
+# 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_test.scenario.step_tools import StepTools
+from holado.common.context.session_context import SessionContext
+from holado_test.behave.behave import *
+import logging
+from holado_yaml.yaml.yaml_manager import YAMLManager
+
+logger = logging.getLogger(__name__)
+
+
+if YAMLManager.is_available():
+    
+    def __get_scenario_context():
+        return SessionContext.instance().get_scenario_context()
+    
+    def __get_variable_manager():
+        return __get_scenario_context().get_variable_manager()
+    
+    def __get_path_manager():
+        return SessionContext.instance().path_manager
+    
+    
+    @Step(r"(?P<var_name>{Variable}) = load YAML file (?P<path>{Str})(?:(?P<with_only_strings_str> \(with only strings\))|(?P<with_full_yaml_features_str> \(with full YAML features\)))?")
+    def step_impl(context, var_name, path, with_only_strings_str, with_full_yaml_features_str):  # @DuplicatedSignature
+        var_name = StepTools.evaluate_variable_name(var_name)
+        path = StepTools.evaluate_scenario_parameter(path)
+        
+        res = YAMLManager.load_file(path, with_only_strings_str is not None, with_full_yaml_features_str is not None)
+        
+        __get_variable_manager().register_variable(var_name, res)
+    
+    @Step(r"(?P<var_name>{Variable}) = load multiple documents YAML file (?P<path>{Str})(?:(?P<with_only_strings_str> \(with only strings\))|(?P<with_full_yaml_features_str> \(with full YAML features\)))?")
+    def step_impl(context, var_name, path, with_only_strings_str, with_full_yaml_features_str):  # @DuplicatedSignature
+        var_name = StepTools.evaluate_variable_name(var_name)
+        path = StepTools.evaluate_scenario_parameter(path)
+        
+        res = YAMLManager.load_multiple_documents_file(path, with_only_strings_str is not None, with_full_yaml_features_str is not None)
+        
+        __get_variable_manager().register_variable(var_name, res)
+    
+    @Step(r"save (?P<data>{Variable}) in YAML file (?P<path>{Str})")
+    def step_impl(context, data, path):  # @DuplicatedSignature
+        data = StepTools.evaluate_scenario_parameter(data)
+        path = StepTools.evaluate_scenario_parameter(path)
+        
+        YAMLManager.save_file(data, path)
+
+
+
+

holado_yaml/yaml/yaml_manager.py

@@ -0,0 +1,86 @@
+
+#################################################
+# 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.tools.tools import Tools
+from holado.common.context.session_context import SessionContext
+from holado_core.common.exceptions.functional_exception import FunctionalException
+from yaml.loader import BaseLoader, FullLoader, SafeLoader
+
+
+logger = logging.getLogger(__name__)
+
+try:
+    import yaml
+    with_yaml = True
+except Exception as exc:
+    if Tools.do_log(logger, logging.DEBUG):
+        logger.debug(f"YAML is not available. Initialization failed on error: {exc}")
+    with_yaml = False
+
+
+class YAMLManager(object):
+    """
+    Manage actions on YAML files.
+    """
+    
+    @classmethod
+    def is_available(cls):
+        return with_yaml
+    
+    @classmethod
+    def __path_manager(cls):
+        return SessionContext.instance().path_manager
+    
+    @classmethod
+    def load_file(cls, file_path, with_only_strings=False, with_full_yaml_features=False):
+        if with_only_strings and with_full_yaml_features:
+            raise FunctionalException(f"It is not possible to set both with_only_strings and with_full_yaml_features to True")
+        
+        if with_only_strings:
+            loader = BaseLoader
+        elif with_full_yaml_features:
+            loader = FullLoader
+        else:
+            loader = SafeLoader
+        
+        with open(file_path, 'r') as file:
+            res = yaml.load(file, Loader=loader)
+        
+        return res
+    
+    @classmethod
+    def load_multiple_documents_file(cls, file_path, with_only_strings=False, with_full_yaml_features=False):
+        if with_only_strings and with_full_yaml_features:
+            raise FunctionalException(f"It is not possible to set both with_only_strings and with_full_yaml_features to True")
+        
+        if with_only_strings:
+            loader = BaseLoader
+        elif with_full_yaml_features:
+            loader = FullLoader
+        else:
+            loader = SafeLoader
+        
+        with open(file_path, 'r') as file:
+            res = list(yaml.load_all(file, Loader=loader))
+        
+        return res
+    
+    @classmethod
+    def save_file(cls, data, file_path):
+        cls.__path_manager().makedirs(file_path)
+        with open(file_path, 'w') as file:
+            yaml.dump(data, file)
+
+
+