holado 0.13.22__py3-none-any.whl

holado_swagger/tests/behave/steps/swagger_hub/mockserver_steps.py

@@ -0,0 +1,74 @@
+# -*- 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
+from holado_core.common.exceptions.technical_exception import TechnicalException
+from holado_rest.api.rest.rest_client import RestClient
+import json
+import logging
+from holado_rest.api.rest.rest_manager import RestManager
+from holado_test.behave.scenario.behave_step_tools import BehaveStepTools
+from holado_core.common.tables.table_manager import TableManager
+from holado_value.common.tables.converters.value_table_converter import ValueTableConverter
+from holado_core.common.tools.tools import Tools
+from holado_swagger.swagger_hub.mockserver.mockserver_client import MockServerClient
+from holado_swagger.swagger_hub.mockserver.mockserver_manager import MockServerManager
+
+logger = logging.getLogger(__name__)
+
+
+if MockServerClient.is_available():
+
+    def __get_session_context():
+        return SessionContext.instance()
+    
+    def __get_scenario_context():
+        return __get_session_context().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}) = new MockServer client")
+    def step_impl(context, var_name):
+        var_name = StepTools.evaluate_variable_name(var_name)
+        table = BehaveStepTools.convert_step_table_2_value_table_with_header(context.table)
+        kwargs = ValueTableConverter.convert_name_value_table_2_dict(table)
+        
+        if 'name' not in kwargs:
+            kwargs['name'] = None
+        
+        manager = MockServerManager()
+        client = manager.new_client(**kwargs)
+    
+        __get_variable_manager().register_variable(var_name, client)
+        
+    @Step(r"(?P<var_name>{Variable}) = retrieve pushed data(?: after (?P<since_datetime>{Str}))? \(MockServer client: (?P<var_client>{Variable})\)")
+    def step_impl(context, var_name, since_datetime, var_client):
+        var_name = StepTools.evaluate_variable_name(var_name)
+        since_datetime = StepTools.evaluate_scenario_parameter(since_datetime)
+        client = StepTools.evaluate_variable_value(var_client)
+        
+        res = client.retrieve_pushed_data(since_datetime=since_datetime)
+        
+        __get_variable_manager().register_variable(var_name, res)
+        
+    
+    

holado_system/system/command/command.py

