edge-containers-cli 4.3.1__tar.gz → 4.4.1b1__tar.gz

{edge_containers_cli-4.3.1 → edge_containers_cli-4.4.1b1}/.copier-answers.yml

@@ -5,7 +5,7 @@ author_email: giles.knap@gmail.com
 author_name: Giles Knap
 description: CLI for deploying and managing epics containers IOCs and services
 distribution_name: edge-containers-cli
-docker: false
+docker: true
 docs_type: README
 git_platform: github.com
 github_org: epics-containers

edge_containers_cli-4.4.1b1/.dockerignore

@@ -0,0 +1,4 @@
+Dockerfile
+README.md
+.venv*
+venv*

edge_containers_cli-4.4.1b1/.github/workflows/_container.yml

@@ -0,0 +1,60 @@
+on:
+  workflow_call:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          # Need this to get version number from last tag
+          fetch-depth: 0
+
+      - name: Set up Docker Buildx
+        id: buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Log in to GitHub Docker Registry
+        if: github.event_name != 'pull_request'
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Build and export to Docker local cache
+        uses: docker/build-push-action@v6
+        env:
+          DOCKER_BUILD_RECORD_UPLOAD: false
+        with:
+          context: .
+          # Need load and tags so we can test it below
+          load: true
+          tags: tag_for_testing
+
+      - name: Test cli works in cached runtime image
+        run: docker run --rm tag_for_testing --version
+
+      - name: Create tags for publishing image
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: ghcr.io/${{ github.repository }}
+          tags: |
+            type=ref,event=tag
+            type=raw,value=latest
+
+      - name: Push cached image to container registry
+        if: github.ref_type == 'tag'
+        uses: docker/build-push-action@v6
+        env:
+          DOCKER_BUILD_RECORD_UPLOAD: false
+        # This does not build the image again, it will find the image in the
+        # Docker cache and publish it
+        with:
+          context: .
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}

{edge_containers_cli-4.3.1 → edge_containers_cli-4.4.1b1}/.github/workflows/ci.yml

@@ -34,6 +34,14 @@ jobs:
     secrets:
       CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
 
+  container:
+    needs: check
+    if: needs.check.outputs.branch-pr == ''
+    uses: ./.github/workflows/_container.yml
+    permissions:
+      contents: read
+      packages: write
+
   dist:
     needs: check
     if: needs.check.outputs.branch-pr == ''

edge_containers_cli-4.4.1b1/Dockerfile

@@ -0,0 +1,41 @@
+# The devcontainer should use the developer target and run as root with podman
+# or docker with user namespaces.
+ARG PYTHON_VERSION=3.12
+FROM python:${PYTHON_VERSION} AS developer
+
+# Set up a virtual environment and put it in PATH
+RUN python -m venv /venv
+ENV PATH=/venv/bin:$PATH
+
+# install tools used by ec #####################################################
+
+# ArgoCD CLI - see https://github.com/argoproj/argo-cd/releases
+RUN VERSION=v2.14.10 && \
+    curl -sSL -o argocd https://github.com/argoproj/argo-cd/releases/download/$VERSION/argocd-linux-amd64 && \
+    echo "d1750274a336f0a090abf196a832cee14cb9f1c2fc3d20d80b0dbfeff83550fa argocd" | sha256sum -c && \
+    install -m 555 argocd /usr/local/bin/argocd && \
+     rm argocd
+
+# kubectl - see https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/
+RUN VERSION=v1.32.3 && \
+    curl -sSLO https://dl.k8s.io/release/$VERSION/bin/linux/amd64/kubectl && \
+    echo "ab209d0c5134b61486a0486585604a616a5bb2fc07df46d304b3c95817b2d79f kubectl" | sha256sum -c && \
+    install -m 555 kubectl /usr/local/bin/kubectl && \
+    rm kubectl
+
+# helm - see https://github.com/helm/helm/releases
+RUN VERSION=v3.17.3 && \
+    curl -sSL -o helm.tar.gz https://get.helm.sh/helm-$VERSION-linux-amd64.tar.gz && \
+    echo "ee88b3c851ae6466a3de507f7be73fe94d54cbf2987cbaa3d1a3832ea331f2cd helm.tar.gz" | sha256sum -c && \
+    tar -xzf helm.tar.gz --strip-components=1 linux-amd64/helm && \
+    install -m 555 helm /usr/local/bin/helm && \
+    rm helm.tar.gz
+
+# install the context into the venv
+COPY . /context
+WORKDIR /context
+RUN touch dev-requirements.txt && \
+    pip install -c dev-requirements.txt .
+
+ENTRYPOINT ["ec"]
+CMD ["--version"]

{edge_containers_cli-4.3.1 → edge_containers_cli-4.4.1b1}/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.1b1
 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.1b1}/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.1b1}/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.1b1}/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.1b1'
+__version_tuple__ = version_tuple = (4, 4, 1, 'b1')

{edge_containers_cli-4.3.1 → edge_containers_cli-4.4.1b1}/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.1b1}/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.1b1}/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