holado 0.13.22__py3-none-any.whl

holado_python/standard_library/ssl/ssl.py

@@ -0,0 +1,131 @@
+
+#################################################
+# 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
+import ssl
+from holado_core.common.tools.tools import Tools
+from holado_json.ipc.json import set_object_attributes_with_json_dict
+from holado_core.common.exceptions.technical_exception import TechnicalException
+import os
+import copy
+from ssl import Purpose
+from holado_system.system.command.command import Command, CommandStates
+from holado.common.context.session_context import SessionContext
+import json
+
+logger = logging.getLogger(__name__)
+
+
+class SslManager(object):
+    """
+    Helper for ssl module.
+    
+    It is implemented internally with standard library ssl.
+    """
+    
+    @classmethod
+    def __get_path_manager(cls):
+        return SessionContext.instance().path_manager
+    
+    @classmethod
+    def new_ssl_context(cls, server_side=False, ssl_kwargs=None, context_kwargs=None):
+        res = None
+        
+        if ssl_kwargs is None:
+            ssl_kwargs = {}
+        kwargs = copy.copy(ssl_kwargs)
+        
+        try:
+            activate_ssl = kwargs.pop('activate', True)
+            if activate_ssl:
+                if Tools.has_sub_kwargs(kwargs, 'create_default_context.'):
+                    create_default_context_kwargs = Tools.pop_sub_kwargs(kwargs, 'create_default_context.')
+                else:
+                    create_default_context_kwargs = {}
+                
+                purpose = Purpose.CLIENT_AUTH if server_side else Purpose.SERVER_AUTH
+                res = ssl.create_default_context(purpose=purpose, **create_default_context_kwargs)
+                
+                # res.set_default_verify_paths()
+                
+                if context_kwargs:
+                    c_kwargs = copy.copy(context_kwargs)
+                    
+                    ciphers = c_kwargs.pop('ciphers', None)
+                    if ciphers is not None:
+                        if ciphers == 'OPENSSL_CIPHERS':
+                            ciphers = SslManager.get_openssl_ciphers()
+                            logger.debug(f"Using openssl ciphers: {ciphers}")
+                        res.set_ciphers(ciphers)
+                    if Tools.has_sub_kwargs(c_kwargs, 'load_cert_chain.'):
+                        load_cert_chain_kwargs = Tools.pop_sub_kwargs(c_kwargs, 'load_cert_chain.')
+                        res.load_cert_chain(**load_cert_chain_kwargs)
+                    if Tools.has_sub_kwargs(c_kwargs, 'load_verify_locations.'):
+                        load_verify_locations_kwargs = Tools.pop_sub_kwargs(c_kwargs, 'load_verify_locations.')
+                        res.load_verify_locations(**load_verify_locations_kwargs)
+                    
+                    # Set context attributes with remaining c_kwargs
+                    if len(c_kwargs) > 0:
+                        set_object_attributes_with_json_dict(res, c_kwargs)
+                
+                logger.debug(f"Default verify paths: {ssl.get_default_verify_paths()})")
+                dvp = ssl.get_default_verify_paths()
+                if res.verify_mode != ssl.CERT_NONE and dvp.cafile is None and 'create_default_context.cafile' not in ssl_kwargs and 'load_verify_locations.cafile' not in context_kwargs:
+                    msg_list = [f"No CA file is defined, it is not possible to verify certificates.",
+                                f"Most common solutions:",
+                                f"  - Configure to not verify certificates, by adding/setting in table: | 'ssl.context.verify_mode' | ssl.CERT_NONE |",
+                                f"  - Be sure OpenSSL default CA file exists on system (configured path: '{dvp.openssl_cafile}'). Example of command (on Ubuntu): sudo ln -s /etc/ssl/certs/ca-certificates.crt {dvp.openssl_cafile}",
+                                f"  - Configure a CA file at context creation, by adding/setting in table: | 'ssl.create_default_context.cafile' | <path to CA file> |",
+                                f"  - Configure a CA file after context creation, by adding/setting in table: | 'ssl.context.load_verify_locations.cafile' | <path to CA file> |",
+                                f"Note: step 'Given CACERTS_PATH = CA certs file path (from certifi package)' can be used to get the path to CA file coming with 'certifi' package that is supposed to be installed when using ssl module",
+                                ]
+                    raise TechnicalException("\n".join(msg_list))
+                try:
+                    logger.debug(f"Loaded CA certificates: {res.get_ca_certs()})")
+                except NotImplementedError:
+                    # Depending on environment, get_ca_certs can be not implemented (ex: python 3.10 and pip v25.1.1)
+                    pass
+                logger.debug(f"Loaded ciphers: {res.get_ciphers()})")
+                
+        except Exception as exc:
+            msg = f"Failed to create SSL context with parameters ({ssl_kwargs}, {context_kwargs}): {exc}"
+            logger.error(msg)
+            raise TechnicalException(msg) from exc
+        
+        # Verify all kwargs were applied
+        if len(kwargs) > 0:
+            raise TechnicalException(f"Unmanaged ssl parameters: {kwargs}")
+        
+        return res
+    
+    @classmethod
+    def get_openssl_ciphers(cls):
+        import subprocess
+        output = subprocess.run(["openssl", "ciphers"], capture_output=True).stdout
+        output_str = output.decode("utf-8")
+        return output_str.strip().split("\n")[0]
+    
+    @classmethod
+    def get_default_certificates(cls):
+        dvp = ssl.get_default_verify_paths()
+        if not os.path.exists(dvp.cafile):
+            raise TechnicalException(f"openssl CA file '{dvp.cafile}' doesn't exist. Example of resolution command (on Ubuntu): sudo ln -s /etc/ssl/certs/ca-certificates.crt {dvp.cafile}")
+        return (dvp.cafile, dvp.capath)
+    
+    @classmethod
+    def get_certifi_ca_certs_file_path(cls):
+        import certifi
+        return certifi.where()
+    
+    
+