@@ -0,0 +1,247 @@
+
+#################################################
+# 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 pprint
+import sys
+import threading
+import subprocess
+import logging
+import time
+from enum import IntEnum
+from holado_core.common.exceptions.functional_exception import FunctionalException
+import copy
+import signal
+from holado_core.common.tools.tools import Tools
+from holado_multitask.multitasking.multitask_manager import MultitaskManager
+
+logger = logging.getLogger(__name__)
+
+
+class CommandStates(IntEnum):
+    """States of a command."""
+    Ready = 1
+    Running = 2
+    Success = 3
+    Error = 4
+
+
+class Command(threading.Thread):
+    """
+    Execute a command in a thread.
+    """
+
+    def __init__(self, cmd, do_log_output = False, do_raise_on_stderr = False, **subprocess_kwargs):
+        """
+        'cmd' argument can be a list or a str. If the global command should contain a '"' in any argument, it is recommanded to pass 'cmd' as a str.
+        """
+        super().__init__()
+
+        # Put thread as daemon
+        self.daemon = True
+        
+        self.cmd = cmd
+        self.__do_log_output = do_log_output
+        self.__do_raise_on_stderr = do_raise_on_stderr
+        
+        self.__process = None
+        self.__state = CommandStates.Ready
+        self.__stdout = None
+        self.__stderr = None
+        self.__error = None
+        self.__callback = None
+        self.__callback_delay_ms = None
+        self.__external_parameters = {}
+        self.__subprocess_kwargs = subprocess_kwargs
+        self.__stop_signal = signal.SIGTERM
+
+ 
+    @property
+    def stdout(self):
+        return self.__stdout
+ 
+    @property
+    def stderr(self):
+        return self.__stderr
+ 
+    @property
+    def error(self):
+        return self.__error
+ 
+    @error.setter
+    def error(self, err):
+        """Set error (an exception)."""
+        if not isinstance(err, Exception):
+            raise Exception("An exception is expected")
+        self.__error = err
+        self.__state = CommandStates.Error
+
+    @property
+    def _internal_process(self):
+        return self.__process
+    
+    @property
+    def state(self):
+        return self.__state
+    
+    @property
+    def return_code(self):
+        if self.__process:
+            return self.__process.returncode
+        else:
+            return None
+    
+    @property
+    def callback(self):
+        return self.__callback
+    
+    @callback.setter
+    def callback(self, callback):
+        """Set callback called when execution end."""
+        self.__callback = callback
+    
+    @property
+    def callback_delay_ms(self):
+        return self.__callback_delay_ms
+    
+    @callback_delay_ms.setter
+    def callback_delay_ms(self, delay_ms):
+        """Set callback delay in ms."""
+        self.__callback_delay_ms = delay_ms
+    
+    @property
+    def external_parameters(self):
+        return self.__external_parameters
+    
+    @property
+    def stop_signal(self):
+        return self.__stop_signal
+    
+    @stop_signal.setter
+    def stop_signal(self, stop_signal):
+        """Set stop signal."""
+        self.__stop_signal = stop_signal
+    
+    def run(self):
+        logger.debug("Call command: {}".format(self.cmd))
+        try:
+            self.__state = CommandStates.Running
+            
+            kwargs = copy.copy(self.__subprocess_kwargs)
+            kwargs['universal_newlines'] = True
+            if isinstance(self.cmd, str):
+                self.__process = subprocess.Popen(self.cmd,
+                                                  stdout=subprocess.PIPE,
+                                                  stderr=subprocess.PIPE,
+                                                  shell=True,
+                                                  **kwargs)
+            else:
+                self.__process = subprocess.Popen(self.cmd,
+                                                  stdout=subprocess.PIPE,
+                                                  stderr=subprocess.PIPE,
+                                                  shell=False,
+                                                  **kwargs)
+            
+            self.__stdout = ""
+            self.__stderr = ""
+            while self.__process.returncode is None:
+                # Wait a small time and in same time yield this thread
+                time.sleep(0.001)
+                
+                self.__process.poll()
+                self.__read_stdout_stderr()
+            
+            # Manage end status
+            if self.return_code == 0:
+                self.__state = CommandStates.Success
+            else:
+                self.__state = CommandStates.Error
+            
+            # Manage error
+            if self.__do_raise_on_stderr:
+                self.__raise_exception_if_stderr()
+
+            # Print result
+            if self.__do_log_output:
+                msg = "Output of command {}:\n{}\n{}\n{}".format(self.cmd, '<'*10, self.stdout, '>'*10)
+                logger.debug(msg)
+
+        except Exception as exc:
+            self.error = exc
+            
+        finally:
+            if self.callback:
+                if self.callback_delay_ms:
+                    delay_s = self.callback_delay_ms / 1000.
+                    logger.debug(f"Command [{self.cmd}] has finished, call callback in {delay_s} seconds")
+                    t = threading.Timer(delay_s, self.callback, [self])
+                    t.start()
+                else:
+                    logger.debug(f"Command [{self.cmd}] has finished, calling callback...")
+                    self.callback(self)
+            elif self.error is not None:
+                logger.error(f"Command [{self.cmd}] has finished on error: {self.error}")
+            elif self.state == CommandStates.Error:
+                logger.error(f"Command [{self.cmd}] has finished on error code {self.return_code} and stderr: {self.stderr}")
+            elif self.state != CommandStates.Success:
+                logger.warning(f"Command [{self.cmd}] has finished with status {self.state.name}")
+            else:
+                logger.debug(f"Command [{self.cmd}] has succeeded")
+    
+    def __read_stdout_stderr(self):
+        # Get results
+        out = self.__process.stdout.read()
+        if len(out) > 0:
+            if sys.version_info < (3,0):
+                self.__stdout += out.decode('utf-8')
+            else:
+                self.__stdout += out
+#                     logger.debug("[CMD OUT] | " + out)
+        err = self.__process.stderr.read()
+        if len(err) > 0:
+            if sys.version_info < (3,0):
+                self.__stderr += err.decode('utf-8')
+            else:
+                self.__stderr += err
+#                     logger.error("[CMD ERR] | " + out)
+                
+    def __raise_exception_if_stderr(self):
+        if len(self.stderr) > 0:
+            msg = "Standard Error:\n{}\n{}\n{}".format('<'*7, self.stderr, '>'*7)
+            if len(self.stdout) > 0:
+                msg += "\nStandard Output:\n{}\n{}\n{}".format('<'*7, self.stdout, '>'*7)
+            raise FunctionalException(f"Error while executing command [{self.cmd}]:\n{msg}")
+        
+    def kill(self):
+        # Note: kill is equivalent to terminate in subprocess implementation
+        if self.state == CommandStates.Running:
+            self.__process.kill() 
+                       
+    def terminate(self):
+        if self.state == CommandStates.Running:
+            self.__process.terminate()
+    
+    def stop(self):
+        if self.state == CommandStates.Running:
+            if Tools.do_log(logger, logging.DEBUG):
+                logger.debug(f"Stopping command [{self.cmd}] with signal {self.__stop_signal} and PID {self.__process.pid}")
+            
+            MultitaskManager.kill_process(self.__process.pid, sig=self.__stop_signal, do_kill_children=True, recursively=True)
+    
+    def raise_error_if_not_success(self, raised_type=FunctionalException):
+        if self.state is not CommandStates.Success:
+            raise raised_type(f"Error while executing command [{self.cmd}]: [{self.stderr}]")
+        
+    def __repr__(self):
+        return pprint.pformat({'cmd' : self.cmd,
+                               'is alive' : self.is_alive() })
+            

