holado 0.8.4__py3-none-any.whl → 0.9.1__py3-none-any.whl

holado_test/common/context/step_context.py

@@ -14,7 +14,7 @@
 from builtins import super
 from holado.common.context.context import Context
 import logging
-from datetime import datetime
+from holado_python.common.tools.datetime import DateTime
 
 logger = logging.getLogger(__name__)
 
@@ -26,7 +26,7 @@ class StepContext(Context):
         self.__step = step
         self.__status = None
         
-        self.__start_date = datetime.now()
+        self.__start_date = DateTime.now()
         self.__end_date = None
     
     def __str__(self):
@@ -60,7 +60,7 @@ class StepContext(Context):
             return None
     
     def end(self):
-        self.__end_date = datetime.now()
+        self.__end_date = DateTime.now()
     
 
         

holado_test/test_server/client/rest/test_server_client.py

@@ -0,0 +1,117 @@
+
+#################################################
+# 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 holado_rest.api.rest.rest_client import RestClient
+import socket
+import urllib.parse
+import re
+from holado_rest.api.rest.rest_manager import RestManager
+from holado.common.handlers.undefined import undefined_argument, undefined_value
+import os
+from holado_core.common.tools.converters.converter import Converter
+
+logger = logging.getLogger(__name__)
+
+
+class TestServerClient(RestClient):
+
+    @classmethod
+    def new_client(cls, use_localhost=undefined_argument, **kwargs):
+        if 'name' not in kwargs:
+            kwargs['name'] = None
+        if 'url' not in kwargs:
+            if use_localhost is undefined_argument:
+                env_use = os.getenv("HOLADO_USE_LOCALHOST", False)
+                use_localhost = Converter.is_boolean(env_use) and Converter.to_boolean(env_use)
+            
+            url = os.getenv("HOLADO_TEST_SERVER_URL", undefined_value)
+            if url is undefined_value:
+                scheme = kwargs.get('scheme', undefined_value)
+                if scheme is undefined_value:
+                    scheme = os.getenv("HOLADO_TEST_SERVER_SCHEME", "http")
+                host = kwargs.get('host', undefined_value)
+                if host is undefined_value:
+                    host = "localhost" if use_localhost else os.getenv("HOLADO_TEST_SERVER_HOST", "holado_test_server")
+                port = kwargs.get('port', undefined_value)
+                if port is undefined_value:
+                    port = os.getenv("HOLADO_TEST_SERVER_PORT", 51232)
+                
+                if port is None:
+                    url = f"{scheme}://{host}"
+                else:
+                    url = f"{scheme}://{host}:{port}"
+            kwargs['url'] = url
+        
+        manager = RestManager(default_client_class=cls)
+        res = manager.new_client(**kwargs)
+        
+        return res
+    
+    
+    def __init__(self, name, url, headers=None):
+        super().__init__(name, url, headers)
+        
+        self.__is_available = None
+    
+    @property
+    def is_available(self):
+        if self.__is_available is None:
+            self.__is_available = self.ping()
+            logger.info(f"Test server is {'not ' if not self.__is_available else ''}available")
+        return self.__is_available
+    
+    def ping(self):
+        url_parsed = urllib.parse.urlparse(self.url)
+        netloc_pattern = r"(?P<host>.*?)(?::(?P<port>\d+))?$"
+        m = re.match(netloc_pattern, url_parsed.netloc)
+        host = m.group('host')
+        port = Converter.to_integer(m.group('port'))
+        
+        sock = socket.socket(socket.AF_INET,socket.SOCK_STREAM)
+        sock.settimeout(1)
+        try:
+            sock.connect((host,port))
+        except Exception as exc:
+            logger.debug(f"Ping of test server failed for ({host}, {port}): {str(exc)}")
+            return False
+        else:
+            sock.close()
+            logger.debug(f"Ping of test server succeeded")
+            return True
+        
+    
+    # Manage campaigns actions
+    
+    def update_stored_campaigns(self):
+        response = self.put(f"campaign/update")
+        return self.response_result(response, status_ok=[200, 204])
+    
+    def get_scenario_history(self, scenario_name=None, size=None):
+        data = {}
+        if scenario_name is not None:
+            data['scenario_name'] = scenario_name
+        if size is not None:
+            data['size'] = size
+            
+        if data:
+            response = self.get(f"campaign/scenario/history", json=data)
+        else:
+            response = self.get(f"campaign/scenario/history", json=data)
+        
+        return self.response_result(response, status_ok=[200, 204])
+    
+    
+    
+    
+    

