rtems-proxy 0.5.2__tar.gz → 0.6.1__tar.gz

{rtems_proxy-0.5.2 → rtems_proxy-0.6.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: rtems-proxy
-Version: 0.5.2
+Version: 0.6.1
 Summary: Support for a K8S proxy container in controlling and monitoring RTEMS EPICS IOCs
 Author-email: Giles Knap <giles.knap@diamond.ac.uk>
 License:                                  Apache License

{rtems_proxy-0.5.2 → rtems_proxy-0.6.1}/src/rtems_proxy/__main__.py

@@ -7,7 +7,7 @@ from ruamel.yaml import YAML
 from . import __version__
 from .copy import copy_rtems
 from .globals import GLOBALS
-from .telnet import ioc_connect
+from .telnet import ioc_connect, report
 
 __all__ = ["main"]
 
@@ -40,6 +40,9 @@ def start(
     copy: bool = typer.Option(
         True, "--copy/--no-copy", help="copy binaries before connecting"
     ),
+    connect: bool = typer.Option(
+        True, "--connect/--no-connect", help="connect to the IOC console"
+    ),
     reboot: bool = typer.Option(
         True, "--reboot/--no-reboot", help="reboot the IOC first"
     ),
@@ -55,16 +58,21 @@ def start(
     it detects that EPICS_HOST_ARCH==RTEMS-beatnik
 
     args:
-    copy: Copy the RTEMS binaries to the IOCs TFTP and NFS directories first
-    reboot: Reboot the IOC once the binaries are copied and the connection is made
+    copy:    Copy the RTEMS binaries to the IOCs TFTP and NFS directories first
+    connect: Connect to the IOC console after rebooting
+    reboot:  Reboot the IOC once the binaries are copied and the connection is
+             made. Ignored if connect is False.
     """
-    print(
+    report(
         f"Remote control startup of RTEMS IOC {GLOBALS.IOC_NAME}"
         f" at {GLOBALS.RTEMS_IOC_IP}"
     )
     if copy:
         copy_rtems()
-    ioc_connect(GLOBALS.RTEMS_CONSOLE, reboot=reboot)
+    if connect:
+        ioc_connect(GLOBALS.RTEMS_CONSOLE, reboot=reboot)
+    else:
+        report("IOC console connection disabled. ")
 
 
 @cli.command()
@@ -91,7 +99,7 @@ def dev(
 
     ioc_path = ioc_repo / "services" / ioc_name
 
-    values = ioc_repo / "helm/shared/values.yaml"
+    values = ioc_repo / "services" / "values.yaml"
     if not values.exists():
         typer.echo(f"Global settings file {values} not found. Exiting")
         raise typer.Exit(1)
@@ -106,20 +114,25 @@ def dev(
     with open(values) as fp:
         yaml = YAML(typ="safe").load(fp)
     try:
-        ioc_group = yaml["ioc-instance"]["ioc_group"]
+        ioc_group = yaml["global"]["ioc_group"]
+    except KeyError:
+        typer.echo(f"{values} global.ioc_group key missing")
+        raise typer.Exit(1) from None
+    try:
+        ioc_group = yaml["global"]["ioc_group"]
         for item in yaml["ioc-instance"]["globalEnv"]:
             env_vars[item["name"]] = item["value"]
     except KeyError:
-        typer.echo(f"{values} not in expected format")
+        typer.echo(f"{values} globalEnv key missing")
         raise typer.Exit(1) from None
 
     with open(ioc_values) as fp:
         yaml = YAML(typ="safe").load(fp)
     try:
-        for item in yaml["shared"]["ioc-instance"]["iocEnv"]:
+        for item in yaml["ioc-instance"]["iocEnv"]:
             env_vars[item["name"]] = item["value"]
     except KeyError:
-        typer.echo(f"{ioc_values} not in expected format")
+        typer.echo(f"{ioc_values} iocEnv key missing")
         raise typer.Exit(1) from None
 
     this_dir = Path(__file__).parent

{rtems_proxy-0.5.2 → rtems_proxy-0.6.1}/src/rtems_proxy/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.5.2'
-__version_tuple__ = version_tuple = (0, 5, 2)
+__version__ = version = '0.6.1'
+__version_tuple__ = version_tuple = (0, 6, 1)

rtems_proxy-0.6.1/src/rtems_proxy/copy.py

@@ -0,0 +1,61 @@
+"""
+functions for moving IOC assets into position for a remote IOC to access
+"""
+
+import re
+import shutil
+from pathlib import Path
+
+from .globals import GLOBALS
+
+
+def copy_rtems():
+    """
+    Copy RTEMS binaries to a location where the RTEMS IOC can access them
+
+    IMPORTANT: local_root and nfs_root are different perspectives on the same
+               folder.
+    local_root: where the IOC files will be placed from the
+                perspective of this IOC proxy service. This IOC proxy will
+                populate the folder for use by the RTEMS crate.
+    nfs_root:   where the IOC files will be found from the perspective of a
+                a client to the nfsv2-tftp service. i.e. where the RTEMS crate
+                will look for them using NFS.
+    """
+    local_root = GLOBALS.RTEMS_TFTP_PATH
+    nfs_root = Path("/iocs") / GLOBALS.IOC_NAME
+
+    # where to copy the Generic IOC folder to. This will contain the IOC binary
+    # and the files
+    dest_ioc = local_root / "ioc"
+    # where to copy the generated runtime assets to. This will contain
+    # st.cmd and ioc.db
+    dest_runtime = local_root / "runtime"
+
+    # TODO - perhaps do protocol files in this fashion for linux IOCs too,
+    # in which case this needs to go somewhere generic
+    protocol_folder = GLOBALS.RUNTIME / "protocol"
+    protocol_folder.mkdir(parents=True, exist_ok=True)
+    protocol_files = GLOBALS.SUPPORT.glob("**/*.proto*")
+    for proto_file in protocol_files:
+        dest = protocol_folder / proto_file.name
+        shutil.copy(proto_file, dest)
+
+    # copy all the files needed for runtime into the PVC that is being shared
+    # over nfs/tftp by the nfsv2-tftp service
+    for folder in ["bin", "dbd"]:
+        shutil.copytree(
+            GLOBALS.IOC.readlink() / folder, dest_ioc / folder, dirs_exist_ok=True
+        )
+    shutil.copytree(GLOBALS.RUNTIME, dest_runtime, dirs_exist_ok=True)
+
+    # because we moved the ioc files we need to fix up startup script paths
+    startup = dest_runtime / "st.cmd"
+    cmd_txt = startup.read_text()
+    cmd_txt = re.sub("/epics/", f"{str(nfs_root)}/", cmd_txt)
+    # also fix up the protocol path to point to protocol_folder
+    cmd_txt = (
+        cmd_txt
+        + f'\nepicsEnvSet("STREAM_PROTOCOL_PATH", "{str(nfs_root / "runtime" / "protocol")}")\n'
+    )
+    startup.write_text(cmd_txt)

rtems_proxy-0.6.1/src/rtems_proxy/rsync.sh.jinja

@@ -0,0 +1,53 @@
+#!/bin/bash
+
+{% for name,value in env_vars.items() -%}
+export {{ name }}={{ value }}
+{% endfor -%}
+export IOC_GROUP={{ ioc_group }}
+export IOC_NAME={{ ioc_name }}
+export IOC_PATH={{ ioc_path }}
+
+if [[ "${BASH_SOURCE[0]}" == "${0}" ]] ; then
+  echo "This script must be sourced"
+  exit 1
+fi
+
+# validate we have the essential environment variables
+if [[ -z "$RTEMS_TFTP_PATH" || -z "$RTEMS_TFTP_IP"  || -z "$IOC_NAME" || -z "$RTEMS_TFTP_IP" ]]; then
+  echo "RTEMS_TFTP_PATH,RTEMS_TFTP_IP,IOC_NAME must all be set"
+  return 1
+fi
+
+if [[ $RTEMS_TFTP_PATH != "/"* ]]; then
+  echo "RTEMS_TFTP_PATH must be an absolute path"
+  return 1
+fi
+
+# remove previoud rsync-background process if it exists
+pkill -f rsync-background &>/dev/null
+
+ibek dev instance $IOC_PATH
+bash /epics/ioc/install.sh
+
+mkdir -p $RTEMS_TFTP_PATH
+
+# get previous contents
+echo "getting existing contents of the IOC nfs2-tftp folder"
+(
+  set -x
+  rsync -rt "rsync://$RTEMS_TFTP_IP:12002/files/$IOC_NAME/" $RTEMS_TFTP_PATH 2>/dev/null
+)
+
+echo "
+#!/bin/bash
+
+while true; do
+  inotifywait -e modify,create,delete,move -r $RTEMS_TFTP_PATH
+  rsync -rt --delete /$RTEMS_TFTP_PATH/ \
+        "rsync://$RTEMS_TFTP_IP:12002/files/$IOC_NAME/"
+done
+" > /tmp/rsync-background.sh
+chmod +x /tmp/rsync-background.sh
+
+echo "launching rsync-background.sh"
+nohup /tmp/rsync-background.sh &> /tmp/rsync-background.log &

{rtems_proxy-0.5.2 → rtems_proxy-0.6.1}/src/rtems_proxy/telnet.py

@@ -48,18 +48,12 @@ class TelnetRTEMS:
         signal.signal(signal.SIGINT, self.terminate)
         signal.signal(signal.SIGTERM, self.terminate)
 
-    def report(self, message):
-        """
-        print a message that is noticeable amongst all the other output
-        """
-        print(f"\n>>>> {message} <<<<\n")
-
     def terminate(self, signum, frame):
         """
         Allow the user to terminate the connection with ctrl-c while the
         pexpect child is running (but not once interactive telnet is started)
         """
-        self.report("Terminating")
+        report("Terminating")
         exit(0)
 
     def connect(self):
@@ -83,7 +77,7 @@ class TelnetRTEMS:
             # if we timeout looking for failed connection that is good
             pass
         else:
-            print(">> Cannot connect to remote IOC, connection in use? <<")
+            report("Cannot connect to remote IOC, connection in use?")
             raise CannotConnect
 
     def check_prompt(self, retries=5) -> RtemsState:
@@ -108,16 +102,16 @@ class TelnetRTEMS:
                     # current state unknown. wait and retry
                     sleep(15)
                 else:
-                    self.report("Currently in bootloader")
+                    report("Currently in bootloader")
                     return RtemsState.MOT
             else:
-                self.report("Currently in IOC shell")
+                report("Currently in IOC shell")
                 return RtemsState.IOC
 
-            self.report("Retrying get current status")
+            report("Retrying get current status")
             retries -= 1
 
-        self.report("Current state UNKNOWN")
+        report("Current state UNKNOWN")
         raise CannotConnect("Current state of remote IOC unknown")
 
     def reboot(self, into: RtemsState):
@@ -127,7 +121,7 @@ class TelnetRTEMS:
         """
         assert self._child, "must call connect before reboot"
 
-        self.report(f"Rebooting into {into.name}")
+        report(f"Rebooting into {into.name}")
         current_state = self.check_prompt()
         if current_state == RtemsState.MOT:
             self._child.sendline("reset")
@@ -162,7 +156,7 @@ class TelnetRTEMS:
                 self.reboot(RtemsState.IOC)
                 self._child.expect(self.IOC_STARTED, timeout=50)
 
-        self.report("press enter for IOC shell prompt")
+        report("press enter for IOC shell prompt")
 
     def get_boot_prompt(self):
         """
@@ -177,7 +171,7 @@ class TelnetRTEMS:
             self.reboot(RtemsState.MOT)
             self._child.expect(self.MOT_PROMPT, timeout=20)
 
-        self.report("press enter for bootloader prompt")
+        report("press enter for bootloader prompt")
 
     def close(self):
         if self._child:
@@ -188,6 +182,13 @@ class TelnetRTEMS:
         self.close()
 
 
+def report(message):
+    """
+    print a message that is noticeable amongst all the other output
+    """
+    print(f"\n>>>> {message} <<<<\n")
+
+
 def ioc_connect(host_and_port: str, reboot: bool = False):
     """
     Entrypoint to make a connection to an RTEMS IOC over telnet.
@@ -201,10 +202,14 @@ def ioc_connect(host_and_port: str, reboot: bool = False):
 
     try:
         telnet.connect()
-        telnet.get_epics_prompt()
+        if reboot:
+            telnet.get_epics_prompt()
+        else:
+            report("Auto reboot disabled. Skipping reboot")
     except (CannotConnect, pexpect.exceptions.TIMEOUT):
-        print("\n\nNot Connected. Exiting...")
+        report("Connection failed. Exiting")
         telnet.close()
     else:
         telnet.close()
+        report("Connecting to IOC console, hit enter for a prompt")
         run_command(telnet.command)

{rtems_proxy-0.5.2 → rtems_proxy-0.6.1}/src/rtems_proxy.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: rtems-proxy
-Version: 0.5.2
+Version: 0.6.1
 Summary: Support for a K8S proxy container in controlling and monitoring RTEMS EPICS IOCs
 Author-email: Giles Knap <giles.knap@diamond.ac.uk>
 License:                                  Apache License

rtems_proxy-0.5.2/src/rtems_proxy/copy.py

@@ -1,53 +0,0 @@
-"""
-functions for moving IOC assets into position for a remote IOC to access
-"""
-
-import re
-import shutil
-from pathlib import Path
-
-from .globals import GLOBALS
-
-
-def copy_rtems():
-    """
-    Copy RTEMS binaries to a location where the RTEMS IOC can access them
-    """
-    # root of pvc mount into which we copy the IOC files for the RTEMS IOC to access
-    root = GLOBALS.RTEMS_TFTP_PATH
-    # root of the path that the RTEMS IOC expects to find the IOC files
-    RTEMS_TFTP_PATH = Path("/iocs") / GLOBALS.IOC_NAME
-    # where to copy the Generic IOC folder to (at present only holds the dbd folder)
-    ioc_dest = root / "ioc"
-    # where to copy the generated runtime assets to (st.cmd and ioc.db)
-    dest_runtime = root / "runtime"
-
-    # move all the files needed for runtime into the PVC that is being shared
-    # over nfs/tftp by the nfsv2-tftp service
-    ioc_src = GLOBALS.IOC.readlink()
-    dbd_src = ioc_src / "dbd"
-    dbd_dest = ioc_dest / "dbd"
-    binary = Path("bin/RTEMS-beatnik/ioc.boot")
-    bin_rtems_src = ioc_src / binary
-    bin_rtems_dest = ioc_dest / binary
-    bin_rtems_dest.parent.mkdir(parents=True, exist_ok=True)
-
-    shutil.copytree(dbd_src, dbd_dest, symlinks=True, dirs_exist_ok=True)
-    shutil.copy(bin_rtems_src, bin_rtems_dest)
-    shutil.copytree(GLOBALS.RUNTIME, dest_runtime, dirs_exist_ok=True)
-
-    protocol_folder = RTEMS_TFTP_PATH / "protocol"
-    protocol_files = GLOBALS.SUPPORT.glob("**/*.proto*")
-    for proto_file in protocol_files:
-        dest = protocol_folder / proto_file.name
-        shutil.copy(proto_file, dest)
-
-    # because we moved the ioc files we need to fix up startup script paths
-    startup = dest_runtime / "st.cmd"
-    cmd_txt = startup.read_text()
-    cmd_txt = re.sub("/epics/", f"{str(RTEMS_TFTP_PATH)}/", cmd_txt)
-    # also fix up the protocol path to point to protocol_folder
-    cmd_txt = (
-        cmd_txt + f'\nepicsEnvSet("STREAM_PROTOCOL_PATH", "{str(protocol_folder)}")\n'
-    )
-    startup.write_text(cmd_txt)

rtems_proxy-0.5.2/src/rtems_proxy/rsync.sh.jinja

@@ -1,30 +0,0 @@
-#!/bin/bash
-
-{% for name,value in env_vars.items() -%}
-export {{ name }}={{ value }}
-{% endfor -%}
-export IOC_GROUP={{ ioc_group }}
-export IOC_NAME={{ ioc_name }}
-export IOC_PATH={{ ioc_path }}
-
-pkill -f rsync-background &>/dev/null
-
-ibek dev instance $IOC_PATH
-bash /epics/ioc/install.sh
-
-mkdir -p $RTEMS_TFTP_PATH
-
-# get previous contents
-rsync -rt "rsync://$RTEMS_TFTP_IP:12002/files/$IOC_GROUP/$IOC_NAME/" $RTEMS_TFTP_PATH 2>/dev/null
-
-echo "
-#!/bin/bash
-
-while true; do
-  inotifywait -e modify,create,delete,move -r $RTEMS_TFTP_PATH
-  rsync -rt --delete /$RTEMS_TFTP_PATH/ \
-        "rsync://$RTEMS_TFTP_IP:12002/files/$IOC_GROUP/$IOC_NAME/" &> /tmp/rsync.log
-done
-" > /tmp/rsync-background.sh
-
-nohup bash /tmp/rsync-background.sh &> /tmp/rsync-background.log &