Adding LocationKindController and EndpointInput, updating swagger generated classes by adding CwmsIdLocationKind.

Adding unit tests for LocationKindController and EndpointInput

Author: RyanM-RMA

cwms-data-api-client/src/main/java/mil/army/usace/hec/cwms/data/api/client/controllers/LocationKindController.java

@@ -0,0 +1,31 @@
+/*
+ * Copyright (c) 2025. Hydrologic Engineering Center (HEC).
+ * United States Army Corps of Engineers
+ * All Rights Reserved. HEC PROPRIETARY/CONFIDENTIAL.
+ * Source may not be released without written approval from HEC
+ */
+
+package mil.army.usace.hec.cwms.data.api.client.controllers;
+
+import mil.army.usace.hec.cwms.data.api.client.model.CwmsIdLocationKind;
+import mil.army.usace.hec.cwms.data.api.client.model.RadarObjectMapper;
+import mil.army.usace.hec.cwms.http.client.ApiConnectionInfo;
+import mil.army.usace.hec.cwms.http.client.HttpRequestBuilderImpl;
+import mil.army.usace.hec.cwms.http.client.HttpRequestResponse;
+import mil.army.usace.hec.cwms.http.client.request.HttpRequestExecutor;
+
+import java.io.IOException;
+import java.util.List;
+
+public final class LocationKindController {
+    private static final String LOCATION_KIND_ENDPOINT = "locations/with-kind";
+
+    public List<CwmsIdLocationKind> retrieveLocationsWithKind(ApiConnectionInfo apiConnectionInfo, LocationKindEndpointInput.GetAll input) throws IOException {
+        HttpRequestExecutor executor = new HttpRequestBuilderImpl(apiConnectionInfo, LOCATION_KIND_ENDPOINT)
+                .addEndpointInput(input)
+                .get();
+        try (HttpRequestResponse response = executor.execute()) {
+            return RadarObjectMapper.mapJsonToListOfObjects(response.getBody(), CwmsIdLocationKind.class);
+        }
+    }
+}

cwms-data-api-client/src/main/java/mil/army/usace/hec/cwms/data/api/client/controllers/LocationKindEndpointInput.java

@@ -0,0 +1,61 @@
+/*
+ * Copyright (c) 2025. Hydrologic Engineering Center (HEC).
+ * United States Army Corps of Engineers
+ * All Rights Reserved. HEC PROPRIETARY/CONFIDENTIAL.
+ * Source may not be released without written approval from HEC
+ */
+
+package mil.army.usace.hec.cwms.data.api.client.controllers;
+
+import mil.army.usace.hec.cwms.http.client.EndpointInput;
+import mil.army.usace.hec.cwms.http.client.HttpRequestBuilder;
+
+import static mil.army.usace.hec.cwms.data.api.client.controllers.CdaEndpointConstants.ACCEPT_HEADER_JSON;
+import static mil.army.usace.hec.cwms.data.api.client.controllers.CdaEndpointConstants.ACCEPT_QUERY_HEADER;
+
+public final class LocationKindEndpointInput {
+
+    static final String OFFICE_QUERY_PARAMETER = "office";
+    static final String NAMES_QUERY_PARAMETER = "names";
+    static final String LOCATION_KIND_LIKE_QUERY_PARAMETER = "location-kind-like";
+
+    private LocationKindEndpointInput() {
+        throw new AssertionError("Factory class");
+    }
+
+    public static GetAll getAll() {
+        return new GetAll();
+    }
+
+    public static class GetAll extends EndpointInput {
+        private String office;
+        private String names;
+        private String locationKindLike;
+
+        public GetAll() {
+        }
+
+        public GetAll locationKindLike(String locationKindLike) {
+            this.locationKindLike = locationKindLike;
+            return this;
+        }
+
+        public GetAll names(String names) {
+            this.names = names;
+            return this;
+        }
+
+        public GetAll office(String office) {
+            this.office = office;
+            return this;
+        }
+
+        @Override
+        protected HttpRequestBuilder addInputParameters(HttpRequestBuilder httpRequestBuilder) {
+            return httpRequestBuilder.addQueryParameter(OFFICE_QUERY_PARAMETER, office)
+                                     .addQueryParameter(NAMES_QUERY_PARAMETER, names)
+                                     .addQueryParameter(LOCATION_KIND_LIKE_QUERY_PARAMETER, locationKindLike)
+                                     .addQueryHeader(ACCEPT_QUERY_HEADER, ACCEPT_HEADER_JSON);
+        }
+    }
+}

cwms-data-api-client/src/test/java/mil/army/usace/hec/cwms/data/api/client/controllers/TestLocationKindController.java

