Merge pull request #17 from Laffini/added-and-matched-events

Order added & matched events

Author: Laffini

.classpath

@@ -28,5 +28,11 @@
 			<attribute name="maven.pomderived" value="true"/>
 		</attributes>
 	</classpathentry>
+	<classpathentry excluding="**" kind="src" output="target/test-classes" path="src/test/resources">
+		<attributes>
+			<attribute name="maven.pomderived" value="true"/>
+			<attribute name="test" value="true"/>
+		</attributes>
+	</classpathentry>
 	<classpathentry kind="output" path="target/classes"/>
 </classpath>

src/main/java/net/laffyco/javamatchingengine/OrderController.java

@@ -6,6 +6,7 @@
 import java.util.Optional;
 
 import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.context.ApplicationEventPublisher;
 import org.springframework.web.bind.annotation.DeleteMapping;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PathVariable;
@@ -18,6 +19,9 @@
 import net.laffyco.javamatchingengine.engine.Order;
 import net.laffyco.javamatchingengine.engine.OrderBook;
 import net.laffyco.javamatchingengine.engine.Side;
+import net.laffyco.javamatchingengine.engine.Trade;
+import net.laffyco.javamatchingengine.events.OrderAddedEvent;
+import net.laffyco.javamatchingengine.events.OrderMatchedEvent;
 
 /**
  * Controller for orders.
@@ -35,6 +39,12 @@ public class OrderController {
     @Autowired
     private OrderBook orderBook;
 
+    /**
+     * Event publisher.
+     */
+    @Autowired
+    private ApplicationEventPublisher applicationEventPublisher;
+
     /**
      * Retrieve orders.
      *
@@ -81,8 +91,17 @@ public Map<String, Object> addOrder(@RequestParam("side") final Side side,
 
         final Order order = new Order(amount, price, side);
 
+        final List<Trade> trades = this.orderBook.process(order);
+
         response.put("id", order.getId());
-        response.put("trades", this.orderBook.process(order));
+        response.put("trades", trades);
+        this.applicationEventPublisher
+                .publishEvent(new OrderAddedEvent(this, order));
+
+        if (!trades.isEmpty()) {
+            this.applicationEventPublisher
+                    .publishEvent(new OrderMatchedEvent(this, trades));
+        }
 
         return response;
     }

src/main/java/net/laffyco/javamatchingengine/events/OrderAddedEvent.java

@@ -0,0 +1,40 @@
+package net.laffyco.javamatchingengine.events;
+
+import org.springframework.context.ApplicationEvent;
+
+import net.laffyco.javamatchingengine.engine.Order;
+
+/**
+ * Event for when an order is added to the engine.
+ *
+ * @author Laffini
+ *
+ */
+public class OrderAddedEvent extends ApplicationEvent {
+
+    /**
+     * The order added.
+     */
+    private final Order order;
+
+    /**
+     * Constructor.
+     *
+     * @param source
+     * @param pOrder
+     */
+    public OrderAddedEvent(final Object source, final Order pOrder) {
+        super(source);
+        this.order = pOrder;
+    }
+
+    /**
+     * Get order.
+     *
+     * @return the order
+     */
+    public Order getOrder() {
+        return this.order;
+    }
+
+}

src/main/java/net/laffyco/javamatchingengine/events/OrderMatchedEvent.java

@@ -0,0 +1,33 @@
+package net.laffyco.javamatchingengine.events;
+
+import java.util.List;
+
+import org.springframework.context.ApplicationEvent;
+
+import net.laffyco.javamatchingengine.engine.Trade;
+
+/**
+ * Order matched event.
+ *
+ * @author Laffini
+ *
+ */
+public class OrderMatchedEvent extends ApplicationEvent {
+
+    /**
+     * Completed trades.
+     */
+    private final List<Trade> trades;
+
+    /**
+     * Constructor.
+     *
+     * @param source
+     * @param pTrades
+     */
+    public OrderMatchedEvent(final Object source, final List<Trade> pTrades) {
+        super(source);
+        this.trades = pTrades;
+    }
+
+}

