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

holado_helper/docker/run_holado_test_nonreg_in_docker.sh

@@ -7,23 +7,23 @@
 #
 # 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_TEST_OUTPUT_BASEDIR/reports if environment variable HOLADO_TEST_OUTPUT_BASEDIR is defined, else in folder WORK_DIR/reports.
+#     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_TEST_IMAGE_TAG: docker image tag to use (usually "main" or tag associated to any branch)
+#         - HOLADO_IMAGE_TAG: docker image tag to use (usually "main" or tag associated to any branch)
 #         - optional but preferable:
-#             - HOLADO_TEST_OUTPUT_BASEDIR: absolute path to base output directory of testing solution
-#             - HOLADO_TEST_LOCAL_RESOURCES_BASEDIR: absolute path to base local resources directory of testing solution (where data are stored through campaigns)
+#             - 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_TEST_IMAGE_REGISTRY: docker image registry to use (default: "registry.gitlab.com/testing-solution/python")
-#             - HOLADO_TEST_USE_LOCALHOST: force the container network to 'host'.
-#             - HOLADO_TEST_NETWORK: specify on which network the docker is run.
+#             - HOLADO_IMAGE_REGISTRY: docker image registry to use (default: "registry.gitlab.com/testing-solution/python")
+#             - HOLADO_USE_LOCALHOST: force the container network to 'host'.
+#             - HOLADO_NETWORK: specify on which network the docker is run.
 #     Example:
-#         export HOLADO_TEST_IMAGE_TAG=main
-#         export HOLADO_TEST_USE_LOCALHOST=True
-#         export HOLADO_TEST_OUTPUT_BASEDIR=$HOME/.holado/output
-#         export HOLADO_TEST_LOCAL_RESOURCES_BASEDIR=$HOME/.holado/resources
+#         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.
@@ -35,7 +35,7 @@
 #       For a complete help on possible parameters, simply add "-h" to command. 
 
 
-for v in HOLADO_TEST_IMAGE_TAG; do
+for v in HOLADO_IMAGE_TAG; do
     if [ -z ${!v} ]; then
         echo "Environment variable $v must be set"
         exit 1
@@ -45,26 +45,26 @@ done
 CWD="$(dirname "${BASH_SOURCE[0]}")"
 WORK_DIR="$(pwd)"
 
-if [[ -z "$HOLADO_TEST_IMAGE_REGISTRY" ]]; then
-    HOLADO_TEST_IMAGE_REGISTRY=registry.gitlab.com/testing-solution/python
+if [[ -z "$HOLADO_IMAGE_REGISTRY" ]]; then
+    HOLADO_IMAGE_REGISTRY=registry.gitlab.com/testing-solution/python
 fi
-TEST_IMAGE=${HOLADO_TEST_IMAGE_REGISTRY}:${HOLADO_TEST_IMAGE_TAG}
+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_TEST_OUTPUT_BASEDIR" ]]; then
-    OUTPUT_DIR=${HOLADO_TEST_OUTPUT_BASEDIR}
+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_TEST_LOCAL_RESOURCES_BASEDIR" ]]; then
-    RESOURCES_DIR=${HOLADO_TEST_LOCAL_RESOURCES_BASEDIR}
+if [[ ! -z "$HOLADO_LOCAL_RESOURCES_BASEDIR" ]]; then
+    RESOURCES_DIR=${HOLADO_LOCAL_RESOURCES_BASEDIR}
 else
     RESOURCES_DIR=${WORK_DIR}/resources
 fi
@@ -81,11 +81,11 @@ if [ ! -d ${RESOURCES_DIR} ]; then
 fi
 
 # Define container network
-if [ "$HOLADO_TEST_USE_LOCALHOST" = True ]; then
+if [ "$HOLADO_USE_LOCALHOST" = True ]; then
     NETWORK_DEF_CMD="--network=host"
 else
