Make GIS models testable and test in CI

.github/workflows/build_lint.yml → .github/workflows/test_examples.yml

@@ -1,28 +1,20 @@
-name: build
+name: Test example models
 
 on:
   push:
-    branches:
-    - main
-    - release**
-    paths-ignore:
-      - '**.md'
-      - '**.rst'
+    paths:
+      - 'examples/**/*.py'  # If an example model is modified
+      - 'test_examples.py'  # If the test script is modified
+      - '.github/workflows/test_examples.yml'  # If this workflow is modified
   pull_request:
-    paths-ignore:
-      - '**.md'
-      - '**.rst'
+    paths:
+      - 'examples/**/*.py'
+      - 'test_examples.py'
+      - '.github/workflows/test_examples.yml'
   workflow_dispatch:
   schedule:
     - cron: '0 6 * * 1'  # Monday at 6:00 UTC
 
-# This will cancel previous run if a newer job that obsoletes the said previous
-# run, is started.
-# Based on https://github.com/zulip/zulip/commit/4a11642cee3c8aec976d305d51a86e60e5d70522
-concurrency:
-  group: "${{ github.workflow }}-${{ github.head_ref || github.run_id }}"
-  cancel-in-progress: true
-
 jobs:
   # build-stable:
   #   runs-on: ubuntu-latest
@@ -48,7 +40,7 @@ jobs:
     - name: Install dependencies
       run: |
         pip install mesa --pre
-        pip install pytest
+        pip install .[test]
     - name: Test with pytest
       run: pytest -rA -Werror test_examples.py
 
@@ -62,7 +54,7 @@ jobs:
         python-version: "3.12"
     - name: Install dependencies
       run: |
-        pip install pytest
+        pip install .[test]
         pip install -U git+https://github.com/projectmesa/mesa@main#egg=mesa
     - name: Test with pytest
       run: pytest -rA -Werror test_examples.py

.github/workflows/test_gis_examples.yml

@@ -0,0 +1,60 @@
+name: Test GIS models
+
+on:
+  push:
+    paths:
+      - 'gis/**/*.py'  # If a gis model is modified
+      - 'test_gis_examples.py'  # If the gis test script is modified
+      - '.github/workflows/test_gis_examples.yml'  # If this workflow is modified
+  pull_request:
+    paths:
+      - 'gis/**/*.py'
+      - 'test_gis_examples.py'
+      - '.github/workflows/test_gis_examples.yml'
+  workflow_dispatch:
+  schedule:
+    - cron: '0 6 * * 1'  # Monday at 6:00 UTC
+
+jobs:
+  # build-stable:
+  #   runs-on: ubuntu-latest
+  #   steps:
+  #   - uses: actions/checkout@v4
+  #   - name: Set up Python
+  #     uses: actions/setup-python@v5
+  #     with:
+  #       python-version: "3.12"
+  #   - name: Install dependencies
+  #     run: pip install mesa pytest
+  #   - name: Test with pytest
+  #     run: pytest -rA -Werror test_examples.py
+
+  build-pre:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.12"
+    - name: Install dependencies
+      run: |
+        pip install mesa-geo --pre
+        pip install .[test_gis]
+    - name: Test with pytest
+      run: pytest -rA -Werror test_gis_examples.py
+
+  build-main:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.12"
+    - name: Install dependencies
+      run: |
+        pip install -U git+https://github.com/projectmesa/mesa-geo@main#egg=mesa-geo
+        pip install .[test_gis]
+    - name: Test with pytest
+      run: pytest -rA -Werror test_gis_examples.py

gis/agents_and_networks/src/agent/commuter.py

@@ -8,8 +8,8 @@
 import pyproj
 from shapely.geometry import LineString, Point
 
-from src.agent.building import Building
-from src.space.utils import UnitTransformer, redistribute_vertices
+from ..space.utils import UnitTransformer, redistribute_vertices
+from .building import Building
 
 
 class Commuter(mg.GeoAgent):

gis/agents_and_networks/src/model/model.py

@@ -7,11 +7,11 @@
 import pandas as pd
 from shapely.geometry import Point
 
-from src.agent.building import Building
-from src.agent.commuter import Commuter
-from src.agent.geo_agents import Driveway, LakeAndRiver, Walkway
-from src.space.campus import Campus
-from src.space.road_network import CampusWalkway
+from ..agent.building import Building
+from ..agent.commuter import Commuter
+from ..agent.geo_agents import Driveway, LakeAndRiver, Walkway
+from ..space.campus import Campus
+from ..space.road_network import CampusWalkway
 
 
 def get_time(model) -> pd.Timedelta:

gis/agents_and_networks/src/space/campus.py

@@ -6,8 +6,8 @@
 import mesa_geo as mg
 from shapely.geometry import Point
 
-from src.agent.building import Building
-from src.agent.commuter import Commuter
+from ..agent.building import Building
+from ..agent.commuter import Commuter
 
 
 class Campus(mg.GeoSpace):

gis/agents_and_networks/src/space/road_network.py

@@ -9,7 +9,7 @@
 import pyproj
 from sklearn.neighbors import KDTree
 
-from src.space.utils import segmented
+from .utils import segmented
 
 
 class RoadNetwork:

gis/agents_and_networks/src/visualization/server.py

@@ -1,8 +1,8 @@
 import mesa
 
-from src.agent.building import Building
-from src.agent.commuter import Commuter
-from src.agent.geo_agents import Driveway, LakeAndRiver, Walkway
+from ..agent.building import Building
+from ..agent.commuter import Commuter
+from ..agent.geo_agents import Driveway, LakeAndRiver, Walkway
 
 
 class ClockElement(mesa.visualization.TextElement):

gis/geo_sir/model.py

@@ -1,8 +1,9 @@
 import mesa
 import mesa_geo as mg
-from agents import NeighbourhoodAgent, PersonAgent
 from shapely.geometry import Point
 
+from .agents import NeighbourhoodAgent, PersonAgent
+
 
 class GeoSir(mesa.Model):
     """Model class for a simplistic infection model."""

pyproject.toml

@@ -9,6 +9,15 @@ license = {file = "LICENSE"}
 readme = "README.rst"
 requires-python = ">=3.8"
 
+[project.optional-dependencies]
+test = [
+    "pytest",
+]
+test_gis = [
+    "pytest",
+    "momepy",
+]
+
 [build-system]
 requires = [
     "setuptools",

test_gis_examples.py

@@ -0,0 +1,34 @@
+import importlib
+import os
+
+import pytest
+from mesa import Model
+
+
+def get_models(directory):
+    models = []
+    for root, dirs, files in os.walk(directory):
+        for file in files:
+            if file == "model.py":
+                module_name = os.path.relpath(os.path.join(root, file[:-3])).replace(
+                    os.sep, "."
+                )
+
+                module = importlib.import_module(module_name)
+                for item in dir(module):
+                    obj = getattr(module, item)
+                    if (
+                        isinstance(obj, type)
+                        and issubclass(obj, Model)
+                        and obj is not Model
+                    ):
+                        models.append(obj)
+
+    return models
+
+
+@pytest.mark.parametrize("model_class", get_models("gis"))
+def test_model_steps(model_class):
+    model = model_class()  # Assume no arguments are needed
+    for _ in range(10):
+        model.step()