holado_system/system/command/command_result.py

@@ -0,0 +1,128 @@
+
+#################################################
+# 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
+from holado_core.common.exceptions.technical_exception import TechnicalException
+from holado_system.system.command.exceptions import CommandError
+
+logger = logging.getLogger(__name__)
+
+
+class CommandResult(object):
+    """
+    Result of a command
+    """
+
+    def __init__(self, command, output=None, error=None, previous_command_result=None):
+        self.__command = command
+        self.__output = output
+        self.__error = error
+
+        if previous_command_result is not None:
+            # Verify command is the same
+            if previous_command_result.command != command:
+                raise TechnicalException(f"Commands are not the same:\n    current:  [{command}]\n    previous: [{previous_command_result.command}]")
+            
+            if output is not None and previous_command_result.output is not None:
+                self.__output = previous_command_result.output + output
+            elif output is not None:
+                self.__output = output
+            else:
+                self.__output = previous_command_result.output
+            
+            if error is not None and previous_command_result.error is not None:
+                self.__error = previous_command_result.error + error
+            elif error is not None:
+                self.__error = error
+            else:
+                self.__error = previous_command_result.error
+    
+    @property
+    def command(self):
+        """
+        @return Command
+        """
+        return self.__command
+    
+    @property
+    def output(self):
+        """
+        @return Command output
+        """
+        return self.__output
+ 
+    @output.setter
+    def output(self, output):
+        """
+        @param output Command output
+        """
+        self.__output = output
+    
+    @property
+    def error(self):
+        """
+        @return Command error
+        """
+        return self.__error
+ 
+    @error.setter
+    def error(self, error):
+        """
+        @param error Command error
+        """
+        self.__error = error
+
+    @property
+    def has_error(self):
+        """
+        @return True if error exists
+        """
+        return (self.error is not None and len(self.error) > 0)
+    
+    @property
+    def has_output(self):
+        """
+        @return True if output exists
+        """
+        return (self.output is not None and len(self.output) > 0)
+    
+    def log_if_error(self):
+        """
+        Log an error if command resulted with an error.
+        """
+        if self.has_error:
+            logger.error(f"Error during command '{self.command}': {self.error}")
+    
+    def raise_if_error(self):
+        """
+        Raise a CommandError if command resulted with an error.
+        """
+        if self.has_error:
+            raise CommandError(self.command, self.error)
+    
+    def __eq__(self, obj:object)->bool:
+        if obj is None or not isinstance(obj, type(self)):
+            return False
+        
+        res = self.command is None and obj.command is None \
+                or self.command is not None and self.command == obj.command
+        
+        res &= self.output is None and obj.output is None \
+                or self.output is not None and self.output == obj.output
+        
+        res &= self.error is None and obj.error is None \
+                or self.error is not None and self.error == obj.error
+        
+        return res
+    
+    

