Skip to content

handle non-specified case in validation date format #179

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
utas-raymondng merged 4 commits into from
Oct 28, 2025
Merged

handle non-specified case in validation date format #179

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
07cf95e
handle non-specified case in validation date format
NekoLyn Oct 28, 2025
631b6bc
fix format
NekoLyn Oct 28, 2025
efd0b4d
refactor code
NekoLyn Oct 28, 2025
2a785da
Merge branch 'main' into bugfix/7651-handle-non-specified-date-case-f…
NekoLyn Oct 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions server/src/main/java/au/org/aodn/ogcapi/server/core/service/wfs/DownloadWfsDataService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,8 @@ private String buildCqlFilter(String startDate, String endDate, Object multiPoly
.filter(field -> "dateTime".equals(field.getType()) || "date".equals(field.getType()))
.findFirst();

// Add temporal filter
if (temporalField.isPresent() && startDate != null && endDate != null) {
// Add temporal filter only if both dates are specified
if (temporalField.isPresent() && startDate != null && !startDate.isEmpty() && endDate != null && !endDate.isEmpty()) {
String fieldName = temporalField.get().getName();
cqlFilter.append(fieldName)
.append(" DURING ")
Expand Down
8 changes: 7 additions & 1 deletion server/src/main/java/au/org/aodn/ogcapi/server/core/util/DatetimeUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ public class DatetimeUtils {
private static final Pattern MM_YYYY_PATTERN = Pattern.compile("^(\\d{2})-(\\d{4})$");
private static final Pattern YYYY_MM_DD_PATTERN = Pattern.compile("^\\d{4}-\\d{2}-\\d{2}$");
private static final DateTimeFormatter ISO_DATE_FORMAT = DateTimeFormatter.ofPattern("yyyy-MM-dd");
public static final String NON_SPECIFIED_DATE = "non-specified";

private DatetimeUtils() {
}
Expand All @@ -18,10 +19,15 @@ private DatetimeUtils() {
*
* @param dateInput Input date string (supports MM-YYYY or YYYY-MM-DD formats)
* @param isStartDate true for start date (first day of month), false for end date (last day of month)
* @return Formatted date string in YYYY-MM-DD format
* @return Formatted date string in YYYY-MM-DD format, or null if date is not specified
* @throws IllegalArgumentException if date format is invalid
*/
public static String validateAndFormatDate(String dateInput, boolean isStartDate) {
// Handle null, empty, or "non-specified" dates
if (dateInput == null || dateInput.trim().isEmpty() || NON_SPECIFIED_DATE.equalsIgnoreCase(dateInput.trim())) {
return null;
}

if (MM_YYYY_PATTERN.matcher(dateInput).matches()) {
String[] parts = dateInput.split("-");
int month = Integer.parseInt(parts[0]);
Expand Down
5 changes: 3 additions & 2 deletions server/src/main/java/au/org/aodn/ogcapi/server/processes/RestServices.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
import au.org.aodn.ogcapi.server.core.exception.wfs.WfsErrorHandler;
import au.org.aodn.ogcapi.server.core.model.enumeration.DatasetDownloadEnums;
import au.org.aodn.ogcapi.server.core.service.wfs.DownloadWfsDataService;
import au.org.aodn.ogcapi.server.core.util.DatetimeUtils;
import au.org.aodn.ogcapi.server.core.util.EmailUtils;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
Expand Down Expand Up @@ -121,8 +122,8 @@ private String generateStartedEmailContent(String uuid, String startDate, String
String template = new String(inputStream.readAllBytes(), StandardCharsets.UTF_8);

// Handle dates - only show if not "non-specified"
String displayStartDate = (startDate != null && !startDate.equals("non-specified")) ? startDate.replace("-", "/") : "";
String displayEndDate = (endDate != null && !endDate.equals("non-specified")) ? endDate.replace("-", "/") : "";
String displayStartDate = (startDate != null && !startDate.equals(DatetimeUtils.NON_SPECIFIED_DATE)) ? startDate.replace("-", "/") : "";
String displayEndDate = (endDate != null && !endDate.equals(DatetimeUtils.NON_SPECIFIED_DATE)) ? endDate.replace("-", "/") : "";

// Generate dynamic bbox HTML
String bboxHtml = EmailUtils.generateBboxHtml(multipolygon, objectMapper);
Expand Down
284 changes: 284 additions & 0 deletions .../src/test/java/au/org/aodn/ogcapi/server/core/service/wfs/DownloadWfsDataServiceTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,284 @@
package au.org.aodn.ogcapi.server.core.service.wfs;

import au.org.aodn.ogcapi.server.core.model.ogc.FeatureRequest;
import au.org.aodn.ogcapi.server.core.model.ogc.wfs.DownloadableFieldModel;
import au.org.aodn.ogcapi.server.core.model.ogc.wms.DescribeLayerResponse;
import au.org.aodn.ogcapi.server.core.service.wms.WmsServer;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.Mock;
import org.mockito.junit.jupiter.MockitoExtension;
import org.springframework.web.client.RestTemplate;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import static org.junit.jupiter.api.Assertions.*;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.*;

/**
* Unit tests for DownloadWfsDataService
*/
@ExtendWith(MockitoExtension.class)
public class DownloadWfsDataServiceTest {

@Mock
private WmsServer wmsServer;

@Mock
private WfsServer wfsServer;

@Mock
private RestTemplate restTemplate;

@Mock
private WfsDefaultParam wfsDefaultParam;

private DownloadWfsDataService downloadWfsDataService;

@BeforeEach
public void setUp() {
downloadWfsDataService = new DownloadWfsDataService(
wmsServer, wfsServer, restTemplate, wfsDefaultParam
);
}

/**
* Helper method to create a list of downloadable fields for testing
*/
private List<DownloadableFieldModel> createTestDownloadableFields() {
List<DownloadableFieldModel> fields = new ArrayList<>();

// Add geometry field
fields.add(DownloadableFieldModel.builder()
.name("geom")
.label("geom")
.type("geometrypropertytype")
.build());

// Add datetime field
fields.add(DownloadableFieldModel.builder()
.name("timestamp")
.label("timestamp")
.type("dateTime")
.build());

return fields;
}

@Test
public void testPrepareWfsRequestUrl_WithNullDates() {
// Setup
String uuid = "test-uuid";
String layerName = "test:layer";
List<DownloadableFieldModel> fields = createTestDownloadableFields();

DescribeLayerResponse describeLayerResponse = mock(DescribeLayerResponse.class);
DescribeLayerResponse.LayerDescription layerDescription = mock(DescribeLayerResponse.LayerDescription.class);
DescribeLayerResponse.Query query = mock(DescribeLayerResponse.Query.class);

when(describeLayerResponse.getLayerDescription()).thenReturn(layerDescription);
when(layerDescription.getWfs()).thenReturn("https://test.com/geoserver/wfs");
when(layerDescription.getQuery()).thenReturn(query);
when(query.getTypeName()).thenReturn(layerName);

when(wmsServer.describeLayer(eq(uuid), any(FeatureRequest.class))).thenReturn(describeLayerResponse);
when(wfsServer.getDownloadableFields(eq(uuid), any(FeatureRequest.class), anyString())).thenReturn(fields);

Map<String, String> defaultParams = new HashMap<>();
defaultParams.put("service", "WFS");
defaultParams.put("version", "2.0.0");
defaultParams.put("request", "GetFeature");
when(wfsDefaultParam.getDownload()).thenReturn(defaultParams);

// Test with null dates (non-specified dates from frontend)
String result = downloadWfsDataService.prepareWfsRequestUrl(
uuid, null, null, null, null, layerName
);

// Verify URL doesn't contain temporal filter when dates are null
assertNotNull(result);
assertTrue(result.contains("typeName=" + layerName));
assertFalse(result.contains("cql_filter"), "URL should not contain cql_filter when dates are null");
}

@Test
public void testPrepareWfsRequestUrl_WithEmptyDates() {
// Setup
String uuid = "test-uuid";
String layerName = "test:layer";
List<DownloadableFieldModel> fields = createTestDownloadableFields();

DescribeLayerResponse describeLayerResponse = mock(DescribeLayerResponse.class);
DescribeLayerResponse.LayerDescription layerDescription = mock(DescribeLayerResponse.LayerDescription.class);
DescribeLayerResponse.Query query = mock(DescribeLayerResponse.Query.class);

when(describeLayerResponse.getLayerDescription()).thenReturn(layerDescription);
when(layerDescription.getWfs()).thenReturn("https://test.com/geoserver/wfs");
when(layerDescription.getQuery()).thenReturn(query);
when(query.getTypeName()).thenReturn(layerName);

when(wmsServer.describeLayer(eq(uuid), any(FeatureRequest.class))).thenReturn(describeLayerResponse);
when(wfsServer.getDownloadableFields(eq(uuid), any(FeatureRequest.class), anyString())).thenReturn(fields);

Map<String, String> defaultParams = new HashMap<>();
defaultParams.put("service", "WFS");
defaultParams.put("version", "2.0.0");
defaultParams.put("request", "GetFeature");
when(wfsDefaultParam.getDownload()).thenReturn(defaultParams);

// Test with empty string dates
String result = downloadWfsDataService.prepareWfsRequestUrl(
uuid, "", "", null, null, layerName
);

// Verify URL doesn't contain temporal filter when dates are empty
assertNotNull(result);
assertTrue(result.contains("typeName=" + layerName));
assertFalse(result.contains("cql_filter"), "URL should not contain cql_filter when dates are empty");
}

@Test
public void testPrepareWfsRequestUrl_WithValidDates() {
// Setup
String uuid = "test-uuid";
String layerName = "test:layer";
String startDate = "2023-01-01";
String endDate = "2023-12-31";
List<DownloadableFieldModel> fields = createTestDownloadableFields();

DescribeLayerResponse describeLayerResponse = mock(DescribeLayerResponse.class);
DescribeLayerResponse.LayerDescription layerDescription = mock(DescribeLayerResponse.LayerDescription.class);
DescribeLayerResponse.Query query = mock(DescribeLayerResponse.Query.class);

when(describeLayerResponse.getLayerDescription()).thenReturn(layerDescription);
when(layerDescription.getWfs()).thenReturn("https://test.com/geoserver/wfs");
when(layerDescription.getQuery()).thenReturn(query);
when(query.getTypeName()).thenReturn(layerName);

when(wmsServer.describeLayer(eq(uuid), any(FeatureRequest.class))).thenReturn(describeLayerResponse);
when(wfsServer.getDownloadableFields(eq(uuid), any(FeatureRequest.class), anyString())).thenReturn(fields);

Map<String, String> defaultParams = new HashMap<>();
defaultParams.put("service", "WFS");
defaultParams.put("version", "2.0.0");
defaultParams.put("request", "GetFeature");
when(wfsDefaultParam.getDownload()).thenReturn(defaultParams);

// Test with valid dates
String result = downloadWfsDataService.prepareWfsRequestUrl(
uuid, startDate, endDate, null, null, layerName
);

// Verify URL contains temporal filter when valid dates are provided
assertNotNull(result);
assertTrue(result.contains("typeName=" + layerName));
assertTrue(result.contains("cql_filter"), "URL should contain cql_filter with valid dates");
assertTrue(result.contains("DURING"), "CQL filter should contain DURING operator");
assertTrue(result.contains("2023-01-01T00:00:00Z"), "CQL filter should contain start date");
assertTrue(result.contains("2023-12-31T23:59:59Z"), "CQL filter should contain end date");
}

@Test
public void testPrepareWfsRequestUrl_WithOnlyStartDate() {
// Setup
String uuid = "test-uuid";
String layerName = "test:layer";
String startDate = "2023-01-01";
List<DownloadableFieldModel> fields = createTestDownloadableFields();

DescribeLayerResponse describeLayerResponse = mock(DescribeLayerResponse.class);
DescribeLayerResponse.LayerDescription layerDescription = mock(DescribeLayerResponse.LayerDescription.class);
DescribeLayerResponse.Query query = mock(DescribeLayerResponse.Query.class);

when(describeLayerResponse.getLayerDescription()).thenReturn(layerDescription);
when(layerDescription.getWfs()).thenReturn("https://test.com/geoserver/wfs");
when(layerDescription.getQuery()).thenReturn(query);
when(query.getTypeName()).thenReturn(layerName);

when(wmsServer.describeLayer(eq(uuid), any(FeatureRequest.class))).thenReturn(describeLayerResponse);
when(wfsServer.getDownloadableFields(eq(uuid), any(FeatureRequest.class), anyString())).thenReturn(fields);

Map<String, String> defaultParams = new HashMap<>();
defaultParams.put("service", "WFS");
defaultParams.put("version", "2.0.0");
defaultParams.put("request", "GetFeature");
when(wfsDefaultParam.getDownload()).thenReturn(defaultParams);

// Test with only start date (end date is null)
String result = downloadWfsDataService.prepareWfsRequestUrl(
uuid, startDate, null, null, null, layerName
);

// Verify URL doesn't contain temporal filter when only one date is provided
assertNotNull(result);
assertTrue(result.contains("typeName=" + layerName));
assertFalse(result.contains("cql_filter"), "URL should not contain cql_filter when only start date is provided");
}

@Test
public void testPrepareWfsRequestUrl_WithMMYYYYFormat() {
// Setup
String uuid = "test-uuid";
String layerName = "test:layer";
String startDate = "01-2023"; // MM-YYYY format
String endDate = "12-2023"; // MM-YYYY format
List<DownloadableFieldModel> fields = createTestDownloadableFields();

DescribeLayerResponse describeLayerResponse = mock(DescribeLayerResponse.class);
DescribeLayerResponse.LayerDescription layerDescription = mock(DescribeLayerResponse.LayerDescription.class);
DescribeLayerResponse.Query query = mock(DescribeLayerResponse.Query.class);

when(describeLayerResponse.getLayerDescription()).thenReturn(layerDescription);
when(layerDescription.getWfs()).thenReturn("https://test.com/geoserver/wfs");
when(layerDescription.getQuery()).thenReturn(query);
when(query.getTypeName()).thenReturn(layerName);

when(wmsServer.describeLayer(eq(uuid), any(FeatureRequest.class))).thenReturn(describeLayerResponse);
when(wfsServer.getDownloadableFields(eq(uuid), any(FeatureRequest.class), anyString())).thenReturn(fields);

Map<String, String> defaultParams = new HashMap<>();
defaultParams.put("service", "WFS");
defaultParams.put("version", "2.0.0");
defaultParams.put("request", "GetFeature");
when(wfsDefaultParam.getDownload()).thenReturn(defaultParams);

// Test with MM-YYYY format dates
String result = downloadWfsDataService.prepareWfsRequestUrl(
uuid, startDate, endDate, null, null, layerName
);

// Verify URL contains temporal filter with converted dates
assertNotNull(result);
assertTrue(result.contains("typeName=" + layerName));
assertTrue(result.contains("cql_filter"), "URL should contain cql_filter");
assertTrue(result.contains("DURING"), "CQL filter should contain DURING operator");
// Start date should be first day of January 2023
assertTrue(result.contains("2023-01-01T00:00:00Z"), "Start date should be converted to first day of month");
// End date should be last day of December 2023
assertTrue(result.contains("2023-12-31T23:59:59Z"), "End date should be converted to last day of month");
}

@Test
public void testPrepareWfsRequestUrl_NoWfsServerUrl() {
// Setup
String uuid = "test-uuid";
String layerName = "test:layer";

when(wmsServer.describeLayer(eq(uuid), any(FeatureRequest.class))).thenReturn(null);
when(wfsServer.getFeatureServerUrl(eq(uuid), eq(layerName))).thenReturn(java.util.Optional.empty());

// Test with no WFS server URL available
Exception exception = assertThrows(IllegalArgumentException.class, () -> {
downloadWfsDataService.prepareWfsRequestUrl(
uuid, null, null, null, null, layerName
);
});

assertTrue(exception.getMessage().contains("No WFS server URL found"));
}
}
13 changes: 0 additions & 13 deletions ...c/test/java/au/org/aodn/ogcapi/server/core/service/wfs/DownloadableFieldsServiceTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -219,19 +219,6 @@ public void testGetDownloadableFieldsEmptyResponse() {
);
}

// @Test
// public void testGetDownloadableFieldsUnauthorizedServer() {
// when(wfsServerConfig.validateAndGetApprovedServerUrl(UNAUTHORIZED_SERVER))
// .thenThrow(new UnauthorizedServerException("Access to WFS server '" + UNAUTHORIZED_SERVER + "' is not authorized"));
// UnauthorizedServerException exception = assertThrows(
// UnauthorizedServerException.class,
// () -> downloadableFieldsService.getDownloadableFields(UNAUTHORIZED_SERVER, "test:layer")
// );
//
// assertTrue(exception.getMessage().contains("not authorized"));
// assertTrue(exception.getMessage().contains(UNAUTHORIZED_SERVER));
// }
//
@Test
public void testGetDownloadableFieldsWfsError() {
FeatureRequest request = FeatureRequest.builder().layerName("invalid:layer").build();
Expand Down
Loading