holado_test/test_server/server/Dockerfile

@@ -0,0 +1,70 @@
+### Build
+
+#FROM python:3.12.9-alpine3.21 AS build
+FROM python:3.12.11-alpine3.22 AS build
+
+# Install to build python requirements
+RUN apk update \
+    && apk --no-cache --update add build-base \
+    && apk --update add alpine-sdk \
+    && apk add libffi-dev \
+    && apk add postgresql-dev gcc python3-dev musl-dev \
+    && apk add protobuf-dev
+
+# Add tools
+RUN apk --no-cache add bash \
+    && apk --no-cache add nano \
+    && apk --no-cache add curl
+
+# Create user
+RUN addgroup appuser \
+    && adduser -G appuser -s /bin/bash -D appuser
+
+# Create /code folder
+RUN mkdir /code \
+    && chown -R appuser:appuser /code
+
+# Switch to user appuser
+USER appuser
+
+# Create python venv and install requirements
+COPY --chown=appuser ./requirements.txt /code/test_server/requirements.txt
+WORKDIR /code/test_server
+RUN python -m venv /code/env \
+    && source /code/env/bin/activate \
+    && pip install -r requirements.txt
+
+
+
+### Runtime
+
+#FROM python:3.12.9-alpine3.21 AS runtime
+FROM python:3.12.11-alpine3.22 AS runtime
+
+# Install for python requirements
+#RUN apk update \
+#    && apk --no-cache add libstdc++ \
+#    && apk --no-cache add postgresql-dev gcc python3-dev musl-dev
+
+# Add tools
+RUN apk --no-cache add bash \
+    && apk --no-cache add nano \
+    && apk --no-cache add curl
+
+# Create and switch to user appuser as in build
+RUN addgroup appuser \
+    && adduser -G appuser -s /bin/bash -D appuser
+USER appuser
+
+# Copy /code from build
+COPY --chown=appuser --from=build /code /code
+
+# Copy docker controller sources
+COPY --chown=appuser ./rest /code/test_server
+
+# Activate permanently python venv
+ENV PATH=/code/env/bin:$PATH
+
+WORKDIR /code/test_server
+CMD ["sh", "-c", "uvicorn run:app --host 0.0.0.0 --port $HOLADO_TEST_SERVER_PORT"]
+

holado_test/test_server/server/core/server_context.py

@@ -0,0 +1,42 @@
+from builtins import super
+from holado.common.context.session_context import SessionContext
+import logging
+
+logger = logging.getLogger(__name__)
+
+
+class TestServerSessionContext(SessionContext):
+    
+    def __init__(self):
+        super().__init__("TestServerSession")
+        
+    def configure(self, session_kwargs=None):
+        logger.info("Configuring TestServerSessionContext")
+        
+        super().configure(session_kwargs)
+        
+        # Override default registered modules
+         
+
+        
+        # Register new modules
+        
+        from holado_test.test_server.server.core.server_manager import TestServerManager
+        self.services.register_service_type("server_manager", TestServerManager,
+                            lambda m: m.initialize(self.resource_manager) )
+        
+        
+        
+    def initialize(self, session_kwargs=None):
+        if session_kwargs is None:
+            session_kwargs = {}
+        # raise_if_not_exist = session_kwargs.get("raise_if_not_exist", True)
+        # do_import = session_kwargs.get("import_compiled_proto", True)
+        
+        # Call default initialization
+        super().initialize(session_kwargs)
+        
+        
+        
+        
+        

