DAS-2397: Adds nsidc-smap regression test suite. (#204)

Author: flamingbear

.github/workflows/build-all-images.yml

@@ -32,6 +32,10 @@ jobs:
             image: "nsidc-icesat2"
             notebook: "NSIDC-ICESAT2_Regression.ipynb"
             shared-utils: "true"
+          -
+            image: "nsidc-smap"
+            notebook: "nsidc-smap_Regression.ipynb"
+            shared-utils: "true"
           -
             image: "regridder"
             notebook: "Regridder_Regression.ipynb"

.github/workflows/notebook-test-suite.yml

@@ -75,6 +75,7 @@ on:
           - harmony-regression
           - sambah
           - nsidc-icesat2
+          - nsidc-smap
 
       docker-image-tag:
         description: "Optional Docker image tag to use for the tests"

CHANGELOG.md

@@ -5,6 +5,12 @@ versioning. Rather than a static releases, this repository contains of a number
 of regression tests that are each semi-independent.  This CHANGELOG file should be used
 to document pull requests to this repository.
 
+## 2025-08-21 ([204](https://github.com/nasa/harmony-regression-tests/pull/204))
+
+### Added
+
+- Adds regression tests and support configuration for `nsidc-smap` test suite.
+
 ## 2025-08-14 ([#202](https://github.com/nasa/harmony-regression-tests/pull/202))
 
 ### Changed

README.md

@@ -132,39 +132,50 @@ environment before installing from the environment.yml.
    with a Harmony service and add it to the `all` list so that it will be run when
    the associated Harmony service or Harmony server is deployed.
 
-With this in place, the new test suite should be able to be built and run:
-
-```bash
-EDL_USER=...
-EDL_PASSWORD=...
-HARMONY_HOST_URL=https://harmony.sit.earthdata.nasa.gov  # Or UAT or production
-cd test
-make <new-suite-name>-image
-./run_notebooks.sh <new-suite-name>
-```
-
-After this, the test suite will need to be integrated with the GitHub workflow
+1. With theses changes in place, the new test suite should be able to be built and run:
+        ```sh
+        EDL_USER=[use yours...]
+        EDL_PASSWORD=[use yours...]
+        HARMONY_HOST_URL=https://harmony.sit.earthdata.nasa.gov  # Or UAT or production
+        cd test
+        make <new-suite-name>-image
+        ./run_notebooks.sh <new-suite-name>
+        ```
+
+1. After this, the test suite will need to be integrated with the GitHub workflow
 to create a new version of the test image any time the related `version.txt`
 file is updated. To do so, simply add a new target to the
 [build-all-images.yml](https://github.com/nasa/harmony-regression-tests/blob/main/.github/workflows/build-all-images.yml) workflow in the `.github/workflows` directory:
 
-```yaml
--
-  image: <new-suite-name>
-  notebook: <new-notebook-name>
-```
-
-The above is the basic structure for adding a new image to the CI/CD.  An
-additional option, `shared-utils`, defaults to off, but can be over-ridden as
-it is for the nsidc-icesat2 image. `shared-utils` controls the addition of the
-`tests/shared_utils` directory into your image.
+   ```yaml
+   -
+     image: <new-suite-name>
+     notebook: <new-notebook-name>
+     shared-utils: "true"
+   ```
 
-``` yaml
-    -
-      image: "nsidc-icesat2"
-      notebook: "NSIDC-ICESAT2_Regression.ipynb"
-      shared-utils: "true"
-```
+1. If your test suite is for a new service. Meaning it has an entry on Harmony's [/service-image-tag](https://harmony.earthdata.nasa.gov/service-image-tag) endpoint you should add it to the:
+   ```yaml
+   on:
+     repository_dispatch:
+       types:
+         - all
+         - batchee
+         - your-new-service
+   ```
+   list in the [notebook-test-suite.yml](https://github.com/nasa/harmony-regression-tests/blob/main/.github/workflows/notebook-test-suite.yml)
+
+1. If you want to trigger your tests by hand on GitHub, add your test name to the:
+   ```yaml
+   on:
+     workflow_dispatch:
+       service-name:
+         options:
+           - all
+           - batchee
+           - your-new-service
+   ```
+list of the [notebook-test-suite.yml](https://github.com/nasa/harmony-regression-tests/blob/main/.github/workflows/notebook-test-suite.yml)
 
 ## Test suite contents:
 

config/services_tests_config_uat.json

@@ -1,28 +1,29 @@
 {
-  "all": "harmony,harmony-regression,geoloco,hga,regridder,hoss,variable-subsetter,hybig,imagenator,net2cog,smap-l2-gridder,subset-band-name,swath-projector,nsidc-icesat2,trajectory-subsetter,sambah,opera-rtc-s1-browse",
+  "all": "harmony,harmony-regression,geoloco,hga,regridder,hoss,variable-subsetter,hybig,imagenator,net2cog,smap-l2-gridder,subset-band-name,swath-projector,nsidc-icesat2,nsidc-smap,trajectory-subsetter,sambah,opera-rtc-s1-browse",
   "batchee": "sambah",
   "filtering": "imagenator",
   "geoloco": "geoloco",
   "giovanni-adapter": "TBD",
   "harmony-gdal-adapter": "hga",
   "harmony-regridder": "regridder",
   "harmony-service-example": "harmony-regression",
-  "harmony-smap-l2-gridder": "smap-l2-gridder",
+  "harmony-smap-l2-gridder": "nsidc-smap,smap-l2-gridder",
   "hoss": "hoss,variable-subsetter",
   "hybig": "hybig,opera-rtc-s1-browse,imagenator",
   "imagenator": "imagenator",
-  "net2cog": "net2cog,imagenator",
+  "net2cog": "net2cog,nsidc-smap,imagenator",
   "opera-rtc-s1-browse": "opera-rtc-s1-browse",
   "podaac-concise": "sambah",
   "podaac-l2-subsetter": "sambah",
   "query-cmr": "variable-subsetter",
   "sds-maskfill": "hoss",
   "stitchee": "sambah",
   "subset-band-name": "subset-band-name",
-  "swath-projector": "swath-projector,imagenator",
-  "trajectory-subsetter": "nsidc-icesat2,trajectory-subsetter",
+  "swath-projector": "swath-projector,nsidc-smap,imagenator",
+  "trajectory-subsetter": "nsidc-icesat2,nsidc-smap,trajectory-subsetter",
   "harmony": "harmony",
   "harmony-regression": "harmony-regression",
   "nsidc-icesat2": "nsidc-icesat2",
+  "nsidc-smap": "nsidc-smap",
   "sambah": "sambah"
 }

script/test-in-bamboo.sh

@@ -52,6 +52,7 @@ all_tests=(
     imagenator
     net2cog
     nsidc-icesat2
+    nsidc-smap
     opera-rtc-s1-browse
     regridder
     sambah

test/Makefile

@@ -29,6 +29,11 @@ nsidc-icesat2-image: Dockerfile nsidc-icesat2/environment.yaml
 	--build-arg notebook=NSIDC-ICESAT2_Regression.ipynb --build-arg sub_dir=nsidc-icesat2 \
 	--build-arg shared_utils=true .
 
+nsidc-smap-image: Dockerfile nsidc-smap/environment.yaml
+	docker build -t ghcr.io/nasa/regression-tests-nsidc-smap:latest -f ./Dockerfile \
+	--build-arg notebook=nsidc-smap_Regression.ipynb --build-arg sub_dir=nsidc-smap \
+	--build-arg shared_utils=true .
+
 regridder-image: Dockerfile regridder/environment.yaml
 	docker build -t ghcr.io/nasa/regression-tests-regridder:latest -f ./Dockerfile \
 	--build-arg notebook=Regridder_Regression.ipynb --build-arg sub_dir=regridder \
@@ -82,6 +87,7 @@ images: harmony-image \
 	hybig-image \
 	imagenator-image \
 	nsidc-icesat2-image \
+	nsidc-smap-image \
 	regridder-image \
 	smap-l2-gridder-image \
 	subset-band-name-image \

test/nsidc-smap/ancillary/EasternUS.kml

@@ -0,0 +1,10 @@
+<kml xmlns="http://www.opengis.net/kml/2.2"><Document>
+<Placemark>
+<ExtendedData></ExtendedData>
+  <Polygon>
+<outerBoundaryIs>
+  <LinearRing><coordinates>-93.33515499433173,44.47025508433279
+-93.33515499433173,30.315484354637036
+-77.02407154294654,30.315484354637036
+-77.02407154294654,44.47025508433279
+-93.33515499433173,44.47025508433279</coordinates></LinearRing></outerBoundaryIs></Polygon></Placemark></Document></kml>

test/nsidc-smap/ancillary/France_simple.geojson

@@ -0,0 +1 @@
+{"type":"FeatureCollection","features":[{"type":"Feature","properties":{},"geometry":{"coordinates":[[[8.20889625972029,49.1338401017081],[1.743012122049322,51.27624895999446],[-5.111555322809551,48.55802129260826],[-1.9547267837421032,43.46597834514631],[3.4983940574298344,42.08322300391913],[7.307299566010869,45.15784094123768],[6.196119692442579,46.347898754742886],[8.20889625972029,49.1338401017081]]],"type":"Polygon"}}]}