Individual test .py files have been altered to use 'get_test_source', rather than fetching declared sources directly from the init. CAUTION THIS IS LIKELY NOT FUNCTIONING RIGHT QUITE YET.

Signed-off-by: David Turner <djturner@umbc.edu>

Author: David Turner

tests/__init__.py

@@ -1,5 +1,5 @@
-#  This code is a part of X-ray: Generate and Analyse (XGA), a module designed for the XMM Cluster Survey (XCS).
-#  Last modified by David J Turner (turne540@msu.edu) 20/02/2023, 14:04. Copyright (c) The Contributors
+#  This code is part of X-ray: Generate and Analyse (XGA), a module designed for the XMM Cluster Survey (XCS).
+#  Last modified by David J Turner (djturner@umbc.edu) 4/24/26, 1:14 PM. Copyright (c) The Contributors.
 from astropy.units import Quantity
 import numpy as np
 import pandas as pd
@@ -31,30 +31,47 @@
 CLUSTER_SMP = pd.DataFrame(data=cluster_data, columns=column_names)
 CLUSTER_SMP[['ra', 'dec', 'z', 'r500']] = CLUSTER_SMP[['ra', 'dec', 'z', 'r500']].astype(float)
 
-SRC_ALL_TELS = GalaxyCluster(SRC_INFO['ra'],
-                             SRC_INFO['dec'],
-                             SRC_INFO['z'],
-                             r500=Quantity(500, 'kpc'),
-                             name=SRC_INFO['name'],
-                             use_peak=False,
-                             search_distance={'erosita': Quantity(3.6, 'deg')},
-                             load_profiles=False)
-    
-SRC_XMM = GalaxyCluster(SRC_INFO['ra'],
-                        SRC_INFO['dec'],
-                        SRC_INFO['z'],
-                        r500=Quantity(500, 'kpc'),
-                        name=SRC_INFO['name'],
-                        use_peak=False,
-                        telescope='xmm',
-                        load_profiles=False)
-
-SRC_ERO = GalaxyCluster(SRC_INFO['ra'],
-                        SRC_INFO['dec'],
-                        SRC_INFO['z'],
-                        r500=Quantity(500, 'kpc'),
-                        name=SRC_INFO['name'],
-                        use_peak=False,
-                        telescope='erosita',
-                        search_distance={'erosita': Quantity(3.6, 'deg')},
-                        load_profiles=False)
+
+# We use a factory pattern to provide the test sources, this is because they are expensive to instantiate
+#  and we don't want to do it at import time, as the configuration might not be set up yet.
+_CACHED_SOURCES = {}
+
+def get_test_source(telescope: str = 'all', shared: bool = True) -> GalaxyCluster:
+    """
+    A factory function to provide test sources. This is used to avoid instantiating them at import time.
+
+    :param str telescope: The telescope for which we want a source. Options are 'all', 'xmm', 'erosita'.
+    :param bool shared: Whether to return a shared (cached) instance or a fresh one.
+    :return: The requested source.
+    :rtype: GalaxyCluster
+    """
+    global _CACHED_SOURCES
+
+    # If a shared instance is requested, and we have one cached, return it
+    if shared and telescope in _CACHED_SOURCES:
+        return _CACHED_SOURCES[telescope]
+
+    # Otherwise we set up the requested source instance for testing.
+    if telescope == 'all':
+        src = GalaxyCluster(SRC_INFO['ra'], SRC_INFO['dec'], SRC_INFO['z'], r500=Quantity(500, 'kpc'),
+                            name=SRC_INFO['name'], use_peak=False,
+                            search_distance={'erosita': Quantity(3.6, 'deg')},
+                            load_profiles=False)
+    elif telescope == 'xmm':
+        src = GalaxyCluster(SRC_INFO['ra'], SRC_INFO['dec'], SRC_INFO['z'], r500=Quantity(500, 'kpc'),
+                            name=SRC_INFO['name'], use_peak=False,
+                            telescope='xmm', load_profiles=False)
+    elif telescope == 'erosita':
+        src = GalaxyCluster(SRC_INFO['ra'], SRC_INFO['dec'], SRC_INFO['z'], r500=Quantity(500, 'kpc'),
+                            name=SRC_INFO['name'], use_peak=False,
+                            telescope='erosita',
+                            search_distance={'erosita': Quantity(3.6, 'deg')},
+                            load_profiles=False)
+    else:
+        raise ValueError(f"Unknown mission name: {telescope}")
+
+    # If a shared instance was requested, cache it
+    if shared:
+        _CACHED_SOURCES[telescope] = src
+
+    return src

