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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: oak_cli
-Version: 0.2.6
+Version: 0.2.8
 Summary: 
 Author: Alexander Malyuk
 Author-email: malyuk.alexander1999@gmail.com
@@ -10,20 +10,21 @@ Classifier: Programming Language :: Python :: 3.10
 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)
 Description-Content-Type: text/markdown
 
 # [Oakestra CLI](https://github.com/oakestra/oakestra-cli)
 
 **oakestra-cli** is a very basic command line tool for controlling your [Oakestra](https://github.com/oakestra/oakestra) setup. 
 
-It is intended to be a interface for the API as well as a development tool.
+It is intended to be an interface for the API as well as a development tool.
 
 The CLI supports command (tab) autocompletion.
 
 ## Usage
 The package can be called via `oak`.
 
-Currently it supports the creation, deletion, inspection, and (un)deployment of applications and services.
+Currently, it supports the creation, deletion, inspection, and (un)deployment of applications and services.
 
 E.g. To deploy a default application with two services:
 ```
@@ -81,7 +82,7 @@ All current services: '2'
    instances: '1'
 ```
 
-For a more detailed explanation have a try out the CLI and use the `-h` flag.
+For a more detailed explanation try out the CLI and use the `-h` flag.
 
 ## [Installation](https://pypi.org/project/oak-cli/)
 ```

{oak_cli-0.2.6 → oak_cli-0.2.8}/README.md

@@ -2,14 +2,14 @@
 
 **oakestra-cli** is a very basic command line tool for controlling your [Oakestra](https://github.com/oakestra/oakestra) setup. 
 
-It is intended to be a interface for the API as well as a development tool.
+It is intended to be an interface for the API as well as a development tool.
 
 The CLI supports command (tab) autocompletion.
 
 ## Usage
 The package can be called via `oak`.
 
-Currently it supports the creation, deletion, inspection, and (un)deployment of applications and services.
+Currently, it supports the creation, deletion, inspection, and (un)deployment of applications and services.
 
 E.g. To deploy a default application with two services:
 ```
@@ -67,7 +67,7 @@ All current services: '2'
    instances: '1'
 ```
 
-For a more detailed explanation have a try out the CLI and use the `-h` flag.
+For a more detailed explanation try out the CLI and use the `-h` flag.
 
 ## [Installation](https://pypi.org/project/oak-cli/)
 ```

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

@@ -14,7 +14,7 @@ _DELETION_HELP_TEXT = "deletes one or all applications" + _APP_ID_HELP_TEXT
 def prepare_applications_deletion_argparser(
     applications_subparsers: Subparsers,
 ) -> None:
-    def aux_delete_appliacations(args: Any):
+    def aux_delete_applications(args: Any):
         if args.all:
             delete_all_applications()
         else:
@@ -30,7 +30,5 @@ def prepare_applications_deletion_argparser(
     applications_deletion_parser.add_argument(
         "-a", "--all", action="store_true", help="delete all applications"
     )
-    applications_deletion_parser.add_argument(
-        "app_id", nargs="?", type=str, help=_APP_ID_HELP_TEXT
-    )
-    applications_deletion_parser.set_defaults(func=aux_delete_appliacations)
+    applications_deletion_parser.add_argument("app_id", nargs="?", type=str, help=_APP_ID_HELP_TEXT)
+    applications_deletion_parser.set_defaults(func=aux_delete_applications)

{oak_cli-0.2.6 → oak_cli-0.2.8}/oak_cli/args_parser/apps/status.py

@@ -13,6 +13,4 @@ def prepare_applications_display_argparser(applications_subparsers: Subparsers)
         description=HELP_TEXT,
         formatter_class=argparse.RawTextHelpFormatter,
     )
-    applications_status_parser.set_defaults(
-        func=lambda _: display_current_applications()
-    )
+    applications_status_parser.set_defaults(func=lambda _: display_current_applications())

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

@@ -5,6 +5,9 @@ import argparse
 import argcomplete
 
 from oak_cli.args_parser.apps.main import prepare_applications_argparsers
+
+# from oak_cli.args_parser.docker.main import prepare_docker_argparsers
+from oak_cli.args_parser.plugins.main import prepare_plugins_argparsers
 from oak_cli.args_parser.services.main import prepare_services_argparsers
 
 
@@ -19,6 +22,8 @@ def parse_arguments_and_execute() -> None:
 
     prepare_applications_argparsers(subparsers)
     prepare_services_argparsers(subparsers)
+    prepare_plugins_argparsers(subparsers)
+    #    prepare_docker_argparsers(subparsers)
 
     argcomplete.autocomplete(parser)
     args = parser.parse_args()

oak_cli-0.2.8/oak_cli/args_parser/plugins/flops/create.py

@@ -0,0 +1,16 @@
+import argparse
+
+from oak_cli.commands.plugins.flops.main import create_new_fl_service
+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"
+    flops_create_parser = flops_subparser.add_parser(
+        "create",
+        aliases=["c"],
+        help=HELP_TEXT,
+        description=HELP_TEXT,
+        formatter_class=argparse.RawTextHelpFormatter,
+    )
+    flops_create_parser.set_defaults(func=lambda _: create_new_fl_service())

oak_cli-0.2.8/oak_cli/args_parser/plugins/flops/main.py

@@ -0,0 +1,25 @@
+import argparse
+from typing import Any
+
+from oak_cli.args_parser.plugins.flops.create import prepare_flops_create_argparser
+from oak_cli.utils.types import Subparsers
+
+
+def prepare_flops_argparsers(subparsers: Subparsers) -> None:
+    flops_parser = subparsers.add_parser(
+        "flops",
+        aliases=["fl"],
+        help="command for FLOps related activities",
+        formatter_class=argparse.RawTextHelpFormatter,
+    )
+
+    def flops_parser_print_help(_: Any) -> None:
+        flops_parser.print_help()
+
+    flops_parser.set_defaults(func=flops_parser_print_help)
+
+    flops_subparser = flops_parser.add_subparsers(
+        dest="FLOps commands",
+    )
+
+    prepare_flops_create_argparser(flops_subparser)

oak_cli-0.2.8/oak_cli/args_parser/plugins/main.py

@@ -0,0 +1,25 @@
+import argparse
+from typing import Any
+
+from oak_cli.args_parser.plugins.flops.main import prepare_flops_argparsers
+from oak_cli.utils.types import Subparsers
+
+
+def prepare_plugins_argparsers(subparsers: Subparsers) -> None:
+    plugins_parser = subparsers.add_parser(
+        "plugins",
+        aliases=["p"],
+        help="command for plugin related activities",
+        formatter_class=argparse.RawTextHelpFormatter,
+    )
+
+    def plugins_parser_print_help(_: Any) -> None:
+        plugins_parser.print_help()
+
+    plugins_parser.set_defaults(func=plugins_parser_print_help)
+
+    plugins_subparsers = plugins_parser.add_subparsers(
+        dest="plugins commands",
+    )
+
+    prepare_flops_argparsers(plugins_subparsers)

{oak_cli-0.2.6 → oak_cli-0.2.8}/oak_cli/args_parser/services/deployment.py

@@ -19,9 +19,7 @@ def prepare_services_deployment_argparser(services_subparsers: Subparsers) -> No
         formatter_class=argparse.RawTextHelpFormatter,
     )
     services_deployment_parser.add_argument("service_id", type=str)
