Moved RoutingService interface back into domain layer, and moved ExternalRoutingService to infrastructure.

dddsample/src/main/java/se/citerus/dddsample/application/impl/BookingServiceImpl.java

@@ -5,11 +5,11 @@ import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 import org.springframework.transaction.annotation.Transactional;
 import se.citerus.dddsample.application.BookingService;
-import se.citerus.dddsample.application.RoutingService;
 import se.citerus.dddsample.domain.model.cargo.*;
 import se.citerus.dddsample.domain.model.location.Location;
 import se.citerus.dddsample.domain.model.location.LocationRepository;
 import se.citerus.dddsample.domain.model.location.UnLocode;
+import se.citerus.dddsample.domain.service.RoutingService;
 
 import java.util.Date;
 import java.util.List;

dddsample/src/main/java/se/citerus/dddsample/domain/service/RoutingService.java

@@ -0,0 +1,20 @@
+package se.citerus.dddsample.domain.service;
+
+import se.citerus.dddsample.domain.model.cargo.Itinerary;
+import se.citerus.dddsample.domain.model.cargo.RouteSpecification;
+
+import java.util.List;
+
+/**
+ * Routing service.
+ *
+ */
+public interface RoutingService {
+
+  /**
+   * @param routeSpecification route specification
+   * @return A list of itineraries that satisfy the specification. May be an empty list if no route is found.
+   */
+  List<Itinerary> fetchRoutesForSpecification(RouteSpecification routeSpecification);
+
+}

dddsample/src/main/java/se/citerus/dddsample/infrastructure/routing/ExternalRoutingService.java

@@ -0,0 +1,84 @@
+package se.citerus.dddsample.infrastructure.routing;
+
+import org.springframework.transaction.annotation.Transactional;
+import se.citerus.dddsample.domain.model.cargo.Itinerary;
+import se.citerus.dddsample.domain.model.cargo.Leg;
+import se.citerus.dddsample.domain.model.cargo.RouteSpecification;
+import se.citerus.dddsample.domain.model.carrier.VoyageNumber;
+import se.citerus.dddsample.domain.model.carrier.VoyageRepository;
+import se.citerus.dddsample.domain.model.location.Location;
+import se.citerus.dddsample.domain.model.location.LocationRepository;
+import se.citerus.dddsample.domain.model.location.UnLocode;
+import se.citerus.dddsample.domain.service.RoutingService;
+import se.citerus.routingteam.GraphTraversalService;
+import se.citerus.routingteam.TransitEdge;
+import se.citerus.routingteam.TransitPath;
+
+import java.util.ArrayList;
+import java.util.Date;
+import java.util.List;
+
+/**
+ * Our end of the routing service. This is basically a data model
+ * translation layer between our domain model and the API put forward
+ * by the routing team, which operates in a different context from us.
+ *
+ */
+public class ExternalRoutingService implements RoutingService {
+
+  private GraphTraversalService graphTraversalService;
+  private LocationRepository locationRepository;
+  private VoyageRepository voyageRepository;
+
+  @Transactional(readOnly = true)
+  public List<Itinerary> fetchRoutesForSpecification(RouteSpecification routeSpecification) {
+    final Location origin = routeSpecification.origin();
+    final Location destination = routeSpecification.destination();
+
+    final List<TransitPath> transitPaths = graphTraversalService.findShortestPath(
+      origin.unLocode().idString(),
+      destination.unLocode().idString()
+    );
+    
+    final List<Itinerary> itineraries = new ArrayList<Itinerary>();
+
+    for (TransitPath transitPath : transitPaths) {
+      final Itinerary itinerary = toItinerary(transitPath);
+      // Use the specification to safe-guard against invalid itineraries
+      if (routeSpecification.isSatisfiedBy(itinerary)) {
+        itineraries.add(itinerary);
+      }
+    }
+
+    return itineraries;
+  }
+
+  private Itinerary toItinerary(TransitPath transitPath) {
+    List<Leg> legs = new ArrayList(transitPath.getTransitEdges().size());
+    for (TransitEdge edge : transitPath.getTransitEdges()) {
+      legs.add(toLeg(edge));
+    }
+    return new Itinerary(legs);
+  }
+
+  private Leg toLeg(TransitEdge edge) {
+    return new Leg(
+      voyageRepository.find(new VoyageNumber(edge.getCarrierMovementId())),
+      locationRepository.find(new UnLocode(edge.getFromUnLocode())),
+      locationRepository.find(new UnLocode(edge.getToUnLocode())),
+      new Date(), new Date()  // TODO better dates
+    );
+  }
+
+  public void setGraphTraversalService(GraphTraversalService graphTraversalService) {
+    this.graphTraversalService = graphTraversalService;
+  }
+
+  public void setLocationRepository(LocationRepository locationRepository) {
+    this.locationRepository = locationRepository;
+  }
+
+  public void setVoyageRepository(VoyageRepository voyageRepository) {
+    this.voyageRepository = voyageRepository;
+  }
+}