@@ -0,0 +1,29 @@
+/*
+ * Copyright (c) 2025. Hydrologic Engineering Center (HEC).
+ * United States Army Corps of Engineers
+ * All Rights Reserved. HEC PROPRIETARY/CONFIDENTIAL.
+ * Source may not be released without written approval from HEC
+ */
+
+package mil.army.usace.hec.cwms.data.api.client.controllers;
+
+import mil.army.usace.hec.cwms.data.api.client.model.CwmsIdLocationKind;
+import org.junit.jupiter.api.Test;
+
+import java.util.List;
+
+import static org.junit.jupiter.api.Assertions.*;
+
+class TestLocationKindController extends TestController {
+    private static final String TEST_ALL_LOCATION_KIND_MOCK_DATA = "radar/v1/json/locations_with_kinds.json";
+
+    @Test
+    void testOptionalLocationKindController() throws Exception {
+        String collect = readJsonFile(TEST_ALL_LOCATION_KIND_MOCK_DATA);
+        mockHttpServer.enqueue(collect);
+        mockHttpServer.start();
+        LocationKindEndpointInput.GetAll input = new LocationKindEndpointInput.GetAll();
+        List<CwmsIdLocationKind> kinds = new LocationKindController().retrieveLocationsWithKind(buildConnectionInfo(), input);
+        assertNotNull(kinds);
+    }
+}

cwms-data-api-client/src/test/java/mil/army/usace/hec/cwms/data/api/client/controllers/TestLocationKindEndpointInput.java

@@ -0,0 +1,50 @@
+/*
+ * Copyright (c) 2025. Hydrologic Engineering Center (HEC).
+ * United States Army Corps of Engineers
+ * All Rights Reserved. HEC PROPRIETARY/CONFIDENTIAL.
+ * Source may not be released without written approval from HEC
+ */
+
+package mil.army.usace.hec.cwms.data.api.client.controllers;
+
+import org.junit.jupiter.api.Test;
+
+import static mil.army.usace.hec.cwms.data.api.client.controllers.CdaEndpointConstants.ACCEPT_HEADER_JSON;
+import static mil.army.usace.hec.cwms.data.api.client.controllers.CdaEndpointConstants.ACCEPT_QUERY_HEADER;
+import static mil.army.usace.hec.cwms.data.api.client.controllers.LocationKindEndpointInput.LOCATION_KIND_LIKE_QUERY_PARAMETER;
+import static mil.army.usace.hec.cwms.data.api.client.controllers.LocationKindEndpointInput.NAMES_QUERY_PARAMETER;
+import static mil.army.usace.hec.cwms.data.api.client.controllers.LocationKindEndpointInput.OFFICE_QUERY_PARAMETER;
+import static org.junit.jupiter.api.Assertions.*;
+
+class TestLocationKindEndpointInput {
+    private static final String TEST_OFFICE = "SPK";
+    private static final String TEST_NAMES = "LOC_TEST";
+    private static final String TEST_LOCATION_KIND_LIKE = "SITE";
+
+    @Test
+    void testGetAll() {
+        MockHttpRequestBuilder mockHttpRequestBuilder = new MockHttpRequestBuilder();
+        LocationKindEndpointInput.GetAll input = LocationKindEndpointInput.getAll();
+        input.locationKindLike(TEST_LOCATION_KIND_LIKE)
+             .names(TEST_NAMES)
+             .office(TEST_OFFICE);
+
+        input.addInputParameters(mockHttpRequestBuilder);
+        assertEquals(TEST_OFFICE, mockHttpRequestBuilder.getQueryParameter(OFFICE_QUERY_PARAMETER));
+        assertEquals(TEST_NAMES, mockHttpRequestBuilder.getQueryParameter(NAMES_QUERY_PARAMETER));
+        assertEquals(TEST_LOCATION_KIND_LIKE, mockHttpRequestBuilder.getQueryParameter(LOCATION_KIND_LIKE_QUERY_PARAMETER));
+        assertEquals(ACCEPT_HEADER_JSON, mockHttpRequestBuilder.getQueryHeader(ACCEPT_QUERY_HEADER));
+    }
+
+    @Test
+    void testGetAllPlain() {
+        MockHttpRequestBuilder mockHttpRequestBuilder = new MockHttpRequestBuilder();
+        LocationKindEndpointInput.GetAll input = LocationKindEndpointInput.getAll();
+
+        input.addInputParameters(mockHttpRequestBuilder);
+        assertNull(mockHttpRequestBuilder.getQueryParameter(OFFICE_QUERY_PARAMETER));
+        assertNull(mockHttpRequestBuilder.getQueryParameter(NAMES_QUERY_PARAMETER));
+        assertNull(mockHttpRequestBuilder.getQueryParameter(LOCATION_KIND_LIKE_QUERY_PARAMETER));
+        assertEquals(ACCEPT_HEADER_JSON, mockHttpRequestBuilder.getQueryHeader(ACCEPT_QUERY_HEADER));
+    }
+}