Add static analysis unit test for Controller classes

.github/workflows/build.yml

@@ -56,6 +56,30 @@ jobs:
           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 :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'
   build-docker-image:
     runs-on: ubuntu-latest
     steps:

cwms-data-api/build.gradle

@@ -159,6 +159,8 @@ dependencies {
 
     // override versions
     implementation(libs.bundles.overrides)
+
+    testImplementation(libs.bundles.java.parser)
 }
 
 task extractWebJars(type: Copy) {

cwms-data-api/src/test/java/helpers/OpenApiDocInfo.java

@@ -0,0 +1,59 @@
+/*
+ * MIT License
+ * Copyright (c) 2025 Hydrologic Engineering Center
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package helpers;
+
+import java.lang.reflect.Method;
+import java.util.ArrayList;
+import java.util.List;
+
+public class OpenApiDocInfo {
+    private final Method method;
+    private final List<OpenApiParamInfo> queryParameters = new ArrayList<>();
+    private final List<OpenApiParamInfo> pathParameters = new ArrayList<>();
+    private final boolean ignored;
+
+    public OpenApiDocInfo(Method method, boolean ignored) {
+        this.method = method;
+        this.ignored = ignored;
+    }
+
+    public Method getMethod() {
+        return method;
+    }
+
+    public List<OpenApiParamInfo> getPathParameters() {
+        return pathParameters;
+    }
+
+    public List<OpenApiParamInfo> getQueryParameters() {
+        return queryParameters;
+    }
+
+    public boolean isIgnored() {
+        return ignored;
+    }
+
+    @Override
+    public String toString() {
+        String temp = ignored ? " - Ignored" : "";
+        return method.getName() + temp;
+    }
+}

cwms-data-api/src/test/java/helpers/OpenApiDocTestInfo.java

@@ -0,0 +1,51 @@
+/*
+ * MIT License
+ * Copyright (c) 2025 Hydrologic Engineering Center
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package helpers;
+
+import java.lang.reflect.Method;
+import java.util.List;
+import java.util.stream.Collectors;
+
+public class OpenApiDocTestInfo {
+    private final Class<?> clazz;
+    private final List<OpenApiDocInfo> methodDocs;
+
+    public OpenApiDocTestInfo(Class<?> clazz, List<OpenApiDocInfo> methodDocs) {
+        this.clazz = clazz;
+        this.methodDocs = methodDocs;
+    }
+
+    public List<OpenApiDocInfo> getMethodDocs() {
+        return methodDocs;
+    }
+
+    public Class<?> getClazz() {
+        return clazz;
+    }
+
+    @Override
+    public String toString() {
+        return clazz.getSimpleName() + ": " + methodDocs.stream()
+                                                        .map(OpenApiDocInfo::getMethod)
+                                                        .map(Method::getName)
+                                                        .collect(Collectors.joining(", "));
+    }
+}

cwms-data-api/src/test/java/helpers/OpenApiParamInfo.java

@@ -0,0 +1,73 @@
+/*
+ * MIT License
+ * Copyright (c) 2025 Hydrologic Engineering Center
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package helpers;
+
+import java.util.Objects;
+
+public class OpenApiParamInfo {
+    private String name;
+    private final boolean required;
+    private final Class<?> type;
+
+    public OpenApiParamInfo(String name, boolean required, Class<?> type) {
+        this.name = name;
+        this.required = required;
+        this.type = type;
+    }
+
+    public OpenApiParamInfo setName(String name) {
+        this.name = name;
+        return this;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public boolean isRequired() {
+        return required;
+    }
+
+    public Class<?> getType() {
+        return type;
+    }
+
+    @Override
+    public String toString() {
+        String req = required ? " (required)" : "";
+        String clazz = type != null ? type.getSimpleName() : "null";
+        return clazz + " " + name + req;
+    }
+
+    @Override
+    public boolean equals(Object o) {
+        if (!(o instanceof OpenApiParamInfo)) {
+            return false;
+        }
+        OpenApiParamInfo that = (OpenApiParamInfo) o;
+        return Objects.equals(getName(), that.getName());
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hashCode(getName());
+    }
+}

cwms-data-api/src/test/java/helpers/OpenApiParamUsage.java

@@ -0,0 +1,65 @@
+/*
+ * MIT License
+ * Copyright (c) 2025 Hydrologic Engineering Center
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package helpers;
+
+import java.util.Objects;
+import java.util.Set;
+
+public class OpenApiParamUsage {
+    private final Set<OpenApiParamUsageInfo> queryParams;
+    private final Set<OpenApiParamUsageInfo> pathParams;
+    private final OpenApiParamUsageInfo resourceId;
+
+    public OpenApiParamUsage(Set<OpenApiParamUsageInfo> pathParams, Set<OpenApiParamUsageInfo> queryParams,
+                             OpenApiParamUsageInfo resourceId) {
+        this.pathParams = pathParams;
+        this.queryParams = queryParams;
+        this.resourceId = resourceId;
+    }
+
+    public Set<OpenApiParamUsageInfo> getPathParams() {
+        return pathParams;
+    }
+
+    public Set<OpenApiParamUsageInfo> getQueryParams() {
+        return queryParams;
+    }
+
+    public OpenApiParamUsageInfo getResourceId() {
+        return resourceId;
+    }
+
+    @Override
+    public boolean equals(Object o) {
+        if (!(o instanceof OpenApiParamUsage)) {
+            return false;
+        }
+        OpenApiParamUsage that = (OpenApiParamUsage) o;
+        return Objects.equals(getQueryParams(), that.getQueryParams()) && Objects.equals(getPathParams(),
+                                                                                         that.getPathParams()) && Objects.equals(
+                getResourceId(), that.getResourceId());
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(getQueryParams(), getPathParams(), getResourceId());
+    }
+}

cwms-data-api/src/test/java/helpers/OpenApiParamUsageInfo.java

@@ -0,0 +1,67 @@
+/*
+ * MIT License
+ * Copyright (c) 2025 Hydrologic Engineering Center
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package helpers;
+
+import java.util.Objects;
+
+public class OpenApiParamUsageInfo {
+    private final OpenApiParamInfo paramInfo;
+    private final boolean used;
+    private final boolean nullHandled;
+
+    public OpenApiParamUsageInfo(OpenApiParamInfo paramInfo, boolean used, boolean nullHandled) {
+        this.paramInfo = paramInfo;
+        this.used = used;
+        this.nullHandled = nullHandled;
+    }
+
+    public OpenApiParamInfo getParamInfo() {
+        return paramInfo;
+    }
+
+    public boolean isUsed() {
+        return used;
+    }
+
+    public boolean isNullHandled() {
+        return nullHandled;
+    }
+
+    @Override
+    public String toString() {
+        String realUse = used ? "In use" : "Not Used";
+        return paramInfo + " - " + realUse;
+    }
+
+    @Override
+    public boolean equals(Object o) {
+        if (!(o instanceof OpenApiParamUsageInfo)) {
+            return false;
+        }
+        OpenApiParamUsageInfo that = (OpenApiParamUsageInfo) o;
+        return Objects.equals(getParamInfo(), that.getParamInfo());
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hashCode(getParamInfo());
+    }
+}