holado 0.13.22__py3-none-any.whl

holado_helper/docker/logging.conf

@@ -0,0 +1,44 @@
+[holado]
+#level=INFO
+level=DEBUG
+#level=TRACE
+log_on_console=False
+log_in_file=True
+
+[loggers_levels]
+holado=INFO
+#holado=DEBUG
+#holado.common.context=INFO
+#holado.common.context.session_context=DEBUG
+holado_core.common.block.scope_manager=INFO
+#holado_core.common.handlers=TRACE
+#holado_core.common.tools=DEBUG
+holado_core.common.tools.comparators=INFO
+#holado_core.common.tools.tools=TRACE
+holado_db.tools=DEBUG
+holado_logging=INFO
+#holado_multitask.multitasking.multitask_manager=TRACE
+#holado_protobuf.ipc.protobuf=DEBUG
+#holado_protobuf.ipc.protobuf.protobuf_messages=DEBUG
+#holado_protobuf.ipc.protobuf.protobuf_messages=TRACE
+#holado_python.standard_library.socket=DEBUG
+#holado_value.common.tables.value_table_cell=TRACE
+holado_s3.tools.s3.minio_client.trace=INFO
+
+#holado_scripting.common.tools=DEBUG
+#holado_scripting.common.tools.expression_evaluator=DEBUG
+#holado_scripting.common.tools.expression_evaluator=TRACE
+#holado_scripting.common.tools.variable_manager=TRACE
+#holado_scripting.text.interpreter=TRACE
+
+#holado_test.behave.behave=DEBUG
+
+# External libraries
+chardet=WARNING
+pika=WARNING
+psycopg=INFO
+suds.transport=DEBUG
+urllib3=INFO
+zeep.transports=DEBUG
+ssl=DEBUG
+

holado_helper/docker/run_holado_test_nonreg_in_docker.sh

