oak-cli 0.2.8__tar.gz → 0.2.9__tar.gz

{oak_cli-0.2.8 → oak_cli-0.2.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: oak_cli
-Version: 0.2.8
+Version: 0.2.9
 Summary: 
 Author: Alexander Malyuk
 Author-email: malyuk.alexander1999@gmail.com
@@ -11,6 +11,7 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Requires-Dist: argcomplete (>=3.2.3,<4.0.0)
 Requires-Dist: icecream (>=2.1.3,<3.0.0)
+Requires-Dist: pydantic (>=2.6.4,<3.0.0)
 Description-Content-Type: text/markdown
 
 # [Oakestra CLI](https://github.com/oakestra/oakestra-cli)

{oak_cli-0.2.8 → oak_cli-0.2.9}/oak_cli/args_parser/apps/delete.py

@@ -15,7 +15,7 @@ def prepare_applications_deletion_argparser(
     applications_subparsers: Subparsers,
 ) -> None:
     def aux_delete_applications(args: Any):
-        if args.all:
+        if args.all or not args.app_id:
             delete_all_applications()
         else:
             delete_application(args.app_id)

oak_cli-0.2.9/oak_cli/args_parser/docker/main.py

@@ -0,0 +1,25 @@
+import argparse
+from typing import Any
+
+from oak_cli.args_parser.docker.rebuild import prepare_docker_rebuild_argparser
+from oak_cli.utils.types import Subparsers
+
+
+def prepare_docker_argparsers(subparsers: Subparsers) -> None:
+    docker_parser = subparsers.add_parser(
+        "docker",
+        aliases=["d"],
+        help="command for docker(compose) related activities",
+        formatter_class=argparse.RawTextHelpFormatter,
+    )
+
+    def docker_parser_print_help(_: Any) -> None:
+        docker_parser.print_help()
+
+    docker_parser.set_defaults(func=docker_parser_print_help)
+
+    docker_subparsers = docker_parser.add_subparsers(
+        dest="services commands",
+    )
+
+    prepare_docker_rebuild_argparser(docker_subparsers)

oak_cli-0.2.9/oak_cli/args_parser/docker/rebuild.py

@@ -0,0 +1,66 @@
+import argparse
+from typing import Any
+
+from oak_cli.commands.docker.enums import ClusterOrchestratorService, RootOrchestratorService
+from oak_cli.commands.docker.rebuild import rebuild_docker_service
+from oak_cli.commands.docker.restart import restart_docker_service
+from oak_cli.utils.types import Subparsers
+
+
+def aux_rebuild_docker_service(args: Any):
+    if args.only_restart:
+        restart_docker_service(args.service)
+    else:
+        rebuild_docker_service(args.service)
+
+
+def prepare_docker_rebuild_root_orchestrator_service_parser(
+    docker_rebuild_subparser: Subparsers,
+) -> None:
+    docker_rebuild_root_orchestrator_service_parser = docker_rebuild_subparser.add_parser(
+        "root_orchestrator",
+        aliases=["ro"],
+    )
+    docker_rebuild_root_orchestrator_service_parser.add_argument(
+        "service",
+        help="testing",
+        type=RootOrchestratorService,
+        choices=RootOrchestratorService,
+    )
+    docker_rebuild_root_orchestrator_service_parser.set_defaults(func=aux_rebuild_docker_service)
+
+
+def prepare_docker_rebuild_cluster_orchestrator_service_parser(
+    docker_rebuild_subparser: Subparsers,
+) -> None:
+    docker_rebuild_cluster_orchestrator_service_parser = docker_rebuild_subparser.add_parser(
+        "cluster_orchestrator",
+        aliases=["co"],
+    )
+    docker_rebuild_cluster_orchestrator_service_parser.add_argument(
+        "service",
+        help="testing",
+        type=ClusterOrchestratorService,
+        choices=ClusterOrchestratorService,
+    )
+    docker_rebuild_cluster_orchestrator_service_parser.set_defaults(func=aux_rebuild_docker_service)
+
+
+def prepare_docker_rebuild_argparser(docker_subparsers: Subparsers) -> None:
+    HELP_TEXT = "rebuilds a docker compose service"
+    docker_restart_parser = docker_subparsers.add_parser(
+        "rebuilds",
+        aliases=["r"],
+        help=HELP_TEXT,
+        description=HELP_TEXT,
+        formatter_class=argparse.RawTextHelpFormatter,
+    )
+    docker_restart_parser.add_argument(
+        "-o",
+        "--only-restart",
+        help="only restart without rebuilding the service",
+        action="store_true",
+    )
+    docker_restart_subparsers = docker_restart_parser.add_subparsers()
+    prepare_docker_rebuild_root_orchestrator_service_parser(docker_restart_subparsers)
+    prepare_docker_rebuild_cluster_orchestrator_service_parser(docker_restart_subparsers)

{oak_cli-0.2.8 → oak_cli-0.2.9}/oak_cli/args_parser/main.py

@@ -23,7 +23,7 @@ def parse_arguments_and_execute() -> None:
     prepare_applications_argparsers(subparsers)
     prepare_services_argparsers(subparsers)
     prepare_plugins_argparsers(subparsers)
-    #    prepare_docker_argparsers(subparsers)
+    # prepare_docker_argparsers(subparsers) # WIP
 
     argcomplete.autocomplete(parser)
     args = parser.parse_args()

{oak_cli-0.2.8 → oak_cli-0.2.9}/oak_cli/args_parser/plugins/flops/create.py

@@ -5,7 +5,7 @@ from oak_cli.utils.types import Subparsers
 
 
 def prepare_flops_create_argparser(flops_subparser: Subparsers) -> None:
-    HELP_TEXT = "creates a new FLOps process - i.e. triggers the init FLOps API"
+    HELP_TEXT = "creates a new FLOps project - i.e. triggers the init FLOps API"
     flops_create_parser = flops_subparser.add_parser(
         "create",
         aliases=["c"],

{oak_cli-0.2.8 → oak_cli-0.2.9}/oak_cli/commands/apps/main.py

@@ -5,6 +5,7 @@ from typing import List
 import oak_cli.utils.api.custom_requests as custom_requests
 from oak_cli.utils.api.common import SYSTEM_MANAGER_URL
 from oak_cli.utils.api.custom_http import HttpMethod
+from oak_cli.utils.exceptions.types import OakCLIExceptionTypes
 from oak_cli.utils.logging import logger
 from oak_cli.utils.SLAs.common import get_SLAs_path
 from oak_cli.utils.types import Application, ApplicationId
@@ -18,6 +19,7 @@ def get_application(app_id: ApplicationId) -> Application:
         ),
         custom_requests.RequestAuxiliaries(
             what_should_happen=f"Get application '{app_id}'",
+            oak_cli_exception_type=OakCLIExceptionTypes.APP_GET,
         ),
     ).execute()
 
