Add support for importing CO₂ emissions per trip leg

application/src/ext-test/java/org/opentripplanner/ext/emissions/EmissionsTest.java → application/src/ext-test/java/org/opentripplanner/ext/emission/EmissionTest.java

@@ -1,4 +1,4 @@
-package org.opentripplanner.ext.emissions;
+package org.opentripplanner.ext.emission;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertNull;
@@ -13,12 +13,12 @@
 import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.Test;
 import org.opentripplanner._support.time.ZoneIds;
-import org.opentripplanner.ext.emissions.internal.DefaultEmissionsRepository;
-import org.opentripplanner.ext.emissions.internal.DefaultEmissionsService;
-import org.opentripplanner.ext.emissions.itinerary.DecorateWithEmission;
+import org.opentripplanner.ext.emission.internal.DefaultEmissionRepository;
+import org.opentripplanner.ext.emission.internal.DefaultEmissionService;
+import org.opentripplanner.ext.emission.internal.itinerary.EmissionItineraryDecorator;
 import org.opentripplanner.framework.model.Cost;
-import org.opentripplanner.framework.model.Gram;
 import org.opentripplanner.model.StopTime;
+import org.opentripplanner.model.plan.Emission;
 import org.opentripplanner.model.plan.Itinerary;
 import org.opentripplanner.model.plan.Leg;
 import org.opentripplanner.model.plan.LegConstructionSupport;
@@ -34,10 +34,18 @@
 import org.opentripplanner.transit.model.timetable.Trip;
 import org.opentripplanner.transit.model.timetable.TripTimesFactory;
 
