holado 0.13.22__py3-none-any.whl

holado_tools/tools/host_viewer/client/rest/host_viewer_client.py

@@ -0,0 +1,190 @@
+
+#################################################
+# 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
+from holado.common.handlers.undefined import undefined_argument, undefined_value, default,\
+    default_value
+import os
+from holado_core.common.tools.converters.converter import Converter
+from holado_rest.api.rest.rest_manager import RestManager
+from holado_core.common.handlers.wait import WaitFuncResult
+from datetime import datetime
+from holado_python.common.tools.datetime import DateTime
+
+logger = logging.getLogger(__name__)
+
+
+class HostViewerClient(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_HOST_VIEWER_URL", undefined_value)
+            if url is undefined_value:
+                scheme = kwargs.get('scheme', undefined_value)
+                if scheme is undefined_value:
+                    scheme = os.getenv("HOLADO_HOST_VIEWER_SCHEME", "http")
+                host = kwargs.get('host', undefined_value)
+                if host is undefined_value:
+                    host = "localhost" if use_localhost else os.getenv("HOLADO_HOST_VIEWER_HOST", "holado_docker_viewer")
+                port = kwargs.get('port', undefined_value)
+                if port is undefined_value:
+                    if use_localhost:
+                        port = os.getenv("HOLADO_HOST_VIEWER_HOSTPORT", 51231)
+                    else:
+                        port = os.getenv("HOLADO_HOST_VIEWER_PORT", 51231)
+                
+                if port is None:
+                    url = f"{scheme}://{host}"
+                else:
+                    url = f"{scheme}://{host}:{port}"
+            kwargs['url'] = url
+        
+        manager = RestManager(default_client_class=HostViewerClient)
+        res = manager.new_client(**kwargs)
+        
+        return res
+
+    
+    def __init__(self, name, url, headers=None):
+        super().__init__(name, url, headers)
+    
+    
+    # Monitoring of host-controller
+    
+    def is_healthy(self):
+        try:
+            response = self.get(f"health")
+            return response.status_code == 200
+        except:
+            return False
+    
+    def wait_is_healthy(self, timeout_sec=300, do_raise_on_timeout=True):
+        logger.info("Waiting for host-viewer to be healthy...")
+        wait_context = WaitFuncResult(f"wait host-viewer is healthy", self.is_healthy)
+        wait_context.with_timeout(timeout_sec) \
+                    .with_raise_on_timeout(do_raise_on_timeout) \
+                    .with_process_in_thread(False) \
+                    .redo_until(True)
+        try:
+            wait_context.execute()
+        except Exception as exc:
+            logger.error(f"Error while waiting for host-viewer to be healthy: {str(exc)}")
+            raise
+        else:
+            logger.info("host-viewer is healthy")
+    
+    
+    # Common features
+    
+    def get_environment_variable_value(self, var_name):
+        data = [var_name]
+        response = self.get(f"os/env", json=data)
+        return self.response_result(response, status_ok=[200])
+    
+    def get_directory_filenames(self, path, extension='.yml'):
+        data = {'path':path, 'extension':extension}
+        response = self.get(f"os/ls", json=data)
+        return self.response_result(response, status_ok=[200])
+    
+    
+    # Manage containers
+    
+    def get_containers_status(self, all_=False):
+        if all_:
+            response = self.get("docker/container?all=true")
+        else:
+            response = self.get("docker/container")
+        return self.response_result(response, status_ok=[200,204])
+    
+    def get_container_info(self, name, all_=False):
+        """Get container info
+        @return container info if found, else None
+        """
+        if all_:
+            response = self.get(f"docker/container/{name}?all=true")
+        else:
+            response = self.get(f"docker/container/{name}")
+        return self.response_result(response, status_ok=[200,204], result_on_statuses={204:None, default:None})
+    
+    def get_container_status(self, name, all_=False):
+        """Get container status
+        @return container status if found, else None
+        """
+        if all_:
+            response = self.get(f"docker/container/{name}/status?all=true")
+        else:
+            response = self.get(f"docker/container/{name}/status")
+        return self.response_result(response, status_ok=[200,204], result_on_statuses={204:None, default:None})
+    
+    def get_container_health_status(self, name, all_=False):
+        """Get container health status
+        @return container health status if found, else None
+        """
+        if all_:
+            response = self.get(f"docker/container/{name}/health_status?all=true")
+        else:
+            response = self.get(f"docker/container/{name}/health_status")
+        return self.response_result(response, status_ok=[200,204], result_on_statuses={204:None, default:None})
+    
+    
+    
+    def await_container_is_started(self, name, timeout=default_value):
+        if isinstance(timeout, int):
+            response = self.put(f"docker/container/{name}/await_started?timeout={timeout}")
+        else:
+            response = self.put(f"docker/container/{name}/await_started")
+        return self.response_result(response, status_ok=[200,204])
+    
+    def await_container_status(self, name, status='running', timeout=default_value):
+        if isinstance(timeout, int):
+            response = self.put(f"docker/container/{name}/await_status?status={status}&timeout={timeout}")
+        else:
+            response = self.put(f"docker/container/{name}/await_status?status={status}")
+        return self.response_result(response, status_ok=[200,204])
+    
+    def await_container_health_status(self, name, status='healthy', timeout=default_value):
+        if isinstance(timeout, int):
+            response = self.put(f"docker/container/{name}/await_health_status?status={status}&timeout={timeout}")
+        else:
+            response = self.put(f"docker/container/{name}/await_health_status?status={status}")
+        return self.response_result(response, status_ok=[200,204])
+    
+    
+    # Manage logs
+    
+    def get_logs(self, name, with_timestamps=True, since=undefined_argument, until=undefined_argument):
+        data = {}
+        if with_timestamps is not None:
+            data['with_timestamps'] = with_timestamps
+        if since not in [undefined_argument, None]:
+            if isinstance(since, datetime):
+                since = DateTime.datetime_2_str(since)
+            data['since'] = since
+        if until not in [undefined_argument, None]:
+            if isinstance(until, datetime):
+                until = DateTime.datetime_2_str(until)
+            data['until'] = until
+        
+        response = self.get(f"docker/logs/{name}", json=data)
+        return self.response_result(response, status_ok=[200,204], result_on_statuses={204:None, default:None})
+    
+    
+    

holado_tools/tools/host_viewer/server/Dockerfile

@@ -0,0 +1,60 @@
+### Build
+
+#FROM python:3.12.9-alpine3.21 AS build
+#FROM python:3.12.11-alpine3.22 AS build
+FROM python:3.12.12-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
+
+# 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/host_viewer/requirements.txt
+WORKDIR /code/host_viewer
+RUN python -m venv /code/env \
+    && source /code/env/bin/activate \
+    && pip install --no-cache-dir -r requirements.txt
+
+
+
+### Runtime
+
+#FROM python:3.12.9-alpine3.21 AS runtime
+#FROM python:3.12.11-alpine3.22 AS runtime
+FROM python:3.12.12-alpine3.22 AS runtime
+
+# 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 host viewer sources
+COPY --chown=appuser ./rest /code/host_viewer
+
+# Activate permanently python venv
+ENV PATH=/code/env/bin:$PATH
+
+WORKDIR /code/host_viewer
+CMD ["sh", "-c", "uvicorn run:app --host 0.0.0.0 --port $HOLADO_HOST_VIEWER_PORT"]
+

holado_tools/tools/host_viewer/server/requirements.txt

@@ -0,0 +1,2 @@
+# HolAdo framework
+holado[api-connexion,docker,ssl,yaml]>=0.13.7

holado_tools/tools/host_viewer/server/rest/README

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

holado_tools/tools/host_viewer/server/rest/api/__init__.py

@@ -0,0 +1,24 @@
+#################################################
+# 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
+# import logging
+
+# logger = logging.getLogger(__name__)
+
+
+class HealthView(MethodView):
+    
+    def get(self):
+        return {'status': 'healthy'}
+
+

holado_tools/tools/host_viewer/server/rest/api/docker/__init__.py

@@ -0,0 +1,65 @@
+#################################################
+# 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()
+
+class ContainerView(MethodView):
+    
+    def get(self, name=None, all_=False, limit=100):
+        try:
+            _get_session_context().docker_client.update_containers(all_=all_)
+            if name is not None:
+                if not _get_session_context().docker_client.has_container(name, in_list=False, all_=all_, reset_if_removed=False):
+                    if all_:
+                        return f"Container '{name}' doesn't exist", 406
+                    else:
+                        return f"Container '{name}' is not running (try with '?all=true' to get information on existing but not running containers)", 406
+                
+                cont = _get_session_context().docker_client.get_container(name, all_=all_)
+                res = cont.information
+            else:
+                names = _get_session_context().docker_client.get_container_names(in_list=False, all_=all_)
+                res = [{'name':n, 'status':_get_session_context().docker_client.get_container(n, all_=all_).status} for n in names]
+            return res
+        except Exception as exc:
+            if name is not None:
+                msg = f"Failed to get information of container '{name}'"
+            else:
+                msg = f"Failed to get information of all containers"
+            logger.exception(msg)
+            return str(exc), 500
+
+class LogsView(MethodView):
+    
+    def get(self, name, body: dict):
+        try:
+            with_timestamps = body.get('with_timestamps', True)
+            since = body.get('since', None)
+            until = body.get('until', None)
+            
+            container = _get_session_context().__docker_client.get_container(name, all_=True, reset_if_removed=False)
+            res = container.get_logs(timestamps=with_timestamps, since=since, until=until, 
+                                     formatter=JsonDockerContainerLogsFormatter())
+            
+            return res
+        except Exception as exc:
+            logger.exception(f"Failed to get logs of container '{name}'")
+            return str(exc), 500

holado_tools/tools/host_viewer/server/rest/api/docker/container.py

@@ -0,0 +1,87 @@
+#################################################
+# 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
+from holado.common.handlers.undefined import default_value
+import logging
+
+
+logger = logging.getLogger(__name__)
+
+
+def _get_session_context():
+    return SessionContext.instance()
+
+
+class StatusView(MethodView):
+    
+    def get(self, name, all_=False):
+        try:
+            cont = _get_session_context().docker_client.get_container(name, all_=all_, reset_if_removed=False)
+            if cont:
+                return cont.status
+            else:
+                return
+        except Exception as exc:
+            logger.exception(f"Failed to get status of container '{name}'")
+            return str(exc), 500
+
+class HealthStatusView(MethodView):
+    
+    def get(self, name, all_=False):
+        try:
+            cont = _get_session_context().docker_client.get_container(name, all_=all_, reset_if_removed=False)
+            if cont:
+                return cont.health_status
+            else:
+                return
+        except Exception as exc:
+            logger.exception(f"Failed to get health status of container '{name}'")
+            return str(exc), 500
+
+
+
+
+class AwaitStartedView(MethodView):
+    
+    def put(self, name, timeout=default_value):
+        try:
+            _get_session_context().docker_client.await_container_exists(name, timeout=timeout)
+            return _get_session_context().docker_client.get_container(name).await_started(timeout=timeout)()
+        except Exception as exc:
+            logger.exception(f"Failed to await container '{name}' is started")
+            return str(exc), 500
+    
+class AwaitStatusView(MethodView):
+    
+    def put(self, name, status, timeout=default_value):
+        try:
+            _get_session_context().docker_client.await_container_exists(name, timeout=timeout)
+            return _get_session_context().docker_client.get_container(name).await_status(status, timeout=timeout)()
+        except Exception as exc:
+            logger.exception(f"Failed to await container '{name}' has status '{status}'")
+            return str(exc), 500
+    
+class AwaitHealthStatusView(MethodView):
+    
+    def put(self, name, status, timeout=default_value):
+        try:
+            _get_session_context().docker_client.await_container_exists(name, timeout=timeout)
+            return _get_session_context().docker_client.get_container(name).await_health_status(status, timeout=timeout)()
+        except Exception as exc:
+            logger.exception(f"Failed to await container '{name}' has health status '{status}'")
+            return str(exc), 500
+
+
+
+

holado_tools/tools/host_viewer/server/rest/api/os.py

@@ -0,0 +1,58 @@
+#################################################
+# 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 os
+import logging
+
+logger = logging.getLogger(__name__)
+
+
+def _get_session_context():
+    return SessionContext.instance()
+
+
+class EnvView(MethodView):
+    
+    def get(self, body: list):
+        try:
+            return [os.getenv(name) for name in body]
+        except Exception as exc:
+            logger.exception(f"Failed to get environment variable values (names: {body})")
+            return str(exc), 500
+
+
+class LsView(MethodView):
+    
+    def get(self, body: dict):
+        try:
+            dir_path = body['path']
+            extension = body.get('extension', None)
+            
+            if not os.path.exists(dir_path) or not os.path.isdir(dir_path):
+                return f"Directory '{dir_path}' doesn't exist", 406
+            
+            res = []
+            for filename in os.listdir(dir_path):
+                if extension is not None and not filename.endswith(extension):
+                    continue
+                if os.path.isfile(os.path.join(dir_path, filename)):
+                    res.append(filename)
+            
+            return res
+        except Exception as exc:
+            logger.exception(f"Failed to list directory (parameters: {body})")
+            return str(exc), 500
+
+
+

holado_tools/tools/host_viewer/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"))
+    
+