rtems-proxy 1.3.0b4__tar.gz → 2.0.0__tar.gz

{rtems_proxy-1.3.0b4 → rtems_proxy-2.0.0}/Dockerfile

@@ -5,6 +5,7 @@ FROM ghcr.io/diamondlightsource/ubuntu-devcontainer:noble AS developer
 # Add any system dependencies for the developer/build environment here
 RUN apt-get update -y && apt-get install -y --no-install-recommends \
     rsync \
+    telnet \
     && apt-get dist-clean
 
 # The build stage installs the context into the venv

{rtems_proxy-1.3.0b4 → rtems_proxy-2.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rtems-proxy
-Version: 1.3.0b4
+Version: 2.0.0
 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-1.3.0b4 → rtems_proxy-2.0.0}/rtems-proxy.code-workspace

@@ -8,6 +8,9 @@
 		},
 		{
 			"path": "../i04-services"
+		},
+		{
+			"path": "../rf-services"
 		}
 	],
 	"settings": {}

{rtems_proxy-1.3.0b4 → rtems_proxy-2.0.0}/src/rtems_proxy/__main__.py

@@ -172,6 +172,9 @@ def configure(
     attach: bool = typer.Option(
         False, help="attach to the IOC console after configuration"
     ),
+    dry_run: bool = typer.Option(
+        False, help="print the configuration commands without applying them"
+    ),
     use_console: bool = typer.Option(
         False, help="use conserver console instead of telnet"
     ),
@@ -180,13 +183,19 @@ def configure(
     Configure the RTEMS IOC boot parameters
     """
 
-    assert GLOBALS.RTEMS_CONSOLE, "No RTEMS console defined"
-    telnet = motboot_connect(GLOBALS.RTEMS_CONSOLE, use_console=use_console)
-    config = Configure(telnet, debug)
-    config.apply_settings()
-    telnet.close()
-    if attach:
-        run_command(telnet.command)
+    if dry_run:
+        config = Configure(None, debug=debug, dry_run=True)
+        config.apply_settings()
+    else:
+        assert GLOBALS.RTEMS_CONSOLE, "No RTEMS console defined"
+
+        config = Configure(None, debug=debug)
+        telnet = motboot_connect(GLOBALS.RTEMS_CONSOLE, use_console=use_console)
+        config = Configure(telnet, debug=debug, dry_run=dry_run)
+        config.apply_settings()
+        telnet.close()
+        if attach:
+            run_command(telnet.command)
 
 
 @cli.command()

{rtems_proxy-1.3.0b4 → rtems_proxy-2.0.0}/src/rtems_proxy/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '1.3.0b4'
-__version_tuple__ = version_tuple = (1, 3, 0, 'b4')
+__version__ = version = '2.0.0'
+__version_tuple__ = version_tuple = (2, 0, 0)
 
-__commit_id__ = commit_id = 'gbe0562251'
+__commit_id__ = commit_id = 'g9b4243c59'

rtems_proxy-2.0.0/src/rtems_proxy/configure.py

@@ -0,0 +1,91 @@
+"""
+Class to apply MOTBoot configuration to a VME crate.
+"""
+
+from time import sleep
+
+from .globals import GLOBALS
+from .telnet import TelnetRTEMS
+
+
+class Configure:
+    def __init__(
+        self, telnet: TelnetRTEMS | None, debug: bool = False, dry_run: bool = False
+    ):
+        self.telnet = telnet
+        self.debug = debug
+        self.dry_run = dry_run
+        if dry_run:
+            self.cr = "\n  "
+        else:
+            self.cr = "\r"
+
+    def apply_nvm(self, variable: str, value: str | None):
+        if self.dry_run:
+            print(f"{variable}={value}")
+            return
+
+        assert self.telnet is not None, (
+            "Telnet connection is required to apply settings"
+        )
+        if value is None or value == "":
+            self.telnet.sendline(f"gevDel {variable}")
+            self.telnet.expect(r"\?")
+            self.telnet.sendline("Y")
+        else:
+            self.telnet.sendline(f"gevE {variable}")
+            self.telnet.expect(r"\(Blank line terminates input.\)")
+            self.telnet.sendline(value or "")
+            self.telnet.sendline("")
+            self.telnet.expect(r"\?")
+            self.telnet.sendline("Y")
+
+    def apply_settings(self):
+        if not self.dry_run:
+            for v in [
+                GLOBALS.RTEMS_IOC_NETMASK,
+                GLOBALS.RTEMS_IOC_GATEWAY,
+                GLOBALS.RTEMS_IOC_IP,
+                GLOBALS.RTEMS_NFS_IP,
+                GLOBALS.RTEMS_TFTP_IP,
+            ]:
+                if v is None or v == "":
+                    raise ValueError(
+                        "RTEMS_IOC_NETMASK, RTEMS_IOC_GATEWAY, RTEMS_IOC_IP, "
+                        "RTEMS_NFS_IP, and RTEMS_TFTP_IP must be set"
+                    )
+
+        mot_boot = (
+            f"dla=malloc 0x4000000{self.cr}"
+            f"tftpGet -d/dev/enet1"
+            f" -f{GLOBALS.RTEMS_EPICS_BINARY}"
+            f" -m{GLOBALS.RTEMS_IOC_NETMASK}"
+            f" -g{GLOBALS.RTEMS_IOC_GATEWAY}"
+            f" -s{GLOBALS.RTEMS_TFTP_IP}"
+            f" -c{GLOBALS.RTEMS_IOC_IP}"
+            f" -adla -r3 -v{self.cr}"
+            f"go -a04000000{self.cr}"
+            f"reset"
+        )
+
+        self.apply_nvm("mot-/dev/enet0-cipa", GLOBALS.RTEMS_IOC_IP)
+        self.apply_nvm("mot-/dev/enet0-snma", GLOBALS.RTEMS_IOC_NETMASK)
+        self.apply_nvm("mot-/dev/enet0-gipa", GLOBALS.RTEMS_IOC_GATEWAY)
+        self.apply_nvm("mot-/dev/enet0-sipa", GLOBALS.RTEMS_NFS_IP)
+        self.apply_nvm("mot-boot-device", "/dev/em1")
+        self.apply_nvm("mot-script-boot", mot_boot)
+        self.apply_nvm("rtems-client-name", GLOBALS.IOC_NAME)
+        self.apply_nvm("epics-script", GLOBALS.RTEMS_EPICS_SCRIPT)
+
+        if GLOBALS.RTEMS_EPICS_NFS_MOUNT:
+            self.apply_nvm(
+                "epics-nfsmount",
+                f"{GLOBALS.RTEMS_NFS_IP}:"
+                f"{GLOBALS.RTEMS_EPICS_NFS_MOUNT}/{GLOBALS.IOC_NAME.lower()}:"
+                f"{GLOBALS.RTEMS_NFS_ROOT_PATH}",
+            )
+
+        if GLOBALS.RTEMS_EPICS_NTP_SERVER:
+            self.apply_nvm("epics-ntpserver", GLOBALS.RTEMS_EPICS_NTP_SERVER)
+
+        sleep(1)

rtems_proxy-2.0.0/src/rtems_proxy/copy.py

@@ -0,0 +1,75 @@
+"""
+functions for moving IOC assets into position for a remote IOC to access
+"""
+
+import os
+import subprocess
+from pathlib import Path
+
+from .globals import GLOBALS
+
+
+def copy_rtems(debug: bool = False):
+    """
+    Copy RTEMS IOC binary and startup assets to a location where the RTEMS IOC
+    can access them
+    """
+
+    # TODO - this function is currently specific to legacy built IOCs
+    # TODO - once IOCs are built in containers review this function to make it
+    # TODO   work for both legacy and container built IOCs (it might just work?)
+
+    # these represent where the rtems-proxy container mounts the IOC NFS and TFTP
+    # shares
+    local_tftp_root = GLOBALS.RTEMS_TFTP_ROOT_PATH
+    local_nfs_root = f"{GLOBALS.RTEMS_NFS_ROOT_PATH}"
+
+    sts = list(Path(GLOBALS.IOC_ORIGINAL_LOCATION).glob("bin/RTEMS-beatnik/st*"))
+    if len(sts) == 0:
+        raise FileNotFoundError(
+            f"No RTEMS startup script found at "
+            f"{GLOBALS.IOC_ORIGINAL_LOCATION}/bin/RTEMS-beatnik/st*"
+        )
+    ioc_script_name = sts[0].name
+
+    # copy the IOC runtime files to the NFS root
+    os.chdir(GLOBALS.IOC_ORIGINAL_LOCATION)
+    subprocess.run(
+        [
+            "rsync",
+            "--delete",
+            "-r",
+            "data",
+            "db",
+            "dbd",
+            f"bin/RTEMS-beatnik/{ioc_script_name}",
+            f"{local_nfs_root}",
+        ],
+        check=True,
+    )
+
+    # symlink the ioc startup script to a fixed name 'st.cmd'
+    ioc_script_path = Path(local_nfs_root) / GLOBALS.RTEMS_SCRIPT_DEFAULT_NAME
+    ioc_script_path.unlink(missing_ok=True)
+    ioc_script_path.symlink_to(Path(local_nfs_root) / ioc_script_name)
+
+    # TODO for container built IOCs the name will be ioc or ioc.boot
+    if debug:
+        ioc_bin = GLOBALS.IOC_NAME.upper()
+    else:
+        ioc_bin = f"{GLOBALS.IOC_NAME.upper()}.boot"
+
+    # copy the .boot files to the TFTP root
+    subprocess.run(
+        [
+            "rsync",
+            f"bin/RTEMS-beatnik/{ioc_bin}",
+            f"{local_tftp_root}",
+        ],
+        check=True,
+    )
+
+    # move the ioc_bin to a fixed name 'rtems.ioc.bin' in the TFTP root
+    tftp_ioc_boot = Path(local_tftp_root) / GLOBALS.RTEMS_BINARY_DEFAULT_NAME
+    tftp_ioc_boot.unlink(missing_ok=True)
+    (Path(local_tftp_root) / ioc_bin).rename(tftp_ioc_boot)

{rtems_proxy-1.3.0b4 → rtems_proxy-2.0.0}/src/rtems_proxy/globals.py

@@ -12,31 +12,21 @@ class _Globals:
     """Helper class for accessing global constants."""
 
     def __init__(self) -> None:
-        self.EPICS_ROOT = Path(os.getenv("EPICS_ROOT", "/epics/"))
-        """Root of epics directory tree"""
-
-        self.SUPPORT = Path(os.getenv("SUPPORT", self.EPICS_ROOT / "support"))
-        """ The root folder for support modules """
-
-        self.RUNTIME = self.EPICS_ROOT / "runtime"
-
-        self.EPICS_HOST_ARCH = os.getenv("EPICS_HOST_ARCH", DEFAULT_ARCH)
-        """ Host architecture """
-
-        self.EPICS_TARGET_ARCH = os.getenv("EPICS_TARGET_ARCH", DEFAULT_ARCH)
-        """ Cross compilation target architecture """
-
-        self.IOC = Path(os.getenv("IOC", self.EPICS_ROOT / "ioc"))
-        """ The root folder for IOC source and binaries """
+        ########################################################################
+        ## Constants
+        ########################################################################
 
-        # TODO in future, shall we drop the RTEMS prefix and make this module
-        # generic?
+        self.RTEMS_BINARY_DEFAULT_NAME = "rtems.ioc.bin"
+        self.RTEMS_SCRIPT_DEFAULT_NAME = "st.cmd"
 
-        self.RTEMS_TFTP_PATH = Path(os.getenv("RTEMS_TFTP_PATH", "/nfsv2-tftp"))
+        self.RTEMS_TFTP_ROOT_PATH = Path("/ioc_tftp")
         """ root folder of a mounted PVC in which to place IOC binaries """
+        self.RTEMS_NFS_ROOT_PATH = Path("/ioc_nfs")
+        """ root folder of a mounted NFS folder in which to place IOC binaries """
 
-        self.RTEMS_IOC_IP = os.getenv("RTEMS_IOC_IP")
-        """ address of the real RTEMS IOC  hardware """
+        ########################################################################
+        ## Beamline level config from global.env in services/values.yaml
+        ########################################################################
 
         self.RTEMS_IOC_GATEWAY = os.getenv("RTEMS_IOC_GATEWAY")
         """ gateway address for the RTEMS IOC hardware """
@@ -50,26 +40,67 @@ class _Globals:
         self.RTEMS_TFTP_IP = os.getenv("RTEMS_TFTP_IP")
         """ address of a TFTP server that the RTEMS IOC can access """
 
+        self.RTEMS_EPICS_NTP_SERVER = os.getenv("RTEMS_EPICS_NTP_SERVER")
+        """ ip address for the ntp server """
+
+        self.RTEMS_EPICS_NFS_MOUNT = os.getenv("RTEMS_EPICS_NFS_MOUNT")
+        """ NFS mount point for the EPICS IOC """
+
+        ########################################################################
+        ## IOC config from ioc-instance.env in services/ioc_name/values.yaml
+        ########################################################################
+
+        self.RTEMS_IOC_IP = os.getenv("RTEMS_IOC_IP")
+        """ address of the real RTEMS IOC  hardware """
+
         self.RTEMS_CONSOLE = os.getenv("RTEMS_CONSOLE")
         """ address:port to connect to the IOC console """
 
+        ########################################################################
+        ## IOC config with defaults supplied by the helm chart
+        ########################################################################
+
         self.IOC_NAME = os.getenv("IOC_NAME", "NO_IOC_NAME")
-        """ the name of this IOC """
+        """ the lowercase name of this IOC """
 
         self.IOC_GROUP = os.getenv("IOC_GROUP", "NO_IOC_GROUP")
         """ the name of the repository that this IOC is grouped into """
 
-        self.RTEMS_EPICS_SCRIPT = os.getenv("RTEMS_EPICS_SCRIPT")
+        ########################################################################
+        ## IOC config with defaults supplied here
+        ########################################################################
+
+        self.RTEMS_EPICS_SCRIPT = os.getenv("RTEMS_EPICS_SCRIPT", "/ioc_nfs/st.cmd")
         """ override for the EPICS startup script """
 
-        self.RTEMS_EPICS_BINARY = os.getenv("RTEMS_EPICS_BINARY")
-        """ override for the EPICS binary """
+        self.RTEMS_EPICS_BINARY = os.getenv(
+            "RTEMS_EPICS_BINARY",
+            f"/iocs/{self.IOC_NAME.lower()}/{self.RTEMS_BINARY_DEFAULT_NAME}",
+        )
+        """ override for the EPICS binary TFTP path """
 
-        self.RTEMS_EPICS_NTP_SERVER = os.getenv("RTEMS_EPICS_NTP_SERVER")
-        """ ip address for the ntp server """
+        ########################################################################
+        ## The remaining values relate to IOCs built inside containers
+        ########################################################################
 
-        self.RTEMS_EPICS_NFS_MOUNT = os.getenv("RTEMS_EPICS_NFS_MOUNT")
-        """ NFS mount point for the EPICS IOC """
+        self.EPICS_ROOT = Path(os.getenv("EPICS_ROOT", "/epics/"))
+        """Root of epics directory tree"""
+
+        self.SUPPORT = Path(os.getenv("SUPPORT", self.EPICS_ROOT / "support"))
+        """ The root folder for support modules """
+
+        self.RUNTIME = self.EPICS_ROOT / "runtime"
+
+        self.EPICS_HOST_ARCH = os.getenv("EPICS_HOST_ARCH", DEFAULT_ARCH)
+        """ Host architecture """
+
+        self.EPICS_TARGET_ARCH = os.getenv("EPICS_TARGET_ARCH", DEFAULT_ARCH)
+        """ Cross compilation target architecture """
+
+        self.IOC_ORIGINAL_LOCATION = Path(
+            os.getenv("IOC_ORIGINAL_LOCATION", self.EPICS_ROOT / "ioc")
+        )
+        """ The root folder for IOC source and binaries """
 
 
 GLOBALS = _Globals()

{rtems_proxy-1.3.0b4 → rtems_proxy-2.0.0}/src/rtems_proxy/trace.py

@@ -9,7 +9,7 @@ from .utils import run_command
 
 IP = re.compile(r"Stack Trace:\n *IP: *(0x[0-9a-f]*)")
 STACK = re.compile(r"--\^ (0x[0-9a-f]*)")
-symbols = GLOBALS.IOC / "bin" / "RTEMS-beatnik" / "ioc"
+symbols = GLOBALS.IOC_ORIGINAL_LOCATION / "bin" / "RTEMS-beatnik" / "ioc"
 
 
 def parse_stack_trace(trace: str):

{rtems_proxy-1.3.0b4 → rtems_proxy-2.0.0}/src/rtems_proxy.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rtems-proxy
-Version: 1.3.0b4
+Version: 2.0.0
 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-1.3.0b4/src/rtems_proxy/configure.py

@@ -1,89 +0,0 @@
-"""
-Class to apply MOTBoot configuration to a VME crate.
-"""
-
-from time import sleep
-
-from .globals import GLOBALS
-from .telnet import TelnetRTEMS
-
-
-class Configure:
-    def __init__(self, telnet: TelnetRTEMS, debug: bool = False):
-        self.telnet = telnet
-        self.debug = debug
-
-    def apply_nvm(self, variable: str, value: str):
-        self.telnet.sendline(f"gevE {variable}")
-        self.telnet.expect(r"\(Blank line terminates input.\)")
-        self.telnet.sendline(value + "\r")
-        self.telnet.sendline("\r")
-        self.telnet.expect(r"\?")
-        self.telnet.sendline("Y\r")
-
-    def apply_settings(self):
-        for v in [
-            GLOBALS.RTEMS_IOC_NETMASK,
-            GLOBALS.RTEMS_IOC_GATEWAY,
-            GLOBALS.RTEMS_IOC_IP,
-            GLOBALS.RTEMS_NFS_IP,
-            GLOBALS.RTEMS_TFTP_IP,
-        ]:
-            if v is None or v == "":
-                raise ValueError(
-                    "RTEMS_IOC_NETMASK, RTEMS_IOC_GATEWAY, RTEMS_IOC_IP, "
-                    "RTEMS_NFS_IP, and RTEMS_TFTP_IP must be set"
-                )
-
-        ioc_bin = "ioc" if self.debug else "ioc.boot"
-
-        if GLOBALS.RTEMS_EPICS_NFS_MOUNT:
-            nfs_mount = GLOBALS.RTEMS_EPICS_NFS_MOUNT
-        else:
-            nfs_mount = f"{GLOBALS.RTEMS_NFS_IP}:/iocs/{GLOBALS.IOC_NAME}:/epics"
-
-        if GLOBALS.RTEMS_EPICS_SCRIPT:
-            epics_script = GLOBALS.RTEMS_EPICS_SCRIPT
-        else:
-            epics_script = "/epics/runtime/st.cmd"
-
-        if GLOBALS.RTEMS_EPICS_BINARY:
-            epics_binary = GLOBALS.RTEMS_EPICS_BINARY
-        else:
-            epics_binary = f"{GLOBALS.IOC_NAME.lower()}/ioc/bin/RTEMS-beatnik/{ioc_bin}"
-
-        mot_boot = (
-            f"dla=malloc 0x4000000\r"
-            f"tftpGet -d/dev/enet1"
-            f" -f{epics_binary}"
-            f" -m{GLOBALS.RTEMS_IOC_NETMASK}"
-            f" -g{GLOBALS.RTEMS_IOC_GATEWAY}"
-            f" -s{GLOBALS.RTEMS_TFTP_IP}"
-            f" -c{GLOBALS.RTEMS_IOC_IP}"
-            f" -adla -r3 -v\r"
-            f"go -a04000000\r"
-            f"reset"
-        )
-
-        if GLOBALS.RTEMS_EPICS_NTP_SERVER:
-            self.apply_nvm("epics-ntpserver", GLOBALS.RTEMS_EPICS_NTP_SERVER)
-
-        # These checks were performed above, so we can safely assert non-None
-        assert GLOBALS.RTEMS_IOC_NETMASK is not None
-        assert GLOBALS.RTEMS_IOC_GATEWAY is not None
-        assert GLOBALS.RTEMS_NFS_IP is not None
-        assert GLOBALS.RTEMS_IOC_IP is not None
-
-        self.apply_nvm("mot-/dev/enet0-snma", GLOBALS.RTEMS_IOC_NETMASK)
-        self.apply_nvm("mot-/dev/enet0-gipa", GLOBALS.RTEMS_IOC_GATEWAY)
-        self.apply_nvm("mot-/dev/enet0-sipa", GLOBALS.RTEMS_NFS_IP)
-        self.apply_nvm("mot-/dev/enet0-cipa", GLOBALS.RTEMS_IOC_IP)
-        self.apply_nvm("mot-boot-device", "/dev/em1")
-        self.apply_nvm("mot-script-boot", mot_boot)
-        self.apply_nvm("rtems-client-name", GLOBALS.IOC_NAME)
-        self.apply_nvm("epics-script", epics_script)
-        self.apply_nvm("epics-nfsmount", nfs_mount)
-        # self.apply_nvm_variable("epics-ntpserver", "EPICS_TS_NTP_INET")
-        self.apply_nvm("mot-/dev/enet0-snma", GLOBALS.RTEMS_IOC_NETMASK)
-
-        sleep(1)

rtems_proxy-1.3.0b4/src/rtems_proxy/copy.py

@@ -1,44 +0,0 @@
-"""
-functions for moving IOC assets into position for a remote IOC to access
-"""
-
-import shutil
-
-from .globals import GLOBALS
-
-
-def copy_rtems():
-    """
-    Copy RTEMS IOC binary and startup assets 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
-
-    # 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"
-
-    # make sure all files are writable - by default some products are read-only
-    for folder in [dest_ioc, dest_runtime]:
-        for file in folder.glob("**/*"):
-            file.chmod(0o666)
-
-    # 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)