@@ -0,0 +1,120 @@
+#!/bin/bash
+
+# Script to launch run_test.sh with testing docker.
+#
+# This script helper is written to run HolAdo tests.
+# With this script, the features to launch are embedded in docker image.
+#
+# USAGE:
+#     Considering a working directory WORK_DIR, to launch scenarios, open a console in WORK_DIR, and launch the script with wanted parameters (see bellow).
+#     Then a new report is added in folder HOLADO_OUTPUT_BASEDIR/reports if environment variable HOLADO_OUTPUT_BASEDIR is defined, else in folder WORK_DIR/reports.
+#
+# REQUIREMENTS:
+#     Define in .profile the following variables
+#         - HOLADO_IMAGE_TAG: docker image tag to use (usually "main" or tag associated to any branch)
+#         - optional but preferable:
+#             - HOLADO_OUTPUT_BASEDIR: absolute path to base output directory of testing solution
+#             - HOLADO_LOCAL_RESOURCES_BASEDIR: absolute path to base local resources directory of testing solution (where data are stored through campaigns)
+#         - optional:
+#             - HOLADO_IMAGE_REGISTRY: docker image registry to use (default: "registry.gitlab.com/holado_framework/python")
+#             - HOLADO_USE_LOCALHOST: force the container network to 'host'.
+#             - HOLADO_NETWORK: specify on which network the docker is run.
+#     Example:
+#         export HOLADO_IMAGE_TAG=main
+#         export HOLADO_USE_LOCALHOST=True
+#         export HOLADO_OUTPUT_BASEDIR=$HOME/.holado/output
+#         export HOLADO_LOCAL_RESOURCES_BASEDIR=$HOME/.holado/resources
+#
+# If no parameters are added to the script, all features/scenarios are run.
+# Additional parameters can be specified to change runner behaviors, usually used to execute specific features/scenarios.
+# In order to execute specific scenarios, the easiest way is to filter scenarios by tags with "-t" parameter.
+# For example, following command executes all scenarios having both tags "scenario" and "table_possible_values": 
+#      run_test_in_docker.sh -t scenario -t table_possible_values
+#
+# Note: Technically, the additional parameters are directly passed to internal script run_test.sh. 
+#       For a complete help on possible parameters, simply add "-h" to command. 
+
+
+for v in HOLADO_IMAGE_TAG; do
+    if [ -z ${!v} ]; then
+        echo "Environment variable $v must be set"
+        exit 1
+    fi
+done
+
+CWD="$(dirname "${BASH_SOURCE[0]}")"
+WORK_DIR="$(pwd)"
+
+if [[ -z "$HOLADO_IMAGE_REGISTRY" ]]; then
+    HOLADO_IMAGE_REGISTRY=registry.gitlab.com/holado_framework/python
+fi
+TEST_IMAGE=${HOLADO_IMAGE_REGISTRY}:${HOLADO_IMAGE_TAG}
+
+# Update docker image
+echo "Updating docker image ${TEST_IMAGE}..."
+docker pull ${TEST_IMAGE}
+
+# Define test output directory
+if [[ ! -z "$HOLADO_OUTPUT_BASEDIR" ]]; then
+    OUTPUT_DIR=${HOLADO_OUTPUT_BASEDIR}
+else
+    OUTPUT_DIR=${WORK_DIR}/output
+fi
+echo "Output directory: $OUTPUT_DIR"
+
+# Define test resources directory
+if [[ ! -z "$HOLADO_LOCAL_RESOURCES_BASEDIR" ]]; then
+    RESOURCES_DIR=${HOLADO_LOCAL_RESOURCES_BASEDIR}
+else
+    RESOURCES_DIR=${WORK_DIR}/resources
+fi
+echo "Resources directory: $RESOURCES_DIR"
+
+# Make dirs
+if [ ! -d ${OUTPUT_DIR} ]; then
+    echo "Create output directory: ${OUTPUT_DIR}"
+    mkdir -p ${OUTPUT_DIR}
+fi
+if [ ! -d ${RESOURCES_DIR} ]; then
+    echo "Create resources directory: ${RESOURCES_DIR}"
+    mkdir -p ${RESOURCES_DIR}
+fi
+
+# Define container network
+if [ "$HOLADO_USE_LOCALHOST" = True ]; then
+    NETWORK_DEF_CMD="--network=host"
+else
+    if [[ ! -z "$HOLADO_NETWORK" ]]; then
+        NETWORK_DEF_CMD="--network $HOLADO_NETWORK"
+    else
+        NETWORK_DEF_CMD=""
+    fi
+fi
+
+# Define if logging.conf must be override
+if [ -f ${WORK_DIR}/logging.conf ]; then
+    LOGGING_CONF_CMD="-v ${WORK_DIR}/logging.conf:/code/holado/python/tests/behave/test_holado/logging.conf"
+elif [ -f ${CWD}/logging.conf ]; then
+    LOGGING_CONF_CMD="-v ${CWD}/logging.conf:/code/holado/python/tests/behave/test_holado/logging.conf"
+else
+    LOGGING_CONF_CMD=""
+fi
+
+# Docker run 
+if [[ -z "$HOLADO_RUNNER_NAME" ]]; then
+    HOLADO_RUNNER_NAME=holado_test_runner
+fi
+
+echo
+echo "Running tests (docker name: ${HOLADO_RUNNER_NAME})..."
+echo
+# Note: In bellow command, some non-regression scenarios are skipped, those currently not working when run in docker
+docker run --rm -t $(docker info --format '{{.SecurityOptions}}' | grep -q rootless && echo -n "--user root" || echo -n "-u $(id -u ${USER}):$(id -g ${USER})") --name ${HOLADO_RUNNER_NAME} \
+	-v "${OUTPUT_DIR}":/output \
+	-v "${RESOURCES_DIR}":/resources \
+	${LOGGING_CONF_CMD} \
+    -e HOLADO_OUTPUT_BASEDIR=/output \
+    -e HOLADO_LOCAL_RESOURCES_BASEDIR=/resources \
+	${NETWORK_DEF_CMD} \
+	${TEST_IMAGE} /bin/bash -c "./run_test_nonreg.sh -t ~grpc -t ~rabbitmq -t ~sftp $*"
+

holado_helper/docker/run_terminal_in_docker.sh

