holado 0.11.1__py3-none-any.whl → 0.11.3__py3-none-any.whl

holado_tools/tools/host_controller/server/rest/openapi.yaml

@@ -0,0 +1,265 @@
+openapi: "3.0.0"
+info:
+  version: "1"
+  title: "Host Controller API"
+  description: |
+    API to process some host actions from anywhere on the network.
+    In a microservice architecture, the host-controller can be run in a docker with special privileges,
+    whereas all other microservices have user privileges.
+    For example, it is usefull for a testing solution needing to restart a microservice of the SUT (System Under Test),
+    but the testing solution docker image has not the privileges to do it.
+paths:
+  /os/env:
+    get:
+      description: "Get environment variable values"
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: "array"
+              items:
+                type: "string"
+      responses:
+        200:
+          description: "Environment variable values"
+          content:
+            application/json:
+              schema:
+                type: "array"
+                items:
+                  type: "object"
+
+  /os/ls:
+    get:
+      description: "List directory filenames"
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: "object"
+              properties:
+                path:
+                  type: string
+                extension:
+                  type: string
+                  nullable: true
+      responses:
+        200:
+          description: "Directory filenames"
+          content:
+            application/json:
+              schema:
+                type: "array"
+                items:
+                  type: "string"
+
+  /docker/container:
+    get:
+      description: "List containers and their status"
+      parameters:
+        - in: "query"
+          name: "all"
+          description: "if set to 'true', list all containers, not only running ones"
+          schema:
+            type: "boolean"
+            default: false
+      responses:
+        200:
+          description: "List of container names with their status"
+          content:
+            application/json:
+              schema:
+                type: "array"
+                items:
+                  type: "string"
+  /docker/container/{name}:
+    get:
+      description: "Display all information of a container"
+      parameters:
+        - in: "path"
+          name: "name"
+          description: "Container name"
+          required: true
+          schema:
+            type: "string"
+        - in: "query"
+          name: "all"
+          description: "if set to 'true', search container in all containers, not only running ones"
+          schema:
+            type: "boolean"
+            default: false
+      responses:
+        200:
+          description: "Container information"
+          content:
+            application/json:
+              schema:
+                type: "string"
+  /docker/container/{name}/restart:
+    put:
+      description: "Restart a container"
+      parameters:
+        - in: "path"
+          name: "name"
+          description: "Container name"
+          required: true
+          schema:
+            type: "string"
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: "object"
+              nullable: true
+      responses:
+        200:
+          description: ""
+          content:
+            application/json:
+              schema:
+                type: "string"
+  /docker/container/{name}/start:
+    put:
+      description: "Start a container"
+      parameters:
+        - in: "path"
+          name: "name"
+          description: "Container name"
+          required: true
+          schema:
+            type: "string"
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: "object"
+              nullable: true
+      responses:
+        200:
+          description: ""
+          content:
+            application/json:
+              schema:
+                type: "string"
+  /docker/container/{name}/stop:
+    put:
+      description: "Stop a container"
+      parameters:
+        - in: "path"
+          name: "name"
+          description: "Container name"
+          required: true
+          schema:
+            type: "string"
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: "object"
+              nullable: true
+      responses:
+        200:
+          description: ""
+          content:
+            application/json:
+              schema:
+                type: "string"
+  /docker/container/{name}/wait:
+    put:
+      description: "Wait until a container is stopped"
+      parameters:
+        - in: "path"
+          name: "name"
+          description: "Container name"
+          required: true
+          schema:
+            type: "string"
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: "object"
+              nullable: true
+      responses:
+        200:
+          description: ""
+          content:
+            application/json:
+              schema:
+                type: "string"
+                
+  /config/yaml_file:
+    get:
+      description: "Get content of a YAML file"
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: "object"
+              properties:
+                file_path:
+                  type: string
+      responses:
+        200:
+          description: ""
+          content:
+            application/text:
+              schema:
+                type: "string"
+    patch:
+      description: "Update a YAML file"
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: "object"
+              properties:
+                file_path:
+                  type: string
+                yaml_string:
+                  type: string
+                with_backup:
+                  type: "boolean"
+                  default: false
+                backup_extension:
+                  type: string
+                  default: '.bak'
+      responses:
+        200:
+          description: ""
+          content:
+            application/json:
+              schema:
+                type: "string"
+    put:
+      description: "Replace a YAML file"
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: "object"
+              properties:
+                action:
+                  description: "Action to perform"
+                  type: string
+                  enum:
+                    - "restore"
+                file_path:
+                  type: string
+                backup_extension:
+                  type: string
+                  default: '.bak'
+      responses:
+        200:
+          description: ""
+          content:
+            application/json:
+              schema:
+                type: "string"
+
+components:
+  securitySchemes: {}
+  schemas:
+    DockerControler:
+      properties: {}
+

holado_tools/tools/host_controller/server/rest/run.py

@@ -0,0 +1,31 @@
+#################################################
+# 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
+
+# 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
+from holado import initialize
+initialize(TSessionContext=None, use_holado_logger=True, logging_config_file_path=None,
+           log_level=None, log_time_in_utc=None, log_on_console=True, log_in_file=False,
+           config_kwargs={'application_group':'host_controller'},
+           garbage_collector_periodicity=None)
+
+
+app = connexion.FlaskApp(__name__, pythonic_params=True)
+app.add_api('openapi.yaml', 
+            resolver=MethodViewResolver('api'), resolver_error=501, 
+            pythonic_params=True)