src/main/java/net/laffyco/javamatchingengine/events/package-info.java

@@ -0,0 +1,5 @@
+/**
+ * @author Laffini
+ *
+ */
+package net.laffyco.javamatchingengine.events;

src/test/java/net/laffyco/javamatchingengine/OrderControllerTests.java

@@ -12,14 +12,20 @@
 
 import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.Test;
+import org.mockito.ArgumentCaptor;
+import org.mockito.Captor;
 import org.mockito.InjectMocks;
 import org.mockito.Mock;
 import org.mockito.Mockito;
+import org.springframework.context.ApplicationEvent;
+import org.springframework.context.ApplicationEventPublisher;
 
 import net.laffyco.javamatchingengine.engine.Order;
 import net.laffyco.javamatchingengine.engine.OrderBook;
 import net.laffyco.javamatchingengine.engine.Side;
 import net.laffyco.javamatchingengine.engine.Trade;
+import net.laffyco.javamatchingengine.events.OrderAddedEvent;
+import net.laffyco.javamatchingengine.events.OrderMatchedEvent;
 import test.utils.AbstractTest;
 
 /**
@@ -36,13 +42,25 @@ public class OrderControllerTests extends AbstractTest {
     @Mock
     private OrderBook orderBook;
 
+    /**
+     * Event publisher.
+     */
+    @Mock
+    private ApplicationEventPublisher applicationEventPublisher;
+
     /**
      * Controller under test.
      */
     @InjectMocks
     @Resource
     private OrderController controller;
 
+    /**
+     * Key captor.
+     */
+    @Captor
+    private ArgumentCaptor<ApplicationEvent> captor;
+
     /**
      * Test data id.
      */
