holado 0.4.0__py3-none-any.whl → 0.4.2__py3-none-any.whl

holado_system/system/command/command.py

@@ -20,6 +20,9 @@ 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__)
 
@@ -31,6 +34,7 @@ class CommandStates(IntEnum):
     Success = 3
     Error = 4
 
+
 class Command(threading.Thread):
     """
     Execute a command in a thread.
@@ -58,6 +62,7 @@ class Command(threading.Thread):
         self.__callback_delay_ms = None
         self.__external_parameters = {}
         self.__subprocess_kwargs = subprocess_kwargs
+        self.__stop_signal = signal.SIGTERM
 
  
     @property
@@ -94,29 +99,38 @@ class Command(threading.Thread):
             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:
@@ -139,7 +153,7 @@ class Command(threading.Thread):
             
             self.__stdout = ""
             self.__stderr = ""
-            while (self.__process.returncode is None):
+            while self.__process.returncode is None:
                 # Wait a small time and in same time yield this thread
                 time.sleep(0.001)
                 
@@ -175,7 +189,7 @@ class Command(threading.Thread):
                     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}")
+                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:
@@ -208,13 +222,21 @@ class Command(threading.Thread):
             raise FunctionalException(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 __repr__(self):
         return pprint.pformat({'cmd' : self.cmd,
                                'is alive' : self.is_alive() })

holado_system/system/global_system.py

@@ -14,9 +14,7 @@
 import logging
 from holado.common.handlers.enums import AutoNumber
 import platform
-from holado_system.system.command.command import Command, CommandStates
 from holado_core.common.exceptions.technical_exception import TechnicalException
-from holado_system.system.command.command_result import CommandResult
 import time
 import os
 from holado_core.common.tools.tools import Tools
@@ -87,6 +85,9 @@ class GlobalSystem(object):
 
     @classmethod
     def execute_command(cls, cmd, do_log_output=False, do_raise_on_stderr=False):
+        from holado_system.system.command.command import Command, CommandStates
+        from holado_system.system.command.command_result import CommandResult
+        
         command = Command(cmd, do_log_output=do_log_output, do_raise_on_stderr=do_raise_on_stderr)
         command.start()
         command.join()
@@ -183,5 +184,4 @@ class GlobalSystem(object):
                 return port
         return None
     
-    
     

test_holado/environment.py

@@ -19,10 +19,12 @@ import logging
 
 # Add testing solution sources paths
 here = os.path.abspath(os.path.dirname(__file__))
-sys.path.append(here)
-holado_path = os.path.normpath(os.path.join(here, "..", "..", ".."))
-sys.path.append( os.path.join(holado_path, "src") )
-sys.path.append( os.path.join(holado_path, "tests", "behave") )
+sys.path.insert(0, here)
+
+# Add HolAdo source paths (needed when using a clone of HolAdo project)
+from initialize_holado import insert_holado_source_paths
+insert_holado_source_paths()
+
 
 # Configure HolAdo
 import holado

test_holado/features/NonReg/api/REST.feature

@@ -2,8 +2,7 @@
 @rest
 Feature: Test REST module
 
-    @go_nogo
-    @need_update
+    #@need_update
     Scenario: Simple get
 
         ### PRECONDITIONS - BEGIN
@@ -18,4 +17,10 @@ Feature: Test REST module
         
         When RESULT = get '/users' (REST client: CLIENT)
         Then RESULT['results'] is list
+        
+        Given TABLE = convert json RESULT['results'] to table with names as columns
+        Then table TABLE contains
+            | email | groups | url | username |
+            | N/A   | N/A    | N/A | 'admin'  |
+        
         

test_holado/features/NonReg/api/gRPC.feature

@@ -9,8 +9,6 @@ Feature: Test gRPC module
         Given begin preconditions
 
         Given SERVER = start internal gRPC server
-        When wait 1 seconds
-
         Given CLIENT = new internal gRPC client on service 'account.UserController'
 
         Given end preconditions
@@ -33,8 +31,6 @@ Feature: Test gRPC module
         Given begin preconditions
 
         Given SERVER = start internal gRPC server
-        When wait 1 seconds
-
         Given CLIENT = new internal gRPC client on service 'account.UserController'
 
         Given end preconditions
@@ -78,8 +74,6 @@ Feature: Test gRPC module
         Given begin preconditions
 
         Given SERVER = start internal gRPC server
-        When wait 1 seconds
-
         Given CLIENT = new internal gRPC client on service 'account.UserController'
 
         Given end preconditions

test_holado/initialize_holado.py

@@ -0,0 +1,62 @@
+
+#################################################
+# 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.
+#################################################
+
+
+#################################################
+# GOAL: Tools when using a clone of HolAdo project.
+#
+# This file contains methods usefull to initialize environments using a clone of HolAdo project.
+#
+# USAGE: 
+#   - Copy this file in projects using HolAdo.
+#   - Define environment variable HOLADO_PATH with path to cloned HolAdo project.
+#     If HOLADO_PATH is defined, sources of cloned HolAdo project are used, else installed holado package is used.
+#################################################
+
+
+
+import os
+import sys
+
+
+def insert_sys_path(path, index=0):
+    """Insert a path in sys.path if it doesn't already exists.
+    """
+    if path not in sys.path:
+        sys.path.insert(index, path)
+
+def insert_holado_source_paths(with_test_behave=True):
+    """Insert in sys.path all HolAdo source paths.
+    If environment variable HOLADO_PATH is defined with path to HolAdo project, following paths are inserted in sys.path:
+        - HOLADO_PATH/src: path to holado modules sources
+        - HOLADO_PATH/tests/behave (if with_test_behave==True): path to holado test sources, needed by testing solutions
+    """
+    holado_path = os.getenv('HOLADO_PATH')
+    if holado_path is None:
+        try:
+            import holado  # @UnusedImport
+        except Exception as exc:
+            if "No module named" in str(exc):
+                raise Exception(f"If environment variable HOLADO_PATH is not defined with path to HolAdo project, 'holado' python package must be installed")
+            else:
+                raise exc
+        else:
+            # holado is installed, and all sources are already accessible
+            pass
+    else:
+        print(f"Using HolAdo project installed in '{holado_path}'")
+        insert_sys_path(os.path.join(holado_path, "src"))
+        if with_test_behave:
+            insert_sys_path(os.path.join(holado_path, "tests", "behave"))
+    
+

test_holado/logging.conf

@@ -3,7 +3,9 @@ level=INFO
 #level=DEBUG
 #level=TRACE
 log_on_console=False
+#log_on_console=True
 log_in_file=True
+#log_in_file=False
 
 [loggers_levels]
 holado=INFO
@@ -22,6 +24,7 @@ holado_multitask=WARNING
 #holado_protobuf.ipc.protobuf=DEBUG
 #holado_protobuf.ipc.protobuf.protobuf_messages=TRACE
 #holado_python.standard_library.socket=DEBUG
+#holado_rest.api/rest=DEBUG
 #holado_value.common.tables.value_table_cell=TRACE
 holado_s3.tools.s3.minio_client.trace=INFO
 
@@ -31,6 +34,7 @@ holado_s3.tools.s3.minio_client.trace=INFO
 #holado_scripting.common.tools.variable_manager=TRACE
 #holado_scripting.text.interpreter=TRACE
 
+#holado_system=DEBUG
 #holado_test.behave.behave=DEBUG
 
 # External libraries