Merge pull request #52 from epics-containers/dev

use container version of yajsv

Author: gilesknap

src/epics_containers_cli/__main__.py

@@ -94,12 +94,22 @@ def ps(
     ),
 ):
     """List the IOCs running in the current namespace"""
-    if ctx.obj.namespace == "":
+    if ctx.obj.namespace == glob_vars.LOCAL_NAMESPACE:
         IocLocalCommands(ctx.obj).ps(all, wide)
     else:
         IocK8sCommands(ctx.obj).ps(all, wide)
 
 
+@cli.command()
+def env(
+    ctx: typer.Context,
+    verbose: bool = typer.Option(
+        False, "-v", "--verbose", help="show all relevant environment variables"
+    ),
+):
+    IocLocalCommands(ctx.obj).environment(verbose == verbose)
+
+
 # test with:
 #     python -m epics_containers_cli
 if __name__ == "__main__":

src/epics_containers_cli/docker.py

@@ -61,7 +61,7 @@ def _check_docker(self):
         result = run_command(
             f"{self.docker} buildx version", interactive=False, error_OK=True
         )
-        self.is_buildx = bool(result) and "buildah" not in result
+        self.is_buildx = "docker/buildx" in result
 
         log.debug(f"buildx={self.is_buildx} ({result})")
 
@@ -204,3 +204,19 @@ def is_running(self, container: str, retry=1, error=False):
                 log.error(f"{container} is not running")
                 raise typer.Exit(1)
             return False
+
+    def run_tool(
+        self, image: str, args: str = "", entrypoint: str = "", interactive=False
+    ):
+        """
+        run a command in a container - mount the current directory
+        so that the command can see files passed on the CLI
+        """
+        if entrypoint:
+            entrypoint = f" --entrypoint {entrypoint}"
+        cwd = Path.cwd().resolve()
+        mount = f"-w {cwd} -v {cwd}:{cwd} -v /tmp:/tmp"
+        run_command(
+            f"{self.docker} run{entrypoint} --rm {mount} {image} {args}",
+            interactive=True,
+        )

src/epics_containers_cli/globals.py

@@ -31,14 +31,25 @@ def __str__(self):
 
 
 # common stings used in paths
+# folder containing the beamline IOC Instance Helm Chart
 BEAMLINE_CHART_FOLDER = "beamline-chart"
+# location of IOC Instance configuration in a beamline ioc Instance folder
 CONFIG_FOLDER = "config"
-CONFIG_FILE = "ioc.yaml"
+# location of IOC Instance configuration inside a Generic IOC container
 IOC_CONFIG_FOLDER = "/epics/ioc/config/"
+# file name of IOC Instance ibek configuration inside a Generic IOC container
+CONFIG_FILE = "ioc.yaml"
+# location of default IOC start script inside Generic IOC containers
 IOC_START = "/epics/ioc/start.sh"
+# default container name for local testing
 IOC_NAME = "test-ioc"
+# namespace name for deploying IOC instances into the local podman/docker
+LOCAL_NAMESPACE = "local"
+
 # these should be set to 0 or 1 in the environment - blank is treated as false
+# Enable debug logging in all ec commands
 EC_DEBUG = bool(os.environ.get("EC_DEBUG", 0))
