Merge pull request #2502 from eerovaher/remote-test-modules

Recommend a better way to mark remote data tests in remote test modules
astropy · Sep 11, 2022 · 1ff3b7f · 1ff3b7f
2 parents 8bfeac0 + 361b242
commit 1ff3b7f
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 7 deletions.
diff --git a/astroquery/atomic/tests/test_atomic_remote.py b/astroquery/atomic/tests/test_atomic_remote.py
@@ -6,8 +6,9 @@
 
 from ...atomic import AtomicLineList
 
+pytestmark = pytest.mark.remote_data
+
 
-@pytest.mark.remote_data
 def test_default_form_values():
     default_response = AtomicLineList._request(
         method="GET", url=AtomicLineList.FORM_URL,
@@ -28,7 +29,6 @@ def test_default_form_values():
         'wave': u'Angstrom'}
 
 
-@pytest.mark.remote_data
 def test_query_with_default_params():
     table = AtomicLineList.query_object(cache=False)
     assert isinstance(table, Table)
@@ -43,7 +43,6 @@ def test_query_with_default_params():
        1.02916   Zn XXX  E1         1*-6*  1-6 1/2-* 1.33E+12 0.00 - 97174700.00'''.strip()
 
 
-@pytest.mark.remote_data
 def test_query_with_wavelength_params():
     result = AtomicLineList.query_object(
         wavelength_range=(15 * u.nm, 200 * u.Angstrom),
@@ -66,15 +65,13 @@ def test_query_with_wavelength_params():
                             '0.00 -   502481.80']))
 
 
-@pytest.mark.remote_data
 def test_empty_result_set():
     result = AtomicLineList.query_object(wavelength_accuracy=0, cache=False)
     assert isinstance(result, Table)
     assert not result
     assert len(result) == 0
 
 
-@pytest.mark.remote_data
 def test_lower_upper_ranges():
     result = AtomicLineList.query_object(
         lower_level_energy_range=u.Quantity((600 * u.cm**(-1), 1000 * u.cm**(-1))),

diff --git a/docs/testing.rst b/docs/testing.rst
@@ -84,8 +84,14 @@ the ``test_module.py`` file.
 ``test_module_remote.py``
 -------------------------
 
-The remote tests are much easier.  Just decorate the test class or test
-functions with ``@pytest.mark.remote_data``.
+The remote tests are much easier. The file must contain the following::
+
+    import pytest
+
+    pytestmark = pytest.mark.remote_data
+
+This ensures that the test functions in remote test module are only executed if
+the ``--remote-data`` flag is used.
 
 ``setup_package.py``
 --------------------