holado_python/standard_library/typing.py

@@ -0,0 +1,192 @@
+# -*- 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 typing import NamedTuple, get_origin
+from typing import types  # @UnresolvedImport
+from holado_core.common.handlers.enums import AccessType
+import inspect
+from holado_core.common.exceptions.technical_exception import TechnicalException
+
+
+logger = logging.getLogger(__name__)
+
+
+class Typing(object):
+    
+    @classmethod
+    def is_NamedTuple(cls, obj=None, class_=None):
+        # if obj is not None:
+        #     class_ = type(obj)
+        # return hasattr(class_, '__orig_bases__') and class_.__orig_bases__[0] == NamedTuple
+        if obj is not None:
+            return (hasattr(obj, "__base__") and obj.__base__ == tuple or not hasattr(obj, "__dict__")) \
+                and hasattr(obj, '_fields') and len(obj._fields) > 0 and any(map(lambda x:isinstance(x, str), obj._fields))
+        else:
+            return hasattr(class_, '__orig_bases__') and class_.__orig_bases__[0] == NamedTuple
+    
+    @classmethod
+    def is_Generic(cls, generic_name, obj=None, class_=None):
+        if obj is not None:
+            class_ = type(obj)
+        return hasattr(class_, '_name') and class_._name == generic_name
+    
+    @classmethod
+    def is_List(cls, obj=None, class_=None):
+        return cls.is_Generic('List', obj, class_)
+    
+    @classmethod
+    def is_Dict(cls, obj=None, class_=None):
+        return cls.is_Generic('Dict', obj, class_)
+    
+    @classmethod
+    def is_typing_type(cls, class_):
+        return get_origin(class_) is not None
+    
+    @classmethod
+    def get_origin_type(cls, class_):
+        if class_ is not None and cls.is_typing_type(class_):
+            orig_type = get_origin(class_)
+            if type(orig_type) == type:
+                return orig_type
+            else:
+                return None
+        else:
+            return class_
+    
+    @classmethod
+    def is_function(cls, target):
+        return isinstance(target, types.FunctionType)
+    
+    @classmethod
+    def is_method(cls, target):
+        return isinstance(target, types.MethodType)
+    
+    @classmethod
+    def get_method_function(cls, target):
+        return target.__func__
+    
+    @classmethod
+    def get_method_object_instance(cls, target):
+        return target.__self__
+    
+    @classmethod
+    def get_function_qualname(cls, target):
+        return target.__qualname__
+    
+    @classmethod
+    def get_function_fullname(cls, target):
+        func_qualname = cls.get_function_qualname(target)
+        if hasattr(target, "__module__"):
+            return target.__module__ + "." + func_qualname
+        else:
+            return func_qualname
+    
+    
+    @classmethod
+    def get_class_name(cls, class_):
+        return class_.__name__
+    
+    @classmethod
+    def get_class_fullname(cls, class_):
+        if class_ is None:
+            return None
+        
+        class_name = cls.get_class_name(class_)
+        if hasattr(class_, "__module__"):
+            return class_.__module__ + "." + class_name
+        else:
+            return class_name
+    
+    @classmethod
+    def get_object_class(cls, obj):
+        if hasattr(obj, "__class__"):
+            return obj.__class__
+        else:
+            return type(obj)
+    
+    @classmethod
+    def get_object_class_name(cls, obj):
+        return cls.get_object_class(obj).__name__
+    
+    @classmethod
+    def get_object_class_fullname(cls, obj):
+        obj_class_name = cls.get_object_class_name(obj)
+        if hasattr(obj, "__module__"):
+            return obj.__module__ + "." + obj_class_name
+        else:
+            return obj_class_name
+    
+    @classmethod
+    def get_object_attributes(cls, obj, access_type=AccessType.Public):
+        if hasattr(obj, "__module__") and getattr(obj, "__module__") == 'zeep.objects' and hasattr(obj, "__values__"):
+            # Manage zeep objects separately
+            d = getattr(obj, "__values__")
+            return [(key, d[key]) for key in sorted(d)]
+        elif Typing.is_NamedTuple(obj):
+            return [(k, getattr(obj, k)) for k in obj._fields]
+        else:
+            try:
+                try:
+                    if not hasattr(obj, '__bases__'):
+                        obj.__bases__ = ()
+                except KeyError:
+                    obj.__bases__ = ()
+                except AttributeError:
+                    pass
+            
+                if access_type == AccessType.Public:
+                    return [(name, member) for name, member in inspect.getmembers(obj, lambda a: not inspect.isroutine(a)) if not name.startswith('_')]
+                elif access_type == AccessType.Protected:
+                    return [(name, member) for name, member in inspect.getmembers(obj, lambda a: not inspect.isroutine(a)) if not name.startswith('__')]
+                elif access_type == AccessType.Private:
+                    return [(name, member) for name, member in inspect.getmembers(obj, lambda a: not inspect.isroutine(a))]
+                else:
+                    raise TechnicalException(f"Unmanaged access type '{access_type}'")
+            except ModuleNotFoundError:
+                return []
+    
+    @classmethod
+    def get_object_attribute_names(cls, obj):
+        if hasattr(obj, "__module__") and getattr(obj, "__module__") == 'zeep.objects' and hasattr(obj, "__values__"):
+            # Manage zeep objects separately
+            d = getattr(obj, "__values__")
+            return [key for key in sorted(d)]
+        else:
+            return [name for name, _ in inspect.getmembers(obj, lambda a: not inspect.isroutine(a)) if not name.startswith('_')]
+    
+    @classmethod
+    def get_object_attribute_values_by_name(cls, obj):
+        if hasattr(obj, "__module__") and getattr(obj, "__module__") == 'zeep.objects' and hasattr(obj, "__values__"):
+            # Manage zeep objects separately
+            return getattr(obj, "__values__")
+        else:
+            return {name: member for name, member in inspect.getmembers(obj, lambda a: not inspect.isroutine(a)) if not name.startswith('_')}
+    
+    @classmethod
+    def get_class_for_type_name(cls, type_name):
+        type_name_splitted = type_name.split('.')
+        if len(type_name_splitted) > 1:
+            module = __import__(type_name_splitted[0])
+            for name in type_name_splitted[1:-1]:
+                module = getattr(module, name)
+            res = getattr(module, type_name_splitted[-1])
+        else:
+            res = globals()[type_name]
+            
+        return res
+
+    
+    
+