@@ -30,6 +32,7 @@ def get_applications() -> List[Application]:
         ),
         custom_requests.RequestAuxiliaries(
             what_should_happen="Get all applications",
+            oak_cli_exception_type=OakCLIExceptionTypes.APP_GET,
         ),
     ).execute()
     if not apps:
@@ -55,6 +58,7 @@ def send_sla(sla_enum: enum) -> List[Application]:
         custom_requests.RequestAuxiliaries(
             what_should_happen=f"Create new application based on '{sla_enum}'",
             show_msg_on_success=True,
+            oak_cli_exception_type=OakCLIExceptionTypes.APP_CREATE,
         ),
     ).execute()
 
@@ -72,6 +76,7 @@ def delete_application(app_id: ApplicationId) -> None:
         custom_requests.RequestAuxiliaries(
             what_should_happen=f"Delete application '{app_id}'",
             show_msg_on_success=True,
+            oak_cli_exception_type=OakCLIExceptionTypes.APP_DELETE,
         ),
     ).execute()
 

oak_cli-0.2.9/oak_cli/commands/docker/aux_dockers/node_engine_log_observer.docker-compose.yml

@@ -0,0 +1,18 @@
+version: "3.3"
+
+services:
+
+  node_engine_log_observer:
+    image: node_engine_log_observer
+    build:
+      context: .
+      dockerfile_inline: |
+        FROM alpine
+        CMD tail -f node_engine_logs
+    hostname: node_engine_log_observer
+    container_name: node_engine_log_observer
+    volumes:
+      - /tmp/node_engine_logs:/node_engine_logs
+
+volumes:
+  node_engine_logs:

oak_cli-0.2.9/oak_cli/commands/docker/common.py

@@ -0,0 +1,29 @@
+import json
+import shlex
+import subprocess
+
+from oak_cli.commands.docker.enums import OakestraDockerComposeService
+from oak_cli.utils.logging import logger
+
+
+def check_docker_service_status(
+    docker_service: OakestraDockerComposeService, docker_operation: str
+):
+    inspect_cmd = 'docker inspect -f "{{ json .State }}" ' + str(docker_service)
+    result = subprocess.run(
+        shlex.split(inspect_cmd),
+        check=True,
+        stderr=subprocess.PIPE,
+        stdout=subprocess.PIPE,
+        text=True,
+    )
+    result_output = json.loads(result.stdout)
+    service_status = result_output["Status"]
+    if service_status == "running":
+        logger.info(
+            f"'{docker_service}' successfully '{docker_operation}' - status: '{service_status}'"
+        )
+    else:
+        logger.error(
+            f"'{docker_service}' failed to '{docker_operation}' - status: '{service_status}'"
+        )

