Merge pull request #47 from epics-containers/dev

Add local docker deployment. Factor out docker calls to Docker class.

Author: gilesknap

docs/conf.py

@@ -153,6 +153,7 @@
     logo=dict(
         text=project,
     ),
+    navigation_with_keys=True,
     use_edit_page_button=True,
     github_url=f"https://github.com/{github_user}/{github_repo}",
     icon_links=[

src/epics_containers_cli/__main__.py

@@ -4,14 +4,14 @@
 import typer
 
 import epics_containers_cli.globals as glob_vars
+from epics_containers_cli.ioc.k8s_commands import IocK8sCommands
+from epics_containers_cli.ioc.local_commands import IocLocalCommands
 
 from . import __version__
 from .dev.dev_cli import dev
 from .ioc.ioc_cli import ioc
 from .k8s.k8s_cli import cluster
-from .k8s.kubectl import fmt_deploys, fmt_pods, fmt_pods_wide
 from .logging import init_logging
-from .shell import run_command
 
 __all__ = ["main"]
 
@@ -93,14 +93,11 @@ def ps(
         False, "--wide", "-w", help="use a wide format with additional fields"
     ),
 ):
-    """List the IOCs running in the current domain"""
-    domain = ctx.obj.namespace
-
-    if all:
-        run_command(f"kubectl -n {domain} get deploy -l is_ioc==True -o {fmt_deploys}")
+    """List the IOCs running in the current namespace"""
+    if ctx.obj.namespace == "":
+        IocLocalCommands(ctx.obj).ps(all, wide)
     else:
-        format = fmt_pods_wide if wide else fmt_pods
-        run_command(f"kubectl -n {domain} get pod -l is_ioc==True -o {format}")
+        IocK8sCommands(ctx.obj).ps(all, wide)
 
 
 # test with:

src/epics_containers_cli/dev/dev_cli.py