holado_system/system/command/curl_command.py

@@ -0,0 +1,101 @@
+
+#################################################
+# 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
+from holado_system.system.command.command_result import CommandResult
+from holado_core.common.tools.converters.converter import Converter
+import re
+
+logger = logging.getLogger(__name__)
+
+
+class CurlCommandResult(CommandResult):
+    """
+    Result of a cURL command
+    """
+    __regex_error = None
+    
+    def __init__(self, command, output=None, error=None, previous_command_result=None):
+        super().__init__(command, output, CurlCommandResult.__extract_error(error), previous_command_result)
+        self.__statistics = None
+
+        self.__statistics = self.__extract_statistics(output, error)
+        if previous_command_result is not None:
+            if self.__statistics is not None and previous_command_result.statistics is not None:
+                self.__statistics = previous_command_result.statistics + self.__statistics
+            elif self.__statistics is None:
+                self.__statistics = previous_command_result.statistics
+    
+    @property
+    def statistics(self):
+        """
+        @return Command statistics
+        """
+        return self.__statistics
+    
+    @classmethod
+    def __get_regex_error(cls):
+        if cls.__regex_error is None:
+            cls.__regex_error = re.compile(r"curl:\s+\((\d+)\)\s+(.*)")
+        return cls.__regex_error
+    
+    @classmethod
+    def __extract_error(cls, error):
+        res = None
+        
+        if error is not None:
+            m = cls.__get_regex_error().search(error)
+            if m:
+                res = m.group()
+        
+        return res
+
+    def __extract_statistics(self, output, error):
+        res = error
+        
+        if (output is None or len(output) == 0) and error is not None:
+            m = self.__get_regex_error().search(error)
+            if m:
+                res = error[:m.start()]
+        
+        return res
+    
+    @property
+    def error_code(self):
+        """
+        @return Error code if an error occurred, else -1
+        """
+        res = -1
+        
+        if self.has_error:
+            m = self.__get_regex_error().search(self.error)
+            if m:
+                res = Converter.to_integer(m.group(1))
+        
+        return res
+    
+    @property
+    def error_message(self):
+        """
+        @return Error message if an error occurred, else None
+        """
+        res = None
+        
+        if self.has_error:
+            m = self.__get_regex_error().search(self.error)
+            if m:
+                res = m.group(2)
+        
+        return res
+    
+    

holado_system/system/command/exceptions.py

@@ -0,0 +1,59 @@
+
+#################################################
+# 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.functional_exception import FunctionalException
+
+class CommandException(FunctionalException):
+    """
+    Exception during command execution
+    """
+    
+    def __init__(self, message=None, command=None, error=None):
+        """
+        @param message Exception message
+        @param command Command
+        @param error Command error message
+        """
+        super().__init__(message if message else f"Command '{command}' failed with error: {error}")
+        self.__command = command
+        self.__error = error
+    
+    @property
+    def command(self):
+        """
+        @return Command
+        """
+        return self.__command
+    
+    @property
+    def error(self):
+        """
+        @return Command error
+        """
+        return self.__error
+        
+    
+class CommandError(FunctionalException):
+    """
+    Error returned by given command
+    """
+    
+    def __init__(self, command, error):
+        """
+        @param command Command
+        @param error Command error message
+        """
+        super().__init__(command=command, error=error)
+        
+