oak_cli-0.2.9/oak_cli/commands/docker/enums.py

@@ -0,0 +1,30 @@
+from enum import EnumMeta
+
+from oak_cli.utils.types import CustomEnum
+
+
+class OakestraDockerComposeService(CustomEnum, metaclass=EnumMeta):
+    pass
+
+
+class RootOrchestratorService(OakestraDockerComposeService):
+    SYSTEM_MANAGER = "system_manager"
+    MONGO_ROOT = "mongo_root"
+    MONGO_ROOTNET = "mongo_rootnet"
+    ROOT_SERVICE_MANAGER = "root_service_manager"
+    REDIS = "redis"
+    GRAFANA = "grafana"
+    DASHBOARD = "dashboard"
+    CLOUD_SCHEDULER = "cloud_scheduler"
+    RESOURCE_ABSTRACTOR = "resource_abstractor"
+
+
+class ClusterOrchestratorService(OakestraDockerComposeService):
+    MQTT = "mqtt"
+    MONGO_CLUSTER = "mongo_cluster"
+    MONGO_CLUSTERNET = "mongo_clusternet"
+    CLUSTER_SERVICE_MANAGER = "cluster_service_manager"
+    CLUSTER_MANAGER = "cluster_manager"
+    CLUSTER_SCHEDULER = "cluster_scheduler"
+    CLUSTER_REDIS = "cluster_redis"
+    PROMETHEUS = "prometheus"

oak_cli-0.2.9/oak_cli/commands/docker/rebuild.py

@@ -0,0 +1,38 @@
+import pathlib
+import shlex
+import subprocess
+import sys
+
+from oak_cli.commands.docker.common import check_docker_service_status
+from oak_cli.commands.docker.enums import OakestraDockerComposeService, RootOrchestratorService
+from oak_cli.utils.logging import logger
+
+ROOT_ORCHESTRATOR_DOCKER_COMPOSE_FILE_PATH = pathlib.Path(
+    "/home/alex/oakestra/root_orchestrator/docker-compose.yml"
+)
+CLUSTER_ORCHESTRATOR_DOCKER_COMPOSE_FILE_PATH = pathlib.Path(
+    "/home/alex/oakestra/cluster_orchestrator/docker-compose.yml"
+)
+
+
+def rebuild_docker_service(docker_service: OakestraDockerComposeService) -> None:
+    rebuild_flags = "-d --build --no-deps --force-recreate"
+    if isinstance(docker_service, RootOrchestratorService):
+        compose_path = ROOT_ORCHESTRATOR_DOCKER_COMPOSE_FILE_PATH
+    else:
+        compose_path = CLUSTER_ORCHESTRATOR_DOCKER_COMPOSE_FILE_PATH
+
+    final_cmd = f"docker compose -f {compose_path} up {rebuild_flags} {docker_service}"
+
+    result = subprocess.run(
+        shlex.split(final_cmd),
+        check=False,
+        stderr=subprocess.PIPE,
+        stdout=subprocess.PIPE,
+        text=True,
+    )
+    if result.returncode != 0:
+        logger.critical(f"Docker service '{docker_service}' rebuild failed due to: '{result}")
+        sys.exit(1)
+
+    check_docker_service_status(docker_service, "rebuild")

oak_cli-0.2.9/oak_cli/commands/docker/restart.py

@@ -0,0 +1,17 @@
+import shlex
+import subprocess
+
+from oak_cli.commands.docker.common import check_docker_service_status
+from oak_cli.commands.docker.enums import OakestraDockerComposeService
+
+
+def restart_docker_service(docker_service: OakestraDockerComposeService) -> None:
+    docker_cmd = f"docker restart {docker_service}"
+    subprocess.run(
+        shlex.split(docker_cmd),
+        check=True,
+        stderr=subprocess.PIPE,
+        stdout=subprocess.PIPE,
+        text=True,
+    )
+    check_docker_service_status(docker_service, "restarted")

{oak_cli-0.2.8 → oak_cli-0.2.9}/oak_cli/commands/plugins/flops/main.py

@@ -4,6 +4,7 @@ import pathlib
 
 import oak_cli.utils.api.custom_requests as custom_requests
 from oak_cli.utils.api.custom_http import HttpMethod