-    services_deployment_parser.set_defaults(
-        func=lambda args: deploy_new_instance(args.service_id)
-    )
+    services_deployment_parser.set_defaults(func=lambda args: deploy_new_instance(args.service_id))
 
 
 def prepare_services_undeployment_argparser(services_subparsers: Subparsers) -> None:

{oak_cli-0.2.6 → oak_cli-0.2.8}/oak_cli/args_parser/services/status.py

@@ -2,10 +2,7 @@ import argparse
 from typing import Any
 
 from oak_cli.commands.services.get import get_single_service
-from oak_cli.commands.services.status import (
-    display_all_current_services,
-    display_single_service,
-)
+from oak_cli.commands.services.status import display_all_current_services, display_single_service
 from oak_cli.utils.types import Subparsers
 
 

oak_cli-0.2.8/oak_cli/commands/apps/main.py

@@ -0,0 +1,81 @@
+import enum
+import json
+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.logging import logger
+from oak_cli.utils.SLAs.common import get_SLAs_path
+from oak_cli.utils.types import Application, ApplicationId
+
+
+def get_application(app_id: ApplicationId) -> Application:
+    return custom_requests.CustomRequest(
+        custom_requests.RequestCore(
+            base_url=SYSTEM_MANAGER_URL,
+            api_endpoint=f"/api/application/{app_id}",
+        ),
+        custom_requests.RequestAuxiliaries(
+            what_should_happen=f"Get application '{app_id}'",
+        ),
+    ).execute()
+
+
+def get_applications() -> List[Application]:
+    apps = custom_requests.CustomRequest(
+        custom_requests.RequestCore(
+            base_url=SYSTEM_MANAGER_URL,
+            api_endpoint="/api/applications",
+        ),
+        custom_requests.RequestAuxiliaries(
+            what_should_happen="Get all applications",
+        ),
+    ).execute()
+    if not apps:
+        logger.info("No applications exist yet")
+    return apps
+
+
+def send_sla(sla_enum: enum) -> List[Application]:
+    sla_file_name = f"{sla_enum}.SLA.json"
+    SLA = ""
+    with open(get_SLAs_path() / sla_file_name, "r") as f:
+        SLA = json.load(f)
+    sla_apps = SLA["applications"]
+    sla_app_names = [app["application_name"] for app in sla_apps]
+    # Note: The API endpoint returns all user apps and not just the newly posted ones.
+    all_user_apps = custom_requests.CustomRequest(
+        custom_requests.RequestCore(
+            http_method=HttpMethod.POST,
+            base_url=SYSTEM_MANAGER_URL,
+            api_endpoint="/api/application",
+            data=SLA,
+        ),
+        custom_requests.RequestAuxiliaries(
+            what_should_happen=f"Create new application based on '{sla_enum}'",
+            show_msg_on_success=True,
+        ),
+    ).execute()
+
+    newly_added_apps = [app for app in all_user_apps if (app["application_name"] in sla_app_names)]
+    return newly_added_apps
+
+
+def delete_application(app_id: ApplicationId) -> None:
+    custom_requests.CustomRequest(
+        custom_requests.RequestCore(
+            http_method=HttpMethod.DELETE,
+            base_url=SYSTEM_MANAGER_URL,
+            api_endpoint=f"/api/application/{app_id}",
+        ),
+        custom_requests.RequestAuxiliaries(
+            what_should_happen=f"Delete application '{app_id}'",
+            show_msg_on_success=True,
+        ),
+    ).execute()
+
+
+def delete_all_applications() -> None:
+    for app in get_applications():
+        delete_application(app["applicationID"])