@@ -0,0 +1,101 @@
+#!/bin/bash
+
+# Script to launch a command with testing docker.
+#
+# It is usually used to launch a script embedded in docker image.
+#
+# USAGE:
+#     Considering a working directory WORK_DIR, to launch scenarios, open a console in WORK_DIR, and launch the script with wanted parameters (see bellow).
+#
+#     Example: display feature & scenario durations of a report
+#              run_terminal_in_docker.sh python ./resources/scripts/print_report_execution_historic.py -r {dirname_to_report} -f feature.name -f feature.filename -f feature.duration -s scenario.name -s scenario.line -s scenario.duration
+#
+# REQUIREMENTS:
+#     Define in .profile the following variables
+#         - HOLADO_IMAGE_TAG: docker image tag to use (usually "main" or tag associated to any branch)
+#         - optional but preferable:
+#             - HOLADO_OUTPUT_BASEDIR: absolute path to base output directory of testing solution
+#             - HOLADO_LOCAL_RESOURCES_BASEDIR: absolute path to base local resources directory of testing solution (where data are stored through campaigns)
+#         - optional:
+#             - HOLADO_USE_LOCALHOST: force the container network to 'host'.
+#             - HOLADO_NETWORK: specify on which network the docker is run.
+#     Example:
+#         export HOLADO_IMAGE_TAG=main
+#         export HOLADO_USE_LOCALHOST=True
+#         export HOLADO_OUTPUT_BASEDIR=$HOME/.holado/output
+#         export HOLADO_LOCAL_RESOURCES_BASEDIR=$HOME/.holado/resources
+#
+
+
+for v in HOLADO_IMAGE_TAG; do
+    if [ -z ${!v} ]; then
+        echo "Environment variable $v must be set"
+        exit 1
+    fi
+done
+
+WORK_DIR="$(pwd)"
+
+if [[ -z "$HOLADO_IMAGE_REGISTRY" ]]; then
+    HOLADO_IMAGE_REGISTRY=registry.gitlab.com/holado_framework/python
+fi
+TEST_IMAGE=${HOLADO_IMAGE_REGISTRY}:${HOLADO_IMAGE_TAG}
+
+# Update docker image
+echo "Updating docker image ${TEST_IMAGE}..."
+docker pull ${TEST_IMAGE}
+
+# Define test output directory
+if [[ ! -z "$HOLADO_OUTPUT_BASEDIR" ]]; then
+    OUTPUT_DIR=${HOLADO_OUTPUT_BASEDIR}
+else
+    OUTPUT_DIR=${WORK_DIR}/output
+fi
+echo "Output directory: $OUTPUT_DIR"
+
+# Define test resources directory
+if [[ ! -z "$HOLADO_LOCAL_RESOURCES_BASEDIR" ]]; then
+    RESOURCES_DIR=${HOLADO_LOCAL_RESOURCES_BASEDIR}
+else
+    RESOURCES_DIR=${WORK_DIR}/resources
+fi
+echo "Resources directory: $RESOURCES_DIR"
+
+# Make dirs
+if [ ! -d ${OUTPUT_DIR} ]; then
+    echo "Create output directory: ${OUTPUT_DIR}"
+    mkdir -p ${OUTPUT_DIR}
+fi
+if [ ! -d ${RESOURCES_DIR} ]; then
+    echo "Create resources directory: ${RESOURCES_DIR}"
+    mkdir -p ${RESOURCES_DIR}
+fi
+
+# Define container network
+if [ "$HOLADO_USE_LOCALHOST" = True ]; then
+	NETWORK_DEF_COMMAND="--network=host"
+else
+	if [[ ! -z "$HOLADO_NETWORK" ]]; then
+		NETWORK_DEF_COMMAND="--network $HOLADO_NETWORK"
+	else
+		NETWORK_DEF_COMMAND=""
+	fi
+fi
+
+# Docker run 
+if [[ -z "$HOLADO_RUNNER_NAME" ]]; then
+    HOLADO_RUNNER_NAME=holado_test_runner
+fi
+
+echo
+echo "Running tests (docker name: ${HOLADO_RUNNER_NAME})..."
+echo
+docker run --rm -it $(docker info --format '{{.SecurityOptions}}' | grep -q rootless && echo -n "--user root" || echo -n "-u $(id -u ${USER}):$(id -g ${USER})") --name ${HOLADO_RUNNER_NAME} \
+    -v "${OUTPUT_DIR}":/output \
+    -v "${RESOURCES_DIR}":/resources \
+    -e HOLADO_OUTPUT_BASEDIR=/output \
+    -e HOLADO_LOCAL_RESOURCES_BASEDIR=/resources \
+    ${NETWORK_DEF_COMMAND} \
+    -w /work_dir \
+    ${TEST_IMAGE} /bin/bash
+

holado_helper/holado_module_template/__init__.py

@@ -0,0 +1,38 @@
+# -*- 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 configure_module():
+    """
+    Configure this module
+    Example: set new attributes in holado.holado_config.Config class
+    """
+    pass
+
+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_helper/holado_module_template/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_helper/holado_module_template/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_helper/initialize_holado.py

@@ -0,0 +1,72 @@
+
+#################################################
+# 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_sys_paths(list_paths, index=0):
+    """Insert a list of path in sys.path if it doesn't already exists.
+    """
+    if list_paths:
+        for path in list_paths:
+            insert_sys_path(path, index=index)
+
+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}'")
+        # import traceback
+        # print("".join(traceback.format_list(traceback.extract_stack())))
+        # insert_sys_path(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"))
+    
+

holado_helper/script/action.py