tests/test_generate/test_ciao_phot.py

@@ -1,4 +1,8 @@
+#  This code is part of X-ray: Generate and Analyse (XGA), a module designed for the XMM Cluster Survey (XCS).
+#  Last modified by David J Turner (djturner@umbc.edu) 4/27/26, 10:27 AM. Copyright (c) The Contributors.
+
 import unittest
+from ..utils import require_ciao
 import sys
 import os
 
@@ -14,31 +18,37 @@
 sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), '..')))
 
 
-from .. import SRC_ALL_TELS, SROC_ERO
+from .. import get_test_source
 
 
 class TestCiaoPhotFuncs(unittest.TestCase):
+    @classmethod
+    def setUpClass(cls):
+        cls.src = get_test_source('all')
+
+    @require_ciao
     def test_chandra_image_expmap_no_tel_error(self):
         """
         Testing that TelescopeNotAssociatedError is raised when Chandra isn't associated.
         """
         with self.assertRaises(TelescopeNotAssociatedError):
-            chandra_image_expmap(SRC_ERO)
+            chandra_image_expmap(self.src)
 
+    @require_ciao
     def test_chandra_image_expmap_if_available(self):
         """
         Test chandra_image_expmap if Chandra data is available. Will skip if no Chandra observations.
         """
         # Check if Chandra is actually available for this source
-        if 'chandra' not in SRC_ALL_TELS.obs_ids or len(SRC_ALL_TELS.obs_ids.get('chandra', [])) == 0:
+        if 'chandra' not in self.src.obs_ids or len(self.src.obs_ids.get('chandra', [])) == 0:
             self.skipTest("No Chandra observations available for test source")
 
         # If we get here, Chandra data exists - try to generate products
-        chandra_image_expmap(SRC_ALL_TELS, Quantity(0.5, 'keV'), Quantity(2.0, 'keV'))
+        chandra_image_expmap(self.src, Quantity(0.5, 'keV'), Quantity(2.0, 'keV'))
 
         # Try to retrieve the generated products
         try:
-            im = SRC_ALL_TELS.get_images(lo_en=Quantity(0.5, 'keV'), hi_en=Quantity(2.0, 'keV'),
+            im = self.src.get_images(lo_en=Quantity(0.5, 'keV'), hi_en=Quantity(2.0, 'keV'),
                                          telescope='chandra')
             if isinstance(im, list):
                 for i in im:
@@ -58,3 +68,6 @@ def test_chandra_image_expmap_if_available(self):
 
 if __name__ == "__main__":
     unittest.main()
+
+
+

tests/test_generate/test_ciao_spec.py

@@ -1,4 +1,8 @@
+#  This code is part of X-ray: Generate and Analyse (XGA), a module designed for the XMM Cluster Survey (XCS).
+#  Last modified by David J Turner (djturner@umbc.edu) 4/27/26, 10:24 AM. Copyright (c) The Contributors.
+
 import unittest
+from ..utils import require_ciao
 import sys
 import os
 
@@ -14,31 +18,37 @@
 sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), '..')))
 
 
-from .. import SRC_ALL_TELS, SRC_ERO
+from .. import get_test_source
 
 
 class TestCiaoSpecFuncs(unittest.TestCase):
