Mark tests which depend on ECS/EGI as expected fail; separate integra…

…tion and unit tests (#609)
icesat2py · Sep 26, 2024 · 74ca632 · 74ca632
1 parent 0f2cfeb
commit 74ca632
Show file tree

Hide file tree

Showing 23 changed files with 339 additions and 279 deletions.
diff --git a/.github/workflows/integration_test.yml b/.github/workflows/integration_test.yml
@@ -39,9 +39,7 @@ jobs:
           EARTHDATA_PASSWORD: "${{ secrets.EARTHDATA_PASSWORD }}"
           NSIDC_LOGIN: "${{ secrets.EARTHDATA_PASSWORD }}"
         run: |
-          pytest icepyx/ --verbose --cov app \
-            icepyx/tests/test_behind_NSIDC_API_login.py \
-            icepyx/tests/test_auth.py
+          pytest icepyx/tests/integration --verbose --cov app
 
       - name: "Upload coverage report"
         uses: "codecov/[email protected]"

diff --git a/.github/workflows/unit_test.yml b/.github/workflows/unit_test.yml
@@ -31,8 +31,7 @@ jobs:
       - name: "Run tests"
         run: |
           pytest icepyx/ --verbose --cov app \
-            --ignore=icepyx/tests/test_behind_NSIDC_API_login.py \
-            --ignore=icepyx/tests/test_auth.py
+            --ignore=icepyx/tests/integration
 
       - name: "Upload coverage report"
         uses: "codecov/[email protected]"

diff --git a/doc/source/user_guide/documentation/classes_dev_uml.svg b/doc/source/user_guide/documentation/classes_dev_uml.svg
diff --git a/doc/source/user_guide/documentation/classes_user_uml.svg b/doc/source/user_guide/documentation/classes_user_uml.svg
diff --git a/doc/source/user_guide/documentation/packages_user_uml.svg b/doc/source/user_guide/documentation/packages_user_uml.svg
diff --git a/icepyx/tests/__init__.py b/icepyx/tests/__init__.py
diff --git a/icepyx/tests/ATL06v06_options.json → ...x/tests/integration/ATL06v06_options.json b/icepyx/tests/ATL06v06_options.json → ...x/tests/integration/ATL06v06_options.json
diff --git a/icepyx/tests/test_auth.py → icepyx/tests/integration/test_auth.py b/icepyx/tests/test_auth.py → icepyx/tests/integration/test_auth.py
diff --git a/icepyx/tests/test_behind_NSIDC_API_login.py → ...ntegration/test_behind_NSIDC_API_login.py b/icepyx/tests/test_behind_NSIDC_API_login.py → ...ntegration/test_behind_NSIDC_API_login.py
@@ -11,6 +11,15 @@
 import icepyx as ipx
 import icepyx.core.is2ref as is2ref
 
+# Skip the whole module. See:
+# https://docs.pytest.org/en/stable/reference/reference.html#globalvar-pytestmark
+pytestmark = pytest.mark.xfail(
+    reason=(
+        "The back-end API on which these tests depend, ECS/EGI/ESI, is scheduled for"
+        " shutdown in late 2024. At that point, these tests will begin failing."
+    )
+)
+
 # Misc notes and needed tests
 # test avail data and subsetting success for each input type
 # (kml, shp, list of coords, bbox)
@@ -40,7 +49,7 @@ def session(reg):
 
 def test_get_custom_options_output(session):
     obs = is2ref._get_custom_options(session, "ATL06", "006")
-    with open("./icepyx/tests/ATL06v06_options.json") as exp_json:
+    with open("./icepyx/tests/integration/ATL06v06_options.json") as exp_json:
         exp = json.load(exp_json)
         assert all(keys in obs for keys in exp)
         assert all(obs[key] == exp[key] for key in exp)

diff --git a/icepyx/tests/test_APIformatting.py → icepyx/tests/unit/test_APIformatting.py b/icepyx/tests/test_APIformatting.py → icepyx/tests/unit/test_APIformatting.py
diff --git a/icepyx/tests/test_Earthdata.py → icepyx/tests/unit/test_Earthdata.py b/icepyx/tests/test_Earthdata.py → icepyx/tests/unit/test_Earthdata.py
diff --git a/icepyx/tests/test_granules.py → icepyx/tests/unit/test_granules.py b/icepyx/tests/test_granules.py → icepyx/tests/unit/test_granules.py
diff --git a/icepyx/tests/test_is2class_query.py → icepyx/tests/unit/test_is2class_query.py b/icepyx/tests/test_is2class_query.py → icepyx/tests/unit/test_is2class_query.py
diff --git a/icepyx/tests/test_is2ref.py → icepyx/tests/unit/test_is2ref.py b/icepyx/tests/test_is2ref.py → icepyx/tests/unit/test_is2ref.py
diff --git a/icepyx/tests/test_query.py → icepyx/tests/unit/test_query.py b/icepyx/tests/test_query.py → icepyx/tests/unit/test_query.py
diff --git a/icepyx/tests/test_quest.py → icepyx/tests/unit/test_quest.py b/icepyx/tests/test_quest.py → icepyx/tests/unit/test_quest.py
diff --git a/icepyx/tests/test_quest_argo.py → icepyx/tests/unit/test_quest_argo.py b/icepyx/tests/test_quest_argo.py → icepyx/tests/unit/test_quest_argo.py
diff --git a/icepyx/tests/test_read.py → icepyx/tests/unit/test_read.py b/icepyx/tests/test_read.py → icepyx/tests/unit/test_read.py
@@ -29,12 +29,12 @@ def test_parse_source_no_files():
         (  # check list input
             [
                 "./icepyx/core/is2ref.py",
-                "./icepyx/tests/test_is2class_query.py",
+                "./icepyx/tests/unit/test_is2class_query.py",
             ],
             sorted(
                 [
                     "./icepyx/core/is2ref.py",
-                    "./icepyx/tests/test_is2class_query.py",
+                    "./icepyx/tests/unit/test_is2class_query.py",
                 ]
             ),
         ),
@@ -49,8 +49,8 @@ def test_parse_source_no_files():
             sorted(
                 [
                     "./icepyx/core/is2ref.py",
-                    "./icepyx/tests/test_is2class_query.py",
-                    "./icepyx/tests/test_is2ref.py",
+                    "./icepyx/tests/unit/test_is2class_query.py",
+                    "./icepyx/tests/unit/test_is2ref.py",
                 ]
             ),
         ),