@@ -0,0 +1,130 @@
+
+#################################################
+# HolAdo (Holistic Automation do)
+#
+# (C) Copyright 2021-2025 by Eric Klumpp
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+# The Software is provided “as is”, without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the Software.
+#################################################
+
+from builtins import super
+import logging
+from holado_test.behave.behave_function import BehaveFunction
+from typing import Dict, Union
+from holado_core.common.tools.tools import Tools
+from holado_core.common.actors.actions import Action
+from holado_core.common.exceptions.technical_exception import TechnicalException
+from holado_python.standard_library.typing import Typing
+from holado.common.handlers.undefined import not_applicable
+
+logger = logging.getLogger(__name__)
+
+
+class ActionInfo(object):
+    def __init__(self, uid:str, action:str, params:Dict[str, Union[str,int]], static_params:Dict[str, Union[str,int]], index:int):
+        self.uid = uid
+        self.action = action
+        self.params = params
+        self.static_params = static_params
+        self.index = index
+        
+    def __str__(self)->str:
+        return f"{Typing.get_object_class_fullname(self)}({self.__dict__})"
+
+class BehaveActionInfo(ActionInfo):
+    def __init__(self, uid:str, action:str, params:Dict[str, Union[str,int]], static_params:Dict[str, Union[str,int]], index:int, behave_args:str):
+        super().__init__(uid, action, params, static_params, index)
+        self.behave_args = behave_args
+
+
+class FeaturesBehaveAction(Action):
+    '''Behave action running features.
+    The features to execute are defined by parameter behave_args.
+    
+    It is possible to pass arguments to the features, by writing the scenarios with expected variables.
+    At execution, given parameter 'variable_values' must define expected variable values. 
+    '''
+    
+    def __init__(self, behave_args, variable_manager):
+        # Method execute is overriden and doesn't use a method reference, thus parameter func_execute is None
+        super().__init__("behave", None)
+        self.__behave_function = BehaveFunction(behave_args)
+        self.__variable_manager = variable_manager
+    
+    def execute(self, variable_values=None):
+        """Execute features with given variable values.
+        """
+        if variable_values is not None and not isinstance(variable_values, dict):
+            raise TechnicalException(f"Parameter 'variable_values' must be a dict")
+        
+        if variable_values:
+            for key, value in variable_values.items():
+                self.__variable_manager.register_variable(key, value)
+        
+        try:
+            return self.__behave_function.run()
+        except Exception as exc:
+            raise TechnicalException(f"Execution of features with behave failed: {exc}") from exc
+    
+    
+class BehaveActionRunner():
+    '''
+    Behave action runner.
+    Return True if succeeded
+    '''
+    
+    def __init__(self, action_info, variable_manager):
+        self.__action = FeaturesBehaveAction(action_info.behave_args, variable_manager)
+        self.__action_info = action_info
+    
+    def __compute_variable_values(self):
+        res = {}
+        self.__add_variable_values(res, self.__action_info.static_params)
+        self.__add_variable_values(res, self.__action_info.params)
+        return res
+    
+    def __add_variable_values(self, res, params):
+        if params:
+            if isinstance(params, dict):
+                for key, value in params.items():
+                    self.__add_variable_value(res, key, value)
+            elif isinstance(params, list):
+                for key, value in params:
+                    self.__add_variable_value(res, key, value)
+            else:
+                raise TechnicalException(f"Unexpected params type '{type(params)}'")
+    
+    def __add_variable_value(self, res, var_name, value):
+        if var_name == 'STATUS':
+            return
+        if value is not_applicable:
+            res[var_name] = 'N/A'
+        else:
+            res[var_name] = value
+    
+    def run(self):
+        logger.info(f"Processing action '{self.__action_info.action}' of index {self.__action_info.index}: {self.__action_info.params}")
+        if Tools.do_log(logger, logging.DEBUG):
+            logger.debug(f"Running behave with arguments '{self.__action_info.behave_args}' on action of index {self.__action_info.index}: {self.__action_info.params}")
+        
+        variable_values = self.__compute_variable_values()
+        
+        logger.info(f"Launching behave with arguments: {self.__action_info.behave_args}")
+        if Tools.do_log(logger, logging.DEBUG):
+            if variable_values:
+                logger.debug(f"   and with variables:\n{Tools.represent_object(variable_values, 8)}")
+        res = self.__action.execute(variable_values)
+        logger.info(f"behave finished with result: {res}")
+        
+        if res:
+            logger.print(f"Success of action '{self.__action_info.action}' on action of index {self.__action_info.index}: {self.__action_info.params}")
+        else:
+            logger.error(f"Action '{self.__action_info.action}' failed on action of index {self.__action_info.index}: {self.__action_info.params}")
+                
+        return res
+    
+