+    @classmethod
+    def setUpClass(cls):
+        cls.src = get_test_source('all')
+
+    @require_ciao
     def test_specextract_spectrum_no_tel_error(self):
         """
         Testing that TelescopeNotAssociatedError is raised when Chandra isn't associated.
         """
         with self.assertRaises(TelescopeNotAssociatedError):
-            specextract_spectrum(SRC_ERO, 'r500')
+            specextract_spectrum(self.src, 'r500')
 
+    @require_ciao
     def test_specextract_spectrum_if_available(self):
         """
         Test specextract_spectrum if Chandra data is available. Will skip if no Chandra observations.
         """
         # Check if Chandra is actually available for this source
-        if 'chandra' not in SRC_ALL_TELS.obs_ids or len(SRC_ALL_TELS.obs_ids.get('chandra', [])) == 0:
+        if 'chandra' not in self.src.obs_ids or len(self.src.obs_ids.get('chandra', [])) == 0:
             self.skipTest("No Chandra observations available for test source")
 
         # If we get here, Chandra data exists - try to generate spectra
-        specextract_spectrum(SRC_ALL_TELS, 'r500')
+        specextract_spectrum(self.src, 'r500')
 
         # Try to retrieve the generated products
         try:
-            spec = SRC_ALL_TELS.get_spectra('r500', telescope='chandra')
+            spec = self.src.get_spectra('r500', telescope='chandra')
             if isinstance(spec, list):
                 for s in spec:
                     assert s.telescope == 'chandra'
@@ -53,3 +63,6 @@ def test_specextract_spectrum_if_available(self):
 
 if __name__ == "__main__":
     unittest.main()
+
+
+

tests/test_generate/test_esass_lightcurve.py

@@ -1,27 +1,31 @@
-import unittest
+#  This code is part of X-ray: Generate and Analyse (XGA), a module designed for the XMM Cluster Survey (XCS).
+#  Last modified by David J Turner (djturner@umbc.edu) 4/27/26, 10:28 AM. Copyright (c) The Contributors.
 
-from astropy.units import Quantity
-import os 
+import os
 import sys
+import unittest
 
-import xga
-from xga.sources import GalaxyCluster
 from xga.generate.esass.lightcurve import srctool_lightcurve
 from xga.products.lightcurve import LightCurve
-
+from ..utils import require_esass
 
 sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), '..')))
 
-from .. import SRC_ALL_TELS
+from .. import get_test_source
+
+class TestEsassLcFuncs(unittest.TestCase):
+    @classmethod
+    def setUpClass(cls):
+        cls.src = get_test_source('erosita')
 
-class TestEsassLcFuncs(unittest.TestCase):    
+    @require_esass
     def test_srctool_lightcurve_combine_insts_f_combine_obs_f(self):
         """
         Testing srctool_lightcurve with the arguments combine_insts=False and combine_obs=False
         """
-        srctool_lightcurve(SRC_ALL_TELS, 'r500', combine_tm=False, combine_obs=False)
+        srctool_lightcurve(self.src, 'r500', combine_tm=False, combine_obs=False)
 
-        lc = SRC_ALL_TELS.get_lightcurves('r500', telescope='erosita', inst='tm1')
+        lc = self.src.get_lightcurves('r500', telescope='erosita', inst='tm1')
 
         if isinstance(lc, list):
             for l in lc:
@@ -35,13 +39,14 @@ def test_srctool_lightcurve_combine_insts_f_combine_obs_f(self):
             assert lc.obs_id != 'combined'
             assert lc.instrument == 'tm1'
 
+    @require_esass
     def test_srctool_lightcurve_combine_insts_t_combine_obs_f(self):
         """
         Testing srctool_lightcurve with the arguments combine_insts=True and combine_obs=False
         """
-        srctool_lightcurve(SRC_ALL_TELS, 'r500', combine_tm=True, combine_obs=False)
+        srctool_lightcurve(self.src, 'r500', combine_tm=True, combine_obs=False)
 