oak_cli-0.2.8/oak_cli/commands/apps/status.py

@@ -0,0 +1,11 @@
+from icecream import ic
+
+from oak_cli.commands.apps.main import get_applications
+
+ic.configureOutput(prefix="")
+
+
+def display_current_applications() -> None:
+    current_applications = get_applications()
+    for i, application in enumerate(current_applications):
+        ic(i, application)

oak_cli-0.2.8/oak_cli/commands/plugins/flops/flops.SLA.json

@@ -0,0 +1,13 @@
+{
+    "verbose": true,
+    "customerID": "Admin",
+    "applicationID": "",
+    "code": "https://github.com/Malyuk-A/mlflower-test-a",
+    "memory": 100,
+    "vcpus": 1,
+    "vgpus": 0,
+    "vtpus": 0,
+    "bandwidth_in": 0,
+    "bandwidth_out": 0,
+    "storage": 0
+}

oak_cli-0.2.8/oak_cli/commands/plugins/flops/main.py

@@ -0,0 +1,29 @@
+import json
+import os
+import pathlib
+
+import oak_cli.utils.api.custom_requests as custom_requests
+from oak_cli.utils.api.custom_http import HttpMethod
+
+ROOT_FL_MANAGER_URL = f"http://{os.environ.get('SYSTEM_MANAGER_URL')}:5072"
+
+
+def create_new_fl_service() -> None:
+    sla_file_name = "flops.SLA.json"
+    current_file_path = pathlib.Path(__file__).resolve()
+    sla_file_path = current_file_path.parent / sla_file_name
+    with open(sla_file_path, "r") as f:
+        SLA = json.load(f)
+
+    custom_requests.CustomRequest(
+        custom_requests.RequestCore(
+            http_method=HttpMethod.POST,
+            base_url=ROOT_FL_MANAGER_URL,
+            api_endpoint="/api/flops",
+            data=SLA,
+        ),
+        custom_requests.RequestAuxiliaries(
+            what_should_happen="Init new FLOps processes",
+            show_msg_on_success=True,
+        ),
+    ).execute()

oak_cli-0.2.8/oak_cli/commands/services/deployment.py