holado_test/test_server/server/core/server_manager.py

@@ -0,0 +1,54 @@
+
+#################################################
+# 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.common.context.session_context import SessionContext
+from behave.model_core import Status
+from holado_core.common.tools.tools import Tools
+import logging
+# from holado_report.report.builders.json_execution_historic_report_builder import JsonExecutionHistoricReportBuilder
+from holado_report.report.builders.detailed_scenario_failed_report_builder import DetailedScenarioFailedReportBuilder
+from holado_report.report.builders.summary_report_builder import SummaryReportBuilder
+from holado_report.report.builders.summary_scenario_failed_report_builder import SummaryScenarioFailedReportBuilder
+from holado_report.report.builders.short_scenario_failed_report_builder import ShortScenarioFailedReportBuilder
+from holado_report.report.reports.base_report import BaseReport
+from holado_scripting.common.tools.evaluate_parameters import EvaluateParameters
+from holado_report.report.builders.summary_scenario_report_builder import SummaryScenarioReportBuilder
+from holado_report.report.builders.failure_report_builder import FailureReportBuilder
+from holado_report.campaign.campaign_manager import CampaignManager
+# from holado_core.scenario.scenario_duration_manager import ScenarioDurationManager
+
+logger = logging.getLogger(__name__)
+
+
+
+
+class TestServerManager(object):
+    """ Manage test server
+    """
+    
+    def __init__(self):
+        super().__init__()
+        
+        self.__campaign_manager = CampaignManager(db_name="server/campaigns")
+    
+    def initialize(self, resource_manager):
+        self.__campaign_manager.initialize(resource_manager)
+    
+    @property
+    def campaign_manager(self):
+        return self.__campaign_manager
+    
+    
+
+
+

holado_test/test_server/server/requirements.txt

@@ -0,0 +1,2 @@
+# HolAdo framework
+holado[api-connexion,ssl]

holado_test/test_server/server/rest/README

