Merge pull request #184 from companieshouse/feature/BI-13973-create-payment-ref-free-admin-orders

Set static payment reference for free admin orders

Author: daisysanson

src/main/java/uk/gov/companieshouse/orders/api/controller/BasketController.java

@@ -422,10 +422,11 @@ public ResponseEntity<?> checkoutBasket(@RequestBody(required = false) String js
         } else {
             logMap.put(LoggingUtils.STATUS, OK);
             LOGGER.infoRequest(request, "Basket checkout completed no payment required", logMap);
+            checkoutData.setPaymentReference("FREEINTERNALORDER");
+
             checkoutData.setStatus(PaymentStatus.FREE);
             processOrder(checkout, logMap);
             LOGGER.infoRequest(request, "Free order processed", logMap);
-
             return new ResponseEntity<>(checkoutData, OK);
         }
     }

src/test/java/uk/gov/companieshouse/orders/api/controller/BasketControllerTest.java

@@ -5,6 +5,7 @@
 import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.ArgumentMatchers.eq;
 import static org.mockito.Mockito.lenient;
+import static org.mockito.Mockito.spy;
 import static org.mockito.Mockito.times;
 import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.verifyNoInteractions;
@@ -610,6 +611,32 @@ void controllerCreatesCheckoutWhenTotalCostIsFree() {
         assertEquals(OK, actual.getStatusCode());
     }
 
+    @Test
+    @DisplayName("Payment Reference is set value when free orders ")
+    void controllerSetsPaymentReferenceWhenIsNotFreeOrder() {
+        // given
+        Basket basket = createBasket();
+        basket.getData().setItems(Arrays.asList(certificate));
+        List<String> emptyErrorsList = Collections.EMPTY_LIST;
+
+        Checkout checkout = new Checkout();
+        CheckoutData checkoutData = spy(new CheckoutData());
+        checkoutData.setTotalOrderCost("0");
+        checkout.setData(checkoutData);
+
+        when(basketService.getBasketById(any())).thenReturn(Optional.of(basket));
+        when(checkoutBasketValidator.getValidationErrors(any(), any())).thenReturn(emptyErrorsList);
+        when(checkoutService.createCheckout(any(), any(), any(), any())).thenReturn(checkout);
+
+        ResponseEntity<?> actual = controllerUnderTest.checkoutBasket(any(),
+                httpServletRequest, "123");
+
+        verify(checkoutData).setPaymentReference("FREEINTERNALORDER");
+        // then
+        assertEquals(OK, actual.getStatusCode());
+        assertEquals("FREEINTERNALORDER", checkout.getData().getPaymentReference());
+    }
+
     @Test
     @DisplayName("Accepted status code when checkout created for multiple items")
     void createsCheckoutSuccessfullyForMultipleItems() {
@@ -630,7 +657,7 @@ void createsCheckoutSuccessfullyForMultipleItems() {
         // when
         ResponseEntity<?> actual = controllerUnderTest.checkoutBasket(any(),
                 httpServletRequest, "123");
-
+        
         // then
         assertEquals(ACCEPTED, actual.getStatusCode());
     }