holado 0.13.22__py3-none-any.whl

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

@@ -0,0 +1,561 @@
+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:
+  /health:
+    get:
+      description: "Healthcheck"
+      responses:
+        200:
+          description: "Healthy"
+          content:
+            application/json:
+              schema:
+                type: "string"
+  
+  /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}/status:
+    get:
+      description: "Get container status"
+      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 status"
+          content:
+            application/json:
+              schema:
+                type: "string"
+
+  /docker/container/{name}/health_status:
+    get:
+      description: "Get container health status"
+      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 health status"
+          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"
+        - in: "query"
+          name: "wait_started"
+          description: "if set to 'true', await container is started (health status 'healthy' if healthcheck exists, else status 'running')"
+          schema:
+            type: "boolean"
+            default: true
+        - in: "query"
+          name: "timeout"
+          description: "Timeout in seconds (if not set, a default timeout is used)"
+          schema:
+            type: "integer"
+      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"
+        - in: "query"
+          name: "wait_started"
+          description: "if set to 'true', await container is started (health status 'healthy' if healthcheck exists, else status 'running')"
+          schema:
+            type: "boolean"
+            default: true
+        - in: "query"
+          name: "timeout"
+          description: "Timeout in seconds (if not set, a default timeout is used)"
+          schema:
+            type: "integer"
+      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"
+        - in: "query"
+          name: "wait_stopped"
+          description: "if set to 'true', await container is stopped"
+          schema:
+            type: "boolean"
+            default: true
+        - in: "query"
+          name: "timeout"
+          description: "Timeout in seconds (if not set, a default timeout is used)"
+          schema:
+            type: "integer"
+      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"
+        - in: "query"
+          name: "timeout"
+          description: "Timeout in seconds (if not set, a default timeout is used)"
+          schema:
+            type: "integer"
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: "object"
+              nullable: true
+      responses:
+        200:
+          description: ""
+          content:
+            application/json:
+              schema:
+                type: "string"
+
+  /docker/container/{name}/await_started:
+    put:
+      description: "Wait until a container is started ('healthy' if container has healthcheck else 'running')"
+      parameters:
+        - in: "path"
+          name: "name"
+          description: "Container name"
+          required: true
+          schema:
+            type: "string"
+        - in: "query"
+          name: "timeout"
+          description: "Timeout in seconds (if not set, a default timeout is used)"
+          schema:
+            type: "integer"
+      responses:
+        200:
+          description: ""
+          content:
+            application/json:
+              schema:
+                type: "string"
+
+  /docker/container/{name}/await_status:
+    put:
+      description: "Wait until a container has given status"
+      parameters:
+        - in: "path"
+          name: "name"
+          description: "Container name"
+          required: true
+          schema:
+            type: "string"
+        - in: "query"
+          name: "status"
+          description: "Status to wait (possible status: created, restarting, running, removing, paused, exited, dead, removed)"
+          schema:
+            type: "string"
+            default: "running"
+        - in: "query"
+          name: "timeout"
+          description: "Timeout in seconds (if not set, a default timeout is used)"
+          schema:
+            type: "integer"
+      responses:
+        200:
+          description: ""
+          content:
+            application/json:
+              schema:
+                type: "string"
+
+  /docker/container/{name}/await_health_status:
+    put:
+      description: "Wait until a container has given health status"
+      parameters:
+        - in: "path"
+          name: "name"
+          description: "Container name"
+          required: true
+          schema:
+            type: "string"
+        - in: "query"
+          name: "status"
+          description: "Health status to wait (possible status: starting, healthy, unhealthy, removed)"
+          schema:
+            type: "string"
+            default: "healthy"
+        - in: "query"
+          name: "timeout"
+          description: "Timeout in seconds (if not set, a default timeout is used)"
+          schema:
+            type: "integer"
+      responses:
+        200:
+          description: ""
+          content:
+            application/json:
+              schema:
+                type: "string"
+
+  /docker/logs/{name}:
+    get:
+      description: "get logs of a container"
+      parameters:
+        - in: "path"
+          name: "name"
+          description: "Container name"
+          required: true
+          schema:
+            type: "string"
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: "object"
+              properties:
+                with_timestamps:
+                  description: "If log timestamps are added"
+                  type: "boolean"
+                  default: true
+                since:
+                  description: "Since which datetime save logs"
+                  type: "string"
+                  nullable: true
+                until:
+                  description: "Until which datetime save logs"
+                  type: "string"
+                  nullable: true
+      responses:
+        200:
+          description: "Container logs"
+          content:
+            application/json:
+              schema:
+                type: "array"
+                items:
+                  type: "string"
+  
+  /docker/logs/save:
+    put:
+      description: "Save logs of containers"
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: "object"
+              properties:
+                destination_path:
+                  description: "Destination path of log files"
+                  type: "string"
+                file_format:
+                  description: "Log file format (ex: 'CSV', 'JSON', 'PrettyTable') (default: JSON)"
+                  type: "string"
+                  nullable: true
+                container_include_patterns:
+                  description: "List of regex for container names to include"
+                  type: "array"
+                  items:
+                    type: "string"
+                  nullable: true
+                container_exclude_patterns:
+                  description: "List of regex for container names to exclude"
+                  type: "array"
+                  items:
+                    type: "string"
+                  nullable: true
+                with_timestamps:
+                  description: "If log timestamps are added"
+                  type: "boolean"
+                  default: true
+                timestamps_field_name:
+                  description: "Field name to use for timestamps (used only if with_timestamps is true or omitted)"
+                  type: "string"
+                  nullable: true
+                field_include_patterns:
+                  description: "Dictionary of (pattern, pattern_info), with pattern for field names to include, and pattern_info a dictionary for actions like 'replace' for a replace name"
+                  type: "object"
+                  nullable: true
+                field_exclude_patterns:
+                  description: "List of regex for field names to exclude (if not included)"
+                  type: "array"
+                  items:
+                    type: "string"
+                  nullable: true
+                field_include_others_name:
+                  description: "Field name used to surround other fields (i.e. not explicitly included or excluded) (used only if field_include_patterns is defined)"
+                  type: "string"
+                  nullable: true
+                since:
+                  description: "Since which datetime save logs"
+                  type: "string"
+                  nullable: true
+                until:
+                  description: "Until which datetime save logs"
+                  type: "string"
+                  nullable: true
+      responses:
+        200:
+          description: "Number of containers for which logs have been saved"
+          content:
+            application/json:
+              schema:
+                type: "integer"
+
+
+  /config/yaml_file:
+    get:
+      description: "Get content of a YAML file"
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: "object"
+              properties:
+                file_path:
+                  type: string
+                field_keys:
+                  description: "List of keys to the field"
+                  type: "array"
+                  items:
+                    type: "string"
+                  nullable: true
+      responses:
+        200:
+          description: ""
+          content:
+            application/json:
+              schema:
+                type: "object"
+    
+    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 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 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}
+