-    if [[ ! -z "$HOLADO_TEST_NETWORK" ]]; then
-        NETWORK_DEF_CMD="--network $HOLADO_TEST_NETWORK"
+    if [[ ! -z "$HOLADO_NETWORK" ]]; then
+        NETWORK_DEF_CMD="--network $HOLADO_NETWORK"
     else
         NETWORK_DEF_CMD=""
     fi
@@ -101,20 +101,20 @@ else
 fi
 
 # Docker run 
-if [[ -z "$HOLADO_TEST_RUNNER_NAME" ]]; then
-    HOLADO_TEST_RUNNER_NAME=holado_test_runner
+if [[ -z "$HOLADO_RUNNER_NAME" ]]; then
+    HOLADO_RUNNER_NAME=holado_test_runner
 fi
 
 echo
-echo "Running tests (docker name: ${HOLADO_TEST_RUNNER_NAME})..."
+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 | grep -i rootless > /dev/null && echo -n "--user root") || echo -n "-u $(id -u ${USER}):$(id -g ${USER})") --name ${HOLADO_TEST_RUNNER_NAME} \
+docker run --rm -t $((docker info | grep -i rootless > /dev/null && 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_TEST_OUTPUT_BASEDIR=/output \
-    -e HOLADO_TEST_LOCAL_RESOURCES_BASEDIR=/resources \
+    -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-with_docker_control.sh

@@ -12,22 +12,22 @@
 #
 # REQUIREMENTS:
 #     Define in .profile the following variables
-#         - HOLADO_TEST_IMAGE_TAG: docker image tag to use (usually "main" or tag associated to any branch)
+#         - HOLADO_IMAGE_TAG: docker image tag to use (usually "main" or tag associated to any branch)
 #         - optional but preferable:
-#             - HOLADO_TEST_OUTPUT_BASEDIR: absolute path to base output directory of testing solution
-#             - HOLADO_TEST_LOCAL_RESOURCES_BASEDIR: absolute path to base local resources directory of testing solution (where data are stored through campaigns)
+#             - 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_TEST_USE_LOCALHOST: force the container network to 'host'.
-#             - HOLADO_TEST_NETWORK: specify on which network the docker is run.
+#             - HOLADO_USE_LOCALHOST: force the container network to 'host'.
+#             - HOLADO_NETWORK: specify on which network the docker is run.
 #     Example:
-#         export HOLADO_TEST_IMAGE_TAG=main
-#         export HOLADO_TEST_USE_LOCALHOST=True
-#         export HOLADO_TEST_OUTPUT_BASEDIR=$HOME/.holado/output
-#         export HOLADO_TEST_LOCAL_RESOURCES_BASEDIR=$HOME/.holado/resources
+#         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_TEST_IMAGE_TAG; do
+for v in HOLADO_IMAGE_TAG; do
     if [ -z ${!v} ]; then
         echo "Environment variable $v must be set"
         exit 1
@@ -36,26 +36,26 @@ done
 
 WORK_DIR="$(pwd)"
 
-if [[ -z "$HOLADO_TEST_IMAGE_REGISTRY" ]]; then
-    HOLADO_TEST_IMAGE_REGISTRY=registry.gitlab.com/testing-solution/python
+if [[ -z "$HOLADO_IMAGE_REGISTRY" ]]; then
+    HOLADO_IMAGE_REGISTRY=registry.gitlab.com/testing-solution/python
 fi
-TEST_IMAGE=${HOLADO_TEST_IMAGE_REGISTRY}:${HOLADO_TEST_IMAGE_TAG}
+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_TEST_OUTPUT_BASEDIR" ]]; then
-    OUTPUT_DIR=${HOLADO_TEST_OUTPUT_BASEDIR}
+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_TEST_LOCAL_RESOURCES_BASEDIR" ]]; then
-    RESOURCES_DIR=${HOLADO_TEST_LOCAL_RESOURCES_BASEDIR}
+if [[ ! -z "$HOLADO_LOCAL_RESOURCES_BASEDIR" ]]; then
+    RESOURCES_DIR=${HOLADO_LOCAL_RESOURCES_BASEDIR}
 else
     RESOURCES_DIR=${WORK_DIR}/resources
 fi
@@ -72,31 +72,31 @@ if [ ! -d ${RESOURCES_DIR} ]; then
 fi
 
 # Define container network
-if [ "$HOLADO_TEST_USE_LOCALHOST" = True ]; then
+if [ "$HOLADO_USE_LOCALHOST" = True ]; then
 	NETWORK_DEF_COMMAND="--network=host"
 else
-	if [[ ! -z "$HOLADO_TEST_NETWORK" ]]; then
-		NETWORK_DEF_COMMAND="--network $HOLADO_TEST_NETWORK"
+	if [[ ! -z "$HOLADO_NETWORK" ]]; then
+		NETWORK_DEF_COMMAND="--network $HOLADO_NETWORK"
 	else
 		NETWORK_DEF_COMMAND=""
 	fi
 fi
 
 # Docker run 
-if [[ -z "$HOLADO_TEST_RUNNER_NAME" ]]; then
-    HOLADO_TEST_RUNNER_NAME=holado_test_runner
+if [[ -z "$HOLADO_RUNNER_NAME" ]]; then
+    HOLADO_RUNNER_NAME=holado_test_runner
 fi
 
 echo
-echo "Running tests (docker name: ${HOLADO_TEST_RUNNER_NAME})..."
+echo "Running tests (docker name: ${HOLADO_RUNNER_NAME})..."
 echo
-#docker run --rm -it $((docker info | grep -i rootless > /dev/null && echo -n "--user root") || echo -n "-u $(id -u ${USER}):$(id -g ${USER})") --name ${HOLADO_TEST_RUNNER_NAME} \
-docker run --rm -it --user root --name ${HOLADO_TEST_RUNNER_NAME} \
+#docker run --rm -it $((docker info | grep -i rootless > /dev/null && echo -n "--user root") || echo -n "-u $(id -u ${USER}):$(id -g ${USER})") --name ${HOLADO_RUNNER_NAME} \
+docker run --rm -it --user root --name ${HOLADO_RUNNER_NAME} \
     --privileged -v /var/run/docker.sock:/var/run/docker.sock \
     -v "${OUTPUT_DIR}":/output \
     -v "${RESOURCES_DIR}":/resources \
-    -e HOLADO_TEST_OUTPUT_BASEDIR=/output \
-    -e HOLADO_TEST_LOCAL_RESOURCES_BASEDIR=/resources \
+    -e HOLADO_OUTPUT_BASEDIR=/output \
+    -e HOLADO_LOCAL_RESOURCES_BASEDIR=/resources \
     ${NETWORK_DEF_COMMAND} \
     -w /work_dir \
     ${TEST_IMAGE} /bin/bash

holado_helper/docker/run_terminal_in_docker.sh

@@ -12,22 +12,22 @@
 #
 # REQUIREMENTS:
 #     Define in .profile the following variables
-#         - HOLADO_TEST_IMAGE_TAG: docker image tag to use (usually "main" or tag associated to any branch)
+#         - HOLADO_IMAGE_TAG: docker image tag to use (usually "main" or tag associated to any branch)
 #         - optional but preferable:
-#             - HOLADO_TEST_OUTPUT_BASEDIR: absolute path to base output directory of testing solution
-#             - HOLADO_TEST_LOCAL_RESOURCES_BASEDIR: absolute path to base local resources directory of testing solution (where data are stored through campaigns)
+#             - 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_TEST_USE_LOCALHOST: force the container network to 'host'.
-#             - HOLADO_TEST_NETWORK: specify on which network the docker is run.
+#             - HOLADO_USE_LOCALHOST: force the container network to 'host'.
+#             - HOLADO_NETWORK: specify on which network the docker is run.
 #     Example:
-#         export HOLADO_TEST_IMAGE_TAG=main
-#         export HOLADO_TEST_USE_LOCALHOST=True
-#         export HOLADO_TEST_OUTPUT_BASEDIR=$HOME/.holado/output
-#         export HOLADO_TEST_LOCAL_RESOURCES_BASEDIR=$HOME/.holado/resources
+#         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_TEST_IMAGE_TAG; do
+for v in HOLADO_IMAGE_TAG; do
     if [ -z ${!v} ]; then
         echo "Environment variable $v must be set"
         exit 1
@@ -36,26 +36,26 @@ done
 
 WORK_DIR="$(pwd)"
 
-if [[ -z "$HOLADO_TEST_IMAGE_REGISTRY" ]]; then
-    HOLADO_TEST_IMAGE_REGISTRY=registry.gitlab.com/testing-solution/python
+if [[ -z "$HOLADO_IMAGE_REGISTRY" ]]; then
+    HOLADO_IMAGE_REGISTRY=registry.gitlab.com/testing-solution/python
 fi
-TEST_IMAGE=${HOLADO_TEST_IMAGE_REGISTRY}:${HOLADO_TEST_IMAGE_TAG}
+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_TEST_OUTPUT_BASEDIR" ]]; then
-    OUTPUT_DIR=${HOLADO_TEST_OUTPUT_BASEDIR}
+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_TEST_LOCAL_RESOURCES_BASEDIR" ]]; then
-    RESOURCES_DIR=${HOLADO_TEST_LOCAL_RESOURCES_BASEDIR}
+if [[ ! -z "$HOLADO_LOCAL_RESOURCES_BASEDIR" ]]; then
+    RESOURCES_DIR=${HOLADO_LOCAL_RESOURCES_BASEDIR}
 else
     RESOURCES_DIR=${WORK_DIR}/resources
 fi
@@ -72,29 +72,29 @@ if [ ! -d ${RESOURCES_DIR} ]; then
 fi
 
 # Define container network
-if [ "$HOLADO_TEST_USE_LOCALHOST" = True ]; then
+if [ "$HOLADO_USE_LOCALHOST" = True ]; then
 	NETWORK_DEF_COMMAND="--network=host"
 else
-	if [[ ! -z "$HOLADO_TEST_NETWORK" ]]; then
-		NETWORK_DEF_COMMAND="--network $HOLADO_TEST_NETWORK"
+	if [[ ! -z "$HOLADO_NETWORK" ]]; then
+		NETWORK_DEF_COMMAND="--network $HOLADO_NETWORK"
 	else
 		NETWORK_DEF_COMMAND=""
 	fi
 fi
 
 # Docker run 
-if [[ -z "$HOLADO_TEST_RUNNER_NAME" ]]; then
-    HOLADO_TEST_RUNNER_NAME=holado_test_runner
+if [[ -z "$HOLADO_RUNNER_NAME" ]]; then
+    HOLADO_RUNNER_NAME=holado_test_runner
 fi
 
 echo
-echo "Running tests (docker name: ${HOLADO_TEST_RUNNER_NAME})..."
+echo "Running tests (docker name: ${HOLADO_RUNNER_NAME})..."
 echo
-docker run --rm -it $((docker info | grep -i rootless > /dev/null && echo -n "--user root") || echo -n "-u $(id -u ${USER}):$(id -g ${USER})") --name ${HOLADO_TEST_RUNNER_NAME} \
+docker run --rm -it $((docker info | grep -i rootless > /dev/null && 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_TEST_OUTPUT_BASEDIR=/output \
-    -e HOLADO_TEST_LOCAL_RESOURCES_BASEDIR=/resources \
+    -e HOLADO_OUTPUT_BASEDIR=/output \
+    -e HOLADO_LOCAL_RESOURCES_BASEDIR=/resources \
     ${NETWORK_DEF_COMMAND} \
     -w /work_dir \
     ${TEST_IMAGE} /bin/bash

holado_helper/script/initialize_script.py

@@ -46,12 +46,12 @@ def _insert_sys_paths(additional_sys_paths=None):
     __insert_sys_path(os.path.join(holado_path, "src") )
     __insert_sys_path(os.path.join(holado_path, "tests", "behave") )
     
-def _initialize_holado(TSessionContext=None, logging_config_file=None, log_level=logging.WARNING, log_in_file=False, with_session_path=False, **kwargs):
+def _initialize_holado(TSessionContext=None, logging_config_file_path=None, log_level=logging.WARNING, log_in_file=False, with_session_path=False, **kwargs):
     import holado
     session_kwargs={'with_session_path':with_session_path or log_in_file}
     if kwargs:
         session_kwargs.update(kwargs)
-    holado.initialize_for_script(TSessionContext=TSessionContext, logging_config_file=logging_config_file,
+    holado.initialize_for_script(TSessionContext=TSessionContext, logging_config_file_path=logging_config_file_path,
                                  log_level=log_level, log_in_file=log_in_file, log_on_console=not log_in_file, 
                                  session_kwargs=session_kwargs)
     
@@ -69,15 +69,15 @@ def initialize(work_dir_path=None, change_work_dir=True,
         sys_paths.extend(additional_sys_paths)
     _insert_sys_paths(sys_paths)
     
-    logging_config_file=None
+    logging_config_file_path=None
     for dir_path in [res, work_dir_path, os.getcwd()]:
         if dir_path is not None:
             file_path = os.path.join(dir_path, "logging.conf")
             if os.path.exists(file_path):
-                logging_config_file = file_path
+                logging_config_file_path = file_path
                 break
     
-    _initialize_holado(TSessionContext, logging_config_file, log_level, log_in_file, with_session_path)
+    _initialize_holado(TSessionContext, logging_config_file_path, log_level, log_in_file, with_session_path)
     
     return res
 

holado_logging/__init__.py

@@ -14,23 +14,21 @@
 
 
 
-def configure(initialize_logging=True, log_level=None):
+def configure(use_holado_logger=True, logging_config_file_path=None, log_level=None, log_on_console=False, log_in_file=True):
     from holado_logging.common.logging.log_config import LogConfig
-    if log_level is None:
-        import logging
-        log_level = logging.INFO
-        
-    LogConfig.configure(initialize_logging=initialize_logging, log_level=log_level)
+    LogConfig.configure(use_holado_logger=use_holado_logger, config_file_path=logging_config_file_path, log_level=log_level, log_on_console=log_on_console, log_in_file=log_in_file)
     
 def dependencies():
     return None
 
-def register():
+def initialize_and_register():
     from holado.common.context.session_context import SessionContext
     from holado_logging.common.logging.log_manager import LogManager
     
     log_manager = LogManager()
-    log_manager.initialize(log_on_console=True)
+    log_manager.configure()
+    log_manager.initialize()
     
-    SessionContext.instance().services.register_service_instance("log_manager", log_manager, SessionContext.instance())
+    SessionContext.instance().services.register_service_instance("log_manager", log_manager, SessionContext.instance(), 
+                                                                 raise_if_service_exist=False, raise_if_object_exist=False)
 

holado_logging/common/logging/holado_logger.py

@@ -15,7 +15,7 @@ import logging
 
 logger = logging.getLogger(__name__)
 
-#TODO EKL: rename HoladoLogger
+
 class HALogger(logging.Logger):
     default_message_size_limit = None
     
@@ -56,7 +56,7 @@ class HALogger(logging.Logger):
     #     logger.print(f"Change logger {self} level to {level}")
     #     logging.Logger.setLevel(self, level)
     
-class TestRootLogger(HALogger):
+class HARootLogger(HALogger):
     """
     Implementation is a copy of logging.RootLogger
     """