@@ -0,0 +1,39 @@
+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.types import Id, ServiceId
+
+
+def deploy_new_instance(service_id: ServiceId) -> None:
+    custom_requests.CustomRequest(
+        custom_requests.RequestCore(
+            http_method=HttpMethod.POST,
+            base_url=SYSTEM_MANAGER_URL,
+            api_endpoint=f"/api/service/{service_id}/instance",
+        ),
+        custom_requests.RequestAuxiliaries(
+            what_should_happen=f"Deploy a new instance for the service '{service_id}'",
+            show_msg_on_success=True,
+        ),
+    ).execute()
+
+
+def undeploy_instance(service_id: ServiceId, instance_id: Id = None) -> None:
+    custom_requests.CustomRequest(
+        custom_requests.RequestCore(
+            http_method=HttpMethod.DELETE,
+            base_url=SYSTEM_MANAGER_URL,
+            api_endpoint=f"/api/service/{service_id}/instance/{instance_id or 0}",
+        ),
+        custom_requests.RequestAuxiliaries(
+            what_should_happen=f"Undeploy instance '{instance_id or 0}' for service '{service_id}'",
+            show_msg_on_success=True,
+        ),
+    ).execute()
+
+
+def undeploy_all_instances_of_service(service_id: ServiceId) -> None:
+    service = get_single_service(service_id)
+    for instance in service["instance_list"]:
+        undeploy_instance(service_id, instance["instance_number"])

oak_cli-0.2.8/oak_cli/commands/services/get.py

@@ -0,0 +1,38 @@
+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.logging import logger
+from oak_cli.utils.types import Service, ServiceId
+
+
+def get_single_service(service_id: ServiceId) -> Service:
+    return custom_requests.CustomRequest(
+        custom_requests.RequestCore(
+            base_url=SYSTEM_MANAGER_URL,
+            api_endpoint=f"/api/service/{service_id}",
+        ),
+        custom_requests.RequestAuxiliaries(
+            what_should_happen=f"Get single service '{service_id}'",
+        ),
+    ).execute()
+
+
+def get_all_services(app_id: ServiceId = None) -> List[Service]:
+    what_should_happen = "Get all services"
+    if app_id:
+        what_should_happen += f" of app '{app_id}'"
+
+    services = custom_requests.CustomRequest(
+        custom_requests.RequestCore(
+            base_url=SYSTEM_MANAGER_URL,
+            api_endpoint=f"/api/services/{app_id or ''}",
+        ),
+        custom_requests.RequestAuxiliaries(
+            what_should_happen=what_should_happen,
+        ),
+    ).execute()
+
+    if not services:
+        logger.info("No applications exist yet")
+    return services

oak_cli-0.2.8/oak_cli/commands/services/status.py

@@ -0,0 +1,41 @@
+from icecream import ic
+
+from oak_cli.commands.services.get import get_all_services
+from oak_cli.utils.types import ApplicationId, Service
+
+ic.configureOutput(prefix="")
+
+
+def display_single_service(service: Service, verbose: bool = False) -> None:
+    if verbose:
+        for instance in service["instance_list"]:
+            instance["cpu_history"] = "..."
+            instance["memory_history"] = "..."
+            instance["logs"] = "..."
+    else:
+        mask = [
+            "addresses",
+            "app_name",
+            "app_ns",
+            "applicationID",
+            "service_name",
+            "service_ns",
+            "service_ns",
+            "one_shot",
+            "microserviceID",
+            "cmd",
+            "code",
+            "image",
+        ]
+        service = {key: service[key] for key in mask if key in service}
+    ic(service)
+
+
+def display_all_current_services(
+    verbose: bool = False,
+    app_id: ApplicationId = None,
+) -> None:
+    all_current_services = get_all_services(app_id)
+    for i, service in enumerate(all_current_services):
+        ic(i)
+        display_single_service(service, verbose)

oak_cli-0.2.8/oak_cli/main.py

@@ -0,0 +1,28 @@
+#!/usr/bin/env python3
+# PYTHON_ARGCOMPLETE_OK
+
+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.logging import logger
+
+
+def main():
+    handle_argcomplete()
+    # Potential Future Work:
+    # This implementation uses argparse & argcomplete for user friendly CLI behavior.
+    # However especially argparse comes with a lot of additional boilerplate code.
+    # It might be useful to look into more modern solutions for python CLI's like
+    # https://github.com/pallets/click
+
+    try:
+        parse_arguments_and_execute()
+    except OakCliException as e:
+        logger.fatal(f"{e.msg}, {e.http_status}")
+    except Exception as e:
+        err_msg = f"Unexpected error occured: {e}"
+        logger.fatal(err_msg)
+
+
+if __name__ == "__main__":
+    main()

oak_cli-0.2.8/oak_cli/utils/api/common.py

@@ -0,0 +1,3 @@
+import os
+
+SYSTEM_MANAGER_URL = f"http://{os.environ.get('SYSTEM_MANAGER_URL')}:10000"

oak_cli-0.2.6/oak_cli/utils/api/common.py → oak_cli-0.2.8/oak_cli/utils/api/custom_http.py

@@ -1,12 +1,7 @@
-import os
-
 import requests
 
 from oak_cli.utils.types import CustomEnum
 