dddsample/src/main/resources/context-service.xml

@@ -32,7 +32,7 @@
 
   <tx:annotation-driven transaction-manager="transactionManager"/>
 
-  <bean id="routingService" class="se.citerus.dddsample.application.impl.RoutingServiceImpl">
+  <bean id="routingService" class="se.citerus.dddsample.infrastructure.routing.ExternalRoutingService">
     <property name="locationRepository" ref="locationRepository"/>
     <property name="voyageRepository" ref="voyageRepository"/>
     <property name="graphTraversalService" ref="graphTraversalService"/>

dddsample/src/test/java/se/citerus/dddsample/application/BookingServiceTest.java

@@ -10,6 +10,7 @@ import se.citerus.dddsample.domain.model.location.LocationRepository;
 import static se.citerus.dddsample.domain.model.location.SampleLocations.CHICAGO;
 import static se.citerus.dddsample.domain.model.location.SampleLocations.STOCKHOLM;
 import se.citerus.dddsample.domain.model.location.UnLocode;
+import se.citerus.dddsample.domain.service.RoutingService;
 
 public class BookingServiceTest extends TestCase {
 

dddsample/src/test/java/se/citerus/dddsample/application/RoutingServiceTest.java

@@ -2,7 +2,6 @@ package se.citerus.dddsample.application;
 
 import junit.framework.TestCase;
 import static org.easymock.EasyMock.*;
-import se.citerus.dddsample.application.impl.RoutingServiceImpl;
 import se.citerus.dddsample.domain.model.cargo.*;
 import se.citerus.dddsample.domain.model.carrier.SampleVoyages;
 import se.citerus.dddsample.domain.model.carrier.VoyageNumber;
@@ -11,6 +10,7 @@ import se.citerus.dddsample.domain.model.location.Location;
 import se.citerus.dddsample.domain.model.location.LocationRepository;
 import static se.citerus.dddsample.domain.model.location.SampleLocations.*;
 import se.citerus.dddsample.infrastructure.persistence.inmemory.LocationRepositoryInMem;
+import se.citerus.dddsample.infrastructure.routing.ExternalRoutingService;
 import se.citerus.routingteam.GraphTraversalService;
 import se.citerus.routingteam.internal.GraphDAO;
 import se.citerus.routingteam.internal.GraphTraversalServiceImpl;
@@ -22,16 +22,16 @@ import java.util.List;
 
 public class RoutingServiceTest extends TestCase {
 
-  private RoutingServiceImpl routingServiceImpl;
+  private ExternalRoutingService externalRoutingService;
   private VoyageRepository voyageRepository;
 
   protected void setUp() throws Exception {
-    routingServiceImpl = new RoutingServiceImpl();
+    externalRoutingService = new ExternalRoutingService();
     LocationRepository locationRepository = new LocationRepositoryInMem();
-    routingServiceImpl.setLocationRepository(locationRepository);
+    externalRoutingService.setLocationRepository(locationRepository);
 
     voyageRepository = createMock(VoyageRepository.class);
-    routingServiceImpl.setVoyageRepository(voyageRepository);
+    externalRoutingService.setVoyageRepository(voyageRepository);
 
     GraphTraversalService graphTraversalService = new GraphTraversalServiceImpl(new GraphDAO(createMock(DataSource.class)) {
       public List<String> listLocations() {
@@ -41,7 +41,7 @@ public class RoutingServiceTest extends TestCase {
       public void storeCarrierMovementId(String cmId, String from, String to) {
       }
     });
-    routingServiceImpl.setGraphTraversalService(graphTraversalService);
+    externalRoutingService.setGraphTraversalService(graphTraversalService);
   }
 
   public void testCalculatePossibleRoutes() {
@@ -53,7 +53,7 @@ public class RoutingServiceTest extends TestCase {
     
     replay(voyageRepository);
 
-    List<Itinerary> candidates = routingServiceImpl.fetchRoutesForSpecification(routeSpecification);
+    List<Itinerary> candidates = externalRoutingService.fetchRoutesForSpecification(routeSpecification);
     assertNotNull(candidates);
     
     for (Itinerary itinerary : candidates) {

dddsample/src/test/java/se/citerus/dddsample/infrastructure/routing/ExternalRoutingServiceTest.java

@@ -0,0 +1,79 @@
+package se.citerus.dddsample.infrastructure.routing;
+
+import junit.framework.TestCase;
+import static org.easymock.EasyMock.*;
+import se.citerus.dddsample.domain.model.cargo.*;
+import se.citerus.dddsample.domain.model.carrier.SampleVoyages;
+import se.citerus.dddsample.domain.model.carrier.VoyageNumber;
+import se.citerus.dddsample.domain.model.carrier.VoyageRepository;
+import se.citerus.dddsample.domain.model.location.Location;
+import se.citerus.dddsample.domain.model.location.LocationRepository;
+import static se.citerus.dddsample.domain.model.location.SampleLocations.*;
+import se.citerus.dddsample.infrastructure.persistence.inmemory.LocationRepositoryInMem;
+import se.citerus.routingteam.GraphTraversalService;
+import se.citerus.routingteam.internal.GraphDAO;
+import se.citerus.routingteam.internal.GraphTraversalServiceImpl;
+
+import javax.sql.DataSource;
+import java.util.Arrays;
+import java.util.Date;
+import java.util.List;
+
+public class ExternalRoutingServiceTest extends TestCase {
+
+  private ExternalRoutingService externalRoutingService;
+  private VoyageRepository voyageRepository;
+
+  protected void setUp() throws Exception {
+    externalRoutingService = new ExternalRoutingService();
+    LocationRepository locationRepository = new LocationRepositoryInMem();
+    externalRoutingService.setLocationRepository(locationRepository);
+
+    voyageRepository = createMock(VoyageRepository.class);
+    externalRoutingService.setVoyageRepository(voyageRepository);
+
+    GraphTraversalService graphTraversalService = new GraphTraversalServiceImpl(new GraphDAO(createMock(DataSource.class)) {
+      public List<String> listLocations() {
+        return Arrays.asList(TOKYO.unLocode().idString(), STOCKHOLM.unLocode().idString(), GOTHENBURG.unLocode().idString());
+      }
+
+      public void storeCarrierMovementId(String cmId, String from, String to) {
+      }
+    });
+    externalRoutingService.setGraphTraversalService(graphTraversalService);
+  }
+
+  public void testCalculatePossibleRoutes() {
+    TrackingId trackingId = new TrackingId("ABC");
+    Cargo cargo = new Cargo(trackingId, HONGKONG, HELSINKI);
+    RouteSpecification routeSpecification = new RouteSpecification(cargo.origin(), cargo.destination(), new Date());
+
+    expect(voyageRepository.find(isA(VoyageNumber.class))).andStubReturn(SampleVoyages.CM002);
+    
+    replay(voyageRepository);
+
+    List<Itinerary> candidates = externalRoutingService.fetchRoutesForSpecification(routeSpecification);
+    assertNotNull(candidates);
+    
+    for (Itinerary itinerary : candidates) {
+      List<Leg> legs = itinerary.legs();
+      assertNotNull(legs);
+      assertFalse(legs.isEmpty());
+
+      // Cargo origin and start of first leg should match
+      assertEquals(cargo.origin(), legs.get(0).loadLocation());
+
+      // Cargo final destination and last leg stop should match
+      Location lastLegStop = legs.get(legs.size() - 1).unloadLocation();
+      assertEquals(cargo.destination(), lastLegStop);
+
+      for (int i = 0; i < legs.size() - 1; i++) {
+        // Assert that all legs are connected
+        assertEquals(legs.get(i).unloadLocation(), legs.get(i + 1).loadLocation());
+      }
+    }
+
+    verify(voyageRepository);
+  }
+
+}

dddsample/src/test/java/se/citerus/dddsample/scenario/CargoHandlingScenarioTest.java

@@ -1,7 +1,10 @@
 package se.citerus.dddsample.scenario;
 
 import junit.framework.TestCase;
-import se.citerus.dddsample.application.*;
+import se.citerus.dddsample.application.HandlingEventRegistrationAttempt;
+import se.citerus.dddsample.application.HandlingEventService;
+import se.citerus.dddsample.application.SystemEvents;
+import se.citerus.dddsample.application.TrackingService;
 import se.citerus.dddsample.application.impl.HandlingEventServiceImpl;
 import se.citerus.dddsample.application.impl.TrackingServiceImpl;
 import se.citerus.dddsample.domain.model.cargo.*;
@@ -15,6 +18,7 @@ import se.citerus.dddsample.domain.model.handling.HandlingEventRepository;
 import se.citerus.dddsample.domain.model.location.Location;
 import se.citerus.dddsample.domain.model.location.LocationRepository;
 import static se.citerus.dddsample.domain.model.location.SampleLocations.*;
+import se.citerus.dddsample.domain.service.RoutingService;
 import se.citerus.dddsample.infrastructure.persistence.inmemory.LocationRepositoryInMem;
 import se.citerus.dddsample.infrastructure.persistence.inmemory.VoyageRepositoryInMem;