-        lc = SRC_ALL_TELS.get_lightcurves('r500', telescope='erosita', inst='combined')
+        lc = self.src.get_lightcurves('r500', telescope='erosita', inst='combined')
 
         if isinstance(lc, list):
             for l in lc:
@@ -56,26 +61,28 @@ def test_srctool_lightcurve_combine_insts_t_combine_obs_f(self):
             assert lc.instrument == 'combined'
 
 
+    @require_esass
     def test_srctool_lightcurve_combine_insts_f_combine_obs_t(self):
         """
         Testing srctool_lightcurve with the arguments combine_insts=False and combine_obs=True
         """
-        srctool_lightcurve(SRC_ALL_TELS, 'r500', combine_tm=False, combine_obs=True)
+        srctool_lightcurve(self.src, 'r500', combine_tm=False, combine_obs=True)
 
-        lc = SRC_ALL_TELS.get_combined_lightcurves('r500', telescope='erosita', inst='tm1')
+        lc = self.src.get_combined_lightcurves('r500', telescope='erosita', inst='tm1')
 
         assert isinstance(lc, LightCurve)
         assert lc.telescope == 'erosita'
         assert lc.obs_id == 'combined'
         assert lc.instrument == 'tm1'
 
+    @require_esass
     def test_srctool_lightcurve_combine_insts_t_combine_obs_t(self):
         """
         Testing srctool_lightcurve with the arguments combine_insts=True and combine_obs=True
         """
-        srctool_lightcurve(SRC_ALL_TELS, 'r500', combine_tm=True, combine_obs=True)
+        srctool_lightcurve(self.src, 'r500', combine_tm=True, combine_obs=True)
 
-        lc = SRC_ALL_TELS.get_combined_lightcurves('r500', telescope='erosita', inst='combined')
+        lc = self.src.get_combined_lightcurves('r500', telescope='erosita', inst='combined')
 
         if isinstance(lc, list):
             for l in lc:
@@ -87,4 +94,6 @@ def test_srctool_lightcurve_combine_insts_t_combine_obs_t(self):
             assert isinstance(lc, LightCurve)
             assert lc.telescope == 'erosita'
             assert lc.obs_id == 'combined'
-            assert lc.instrument == 'combined'
+            assert lc.instrument == 'combined'
+
+

tests/test_generate/test_esass_misc.py

@@ -1,25 +1,29 @@
-import unittest
+#  This code is part of X-ray: Generate and Analyse (XGA), a module designed for the XMM Cluster Survey (XCS).
+#  Last modified by David J Turner (djturner@umbc.edu) 4/24/26, 1:36 PM. Copyright (c) The Contributors.
 
-from astropy.units import Quantity
-import sys
 import os
+import sys
+import unittest
 
-import xga
-from xga.sources import GalaxyCluster
 from xga.generate.esass.misc import evtool_combine_evts
-
+from ..utils import require_esass
 
 sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), '..')))
 
-from ..import SRC_ALL_TELS
+from .. import get_test_source
 
 class TestEsassMiscFuncs(unittest.TestCase):
+    @classmethod
+    def setUpClass(cls):
+        cls.src = get_test_source('erosita')
+
+    @require_esass
     def test_evtool_combine_evts(self):
-        evtool_combine_evts(SRC_ALL_TELS)
+        evtool_combine_evts(self.src)
 
-        evtlist = SRC_ALL_TELS.get_products("combined_events", just_obj=False, telescope='erosita')[0][-1]
+        evtlist = self.src.get_products("combined_events", just_obj=False, telescope='erosita')[0][-1]
         assert evtlist.telescope == 'erosita'
-        assert set(evtlist.obs_ids) == set(SRC_ALL_TELS.obs_ids['erosita'])
+        assert set(evtlist.obs_ids) == set(self.src.obs_ids['erosita'])
 
 if __name__ == "__main__":
-     unittest.main()
+     unittest.main()