holado 0.10.1__py3-none-any.whl → 0.11.0__py3-none-any.whl

holado_docker/tools/docker_controller/server/rest/api/os.py

@@ -1,47 +0,0 @@
-#################################################
-# 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
-
-def _get_session_context():
-    return SessionContext.instance()
-
-
-class EnvView(MethodView):
-    
-    def get(self, body: list):
-        res = [os.getenv(name) for name in body]
-        return res
-
-
-class LsView(MethodView):
-    
-    def get(self, body: dict):
-        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
-
-
-

holado_docker/tools/docker_controller/server/rest/openapi.yaml

@@ -1,265 +0,0 @@
-openapi: "3.0.0"
-info:
-  version: "1"
-  title: "Docker Controller API"
-  description: |
-    API to process some docker actions from anywhere on the network.
-    In a microservice architecture, the docker 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"
-
-  /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"
-  /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"
-  /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"
-  /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"
-  /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"
-  /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_docker/tools/docker_controller/server/rest/run.py

@@ -1,31 +0,0 @@
-#################################################
-# 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':'docker_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_docker/tools/docker_controller/server/run_docker_controller_in_docker.sh

@@ -1,102 +0,0 @@
-#!/bin/bash
-
-# Script to launch Docker Controller as a docker image.
-# 
-# Docker Controller exposes a REST API for some docker commands.
-# It is accessible on localhost, and also on a docker network if HOLADO_NETWORK is defined.
-# On all networks, API is accessible on same port (HOLADO_DOCKER_CONTROLLER_PORT or 8000).
-#
-# REST API specification is in file rest/openapi.yaml.
-#
-# REQUIREMENTS:
-#     Have access to any HolAdo registry.
-#
-#     Optionally, define in .profile the following variables
-#         - HOLADO_DOCKER_CONTROLLER_HOST: host name or name of the container
-#         - HOLADO_DOCKER_CONTROLLER_PORT: REST API port to use (default: 51231)
-#         - HOLADO_IMAGE_REGISTRY: docker image registry to use (default: holado/docker_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/docker_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 port to use
-if [[ -z "$HOLADO_DOCKER_CONTROLLER_PORT" ]]; then
-    HOLADO_DOCKER_CONTROLLER_PORT=51231
-fi
-
-
-# Docker run 
-if [[ -z "$HOLADO_DOCKER_CONTROLLER_NAME" ]]; then
-    HOLADO_DOCKER_CONTROLLER_NAME=holado_docker_controller
-fi
-
-echo
-echo "Running Docker Controller (docker name: ${HOLADO_DOCKER_CONTROLLER_NAME})..."
-echo "    port: ${HOLADO_DOCKER_CONTROLLER_PORT}"
-#echo "    NETWORK_DEF_COMMAND=${NETWORK_DEF_COMMAND}"
-echo
-docker run --rm --user root --name ${HOLADO_DOCKER_CONTROLLER_NAME} \
-    --privileged -v $(docker info | grep -i rootless > /dev/null && 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_DOCKER_CONTROLLER_PORT=${HOLADO_DOCKER_CONTROLLER_PORT} \
-    ${NETWORK_DEF_COMMAND} \
-    -p ${HOLADO_DOCKER_CONTROLLER_PORT}:${HOLADO_DOCKER_CONTROLLER_PORT} \
-    ${CONTROLLER_IMAGE}
-

holado_docker/tools/docker_viewer/client/rest/docker_viewer_client.py

@@ -1,40 +0,0 @@
-
-#################################################
-# 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
-
-logger = logging.getLogger(__name__)
-
-
-class DockerViewerClient(RestClient):
-    
-    def __init__(self, name, url, headers=None):
-        super().__init__(name, url, headers)
-    
-    def get_containers_status(self, all_=False):
-        if all_:
-            response = self.get("container?all=true")
-        else:
-            response = self.get("container")
-        return self.response_result(response, status_ok=[200,204])
-    
-    def get_container_info(self, name, all_=False):
-        if all_:
-            response = self.get(f"container/{name}?all=true")
-        else:
-            response = self.get(f"container/{name}")
-        return self.response_result(response, status_ok=[200,204])
-    
-    
-    

holado_docker/tools/docker_viewer/docker_viewer_manager.py

@@ -1,44 +0,0 @@
-
-#################################################
-# 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_core.common.tools.converters.converter import Converter
-import os
-from holado_rest.api.rest.rest_manager import RestManager
-from holado_docker.tools.docker_viewer.client.rest.docker_viewer_client import DockerViewerClient
-
-logger = logging.getLogger(__name__)
-
-
-class DockerViewerManager(object):
-    
-    @classmethod
-    def new_client(cls, **kwargs):
-        if 'name' not in kwargs:
-            kwargs['name'] = None
-        if 'url' not in kwargs:
-            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_VIEWER_NAME", "holado_docker_viewer")
-            port = os.getenv("HOLADO_DOCKER_VIEWER_PORT", 8000)
-            kwargs['url'] = f"http://{host}:{port}"
-        
-        manager = RestManager(default_client_class=DockerViewerClient)
-        res = manager.new_client(**kwargs)
-        
-        return res
-        
-        
-        
-        

holado_docker/tools/docker_viewer/server/Dockerfile

@@ -1,70 +0,0 @@
-### 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/docker_viewer/requirements.txt
-WORKDIR /code/docker_viewer
-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 viewer sources
-COPY --chown=appuser ./rest /code/docker_viewer
-
-# Activate permanently python venv
-ENV PATH=/code/env/bin:$PATH
-
-WORKDIR /code/docker_viewer
-CMD ["sh", "-c", "uvicorn run:app --host 0.0.0.0 --port $HOLADO_DOCKER_VIEWER_PORT"]
-

holado_docker/tools/docker_viewer/server/requirements.txt

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

holado_docker/tools/docker_viewer/server/rest/README

@@ -1,2 +0,0 @@
-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_docker/tools/docker_viewer/server/rest/api/__init__.py

@@ -1,40 +0,0 @@
-#################################################
-# 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