Move data registries into tests

Author: jl-wynen

src/ess/reduce/data/__init__.py

@@ -6,103 +6,12 @@
 It has to be installed separately with either pip or conda.
 """
 
-from pathlib import Path
-
 from ._registry import Entry, LocalRegistry, PoochRegistry, Registry, make_registry
 
-_bifrost_registry = make_registry(
-    'ess/bifrost',
-    files={
-        "BIFROST_20240914T053723.h5": "md5:0f2fa5c9a851f8e3a4fa61defaa3752e",
-    },
-    version='1',
-)
-
-
-_dream_registry = make_registry(
-    'ess/dream',
-    files={
-        "TEST_977695_00068064.hdf": "md5:9e6ee9ec70d7c5e8c0c93b9e07e8949f",
-    },
-    version='2',
-)
-
-
-_loki_registry = make_registry(
-    'ess/loki',
-    files={
-        # Files from LoKI@Larmor detector test experiment
-        #
-        # Background run 1 (no sample, sample holder/can only, no transmission monitor)
-        '60248-2022-02-28_2215.nxs': 'md5:d9f17b95274a0fc6468df7e39df5bf03',
-        # Sample run 1 (sample + sample holder/can, no transmission monitor in beam)
-        '60250-2022-02-28_2215.nxs': 'md5:6a519ceaacbae702a6d08241e86799b1',
-        # Sample run 2 (sample + sample holder/can, no transmission monitor in beam)
-        '60339-2022-02-28_2215.nxs': 'md5:03c86f6389566326bb0cbbd80b8f8c4f',
-        # Background transmission run (sample holder/can + transmission monitor)
-        '60392-2022-02-28_2215.nxs': 'md5:9ecc1a9a2c05a880144afb299fc11042',
-        # Background run 2 (no sample, sample holder/can only, no transmission monitor)
-        '60393-2022-02-28_2215.nxs': 'md5:bf550d0ba29931f11b7450144f658652',
-        # Sample transmission run (sample + sample holder/can + transmission monitor)
-        '60394-2022-02-28_2215.nxs': 'md5:c40f38a62337d86957af925296c4c615',
-        # Analytical model for the I(Q) of the Poly-Gauss sample
-        'PolyGauss_I0-50_Rg-60.h5': 'md5:f5d60d9c2286cb197b8cd4dc82db3d7e',
-        # XML file for the pixel mask
-        'mask_new_July2022.xml': 'md5:421b6dc9db74126ffbc5d88164d017b0',
-    },
-    version='2',
-)
-
-
-def bifrost_simulated_elastic() -> Path:
-    """McStas simulation with elastic incoherent scattering + phonon."""
-    return _bifrost_registry.get_path('BIFROST_20240914T053723.h5')
-
-
-def loki_tutorial_sample_run_60250() -> Path:
-    """Sample run with sample and sample holder/can, no transmission monitor in beam."""
-    return _loki_registry.get_path('60250-2022-02-28_2215.nxs')
-
-
-def loki_tutorial_sample_run_60339() -> Path:
-    """Sample run with sample and sample holder/can, no transmission monitor in beam."""
-    return _loki_registry.get_path('60339-2022-02-28_2215.nxs')
-
-
-def loki_tutorial_background_run_60248() -> Path:
-    """Background run with sample holder/can only, no transmission monitor."""
-    return _loki_registry.get_path('60248-2022-02-28_2215.nxs')
-
-
-def loki_tutorial_background_run_60393() -> Path:
-    """Background run with sample holder/can only, no transmission monitor."""
-    return _loki_registry.get_path('60393-2022-02-28_2215.nxs')
-
-
-def loki_tutorial_sample_transmission_run() -> Path:
-    """Sample transmission run (sample + sample holder/can + transmission monitor)."""
-    return _loki_registry.get_path('60394-2022-02-28_2215.nxs')
-
-
-def dream_coda_test_file() -> Path:
-    """CODA file for DREAM where most pulses have been removed.
-
-    See ``tools/shrink_nexus.py``.
-    """
-    return _dream_registry.get_path('TEST_977695_00068064.hdf')
-
-
 __all__ = [
     'Entry',
     'LocalRegistry',
     'PoochRegistry',
     'Registry',
-    'bifrost_simulated_elastic',
-    'dream_coda_test_file',
-    'loki_tutorial_background_run_60248',
-    'loki_tutorial_background_run_60393',
-    'loki_tutorial_sample_run_60250',
-    'loki_tutorial_sample_run_60339',
-    'loki_tutorial_sample_transmission_run',
     'make_registry',
 ]

tests/conftest.py

@@ -0,0 +1,103 @@
+# SPDX-License-Identifier: BSD-3-Clause
+# Copyright (c) 2025 Scipp contributors (https://github.com/scipp)
+
+from pathlib import Path
+
+import pytest
+
+from ess.reduce.data import Registry, make_registry
+
+
+@pytest.fixture(scope='session')
+def bifrost_registry() -> Registry:
+    return make_registry(
+        'ess/bifrost',
+        files={
+            "BIFROST_20240914T053723.h5": "md5:0f2fa5c9a851f8e3a4fa61defaa3752e",
+        },
+        version='1',
+    )
+
+
+@pytest.fixture(scope='session')
+def dream_registry() -> Registry:
+    return make_registry(
+        'ess/dream',
+        files={
+            "TEST_977695_00068064.hdf": "md5:9e6ee9ec70d7c5e8c0c93b9e07e8949f",
+        },
+        version='2',
+    )
+
+
+@pytest.fixture(scope='session')
+def loki_registry() -> Registry:
+    return make_registry(
+        'ess/loki',
+        files={
+            # Files from LoKI@Larmor detector test experiment
+            #
+            # Background run 1 (no sample, sample holder/can only, no transmission monitor)  # noqa: E501
+            '60248-2022-02-28_2215.nxs': 'md5:d9f17b95274a0fc6468df7e39df5bf03',
+            # Sample run 1 (sample + sample holder/can, no transmission monitor in beam)
+            '60250-2022-02-28_2215.nxs': 'md5:6a519ceaacbae702a6d08241e86799b1',
+            # Sample run 2 (sample + sample holder/can, no transmission monitor in beam)
+            '60339-2022-02-28_2215.nxs': 'md5:03c86f6389566326bb0cbbd80b8f8c4f',
+            # Background transmission run (sample holder/can + transmission monitor)
+            '60392-2022-02-28_2215.nxs': 'md5:9ecc1a9a2c05a880144afb299fc11042',
+            # Background run 2 (no sample, sample holder/can only, no transmission monitor)  # noqa: E501
+            '60393-2022-02-28_2215.nxs': 'md5:bf550d0ba29931f11b7450144f658652',
+            # Sample transmission run (sample + sample holder/can + transmission monitor)  # noqa: E501
+            '60394-2022-02-28_2215.nxs': 'md5:c40f38a62337d86957af925296c4c615',
+            # Analytical model for the I(Q) of the Poly-Gauss sample
+            'PolyGauss_I0-50_Rg-60.h5': 'md5:f5d60d9c2286cb197b8cd4dc82db3d7e',
+            # XML file for the pixel mask
+            'mask_new_July2022.xml': 'md5:421b6dc9db74126ffbc5d88164d017b0',
+        },
+        version='2',
+    )
+
+
+@pytest.fixture(scope='session')
+def bifrost_simulated_elastic(bifrost_registry: Registry) -> Path:
+    """McStas simulation with elastic incoherent scattering + phonon."""
+    return bifrost_registry.get_path('BIFROST_20240914T053723.h5')
+
+
+@pytest.fixture(scope='session')
+def loki_tutorial_sample_run_60250(loki_registry: Registry) -> Path:
+    """Sample run with sample and sample holder/can, no transmission monitor in beam."""
+    return loki_registry.get_path('60250-2022-02-28_2215.nxs')
+
+
+@pytest.fixture(scope='session')
+def loki_tutorial_sample_run_60339(loki_registry: Registry) -> Path:
+    """Sample run with sample and sample holder/can, no transmission monitor in beam."""
+    return loki_registry.get_path('60339-2022-02-28_2215.nxs')
+
+
+@pytest.fixture(scope='session')
+def loki_tutorial_background_run_60248(loki_registry: Registry) -> Path:
+    """Background run with sample holder/can only, no transmission monitor."""
+    return loki_registry.get_path('60248-2022-02-28_2215.nxs')
+
+
+@pytest.fixture(scope='session')
+def loki_tutorial_background_run_60393(loki_registry: Registry) -> Path:
+    """Background run with sample holder/can only, no transmission monitor."""
+    return loki_registry.get_path('60393-2022-02-28_2215.nxs')
+
+
+@pytest.fixture(scope='session')
+def loki_tutorial_sample_transmission_run(loki_registry: Registry) -> Path:
+    """Sample transmission run (sample + sample holder/can + transmission monitor)."""
+    return loki_registry.get_path('60394-2022-02-28_2215.nxs')
+
+
+@pytest.fixture(scope='session')
+def dream_coda_test_file(dream_registry: Registry) -> Path:
+    """CODA file for DREAM where most pulses have been removed.
+
+    See ``tools/shrink_nexus.py``.
+    """
+    return dream_registry.get_path('TEST_977695_00068064.hdf')

tests/nexus/json_generator_test.py

@@ -1,16 +1,19 @@
 # SPDX-License-Identifier: BSD-3-Clause
 # Copyright (c) 2024 Scipp contributors (https://github.com/scipp)
+from pathlib import Path
+
 import pytest
 import scippnexus as snx
 from scipp.testing import assert_identical
 
-from ess.reduce import data
 from ess.reduce.nexus.json_generator import event_data_generator
 from ess.reduce.nexus.json_nexus import json_nexus_group
 
 
-def test_event_data_generator_monitor_events_round_trip() -> None:
-    filename = data.loki_tutorial_sample_run_60250()
+def test_event_data_generator_monitor_events_round_trip(
+    loki_tutorial_sample_run_60250: Path,
+) -> None:
+    filename = loki_tutorial_sample_run_60250
     monitor = snx.load(filename, root='entry/instrument/monitor_1/monitor_1_events')
     generator = event_data_generator(monitor)
     for i in range(len(monitor)):
@@ -20,8 +23,10 @@ def test_event_data_generator_monitor_events_round_trip() -> None:
         next(generator)
 
 
-def test_event_data_generator_detector_events_round_trip() -> None:
-    filename = data.loki_tutorial_sample_run_60250()
+def test_event_data_generator_detector_events_round_trip(
+    loki_tutorial_sample_run_60250: Path,
+) -> None:
+    filename = loki_tutorial_sample_run_60250
     detector = snx.load(
         filename, root='entry/instrument/larmor_detector/larmor_detector_events'
     )
@@ -31,8 +36,10 @@ def test_event_data_generator_detector_events_round_trip() -> None:
         assert_identical(group[()], detector[i : i + 1])
 
 
-def test_event_data_generator_without_event_id_yields_ones() -> None:
-    filename = data.loki_tutorial_sample_run_60250()
+def test_event_data_generator_without_event_id_yields_ones(
+    loki_tutorial_sample_run_60250: Path,
+) -> None:
+    filename = loki_tutorial_sample_run_60250
     base = snx.load(filename, root='entry/instrument/monitor_1/monitor_1_events')
     monitor = base.bins.drop_coords('event_id')
     generator = event_data_generator(monitor)

tests/nexus/workflow_test.py

@@ -1,13 +1,13 @@
 # SPDX-License-Identifier: BSD-3-Clause
 # Copyright (c) 2024 Scipp contributors (https://github.com/scipp)
 from datetime import UTC, datetime
+from pathlib import Path
 
 import pytest
 import scipp as sc
 import scippnexus as snx
 from scipp.testing import assert_identical
 
-from ess.reduce import data
 from ess.reduce.nexus import compute_component_position, workflow
 from ess.reduce.nexus.types import (
     BackgroundRun,
@@ -176,11 +176,11 @@ def test_to_transform_raises_if_interval_does_not_yield_unique_value(
         )
 
 
-def test_given_no_sample_load_nexus_sample_returns_group_with_origin_depends_on() -> (
-    None
-):
+def test_given_no_sample_load_nexus_sample_returns_group_with_origin_depends_on(
+    loki_tutorial_sample_run_60250: Path,
+) -> None:
     filespec = workflow.file_path_to_file_spec(
-        data.loki_tutorial_sample_run_60250(), preopen=True
+        loki_tutorial_sample_run_60250, preopen=True
     )
     spec = workflow.unique_component_spec(filespec)
     assert spec.filename['/entry'][snx.NXsample] == {}
@@ -549,9 +549,9 @@ def test_assemble_monitor_preserves_masks(calibrated_monitor, monitor_event_data
     assert 'mymask' in monitor_data.masks
 
 
-def test_load_event_monitor_workflow() -> None:
+def test_load_event_monitor_workflow(loki_tutorial_sample_run_60250: Path) -> None:
     wf = LoadMonitorWorkflow(run_types=[SampleRun], monitor_types=[FrameMonitor1])
-    wf[Filename[SampleRun]] = data.loki_tutorial_sample_run_60250()
+    wf[Filename[SampleRun]] = loki_tutorial_sample_run_60250
     wf[NeXusName[FrameMonitor1]] = 'monitor_1'
     da = wf.compute(MonitorData[SampleRun, FrameMonitor1])
     assert 'position' in da.coords
@@ -561,9 +561,9 @@ def test_load_event_monitor_workflow() -> None:
     assert da.bins.constituents['data'].variances is not None
 
 
-def test_load_histogram_monitor_workflow() -> None:
+def test_load_histogram_monitor_workflow(dream_coda_test_file: Path) -> None:
     wf = LoadMonitorWorkflow(run_types=[SampleRun], monitor_types=[FrameMonitor1])
-    wf[Filename[SampleRun]] = data.dream_coda_test_file()
+    wf[Filename[SampleRun]] = dream_coda_test_file
     wf[NeXusName[FrameMonitor1]] = 'monitor_bunker'
     da = wf.compute(MonitorData[SampleRun, FrameMonitor1])
     assert 'position' in da.coords
@@ -575,9 +575,9 @@ def test_load_histogram_monitor_workflow() -> None:
     assert da.variances is not None
 
 
-def test_load_detector_workflow() -> None:
+def test_load_detector_workflow(loki_tutorial_sample_run_60250: Path) -> None:
     wf = LoadDetectorWorkflow(run_types=[SampleRun], monitor_types=[])
-    wf[Filename[SampleRun]] = data.loki_tutorial_sample_run_60250()
+    wf[Filename[SampleRun]] = loki_tutorial_sample_run_60250
     wf[NeXusName[snx.NXdetector]] = 'larmor_detector'
     da = wf.compute(DetectorData[SampleRun])
     assert 'position' in da.coords
@@ -588,9 +588,11 @@ def test_load_detector_workflow() -> None:
 
 
 @pytest.mark.parametrize('preopen', [True, False])
-def test_generic_nexus_workflow(preopen: bool) -> None:
+def test_generic_nexus_workflow(
+    preopen: bool, loki_tutorial_sample_run_60250: Path
+) -> None:
     wf = GenericNeXusWorkflow(run_types=[SampleRun], monitor_types=[FrameMonitor1])
-    wf[Filename[SampleRun]] = data.loki_tutorial_sample_run_60250()
+    wf[Filename[SampleRun]] = loki_tutorial_sample_run_60250
     wf[NeXusName[FrameMonitor1]] = 'monitor_1'
     wf[NeXusName[snx.NXdetector]] = 'larmor_detector'
     wf[PreopenNeXusFile] = preopen
@@ -607,9 +609,9 @@ def test_generic_nexus_workflow(preopen: bool) -> None:
     assert da.dims == ('event_time_zero',)
 
 
-def test_generic_nexus_workflow_load_choppers() -> None:
+def test_generic_nexus_workflow_load_choppers(bifrost_simulated_elastic: Path) -> None:
     wf = GenericNeXusWorkflow(run_types=[SampleRun], monitor_types=[])
-    wf[Filename[SampleRun]] = data.bifrost_simulated_elastic()
+    wf[Filename[SampleRun]] = bifrost_simulated_elastic
     choppers = wf.compute(RawChoppers[SampleRun])
 
     assert choppers.keys() == {
@@ -626,20 +628,24 @@ def test_generic_nexus_workflow_load_choppers() -> None:
     assert chopper['slit_edges'].shape == (2,)
 
 
-def test_generic_nexus_workflow_load_beamline_metadata() -> None:
+def test_generic_nexus_workflow_load_beamline_metadata(
+    bifrost_simulated_elastic: Path,
+) -> None:
     wf = GenericNeXusWorkflow(run_types=[SampleRun], monitor_types=[])
-    wf[Filename[SampleRun]] = data.bifrost_simulated_elastic()
+    wf[Filename[SampleRun]] = bifrost_simulated_elastic
     beamline = wf.compute(Beamline)
 
     assert beamline.name == 'BIFROST'
     assert beamline.facility == 'ESS'
     assert beamline.site == 'ESS'
 
 
-def test_generic_nexus_workflow_load_measurement_metadata() -> None:
+def test_generic_nexus_workflow_load_measurement_metadata(
+    loki_tutorial_sample_run_60250: Path, loki_tutorial_background_run_60248: Path
+) -> None:
     wf = GenericNeXusWorkflow(run_types=[SampleRun], monitor_types=[])
-    wf[Filename[SampleRun]] = data.loki_tutorial_sample_run_60250()
-    wf[Filename[BackgroundRun]] = data.loki_tutorial_background_run_60248()
+    wf[Filename[SampleRun]] = loki_tutorial_sample_run_60250
+    wf[Filename[BackgroundRun]] = loki_tutorial_background_run_60248
     measurement = wf.compute(Measurement)
 
     assert measurement.title == 'My experiment'