holado 0.6.2__py3-none-any.whl → 0.6.4__py3-none-any.whl

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

@@ -12,30 +12,29 @@
 
 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 post(self, body: dict):
-    #     pass
-    #
-    # def put(self, container_name, body: dict):
-    #     pass
-    #
-    # def delete(self, container_name):
-    #     pass
-    
-    def get(self, name=None, limit=100):
+    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):
-                return f"Container '{name}' doesn't exist", 406
+            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)
-            cont.container.reload()
-            res = cont.container.attrs
+            cont = _get_session_context().docker_client.get_container(name, all_=all_)
+            res = cont.information
         else:
-            names = _get_session_context().docker_client.get_all_container_names()
-            res = [{'name':n, 'status':_get_session_context().docker_client.get_container(n).status} for n in names]
+            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

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

@@ -12,10 +12,16 @@ paths:
   /container:
     get:
       description: "List containers and their status"
-      parameters: []
+      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: ""
+          description: "List of container names with their status"
           content:
             application/json:
               schema:
@@ -28,12 +34,19 @@ paths:
       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: ""
+          description: "Container information"
           content:
             application/json:
               schema:
@@ -44,6 +57,7 @@ paths:
       parameters:
         - in: "path"
           name: "name"
+          description: "Container name"
           required: true
           schema:
             type: "string"
@@ -66,6 +80,7 @@ paths:
       parameters:
         - in: "path"
           name: "name"
+          description: "Container name"
           required: true
           schema:
             type: "string"
@@ -88,6 +103,7 @@ paths:
       parameters:
         - in: "path"
           name: "name"
+          description: "Container name"
           required: true
           schema:
             type: "string"
@@ -110,6 +126,7 @@ paths:
       parameters:
         - in: "path"
           name: "name"
+          description: "Container name"
           required: true
           schema:
             type: "string"

holado_docker/tools/docker_controller/server/run_docker_controller_in_docker.sh

@@ -1,8 +1,8 @@
 #!/bin/bash
 
-# Script to launch Docker Controler as a docker image.
+# Script to launch Docker Controller as a docker image.
 # 
-# Docker Controler exposes a REST API for some docker commands.
+# 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).
 #
@@ -13,8 +13,8 @@
 #
 #     Optionally, define in .profile the following variables
 #         - HOLADO_DOCKER_CONTROLLER_PORT: REST API port to use (default: 8000)
-#         - HOLADO_IMAGE_REGISTRY: docker image registry to use (default: holado/docker_controler)
-#         - HOLADO_IMAGE_TAG: docker image tag to use (default: main)
+#         - 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.
@@ -24,10 +24,10 @@
 WORK_DIR="$(pwd)"
 
 if [[ -z "$HOLADO_IMAGE_REGISTRY" ]]; then
-    HOLADO_IMAGE_REGISTRY=holado/docker_controler
+    HOLADO_IMAGE_REGISTRY=holado/docker_controller
 fi
 if [[ -z "$HOLADO_IMAGE_TAG" ]]; then
-    HOLADO_IMAGE_TAG=main
+    HOLADO_IMAGE_TAG=latest
 fi
 CONTROLLER_IMAGE=${HOLADO_IMAGE_REGISTRY}:${HOLADO_IMAGE_TAG}
 

holado_docker/tools/docker_viewer/client/rest/docker_viewer_client.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 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

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

@@ -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/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

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

holado_docker/tools/docker_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_docker/tools/docker_viewer/server/rest/api/__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

holado_docker/tools/docker_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"))
+    
+

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

@@ -0,0 +1,58 @@
+openapi: "3.0.0"
+info:
+  version: "1"
+  title: "Docker Viewer API"
+  description: |
+    API to process some docker actions from anywhere on the network.
+    In a microservice architecture, the docker viewer can be run in a docker with special privileges,
+    whereas all other microservices have user privileges.
+    For example, it is usefull to monitor containers statuses from any terminal on the network.
+paths:
+  /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"
+components:
+  securitySchemes: {}
+  schemas:
+    DockerControler:
+      properties: {}
+

holado_docker/tools/docker_viewer/server/rest/run.py

@@ -0,0 +1,28 @@
+#################################################
+# 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_minimal
+initialize_minimal()
+
+
+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_viewer/server/run_docker_viewer_in_docker.sh

@@ -0,0 +1,101 @@
+#!/bin/bash
+
+# Script to launch Docker Viewer as a docker image.
+# 
+# Docker Viewer 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_VIEWER_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_VIEWER_PORT: REST API port to use (default: 8000)
+#         - HOLADO_IMAGE_REGISTRY: docker image registry to use (default: holado/docker_viewer)
+#         - 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_viewer
+fi
+if [[ -z "$HOLADO_IMAGE_TAG" ]]; then
+    HOLADO_IMAGE_TAG=latest
+fi
+VIEWER_IMAGE=${HOLADO_IMAGE_REGISTRY}:${HOLADO_IMAGE_TAG}
+
+# Update docker image
+echo "Updating docker image ${VIEWER_IMAGE}..."
+docker pull ${VIEWER_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_VIEWER_PORT" ]]; then
+    HOLADO_DOCKER_VIEWER_PORT=8000
+fi
+
+
+# Docker run 
+if [[ -z "$HOLADO_DOCKER_VIEWER_NAME" ]]; then
+    HOLADO_DOCKER_VIEWER_NAME=holado_docker_VIEWER
+fi
+
+echo
+echo "Running Docker VIEWER (docker name: ${HOLADO_DOCKER_VIEWER_NAME})..."
+echo "    port: ${HOLADO_DOCKER_VIEWER_PORT}"
+#echo "    NETWORK_DEF_COMMAND=${NETWORK_DEF_COMMAND}"
+echo
+docker run --rm --user root --name ${HOLADO_DOCKER_VIEWER_NAME} \
+    --privileged -v /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_VIEWER_PORT=${HOLADO_DOCKER_VIEWER_PORT} \
+    ${NETWORK_DEF_COMMAND} \
+    -p ${HOLADO_DOCKER_VIEWER_PORT}:${HOLADO_DOCKER_VIEWER_PORT} \
+    ${VIEWER_IMAGE}
+