+from oak_cli.utils.exceptions.types import OakCLIExceptionTypes
 
 ROOT_FL_MANAGER_URL = f"http://{os.environ.get('SYSTEM_MANAGER_URL')}:5072"
 
@@ -23,7 +24,8 @@ def create_new_fl_service() -> None:
             data=SLA,
         ),
         custom_requests.RequestAuxiliaries(
-            what_should_happen="Init new FLOps processes",
+            what_should_happen="Init new FLOps project",
             show_msg_on_success=True,
+            oak_cli_exception_type=OakCLIExceptionTypes.FLOPS_PLUGIN,
         ),
     ).execute()

{oak_cli-0.2.8 → oak_cli-0.2.9}/oak_cli/commands/services/deployment.py

@@ -2,6 +2,7 @@ import oak_cli.utils.api.custom_requests as custom_requests
 from oak_cli.commands.services.get import get_single_service
 from oak_cli.utils.api.common import SYSTEM_MANAGER_URL
 from oak_cli.utils.api.custom_http import HttpMethod
+from oak_cli.utils.exceptions.types import OakCLIExceptionTypes
 from oak_cli.utils.types import Id, ServiceId
 
 
@@ -15,6 +16,7 @@ def deploy_new_instance(service_id: ServiceId) -> None:
         custom_requests.RequestAuxiliaries(
             what_should_happen=f"Deploy a new instance for the service '{service_id}'",
             show_msg_on_success=True,
+            oak_cli_exception_type=OakCLIExceptionTypes.SERVICE_DEPLOYMENT,
         ),
     ).execute()
 
@@ -29,6 +31,7 @@ def undeploy_instance(service_id: ServiceId, instance_id: Id = None) -> None:
         custom_requests.RequestAuxiliaries(
             what_should_happen=f"Undeploy instance '{instance_id or 0}' for service '{service_id}'",
             show_msg_on_success=True,
+            oak_cli_exception_type=OakCLIExceptionTypes.SERVICE_UNDEPLOYMENT,
         ),
     ).execute()
 

{oak_cli-0.2.8 → oak_cli-0.2.9}/oak_cli/commands/services/get.py

@@ -2,6 +2,7 @@ from typing import List
 
 import oak_cli.utils.api.custom_requests as custom_requests
 from oak_cli.utils.api.common import SYSTEM_MANAGER_URL
+from oak_cli.utils.exceptions.types import OakCLIExceptionTypes
 from oak_cli.utils.logging import logger
 from oak_cli.utils.types import Service, ServiceId
 
@@ -14,6 +15,7 @@ def get_single_service(service_id: ServiceId) -> Service:
         ),
         custom_requests.RequestAuxiliaries(
             what_should_happen=f"Get single service '{service_id}'",
+            oak_cli_exception_type=OakCLIExceptionTypes.SERVICE_GET,
         ),
     ).execute()
 
@@ -30,6 +32,7 @@ def get_all_services(app_id: ServiceId = None) -> List[Service]:
         ),
         custom_requests.RequestAuxiliaries(
             what_should_happen=what_should_happen,
+            oak_cli_exception_type=OakCLIExceptionTypes.SERVICE_GET,
         ),
     ).execute()
 

{oak_cli-0.2.8 → oak_cli-0.2.9}/oak_cli/main.py

@@ -3,7 +3,7 @@
 
 from oak_cli.args_parser.main import parse_arguments_and_execute
 from oak_cli.utils.argcomplete import handle_argcomplete
-from oak_cli.utils.exceptions import OakCliException
+from oak_cli.utils.exceptions.main import OakCLIException
 from oak_cli.utils.logging import logger
 
 
@@ -17,8 +17,8 @@ def main():
 
     try:
         parse_arguments_and_execute()
-    except OakCliException as e:
-        logger.fatal(f"{e.msg}, {e.http_status}")
+    except OakCLIException as e:
+        logger.fatal(f"{e.message}, {e.http_status}")
     except Exception as e:
         err_msg = f"Unexpected error occured: {e}"
         logger.fatal(err_msg)

{oak_cli-0.2.8 → oak_cli-0.2.9}/oak_cli/utils/SLAs/default_app_with_services.SLA.json

@@ -45,7 +45,7 @@
                     "storage": 0,
                     "code": "docker.io/library/nginx:latest",
                     "state": "",
-                    "port": "6080:60/tcp",
+                    "port": "6080:80/tcp",
                     "addresses": {
                         "rr_ip": "10.30.30.30"
                     },

{oak_cli-0.2.8 → oak_cli-0.2.9}/oak_cli/utils/api/custom_requests.py

@@ -1,4 +1,5 @@
 import json
