fix: sort expired_calendar notices by row number (#1968)

Author: sylvansson

main/src/main/java/org/mobilitydata/gtfsvalidator/validator/ExpiredCalendarValidator.java

@@ -54,6 +54,9 @@ public void validate(NoticeContainer noticeContainer) {
         CalendarUtil.servicePeriodToServiceDatesMap(
             CalendarUtil.buildServicePeriodMap(calendarTable, calendarDateTable));
     boolean isCalendarTableEmpty = calendarTable.getEntities().isEmpty();
+    List<ExpiredCalendarNotice> noticesToReturn = new ArrayList<>();
+    // Notices to return only if there are no calendars in `calendar.txt` and
+    // all calendar dates are in the past.
     List<ExpiredCalendarNotice> expiredCalendarDatesNotices = new ArrayList<>();
     boolean allCalendarAreExpired = true;
     for (var serviceId : servicePeriodMap.keySet()) {
@@ -63,7 +66,7 @@ public void validate(NoticeContainer noticeContainer) {
       }
       if (serviceDates.last().isBefore(dateForValidation.getDate())) {
         if (calendarTable.byServiceId(serviceId).isPresent()) {
-          noticeContainer.addValidationNotice(
+          noticesToReturn.add(
               new ExpiredCalendarNotice(
                   calendarTable.byServiceId(serviceId).get().csvRowNumber(), serviceId));
         } else if (isCalendarTableEmpty && allCalendarAreExpired) {
@@ -82,8 +85,11 @@ public void validate(NoticeContainer noticeContainer) {
       }
     }
     if (isCalendarTableEmpty && allCalendarAreExpired) {
-      noticeContainer.addValidationNotices(expiredCalendarDatesNotices);
+      noticesToReturn.addAll(expiredCalendarDatesNotices);
     }
+
+    noticesToReturn.sort(Comparator.comparing(ExpiredCalendarNotice::getCsvRowNumber));
+    noticeContainer.addValidationNotices(noticesToReturn);
   }
 
   /**
@@ -111,5 +117,9 @@ static class ExpiredCalendarNotice extends ValidationNotice {
       this.csvRowNumber = csvRowNumber;
       this.serviceId = serviceId;
     }
+
+    public int getCsvRowNumber() {
+      return csvRowNumber;
+    }
   }
 }

main/src/test/java/org/mobilitydata/gtfsvalidator/validator/ExpiredCalendarValidatorTest.java

@@ -316,6 +316,12 @@ public void calendarDateWithAllCalendarDatesExpiredShouldGenerateNotice() {
                     .setDate(GtfsDate.fromLocalDate(TEST_NOW.minusDays(3)))
                     .setExceptionType(GtfsCalendarDateExceptionType.SERVICE_ADDED)
                     .build(),
+                new GtfsCalendarDate.Builder()
+                    .setCsvRowNumber(4)
+                    .setServiceId("SERVICE_ID_4")
+                    .setDate(GtfsDate.fromLocalDate(TEST_NOW.minusDays(7)))
+                    .setExceptionType(GtfsCalendarDateExceptionType.SERVICE_ADDED)
+                    .build(),
                 new GtfsCalendarDate.Builder()
                     .setCsvRowNumber(1)
                     .setServiceId("SERVICE_ID_1")
@@ -326,9 +332,12 @@ public void calendarDateWithAllCalendarDatesExpiredShouldGenerateNotice() {
     new ExpiredCalendarValidator(new DateForValidation(TEST_NOW), calendarTable, calendarDateTable)
         .validate(container);
     assertThat(container.getValidationNotices())
+        // We verify that entries are sorted by row number.
         .containsExactly(
-            new ExpiredCalendarValidator.ExpiredCalendarNotice(3, "SERVICE_ID_3"),
+            new ExpiredCalendarValidator.ExpiredCalendarNotice(1, "SERVICE_ID_1"),
             new ExpiredCalendarValidator.ExpiredCalendarNotice(2, "SERVICE_ID_2"),
-            new ExpiredCalendarValidator.ExpiredCalendarNotice(1, "SERVICE_ID_1"));
+            new ExpiredCalendarValidator.ExpiredCalendarNotice(3, "SERVICE_ID_3"),
+            new ExpiredCalendarValidator.ExpiredCalendarNotice(4, "SERVICE_ID_4"))
+        .inOrder();
   }
 }