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

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

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

{edge_containers_cli-4.2.0 → edge_containers_cli-4.2.2}/.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.3.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.5.0/how-to.html).

{edge_containers_cli-4.2.0 → edge_containers_cli-4.2.2}/.github/workflows/_pypi.yml

@@ -15,3 +15,5 @@ jobs:
 
       - name: Publish to PyPI using trusted publishing
         uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          attestations: false

{edge_containers_cli-4.2.0 → edge_containers_cli-4.2.2}/.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@c062e08bd532815e2082a85e87e3ef29c3e6d191 # v2.0.8
+        uses: softprops/action-gh-release@e7a8f85e1c67a31e6ed99a94b41bd0b71bbee6b8 # v2.0.9
         with:
           prerelease: ${{ contains(github.ref_name, 'a') || contains(github.ref_name, 'b') || contains(github.ref_name, 'rc') }}
           files: "*"

{edge_containers_cli-4.2.0 → edge_containers_cli-4.2.2}/.vscode/launch.json

@@ -18,6 +18,19 @@
                 // Enable break on exception when debugging tests (see: tests/conftest.py)
                 "PYTEST_RAISE": "1",
             },
+        },
+        {
+            "name": "Debug Monitor",
+            "type": "debugpy",
+            "request": "launch",
+            "module": "edge_containers_cli",
+            "args": [
+                "monitor"
+            ],
+            "console": "integratedTerminal",
+            "env": {
+                "EC_CLI_BACKEND": "DEMO",
+            },
         }
     ]
 }

{edge_containers_cli-4.2.0 → edge_containers_cli-4.2.2}/Dockerfile

@@ -1,7 +1,7 @@
 # The devcontainer should use the developer target and run as root with podman
 # or docker with user namespaces.
 ARG PYTHON_VERSION=3.11
-FROM python:${PYTHON_VERSION} as developer
+FROM python:${PYTHON_VERSION} AS developer
 
 # Add any system dependencies for the developer/build environment here
 RUN apt-get update && apt-get install -y --no-install-recommends \

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: edge-containers-cli
-Version: 4.2.0
+Version: 4.2.2
 Summary: CLI for deploying and managing epics containers IOCs and services
 Author-email: Giles Knap <giles.knap@gmail.com>
 License:                                  Apache License
