Use pytest-remotedata for offline/online test split

Author: Cadair

.coveragerc

@@ -4,6 +4,8 @@ omit =
   sunpy_soar/*setup_package*
   sunpy_soar/extern/*
   sunpy_soar/version*
+  sunpy_soar/_dev/*
+  */sunpy_soar/_dev/*
   */sunpy_soar/conftest.py
   */sunpy_soar/*setup_package*
   */sunpy_soar/extern/*

.github/workflows/ci.yml

@@ -65,11 +65,11 @@ jobs:
       toxdeps: tox-pypi-filter
       posargs: -n auto
       envs: |
-        - linux: py314
-        - windows: py312
-        - macos: py312
-        - linux: py312-oldestdeps
-        - linux: py314-devdeps
+        - linux: py314-online
+        - windows: py312-online
+        - macos: py312-online
+        - linux: py312-oldestdeps-online
+        - linux: py314-devdeps-online
     secrets:
       CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
 

pyproject.toml

@@ -33,6 +33,7 @@ tests-only = [
   "pytest-cov",
   "pytest-doctestplus",
   "pytest",
+  "pytest-remotedata",
 ]
 tests = [
   "sunpy_soar[tests-deps,tests-only]",

pytest.ini

@@ -22,6 +22,9 @@ addopts =
     --doctest-rst
     -p no:unraisableexception
     -p no:threadexception
+markers =
+    remote_data: marks this test function as needing remote data.
+remote_data_strict = true
 filterwarnings =
     # Turn all warnings into errors so they do not pass silently.
     error

sunpy_soar/tests/test_sunpy_soar.py

@@ -13,6 +13,8 @@
 
 SUNPY_VERSION = (sunpy.version.major, sunpy.version.minor)
 
+
+@pytest.mark.remote_data
 def test_search() -> None:
     instrument = a.Instrument("EUI")
     time = a.Time("2022-02-11", "2022-02-12")
@@ -39,6 +41,7 @@ def test_search() -> None:
     sunpy.map.Map(fname)
 
 
+@pytest.mark.remote_data
 def test_search_low_latency() -> None:
     time = a.Time("2020-11-13", "2020-11-14")
     level = a.Level("LL02")
@@ -52,6 +55,7 @@ def test_search_low_latency() -> None:
     assert len(files) == 1
 
 
+@pytest.mark.remote_data
 def test_insitu_search() -> None:
     instrument = a.Instrument("MAG")
     time = a.Time("2020-04-16", "2020-04-17")
@@ -65,6 +69,7 @@ def test_insitu_search() -> None:
     assert len(files) == 1
 
 
+@pytest.mark.remote_data
 def test_no_results() -> None:
     instrument = a.Instrument("EUI")
     time = a.Time("2019-02-01", "2019-02-02")
@@ -74,13 +79,15 @@ def test_no_results() -> None:
     assert len(res) == 0
 
 
+@pytest.mark.remote_data
 def test_no_instrument() -> None:
     # Check that a time only search returns results
     time = a.Time("2020-04-16", "2020-04-17")
     res = SOARClient().search(time)
     assert len(res) == 63
 
 
+@pytest.mark.remote_data
 def test_download_path(tmp_path) -> None:
     # Check that we can download things to a custom path using
     # the search parameters
@@ -119,6 +126,7 @@ def test_registered_soop_names() -> None:
     assert "\nr_small_mres_mcad_ar_long_term" in soop_attr
 
 
+@pytest.mark.remote_data
 def test_search_soop() -> None:
     instrument = a.Instrument("EUI")
     time = a.Time("2022-04-01 01:00", "2022-04-01 02:00")
@@ -132,6 +140,7 @@ def test_search_soop() -> None:
     assert res.file_num == 0
 
 
+@pytest.mark.remote_data
 def test_when_soar_provider_passed() -> None:
     # Tests when a.Provider.soar is passed that only SOARClient results are returned
     instrument = a.Instrument("EUI")
@@ -153,6 +162,7 @@ def test_when_sdac_provider_passed() -> None:
     assert res["vso"]
 
 
+@pytest.mark.remote_data
 def test_when_wrong_provider_passed() -> None:
     # Tests that no results are returned when a provider is passed which does not provide EUI data.
     # This is different from the above test because the SDAC and the SOAR both provide EUI data while
@@ -164,6 +174,7 @@ def test_when_wrong_provider_passed() -> None:
     assert len(res) == 0
 
 
+@pytest.mark.remote_data
 def test_search_wavelength_detector_column() -> None:
     instrument = a.Instrument("EUI")
     time = a.Time("2021-02-01", "2021-02-02")
@@ -174,6 +185,7 @@ def test_search_wavelength_detector_column() -> None:
     assert "Detector" in res[0].columns
 
 
+@pytest.mark.remote_data
 def test_search_detector_instrument_dimension_2() -> None:
     # Instruments "EUI", "METIS", "PHI" and "SOLOHI" have two dimensions in the SOAR data.
     # Selecting no dimension index in the query results in two identical output rows.
@@ -187,6 +199,7 @@ def test_search_detector_instrument_dimension_2() -> None:
     assert res.file_num == 266
 
 
+@pytest.mark.remote_data
 def test_search_detector_instrument_dimension_4() -> None:
     # The "SPICE" instrument has four dimensions in the SOAR data. As a result,
     # selecting no dimension index in the query results in four identical output rows.
@@ -200,6 +213,7 @@ def test_search_detector_instrument_dimension_4() -> None:
     assert res.file_num == 11
 
 
+@pytest.mark.remote_data
 def test_invalid_detector() -> None:
     instrument = a.Instrument("SPICE")
     time = a.Time("2023-03-03 15:00", "2023-03-03 16:00")
@@ -210,6 +224,7 @@ def test_invalid_detector() -> None:
     assert res.file_num == 0
 
 
+@pytest.mark.remote_data
 def test_wavelength_column_wavelength_exists() -> None:
     # For instruments EUI, METIS and SOLOHI "wavelength" column is available.
     # Test to check if the "Wavelength" column exists in the search results.
@@ -222,6 +237,7 @@ def test_wavelength_column_wavelength_exists() -> None:
     assert res.file_num == 12
 
 
+@pytest.mark.remote_data
 def test_wavelength_single() -> None:
     # Test to check if the wavelength value is filtered for a single value provided.
     instrument = a.Instrument("EUI")
@@ -233,6 +249,7 @@ def test_wavelength_single() -> None:
         assert all(table["Wavelength"] == 304)
 
 
+@pytest.mark.remote_data
 def test_wavelength_range() -> None:
     # Test to check if the wavelength value is filtered for wavemin and wavemax provided.
     instrument = a.Instrument("EUI")
@@ -312,6 +329,7 @@ def test_distance_join_query():
     )
 
 
+@pytest.mark.remote_data
 def test_distance_search_remote_sensing():
     instrument = a.Instrument("RPW")
     product = a.soar.Product("rpw-tnr-surv")
@@ -321,6 +339,7 @@ def test_distance_search_remote_sensing():
     assert res.file_num > 40
 
 
+@pytest.mark.remote_data
 def test_distance_search_insitu():
     instrument = a.Instrument("METIS")
     level = a.Level(2)
@@ -330,6 +349,7 @@ def test_distance_search_insitu():
     assert res.file_num == 310
 
 
+@pytest.mark.remote_data
 def test_distance_time_search():
     instrument = a.Instrument("EUI")
     time = a.Time("2023-04-27", "2023-04-28")
@@ -345,6 +365,7 @@ def test_distance_time_search():
 
 # Remove this test and the mark from below once min sunpy dep >=7.1
 @pytest.mark.skipif(SUNPY_VERSION >= (7, 1), reason="Skip post sunpy 7.1")
+@pytest.mark.remote_data
 def test_distance_out_of_bounds_warning(recwarn):
     instrument = a.Instrument("EUI")
     time = a.Time("2023-04-27", "2023-04-28")
@@ -364,6 +385,7 @@ def test_distance_out_of_bounds_warning(recwarn):
 
 
 @pytest.mark.skipif(SUNPY_VERSION < (7, 1), reason="Skip pre sunpy 7.1")
+@pytest.mark.remote_data
 def test_distance_out_of_bounds_warning_post71(recwarn):
     instrument = a.Instrument("EUI")
     time = a.Time("2023-04-27", "2023-04-28")

tox.ini

@@ -3,7 +3,7 @@ min_version = 4.0
 requires =
     tox-pypi-filter>=0.14
 envlist =
-    py{312,313,314}
+    py{312,313,314}{,-online}
     py314-devdeps
     py312-oldestdeps
     codestyle
@@ -18,6 +18,7 @@ description =
     run tests
     oldestdeps: with the oldest supported version of key dependencies
     devdeps: with the latest developer version of key dependencies
+    online: that require remote data (as well as the offline ones)
 pass_env =
     # A variable to tell tests we are on a CI system
     CI
@@ -57,6 +58,7 @@ commands =
     --cov-report=xml \
     --cov=sunpy_soar \
     --cov-config={toxinidir}/.coveragerc \
+    online: --remote-data=any \
     {toxinidir}/docs \
     {posargs}