Implemented a very efficient, randomized, routing service.

dddsample/src/main/java/se/citerus/dddsample/repository/LocationRepository.java

@@ -3,8 +3,12 @@ package se.citerus.dddsample.repository;
 import se.citerus.dddsample.domain.Location;
 import se.citerus.dddsample.domain.UnLocode;
 
+import java.util.List;
+
 public interface LocationRepository {
 
   Location find(UnLocode unLocode);
 
+  List<Location> findAll();
+
 }

dddsample/src/main/java/se/citerus/dddsample/repository/LocationRepositoryHibernate.java

@@ -3,6 +3,8 @@ package se.citerus.dddsample.repository;
 import se.citerus.dddsample.domain.Location;
 import se.citerus.dddsample.domain.UnLocode;
 
+import java.util.List;
+
 public class LocationRepositoryHibernate extends HibernateRepository implements LocationRepository {
 
   public Location find(UnLocode unLocode) {
@@ -11,4 +13,9 @@ public class LocationRepositoryHibernate extends HibernateRepository implements
           setParameter(0, unLocode).
           uniqueResult();
   }
+
+  public List<Location> findAll() {
+    return getSession().createQuery("from Location").list();
+  }
+
 }

dddsample/src/main/java/se/citerus/dddsample/service/RoutingServiceImpl.java

@@ -0,0 +1,52 @@
+package se.citerus.dddsample.service;
+
+import org.springframework.transaction.annotation.Transactional;
+import se.citerus.dddsample.domain.*;
+import se.citerus.dddsample.repository.LocationRepository;
+
+import java.util.*;
+
+/**
+ * Simple routing service implementation that randomly creates a number
+ * of different itineraries.
+ *
+ */
+public class RoutingServiceImpl implements RoutingService {
+
+  LocationRepository locationRepository;
+
+  @Transactional(readOnly = true)
+  public Set<Itinerary> calculatePossibleRoutes(Cargo cargo, Specification specification) {
+    List<Location> allLocations = locationRepository.findAll();
+
+    allLocations.remove(cargo.origin());
+    allLocations.remove(cargo.finalDestination());
+
+    // TODO: vary the number of locations and number of candidates randomly
+
+    int candidateCount = 3;
+    Set<Itinerary> candidates = new HashSet<Itinerary>(candidateCount);
+    for (int i = 0; i < candidateCount; i++) {
+      Collections.shuffle(allLocations);
+      List<Leg> legs = new ArrayList<Leg>(allLocations.size() - 1);
+
+      legs.add(new Leg(new CarrierMovementId("CM000"), cargo.origin(), allLocations.get(0)));
+      for (int j = 0; j < allLocations.size() - 1 ; j++) {
+        legs.add(new Leg(new CarrierMovementId("CM00" + j), 
+          allLocations.get(j), allLocations.get(j + 1)));
+      }
+      legs.add(new Leg(new CarrierMovementId("CM999"), allLocations.get(allLocations.size() - 1), cargo.finalDestination()));
+
+      Itinerary itinerary = new Itinerary(legs);
+
+      candidates.add(itinerary);
+    }
+
+    return candidates;
+  }
+
+  public void setLocationRepository(LocationRepository locationRepository) {
+    this.locationRepository = locationRepository;
+  }
+
+}

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

@@ -30,6 +30,10 @@
     <property name="destination" ref="handlingEventTopic"/>
   </bean>
 
+  <bean id="routingService" class="se.citerus.dddsample.service.RoutingServiceImpl">
+    <property name="locationRepository" ref="locationRepository"/>
+  </bean>
+
   <!--
   <bean id="eventService" class="se.citerus.dddsample.service.ThreadBasedEventServiceImpl">
     <property name="cargoService" ref="cargoService"/>

dddsample/src/test/java/se/citerus/dddsample/domain/DeliveryHistoryTest.java

@@ -1,28 +1,28 @@
 package se.citerus.dddsample.domain;
 
 import junit.framework.TestCase;
+import static se.citerus.dddsample.domain.SampleLocations.*;
 
 import java.text.DateFormat;
 import java.text.SimpleDateFormat;