@@ -236,12 +236,16 @@ Requires-Dist: types-mock; extra == "dev"
 [![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)
 [![PyPI](https://img.shields.io/pypi/v/edge-containers-cli.svg)](https://pypi.org/project/edge-containers-cli)
-[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
 
 # edge_containers_cli
 
+## About
+
 Edge containers command line interface: a tool for deploying and managing
-IOCs and services in a beamline or accelerator cluster.
+IOCs in a beamline or accelerator cluster. The tool is a thin wrapper around
+familiar command line tools such as git, kubectl, helm and argocd - and can
+be used to learn the underlying commands being used.
 
 For detailed documentation on the framework that this supports see:
 https://epics-containers.github.io/
@@ -254,7 +258,25 @@ Releases        | <https://github.com/epics-containers/edge-containers-cli/relea
 
 
 To discover the CLI commands, create a python virtual environment,
-and perform the following::
+and perform the following:
 
     pip install edge-containers-cli
     ec --version
+
+## Monitor
+
+Some commands of the tool are also exposed as a TUI which can additionally be served as
+a web application.
+
+To demo the TUI as a web application:
+
+    pip install textual-dev
+    textual serve "ec -b DEMO monitor"
+
+Dashboard:
+
+![screenshot](docs/images/ec-web.png)
+
+IOC logs:
+
+![screenshot](docs/images/ec-logs.png)

{edge_containers_cli-4.2.0 → edge_containers_cli-4.2.2}/README.md

@@ -1,12 +1,16 @@
 [![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)
 [![PyPI](https://img.shields.io/pypi/v/edge-containers-cli.svg)](https://pypi.org/project/edge-containers-cli)
-[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
 
 # edge_containers_cli
 
+## About
+
 Edge containers command line interface: a tool for deploying and managing
-IOCs and services in a beamline or accelerator cluster.
+IOCs in a beamline or accelerator cluster. The tool is a thin wrapper around
+familiar command line tools such as git, kubectl, helm and argocd - and can
+be used to learn the underlying commands being used.
 
 For detailed documentation on the framework that this supports see:
 https://epics-containers.github.io/
@@ -19,7 +23,25 @@ Releases        | <https://github.com/epics-containers/edge-containers-cli/relea
 
 
 To discover the CLI commands, create a python virtual environment,
-and perform the following::
+and perform the following:
 
     pip install edge-containers-cli
     ec --version
+
+## Monitor
+
+Some commands of the tool are also exposed as a TUI which can additionally be served as
+a web application.
+
+To demo the TUI as a web application:
+
+    pip install textual-dev
+    textual serve "ec -b DEMO monitor"
+
+Dashboard:
+
+![screenshot](docs/images/ec-web.png)
+
+IOC logs:
+
+![screenshot](docs/images/ec-logs.png)

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

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '4.2.0'
-__version_tuple__ = version_tuple = (4, 2, 0)
+__version__ = version = '4.2.2'
+__version_tuple__ = version_tuple = (4, 2, 2)

{edge_containers_cli-4.2.0 → edge_containers_cli-4.2.2}/src/edge_containers_cli/cli.py

@@ -238,7 +238,7 @@ def start(
 ):
     """Start a service"""
     try:
-        backend.commands.start(service_name, commit)
+        backend.commands.start(service_name, commit=commit)
     except GitError as e:
         msg = f"{str(e)} - Commit failed. Try 'ec start <service> --no-commit to set values without updating git"
         raise GitError(msg) from e
@@ -255,7 +255,7 @@ def stop(
 ):
     """Stop a service"""
     try:
-        backend.commands.stop(service_name, commit)
+        backend.commands.stop(service_name, commit=commit)
     except GitError as e:
         msg = f"{str(e)} - Commit failed. Try ec stop <service> --no-commit to set values without updating git"
         raise GitError(msg) from e

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

@@ -7,6 +7,7 @@ Relies on the Helm class for deployment aspects.
 import webbrowser
 from datetime import datetime
 from pathlib import Path
+from time import sleep
 
 import polars
 from ruamel.yaml import YAML
@@ -15,6 +16,7 @@ from edge_containers_cli.cmds.commands import CommandError, Commands, ServicesDa
 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.logging import log
 from edge_containers_cli.shell import ShellError, shell
 
 
@@ -26,8 +28,23 @@ def extract_ns_app(target: str) -> tuple[str, str]:
 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)
-    cmd_sync = f"argocd app sync {target} --apply-out-of-sync-only"
-    shell.run_command(cmd_sync, 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
 
 
 def push_value(target: str, key: str, value: str | bool | int):
@@ -84,14 +101,14 @@ class ArgoCommands(Commands):
         )
         shell.run_command(cmd, skip_on_dryrun=True)
 
-    def start(self, service_name, commit):
+    def start(self, service_name, commit=False):
         self._check_service(service_name)
         if commit:
             push_value(self.target, f"ec_services.{service_name}.enabled", True)
         else:
             patch_value(self.target, f"ec_services.{service_name}.enabled", True)
 
-    def stop(self, service_name, commit):
+    def stop(self, service_name, commit=False):
         self._check_service(service_name)
         if commit:
             push_value(self.target, f"ec_services.{service_name}.enabled", False)

{edge_containers_cli-4.2.0 → edge_containers_cli-4.2.2}/src/edge_containers_cli/cmds/commands.py

@@ -47,6 +47,34 @@ class Commands(ABC):
         self._repo = ctx.repo
         self._log_url = ctx.log_url
 
+    def __getattribute__(self, attr_name):
+        """Override to wrap each abstract method"""
+        attr = super().__getattribute__(attr_name)
+        if callable(attr):
+            if attr_name[0] == "_":
+                log_f = log.debug
+            else:
+                log_f = log.info
+
+            def wrapper(*args, **kwargs):
+                call_msg = (
+                    f"Calling: {attr_name} {', '.join(str(item) for item in args)}"
+                )
+                return_msg = (
+                    f"Returned: {attr_name} {', '.join(str(item) for item in args)}"
+                )
+                if kwargs:
+                    call_msg = f"{call_msg} [{', '.join(f'{k}={v}' for k, v in kwargs.items())}]"
+                    return_msg = f"{return_msg} [{', '.join(f'{k}={v}' for k, v in kwargs.items())}]"
+                log_f(call_msg)
+                result = attr(*args, **kwargs)
+                log_f(return_msg)
+                return result
+
+            return wrapper
+        else:
+            return attr
+
     @property
     def target(self):
         if not self._target_valid:  # Only validate once
@@ -103,11 +131,11 @@ class Commands(ABC):
         raise NotImplementedError
 
     @abstractmethod
-    def start(self, service_name: str, commit: bool) -> None:
+    def start(self, service_name: str, commit: bool = False) -> None:
         raise NotImplementedError
 
     @abstractmethod
-    def stop(self, service_name: str, commit: bool) -> None:
+    def stop(self, service_name: str, commit: bool = False) -> None:
         raise NotImplementedError
 
     def template(self, svc_instance: Path, args: str) -> None:

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

@@ -6,6 +6,7 @@ Relies on the Helm class for deployment aspects.
 
 import time
 from datetime import datetime
+from random import randrange, seed
 
 import polars
 
@@ -13,7 +14,9 @@ from edge_containers_cli.cmds.commands import CommandError, Commands, ServicesDa
 from edge_containers_cli.definitions import ECContext
 from edge_containers_cli.globals import TIME_FORMAT
 
-DELAY = 0.0
+DELAY = 2.0
+NUM_SERVICES = 8
+seed(237)
 
 
 def process_t(time_string) -> str:
@@ -22,13 +25,12 @@ def process_t(time_string) -> str:
 
 
 sample_data = {
-    "name": ["demo-ea-01", "demo-ea-02", "demo-ea-03"],  # type: ignore
-    "version": ["2024.10.1", "2024.10.1b", "2024.10.1"],
-    "ready": [True, True, False],
+    "name": [f"demo-ea-0{cnt}" for cnt in range(NUM_SERVICES)],
+    "version": ["1.0." + str(25 - cnt) for cnt in range(NUM_SERVICES)],
+    "ready": [True] * NUM_SERVICES,
     "deployed": [
-        process_t("2024-10-22T11:23:10Z"),
-        process_t("2024-10-28T14:53:55Z"),
-        process_t("2024-10-22T12:51:50Z"),
+        process_t(f"2024-10-22T11:23:0{randrange(1,9, )}Z")
+        for cnt in range(NUM_SERVICES)
     ],
 }
 sample_ServicesDataFrame = ServicesDataFrame(polars.from_dict(sample_data))
@@ -69,6 +71,11 @@ class DemoCommands(Commands):
         self._target_valid = False
         self._stateDF = sample_ServicesDataFrame
 
+        self.lorem_min = 10
+        self.lorem_max = 50
+        self.lorem_step = 5
+        self.lorem_count = self.lorem_min
+
     @demo_message
     def logs(self, service_name, prev):
         self._logs(service_name, prev)
@@ -83,11 +90,14 @@ class DemoCommands(Commands):
 
     @demo_message
     def restart(self, service_name):
-        self.stop(service_name, False)
-        self.start(service_name, False)
+        self._stop(service_name, commit=False)
+        self._start(service_name, commit=False)
 
     @demo_message
-    def start(self, service_name, commit):
+    def start(self, service_name, commit=False):
+        self._start(service_name, commit=commit)
+
+    def _start(self, service_name, commit=False):
         self._check_service(service_name)
         time.sleep(DELAY)
         self._stateDF = self._stateDF.with_columns(
@@ -98,7 +108,10 @@ class DemoCommands(Commands):
         )
 
     @demo_message
-    def stop(self, service_name, commit):
+    def stop(self, service_name, commit=False):
+        self._stop(service_name, commit=commit)
+
+    def _stop(self, service_name, commit=False):
         self._check_service(service_name)
         time.sleep(DELAY)
         self._stateDF = self._stateDF.with_columns(
@@ -110,7 +123,11 @@ class DemoCommands(Commands):
 
     def _get_logs(self, service_name, prev) -> str:
         self._check_service(service_name)
-        logs_list = ["Lorem ipsum dolor sit amet"] * 25
+        if self.lorem_count < self.lorem_max:
+            self.lorem_count += self.lorem_step
+        else:
+            self.lorem_count = self.lorem_min
+        logs_list = ["Lorem ipsum dolor sit amet"] * self.lorem_count
         return "\n".join(logs_list)
 
     def _get_services(self, running_only) -> ServicesDataFrame:

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

@@ -89,14 +89,14 @@ class K8sCommands(Commands):
             f"kubectl delete -n {self.target} {pod_name}", skip_on_dryrun=True
         )
 
-    def start(self, service_name, commit):
+    def start(self, service_name, commit=False):
         self._check_service(service_name)
         shell.run_command(
             f"kubectl scale -n {self.target} statefulset {service_name} --replicas=1",
             skip_on_dryrun=True,
         )
 
-    def stop(self, service_name, commit):
+    def stop(self, service_name, commit=False):
         self._check_service(service_name)
         shell.run_command(
             f"kubectl scale -n {self.target} statefulset {service_name} --replicas=0 ",