feat: 1820 flex missing stop times record (#1945)

* added StopTimesRecordValidator and StopTimesRecordValidatorTest
MobilityData · Jan 28, 2025 · 7c671d8 · 7c671d8
1 parent 9badbe8
commit 7c671d8
Show file tree

Hide file tree

Showing 2 changed files with 177 additions and 0 deletions.
diff --git a/main/src/main/java/org/mobilitydata/gtfsvalidator/validator/StopTimesRecordValidator.java b/main/src/main/java/org/mobilitydata/gtfsvalidator/validator/StopTimesRecordValidator.java
@@ -0,0 +1,93 @@
+package org.mobilitydata.gtfsvalidator.validator;
+
+import static org.mobilitydata.gtfsvalidator.notice.SeverityLevel.ERROR;
+
+import javax.inject.Inject;
+import org.mobilitydata.gtfsvalidator.annotation.GtfsValidationNotice;
+import org.mobilitydata.gtfsvalidator.annotation.GtfsValidator;
+import org.mobilitydata.gtfsvalidator.notice.NoticeContainer;
+import org.mobilitydata.gtfsvalidator.notice.ValidationNotice;
+import org.mobilitydata.gtfsvalidator.table.GtfsPickupDropOff;
+import org.mobilitydata.gtfsvalidator.table.GtfsStopTime;
+import org.mobilitydata.gtfsvalidator.table.GtfsStopTimeTableContainer;
+
+/**
+ * Validates `stop_times.start_pickup_dropoff_window`, `stop_times.end_pickup_dropoff_window`,
+ * `stop_times.pickup_type`, and `stop_times.drop_off_type` for a single `GtfsStopTime`.
+ *
+ * <p>Generated notices:
+ *
+ * <ul>
+ *   <li>{@link MissingStopTimesRecordNotice}
+ * </ul>
+ */
+@GtfsValidator
+public class StopTimesRecordValidator extends FileValidator {
+  private final GtfsStopTimeTableContainer stopTimeTable;
+
+  @Inject
+  public StopTimesRecordValidator(GtfsStopTimeTableContainer stopTimeTable) {
+    this.stopTimeTable = stopTimeTable;
+  }
+
+  @Override
+  public void validate(NoticeContainer noticeContainer) {
+    for (GtfsStopTime entity : stopTimeTable.getEntities()) {
+      if (entity.hasStartPickupDropOffWindow()
+          && entity.hasEndPickupDropOffWindow()
+          && entity.pickupType() == GtfsPickupDropOff.MUST_PHONE
+          && entity.dropOffType() == GtfsPickupDropOff.MUST_PHONE) {
+        int tripStopCount = stopTimeTable.byTripId(entity.tripId()).size();
+        if (tripStopCount == 1) {
+          noticeContainer.addValidationNotice(
+              new MissingStopTimesRecordNotice(
+                  entity.csvRowNumber(),
+                  entity.tripId(),
+                  entity.locationGroupId(),
+                  entity.locationId()));
+        }
+      }
+    }
+  }
+
+  @Override
+  public boolean shouldCallValidate() {
+    if (stopTimeTable != null) {
+      return stopTimeTable.hasColumn(GtfsStopTime.START_PICKUP_DROP_OFF_WINDOW_FIELD_NAME)
+          && stopTimeTable.hasColumn(GtfsStopTime.END_PICKUP_DROP_OFF_WINDOW_FIELD_NAME)
+          && stopTimeTable.hasColumn(GtfsStopTime.PICKUP_TYPE_FIELD_NAME)
+          && stopTimeTable.hasColumn(GtfsStopTime.DROP_OFF_TYPE_FIELD_NAME);
+    } else {
+      return false;
+    }
+  }
+
+  /**
+   * Only one stop_times record is found where two are required.
+   *
+   * <p>Travel within the same location group or GeoJSON location requires two records in
+   * stop_times.txt with the same location_group_id or location_id.
+   */
+  @GtfsValidationNotice(severity = ERROR)
+  public static class MissingStopTimesRecordNotice extends ValidationNotice {
+    /** The row of the faulty record. */
+    private final long csvRowNumber;
+
+    /** The `tripId` of the faulty record. */
+    private final String tripId;
+
+    /** The `locationGroupId` of the faulty record. */
+    private final String locationGroupId;
+
+    /** The `locationId` of the faulty record. */
+    private final String locationId;
+
+    public MissingStopTimesRecordNotice(
+        long csvRowNumber, String tripId, String locationGroupId, String locationId) {
+      this.csvRowNumber = csvRowNumber;
+      this.tripId = tripId;
+      this.locationGroupId = locationGroupId;
+      this.locationId = locationId;
+    }
+  }
+}
diff --git a/.../src/test/java/org/mobilitydata/gtfsvalidator/validator/StopTimesRecordValidatorTest.java b/.../src/test/java/org/mobilitydata/gtfsvalidator/validator/StopTimesRecordValidatorTest.java
@@ -0,0 +1,84 @@
+package org.mobilitydata.gtfsvalidator.validator;
+
+import static com.google.common.truth.Truth.assertThat;
+
+import com.google.common.collect.ImmutableList;
+import java.util.List;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.junit.runners.JUnit4;
+import org.mobilitydata.gtfsvalidator.notice.NoticeContainer;
+import org.mobilitydata.gtfsvalidator.notice.ValidationNotice;
+import org.mobilitydata.gtfsvalidator.table.GtfsPickupDropOff;
+import org.mobilitydata.gtfsvalidator.table.GtfsStopTime;
+import org.mobilitydata.gtfsvalidator.table.GtfsStopTimeTableContainer;
+import org.mobilitydata.gtfsvalidator.type.GtfsTime;
+
+@RunWith(JUnit4.class)
+public class StopTimesRecordValidatorTest {
+
+  public static GtfsStopTime createStopTime(
+      int csvRowNumber,
+      String tripId,
+      String locationGroupId,
+      String locationId,
+      GtfsPickupDropOff pickupType,
+      GtfsPickupDropOff dropOffType,
+      GtfsTime startWindow,
+      GtfsTime endWindow) {
+    return new GtfsStopTime.Builder()
+        .setCsvRowNumber(csvRowNumber)
+        .setTripId(tripId)
+        .setLocationGroupId(locationGroupId)
+        .setLocationId(locationId)
+        .setPickupType(pickupType)
+        .setDropOffType(dropOffType)
+        .setStartPickupDropOffWindow(startWindow)
+        .setEndPickupDropOffWindow(endWindow)
+        .build();
+  }
+
+  private static List<ValidationNotice> generateNotices(List<GtfsStopTime> stopTimes) {
+    NoticeContainer noticeContainer = new NoticeContainer();
+    GtfsStopTimeTableContainer stopTimeTable =
+        GtfsStopTimeTableContainer.forEntities(stopTimes, noticeContainer);
+    new StopTimesRecordValidator(stopTimeTable).validate(noticeContainer);
+    return noticeContainer.getValidationNotices();
+  }
+
+  @Test
+  public void containsStopTimesRecordShouldNotGenerateNotice1() {
+    assertThat(
+            generateNotices(
+                ImmutableList.of(
+                    createStopTime(
+                        1,
+                        "trip1",
+                        "locationGroupId1",
+                        "locationId1",
+                        GtfsPickupDropOff.ALLOWED,
+                        GtfsPickupDropOff.ALLOWED,
+                        GtfsTime.fromString("08:00:00"),
+                        GtfsTime.fromString("09:00:00")))))
+        .isEmpty();
+  }
+
+  @Test
+  public void missingStopTimesRecordShouldGenerateNotice() {
+    assertThat(
+            generateNotices(
+                ImmutableList.of(
+                    createStopTime(
+                        1,
+                        "trip2",
+                        "locationGroupId1",
+                        "locationId1",
+                        GtfsPickupDropOff.MUST_PHONE,
+                        GtfsPickupDropOff.MUST_PHONE,
+                        GtfsTime.fromString("08:00:00"),
+                        GtfsTime.fromString("09:00:00")))))
+        .containsExactly(
+            new StopTimesRecordValidator.MissingStopTimesRecordNotice(
+                1, "trip2", "locationGroupId1", "locationId1"));
+  }
+}