-import java.util.*;
+import java.util.Arrays;
+import java.util.Date;
+import java.util.List;
 
 public class DeliveryHistoryTest extends TestCase {
-  private Location ham = new Location(new UnLocode("DE", "HAM"), "Hamburg");
-  private Location from = new Location(new UnLocode("FR", "OMX"), "From");
-  private Location to = new Location(new UnLocode("TO", "XXX"), "To");
-  private Cargo cargo = new Cargo(new TrackingId("XYZ"), from, to);
 
+  private Cargo cargo = new Cargo(new TrackingId("XYZ"), HONGKONG, NEWYORK);
 
   public void testEvensOrderedByTimeOccured() throws Exception {
     DeliveryHistory dh = new DeliveryHistory();
     assertTrue(dh.eventsOrderedByCompletionTime().isEmpty());
 
     DateFormat df = new SimpleDateFormat("yyyy-MM-dd");
-    CarrierMovement carrierMovement = new CarrierMovement(new CarrierMovementId("CAR_001"), from, to);
-    HandlingEvent he1 = new HandlingEvent(cargo, df.parse("2010-01-03"), new Date(), HandlingEvent.Type.RECEIVE, to, null);
-    HandlingEvent he2 = new HandlingEvent(cargo, df.parse("2010-01-01"), new Date(), HandlingEvent.Type.LOAD, to, carrierMovement);
-    HandlingEvent he3 = new HandlingEvent(cargo, df.parse("2010-01-04"), new Date(), HandlingEvent.Type.CLAIM, from, null);
-    HandlingEvent he4 = new HandlingEvent(cargo, df.parse("2010-01-02"), new Date(), HandlingEvent.Type.UNLOAD, from, carrierMovement);
+    CarrierMovement carrierMovement = new CarrierMovement(new CarrierMovementId("CAR_001"), HONGKONG, NEWYORK);
+    HandlingEvent he1 = new HandlingEvent(cargo, df.parse("2010-01-03"), new Date(), HandlingEvent.Type.RECEIVE, NEWYORK, null);
+    HandlingEvent he2 = new HandlingEvent(cargo, df.parse("2010-01-01"), new Date(), HandlingEvent.Type.LOAD, NEWYORK, carrierMovement);
+    HandlingEvent he3 = new HandlingEvent(cargo, df.parse("2010-01-04"), new Date(), HandlingEvent.Type.CLAIM, HONGKONG, null);
+    HandlingEvent he4 = new HandlingEvent(cargo, df.parse("2010-01-02"), new Date(), HandlingEvent.Type.UNLOAD, HONGKONG, carrierMovement);
     dh.addAllEvents(Arrays.asList(he1, he2, he3, he4));
 
     List<HandlingEvent> orderEvents = dh.eventsOrderedByCompletionTime();
@@ -38,17 +38,17 @@ public class DeliveryHistoryTest extends TestCase {
 
     assertEquals(StatusCode.NOT_RECIEVED, deliveryHistory.status());
 
-    deliveryHistory.addEvent(new HandlingEvent(cargo, new Date(10), new Date(11), HandlingEvent.Type.RECEIVE, ham, null));
+    deliveryHistory.addEvent(new HandlingEvent(cargo, new Date(10), new Date(11), HandlingEvent.Type.RECEIVE, HAMBURG, null));
     assertEquals(StatusCode.IN_PORT, deliveryHistory.status());
 
-    CarrierMovement carrierMovement = new CarrierMovement(new CarrierMovementId("ABC"), ham, ham);
-    deliveryHistory.addEvent(new HandlingEvent(cargo, new Date(20), new Date(21), HandlingEvent.Type.LOAD, ham, carrierMovement));
+    CarrierMovement carrierMovement = new CarrierMovement(new CarrierMovementId("ABC"), HAMBURG, HAMBURG);
+    deliveryHistory.addEvent(new HandlingEvent(cargo, new Date(20), new Date(21), HandlingEvent.Type.LOAD, HAMBURG, carrierMovement));
     assertEquals(StatusCode.ONBOARD_CARRIER, deliveryHistory.status());
 
-    deliveryHistory.addEvent(new HandlingEvent(cargo, new Date(30), new Date(31), HandlingEvent.Type.UNLOAD, ham, carrierMovement));
+    deliveryHistory.addEvent(new HandlingEvent(cargo, new Date(30), new Date(31), HandlingEvent.Type.UNLOAD, HAMBURG, carrierMovement));
     assertEquals(StatusCode.IN_PORT, deliveryHistory.status());
 
-    deliveryHistory.addEvent(new HandlingEvent(cargo, new Date(40), new Date(41), HandlingEvent.Type.CLAIM, ham, null));
+    deliveryHistory.addEvent(new HandlingEvent(cargo, new Date(40), new Date(41), HandlingEvent.Type.CLAIM, HAMBURG, null));
     assertEquals(StatusCode.CLAIMED, deliveryHistory.status());
   }
 
@@ -57,11 +57,11 @@ public class DeliveryHistoryTest extends TestCase {
 
     assertNull(deliveryHistory.currentLocation());
 
-    deliveryHistory.addEvent(new HandlingEvent(cargo, new Date(10), new Date(11), HandlingEvent.Type.RECEIVE, ham, null));
-    assertEquals(ham, deliveryHistory.currentLocation());
+    deliveryHistory.addEvent(new HandlingEvent(cargo, new Date(10), new Date(11), HandlingEvent.Type.RECEIVE, HAMBURG, null));
+    assertEquals(HAMBURG, deliveryHistory.currentLocation());
 
-    CarrierMovement carrierMovement = new CarrierMovement(new CarrierMovementId("ABC"), ham, ham);
-    deliveryHistory.addEvent(new HandlingEvent(cargo, new Date(20), new Date(21), HandlingEvent.Type.LOAD, ham, carrierMovement));
+    CarrierMovement carrierMovement = new CarrierMovement(new CarrierMovementId("ABC"), HAMBURG, HAMBURG);
+    deliveryHistory.addEvent(new HandlingEvent(cargo, new Date(20), new Date(21), HandlingEvent.Type.LOAD, HAMBURG, carrierMovement));
     assertNull(deliveryHistory.currentLocation());
   }
 

dddsample/src/test/java/se/citerus/dddsample/domain/SampleLocations.java

@@ -1,5 +1,9 @@
 package se.citerus.dddsample.domain;
 
+import java.lang.reflect.Field;
+import java.util.ArrayList;
+import java.util.List;
+
 /**
  * A few locations for easy testing.
  *
@@ -19,4 +23,22 @@ public class SampleLocations {
   public static final Location HANGZOU = new Location(new UnLocode("CN", "HGH"), "Hangzhou");
   public static final Location NEWYORK = new Location(new UnLocode("US", "NYC"), "New York");
 
+  public static final List<Location> all = new ArrayList<Location>();
+
+  static {
+    for (Field field : SampleLocations.class.getDeclaredFields()) {
+      if (field.getType().equals(Location.class)) {
+        try {
+          all.add((Location) field.get(null));
+        } catch (IllegalAccessException e) {
+          throw new RuntimeException(e);
+        }
+      }
+    }
+  }
+
+  public static List<Location> getAll() {
+    return all;
+  }
+  
 }

dddsample/src/test/java/se/citerus/dddsample/repository/LocationRepositoryTest.java

@@ -3,6 +3,8 @@ package se.citerus.dddsample.repository;
 import se.citerus.dddsample.domain.Location;
 import se.citerus.dddsample.domain.UnLocode;
 
+import java.util.List;
+
 public class LocationRepositoryTest extends AbstractRepositoryTest {
   private LocationRepository locationRepository;
   
@@ -11,6 +13,15 @@ public class LocationRepositoryTest extends AbstractRepositoryTest {
     Location location = locationRepository.find(melbourne);
     assertNotNull(location);
     assertEquals(melbourne, location.unLocode());
+
+    assertNull(locationRepository.find(new UnLocode("NO","LOC")));
+  }
+
+  public void testFindAll() throws Exception {
+    List<Location> allLocations = locationRepository.findAll();
+
+    assertNotNull(allLocations);
+    assertEquals(7, allLocations.size());
   }
 
   public void setLocationRepository(LocationRepository locationRepository) {

dddsample/src/test/java/se/citerus/dddsample/service/RoutingScenarioTest.java

@@ -0,0 +1,69 @@
+package se.citerus.dddsample.service;
+
+import junit.framework.TestCase;
+import se.citerus.dddsample.domain.*;
+import se.citerus.dddsample.repository.CargoRepository;
+
+import java.util.Date;
+import java.util.Set;
+
+public class RoutingScenarioTest extends TestCase {
+
+  RoutingService routingService;
+  CargoRepository cargoRepository;
+  HandlingEventService handlingEventService;
+
+  public void xtestCalculateRoute() throws Exception {
+
+    TrackingId trackingId = new TrackingId("XYZ123");
+    Cargo cargo = cargoRepository.find(trackingId);
+    Specification specification = null;
+
+    /*
+      The routing service calculates a number of possible routes that
+      satisfy the given specification (must arrive in three days, must not
+      cost more than $10,000 etc).
+     */
+    Set<Itinerary> itineraryCandidates = routingService.calculatePossibleRoutes(cargo, specification);
+
+    /*
+      Someone, or something, selects the most appropriate itinerary and
+      assigns that itinerary to the cargo.
+     */
+    Itinerary itinerary = stubbedItinerarySelection(itineraryCandidates);
+    cargo.setItinerary(itinerary);
+
+    /*
+      A number of events occur, all of which are according to plan
+     */
+    handlingEventService.register(new Date(), trackingId, new CarrierMovementId("A001"), new UnLocode("SE","STO"), null);
+    handlingEventService.register(new Date(), trackingId, new CarrierMovementId("B002"), null, null);
+    handlingEventService.register(new Date(), trackingId, new CarrierMovementId("C003"), null, null);
+
+    /*
+      Cargo should not be misdirected at this point.
+     */
+    assertFalse(cargo.isMisdirected());
+
+    /*
+      An unexpected event occur.
+     */
+    handlingEventService.register(null, null, null, null, null);
+
+    /*
+      Now the cargo is misdirected.
+     */
+    assertTrue(cargo.isMisdirected());
+  }
+
+  public void testRun() throws Exception
+  {
+    
+  }
+
+
+  private Itinerary stubbedItinerarySelection(Set<Itinerary> itineraryCandidates) {
+    return itineraryCandidates.iterator().next();
+  }
+
+}

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

