Merge pull request #2574 from bsipocz/DOC_remote_data_only

DOCS: how to do remote-data only tests

Author: bsipocz

docs/testing.rst

@@ -117,4 +117,19 @@ Narrative documentation should also be tested, the ``doctest-remote-data`` direc
 to mark code snippets that relies on remote data access.
 
 If any of the examples include saving data files locally, use the ``testcleanup`` directive and the
-`~astroquery.utils.cleanup_saved_downloads` function at the end of the narrative documentation.
+`~astroquery.utils.cleanup_saved_downloads` function at the end of the
+narrative documentation.
+
+
+Running only the remote-data tests
+----------------------------------
+
+We should aim to have a reasonably complete test coverage for all the code using the
+actual servers (as opposed to mocked tests). To check the remote-data test
+coverage you can opt to run only those marked with ``remote_data``. Do
+remember to change ``<module_you_want_to_test>`` to the module name you
+actually work on:
+
+.. code-block:: bash
+
+    pytest -P <module_you_want_to_test> -m remote_data --remote-data=any --cov astroquery/<module_you_want_to_test> --cov-config=setup.cfg

setup.cfg

@@ -26,7 +26,7 @@ show-response = 1
 
 [tool:pytest]
 minversion = 6.0
-norecursedirs = build docs/_build docs/gallery-examples astroquery/irsa astroquery/nasa_exoplanet_archive astroquery/ned astroquery/ibe astroquery/irsa_dust astroquery/sha
+norecursedirs = build docs/_build astroquery/irsa astroquery/nasa_exoplanet_archive astroquery/ned astroquery/ibe astroquery/irsa_dust astroquery/sha
 testpaths = astroquery docs
 doctest_plus = enabled
 astropy_header = true

tox.ini

@@ -47,9 +47,8 @@ commands =
     devdeps: pip install -U --pre -i https://pypi.anaconda.org/astropy/simple astropy
 
     pip freeze
-    # FIXME: there are too many failures in the docs example gallery, ignore it for now
-    !cov: pytest --pyargs astroquery {toxinidir}/docs --ignore={toxinidir}/docs/gallery* {env:PYTEST_ARGS} {posargs}
-    cov:  pytest --pyargs astroquery {toxinidir}/docs --ignore={toxinidir}/docs/gallery* --cov astroquery --cov-config={toxinidir}/setup.cfg {env:PYTEST_ARGS} {posargs}
+    !cov: pytest --pyargs astroquery {toxinidir}/docs {env:PYTEST_ARGS} {posargs}
+    cov:  pytest --pyargs astroquery {toxinidir}/docs --cov astroquery --cov-config={toxinidir}/setup.cfg {env:PYTEST_ARGS} {posargs}
     cov: coverage xml -o {toxinidir}/coverage.xml
 
 pip_pre =