+from dataclasses import dataclass, field
 from http import HTTPStatus
 from typing import NamedTuple
 
@@ -6,7 +7,8 @@ import requests
 
 from oak_cli.utils.api.custom_http import HttpMethod
 from oak_cli.utils.api.login import get_login_token
-from oak_cli.utils.exceptions import OakCliException
+from oak_cli.utils.exceptions.main import OakCLIException
+from oak_cli.utils.exceptions.types import OakCLIExceptionTypes
 from oak_cli.utils.logging import logger
 
 
@@ -21,19 +23,23 @@ class RequestCore(NamedTuple):
 
 class RequestAuxiliaries(NamedTuple):
     what_should_happen: str
-    exception: OakCliException = OakCliException
+    oak_cli_exception_type: OakCLIExceptionTypes
     show_msg_on_success: bool = False
     is_oakestra_api: bool = True
 
 
+# Note: The use of Pydantic here leads to strange validation errors.
+@dataclass
 class CustomRequest:
-    def __init__(self, core: RequestCore, aux: RequestAuxiliaries):
-        self.core = core
-        self.aux = aux
-        self.headers = None
-        self.url = None
-        self.args = None
-        self.response = None
+    core: RequestCore
+    aux: RequestAuxiliaries
+
+    headers: dict = field(default=None, init=False)
+    url: str = field(default=None, init=False)
+    args: dict = field(default=None, init=False)
+    response: requests.Response = field(default=None, init=False)
+
+    def __post_init__(self):
         self._prepare()
 
     def _prepare(self) -> None:
@@ -88,7 +94,9 @@ class CustomRequest:
 
         error_msg += self._create_failure_msg()
 
-        raise self.aux.exception(
-            msg=error_msg,
+        raise OakCLIException(
+            flops_exception_type=self.aux.flops_exception_type,
+            text=error_msg,
             http_status=self.response.status if self.response else None,
+            flops_project_id=self.aux.flops_project_id,
         )

{oak_cli-0.2.8 → oak_cli-0.2.9}/oak_cli/utils/api/login.py

@@ -1,7 +1,7 @@
 import oak_cli.utils.api.custom_requests as custom_requests
 from oak_cli.utils.api.common import SYSTEM_MANAGER_URL
 from oak_cli.utils.api.custom_http import HttpMethod
-from oak_cli.utils.exceptions import LoginException
+from oak_cli.utils.exceptions.types import OakCLIExceptionTypes
 
 _login_token = ""
 
@@ -21,7 +21,7 @@ def _login_and_set_token() -> str:
         ),
         custom_requests.RequestAuxiliaries(
             what_should_happen="Login",
-            exception=LoginException,
+            oak_cli_exception_type=OakCLIExceptionTypes.LOGIN,
         ),
     ).execute()
 

oak_cli-0.2.9/oak_cli/utils/exceptions/main.py

@@ -0,0 +1,17 @@
+from dataclasses import dataclass, field
+from http import HTTPStatus
+
+from oak_cli.utils.exceptions.types import OakCLIExceptionTypes
+
+
+# Note: Pydantic.BaseModel and Exception do not seem to work well if inherited together.
+@dataclass
+class OakCLIException(Exception):
+    oak_cli_exception_type: OakCLIExceptionTypes
+    text: str
+    http_status: HTTPStatus = None
+
+    message: str = field(init=False)
+
+    def model_post_init(self, _) -> None:
+        self.message = f"'{self.oak_cli_exception_type}' exception occured: {self.text}"

oak_cli-0.2.9/oak_cli/utils/exceptions/types.py

@@ -0,0 +1,12 @@
+from oak_cli.utils.types import CustomEnum
+
+
+class OakCLIExceptionTypes(CustomEnum):
+    LOGIN = "Login"
+    APP_CREATE = "Application Creation"
+    APP_DELETE = "Application Deletion"
+    APP_GET = "GET Application"
+    SERVICE_GET = "GET Service"
+    SERVICE_DEPLOYMENT = "Deploying Service"
+    SERVICE_UNDEPLOYMENT = "Undeploying Service"
+    FLOPS_PLUGIN = "FLOps Plugin"

{oak_cli-0.2.8 → oak_cli-0.2.9}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "oak_cli"
-version = "0.2.8"
+version = "0.2.9"
 description = ""
 authors = ["Alexander Malyuk <malyuk.alexander1999@gmail.com>"]
 readme = "README.md"
@@ -8,6 +8,7 @@ readme = "README.md"
 [tool.poetry.dependencies]
 python = "^3.10"
 argcomplete = "^3.2.3"
+pydantic = "^2.6.4"
 icecream = "^2.1.3"
 
 [build-system]