TST: add a caproto IOC fixture to be able to start and test against i…

…t in CI

pyproject.toml

@@ -88,6 +88,7 @@ testpaths = [
 markers = [
     "hardware: marks tests as requiring the hardware IOC to be available/running (deselect with '-m \"not hardware\"')",
     "tiled: marks tests as requiring tiled",
+    "cloud_friendly: marks tests to be able to execute in the CI in the cloud",
 ]
 
 [tool.coverage]

tests/conftest.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import subprocess
+import sys
 import time as ttime
 
 import pytest
@@ -16,20 +17,33 @@ def zebra_ophyd_caproto():
 
 
 @pytest.fixture(scope="session")
-def _caproto_ioc():
-    command = 'EPICS_CAS_BEACON_ADDR_LIST=127.0.0.1 EPICS_CAS_AUTO_BEACON_ADDR_LIST=no python -m srx_caproto_iocs.zebra.caproto_ioc --prefix="XF:05IDD-ES:1{{Dev:Zebra2}}:" --list-pvs'
+def caproto_ioc(wait=3):
+    env = {
+        "EPICS_CAS_BEACON_ADDR_LIST": "127.0.0.1",
+        "EPICS_CAS_AUTO_BEACON_ADDR_LIST": "no",
+    }
+    command = (
+        sys.executable
+        + " -m srx_caproto_iocs.zebra.caproto_ioc --prefix=XF:05IDD-ES:1{{Dev:Zebra2}}: --list-pvs"
+    )
+    print(
+        f"Starting caproto IOC in via a fixture using the following command:\n\n  {command}\n"
+    )
     p = subprocess.Popen(
         command.split(),
         start_new_session=True,
         stdout=subprocess.PIPE,
         stderr=subprocess.STDOUT,
-        shell=True,
+        shell=False,
+        env=env,
     )
-    ttime.sleep(2.0)
+    print(f"Wait for {wait} seconds...")
+    ttime.sleep(wait)
 
-    yield
+    yield p
+
+    p.terminate()
 
     std_out, std_err = p.communicate()
     std_out = std_out.decode()
     print(std_out)
-    p.terminate()

tests/test_zebra_ophyd.py

@@ -9,19 +9,16 @@
 from srx_caproto_iocs.utils import now
 
 
-@pytest.mark.hardware()
-@pytest.mark.usefixtures("_caproto_ioc")
+@pytest.mark.cloud_friendly()
 @pytest.mark.parametrize("date_template", ["%Y/%m/", "%Y/%m/%d", "mydir/%Y/%m/%d"])
-def test_zebra_ophyd_caproto(zebra_ophyd_caproto, date_template):
+def test_zebra_ophyd_caproto(caproto_ioc, zebra_ophyd_caproto, date_template):
     with tempfile.TemporaryDirectory() as tmpdirname:
         date = now(as_object=True)
         write_dir_root = Path(tmpdirname)
         dir_template = f"{write_dir_root}/{date_template}"
         write_dir = Path(date.strftime(dir_template))
         write_dir.mkdir(parents=True, exist_ok=True)
 
-        print(f"{write_dir = }")
-
         file_template = "scan_{num:06d}_{uid}.hdf5"
 
         dev = zebra_ophyd_caproto
@@ -39,3 +36,5 @@ def cb(value, old_value, **kwargs):
 
         full_file_path = dev.full_file_path.get()
         print(f"{full_file_path = }")
+
+        assert full_file_path, "The returned 'full_file_path' did not change."