holado_python/tests/behave/steps/__init__.py

@@ -0,0 +1,27 @@
+# -*- 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 .builtins.str_steps import *
+
+from .standard_library.csv_steps import *
+from .standard_library.datetime_steps import *
+from .standard_library.hashlib_steps import *
+from .standard_library.multiprocessing_steps import *
+from .standard_library.queue_steps import *
+from .standard_library.socket_steps import *
+from .standard_library.ssl_steps import *
+
+from .convert_steps import *
+from .iterable_steps import *

holado_python/tests/behave/steps/builtins/str_steps.py

@@ -0,0 +1,45 @@
+# -*- 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 *  # @UnusedWildImport
+import logging
+
+logger = logging.getLogger(__name__)
+
+
+
+def __get_scenario_context():
+    return SessionContext.instance().get_scenario_context()
+
+def __get_variable_manager():
+    return __get_scenario_context().get_variable_manager()
+
+
+
+@Given(r"(?P<var_name>{Variable}) = split text (?P<text>{Str}) on separator (?P<separator>{Str})")
+def step_impl(context, var_name, text, separator):
+    var_name = StepTools.evaluate_variable_name(var_name)
+    text = StepTools.evaluate_scenario_parameter(text)
+    separator = StepTools.evaluate_scenario_parameter(separator)
+    
+    res = text.split(separator)
+    
+    __get_variable_manager().register_variable(var_name, res)
+
+
+
+

