Update test branch (#1538)

Pull in latest changes to develop since the last time we did this.

NOTE: I'm pretty sure this is everything, but it's a lot to keep track
of so is possible I've missed something.

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Zack Olson <zack@rmanet.com>
Co-authored-by: Ryan Ripken <89810919+rma-rripken@users.noreply.github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Charles Graham <charles.r.graham@usace.army.mil>
Co-authored-by: Bryson Spilman <87150647+rma-bryson@users.noreply.github.com>
Co-authored-by: rma-kayla <kayla@rmanet.com>
Co-authored-by: Ryan Miles <ryanm@rmanet.com>
Co-authored-by: Adam Korynta <47677856+adamkorynta@users.noreply.github.com>
Co-authored-by: Bryson Spilman <bryson@rmanet.com>
Co-authored-by: Daniel Osborne <Daniel.T.Osborne@usace.army.mil>

Author: 10 people

.github/workflows/build.yml

@@ -15,13 +15,20 @@ jobs:
       matrix:
         jdk: [11]
         schema:
-          - "ghcr.io/hydrologicengineeringcenter/cwms-database/cwms/database-ready-ora-23.5:latest-dev"
-          - "ghcr.io/hydrologicengineeringcenter/cwms-database/cwms/database-ready-ora-23.5:25-07-01-RC06"
-    name: build and test
+          - env: latest
+            image: "ghcr.io/hydrologicengineeringcenter/cwms-database/cwms/database-ready-ora-23.5:latest-dev"
+          - env: release
+            image: "ghcr.io/hydrologicengineeringcenter/cwms-database/cwms/database-ready-ora-23.5:25.07.01"
+    name: build and test (jdk ${{matrix.jdk}}, schema ${{matrix.schema.env}})
     runs-on: ubuntu-latest
     outputs:
       thewar: ${{steps.thebuild.outputs.WARFILE}}
     steps:
+      - name: Clean up disk space, so we don't run out.
+        run: |
+          sudo rm -rf /usr/share/dotnet
+          sudo rm -rf /usr/local/lib/android
+          sudo rm -rf /opt/ghc
       - name: checkout code
         uses: actions/checkout@v5.0.0
       - name: setup java
@@ -30,30 +37,43 @@ jobs:
           distribution: 'temurin'
           java-version: ${{matrix.jdk}}
           cache: 'gradle'
-      - name: install node for cda-gui audit
-        uses: actions/setup-node@v4
-        with:
-          node-version: '22'
-          cache: 'npm'
-          cache-dependency-path: cda-gui/package-lock.json
-
-      - name: run cda-gui audit for high CVE
-        working-directory: ./cda-gui
-        run: |
-          npm install --package-lock-only
-          npm audit --audit-level=high
       - name: build and test
         id: thebuild
-        run: ./gradlew build --info --init-script init.gradle
+        run: ./gradlew clean build --info --init-script init.gradle
       - name: integration tests
-        run: ./gradlew integrationtest --info --init-script init.gradle -PCDA.oracle.database.image=${{matrix.schema}}
+        run: ./gradlew integrationtest --info --init-script init.gradle -PCDA.oracle.database.image=${{matrix.schema.image}}
       - name: Publish Test Report
         uses: mikepenz/action-junit-report@v5
         if: success() || failure() # always run even if the previous step fails
         with:
           annotate_only: true
           include_passed: true
           report_paths: '**/TEST-*.xml'
+  open-api-static-analysis:
+    name: OpenApi Static Analysis Tests
+    runs-on: ubuntu-latest
+    env:
+      OPEN_API_TEST: "true"
+    steps:
+      - name: checkout code
+        uses: actions/checkout@v5.0.0
+      - name: setup java
+        uses: actions/setup-java@v5.0.0
+        with:
+          distribution: 'temurin'
+          java-version: 11
+          cache: 'gradle'
+      - name: build and test
+        id: thebuild
+        run: ./gradlew clean :cwms-data-api:test --tests "cwms.cda.api.OpenApiDocTest" --info --init-script init.gradle
+      - name: Publish Test Report
+        uses: mikepenz/action-junit-report@v5
+        if: always()
+        with:
+          annotate_only: true
+          include_passed: true
+          report_paths: '**/TEST-*.xml'
+          detailed_summary: true
   build-docker-image:
     runs-on: ubuntu-latest
     steps:

.github/workflows/release.yml

@@ -50,6 +50,12 @@ jobs:
       api_image: ${{steps.set_image.outputs.api_image}}
       migration_image: ${{steps.migration-publish.outputs.image}}
     steps:
+      - name: Clean up disk space, so we don't run out.
+        if: matrix.platform == 'ubuntu-latest'
+        run: |
+          sudo rm -rf /usr/share/dotnet
+          sudo rm -rf /usr/local/lib/android
+          sudo rm -rf /opt/ghc
       - name: checkout code
         uses: actions/checkout@v5.0.0
         with:

.github/workflows/web-gui-checks.yml

@@ -0,0 +1,37 @@
+name: CDA Web GUI NPM Audit (CVE)
+
+on:
+  push:
+    branches:
+      - develop
+    pull_request:
+      branches:
+        - develop
+    # Only run when relevant files change (i.e. packages are bumped into new NPM versions)
+    paths:
+      - "cda-gui/**"
+      - ".github/workflows/web-gui-*.yml"
+
+  # Allow running audits adhoc via "run task" in the UI
+  workflow_dispatch:
+
+jobs:
+  audit:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: install node for cda-gui audit
+        uses: actions/setup-node@v4
+        with:
+          node-version: '22'
+          cache: 'npm'
+          cache-dependency-path: cda-gui/package-lock.json
+
+      - name: run cda-gui audit for critical CVE
+        working-directory: ./cda-gui
+        # disable husky git hooks during CI runs
+        run: |
+          HUSKY=0 npm ci
+          npm audit --audit-level=critical

.readthedocs.yaml

@@ -10,6 +10,7 @@ build:
 # Build documentation in the "docs/" directory with Sphinx
 sphinx:
    configuration: docs/source/conf.py
+   fail_on_warning: true
 # Optionally, but recommended,
 # declare the Python requirements required to build your documentation
 # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html

Dockerfile

@@ -24,11 +24,11 @@ RUN apk --no-cache upgrade && \
 
 RUN mkdir /download && \
     cd /download && \
-    wget https://archive.apache.org/dist/tomcat/tomcat-9/v9.0.105/bin/apache-tomcat-9.0.105.tar.gz && \
-    echo "904f10378ee2c7c68529edfefcba50c77eb677aa4586cfac0603e44703b0278f71f683b0295774f3cdcb027229d146490ef2c8868d8c2b5a631cf3db61ff9956 *apache-tomcat-9.0.105.tar.gz" > checksum.txt && \
+    wget https://archive.apache.org/dist/tomcat/tomcat-9/v9.0.112/bin/apache-tomcat-9.0.112.tar.gz && \
+    echo "fc55589f28bf6659928167461c741649b6005b64285dd81df05bb5ee40f4c6de59b8ee3af84ff756ae1513fc47f5f73070e29313b555e27f096f25881c69841d *apache-tomcat-9.0.112.tar.gz" > checksum.txt && \
     sha512sum -c checksum.txt && \
     tar xzf apache-tomcat-*tar.gz && \
-    mv apache-tomcat-9.0.105 /usr/local/tomcat/ && \
+    mv apache-tomcat-9.0.112 /usr/local/tomcat/ && \
     cd / && \
     rm -rf /download && \
     rm -rf /usr/local/tomcat/webapps/* && \

README.md

@@ -38,10 +38,11 @@ This is a new implementation of a REST API for data retrieval of USACE Water Dat
 
 See the [📃 Wiki](https://github.com/USACE/cwms-data-api/wiki) for how to get started
 
+End user documentation available here: [📕 Read the Docs](https://cwms-data-api.readthedocs.io/latest)
 
 ## Development notes
 
-Development and runtime currently requires java 8.
+Development and runtime currently requires java 11. JDKs and JREs greater than 11 should work, please report if they don't.
 
 
 To build the war:
@@ -52,7 +53,7 @@ This will compile the jar and run the basic unit tests.
 
 ## Development stack
 
-See the README.docker-compose.md for instructions using the docker-compose environment
+See the docker-compose.README.md for instructions using the docker-compose environment
 
 ## Testing