ci: Run system tests against containerised areadetector simulator (#1198)

* ci: Enable adsim tests to run

Co-authored-by: rtuck99 <robert.tuck@diamond.ac.uk>

Author: DiamondJoseph

.github/workflows/_test.yml

@@ -57,6 +57,21 @@ jobs:
         run: |
           python .github/scripts/check_test_durations.py unit-report.json 1
 
+      - name: Checkout simulated devices
+        uses: actions/checkout@v4
+        with:
+          repository: epics-containers/example-services
+          path: example-services
+
+      - name: Run docker compose
+        uses: hoverkraft-tech/compose-action@v2.2.0
+        with:
+          compose-file: "./example-services/compose.yaml"
+          services: |
+            bl01t-di-cam-01
+            bl01t-mo-sim-01
+            ca-gateway
+
       - name: Run system tests
         run: tox -e system-report
 

pyproject.toml

@@ -157,8 +157,8 @@ commands =
     type-checking: pyright src tests {posargs}
     pre-commit: pre-commit run --all-files --show-diff-on-failure {posargs}
     docs: sphinx-{posargs:build -E} -T docs build/html
-    unit-report: pytest -m 'not requires' --cov=dodal --cov-report term --cov-report xml:unit_cov.xml --json-report --json-report-file=unit-report.json tests {posargs}
-    system-report: pytest -m 'not requires or requires(external="internet")' --cov=dodal --cov-report term --cov-report xml:system_cov.xml --json-report --json-report-file=system-report.json system_tests {posargs}
+    unit-report: pytest --cov=dodal --cov-report term --cov-report xml:unit_cov.xml --json-report --json-report-file=unit-report.json tests {posargs}
+    system-report: pytest -m 'not requires(instrument="i04")' --cov=dodal --cov-report term --cov-report xml:system_cov.xml --json-report --json-report-file=system-report.json system_tests {posargs}
 """
 
 [tool.ruff]

system_tests/test_adsim.py

@@ -1,5 +1,7 @@
+import os
 from collections.abc import Generator
 from typing import cast
+from unittest.mock import patch
 
 import pytest
 from bluesky.run_engine import RunEngine
@@ -20,6 +22,38 @@
 from dodal.devices.adsim import SimStage
 from dodal.plans import count
 
+"""
+System tests that can be run against the containerised IOCs from epics-containers:
+https://github.com/epics-containers/example-services
+
+Check out that repository and using docker or podman deploy the services in the compose
+file:
+
+```sh
+docker compose up -d
+```
+
+Run these system tests, with your EPICS environment configured to talk to the gateways:
+```sh
+python -m pytest -m 'requires(instrument="adsim")'
+```
+
+"""
+
+
+@pytest.fixture(scope="module", autouse=True)
+def with_env():
+    with patch.dict(
+        os.environ,
+        {
+            "EPICS_CA_NAME_SERVERS": "127.0.0.1:5094",
+            "EPICS_PVA_NAME_SERVERS": "127.0.0.1:5095",
+            "EPICS_CA_ADDR_LIST": "127.0.0.1:5094",
+        },
+        clear=True,
+    ):
+        yield
+
 
 @pytest.fixture
 def det(RE) -> Generator[StandardDetector]:
@@ -126,8 +160,6 @@ def test_plan_produces_expected_resources(
         assert resource.get("mimetype") == "application/x-hdf5"
         assert resource.get("parameters") == {
             "dataset": "/entry/data/data",
-            "swmr": False,
-            "multiplier": 1,
             "chunk_shape": (1, 1024, 1024),
         }