-GITHUB_PREFIX = "https://github.com/"
-SYSTEM_MANAGER_URL = f"http://{os.environ.get('SYSTEM_MANAGER_URL')}:10000"
-
 
 class HttpMethod(CustomEnum):
     GET = "get"

oak_cli-0.2.8/oak_cli/utils/api/custom_requests.py

@@ -0,0 +1,94 @@
+import json
+from http import HTTPStatus
+from typing import NamedTuple
+
+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.logging import logger
+
+
+class RequestCore(NamedTuple):
+    base_url: str
+    api_endpoint: str = None
+    query_params: str = None
+    http_method: HttpMethod = HttpMethod.GET
+    custom_headers: dict = None
+    data: dict = None
+
+
+class RequestAuxiliaries(NamedTuple):
+    what_should_happen: str
+    exception: OakCliException = OakCliException
+    show_msg_on_success: bool = False
+    is_oakestra_api: bool = True
+
+
+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
+        self._prepare()
+
+    def _prepare(self) -> None:
+        self.url = self.core.base_url
+        if self.core.api_endpoint is not None:
+            self.url = f"{self.core.base_url}{self.core.api_endpoint}"
+        if self.core.query_params is not None:
+            self.url += f"?{self.core.query_params}"
+
+        if self.core.custom_headers:
+            self.headers = self.core.custom_headers
+        else:
+            self.headers = (
+                {"Authorization": f"Bearer {get_login_token()}"} if self.aux.is_oakestra_api else {}
+            )
+
+        if self.core.data and not self.core.custom_headers:
+            self.headers["Content-Type"] = "application/json"
+
+        self.args = {
+            "url": self.url,
+            "verify": False,
+            **({"headers": self.headers} if self.headers else {}),
+            **({"json": self.core.data} if self.core.data else {}),
+        }
+
+    def _create_failure_msg(self) -> str:
+        return " ".join(
+            (
+                self.aux.what_should_happen,
+                "request failed",
+                f"with {self.response.status}" if self.response else "- no response",
+                f"for '{self.core.http_method}' '{self.url}",
+            )
+        )
+
+    def execute(self) -> any:
+        error_msg = ""
+        try:
+            self.response = self.core.http_method.call(**self.args)
+            self.response.status = HTTPStatus(self.response.status_code)
+            if self.response.status == HTTPStatus.OK:
+                if self.aux.show_msg_on_success:
+                    logger.info(f"Success: '{self.aux.what_should_happen}'")
+                response = self.response.json()
+                if isinstance(response, str):
+                    response = json.loads(response)
+                return response
+
+        except requests.exceptions.RequestException as e:
+            error_msg = f"exception: {e}: "
+
+        error_msg += self._create_failure_msg()
+
+        raise self.aux.exception(
+            msg=error_msg,
+            http_status=self.response.status if self.response else None,
+        )

oak_cli-0.2.8/oak_cli/utils/api/login.py

@@ -0,0 +1,36 @@
+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
+
+_login_token = ""
+
+
+class LoginFailed(Exception):
+    pass
+
+
+def _login_and_set_token() -> str:
+    response = custom_requests.CustomRequest(
+        custom_requests.RequestCore(
+            http_method=HttpMethod.POST,
+            base_url=SYSTEM_MANAGER_URL,
+            api_endpoint="/api/auth/login",
+            data={"username": "Admin", "password": "Admin"},
+            custom_headers={"accept": "application/json", "Content-Type": "application/json"},
+        ),
+        custom_requests.RequestAuxiliaries(
+            what_should_happen="Login",
+            exception=LoginException,
+        ),
+    ).execute()
+
+    global _login_token
+    _login_token = response["token"]
+    return _login_token
+
+
+def get_login_token() -> str:
+    if _login_token == "":
+        return _login_and_set_token()
+    return _login_token

oak_cli-0.2.8/oak_cli/utils/exceptions.py

@@ -0,0 +1,23 @@
+from http import HTTPStatus
+
+
+class OakCliException(Exception):
+    def __init__(
+        self,
+        msg: str,
+        http_status: HTTPStatus = None,
+    ):
+        self.msg = msg
+        self.http_status = http_status
+
+
+class OakestraException(OakCliException):
+    pass
+
+
+class MQTTException(OakCliException):
+    pass
+
+
+class LoginException(OakCliException):
+    pass

{oak_cli-0.2.6 → oak_cli-0.2.8}/oak_cli/utils/logging.py

@@ -33,7 +33,6 @@ class CustomFormatter(logging.Formatter):
 
 
 _LOGGER_NAME = "logger"
