Merge branch 'feature/conftest-for-common-fixtures' into feature/interpolated-trajectories

Author: spjuhel

climada/test/conftest.py

@@ -69,7 +69,7 @@
 
 # Exposure coordinates
 EXP_LONS = np.array([4, 4.25, 4.5, 4, 4.25, 4.5])
-EXP_LATS = np.array([45, 45, 45, 45.25, 45.25, 45.25])
+EXP_LATS = np.array([33, 33, 33, 33.25, 33.25, 33.25])
 
 # ---------------------------------------------------------------------------
 # Hazard definition
@@ -104,87 +104,62 @@
 IMPF_ID = 1
 IMPF_NAME = "IMPF_1"
 
-# Sanity checks
-for const in [VALUES, CATEGORIES, EXP_LONS, EXP_LATS]:
-    assert len(const) == len(
-        VALUES
-    ), "VALUES, REGIONS, CATEGORIES, EXP_LONS, EXP_LATS should all have the same lengths."
 
-for const in [EVENT_IDS, EVENT_NAMES, DATES, FREQUENCY]:
-    assert len(const) == len(
-        EVENT_IDS
-    ), "EVENT_IDS, EVENT_NAMES, DATES, FREQUENCY should all have the same lengths."
-
-
-@pytest.fixture(scope="session")
-def exposure_values():
-    return VALUES.copy()
-
-
-@pytest.fixture(scope="session")
-def categories():
-    return CATEGORIES.copy()
-
-
-@pytest.fixture(scope="session")
-def exposure_geometry():
-    return [Point(lon, lat) for lon, lat in zip(EXP_LONS, EXP_LATS)]
-
-
-@pytest.fixture(scope="session")
-def exposures_factory(
-    exposure_values,
-    exposure_geometry,
-):
+@pytest.fixture
+def exposures_factory():
     def _make_exposures(
+        values=VALUES,
+        exp_lons=EXP_LONS,
+        exp_lats=EXP_LATS,
         value_factor=1.0,
         ref_year=EXPOSURE_REF_YEAR,
         hazard_type=HAZARD_TYPE,
         group_id=None,
+        crs=CRS_WGS84,
+        impf_id=IMPF_ID,
+        description=EXP_DESC,
+        value_unit=EXPOSURE_VALUE_UNIT,
+        categories=None,
     ):
         gdf = gpd.GeoDataFrame(
             {
-                "value": exposure_values * value_factor,
-                f"impf_{hazard_type}": IMPF_ID,
-                "geometry": exposure_geometry,
+                "value": values * value_factor,
+                f"impf_{hazard_type}": impf_id,
+                "category": categories,
+                "geometry": gpd.points_from_xy(exp_lons, exp_lats, crs=crs),
             },
-            crs=CRS_WGS84,
+            crs=crs,
         )
         if group_id is not None:
             gdf["group_id"] = group_id
 
         return Exposures(
             data=gdf,
-            description=EXP_DESC,
+            description=description,
             ref_year=ref_year,
-            value_unit=EXPOSURE_VALUE_UNIT,
+            value_unit=value_unit,
         )
 
     return _make_exposures
 
 
-@pytest.fixture(scope="session")
+@pytest.fixture
 def exposures(exposures_factory):
     return exposures_factory()
 
 
-@pytest.fixture(scope="session")
-def hazard_frequency_factory():
-    base = FREQUENCY
-
+def hazard_frequency_factory(base=FREQUENCY):
     def _make_frequency(scale=1.0):
         return base * scale
 
     return _make_frequency
 
 
-@pytest.fixture(scope="session")
 def hazard_frequency():
     return hazard_frequency_factory()
 
 