+# Enable printing of all shell commands run by ec
 EC_VERBOSE = bool(os.environ.get("EC_VERBOSE", 0))
 
 """
@@ -60,7 +71,7 @@ def __str__(self):
 break and regex and replacement are separated by space
 """
 EC_REGISTRY_MAPPING_REGEX = os.environ.get(
-    "EC_REGISTRY_MAPPING",
+    "EC_REGISTRY_MAPPING_REGEX",
     r"""
 .*github.com:(.*)\/(.*)\.git ghcr.io/\1/\2
 .*gitlab.diamond.ac.uk.*\/(.*).git gcr.io/diamond-privreg/controls/prod/ioc/\1

src/epics_containers_cli/ioc/helm.py

@@ -9,7 +9,7 @@
 import epics_containers_cli.globals as glob_vars
 from epics_containers_cli.globals import BEAMLINE_CHART_FOLDER, CONFIG_FOLDER
 from epics_containers_cli.shell import run_command
-from epics_containers_cli.utils import check_ioc_instance_path
+from epics_containers_cli.utils import check_ioc_instance_path, log
 
 
 class Helm:
@@ -86,6 +86,12 @@ def deploy(self):
             f"--single-branch --branch={self.version}",
             interactive=False,
         )
+        if not self.ioc_config_folder.exists():
+            log.error(
+                f"{self.ioc_name} does not exist in {self.beamline_repo} version {self.version}"
+            )
+            raise typer.Exit(1)
+
         self._do_deploy(self.ioc_config_folder)
 
     def _do_deploy(self, config_folder: Path):

src/epics_containers_cli/ioc/ioc_cli.py

@@ -4,6 +4,7 @@
 import typer
 
 from epics_containers_cli.git import versions
+from epics_containers_cli.globals import LOCAL_NAMESPACE
 from epics_containers_cli.ioc.k8s_commands import IocK8sCommands
 from epics_containers_cli.ioc.local_commands import IocLocalCommands
 from epics_containers_cli.logging import log
@@ -19,7 +20,7 @@ def attach(
     """
     Attach to the IOC shell of a live IOC
     """
-    if ctx.obj.namespace == "":
+    if ctx.obj.namespace == LOCAL_NAMESPACE:
         IocLocalCommands(ctx.obj, ioc_name).attach()
     else:
         IocK8sCommands(ctx.obj, ioc_name).attach()
@@ -33,7 +34,7 @@ def delete(
     """
     Remove an IOC helm deployment from the cluster
     """
-    if ctx.obj.namespace == "":
+    if ctx.obj.namespace == LOCAL_NAMESPACE:
         IocLocalCommands(ctx.obj, ioc_name).delete()
     else:
         IocK8sCommands(ctx.obj, ioc_name).delete()
@@ -54,7 +55,7 @@ def template(
     """
     print out the helm template generated from a local ioc instance
     """
-    if ctx.obj.namespace == "":
+    if ctx.obj.namespace == LOCAL_NAMESPACE:
         typer.echo("Not applicable to local deployments")
     else:
         IocK8sCommands(ctx.obj).template(ioc_instance, args)
@@ -76,7 +77,7 @@ def deploy_local(
     """
     Deploy a local IOC helm chart directly to the cluster with dated beta version
     """
-    if ctx.obj.namespace == "":
+    if ctx.obj.namespace == LOCAL_NAMESPACE:
         IocLocalCommands(ctx.obj).deploy_local(ioc_instance, yes, args)
     else:
         IocK8sCommands(ctx.obj).deploy_local(ioc_instance, yes, args)
@@ -94,7 +95,7 @@ def deploy(
     """
     Pull an IOC helm chart version from the domain repo and deploy it to the cluster
     """
-    if ctx.obj.namespace == "":
+    if ctx.obj.namespace == LOCAL_NAMESPACE:
         IocLocalCommands(ctx.obj, ioc_name).deploy(ioc_name, version, args)
     else:
         IocK8sCommands(ctx.obj, ioc_name).deploy(ioc_name, version, args)
@@ -116,7 +117,7 @@ def exec(
     ioc_name: str = typer.Argument(..., help="Name of the IOC container to run in"),
 ):
     """Execute a bash prompt in a live IOC's container"""
-    if ctx.obj.namespace == "":
+    if ctx.obj.namespace == LOCAL_NAMESPACE:
         IocLocalCommands(ctx.obj, ioc_name).exec()
     else:
         IocK8sCommands(ctx.obj, ioc_name).exec()
@@ -143,7 +144,7 @@ def logs(
     follow: bool = typer.Option(False, "--follow", "-f", help="Follow the log stream"),
 ):
     """Show logs for current and previous instances of an IOC"""
-    if ctx.obj.namespace == "":
+    if ctx.obj.namespace == LOCAL_NAMESPACE:
         IocLocalCommands(ctx.obj, ioc_name).logs(prev, follow)
     else:
         IocK8sCommands(ctx.obj, ioc_name).logs(prev, follow)
@@ -155,7 +156,7 @@ def restart(
     ioc_name: str = typer.Argument(..., help="Name of the IOC container to restart"),
 ):
     """Restart an IOC"""
-    if ctx.obj.namespace == "":
+    if ctx.obj.namespace == LOCAL_NAMESPACE:
         IocLocalCommands(ctx.obj, ioc_name).restart()
     else:
         IocK8sCommands(ctx.obj, ioc_name).restart()
@@ -168,7 +169,7 @@ def start(
 ):
     """Start an IOC"""
     log.debug("Starting IOC with LOCAL={ctx.obj.namespace == " "}")
-    if ctx.obj.namespace == "":
+    if ctx.obj.namespace == LOCAL_NAMESPACE:
         IocLocalCommands(ctx.obj, ioc_name).start()
     else:
         IocK8sCommands(ctx.obj, ioc_name).start()
@@ -180,7 +181,7 @@ def stop(
     ioc_name: str = typer.Argument(..., help="Name of the IOC container to stop"),
 ):
     """Stop an IOC"""
-    if ctx.obj.namespace == "":
+    if ctx.obj.namespace == LOCAL_NAMESPACE:
         IocLocalCommands(ctx.obj, ioc_name).stop()
     else:
         IocK8sCommands(ctx.obj, ioc_name).stop()

src/epics_containers_cli/ioc/k8s_commands.py

@@ -29,14 +29,17 @@ def check_namespace(namespace: Optional[str]):
     """
     Verify we have a good namespace that exists in the cluster
     """
-    if namespace is None:
+    if not namespace:
         log.error("Please set EC_K8S_NAMESPACE or pass --namespace")
         raise typer.Exit(1)
 
     cmd = f"kubectl get namespace {namespace} -o name"
     result = run_command(cmd, interactive=False, error_OK=True)
     if "NotFound" in str(result):
-        log.error(f"namespace {namespace} not found - please check your environment")
+        log.error(
+            f"namespace {namespace} not found - please check "
+            f"~/.kube/config or change EC_K8S_NAMESPACE"
+        )
         raise typer.Exit(1)
 
     log.info("domain = %s", namespace)

src/epics_containers_cli/ioc/local_commands.py

@@ -24,8 +24,10 @@
     CONFIG_FILE,
     CONFIG_FOLDER,
     IOC_CONFIG_FOLDER,
+    LOCAL_NAMESPACE,
     Context,
 )