@@ -1,69 +1,55 @@
-package se.citerus.dddsample.service;
-
-import junit.framework.TestCase;
-import se.citerus.dddsample.domain.*;
-import se.citerus.dddsample.repository.CargoRepository;
-
-import java.util.Date;
-import java.util.Set;
-
-public class RoutingServiceTest extends TestCase {
-
-  RoutingService routingService;
-  CargoRepository cargoRepository;
-  HandlingEventService handlingEventService;
-
-  public void xtestCalculateRoute() throws Exception {
-
-    TrackingId trackingId = new TrackingId("XYZ123");
-    Cargo cargo = cargoRepository.find(trackingId);
-    Specification specification = null;
-
-    /*
-      The routing service calculates a number of possible routes that
-      satisfy the given specification (must arrive in three days, must not
-      cost more than $10,000 etc).
-     */
-    Set<Itinerary> itineraryCandidates = routingService.calculatePossibleRoutes(cargo, specification);
-
-    /*
-      Someone, or something, selects the most appropriate itinerary and
-      assigns that itinerary to the cargo.
-     */
-    Itinerary itinerary = stubbedItinerarySelection(itineraryCandidates);
-    cargo.setItinerary(itinerary);
-
-    /*
-      A number of events occur, all of which are according to plan
-     */
-    handlingEventService.register(new Date(), trackingId, new CarrierMovementId("A001"), new UnLocode("SE","STO"), null);
-    handlingEventService.register(new Date(), trackingId, new CarrierMovementId("B002"), null, null);
-    handlingEventService.register(new Date(), trackingId, new CarrierMovementId("C003"), null, null);
-
-    /*
-      Cargo should not be misdirected at this point.
-     */
-    assertFalse(cargo.isMisdirected());
-
-    /*
-      An unexpected event occur.
-     */
-    handlingEventService.register(null, null, null, null, null);
-
-    /*
-      Now the cargo is misdirected.
-     */
-    assertTrue(cargo.isMisdirected());
-  }
-
-  public void testRun() throws Exception
-  {
-    
-  }
-
-
-  private Itinerary stubbedItinerarySelection(Set<Itinerary> itineraryCandidates) {
-    return itineraryCandidates.iterator().next();
-  }
-
-}
+package se.citerus.dddsample.service;
+
+import junit.framework.TestCase;
+import static org.easymock.EasyMock.*;
+import se.citerus.dddsample.domain.*;
+import static se.citerus.dddsample.domain.SampleLocations.HELSINKI;
+import static se.citerus.dddsample.domain.SampleLocations.HONGKONG;
+import se.citerus.dddsample.repository.LocationRepository;
+
+import java.util.List;
+import java.util.Set;
+
+public class RoutingServiceTest extends TestCase {
+
+  RoutingServiceImpl routingService;
+  LocationRepository locationRepository;
+
+  protected void setUp() throws Exception {
+    routingService = new RoutingServiceImpl();
+    locationRepository = createMock(LocationRepository.class);
+    routingService.setLocationRepository(locationRepository);
+  }
+
+  public void testCalculatePossibleRoutes() {
+    expect(locationRepository.findAll()).andStubReturn(SampleLocations.getAll());
+    replay(locationRepository);
+
+    Cargo cargo = new Cargo(new TrackingId("ABC"), HONGKONG, HELSINKI);
+    Set<Itinerary> candidates = routingService.calculatePossibleRoutes(cargo, null);
+    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
+      Location firstLegStart = legs.get(0).from();
+      assertEquals(cargo.origin(), firstLegStart);
+
+      // Cargo final destination and last leg stop should match
+      Location lastLegStop = legs.get(legs.size() - 1).to();
+      assertEquals(cargo.finalDestination(), lastLegStop);
+
+      for (int i = 0; i < legs.size() - 1; i++) {
+        // Assert that all legs are conencted
+        assertEquals(legs.get(i).to(), legs.get(i + 1).from());
+      }
+    }
+
+
+    verify(locationRepository);
+  }
+
+}