holado_tools/tools/host_controller/server/run_host_controller_in_docker.sh

@@ -0,0 +1,107 @@
+#!/bin/bash
+
+# Script to launch Host Controller as a docker image.
+# 
+# Host Controller exposes a REST API with host services.
+# It is accessible on localhost, and also on a docker network if HOLADO_NETWORK is defined.
+# API is accessible on port HOLADO_HOST_CONTROLLER_HOSTPORT from localhost and port HOLADO_HOST_CONTROLLER_PORT from network.
+#
+# REST API specification is in file rest/openapi.yaml.
+#
+# REQUIREMENTS:
+#     Have access to any HolAdo registry.
+#
+#     Optionally, define in .profile the following variables
+#         - HOLADO_HOST_CONTROLLER_HOST: host name or name of the container
+#         - HOLADO_HOST_CONTROLLER_HOSTPORT: REST API port to use from localhost (default: 51231)
+#         - HOLADO_HOST_CONTROLLER_PORT: REST API port to use from network HOLADO_NETWORK (default: 51231)
+#         - HOLADO_IMAGE_REGISTRY: docker image registry to use (default: holado/host_controller)
+#         - HOLADO_IMAGE_TAG: docker image tag to use (default: latest)
+#         - HOLADO_OUTPUT_BASEDIR: absolute path to base output directory (default: [HOME]/.holado/output)
+#         - HOLADO_USE_LOCALHOST: force the container network to 'host'.
+#         - HOLADO_NETWORK: specify on which network the docker is run.
+#
+
+
+WORK_DIR="$(pwd)"
+
+if [[ -z "$HOLADO_IMAGE_REGISTRY" ]]; then
+    HOLADO_IMAGE_REGISTRY=holado/host_controller
+fi
+if [[ -z "$HOLADO_IMAGE_TAG" ]]; then
+    HOLADO_IMAGE_TAG=latest
+fi
+CONTROLLER_IMAGE=${HOLADO_IMAGE_REGISTRY}:${HOLADO_IMAGE_TAG}
+
+# Update docker image
+echo "Updating docker image ${CONTROLLER_IMAGE}..."
+docker pull ${CONTROLLER_IMAGE}
+
+# Define test output directory
+if [[ ! -z "$HOLADO_OUTPUT_BASEDIR" ]]; then
+    OUTPUT_DIR=${HOLADO_OUTPUT_BASEDIR}
+else
+    OUTPUT_DIR=${HOME}/.holado/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=${HOME}/.holado/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
+
+# Define ports to use
+if [[ -z "$HOLADO_HOST_CONTROLLER_HOSTPORT" ]]; then
+    HOLADO_HOST_CONTROLLER_HOSTPORT=51231
+fi
+if [[ -z "$HOLADO_HOST_CONTROLLER_PORT" ]]; then
+    HOLADO_HOST_CONTROLLER_PORT=51231
+fi
+
+# Docker run 
+if [[ -z "$HOLADO_HOST_CONTROLLER_HOST" ]]; then
+    HOLADO_HOST_CONTROLLER_HOST=holado_host_controller
+fi
+
+echo
+echo "Running Host Controller..."
+echo "    container name: ${HOLADO_HOST_CONTROLLER_HOST}"
+echo "    host port: ${HOLADO_HOST_CONTROLLER_HOSTPORT}"
+echo "    port: ${HOLADO_HOST_CONTROLLER_PORT}"
+#echo "    NETWORK_DEF_COMMAND=${NETWORK_DEF_COMMAND}"
+echo
+docker run --rm --user root --name ${HOLADO_HOST_CONTROLLER_HOST} \
+    --privileged -v $(docker info --format '{{.SecurityOptions}}' | grep -q rootless && echo -n "/run/user/$(id -u ${USER})/docker.sock" || echo -n "/var/run/docker.sock"):/var/run/docker.sock \
+    -v "${OUTPUT_DIR}":/output \
+    -v "${RESOURCES_DIR}":/resources \
+    -e HOLADO_OUTPUT_BASEDIR=/output \
+    -e HOLADO_LOCAL_RESOURCES_BASEDIR=/resources \
+    -e HOLADO_HOST_CONTROLLER_PORT=${HOLADO_HOST_CONTROLLER_PORT} \
+    ${NETWORK_DEF_COMMAND} \
+    -p ${HOLADO_HOST_CONTROLLER_HOSTPORT}:${HOLADO_HOST_CONTROLLER_PORT} \
+    ${CONTROLLER_IMAGE}
+

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

@@ -0,0 +1,96 @@
+
+#################################################
+# 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
+import os
+from holado_core.common.tools.converters.converter import Converter
+from holado_rest.api.rest.rest_manager import RestManager
+
+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)
+    
+    
+    # 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):
+        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])
+    
+    
+    

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]

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,22 @@
+#################################################
+# 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_tools/tools/host_viewer/server/rest/api/docker/__init__.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.
+#################################################
+
+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):
+        _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