+from epics_containers_cli.ioc.k8s_commands import check_namespace
 from epics_containers_cli.logging import log
 from epics_containers_cli.shell import check_beamline_repo, run_command
 from epics_containers_cli.utils import (
@@ -43,9 +45,11 @@ class IocLocalCommands:
     def __init__(
         self, ctx: Optional[Context], ioc_name: str = "", with_docker: bool = True
     ):
+        self.namespace = ""
         self.beamline_repo: str = ""
         if ctx is not None:
             self.beamline_repo = ctx.beamline_repo
+            self.namespace = ctx.namespace
 
         self.ioc_name: str = ioc_name
 
@@ -197,14 +201,10 @@ def validate_instance(self, ioc_instance: Path):
             with requests.get(schema_url, allow_redirects=True) as r:
                 schema_file.write_text(r.content.decode())
 
-            if not run_command("yajsv -v", interactive=False, error_OK=True):
-                typer.echo(
-                    "yajsv, used for schema validation of ioc.yaml, is not installed. "
-                    "Please install from https://github.com/neilpa/yajsv"
-                )
-                raise typer.Exit(1)
-
-            run_command(f"yajsv -s {schema_file} {ioc_config_file}", interactive=False)
+            self.docker.run_tool(
+                image="ghcr.io/epics-containers/yajsv",
+                args=f"-s {schema_file} {ioc_config_file}",
+            )
 
             # check that the image name and the schema are from the same generic IOC
             if image_tag not in schema_url:
@@ -225,3 +225,18 @@ def validate_instance(self, ioc_instance: Path):
         shutil.rmtree(tmp, ignore_errors=True)
 
         typer.echo(f"{ioc_instance} validated successfully")
+
+    def environment(self, verbose: bool):
+        """
+        declare the environment settings for ec
+        """
+        ns = self.namespace
+
+        if ns == LOCAL_NAMESPACE:
+            typer.echo("ioc commands deploy to the local docker/podman instance")
+        else:
+            check_namespace(ns)
+            typer.echo(f"ioc commands deploy to the {ns} namespace the K8S cluster")
+
+        typer.echo("\nEC environment variables:")
+        run_command("env | grep '^EC_'", interactive=False, show=True)

src/epics_containers_cli/shell.py

@@ -14,12 +14,21 @@
 from .logging import log
 
 
-def run_command(command: str, interactive=True, error_OK=False) -> Union[str, bool]:
+def run_command(
+    command: str, interactive=True, error_OK=False, show=False
+) -> Union[str, bool]:
     """
     Run a command and return the output
 
     if interactive is true then allow stdin and stdout, return the return code,
     otherwise return True for success and False for failure
+
+    args:
+
+        command: the command to run
+        interactive: if True then allow stdin and stdout
+        error_OK: if True then do not raise an exception on failure
+        show: print the command output to the console
     """
     console = Console(highlight=False, soft_wrap=True)
 
@@ -28,20 +37,31 @@ def run_command(command: str, interactive=True, error_OK=False) -> Union[str, bo
 
     p_result = subprocess.run(command, capture_output=not interactive, shell=True)
 
-    output = "" if interactive else p_result.stdout.decode() + p_result.stderr.decode()
+    if interactive:
+        output = error_out = ""
+    else:
+        output = p_result.stdout.decode()
+        error_out = p_result.stderr.decode()
 
     if interactive:
         result: Union[str, bool] = p_result.returncode == 0
     else:
-        result = p_result.stdout.decode() + p_result.stderr.decode()
+        result = output + error_out
 
     if p_result.returncode != 0 and not error_OK:
         console.print("\nCommand Failed:", style=Style(color="red", bold=True))
-        console.print(f"{command}", style=Style(color="pale_turquoise4"))
-        console.print(output, style=Style(color="red", bold=True))
+        if not glob_vars.EC_VERBOSE:
+            console.print(f"{command}", style=Style(color="pale_turquoise4"))
+        console.print(output, style=Style(color="deep_sky_blue3", bold=True))
+        console.print(error_out, style=Style(color="red", bold=True))
         raise typer.Exit(1)
 
+    if show:
+        console.print(output, style=Style(color="deep_sky_blue3", bold=True))
+        console.print(error_out, style=Style(color="red", bold=True))
+
     log.debug(f"returning: {result}")
+
     return result
 
 

tests/conftest.py

@@ -157,7 +157,7 @@ def ioc(data):
 @fixture()
 def local(data):
     file = Path(__file__).parent / "data" / "local.yaml"
-    os.environ["EC_K8S_NAMESPACE"] = ""
+    os.environ["EC_K8S_NAMESPACE"] = "local"
     yaml = YAML(typ="safe").load(file)
     return SimpleNamespace(**yaml)
 

tests/data/local.yaml

@@ -105,10 +105,7 @@ ps:
     rsp: bl45p-ea-ioc-01%2023.10.9%Up%an image
 
 validate:
-  - cmd: yajsv -v
-    rsp: "1.4.0"
-  - cmd: yajsv -s \/tmp\/ec_tests\/schema.json .*\/data\/iocs\/bl45p-ea-ioc-01\/config\/ioc.yaml
-    rsp: "OK"
-  - cmd: docker manifest inspect ghcr.io/epics-containers/ioc-adaravis-linux-runtime:23.9.4
+  - cmd: docker run --rm -w .* -v .*:.* -v \/tmp:\/tmp ghcr.io\/epics-containers\/yajsv -s \/tmp\/ec_tests\/schema.json .*/bl45p-ea-ioc-01\/config\/ioc.yaml
+    rsp: True
+  - cmd: docker manifest inspect ghcr.io\/epics-containers\/ioc-adaravis-linux-runtime:23.9.4
     rsp: "OK"
-