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

holado_tools/tools/host_controller/server/grpc/proto/definitions/docker_controler.proto

@@ -0,0 +1,63 @@
+syntax = "proto3";
+
+package docker_controler;
+
+
+// DockerControlerService represents the querying service provided by docker controler.
+service DockerControlerService {
+    // Get all container names.
+    rpc GetAllContainerNames(GetAllContainerNamesRequest) returns (GetAllContainerNamesResponse) {};
+
+    // Start a container.
+    rpc StartContainer(StartContainerRequest) returns (StartContainerResponse) {};
+
+    // Stop a container.
+    rpc StopContainer(StopContainerRequest) returns (StopContainerResponse) {};
+
+    // Restart a container.
+    rpc RestartContainer(RestartContainerRequest) returns (RestartContainerResponse) {};
+}
+
+
+// Request and Response of DockerControlerService.GetAllContainerNames.
+message GetAllContainerNamesRequest {
+}
+
+message GetAllContainerNamesResponse {
+    // List of names of containers existing on server.
+    repeated string container_names = 1;
+}
+
+// Request and Response of DockerControlerService.StartContainer.
+message StartContainerRequest {
+    // Container name.
+    string name = 1;
+}
+
+message StartContainerResponse {
+    // Container status after request
+    string container_status = 1;
+}
+
+// Request and Response of DockerControlerService.StopContainer.
+message StopContainerRequest {
+    // Container name.
+    string name = 1;
+}
+
+message StopContainerResponse {
+    // Container status after request
+    string container_status = 1;
+}
+
+// Request and Response of DockerControlerService.RestartContainer.
+message RestartContainerRequest {
+    // Container name.
+    string name = 1;
+}
+
+message RestartContainerResponse {
+    // Container status after request
+    string container_status = 1;
+}
+

holado_tools/tools/host_controller/server/requirements.txt

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

holado_tools/tools/host_controller/server/rest/README

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

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

@@ -0,0 +1,24 @@
+#################################################
+# HolAdo (Holistic Automation do)
+#
+# (C) Copyright 2021-2025 by Eric Klumpp
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+# The Software is provided “as is”, without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the Software.
+#################################################
+
+# from flask.views import MethodView
+# 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_controller/server/rest/api/config.py

@@ -0,0 +1,57 @@
+#################################################
+# HolAdo (Holistic Automation do)
+#
+# (C) Copyright 2021-2025 by Eric Klumpp
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+# The Software is provided “as is”, without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the Software.
+#################################################
+
+from flask.views import MethodView
+from holado.common.context.session_context import SessionContext
+from holado_yaml.yaml.yaml_manager import YAMLManager
+
+def _get_session_context():
+    return SessionContext.instance()
+
+
+class YamlFileView(MethodView):
+    
+    def get(self, body: dict):
+        file_path = body['file_path']
+        
+        with open(file_path, 'rt') as fin:
+            res = fin.read()
+        
+        return res
+
+    def patch(self, body: dict):
+        file_path = body['file_path']
+        yaml_string = body['yaml_string']
+        with_backup = body['with_backup']
+        backup_extension = body['backup_extension']
+        
+        data = YAMLManager.load_string(yaml_string)
+        res = YAMLManager.update_file(file_path, data, with_backup=with_backup, backup_extension=backup_extension)
+        
+        return res
+
+    def put(self, body: list):
+        action = body['action']
+        file_path = body['file_path']
+        backup_extension = body['backup_extension']
+        
+        if action == 'restore':
+            res = YAMLManager.restore_file(file_path, backup_extension=backup_extension)
+        else:
+            return f"Unmanaged action '{action}'", 400
+            
+        return res
+
+
+
+
+

holado_tools/tools/host_controller/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

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

@@ -0,0 +1,55 @@
+#################################################
+# 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
+
+def _get_session_context():
+    return SessionContext.instance()
+
+
+class RestartView(MethodView):
+    
+    def put(self, name, body: dict):
+        if not _get_session_context().docker_client.has_container(name):
+            return f"Container '{name}' doesn't exist", 410
+        
+        res = _get_session_context().docker_client.restart_container(name, wait_running=False)
+        return res
+
+class StartView(MethodView):
+    
+    def put(self, name, body: dict):
+        if not _get_session_context().docker_client.has_container(name, all_=True):
+            return f"Container '{name}' doesn't exist", 410
+        
+        res = _get_session_context().docker_client.start_container(name, wait_running=False)
+        return res
+
+class StopView(MethodView):
+    
+    def put(self, name, body: dict):
+        if not _get_session_context().docker_client.has_container(name):
+            return f"Container '{name}' doesn't exist", 410
+        
+        res = _get_session_context().docker_client.stop_container(name)
+        return res
+
+class WaitView(MethodView):
+    
+    def put(self, name, body: dict):
+        if not _get_session_context().docker_client.has_container(name):
+            return f"Container '{name}' doesn't exist", 410
+        
+        res = _get_session_context().docker_client.get_container(name).wait()
+        return res
+    

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

@@ -0,0 +1,47 @@
+#################################################
+# 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_tools/tools/host_controller/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_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)