@@ -0,0 +1,2 @@
+REST API specification is described in openapi.yaml.
+If Test Server is running, the specification can be displayed with path /ui (ex: http://127.0.0.1:8001/ui).

holado_test/test_server/server/rest/api/__init__.py

@@ -0,0 +1,23 @@
+#################################################
+# 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 flask.views import MethodView
+from holado.common.context.session_context import SessionContext
+import logging
+
+logger = logging.getLogger(__name__)
+
+
+
+def _get_session_context():
+    return SessionContext.instance()
+

holado_docker/tools/docker_controller/docker_controller_manager.py → holado_test/test_server/server/rest/api/campaign/__init__.py

@@ -1,4 +1,3 @@
-
 #################################################
 # HolAdo (Holistic Automation do)
 #
@@ -11,36 +10,19 @@
 # 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 flask.views import MethodView
+from holado.common.context.session_context import SessionContext
 import logging
-from holado_core.common.tools.converters.converter import Converter
-import os
-from holado_docker.tools.docker_controller.client.rest.docker_controller_client import DockerControllerClient
-from holado_rest.api.rest.rest_manager import RestManager
-from holado.common.handlers.undefined import undefined_argument
 
 logger = logging.getLogger(__name__)
 
 
-class DockerControllerManager(object):
+def _get_session_context():
+    return SessionContext.instance()
+
+
+class UpdateView(MethodView):
     
-    @classmethod
-    def new_client(cls, use_localhost=undefined_argument, **kwargs):
-        if 'name' not in kwargs:
-            kwargs['name'] = None
-        if 'url' not in kwargs:
-            if use_localhost is undefined_argument:
-                env_use = os.getenv("HOLADO_USE_LOCALHOST", False)
-                use_localhost = Converter.is_boolean(env_use) and Converter.to_boolean(env_use)
-            
-            host = "localhost" if use_localhost else os.getenv("HOLADO_DOCKER_CONTROLLER_NAME", "holado_docker_controller")
-            port = os.getenv("HOLADO_DOCKER_CONTROLLER_PORT", 8000)
-            kwargs['url'] = f"http://{host}:{port}"
-        
-        manager = RestManager(default_client_class=DockerControllerClient)
-        res = manager.new_client(**kwargs)
-        
-        return res
-        
-        
-        
-        
+    def put(self):
+        _get_session_context().server_manager.campaign_manager.update_stored_campaigns()
+

holado_test/test_server/server/rest/api/campaign/scenario.py

@@ -0,0 +1,33 @@
+#################################################
+# 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 flask.views import MethodView
+from holado.common.context.session_context import SessionContext
+
+
+def _get_session_context():
+    return SessionContext.instance()
+
+
+class HistoryView(MethodView):
+    
+    def get(self, body: dict):
+        scenario_name = body.get('scenario_name') if body else None
+        size = body.get('size') if body else None
+        
+        res = _get_session_context().server_manager.campaign_manager.get_scenario_history(scenario_name=scenario_name, size=size)
+        return res
+
+
+
+
+

holado_test/test_server/server/rest/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_test/test_server/server/rest/logging.conf

@@ -0,0 +1,50 @@
+[holado]
+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
+#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=WARNING
+#holado_multitask.multitasking.multitask_manager=TRACE
+#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
+
+#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_system=DEBUG
+#holado_test.behave.behave=DEBUG
+#holado_yaml=DEBUG
+
+# External libraries
+chardet=WARNING
+pika=WARNING
+psycopg=INFO
+ssl=DEBUG
+suds.transport=DEBUG
+subprocess=DEBUG
+urllib3=INFO
+zeep.transports=DEBUG
+

holado_test/test_server/server/rest/openapi.yaml

@@ -0,0 +1,46 @@
+openapi: "3.0.0"
+info:
+  version: "1"
+  title: "Test Server API"
+  description: |
+    API exposed by Test Server.
+paths:
+  /campaign/update:
+    put:
+      description: "Update stored campaigns"
+      responses:
+        200:
+          description: ""
+          content:
+            application/json:
+              schema:
+                type: "string"
+               
+  /campaign/scenario/history:
+    get:
+      description: "Get execution history of a scenario"
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: "object"
+              nullable: true
+              properties:
+                scenario_name:
+                  type: string
+                size:
+                  type: integer
+      responses:
+        200:
+          description: "Execution history of a scenario"
+          content:
+            application/json:
+              schema:
+                type: "string"
+
+components:
+  securitySchemes: {}
+  schemas:
+    DockerControler:
+      properties: {}
+

holado_test/test_server/server/rest/run.py

@@ -0,0 +1,40 @@
+#################################################
+# 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 connexion
+from connexion.resolver import MethodViewResolver
+import os
+import logging
+
+here = os.path.abspath(os.path.dirname(__file__))
+
+# For debug with HolAdo sources, insert HolAdo source paths
+from initialize_holado import insert_holado_source_paths  # @UnresolvedImport
+insert_holado_source_paths(with_test_behave=False)
+
+# Initialize HolAdo
+import holado
+from holado_test.test_server.server.core.server_context import TestServerSessionContext
+holado.initialize(TSessionContext=TestServerSessionContext, 
+                  logging_config_file_path=os.path.join(here, 'logging.conf'), log_level=logging.INFO, 
+                  log_on_console=True, log_in_file=False, 
+                  garbage_collector_periodicity=None)
+
+# Update stored campaigns
+from holado.common.context.session_context import SessionContext
+SessionContext.instance().server_manager.campaign_manager.update_stored_campaigns()
+
+
+app = connexion.FlaskApp(__name__, pythonic_params=True)
+app.add_api('openapi.yaml', 
+            resolver=MethodViewResolver('api'), resolver_error=501, 
+            pythonic_params=True)