-class EmissionsTest {
+/**
+ * @deprecated The purpose of this test is not clear?
+ * - Is it an integration test, it does notload data from file.
+ * - Or, is it a unit-test on the {@link EmissionItineraryDecorator}? The test package/name does not
+ *   reflect this and there is realy no need to create a
+ *
+ */
+@Deprecated
+class EmissionTest {
 
-  private static DefaultEmissionsService eService;
-  private static DecorateWithEmission decorateWithEmission;
+  private static DefaultEmissionService eService;
+  private static EmissionItineraryDecorator emissionDecorator;
 
   static final ZonedDateTime TIME = OffsetDateTime.parse(
     "2023-07-20T17:49:06+03:00"
@@ -53,7 +61,7 @@ class EmissionsTest {
   private static final Route ROUTE_WITH_EMISSIONS = TimetableRepositoryForTest.route(
     id("1")
   ).build();
-  private static final Route ROUTE_WITH_ZERO_EMISSIONS = TimetableRepositoryForTest.route(
+  private static final Route ROUTE_WITH_UNKNOWN_EMISSIONS = TimetableRepositoryForTest.route(
     id("2")
   ).build();
   private static final Route ROUTE_WITHOUT_EMISSIONS_CONFIGURED = TimetableRepositoryForTest.route(
@@ -62,57 +70,59 @@ class EmissionsTest {
 
   @BeforeAll
   static void SetUp() {
-    Map<FeedScopedId, Double> emissions = new HashMap<>();
-    emissions.put(new FeedScopedId("F", "1"), (0.12 / 12));
-    emissions.put(new FeedScopedId("F", "2"), 0.0);
-    EmissionsRepository emissionsRepository = new DefaultEmissionsRepository();
-    emissionsRepository.setCo2Emissions(emissions);
-    emissionsRepository.setCarAvgCo2PerMeter(0.131);
-    eService = new DefaultEmissionsService(emissionsRepository);
-    decorateWithEmission = new DecorateWithEmission(eService);
+    Map<FeedScopedId, Emission> emission = new HashMap<>();
+    emission.put(id("1"), Emission.co2_g(.12 / 12));
+    emission.put(id("2"), Emission.co2_g(0.0));
+    EmissionRepository emissionRepository = new DefaultEmissionRepository();
+    emissionRepository.addRouteEmissions(emission);
+    emissionRepository.setCarAvgCo2PerMeter(0.131);
+    eService = new DefaultEmissionService(emissionRepository);
+    emissionDecorator = new EmissionItineraryDecorator(eService);
   }
 
   @Test
   void testGetEmissionsForItinerary() {
-    var i = createItinerary(createTransitLeg(ROUTE_WITH_EMISSIONS));
-    i = decorateWithEmission.decorate(i);
-    assertEquals(new Gram(2223.902), i.emissionsPerPerson().getCo2());
+    var itinerary = createItinerary(createTransitLeg(ROUTE_WITH_EMISSIONS));
+    itinerary = emissionDecorator.decorate(itinerary);
+    assertEquals(Emission.co2_g(2223.902), itinerary.emissionPerPerson());
   }
 
   @Test
   void testGetEmissionsForCarRoute() {
-    var i = createItinerary(STREET_LEG);
-    i = decorateWithEmission.decorate(i);
-    assertEquals(new Gram(28.0864), i.emissionsPerPerson().getCo2());
+    var itinerary = createItinerary(STREET_LEG);
+    itinerary = emissionDecorator.decorate(itinerary);
+    assertEquals(Emission.co2_g(28.0864), itinerary.emissionPerPerson());
   }
 
   @Test
   void testNoEmissionsForFeedWithoutEmissionsConfigured() {
-    var i = createItinerary(createTransitLeg(ROUTE_WITHOUT_EMISSIONS_CONFIGURED));
-    i = decorateWithEmission.decorate(i);
-    assertNull(i.emissionsPerPerson());
+    var itinerary = createItinerary(createTransitLeg(ROUTE_WITHOUT_EMISSIONS_CONFIGURED));
+    itinerary = emissionDecorator.decorate(itinerary);
+    assertNull(itinerary.emissionPerPerson());
   }
 
   @Test
   void testZeroEmissionsForItineraryWithZeroEmissions() {
-    var i = createItinerary(createTransitLeg(ROUTE_WITH_ZERO_EMISSIONS));
-    i = decorateWithEmission.decorate(i);
-    assertEquals(new Gram(0.0), i.emissionsPerPerson().getCo2());
+    var itinerary = createItinerary(createTransitLeg(ROUTE_WITH_UNKNOWN_EMISSIONS));
+    itinerary = emissionDecorator.decorate(itinerary);
+    assertNull(itinerary.emissionPerPerson());
   }
 
   @Test
   void testGetEmissionsForCombinedRoute() {
-    var i = createItinerary(createTransitLeg(ROUTE_WITH_EMISSIONS), STREET_LEG);
-    i = decorateWithEmission.decorate(i);
-    assertEquals(new Gram(2251.9884), i.emissionsPerPerson().getCo2());
+    var itinerary = createItinerary(createTransitLeg(ROUTE_WITH_EMISSIONS), STREET_LEG);
+    itinerary = emissionDecorator.decorate(itinerary);
+    assertEquals(Emission.co2_g(2251.9884), itinerary.emissionPerPerson());
   }
 
   @Test
   void testNoEmissionsForCombinedRouteWithoutTransitEmissions() {
-    var i = createItinerary(createTransitLeg(ROUTE_WITHOUT_EMISSIONS_CONFIGURED), STREET_LEG);
-    i = decorateWithEmission.decorate(i);
-    var emissionsResult = i.emissionsPerPerson() != null ? i.emissionsPerPerson().getCo2() : null;
-    assertNull(emissionsResult);
+    var itinerary = createItinerary(
+      createTransitLeg(ROUTE_WITHOUT_EMISSIONS_CONFIGURED),
+      STREET_LEG
+    );
+    itinerary = emissionDecorator.decorate(itinerary);
+    assertNull(itinerary.emissionPerPerson());
   }
 
   private ScheduledTransitLeg createTransitLeg(Route route) {
@@ -127,10 +137,7 @@ private ScheduledTransitLeg createTransitLeg(Route route) {
     var pattern = TimetableRepositoryForTest.tripPattern("1", route)
       .withStopPattern(stopPattern)
       .build();
-    var trip = Trip.of(FeedScopedId.parse("FOO:BAR"))
-      .withMode(TransitMode.BUS)
-      .withRoute(route)
-      .build();
+    var trip = Trip.of(id("FOO:BAR")).withMode(TransitMode.BUS).withRoute(route).build();
     return new ScheduledTransitLegBuilder<>()
       .withTripTimes(TripTimesFactory.tripTimes(trip, stopTimes, new Deduplicator()))
       .withTripPattern(pattern)

application/src/ext-test/java/org/opentripplanner/ext/emission/EmissionTestData.java

@@ -0,0 +1,52 @@
+package org.opentripplanner.ext.emission;
+
+import java.io.File;
+import org.opentripplanner.datastore.api.CompositeDataSource;
+import org.opentripplanner.datastore.api.DataSource;
+import org.opentripplanner.datastore.api.FileType;
+import org.opentripplanner.datastore.file.FileDataSource;
+import org.opentripplanner.ext.emission.internal.csvdata.EmissionDataReader;
+import org.opentripplanner.test.support.ResourceLoader;
+import org.opentripplanner.transit.model.framework.FeedScopedId;
+
+public interface EmissionTestData {
+  String FEED_FEED_ID = "em";
+  String GTFS_DIR_FEED_ID = "gd";
+  String GTFS_ZIP_FEED_ID = "gz";
+
+  FeedScopedId ROUTE_ID_EM_R1 = new FeedScopedId(FEED_FEED_ID, "R1");
+  FeedScopedId ROUTE_ID_GD_1001 = new FeedScopedId(GTFS_DIR_FEED_ID, "1001");
+  FeedScopedId ROUTE_ID_GZ_1002 = new FeedScopedId(GTFS_ZIP_FEED_ID, "1002");
+
+  default CompositeDataSource gtfsWithEmissionZip() {
+    return resource().catalogDataSource("gz-gtfs.zip", FileType.GTFS);
+  }
+
+  default CompositeDataSource gtfsWithEmissionDir() {
+    return resource().catalogDataSource("gd-gtfs/", FileType.GTFS);
+  }
+
+  default DataSource gtfsWithEmissionFile() {
+    return gtfsWithEmissionDir().entry(EmissionDataReader.EMISSION_FILE_NAME);
+  }
+
+  default DataSource emissionOnRoutes() {
+    return resource().dataSource("em-on-routes.txt", FileType.EMMISION);
+  }
+
+  default DataSource emissionOnTripLegs() {
+    return resource().dataSource("em-on-trip-legs.txt", FileType.EMMISION);
+  }
+
+  /**
+   * The DataSource framwork should prevent this from happening, but we add it here
+   * as a test-case so we can see that the parsers handle it gracefully.
+   */
+  default DataSource emissionMissingFile() {
+    return new FileDataSource(new File("file-does-not-exist.txt"), FileType.EMMISION);
+  }
+
+  private ResourceLoader resource() {
+    return ResourceLoader.of(EmissionTestData.class);
+  }
+}

application/src/test/java/org/opentripplanner/generate/doc/EmissionsConfigurationDocTest.java → application/src/ext-test/java/org/opentripplanner/ext/emission/doc/EmissionConfigurationDocTest.java

@@ -1,38 +1,36 @@
-package org.opentripplanner.generate.doc;
+package org.opentripplanner.ext.emission.doc;
 
+import static org.opentripplanner.framework.application.OtpFileNames.BUILD_CONFIG_FILENAME;
 import static org.opentripplanner.framework.io.FileUtils.assertFileEquals;
 import static org.opentripplanner.framework.io.FileUtils.readFile;
 import static org.opentripplanner.framework.io.FileUtils.writeFile;
-import static org.opentripplanner.generate.doc.framework.DocsTestConstants.TEMPLATE_PATH;
-import static org.opentripplanner.generate.doc.framework.DocsTestConstants.USER_DOC_PATH;
 import static org.opentripplanner.generate.doc.framework.TemplateUtil.replaceSection;
-import static org.opentripplanner.standalone.config.framework.json.JsonSupport.jsonNodeFromResource;
 import static org.opentripplanner.utils.text.MarkdownFormatter.HEADER_4;
 
 import java.io.File;
 import org.junit.jupiter.api.Test;
-import org.opentripplanner.framework.application.OtpFileNames;
 import org.opentripplanner.generate.doc.framework.DocBuilder;
+import org.opentripplanner.generate.doc.framework.DocsTestConstants;
 import org.opentripplanner.generate.doc.framework.GeneratesDocumentation;
 import org.opentripplanner.generate.doc.framework.ParameterDetailsList;
 import org.opentripplanner.generate.doc.framework.ParameterSummaryTable;
 import org.opentripplanner.generate.doc.framework.SkipNodes;
 import org.opentripplanner.generate.doc.framework.TemplateUtil;
 import org.opentripplanner.standalone.config.BuildConfig;
+import org.opentripplanner.standalone.config.framework.json.JsonSupport;
 import org.opentripplanner.standalone.config.framework.json.NodeAdapter;
+import org.opentripplanner.test.support.ResourceLoader;
 
 @GeneratesDocumentation
-public class EmissionsConfigurationDocTest {
+public class EmissionConfigurationDocTest implements DocsTestConstants {
 
-  private static final File TEMPLATE = new File(TEMPLATE_PATH, "Emissions.md");
-  private static final File OUT_FILE = new File(USER_DOC_PATH + "/sandbox", "Emissions.md");
-  private static final String CONFIG_JSON = OtpFileNames.BUILD_CONFIG_FILENAME;
-  private static final String CONFIG_PATH = "standalone/config/" + CONFIG_JSON;
+  private static final File TEMPLATE = new File(TEMPLATE_PATH, "Emission.md");
+  private static final File OUT_FILE = new File(SANDBOX_USER_DOC_PATH, "Emission.md");
   private static final SkipNodes SKIP_NODES = SkipNodes.of().build();
 
   @Test
-  public void updateEmissionsDoc() {
-    NodeAdapter node = readEmissionsConfig();
+  public void updateMapEmissionsConfigDoc() {
+    NodeAdapter node = readMapEmissionsConfigConfig();
 
     String template = readFile(TEMPLATE);
     String original = readFile(OUT_FILE);
@@ -43,10 +41,14 @@ public void updateEmissionsDoc() {
     assertFileEquals(original, OUT_FILE);
   }
 
-  private NodeAdapter readEmissionsConfig() {
-    var json = jsonNodeFromResource(CONFIG_PATH);
-    var conf = new BuildConfig(json, CONFIG_PATH, false);
-    return conf.asNodeAdapter().child("emissions");
+  private NodeAdapter readMapEmissionsConfigConfig() {
+    var buildConfigFile = ResourceLoader.of(EmissionConfigurationDocTest.class).extTestResourceFile(
+      BUILD_CONFIG_FILENAME
+    );
+
+    var json = JsonSupport.jsonNodeFromPath(buildConfigFile.toPath());
+    var conf = new BuildConfig(json, buildConfigFile.toString(), false);
+    return conf.asNodeAdapter().child("emission");
   }
 
   private String updaterDoc(NodeAdapter node) {
@@ -70,7 +72,7 @@ private void addDetailsSection(DocBuilder buf, NodeAdapter node) {
   }
 
   private void addExample(DocBuilder buf, NodeAdapter node) {
-    var root = TemplateUtil.jsonExampleBuilder(node.rawNode()).wrapInObject("emissions").build();
+    var root = TemplateUtil.jsonExampleBuilder(node.rawNode()).wrapInObject("emission").build();
     buf.header(3, "Example configuration", null).addExample("build-config.json", root);
   }
 }