@@ -57,7 +57,13 @@ def launch_local(
     IOC project folder.
     """
     DevCommands().launch_local(
-        ioc_instance, generic_ioc, execute, target, tag, args, ioc_name
+        ioc_instance=ioc_instance,
+        generic_ioc=generic_ioc,
+        execute=execute,
+        target=target,
+        tag=tag,
+        args=args,
+        ioc_name=ioc_name,
     )
 
 
@@ -67,9 +73,9 @@ def launch(
     ioc_instance: Path = typer.Argument(
         ...,
         help="local IOC definition folder from domain repo",
-        dir_okay=True,
         file_okay=False,
         exists=True,
+        resolve_path=True,
     ),
     execute: str = typer.Option(
         f"{IOC_START}; bash",
@@ -93,12 +99,22 @@ def launch(
     instances. You may find the devcontainer a more convenient way to
     do this.
     """
-    DevCommands().launch(ioc_instance, execute, target, image, tag, args, ioc_name)
+    DevCommands().launch(
+        ioc_instance=ioc_instance,
+        execute=execute,
+        target=target,
+        image=image,
+        tag=tag,
+        args=args,
+        ioc_name=ioc_name,
+    )
 
 
 @dev.command()
 def debug_last(
-    generic_ioc: Path = typer.Argument(Path("."), help="Container project folder"),
+    generic_ioc: Path = typer.Argument(
+        Path("."), help="Container project folder", exists=True, file_okay=False
+    ),
     mount_repos: bool = typer.Option(
         True, help="Mount generic IOC repo folder into the container"
     ),
@@ -108,13 +124,15 @@ def debug_last(
     Useful for debugging failed builds - if the last build failed it will
     start the container after the most recent successful build step.
     """
-    DevCommands().debug_last(generic_ioc, mount_repos)
+    DevCommands().debug_last(generic_ioc=generic_ioc, mount_repos=mount_repos)
 
 
 @dev.command()
 def versions(
     ctx: typer.Context,
-    generic_ioc: Path = typer.Argument(Path("."), help="Generic IOC project folder"),
+    generic_ioc: Path = typer.Argument(
+        Path("."), help="Generic IOC project folder", exists=True, file_okay=False
+    ),
     arch: Architecture = typer.Option(
         Architecture.linux, help="choose target architecture"
     ),
@@ -129,7 +147,7 @@ def versions(
     or the local project folder (defaults to .) e.g.
         ec dev versions ../ioc-template
     """
-    DevCommands().versions(generic_ioc, arch, image)
+    DevCommands().versions(generic_ioc=generic_ioc, arch=arch, image=image)
 
 
 @dev.command()
@@ -142,24 +160,24 @@ def stop(
     """
     Stop a running local IOC container
     """
-    DevCommands().stop(ioc_name)
+    DevCommands().stop(ioc_name=ioc_name)
 
 
 @dev.command()
 def exec(
     ctx: typer.Context,
-    ioc_name: str = typer.Option(
-        IOC_NAME, help="container name override. Use to run multiple instances"
-    ),
     command: str = typer.Argument(
         "bash", help="command to execute inside the container must be 'single quoted'"
     ),
+    ioc_name: str = typer.Option(
+        IOC_NAME, help="container name override. Use to run multiple instances"
+    ),
     args: str = typer.Option("", help="Additional args for exec, 'must be quoted'"),
 ):
     """
     Execute a command inside a running local IOC container
     """
-    DevCommands().exec(ioc_name, command, args)
+    DevCommands().exec(ioc_name=ioc_name, command=command, args=args)
 
 
 @dev.command()
@@ -176,13 +194,15 @@ def wait_pv(
     """
     Execute a command inside a running local IOC container
     """
-    DevCommands().wait_pv(pv_name, ioc_name, attempts)
+    DevCommands().wait_pv(pv_name=pv_name, ioc_name=ioc_name, attempts=attempts)
 
 
 @dev.command()
 def build(
     ctx: typer.Context,
-    generic_ioc: Path = typer.Option(Path("."), help="Generic IOC project folder"),
+    generic_ioc: Path = typer.Option(
+        Path("."), help="Generic IOC project folder", exists=True, file_okay=False
+    ),
     tag: str = typer.Option(IMAGE_TAG, help="version tag for the image"),
     arch: Architecture = typer.Option(
         Architecture.linux, help="choose target architecture"
@@ -200,13 +220,13 @@ def build(
     Builds both developer and runtime targets.
     """
     DevCommands().build(
-        generic_ioc,
-        tag,
-        arch,
-        platform,
-        cache,
-        cache_to,
-        cache_from,
-        push,
-        rebuild,
+        generic_ioc=generic_ioc,
+        tag=tag,
+        arch=arch,
+        platform=platform,
+        cache=cache,
+        cache_from=cache_from,
+        cache_to=cache_to,
+        push=push,
+        rebuild=rebuild,
     )

src/epics_containers_cli/dev/dev_commands.py

@@ -1,6 +1,5 @@
 import time
 from pathlib import Path
-from subprocess import CalledProcessError
 from typing import Optional
 
 import typer
@@ -158,23 +157,21 @@ def stop(self, ioc_name: str):
         """
         self.docker.stop(ioc_name)
 
-    def exec(self, command: str, ioc_name: str, args: str = ""):
+    def exec(self, ioc_name: str, command: str, args: str = ""):
         """
         execute a command in a locally running container
         """
-        self.docker.exec(command, ioc_name, args)
+        self.docker.exec(container=ioc_name, command=command, args=args)
 
     def wait_pv(self, pv_name: str, ioc_name: str, attempts: int):
         """
         wait for a local IOC instance to start by monitoring for a PV
         """
         for i in range(attempts):
-            try:
-                cmd = f"caget {pv_name}"
-                result = self.docker.exec(ioc_name, cmd, interactive=False)
-            except CalledProcessError:
-                pass  # assume the IOC is not running yet
-
+            cmd = f"caget {pv_name}"
+            result = self.docker.exec(
+                container=ioc_name, command=cmd, interactive=False, errorOK=True
+            )
             if str(result).startswith(pv_name):
                 break
             time.sleep(1)

src/epics_containers_cli/docker.py

@@ -4,8 +4,11 @@
 import re
 import sys
 from pathlib import Path
+from time import sleep
 from typing import List, Optional
 
+import typer
+
 import epics_containers_cli.globals as glob_vars
 from epics_containers_cli.globals import Architecture
 from epics_containers_cli.logging import log
@@ -130,15 +133,22 @@ def build(
         run_command(f"{cmd} build --target {target}{t_arch} {args} -t {name} {context}")
 
     def exec(
-        self, container: str, command: str, args: str = "", interactive: bool = True
+        self,
+        container: str,
+        command: str,
+        args: str = "",
+        interactive: bool = True,
+        errorOK: bool = False,
     ):
         """
         execute a command in a local IOC instance
         """
+        self.is_running(container, error=True)
         args = f"{args} " if args else ""
         result = run_command(
             f'{self.docker} exec {args}{container} bash -c "{command}"',
             interactive=interactive,
+            error_OK=errorOK,
         )
         return result
 
@@ -163,13 +173,33 @@ def attach(self, container: str):
         """
         attach to a container
         """
+        self.is_running(container, error=True)
         run_command(f"{self.docker} attach {container}")
 
     def logs(self, container: str, previous: bool = False, follow: bool = False):
         """
         show logs from a container
         """
+        self.is_running(container, error=True)
         prev = " -p" if previous else ""
         fol = " -f" if follow else ""
 
-        run_command(f"docker logs{prev}{fol} {container}")
+        run_command(f"{self.docker} logs{prev}{fol} {container}")
+
+    def is_running(self, container: str, retry=1, error=False):
+        """
+        verify that a given container is up and running
+        """
+        for i in range(retry):
+            result = run_command(
+                f"{self.docker} ps -f name={container} --format '{{{{.Names}}}}'",
+                interactive=False,
+            )
+            if container in str(result):
+                return True
+            sleep(0.5)
+        else:
+            if error:
+                log.error(f"{container} is not running")
+                raise typer.Exit(1)
+            return False

src/epics_containers_cli/git.py

@@ -102,6 +102,7 @@ def versions(beamline_repo: str, ioc_name: str, folder: Path):
     result = str(run_command("git tag", interactive=False))
     log.debug(f"checking these tags for changes in the instance: {result}")
 
+    count = 0
     tags = result.split("\n")
     for tag in tags:
         if tag == "":
@@ -111,3 +112,11 @@ def versions(beamline_repo: str, ioc_name: str, folder: Path):
 
         if ioc_name in result:
             typer.echo(f"  {tag}")
+            count += 1
+
+    if count == 0:
+        # also look to see if the first tag was when the instance was created
+        cmd = f"git diff --name-only {tags[0]} $(git hash-object -t tree /dev/null)"
+        result = str(run_command(cmd, interactive=False))
+        if ioc_name in result:
+            typer.echo(f"  {tags[0]}")

src/epics_containers_cli/ioc/ioc_cli.py

@@ -42,7 +42,13 @@ def delete(
 @ioc.command()
 def template(
     ctx: typer.Context,
-    ioc_instance: Path = typer.Argument(..., help="folder of local ioc definition"),
+    ioc_instance: Path = typer.Argument(
+        ...,
+        help="folder of local ioc definition",
+        exists=True,
+        file_okay=False,
+        resolve_path=True,
+    ),
     args: str = typer.Option("", help="Additional args for helm, 'must be quoted'"),
 ):
     """
@@ -57,7 +63,13 @@ def template(
 @ioc.command()
 def deploy_local(
     ctx: typer.Context,
-    ioc_instance: Path = typer.Argument(..., help="folder of local ioc definition"),
+    ioc_instance: Path = typer.Argument(
+        ...,
+        help="folder of local ioc definition",
+        exists=True,
+        file_okay=False,
+        resolve_path=True,
+    ),
     yes: bool = typer.Option(False, "-y", "--yes", help="Skip confirmation prompt"),
     args: str = typer.Option("", help="Additional args for helm, 'must be quoted'"),
 ):