edge-containers-cli 4.2.2__tar.gz → 4.3.0__tar.gz

{edge_containers_cli-4.2.2 → edge_containers_cli-4.3.0}/.copier-answers.yml

@@ -1,5 +1,5 @@
 # Changes here will be overwritten by Copier
-_commit: 2.5.0
+_commit: 2.6.0
 _src_path: gh:DiamondLightSource/python-copier-template
 author_email: giles.knap@gmail.com
 author_name: Giles Knap

{edge_containers_cli-4.2.2 → edge_containers_cli-4.3.0}/.devcontainer/devcontainer.json

@@ -28,11 +28,11 @@
         }
     },
     "features": {
-        // Some default things like git config
-        "ghcr.io/devcontainers/features/common-utils:2": {
-            "upgradePackages": false
-        }
+        // add in eternal history and other bash features
+        "ghcr.io/diamondlightsource/devcontainer-features/bash-config:1.0.0": {}
     },
+    // Create the config folder for the bash-config feature
+    "initializeCommand": "mkdir -p ${localEnv:HOME}/.config/bash-config",
     "runArgs": [
         // Allow the container to access the host X11 display and EPICS CA
         "--net=host",

{edge_containers_cli-4.2.2 → edge_containers_cli-4.3.0}/.github/CONTRIBUTING.md

@@ -24,4 +24,4 @@ It is recommended that developers use a [vscode devcontainer](https://code.visua
 
 This project was created using the [Diamond Light Source Copier Template](https://github.com/DiamondLightSource/python-copier-template) for Python projects.
 
-For more information on common tasks like setting up a developer environment, running the tests, and setting a pre-commit hook, see the template's [How-to guides](https://diamondlightsource.github.io/python-copier-template/2.5.0/how-to.html).
+For more information on common tasks like setting up a developer environment, running the tests, and setting a pre-commit hook, see the template's [How-to guides](https://diamondlightsource.github.io/python-copier-template/2.6.0/how-to.html).

{edge_containers_cli-4.2.2 → edge_containers_cli-4.3.0}/.github/workflows/_release.yml

@@ -23,7 +23,7 @@ jobs:
       - name: Create GitHub Release
         # We pin to the SHA, not the tag, for security reasons.
         # https://docs.github.com/en/actions/learn-github-actions/security-hardening-for-github-actions#using-third-party-actions
-        uses: softprops/action-gh-release@e7a8f85e1c67a31e6ed99a94b41bd0b71bbee6b8 # v2.0.9
+        uses: softprops/action-gh-release@c95fe1489396fe8a9eb87c0abf8aa5b2ef267fda # v2.2.1
         with:
           prerelease: ${{ contains(github.ref_name, 'a') || contains(github.ref_name, 'b') || contains(github.ref_name, 'rc') }}
           files: "*"

{edge_containers_cli-4.2.2 → edge_containers_cli-4.3.0}/.github/workflows/_test.yml

@@ -54,7 +54,7 @@ jobs:
         run: tox -e tests
 
       - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@v4
+        uses: codecov/codecov-action@v5
         with:
           name: ${{ inputs.python-version }}/${{ inputs.runs-on }}
           files: cov.xml

{edge_containers_cli-4.2.2 → edge_containers_cli-4.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: edge-containers-cli
-Version: 4.2.2
+Version: 4.3.0
 Summary: CLI for deploying and managing epics containers IOCs and services
 Author-email: Giles Knap <giles.knap@gmail.com>
 License:                                  Apache License

{edge_containers_cli-4.2.2 → edge_containers_cli-4.3.0}/src/edge_containers_cli/_version.py

@@ -1,8 +1,13 @@
-# file generated by setuptools_scm
+# file generated by setuptools-scm
 # don't change, don't track in version control
+
+__all__ = ["__version__", "__version_tuple__", "version", "version_tuple"]
+
 TYPE_CHECKING = False
 if TYPE_CHECKING:
-    from typing import Tuple, Union
+    from typing import Tuple
+    from typing import Union
+
     VERSION_TUPLE = Tuple[Union[int, str], ...]
 else:
     VERSION_TUPLE = object
@@ -12,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '4.2.2'
-__version_tuple__ = version_tuple = (4, 2, 2)
+__version__ = version = '4.3.0'
+__version_tuple__ = version_tuple = (4, 3, 0)

{edge_containers_cli-4.2.2 → edge_containers_cli-4.3.0}/src/edge_containers_cli/cmds/argo_commands.py

@@ -12,7 +12,12 @@ from time import sleep
 import polars
 from ruamel.yaml import YAML
 
-from edge_containers_cli.cmds.commands import CommandError, Commands, ServicesDataFrame
+from edge_containers_cli.cmds.commands import (
+    CommandError,
+    Commands,
+    ServicesDataFrame,
+    ServicesSchema,
+)
 from edge_containers_cli.definitions import ECContext
 from edge_containers_cli.git import set_values
 from edge_containers_cli.globals import TIME_FORMAT
@@ -25,28 +30,35 @@ def extract_ns_app(target: str) -> tuple[str, str]:
     return namespace, app
 
 
+def do_retry(cmd):
+    def _do_retry(*args, **kwargs):
+        max_attempts = 5
+        attempt = 1
+        sleep_time = 1
+        while attempt <= max_attempts:
+            try:
+                cmd(*args, **kwargs)
+                return None
+            except ShellError:
+                if attempt == max_attempts:
+                    log.debug(f"Retry failed after {max_attempts} attempts")
+                    raise
+                else:
+                    log.debug(f"Retry attempt {attempt} failed. Retrying...")
+                    sleep(sleep_time)
+                    attempt += 1
+
+    return _do_retry
+
+
+@do_retry
 def patch_value(target: str, key: str, value: str | bool | int):
     cmd_temp_ = f"argocd app set {target} -p {key}={value}"
     shell.run_command(cmd_temp_, skip_on_dryrun=True)
-    max_attempts = 3
-    attempt = 1
-    sleep_time = 2
-    while attempt <= max_attempts:
-        try:
-            # Sync may conflict with autosync "another operation is already in progress"
-            cmd_sync = f"argocd app sync {target} --apply-out-of-sync-only"
-            shell.run_command(cmd_sync, skip_on_dryrun=True)
-            return None
-        except ShellError:
-            if attempt == max_attempts:
-                log.debug(f"Argo patch failed after {max_attempts} attempts")
-                raise
-            else:
-                log.debug(f"Argo patch attempt {attempt} failed. Retrying...")
-                sleep(sleep_time)
-                attempt += 1
+    # 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):
     # Get source details
     app_resp = shell.run_command(
@@ -63,11 +75,12 @@ def push_value(target: str, key: str, value: str | bool | int):
         value,
     )
 
-    # Sync & release a possible patched value
-    cmd_sync = f"argocd app sync {target} --apply-out-of-sync-only"
-    shell.run_command(cmd_sync, skip_on_dryrun=True)
+    # Free a possible patched value & refresh repo
     cmd_unset = f"argocd app unset {target} -p {key}"
     shell.run_command(cmd_unset, 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
 
 
 class ArgoCommands(Commands):
@@ -96,8 +109,7 @@ class ArgoCommands(Commands):
         self._check_service(service_name)
         namespace, app = extract_ns_app(self.target)
         cmd = (
-            f"argocd app delete-resource {namespace}/{service_name} "
-            f"--kind StatefulSet"
+            f"argocd app delete-resource {namespace}/{service_name} --kind StatefulSet"
         )
         shell.run_command(cmd, skip_on_dryrun=True)
 
@@ -139,45 +151,47 @@ class ArgoCommands(Commands):
         )
         app_dicts = YAML(typ="safe").load(app_resp)
 
-        if not app_dicts:
-            raise CommandError(f"No ec-services found in {self.target}")
-        for app in app_dicts:
-            resources_dict = app["status"]["resources"]
-
-            for resource in resources_dict:
-                is_ready = False
-                if resource["kind"] == "StatefulSet":
-                    name = app["metadata"]["name"]
-
-                    # check if replicas ready
-                    mani_resp = shell.run_command(
-                        f"argocd app manifests {namespace}/{name} --source live",
-                    )
-                    for resource_manifest in mani_resp.split("---")[1:]:
-                        manifest = YAML(typ="safe").load(resource_manifest)
-                        if not manifest:
-                            continue
-                        kind = manifest["kind"]
-                        resource_name = manifest["metadata"]["name"]
-                        if kind == "StatefulSet" and resource_name == name:
-                            try:
-                                is_ready = bool(manifest["status"]["readyReplicas"])
-                            except (KeyError, TypeError):  # Not ready if doesnt exist
-                                is_ready = False
-                            time_stamp = datetime.strptime(
-                                manifest["metadata"]["creationTimestamp"],
-                                "%Y-%m-%dT%H:%M:%SZ",
-                            )
-                            service_data["name"].append(name)
-                            service_data["version"].append(
-                                app["spec"]["source"]["targetRevision"]
-                            )
-                            service_data["ready"].append(is_ready)
-                            service_data["deployed"].append(
-                                datetime.strftime(time_stamp, TIME_FORMAT)
-                            )
-
-        services_df = polars.from_dict(service_data)
+        if app_dicts:
+            for app in app_dicts:
+                resources_dict = app["status"]["resources"]
+
+                for resource in resources_dict:
+                    is_ready = False
+                    if resource["kind"] == "StatefulSet":
+                        name = app["metadata"]["name"]
+
+                        # check if replicas ready
+                        mani_resp = shell.run_command(
+                            f"argocd app manifests {namespace}/{name} --source live",
+                        )
+                        for resource_manifest in mani_resp.split("---")[1:]:
+                            manifest = YAML(typ="safe").load(resource_manifest)
+                            if not manifest:
+                                continue
+                            kind = manifest["kind"]
+                            resource_name = manifest["metadata"]["name"]
+                            if kind == "StatefulSet" and resource_name == name:
+                                try:
+                                    is_ready = bool(manifest["status"]["readyReplicas"])
+                                except (
+                                    KeyError,
+                                    TypeError,
+                                ):  # Not ready if doesnt exist
+                                    is_ready = False
+                                time_stamp = datetime.strptime(
+                                    manifest["metadata"]["creationTimestamp"],
+                                    "%Y-%m-%dT%H:%M:%SZ",
+                                )
+                                service_data["name"].append(name)
+                                service_data["version"].append(
+                                    app["spec"]["source"]["targetRevision"]
+                                )
+                                service_data["ready"].append(is_ready)
+                                service_data["deployed"].append(
+                                    datetime.strftime(time_stamp, TIME_FORMAT)
+                                )
+
+        services_df = polars.from_dict(service_data, schema=ServicesSchema)
 
         if running_only:
             services_df = services_df.filter(polars.col("ready").eq(True))

{edge_containers_cli-4.2.2 → edge_containers_cli-4.3.0}/src/edge_containers_cli/cmds/demo_commands.py

@@ -29,7 +29,7 @@ sample_data = {
     "version": ["1.0." + str(25 - cnt) for cnt in range(NUM_SERVICES)],
     "ready": [True] * NUM_SERVICES,
     "deployed": [
-        process_t(f"2024-10-22T11:23:0{randrange(1,9, )}Z")
+        process_t(f"2024-10-22T11:23:0{randrange(1, 9)}Z")
         for cnt in range(NUM_SERVICES)
     ],
 }

{edge_containers_cli-4.2.2 → edge_containers_cli-4.3.0}/src/edge_containers_cli/cmds/helm.py

@@ -87,7 +87,7 @@ class Helm:
             with open("Chart.yaml") as fp:
                 chart_yaml = YAML(typ="safe").load(fp)
             package_path = (
-                service_folder / f'{chart_yaml["name"]}-{chart_yaml["version"]}.tgz'
+                service_folder / f"{chart_yaml['name']}-{chart_yaml['version']}.tgz"
             )
 
         # use helm to install the chart

{edge_containers_cli-4.2.2 → edge_containers_cli-4.3.0}/src/edge_containers_cli/cmds/k8s_commands.py

@@ -124,34 +124,46 @@ class K8sCommands(Commands):
             f'kubectl get statefulset -l "is_ioc==true" -n {self.target} -o yaml',
         )
         sts_dicts = YAML(typ="safe").load(kubectl_res)
-        if not sts_dicts["items"]:
-            raise CommandError(f"No ec-services found in {self.target}")
         service_data = {
             "name": [],  # type: ignore
             "ready": [],
             "deployed": [],
         }
-        for sts in sts_dicts["items"]:
-            name = sts["metadata"]["name"]
-            time_stamp = datetime.strptime(
-                sts["metadata"]["creationTimestamp"], "%Y-%m-%dT%H:%M:%SZ"
-            )
-            try:
-                is_ready = bool(sts["status"]["readyReplicas"])
-            except KeyError:  # Not ready if doesnt exist
-                is_ready = False
-
-            # Fill app data
-            service_data["name"].append(name)
-            service_data["ready"].append(is_ready)
-            service_data["deployed"].append(datetime.strftime(time_stamp, TIME_FORMAT))
-
-        services_df = polars.from_dict(service_data)
+        if sts_dicts["items"]:
+            for sts in sts_dicts["items"]:
+                name = sts["metadata"]["name"]
+                time_stamp = datetime.strptime(
+                    sts["metadata"]["creationTimestamp"], "%Y-%m-%dT%H:%M:%SZ"
+                )
+                try:
+                    is_ready = bool(sts["status"]["readyReplicas"])
+                except KeyError:  # Not ready if doesnt exist
+                    is_ready = False
+
+                # Fill app data
+                service_data["name"].append(name)
+                service_data["ready"].append(is_ready)
+                service_data["deployed"].append(
+                    datetime.strftime(time_stamp, TIME_FORMAT)
+                )
+
+        services_df = polars.from_dict(
+            service_data,
+            schema=polars.Schema(
+                {
+                    "name": polars.String,
+                    "ready": polars.Boolean,
+                    "deployed": polars.String,
+                }
+            ),
+        )
 
         # Adds the version for all services
         helm_out = str(shell.run_command(f"helm list -n {self.target} -o json"))
         if helm_out == "[]\n":
-            helm_df = polars.DataFrame({"name": [""], "version": [""]})
+            helm_df = polars.DataFrame(
+                schema=polars.Schema({"name": polars.String, "version": polars.String})
+            )
         else:
             helm_df = polars.read_json(StringIO(str(helm_out)))
             helm_df = helm_df.rename({"app_version": "version"})