-@pytest.fixture(scope="session")
-def hazard_intensity_factory():
+def hazard_intensity(max_intensity=HAZARD_MAX_INTENSITY, scale=1.0):
     """
     Intensity matrix designed for analytical expectations:
     - Event 1: zero
@@ -195,76 +170,83 @@ def hazard_intensity_factory():
     base = csr_matrix(
         [
             [0, 0, 0, 0, 0, 0],
-            [HAZARD_MAX_INTENSITY, 0, 0, 0, 0, 0],
-            [0, HAZARD_MAX_INTENSITY / 2, 0, 0, 0, 0],
+            [max_intensity, 0, 0, 0, 0, 0],
+            [0, max_intensity / 2, 0, 0, 0, 0],
             [
-                HAZARD_MAX_INTENSITY / 4,
-                HAZARD_MAX_INTENSITY / 4,
-                HAZARD_MAX_INTENSITY / 4,
-                HAZARD_MAX_INTENSITY / 4,
-                HAZARD_MAX_INTENSITY / 4,
-                HAZARD_MAX_INTENSITY / 4,
+                max_intensity / 4,
+                max_intensity / 4,
+                max_intensity / 4,
+                max_intensity / 4,
+                max_intensity / 4,
+                max_intensity / 4,
             ],
             [
-                HAZARD_MAX_INTENSITY,
-                HAZARD_MAX_INTENSITY,
-                HAZARD_MAX_INTENSITY,
-                HAZARD_MAX_INTENSITY,
-                HAZARD_MAX_INTENSITY,
-                HAZARD_MAX_INTENSITY,
+                max_intensity,
+                max_intensity,
+                max_intensity,
+                max_intensity,
+                max_intensity,
+                max_intensity,
             ],
         ]
     )
 
-    def _make_intensity(scale=1.0):
-        return base * scale
-
-    return _make_intensity
-
+    return base * scale
 
-@pytest.fixture(scope="session")
-def hazard_intensity_matrix(hazard_intensity_factory):
-    return hazard_intensity_factory()
 
-
-@pytest.fixture(scope="session")
+@pytest.fixture
 def centroids():
     return Centroids(lat=HAZ_LATS, lon=HAZ_LONS, crs=CRS_WGS84)
 
 
-@pytest.fixture(scope="session")
+@pytest.fixture
 def hazard_factory(
-    hazard_intensity_factory,
-    hazard_frequency_factory,
     centroids,
 ):
     def _make_hazard(
+        intensity_matrix=None,
+        frequency_array=FREQUENCY,
+        max_intensity=HAZARD_MAX_INTENSITY,
+        centroids=None,
         intensity_scale=1.0,
         frequency_scale=1.0,
         hazard_type=HAZARD_TYPE,
         hazard_unit=HAZARD_UNIT,
+        lat=HAZ_LATS,
+        lon=HAZ_LONS,
+        crs=CRS_WGS84,
+        event_id=EVENT_IDS,
+        event_name=EVENT_NAMES,
+        date=DATES,
+        frequency_unit=FREQUENCY_UNIT,
     ):
+        if intensity_matrix is None:
+            intensity_matrix = hazard_intensity(max_intensity, intensity_scale)
+
+        if centroids is None:
+            centroids = Centroids(lat=lat, lon=lon, crs=crs)
+
         return Hazard(
             haz_type=hazard_type,
             units=hazard_unit,
             centroids=centroids,
-            event_id=EVENT_IDS,
-            event_name=EVENT_NAMES,
-            date=DATES,
-            frequency=hazard_frequency_factory(scale=frequency_scale),
-            frequency_unit=FREQUENCY_UNIT,
-            intensity=hazard_intensity_factory(scale=intensity_scale),
+            event_id=event_id,
+            event_name=event_name,
+            date=date,
+            frequency=frequency_array * frequency_scale,
+            frequency_unit=frequency_unit,
+            intensity=intensity_matrix,
         )
 
     return _make_hazard
 
 
-@pytest.fixture(scope="session")
+@pytest.fixture
 def hazard(hazard_factory):
     return hazard_factory()
 
 
-@pytest.fixture(scope="session")
+@pytest.fixture
 def impf_factory():
     def _make_impf(
         paa_scale=1.0,
@@ -292,12 +274,12 @@ def _make_impf(
     return _make_impf
 
 
-@pytest.fixture(scope="session")
+@pytest.fixture
 def linear_impact_function(impf_factory):
     return impf_factory()
 
 
-@pytest.fixture(scope="session")
+@pytest.fixture
 def impfset_factory(impf_factory):
     def _make_impfset(
         paa_scale=1.0,
@@ -323,6 +305,6 @@ def _make_impfset(
     return _make_impfset
 
 
-@pytest.fixture(scope="session")
+@pytest.fixture
 def impfset(impfset_factory):
     return impfset_factory()

climada/test/fixture_use_example.py

@@ -20,7 +20,9 @@
     "Writing tests is work. As a matter of facts, it can be a _lot_ of work, depending on the program often more than writing the original code.\\\n",
     "Luckily, it essentially follows always the same basic procedure and a there are a lot of tools and frameworks available to facilitate this work.\n",
     "\n",
-    "In CLIMADA we use the Python in-built _test runner_ [pytest](https://docs.pytest.org/en/7.1.x/index.html) for execution of the tests."
+    "In CLIMADA we use the Python in-built _test runner_ [pytest](https://docs.pytest.org/en/7.1.x/index.html) for execution of the tests.\n",
+    "\n",
+    "We now leverage `pytest` fixtures for defining the data and context used by tests. Please read [how to use fixtures for testing in CLIMADA](fixture-tutorial)."
    ]
   },
   {
@@ -53,7 +55,6 @@
   },
   {
    "cell_type": "markdown",
-   "id": "5819e8c6",
    "metadata": {},
    "source": [
     "### Basic Test Procedure\n",
@@ -277,7 +278,9 @@
    "source": [
     "### Test Configuration\n",
     "\n",
-    "Use the configuration file `climada.config` in the installation directory to define file paths and external resources used during tests (see the [Constants and Configuration Guide](./Guide_Configuration.ipynb))."
+    "Integration tests should make use of the fixtures defined in `climada/test/conftest.py`. Learn how to do that in [how to use fixtures for testing in CLIMADA](fixture-tutorial).\n",
+    "\n",
+    "Test data can also use paths defined in the configuration file `climada.config` (in the installation directory) which define file paths and external resources to be used during tests (see the [Constants and Configuration Guide](./Guide_Configuration.ipynb))."
    ]
   },
   {
@@ -334,9 +337,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
+   "display_name": "Python [conda env:climada_env_dev]",
    "language": "python",
-   "name": "python3"
+   "name": "conda-env-climada_env_dev-py"
   },
   "language_info": {
    "codemirror_mode": {
@@ -348,7 +351,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.12.6"
+   "version": "3.11.15"
   },
   "vscode": {
    "interpreter": {