-
 _FORMAT = "%(message)s"
 
 logger = logging.getLogger(_LOGGER_NAME)

{oak_cli-0.2.6 → oak_cli-0.2.8}/oak_cli/utils/types.py

@@ -17,6 +17,4 @@ Application = dict
 SLA = dict
 DbObject = dict
 
-
-# Custom type for nicer type hints
 Subparsers = argparse._SubParsersAction

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

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "oak_cli"
-version = "0.2.6"
+version = "0.2.8"
 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"
+icecream = "^2.1.3"
 
 [build-system]
 requires = ["poetry-core"]
@@ -15,3 +16,6 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry.scripts]
 oak = "oak_cli.main:main"
+
+[tool.black]
+line-length = 100

oak_cli-0.2.6/oak_cli/commands/apps/main.py

@@ -1,60 +0,0 @@
-import enum
-import json
-from typing import List
-
-from oak_cli.utils.api.common import SYSTEM_MANAGER_URL, HttpMethod
-from oak_cli.utils.api.main import handle_request
-from oak_cli.utils.SLAs.common import get_SLAs_path
-from oak_cli.utils.types import Application, ApplicationId
-
-
-def get_application(app_id: ApplicationId) -> Application:
-    app = handle_request(
-        base_url=SYSTEM_MANAGER_URL,
-        http_method=HttpMethod.GET,
-        api_endpoint=f"/api/application/{app_id}",
-        what_should_happen=f"Get application '{app_id}'",
-    )
-    return app
-
-
-def get_applications() -> List[Application]:
-    apps = handle_request(
-        base_url=SYSTEM_MANAGER_URL,
-        http_method=HttpMethod.GET,
-        api_endpoint="/api/applications",
-        what_should_happen="Get all applications",
-    )
-    return apps
-
-
-def send_sla(sla_enum: enum) -> List[Application]:
-    sla_file_name = f"{sla_enum}.SLA.json"
-    SLA = ""
-    with open(get_SLAs_path() / sla_file_name, "r") as f:
-        SLA = json.load(f)
-
-    apps = handle_request(
-        base_url=SYSTEM_MANAGER_URL,
-        http_method=HttpMethod.POST,
-        data=SLA,
-        api_endpoint="/api/application",
-        what_should_happen=f"Create new application based on '{sla_enum}'",
-        show_msg_on_success=True,
-    )
-    return apps
-
-
-def delete_application(app_id: ApplicationId) -> None:
-    handle_request(
-        base_url=SYSTEM_MANAGER_URL,
-        http_method=HttpMethod.DELETE,
-        api_endpoint=f"/api/application/{app_id}",
-        what_should_happen=f"Delete application '{app_id}'",
-        show_msg_on_success=True,
-    )
-
-
-def delete_all_applications() -> None:
-    for app in get_applications():
-        delete_application(app["applicationID"])

oak_cli-0.2.6/oak_cli/commands/apps/status.py

@@ -1,21 +0,0 @@
-from oak_cli.commands.apps.main import get_applications
-from oak_cli.utils.logging import logger
-
-
-def display_current_applications() -> None:
-    current_applications = get_applications()
-
-    def log_aux(key: str, value: str) -> None:
-        logger.debug(f"   {key}: '{value}'")
-
-    logger.info(f"Current apps: '{len(current_applications)}'")
-    for i, application in enumerate(current_applications):
-        logger.info(f" App '{i}':")
-        log_aux("id", application["applicationID"])
-        log_aux("name", application["application_name"])
-        log_aux("ns", application["application_namespace"])
-        log_aux("desc", application["application_desc"])
-        log_aux(
-            "microservices",
-            f"{len(application['microservices'])}: {application['microservices']}",
-        )

oak_cli-0.2.6/oak_cli/commands/services/deployment.py

@@ -1,30 +0,0 @@
-from oak_cli.commands.services.get import get_single_service
-from oak_cli.utils.api.common import SYSTEM_MANAGER_URL, HttpMethod
-from oak_cli.utils.api.main import handle_request
-from oak_cli.utils.types import Id, ServiceId
-
-
-def deploy_new_instance(service_id: ServiceId) -> None:
-    handle_request(
-        base_url=SYSTEM_MANAGER_URL,
-        http_method=HttpMethod.POST,
-        api_endpoint=f"/api/service/{service_id}/instance",
-        what_should_happen=f"Deploy a new instance for the service '{service_id}'",
-        show_msg_on_success=True,
-    )
-
-
-def undeploy_instance(service_id: ServiceId, instance_id: Id = None) -> None:
-    handle_request(
-        base_url=SYSTEM_MANAGER_URL,
-        http_method=HttpMethod.DELETE,
-        api_endpoint=f"/api/service/{service_id}/instance/{instance_id or 0}",
-        what_should_happen=f"Undeploy instance '{instance_id or 0}' for the service '{service_id}'",
-        show_msg_on_success=True,
-    )
-
-
-def undeploy_all_instances_of_service(service_id: ServiceId) -> None:
-    service = get_single_service(service_id)
-    for instance in service["instance_list"]:
-        undeploy_instance(service_id, instance["instance_number"])

