Merge pull request #103 from wri/CIF-323-Add-on-off-control-of-skippe…

…d-tests-to-conftest-file

Adding a master control for ignored tests

tests/conftest.py

@@ -2,6 +2,13 @@
 from city_metrix.layers.layer import create_fishnet_grid
 from geocube.api.core import make_geocube
 
+# EXECUTE_IGNORED_TESTS is the master control for whether to execute tests decorated with
+# pytest.mark.skipif. These tests are temporarily ignored due to some unresolved issue.
+# Setting EXECUTE_IGNORED_TESTS to True turns on code execution. This should be done for local testing.
+# The value must be set to False when pushing to GitHub since the ignored tests would otherwise fail
+# in GitHub Actions.
+EXECUTE_IGNORED_TESTS = False
+
 def test_create_fishnet_grid(min_x, min_y, max_x, max_y, cell_size):
     # Slightly reduce aoi to avoid partial cells
     reduction = 0.000001

tests/test_layers.py

@@ -31,6 +31,7 @@
     UrbanLandUse,
     WorldPop
 )
+from tests.conftest import EXECUTE_IGNORED_TESTS
 from tests.resources.bbox_constants import BBOX_BRA_LAURO_DE_FREITAS_1
 
 # Tests are implemented for the same bounding box in Brazil.
@@ -53,12 +54,12 @@ def test_built_up_height():
     data = BuiltUpHeight().get_data(BBOX)
     assert np.size(data) > 0
 
-@pytest.mark.skip(reason="CDS API needs personal access token file to run")
+@pytest.mark.skipif(EXECUTE_IGNORED_TESTS == False, reason="CDS API needs personal access token file to run")
 def test_cams():
     data = Cams().get_data(BBOX)
     assert np.size(data) > 0
 
-@pytest.mark.skip(reason="CDS API needs personal access token file to run")
+@pytest.mark.skipif(EXECUTE_IGNORED_TESTS == False, reason="CDS API needs personal access token file to run")
 def test_era_5_hottest_day():
     data = Era5HottestDay().get_data(BBOX)
     assert np.size(data) > 0

tests/test_metrics.py

@@ -1,5 +1,5 @@
 from city_metrix import *
-from .conftest import ZONES
+from .conftest import ZONES, EXECUTE_IGNORED_TESTS
 import pytest
 
 
@@ -24,7 +24,7 @@ def test_built_land_without_tree_cover():
     assert expected_zone_size == actual_indicator_size
 
 
-@pytest.mark.skip(reason="CDS API needs personal access token file to run")
+@pytest.mark.skipif(EXECUTE_IGNORED_TESTS == False, reason="CDS API needs personal access token file to run")
 def test_era_5_met_preprocess():
     indicator = era_5_met_preprocessing(ZONES)
     assert len(indicator) == 24