Updates config and workflows to be consistent and correct. (#147)

Author: flamingbear

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

@@ -43,42 +43,70 @@ on:
           - uat
           - prod
       service-name:
-        description: "Select the service to run tests against"
+        description: "Select the service to run its tests"
         required: true
         type: choice
         options:
-          # This is a list of the aliases for the service images
-          # found at the harmony service-image-tags endpoint.
+          # Run all regression test suites
           - all
+          # These values are from Harmony's /service-image-tag endpoint and are associated
+          ## with 1 or more regression tests via the services_tests_config_[env].json files.
           - batchee
           - geoloco
           - giovanni-adapter
-          - harmony
           - harmony-gdal-adapter
-          # - harmony-netcdf-to-zarr": "n2z", (disabled because AWS Credentials are needed to run)
+          ## - harmony-netcdf-to-zarr": "n2z", (Disabled because of AWS credential requirements)
           - harmony-regridder
           - harmony-service-example
+          - harmony-smap-l2-gridder
           - hoss
           - hybig
           - net2cog
+          - opera-rtc-s1-browse
           - podaac-concise
           - podaac-l2-subsetter
           - query-cmr
-          - smap-l2-gridder
           - sds-maskfill
           - stitchee
           - subset-band-name
           - swath-projector
           - trajectory-subsetter
-          - opera-rtc-s1-browse
+          ## These run specific regression tests associated with service chains or core Harmony functionality.
+          - harmony
+          - harmony-regression
+          - sambah
+          - nsidc-icesat2
+
       docker-image-tag:
         description: "Optional Docker image tag to use for the tests"
         required: false
         type: string
         default: 'latest'
 
   repository_dispatch:
-    types: [all,geoloco,harmony-gdal-adapter,harmony-netcdf-to-zarr,harmony-service-example,hoss,hybig,net2cog,swath-projector,trajectory-subsetter,sambah,opera-rtc-s1-browse]
+    types:
+      ## These are the events sent from Harmony to this repository's API to trigger tests.
+      ## They should align with the keys to the /service-image-tag endpoint (plus all)
+      - all
+      - batchee
+      - geoloco
+      - harmony-gdal-adapter
+      ## - harmony-netcdf-to-zarr (Disabled because of AWS credential requirements)
+      - harmony-regridder
+      - harmony-service-example
+      - harmony-smap-l2-gridder
+      - hoss
+      - hybig
+      - net2cog
+      - opera-rtc-s1-browse
+      - podaac-concise
+      - podaac-l2-subsetter
+      - query-cmr
+      - sds-maskfill
+      - stitchee
+      - subset-band-name
+      - swath-projector
+      - trajectory-subsetter
     inputs:
       harmony-environment:
         required: true

CHANGELOG.md

@@ -5,6 +5,11 @@ 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-03-05 ([#147](https://github.com/nasa/harmony-regression-tests/pull/147))
+
+- Cleans up `repository_dispatch` and `workflow_dispatch` options to be consistent with Harmony's service-image-tags endpoint.
+- Adds documentation to clarify how the configuration works for mapping triggers to regression tests.
+
 ### 2025-03-04 ([#146](https://github.com/nasa/harmony-regression-tests/pull/146))
 
 - Re-enables two ATL10 v006 tests in the nsidc-icesat2 regression notebook, as the Trajectory Subsetter now supports ATL10 v006.

config/README.md

@@ -0,0 +1,25 @@
+This directory has files containing dictionary mappings of labels (keys) to lists of regression tests that run when the label is selected (values)
+
+The two files describe the environments:
+- `services_tests_config_prod.json` for Production environment
+- `services_tests_config_uat.json` for UAT environment
+
+Generally the mappings are:
+
+ - `key`:  A Harmony service name directly from the Harmony /service-image-tag endpoint.
+
+ - `value`: A comma separated list of regression tests to run.  These tests, will have a direct dependency on the service, either as the regression for the service or as a regression for a service chain that the service is apart of.
+
+There are a few additional keys/values beyond the keys returned from the Harmony service-image-tags endpoint.
+
+`"all"` is used to trigger every harmony regression test.
+`"harmony"` - triggers harmony regression test
+`"nsidc-icesat2"`- triggers nsidc-icesat2 regression test
+`"sambah"` - triggers samba regression test
+`"harmony-regression"` - triggers harmony-regression test
+
+
+**The important thing to note is that when you are adding a new service to
+harmony and adding its regression tests. You must include a mapping for the
+service as described by Harmony's /service-image-tag endpoint to the name of
+the regression test as described by the directory name in the regression tests.**

config/services_tests_config_prod.json

@@ -2,12 +2,12 @@
   "all": "harmony,harmony-regression,geoloco,hga,n2z,regridder,hoss,hybig,net2cog,smap-l2-gridder,subset-band-name,swath-projector,nsidc-icesat2,trajectory-subsetter,sambah,opera-rtc-s1-browse",
   "batchee": "sambah",
   "geoloco": "geoloco",
-  "giovanni-adapter": "TBD",
-  "harmony": "harmony",
+  "giovanni-time-series-adapter": "TBD",
   "harmony-gdal-adapter": "hga",
   "harmony-netcdf-to-zarr": "n2z",
-  "harmony-regridder": "regridder",
+  "harmony-regression": "harmony-regression",
   "harmony-service-example": "harmony-regression",
+  "harmony-smap-l2-gridder": "smap-l2-gridder",
   "hoss": "hoss",
   "hybig": "hybig,opera-rtc-s1-browse",
   "net2cog": "net2cog",
@@ -16,9 +16,12 @@
   "podaac-l2-subsetter": "sambah",
   "query-cmr": "geoloco",
   "sds-maskfill": "hoss",
-  "smap-l2-gridder": "smap-l2-gridder",
   "stitchee": "sambah",
   "subset-band-name": "subset-band-name",
   "swath-projector": "swath-projector",
-  "trajectory-subsetter": "nsidc-icesat2,trajectory-subsetter"
+  "trajectory-subsetter": "nsidc-icesat2,trajectory-subsetter",
+  "harmony": "harmony",
+  "harmony-regridder": "regridder",
+  "nsidc-icesat2": "nsidc-icesat2",
+  "sambah": "sambah"
 }

config/services_tests_config_uat.json

@@ -3,7 +3,6 @@
   "batchee": "sambah",
   "geoloco": "geoloco",
   "giovanni-adapter": "TBD",
-  "harmony": "harmony",
   "harmony-gdal-adapter": "hga",
   "harmony-netcdf-to-zarr": "n2z",
   "harmony-regridder": "regridder",
@@ -20,5 +19,9 @@
   "stitchee": "sambah",
   "subset-band-name": "subset-band-name",
   "swath-projector": "swath-projector",
-  "trajectory-subsetter": "nsidc-icesat2,trajectory-subsetter"
+  "trajectory-subsetter": "nsidc-icesat2,trajectory-subsetter",
+  "harmony": "harmony",
+  "harmony-regression": "harmony-regression",
+  "nsidc-icesat2": "nsidc-icesat2",
+  "sambah": "sambah"
 }