holado_python/tests/behave/steps/convert_steps.py

@@ -0,0 +1,59 @@
+# -*- 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 *  # @UnusedWildImport
+import logging
+from holado_core.common.tools.string_tools import StrTools
+
+logger = logging.getLogger(__name__)
+
+
+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"(?P<var_name>{Variable}) = convert list (?P<hex_list>{List}) of hexadecimal strings to list of bytes")
+def step_impl(context, var_name, hex_list):
+    var_name = StepTools.evaluate_variable_name(var_name)
+    hex_list = StepTools.evaluate_scenario_parameter(hex_list)
+    
+    res = []
+    for hex_str in hex_list:
+        res.append(StrTools.hex_to_bytes(hex_str))
+    
+    __get_variable_manager().register_variable(var_name, res)
+
+@Given(r"(?P<var_name>{Variable}) = convert list (?P<str_list>{List}) of (?:strings|bytes) to list of hexadecimal strings")
+def step_impl(context, var_name, str_list):
+    var_name = StepTools.evaluate_variable_name(var_name)
+    str_list = StepTools.evaluate_scenario_parameter(str_list)
+    
+    res = []
+    for str_el in str_list:
+        res.append(StrTools.to_bytes(str_el).hex())
+    
+    __get_variable_manager().register_variable(var_name, res)
+    
+    
+    
+    

holado_python/tests/behave/steps/iterable_steps.py

@@ -0,0 +1,87 @@
+# -*- 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 *  # @UnusedWildImport
+import logging
+from holado_core.common.exceptions.verify_exception import VerifyException
+from holado_core.common.tools.converters.converter import Converter
+from holado_core.common.exceptions.technical_exception import TechnicalException
+from holado_core.common.exceptions.functional_exception import FunctionalException
+from holado_python.standard_library.typing import Typing
+
+logger = logging.getLogger(__name__)
+
+
+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"(?P<var_name>{Variable}) = is (?P<value>{Any}) in (?P<iterable>{Any})")
+def step_impl(context, var_name, value, iterable):
+    var_name = StepTools.evaluate_variable_name(var_name)
+    value = StepTools.evaluate_scenario_parameter(value)
+    iterable = StepTools.evaluate_scenario_parameter(iterable)
+    
+    res = value in iterable
+    
+    __get_variable_manager().register_variable(var_name, res)
+
+@Then(r"(?P<value>{Any}) is(?P<is_not_in> not)? in (?P<iterable>{Any})")
+def step_impl(context, value, is_not_in, iterable):
+    value = StepTools.evaluate_scenario_parameter(value)
+    iterable = StepTools.evaluate_scenario_parameter(iterable)
+    expected_in = is_not_in is None
+    
+    is_in = value in iterable
+    if is_in != expected_in:
+        raise VerifyException(f"Value is{' not' if expected_in else ''} in iterable:\n    value: {value}\n    iterable: {iterable}")
+
+@Step(r"add (?!all)(?P<value>{Any}) in (?P<iterable>{Any})")
+def step_impl(context, value, iterable):
+    value = StepTools.evaluate_scenario_parameter(value)
+    iterable = StepTools.evaluate_scenario_parameter(iterable)
+    
+    if isinstance(iterable, list):
+        iterable.append(value)
+    else:
+        raise TechnicalException(f"Unmanaged iterable of type '{Typing.get_object_class_fullname(iterable)}'")
+
+@Step(r"add all of (?P<value>{Any}) in (?P<iterable>{Any})")
+def step_impl(context, value, iterable):
+    value = StepTools.evaluate_scenario_parameter(value)
+    iterable = StepTools.evaluate_scenario_parameter(iterable)
+    
+    if isinstance(iterable, list):
+        if Converter.is_iterable(value):
+            iterable.extend(value)
+        else:
+            raise FunctionalException(f"Value is of type '{Typing.get_object_class_fullname(value)}' that is not an iterable")
+    else:
+        raise TechnicalException(f"Unmanaged iterable of type '{Typing.get_object_class_fullname(iterable)}'")
+    
+    
+    
+
+
+
+