@@ -61,6 +79,11 @@ public class OrderControllerTests extends AbstractTest {
      */
     private final double amt = 25.0;
 
+    /**
+     * Test data price.
+     */
+    private final double price = 25;
+
     @Override
     public final void init() {
         Mockito.when(this.orderBook.findOrder(this.id, this.side))
@@ -100,19 +123,41 @@ public void getOrderById() {
     @Test
     @DisplayName("Add an order")
     public void addOrder() {
-        final double price = 25;
-
         final List<Trade> trades = new ArrayList<Trade>();
         Mockito.when(this.orderBook.process(Mockito.any())).thenReturn(trades);
 
         final Map<String, Object> result = this.controller.addOrder(this.side,
-                this.amt, price);
+                this.amt, this.price);
 
         assertTrue(result.containsKey(this.id));
         assertTrue(result.containsKey("trades"));
         assertEquals(result.get("trades"), trades);
     }
 
+    /**
+     * Checking that the correct events are published.
+     */
+    @Test
+    @DisplayName("Check that appropriate events are published")
+    public void events() {
+        final List<Trade> trades = new ArrayList<Trade>() {
+            {
+                this.add(null);
+            }
+        };
+        Mockito.when(this.orderBook.process(Mockito.any())).thenReturn(trades);
+
+        this.controller.addOrder(this.side, this.amt, this.price);
+
+        Mockito.verify(this.applicationEventPublisher, Mockito.times(2))
+                .publishEvent(this.captor.capture());
+
+        assertTrue(
+                this.captor.getAllValues().get(0) instanceof OrderAddedEvent);
+        assertTrue(
+                this.captor.getAllValues().get(1) instanceof OrderMatchedEvent);
+    }
+
     /**
      * Delete an order.
      */
@@ -137,16 +182,15 @@ public void deleteOrder() {
     @Test
     @DisplayName("Update an order")
     public void updateOrder() {
-        final double price = 35.0;
         final Side newSide = Side.SELL;
 
         final Map<String, Object> result = this.controller.updateOrder(this.id,
-                this.side, Optional.of(this.amt), Optional.of(price),
+                this.side, Optional.of(this.amt), Optional.of(this.price),
                 Optional.of(newSide));
 
         assertTrue((boolean) result.get("updated"));
         Mockito.verify(this.mockOrder).setAmount(this.amt);
-        Mockito.verify(this.mockOrder).setPrice(price);
+        Mockito.verify(this.mockOrder).setPrice(this.price);
         Mockito.verify(this.mockOrder).setSide(newSide);
     }
 
@@ -156,7 +200,6 @@ public void updateOrder() {
     @Test
     @DisplayName("Update an order with one parameter")
     public void updateOrder1Param() {
-
         final Map<String, Object> result = this.controller.updateOrder(this.id,
                 this.side, Optional.of(this.amt), Optional.empty(),
                 Optional.empty());

src/test/java/net/laffyco/javamatchingengine/scenarios/CucumberRunner.java

@@ -1,18 +1,20 @@
 package net.laffyco.javamatchingengine.scenarios;
 
-import io.cucumber.junit.Cucumber;
-import io.cucumber.junit.CucumberOptions;
+import static io.cucumber.junit.CucumberOptions.SnippetType.CAMELCASE;
+
 import org.junit.runner.RunWith;
 
-import static io.cucumber.junit.CucumberOptions.SnippetType.CAMELCASE;
+import io.cucumber.junit.Cucumber;
+import io.cucumber.junit.CucumberOptions;
 
 /**
  * Cucumber test runner.
  *
  * @author Laffini
  */
 @RunWith(Cucumber.class)
-@CucumberOptions(plugin = {"pretty", "summary"}, snippets = CAMELCASE,
+@CucumberOptions(plugin = { "pretty",
+        "summary" }, snippets = CAMELCASE,
         features = "src/test/java/net/laffyco/javamatchingengine/scenarios/")
 public class CucumberRunner {
     // Intentionally left blank.

src/test/java/net/laffyco/javamatchingengine/scenarios/orders/OrdersSteps.java

@@ -1,19 +1,20 @@
 package net.laffyco.javamatchingengine.scenarios.orders;
 
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+import java.util.List;
+
 import io.cucumber.java.en.Given;
 import io.cucumber.java.en.Then;
 import io.cucumber.java.en.When;
 import net.laffyco.javamatchingengine.engine.Order;
 import net.laffyco.javamatchingengine.engine.OrderBook;
 import net.laffyco.javamatchingengine.engine.Side;
 
-import java.util.List;
-
-import static org.junit.jupiter.api.Assertions.assertEquals;
-import static org.junit.jupiter.api.Assertions.assertTrue;
-
 /**
  * Orders feature steps.
+ *
  * @author Laffini
  */
 public class OrdersSteps {
@@ -28,21 +29,30 @@ public class OrdersSteps {
      */
     private Order order;
 
+    /**
+     * Create the order book.
+     */
     @Given("There is an instance of the order book")
     public void createOrderBook() {
         this.orderBook = new OrderBook();
     }
 
+    /**
+     * Add the order.
+     */
     @When("I add an order")
     public void addOrder() {
         final double amount = 10;
         final double price = 25.59;
         final Side side = Side.BUY;
 
         this.order = new Order(amount, price, side);
-        this.orderBook.process(order);
+        this.orderBook.process(this.order);
     }
 
+    /**
+     * Confirm order is added.
+     */
     @Then("It is added to the order book")
     public void orderIsAdded() {
         final List<Order> buyOrders = this.orderBook.getBuyOrders();

src/test/java/net/laffyco/javamatchingengine/scenarios/orders/package-info.java

@@ -0,0 +1,5 @@
+/**
+ * @author Laffini
+ *
+ */
+package net.laffyco.javamatchingengine.scenarios.orders;

src/test/java/net/laffyco/javamatchingengine/scenarios/package-info.java

@@ -0,0 +1,5 @@
+/**
+ * @author Laffini
+ *
+ */
+package net.laffyco.javamatchingengine.scenarios;