edge-containers-cli 4.3.1__tar.gz → 4.4.0__tar.gz

{edge_containers_cli-4.3.1 → edge_containers_cli-4.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: edge-containers-cli
-Version: 4.3.1
+Version: 4.4.0
 Summary: CLI for deploying and managing epics containers IOCs and services
 Author-email: Giles Knap <giles.knap@gmail.com>
 License:                                  Apache License
@@ -232,6 +232,7 @@ Requires-Dist: pytest-mock; extra == "dev"
 Requires-Dist: ruff; extra == "dev"
 Requires-Dist: tox-direct; extra == "dev"
 Requires-Dist: types-mock; extra == "dev"
+Dynamic: license-file
 
 [![CI](https://github.com/epics-containers/edge-containers-cli/actions/workflows/ci.yml/badge.svg)](https://github.com/epics-containers/edge-containers-cli/actions/workflows/ci.yml)
 [![Coverage](https://codecov.io/gh/epics-containers/edge-containers-cli/branch/main/graph/badge.svg)](https://codecov.io/gh/epics-containers/edge-containers-cli)

{edge_containers_cli-4.3.1 → edge_containers_cli-4.4.0}/pyproject.toml

@@ -43,7 +43,7 @@ dev = [
 ]
 
 [project.scripts]
-ec = "edge_containers_cli.__main__:cli"
+ec = "edge_containers_cli.__main__:main"
 
 [project.urls]
 GitHub = "https://github.com/epics-containers/edge-containers-cli"

{edge_containers_cli-4.3.1 → edge_containers_cli-4.4.0}/src/edge_containers_cli/__main__.py

@@ -1,8 +1,10 @@
+import os
+import sys
 from typing import Optional
 
 import typer
 
-from edge_containers_cli.cli import cli
+from edge_containers_cli.cli import cli, drop_methods, drop_options, set_optional
 from edge_containers_cli.definitions import ENV, ECBackends, ECContext, ECLogLevels
 
 from . import __version__
@@ -14,6 +16,8 @@ from .utils import init_cleanup
 
 __all__ = ["main"]
 
+DEFAULT_BACKEND = ECBackends.ARGOCD
+
 
 def version_callback(value: bool):
     if value:
@@ -23,27 +27,14 @@ def version_callback(value: bool):
 
 def backend_callback(ctx: typer.Context, backend: ECBackends):
     init_backend(backend)
-
-    # Dynamically drop any method not implemented
-    not_implemented = [
-        mthd.replace("_", "-") for mthd in ec_backend.get_notimplemented_cmds()
-    ]
-    typer_commands = ctx.command.commands  # type: ignore
-    for command in not_implemented:
-        if command in typer_commands:
-            typer_commands.pop(command)
-
-    # Dynamically drop any cli options as specified
-    for cmd_name, drop_params in ec_backend.get_notimplemented_params().items():
-        for index, param in enumerate(typer_commands[cmd_name].params):
-            if param.name in drop_params:
-                typer_commands[cmd_name].params.pop(index)
-
+    drop_methods(ctx, ec_backend.get_notimplemented_cmds())
+    drop_options(ctx, ec_backend.get_notimplemented_params())
+    set_optional(ctx, ec_backend.get_optional_params())
     return backend.value
 
 
 @cli.callback()
-def main(
+def _main(
     ctx: typer.Context,
     version: Optional[bool] = typer.Option(
         None,
@@ -67,7 +58,7 @@ def main(
         envvar=ENV.target.value,
     ),
     backend: ECBackends = typer.Option(
-        ECBackends.ARGOCD,
+        DEFAULT_BACKEND,
         "-b",
         "--backend",
         callback=backend_callback,
@@ -123,7 +114,24 @@ def main(
     ec_backend.set_context(context)
 
 
+def force_backend_callback():
+    """
+    Typer does not execute option callbacks before running --help unless the
+    option is explicitly provided
+    """
+    if "--help" in sys.argv:
+        if "-b" not in sys.argv:
+            backend = os.environ.get("EC_CLI_BACKEND", DEFAULT_BACKEND)
+            sys.argv.insert(1, backend)
+            sys.argv.insert(1, "-b")
+
+
+def main():
+    force_backend_callback()
+    cli()
+
+
 # test with:
 #     python -m edge_containers_cli
 if __name__ == "__main__":
-    cli()
+    main()

{edge_containers_cli-4.3.1 → edge_containers_cli-4.4.0}/src/edge_containers_cli/_version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '4.3.1'
-__version_tuple__ = version_tuple = (4, 3, 1)
+__version__ = version = '4.4.0'
+__version_tuple__ = version_tuple = (4, 4, 0)

{edge_containers_cli-4.3.1 → edge_containers_cli-4.4.0}/src/edge_containers_cli/autocomplete.py

@@ -33,7 +33,10 @@ def fetch_service_graph(repo: str) -> dict:
     if not version_map:
         with new_workdir() as path:
             version_map = create_version_map(
-                repo, Path(globals.SERVICES_DIR), path, shared=[globals.SHARED_VALUES]
+                repo,
+                Path(globals.SERVICES_DIR),
+                path,
+                shared_files=[globals.SHARED_VALUES],
             )
             cache_dict(
                 globals.CACHE_ROOT / url_encode(repo),

{edge_containers_cli-4.3.1 → edge_containers_cli-4.4.0}/src/edge_containers_cli/backend.py

@@ -68,6 +68,9 @@ class Backend:
     def get_notimplemented_params(self) -> dict[str, list[str]]:
         return self.Commands.params_opt_out
 
+    def get_optional_params(self) -> dict[str, list[str]]:
+        return self.Commands.params_optional
+
 
 backend = Backend()
 

{edge_containers_cli-4.3.1 → edge_containers_cli-4.4.0}/src/edge_containers_cli/cli.py

@@ -40,7 +40,10 @@ cli = ErrorHandlingTyper(pretty_exceptions_show_locals=False)
 @cli.command()
 def attach(
     service_name: str = typer.Argument(
-        ..., help="Name of the service to attach to", autocompletion=running_svc
+        ...,
+        help="Name of the service to attach to",
+        autocompletion=running_svc,
+        show_default=False,
     ),
 ):
     """
@@ -52,15 +55,18 @@ def attach(
 @cli.command()
 def delete(
     service_name: str = typer.Argument(
-        ..., help="Name of the service to delete", autocompletion=all_svc
+        ...,
+        help="Name of the service to delete",
+        autocompletion=all_svc,
+        show_default=False,
     ),
     yes: bool = typer.Option(False, "-y", "--yes", help="Skip confirmation prompt"),
 ):
     """
-    Remove a helm deployment from the cluster
+    Remove a service from the cluster
     """
     confirmation(
-        f"Remove all versions of {service_name} from the target `{backend.commands.target}`",
+        f"Remove {service_name} from the target `{backend.commands.target}`",
         yes,
     )
     backend.commands.delete(service_name)
@@ -69,12 +75,16 @@ def delete(
 @cli.command()
 def deploy(
     service_name: str = typer.Argument(
-        ..., help="Name of the service to deploy", autocompletion=avail_services
+        ...,
+        help="Name of the service to deploy",
+        autocompletion=avail_services,
+        show_default=False,
     ),
     version: str = typer.Argument(
-        ...,
-        help="Version tag of the service to deploy",
+        "latest tag",
+        help="Version tag or branch of the service to deploy",
         autocompletion=avail_versions,
+        show_default=False,
     ),
     wait: bool = typer.Option(False, "--wait", help="Waits for readiness"),
     yes: bool = typer.Option(False, "-y", "--yes", help="Skip confirmation prompt"),
@@ -83,15 +93,19 @@ def deploy(
     ),
 ):
     """
-    Pull an service helm chart version from the domain repo and deploy it to the cluster
+    Add a service to the cluster from its source repository
     """
-    confirmation(
-        f"Deploy {service_name.lower()} "
-        f"of version `{version}` to target `{backend.commands.target}`",
-        yes,
-    )
+
+    def confirm_callback(svc_version):
+        confirmation(
+            f"Deploy {service_name.lower()} "
+            f"of version `{svc_version}` to target `{backend.commands.target}`",
+            yes,
+        )
+
     args = args if not wait else args + " --wait"
-    backend.commands.deploy(service_name, version, args)
+    version = version if version != "latest tag" else ""
+    backend.commands.deploy(service_name, version, args, confirm_callback)
 
 
 @cli.command()
@@ -103,19 +117,23 @@ def deploy_local(
         file_okay=False,
         resolve_path=True,
         autocompletion=force_plain_completion,
+        show_default=False,
     ),
     yes: bool = typer.Option(False, "-y", "--yes", help="Skip confirmation prompt"),
     args: str = typer.Option("", help="Additional args for helm, 'must be quoted'"),
 ):
     """
-    Deploy a local service helm chart directly to the cluster with dated beta version
+    Add a local service helm chart directly to the cluster with dated beta version
     """
-    confirmation(
-        f"Deploy local {svc_instance.name.lower()} "
-        f"from {svc_instance} to target `{backend.commands.target}`",
-        yes,
-    )
-    backend.commands.deploy_local(svc_instance, args)
+
+    def confirm_callback(svc_version):
+        confirmation(
+            f"Deploy local {svc_instance.name.lower()} of version `{svc_version}` "
+            f"from {svc_instance} to target `{backend.commands.target}`",
+            yes,
+        )
+
+    backend.commands.deploy_local(svc_instance, args, confirm_callback)
 
 
 @cli.command()
@@ -131,6 +149,7 @@ def exec(
         ...,
         help="Name of the service container to run in",
         autocompletion=running_svc,
+        show_default=False,
     ),
 ):
     """Execute a bash prompt in a running container"""
@@ -140,7 +159,10 @@ def exec(
 @cli.command()
 def instances(
     service_name: str = typer.Argument(
-        ..., help="Name of the service to inspect", autocompletion=avail_services
+        ...,
+        help="Name of the service to inspect",
+        autocompletion=avail_services,
+        show_default=False,
     ),
 ):
     """List all versions of the specified service in the repository"""
@@ -149,19 +171,19 @@ def instances(
             service_name,
             backend.commands.repo,
             Path(globals.SERVICES_DIR),
-            shared=[globals.SHARED_VALUES],
+            shared_files=[globals.SHARED_VALUES],
         )
     )
 
 
-@cli.command()
-def list():
+@cli.command(name="list")
+def _list():
     """List all services available in the service repository"""
     print(
         list_all(
             backend.commands.repo,
             Path(globals.SERVICES_DIR),
-            shared=[globals.SHARED_VALUES],
+            shared_files=[globals.SHARED_VALUES],
         )
     )
 
@@ -172,16 +194,20 @@ def log_history(
         ...,
         help="Name of the service to inspect",
         autocompletion=all_svc,
+        show_default=False,
     ),
 ):
-    """Open historical logs for an service"""
+    """Open historical logs for a service"""
     backend.commands.log_history(service_name)
 
 
 @cli.command()
 def logs(
     service_name: str = typer.Argument(
-        ..., help="Name of the service to inspect", autocompletion=running_svc
+        ...,
+        help="Name of the service to inspect",
+        autocompletion=running_svc,
+        show_default=False,
     ),
     prev: bool = typer.Option(
         False,
@@ -190,7 +216,7 @@ def logs(
         help="Show log from the previous instance of the service",
     ),
 ):
-    """Show logs for current and previous instances of an service"""
+    """Show logs for current and previous instances of a service"""
     backend.commands.logs(service_name, prev)
 
 
@@ -200,7 +226,7 @@ def monitor(
         False, "-r", "--running-only", help="list only services that are running"
     ),
 ):
-    """Open monitor TUI."""
+    """Open monitor TUI"""
     from edge_containers_cli.cmds.monitor import (
         MonitorApp,  # Lazy import for performace
     )
@@ -222,7 +248,10 @@ def ps(
 @cli.command()
 def restart(
     service_name: str = typer.Argument(
-        ..., help="Name of the container to restart", autocompletion=running_svc
+        ...,
+        help="Name of the container to restart",
+        autocompletion=running_svc,
+        show_default=False,
     ),
 ):
     """Restart a service"""
@@ -232,7 +261,10 @@ def restart(
 @cli.command()
 def start(
     service_name: str = typer.Argument(
-        ..., help="Name of the service container to start", autocompletion=all_svc
+        ...,
+        help="Name of the service container to start",
+        autocompletion=all_svc,
+        show_default=False,
     ),
     commit: bool = typer.Option(False, help="Commits the values to the git repo"),
 ):
@@ -250,6 +282,7 @@ def stop(
         ...,
         help="Name of the service container to stop",
         autocompletion=running_svc,
+        show_default=False,
     ),
     commit: bool = typer.Option(False, help="Commits the values to the git repo"),
 ):
@@ -270,6 +303,7 @@ def template(
         file_okay=False,
         resolve_path=True,
         autocompletion=force_plain_completion,
+        show_default=False,
     ),
     args: str = typer.Option("", help="Additional args for helm, 'must be quoted'"),
 ):
@@ -278,3 +312,30 @@ def template(
     """
     args = f"{args} --debug"
     backend.commands.template(svc_instance, args)
+
+
+def drop_methods(ctx: typer.Context, to_drop: list[str]):
+    """Dynamically drop any method not implemented"""
+    not_implemented = [mthd.replace("_", "-") for mthd in to_drop]
+    typer_commands = ctx.command.commands  # type: ignore
+    for command in not_implemented:
+        if command in typer_commands:
+            typer_commands.pop(command)
+
+
+def drop_options(ctx: typer.Context, to_drop: dict[str, list[str]]):
+    """Dynamically drop any cli options as specified"""
+    typer_commands = ctx.command.commands  # type: ignore
+    for cmd_name, drop_params in to_drop.items():
+        for i, param in enumerate(typer_commands[cmd_name].params):
+            if param.name in drop_params:
+                typer_commands[cmd_name].params.pop(i)
+
+
+def set_optional(ctx: typer.Context, to_set: dict[str, list[str]]):
+    """Dynamically set any cli options optional as specified"""
+    typer_commands = ctx.command.commands  # type: ignore
+    for cmd_name, optional_params in to_set.items():
+        for i, param in enumerate(typer_commands[cmd_name].params):
+            if param.name in optional_params:
+                typer_commands[cmd_name].params[i].required = False

{edge_containers_cli-4.3.1 → edge_containers_cli-4.4.0}/src/edge_containers_cli/cmds/argo_commands.py

@@ -4,6 +4,7 @@ implements commands for deploying and managing service instances suing argocd
 Relies on the Helm class for deployment aspects.
 """
 
+import re
 import webbrowser
 from datetime import datetime
 from pathlib import Path
@@ -12,6 +13,7 @@ from time import sleep
 import polars
 from ruamel.yaml import YAML
 
+from edge_containers_cli import globals
 from edge_containers_cli.cmds.commands import (
     CommandError,
     Commands,
@@ -19,10 +21,10 @@ from edge_containers_cli.cmds.commands import (
     ServicesSchema,
 )
 from edge_containers_cli.definitions import ECContext
-from edge_containers_cli.git import set_values
-from edge_containers_cli.globals import TIME_FORMAT
+from edge_containers_cli.git import del_key, set_value
 from edge_containers_cli.logging import log
 from edge_containers_cli.shell import ShellError, shell
+from edge_containers_cli.utils import YamlTypes
 
 
 def extract_ns_app(target: str) -> tuple[str, str]:
@@ -30,6 +32,18 @@ def extract_ns_app(target: str) -> tuple[str, str]:
     return namespace, app
 
 
+def get_patches(target) -> dict:
+    app_resp = shell.run_command(
+        f"argocd app get --show-params {target} -o json",
+    )
+    app_dicts = YAML(typ="safe").load(app_resp)
+    try:
+        patch_dict = app_dicts["spec"]["source"]["helm"]["parameters"]
+    except KeyError:
+        patch_dict = {}
+    return patch_dict
+
+
 def do_retry(cmd):
     def _do_retry(*args, **kwargs):
         max_attempts = 5
@@ -52,14 +66,14 @@ def do_retry(cmd):
 
 
 @do_retry
-def patch_value(target: str, key: str, value: str | bool | int):
+def patch_value(target: str, key: str, value: YamlTypes):
     cmd_temp_ = f"argocd app set {target} -p {key}={value}"
     shell.run_command(cmd_temp_, skip_on_dryrun=True)
     # Rely on argocd autosync to get the cluster into the right state
 
 
 @do_retry
-def push_value(target: str, key: str, value: str | bool | int):
+def push_value(target: str, key: str, value: YamlTypes):
     # Get source details
     app_resp = shell.run_command(
         f"argocd app get {target} -o yaml",
@@ -68,12 +82,7 @@ def push_value(target: str, key: str, value: str | bool | int):
     repo_url = app_dicts["spec"]["source"]["repoURL"]
     path = Path(app_dicts["spec"]["source"]["path"])
 
-    set_values(
-        repo_url,
-        path / "values.yaml",
-        key,
-        value,
-    )
+    set_value(repo_url, path / "values.yaml", key, value)
 
     # Free a possible patched value & refresh repo
     cmd_unset = f"argocd app unset {target} -p {key}"
@@ -83,17 +92,65 @@ def push_value(target: str, key: str, value: str | bool | int):
     # Rely on argocd autosync to get the cluster into the right state
 
 
+@do_retry
+def push_remove_key(target: str, key: str):
+    # Get source details
+    app_resp = shell.run_command(
+        f"argocd app get {target} -o yaml",
+    )
+    app_dicts = YAML(typ="safe").load(app_resp)
+    repo_url = app_dicts["spec"]["source"]["repoURL"]
+    path = Path(app_dicts["spec"]["source"]["path"])
+
+    del_key(repo_url, path / "values.yaml", key)
+
+    # Free a possible patched value, its children & refresh repo
+    cmd_unset = f"argocd app unset {target} -p {key}"
+    shell.run_command(cmd_unset, skip_on_dryrun=True)
+    app_patches = get_patches(target)
+    for patch in app_patches:
+        if re.match(rf"{key}\..*", patch["name"]):
+            cmd_unset_child = f"argocd app unset {target} -p {patch['name']}"
+            shell.run_command(cmd_unset_child, skip_on_dryrun=True)
+    cmd_refresh = f"argocd app get {target} --refresh"
+    shell.run_command(cmd_refresh, skip_on_dryrun=True)
+    # Rely on argocd autosync to get the cluster into the right state
+
+
+def get_services_repo(deployment_repo_url: str) -> str:
+    services_repo_url = ""
+    return services_repo_url
+
+
 class ArgoCommands(Commands):
     """
     A class for implementing the Kubernetes based commands
     """
 
+    params_opt_out = {
+        "deploy": ["args", "wait"],
+    }
+
     def __init__(
         self,
         ctx: ECContext,
     ):
         super().__init__(ctx)
 
+    def delete(self, service_name: str) -> None:
+        self._check_service(service_name)
+        push_remove_key(self.target, f"ec_services.{service_name}")
+
+    def deploy(self, service_name, version, args, confirm_callback=None) -> None:
+        latest_version = self._get_latest_version(service_name)
+        if not version:
+            version = latest_version
+        if confirm_callback:
+            confirm_callback(version)
+        deploy_dict: YamlTypes = {"enabled": True, "targetRevision": version}
+
+        push_value(self.target, f"ec_services.{service_name}", deploy_dict)
+
     def logs(self, service_name, prev):
         self._logs(service_name, prev)
 
@@ -153,7 +210,10 @@ class ArgoCommands(Commands):
 
         if app_dicts:
             for app in app_dicts:
-                resources_dict = app["status"]["resources"]
+                try:
+                    resources_dict = app["status"]["resources"]
+                except KeyError:
+                    continue
 
                 for resource in resources_dict:
                     is_ready = False
@@ -188,7 +248,7 @@ class ArgoCommands(Commands):
                                 )
                                 service_data["ready"].append(is_ready)
                                 service_data["deployed"].append(
-                                    datetime.strftime(time_stamp, TIME_FORMAT)
+                                    datetime.strftime(time_stamp, globals.TIME_FORMAT)
                                 )
 
         services_df = polars.from_dict(service_data, schema=ServicesSchema)

{edge_containers_cli-4.3.1 → edge_containers_cli-4.4.0}/src/edge_containers_cli/cmds/commands.py

@@ -1,10 +1,15 @@
 from abc import ABC, abstractmethod
+from collections.abc import Callable
 from pathlib import Path
 
 import polars
+from natsort import natsorted
 
+from edge_containers_cli import globals
 from edge_containers_cli.definitions import ENV, ECContext
+from edge_containers_cli.git import create_version_map
 from edge_containers_cli.logging import log
+from edge_containers_cli.utils import new_workdir
 
 
 class CommandError(Exception):
@@ -39,7 +44,8 @@ class Commands(ABC):
     Methods not exposed to the CLI should be private
     """
 
-    params_opt_out: dict[str, list[str]] = {}  # Optionally drop parameters from the CLI
+    params_opt_out: dict[str, list[str]] = {}  # Drop parameters from the CLI
+    params_optional: dict[str, list[str]] = {}  # Set optional parameters from the CLI
 
     def __init__(self, ctx: ECContext):
         self._target = ctx.target
@@ -108,10 +114,21 @@ class Commands(ABC):
     def delete(self, service_name: str) -> None:
         raise NotImplementedError
 
-    def deploy(self, service_name: str, version: str, args: str) -> None:
+    def deploy(
+        self,
+        service_name: str,
+        version: str,
+        args: str,
+        confirm_callback: Callable[[str], None] | None = None,
+    ) -> None:
         raise NotImplementedError
 
-    def deploy_local(self, svc_instance: Path, args: str) -> None:
+    def deploy_local(
+        self,
+        svc_instance: Path,
+        args: str,
+        confirm_callback: Callable[[str], None] | None = None,
+    ) -> None:
         raise NotImplementedError
 
     def exec(self, service_name: str) -> None:
@@ -171,3 +188,27 @@ class Commands(ABC):
             pass
         else:
             raise CommandError(f"Service '{service_name}' not found in {self.target}")
+
+    def _get_latest_version(self, service_name) -> str:
+        with new_workdir() as path:
+            version_map = create_version_map(
+                self.repo,
+                Path(globals.SERVICES_DIR),
+                path,
+                shared_files=[globals.SHARED_VALUES],
+            )
+        svc_list = version_map.keys()
+        log.debug(f"Found the following services: {svc_list}")
+        if service_name not in svc_list:
+            raise CommandError(f"Service '{service_name}' not found in {self.repo}")
+
+        version_list = natsorted(version_map[service_name])
+        log.debug(f"Found the following versions of {service_name}: {version_list}")
+        try:
+            version = version_list[-1]
+        except IndexError as err:
+            raise CommandError(
+                f"No versions of '{service_name}' found in {self.repo}"
+            ) from err
+
+        return version

{edge_containers_cli-4.3.1 → edge_containers_cli-4.4.0}/src/edge_containers_cli/cmds/helm.py

@@ -1,3 +1,4 @@
+from collections.abc import Callable
 from pathlib import Path
 from typing import Optional
 
@@ -50,19 +51,25 @@ class Helm:
         for package in service_path.glob("*.tgz"):
             package.unlink(missing_ok=True)
 
-    def deploy_local(self, service_path: Path):
+    def deploy_local(
+        self, service_path: Path, confirm_callback: Callable[[str], None] | None = None
+    ):
         """
         Deploy a local helm chart directly to the cluster with dated beta version
         """
 
+        if confirm_callback:
+            confirm_callback(self.version)
         validate_instance_path(service_path)
         self.cleanup_chart(service_path)
         self._do_deploy(service_path)
 
-    def deploy(self):
+    def deploy(self, confirm_callback: Callable[[str], None] | None = None):
         """
         Clone a helm chart and deploy it to the cluster
         """
+        if confirm_callback:
+            confirm_callback(self.version)
         shell.run_command(
             f"git clone {self.repo} {self.tmp} --depth=1 "
             f"--single-branch --branch={self.version}",