diff --git a/icepyx/tests/test_spatial.py → icepyx/tests/unit/test_spatial.py b/icepyx/tests/test_spatial.py → icepyx/tests/unit/test_spatial.py
@@ -378,7 +378,7 @@ def test_bad_poly_inputfile_name_throws_error():
 
 def test_bad_poly_inputfile_type_throws_error():
     with pytest.raises(TypeError):
-        spat.Spatial(str(Path("./icepyx/tests/test_read.py").resolve()))
+        spat.Spatial(str(Path("./icepyx/tests/unit/test_read.py").resolve()))
 
 
 ########## geodataframe ##########

diff --git a/icepyx/tests/test_temporal.py → icepyx/tests/unit/test_temporal.py b/icepyx/tests/test_temporal.py → icepyx/tests/unit/test_temporal.py
diff --git a/icepyx/tests/test_validate_inputs.py → icepyx/tests/unit/test_validate_inputs.py b/icepyx/tests/test_validate_inputs.py → icepyx/tests/unit/test_validate_inputs.py
diff --git a/icepyx/tests/test_variables.py → icepyx/tests/unit/test_variables.py b/icepyx/tests/test_variables.py → icepyx/tests/unit/test_variables.py
diff --git a/icepyx/tests/test_visualization.py → icepyx/tests/unit/test_visualization.py b/icepyx/tests/test_visualization.py → icepyx/tests/unit/test_visualization.py