Ecoscope 197

.github/workflows/_tests.yml

@@ -0,0 +1,36 @@
+name: Run tests
+on:
+  push:
+    branches: [ "*" ]
+env:
+  ER_USERNAME: ${{ secrets.ER_USERNAME }}
+  ER_PASSWORD: ${{ secrets.ER_PASSWORD }}
+  GCP_DATAFLOW_SERVICE_KEY: ${{ secrets.GCP_DATAFLOW_SERVICE_KEY }}
+
+jobs:
+  run_unit_tests:
+    runs-on: ubuntu-latest
+    steps:
+      - name: 'Authenticate to Google Cloud'
+        uses: 'google-github-actions/auth@v1'
+        with:
+          credentials_json: '${{ secrets.GCP_DATAFLOW_SERVICE_KEY }}'
+      - name: 'Set up Cloud SDK'
+        uses: 'google-github-actions/setup-gcloud@v1'
+      - name: Checkout branch
+        uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.10' 
+      - name: Install pip
+        run: python -m ensurepip --upgrade
+      - name: Install dependencies
+        run: pip install -r requirements-notebooks-test.txt
+      - name: Use the kernel
+        run: python -m ipykernel install --user --name=venv
+      - name: Run unit tests
+        run: pytest nb-tests/test_notebooks.py -s
+    env:
+      ER_USERNAME: ${{ secrets.ER_USERNAME }}
+      ER_PASSWORD: ${{ secrets.ER_PASSWORD }}
+      GCP_DATAFLOW_SERVICE_KEY: ${{ secrets.GCP_DATAFLOW_SERVICE_KEY }}

.github/workflows/main.yml

@@ -37,4 +37,4 @@ jobs:
           pytest -v -r s --color=yes --cov=ecoscope --cov-append --cov-report=xml
 
       - name: Codecov
-        uses: codecov/codecov-action@v4
+        uses: codecov/codecov-action@v4

nb-tests/test_notebooks.py

@@ -0,0 +1,57 @@
+import os
+import pathlib
+from dataclasses import dataclass
+import papermill
+from papermill.execute import PapermillExecutionError
+import pytest
+
+
+NB_DIR = pathlib.Path(__file__).parent.parent / "doc" / "source" / "notebooks"
+
+KNOWN_ERRORS_REGEXES = {  # This is basically a GitHub ticket queue
+    "EarthRanger_IO.ipynb": "Series found",
+    "GEE_IO.ipynb": "frontend does not support input requests", # This error only happens in the ci pipeline
+    "EcoMap.ipynb": "frontend does not support input requests", # This error only happens in the ci pipeline
+    "Remote Sensing Time Series Anomaly.ipynb": "frontend does not support input requests", # This error only happens in the ci pipeline
+    "Relocations_and_Trajectories.ipynb": "not a zip file",
+    "EcoGraph.ipynb": "not a zip file",
+    "EcoPlot.ipynb": "not a zip file",
+    "Landscape Grid.ipynb": "not a zip file",
+    "Seasonal Calculation.ipynb": "buffer source array is read-only",
+    "Tracking Data Gantt Chart.ipynb": "not a zip file",
+}
+class UnexecptedNotebookExecutionError(Exception):
+    pass
+
+@dataclass
+class Notebook:
+    path: pathlib.Path
+    raises: bool = False
+    raises_match: str = None
+
+
+ALL_NOTEBOOKS = [
+    Notebook(
+        path=p,
+        raises=False if not p.name in KNOWN_ERRORS_REGEXES else True,
+        raises_match=KNOWN_ERRORS_REGEXES.get(p.name),
+    )
+    for p in NB_DIR.rglob("*.ipynb")
+]
+
+@pytest.mark.parametrize(
+    "notebook",
+    ALL_NOTEBOOKS,
+    ids=[nb.path.name for nb in ALL_NOTEBOOKS],
+)
+def test_notebooks(notebook: Notebook):
+    try:
+        papermill.execute_notebook(str(notebook.path), "./output.ipynb", kernel_name="venv")
+    except Exception as e:
+        if notebook.raises:  # these are the ones we expect to raise errors
+            pytest.xfail(f"Notebook {notebook.path} is known to fail with error {notebook.raises_match}")
+        else:
+            raise UnexecptedNotebookExecutionError(
+                f"{notebook.path.name=} not in {list(KNOWN_ERRORS_REGEXES)= } but execution errored. "
+                "This notebook is unexpectedly broken."
+            ) from e

requirements-notebooks-test.txt

@@ -0,0 +1,7 @@
+pip-tools
+pytest
+papermill
+folium
+branca
+ecoscope[all]
+ipykernel