oak_cli-0.2.6/oak_cli/commands/services/get.py

@@ -1,29 +0,0 @@
-from typing import List
-
-from oak_cli.utils.api.common import SYSTEM_MANAGER_URL, HttpMethod
-from oak_cli.utils.api.main import handle_request
-from oak_cli.utils.types import Service, ServiceId
-
-
-def get_single_service(service_id: ServiceId) -> Service:
-    service = handle_request(
-        base_url=SYSTEM_MANAGER_URL,
-        http_method=HttpMethod.GET,
-        api_endpoint=f"/api/service/{service_id}",
-        what_should_happen=f"Get single service '{service_id}'",
-    )
-    return service
-
-
-def get_all_services(app_id: ServiceId = None) -> List[Service]:
-    what_should_happen = "Get all services"
-    if app_id:
-        what_should_happen += f" of app '{app_id}'"
-
-    services = handle_request(
-        base_url=SYSTEM_MANAGER_URL,
-        http_method=HttpMethod.GET,
-        api_endpoint=f"/api/services/{app_id or ''}",
-        what_should_happen=what_should_happen,
-    )
-    return services

oak_cli-0.2.6/oak_cli/commands/services/status.py

@@ -1,75 +0,0 @@
-from oak_cli.commands.services.get import get_all_services
-from oak_cli.utils.logging import logger
-from oak_cli.utils.types import ApplicationId, Service
-
-
-def _log_aux_service(key: str, value: str, service: Service) -> None:
-    value = service.get(value, None)
-    if value is not None:
-        _log_aux(key, value)
-
-
-def _log_aux(key: str, value: str) -> None:
-    logger.debug(f"   {key}: '{value}'")
-
-
-def verbose_log_aux(section_name: str) -> None:
-    logger.info(f"   - {section_name} -")
-
-
-def display_single_service(service: Service, verbose: bool = False) -> None:
-    verbose_log_aux("microservice")
-    _log_aux_service("id", "microserviceID", service)
-    _log_aux_service(
-        "microservice name" if verbose else "name", "microservice_name", service
-    )
-    _log_aux_service(
-        "microservice ns" if verbose else "ns", "microservice_namespace", service
-    )
-    _log_aux("parent app", f"{service['app_name']}: {service['applicationID']}")
-
-    if verbose:
-        verbose_log_aux("service")
-        _log_aux_service("service name", "service_name", service)
-
-    verbose_log_aux("resources")
-    _log_aux_service("memory", "memory", service)
-    _log_aux_service("vcpus", "vcpus", service)
-    if verbose:
-        _log_aux_service("storage", "storage", service)
-        _log_aux_service("vgpus", "vgpus", service)
-
-    verbose_log_aux("container")
-    _log_aux_service("image", "image", service)
-    if verbose:
-        _log_aux_service("code", "code", service)
-
-    verbose_log_aux("networking")
-    _log_aux_service("port", "port", service)
-    if verbose:
-        _log_aux_service("bandwidth in", "bandwidth_in", service)
-        _log_aux_service("bandwidth out", "bandwidth_out", service)
-
-    verbose_log_aux("instances")
-    instances = service["instance_list"]
-    num_instances = len(instances)
-    _log_aux("instances", num_instances)
-    if verbose and num_instances > 0:
-        for i, instance in enumerate(instances):
-            logger.info(f"   Instance '{i}':")
-            _log_aux("  instance_number", instance["instance_number"])
-            _log_aux("  status", instance["status"])
-            _log_aux("  publicip", instance["publicip"])
-            _log_aux("  cpu", instance["cpu"])
-
-
-def display_all_current_services(
-    verbose: bool = False,
-    app_id: ApplicationId = None,
-) -> None:
-    all_current_services = get_all_services(app_id)
-
-    logger.info(f"All current services: '{len(all_current_services)}'")
-    for i, service in enumerate(all_current_services):
-        logger.warning(f" Service '{i}':")
-        display_single_service(service, verbose)

oak_cli-0.2.6/oak_cli/main.py

@@ -1,14 +0,0 @@
-#!/usr/bin/env python3
-# PYTHON_ARGCOMPLETE_OK
-
-from oak_cli.args_parser.main import parse_arguments_and_execute
-from oak_cli.utils.argcomplete import handle_argcomplete
-
-
-def main():
-    handle_argcomplete()
-    parse_arguments_and_execute()
-
-
-if __name__ == "__main__":
-    main()

oak_cli-0.2.6/oak_cli/utils/api/login.py

@@ -1,33 +0,0 @@
-from http import HTTPStatus
-
-import oak_cli.utils.api as oak_api
-
-_login_token = ""
-
-
-class LoginFailed(Exception):
-    pass
-
-
-def _login_and_set_token() -> str:
-    data = {"username": "Admin", "password": "Admin"}
-    headers = {"accept": "application/json", "Content-Type": "application/json"}
-
-    json_data = oak_api.main.handle_request(
-        base_url=oak_api.common.SYSTEM_MANAGER_URL,
-        http_method=oak_api.common.HttpMethod.POST,
-        api_endpoint="/api/auth/login",
-        headers=headers,
-        data=data,
-        what_should_happen="Login",
-    )
-
-    global _login_token
-    _login_token = json_data["token"]
-    return _login_token
-
-
-def get_login_token() -> str:
-    if _login_token == "":
-        return _login_and_set_token()
-    return _login_token

oak_cli-0.2.6/oak_cli/utils/api/main.py

@@ -1,108 +0,0 @@
-import json
-import sys
-from http import HTTPStatus
-from typing import NamedTuple, Optional, Tuple, Union
-
-import requests
-
-from oak_cli.utils.api.common import HttpMethod
-from oak_cli.utils.api.login import get_login_token
-from oak_cli.utils.logging import logger
-
-
-class ApiQueryComponents(NamedTuple):
-    url: str
-    headers: dict
-    data: dict = None
-
-
-def _prepare_api_query_components(
-    base_url: str,
-    api_endpoint: str = None,
-    custom_headers: dict = None,
-    data: dict = None,
-    query_params: str = None,
-) -> ApiQueryComponents:
-    url = base_url
-    if api_endpoint is not None:
-        url = f"{base_url}{api_endpoint}"
-    if query_params is not None:
-        url += f"?{query_params}"
-    headers = custom_headers or {"Authorization": f"Bearer {get_login_token()}"}
-    if data and not custom_headers:
-        headers["Content-Type"] = "application/json"
-    return ApiQueryComponents(url, headers, data)
-
-
-def _create_failure_msg(
-    what_should_happen: str,
-    http_method: HttpMethod,
-    url: str,
-    response_status: HTTPStatus = None,
-) -> str:
-    return (
-        " ".join(
-            (
-                what_should_happen,
-                "request failed with",
-                str(response_status),
-                f"for '{http_method}' '{url}",
-            )
-        ),
-    )
-
-
-def handle_request(
-    base_url: str,
-    what_should_happen: str,
-    http_method: HttpMethod = HttpMethod.GET,
-    api_endpoint: str = None,
-    headers: dict = None,
-    data: dict = None,
-    show_msg_on_success: bool = False,
-    special_msg_on_fail: str = None,
-    query_params: str = None,
-    terminate_when_failed: bool = True,
-) -> Union[HTTPStatus, Tuple[HTTPStatus, Optional[dict]]]:
-
-    url, headers, data = _prepare_api_query_components(
-        base_url, api_endpoint, headers, data, query_params
-    )
-    args = {
-        "url": url,
-        "verify": False,
-        **({"headers": headers} if headers else {}),
-        **({"json": data} if data else {}),
-    }
-
-    try:
-        response = http_method.call(**args)
-        response_status = HTTPStatus(response.status_code)
-
-        if response_status == HTTPStatus.OK:
-            if show_msg_on_success:
-                logger.info(f"Success: {what_should_happen}")
-            response = response.json()
-            if isinstance(response, str):
-                response = json.loads(response)
-            if terminate_when_failed:
-                return response
-            return response_status, response
-        else:
-            logger.error(f"FAILED: {special_msg_on_fail or what_should_happen}!")
-            logger.error(
-                _create_failure_msg(
-                    what_should_happen, http_method, url, response_status
-                )
-            )
-            logger.error(f"response: '{response}'")
-            if terminate_when_failed:
-                sys.exit(1)
-            return response_status, None
-
-    except requests.exceptions.RequestException as e:
-        logger.error(_create_failure_msg(what_should_happen, http_method, url))
-        logger.error(e)
-        if terminate_when_failed:
-            sys.exit(1)
-        return HTTPStatus.INTERNAL_SERVER_ERROR, None