CIV-15614 - add obligations to notes tab

src/main/java/uk/gov/hmcts/reform/civil/handler/callback/user/ConfirmOrderReviewCallbackHandler.java

@@ -11,12 +11,16 @@
 import uk.gov.hmcts.reform.civil.callback.CallbackParams;
 import uk.gov.hmcts.reform.civil.callback.CaseEvent;
 import uk.gov.hmcts.reform.civil.enums.CaseState;
+import uk.gov.hmcts.reform.civil.enums.ObligationReason;
 import uk.gov.hmcts.reform.civil.enums.YesOrNo;
 import uk.gov.hmcts.reform.civil.model.BusinessProcess;
 import uk.gov.hmcts.reform.civil.model.CaseData;
-import uk.gov.hmcts.reform.civil.model.ObligationData;
+import uk.gov.hmcts.reform.civil.model.StoredObligationData;
 import uk.gov.hmcts.reform.civil.model.common.Element;
 import uk.gov.hmcts.reform.civil.service.FeatureToggleService;
+import uk.gov.hmcts.reform.civil.service.Time;
+import uk.gov.hmcts.reform.civil.service.UserService;
+import uk.gov.hmcts.reform.idam.client.models.UserDetails;
 
 import java.time.LocalDate;
 import java.util.ArrayList;
@@ -29,12 +33,14 @@
 
 import static java.lang.String.format;
 import static java.util.Objects.nonNull;
+import static uk.gov.hmcts.reform.civil.callback.CallbackParams.Params.BEARER_TOKEN;
 import static uk.gov.hmcts.reform.civil.callback.CallbackType.ABOUT_TO_START;
 import static uk.gov.hmcts.reform.civil.callback.CallbackType.ABOUT_TO_SUBMIT;
 import static uk.gov.hmcts.reform.civil.callback.CallbackType.MID;
 import static uk.gov.hmcts.reform.civil.callback.CallbackType.SUBMITTED;
 import static uk.gov.hmcts.reform.civil.callback.CaseEvent.CONFIRM_ORDER_REVIEW;
 import static uk.gov.hmcts.reform.civil.enums.CourtStaffNextSteps.STILL_TASKS;
+import static uk.gov.hmcts.reform.civil.utils.ElementUtils.element;
 
 @Service
 @RequiredArgsConstructor
@@ -44,6 +50,8 @@ public class ConfirmOrderReviewCallbackHandler extends CallbackHandler {
 
     private final FeatureToggleService featureToggleService;
     private final ObjectMapper objectMapper;
+    private final UserService userService;
+    private final Time time;
     private static final String HEADER_CONFIRMATION = "# The order review has been completed";
     private static final String BODY_CONFIRMATION_NO_OBLIGATION = " ";
     private static final String BODY_CONFIRMATION_OBLIGATION = "### What happens next \n\n" +
@@ -134,13 +142,30 @@ private CallbackResponse confirmOrderReview(CallbackParams callbackParams) {
         }
 
         if (nonNull(caseData.getObligationData())) {
+            UserDetails userDetails = userService.getUserDetails(callbackParams.getParams().get(BEARER_TOKEN).toString());
+            String officerName = userDetails.getFullName();
 
-            List<Element<ObligationData>> storedObligationData = Optional.ofNullable(caseData.getStoredObligationData())
+            List<Element<StoredObligationData>> storedObligationData = Optional.ofNullable(caseData.getStoredObligationData())
                 .orElse(Collections.emptyList());
 
-            List<Element<ObligationData>> combinedData = new ArrayList<>();
+            List<Element<StoredObligationData>> combinedData = new ArrayList<>();
             combinedData.addAll(storedObligationData);
-            combinedData.addAll(caseData.getObligationData());
+
+            caseData.getObligationData().forEach(obligation -> {
+                StoredObligationData storedObligation = StoredObligationData.builder()
+                    .createdBy(officerName)
+                    .createdOn(time.now())
+                    .obligationDate(obligation.getValue().getObligationDate())
+                    .obligationReason(obligation.getValue().getObligationReason())
+                    .otherObligationReason(obligation.getValue().getOtherObligationReason())
+                    .reasonText(obligation.getValue().getObligationReason().equals(ObligationReason.OTHER)
+                                    ? ObligationReason.OTHER.getDisplayedValue() + ": " + obligation.getValue().getOtherObligationReason()
+                                    : obligation.getValue().getObligationReason().getDisplayedValue())
+                    .obligationAction(obligation.getValue().getObligationAction())
+                    .build();
+
+                combinedData.add(element(storedObligation));
+            });
 
             updatedCaseData.obligationData(null)
                 .storedObligationData(combinedData);

src/main/java/uk/gov/hmcts/reform/civil/handler/tasks/ConfirmOrderReviewTaskHandler.java

@@ -15,7 +15,7 @@
 import uk.gov.hmcts.reform.civil.model.BusinessProcess;
 import uk.gov.hmcts.reform.civil.model.CaseData;
 import uk.gov.hmcts.reform.civil.model.ExternalTaskData;
-import uk.gov.hmcts.reform.civil.model.ObligationData;
+import uk.gov.hmcts.reform.civil.model.StoredObligationData;
 import uk.gov.hmcts.reform.civil.service.CoreCaseDataService;
 import uk.gov.hmcts.reform.civil.service.data.ExternalTaskInput;
 
@@ -99,7 +99,7 @@ private String getObligationReasons(CaseData caseData) {
             .orElse(Collections.emptyList())
             .stream()
             .map(element -> {
-                ObligationData data = element.getValue();
+                StoredObligationData data = element.getValue();
                 ObligationReason reason = data.getObligationReason();
 
                 if (reason == ObligationReason.OTHER) {

src/main/java/uk/gov/hmcts/reform/civil/model/CaseData.java

@@ -754,7 +754,7 @@ public boolean hasNoOngoingBusinessProcess() {
     private YesOrNo obligationDatePresent;
     private CourtStaffNextSteps courtStaffNextSteps;
     private List<Element<ObligationData>> obligationData;
-    private List<Element<ObligationData>> storedObligationData;
+    private List<Element<StoredObligationData>> storedObligationData;
     private YesOrNo isFinalOrder;
 
     private SendAndReplyOption sendAndReplyOption;

src/main/java/uk/gov/hmcts/reform/civil/model/StoredObligationData.java

@@ -0,0 +1,25 @@
+package uk.gov.hmcts.reform.civil.model;
+
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+import uk.gov.hmcts.reform.civil.enums.ObligationReason;
+
+import java.time.LocalDate;
+import java.time.LocalDateTime;
+
+@Data
+@Builder(toBuilder = true)
+@NoArgsConstructor
+@AllArgsConstructor
+public class StoredObligationData {
+
+    private String createdBy;
+    private LocalDateTime createdOn;
+    private LocalDate obligationDate;
+    private ObligationReason obligationReason;
+    private String otherObligationReason;
+    private String reasonText;
+    private String obligationAction;
+}

src/test/java/uk/gov/hmcts/reform/civil/handler/callback/user/ConfirmOrderReviewCallbackHandlerTest.java

@@ -1,49 +1,61 @@
 package uk.gov.hmcts.reform.civil.handler.callback.user;
 
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Nested;
 import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.mockito.Mock;
 import org.mockito.Mockito;
-import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.boot.autoconfigure.jackson.JacksonAutoConfiguration;
-import org.springframework.boot.test.context.SpringBootTest;
-import org.springframework.boot.test.mock.mockito.MockBean;
+import org.mockito.junit.jupiter.MockitoExtension;
 import uk.gov.hmcts.reform.ccd.client.model.AboutToStartOrSubmitCallbackResponse;
 import uk.gov.hmcts.reform.ccd.client.model.SubmittedCallbackResponse;
 import uk.gov.hmcts.reform.civil.callback.CallbackParams;
 import uk.gov.hmcts.reform.civil.enums.CaseState;
 import uk.gov.hmcts.reform.civil.enums.CourtStaffNextSteps;
+import uk.gov.hmcts.reform.civil.enums.ObligationReason;
 import uk.gov.hmcts.reform.civil.enums.YesOrNo;
 import uk.gov.hmcts.reform.civil.handler.callback.BaseCallbackHandlerTest;
 import uk.gov.hmcts.reform.civil.model.CaseData;
 import uk.gov.hmcts.reform.civil.model.ObligationData;
+import uk.gov.hmcts.reform.civil.model.StoredObligationData;
 import uk.gov.hmcts.reform.civil.model.common.Element;
 import uk.gov.hmcts.reform.civil.sampledata.CallbackParamsBuilder;
 import uk.gov.hmcts.reform.civil.sampledata.CaseDataBuilder;
 import uk.gov.hmcts.reform.civil.service.FeatureToggleService;
+import uk.gov.hmcts.reform.civil.service.Time;
+import uk.gov.hmcts.reform.civil.service.UserService;
+import uk.gov.hmcts.reform.idam.client.models.UserDetails;
+
+import java.time.LocalDate;
+import java.time.LocalDateTime;
+import java.util.List;
+import java.util.UUID;
 
 import java.time.LocalDate;
 import java.util.List;
 import java.util.UUID;
 
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.mockito.ArgumentMatchers.any;
 import static uk.gov.hmcts.reform.civil.callback.CallbackType.ABOUT_TO_START;
 import static uk.gov.hmcts.reform.civil.callback.CallbackType.ABOUT_TO_SUBMIT;
 import static uk.gov.hmcts.reform.civil.callback.CallbackType.MID;
 import static uk.gov.hmcts.reform.civil.callback.CallbackType.SUBMITTED;
 import static uk.gov.hmcts.reform.civil.callback.CaseEvent.CONFIRM_ORDER_REVIEW;
 
-@SpringBootTest(classes = {
-    ConfirmOrderReviewCallbackHandler.class,
-    JacksonAutoConfiguration.class,
-})
+@ExtendWith(MockitoExtension.class)
 class ConfirmOrderReviewCallbackHandlerTest extends BaseCallbackHandlerTest {
 
-    @Autowired
     private ConfirmOrderReviewCallbackHandler handler;
 
-    @MockBean
+    @Mock
     private FeatureToggleService toggleService;
+    @Mock
+    private UserService userService;
+
+    private ObjectMapper objectMapper;
 
     private static final String HEADER_CONFIRMATION = "# The order review has been completed";
     private static final String BODY_CONFIRMATION_NO_OBLIGATION = " ";
@@ -55,8 +67,15 @@ class ConfirmOrderReviewCallbackHandlerTest extends BaseCallbackHandlerTest {
     private static final String TASKS_LEFT_ERROR_3 = "Once you have completed the task you can submit your order review by clicking on the link on your task list.";
     private static final String OBLIGATION_DATE_ERROR = "The obligation date must be in the future";
 
+    @Mock
+    private Time time;
+
     @BeforeEach
     void caseEventsEnabled() {
+
+        objectMapper = new ObjectMapper();
+        objectMapper.registerModule(new JavaTimeModule());
+        handler = new ConfirmOrderReviewCallbackHandler(toggleService, objectMapper, userService, time);
         Mockito.when(toggleService.isCaseEventsEnabled()).thenReturn(true);
     }
 
@@ -138,7 +157,6 @@ class AboutToSubmit {
 
         @Test
         void shouldConfirmOrderReview_whenInvoked() {
-
             CaseData caseData = CaseData.builder()
                 .obligationDatePresent(YesOrNo.YES)
                 .courtStaffNextSteps(CourtStaffNextSteps.NO_TASKS)
@@ -180,6 +198,102 @@ void shouldSetAllFinalOrdersIssuedState_whenIsFinalOrder() {
 
             assertThat(response.getState()).isEqualTo(CaseState.All_FINAL_ORDERS_ISSUED.name());
         }
+
+        @Test
+        void shouldSetStoredObligationData_whenObligationDataIsPresent() {
+            LocalDateTime localDateTime = LocalDateTime.of(2024, 01, 01, 10, 10, 10);
+            Mockito.when(time.now()).thenReturn(localDateTime);
+            UUID uuid = UUID.fromString("818da749-8920-40c2-a083-722645735e02");
+            Mockito.when(userService.getUserDetails(any())).thenReturn(UserDetails
+                                                                           .builder()
+                                                                           .forename("John")
+                                                                           .surname("Smith")
+                                                                           .build());
+            Mockito.when(toggleService.isCaseEventsEnabled()).thenReturn(true);
+
+            LocalDate obligationDate = LocalDate.of(2024, 12, 12);
+            CaseData caseData = CaseData.builder()
+                .isFinalOrder(YesOrNo.YES)
+                .obligationData(List.of(Element.<ObligationData>builder()
+                                            .id(uuid)
+                                            .value(ObligationData.builder()
+                                                       .obligationReason(ObligationReason.STAY_A_CASE)
+                                                       .obligationDate(obligationDate)
+                                                       .obligationAction("Main text")
+                                                       .build()
+                                            )
+                                            .build()
+                                )
+                )
+                .build();
+
+            StoredObligationData expectedData = StoredObligationData
+                                                  .builder()
+                                                  .createdBy("John Smith")
+                                                  .createdOn(time.now())
+                                                  .obligationDate(obligationDate)
+                                                  .obligationAction("Main text")
+                                                  .obligationReason(ObligationReason.STAY_A_CASE)
+                                                  .reasonText(ObligationReason.STAY_A_CASE
+                                                                  .getDisplayedValue())
+                                                  .build();
+
+            CallbackParams params = callbackParamsOf(caseData, ABOUT_TO_SUBMIT);
+
+            var response = (AboutToStartOrSubmitCallbackResponse) handler.handle(params);
+            CaseData data = objectMapper.convertValue(response.getData(), CaseData.class);
+
+            assertThat(data.getStoredObligationData().get(0).getValue()).isEqualTo(expectedData);
+        }
+
+        @Test
+        void shouldSetStoredObligationData_whenObligationDataIsPresent_withOtherReason() {
+            LocalDateTime localDateTime = LocalDateTime.of(2024, 01, 01, 10, 10, 10);
+            Mockito.when(time.now()).thenReturn(localDateTime);
+            UUID uuid = UUID.fromString("818da749-8920-40c2-a083-722645735e02");
+            Mockito.when(userService.getUserDetails(any())).thenReturn(UserDetails
+                                                                           .builder()
+                                                                           .forename("John")
+                                                                           .surname("Smith")
+                                                                           .build());
+            Mockito.when(toggleService.isCaseEventsEnabled()).thenReturn(true);
+
+            LocalDate obligationDate = LocalDate.of(2024, 12, 12);
+            CaseData caseData = CaseData.builder()
+                .isFinalOrder(YesOrNo.YES)
+                .obligationData(List.of(Element.<ObligationData>builder()
+                                            .id(uuid)
+                                            .value(ObligationData.builder()
+                                                       .obligationReason(ObligationReason.OTHER)
+                                                       .otherObligationReason("Reason for othering")
+                                                       .obligationDate(obligationDate)
+                                                       .obligationAction("Main text")
+                                                       .build()
+                                            )
+                                            .build()
+                                )
+                )
+                .build();
+
+            StoredObligationData expectedData = StoredObligationData
+                .builder()
+                .createdBy("John Smith")
+                .createdOn(time.now())
+                .obligationDate(obligationDate)
+                .obligationAction("Main text")
+                .obligationReason(ObligationReason.OTHER)
+                .otherObligationReason("Reason for othering")
+                .reasonText(ObligationReason.OTHER
+                                .getDisplayedValue() + ": Reason for othering")
+                .build();
+
+            CallbackParams params = callbackParamsOf(caseData, ABOUT_TO_SUBMIT);
+
+            var response = (AboutToStartOrSubmitCallbackResponse) handler.handle(params);
+            CaseData data = objectMapper.convertValue(response.getData(), CaseData.class);
+
+            assertThat(data.getStoredObligationData().get(0).getValue()).isEqualTo(expectedData);
+        }
     }
 
     @Nested

src/test/java/uk/gov/hmcts/reform/civil/handler/tasks/ConfirmOrderReviewTaskHandlerTest.java

@@ -20,7 +20,7 @@
 import uk.gov.hmcts.reform.civil.helpers.CaseDetailsConverter;
 import uk.gov.hmcts.reform.civil.model.BusinessProcess;
 import uk.gov.hmcts.reform.civil.model.CaseData;
-import uk.gov.hmcts.reform.civil.model.ObligationData;
+import uk.gov.hmcts.reform.civil.model.StoredObligationData;
 import uk.gov.hmcts.reform.civil.model.common.Element;
 import uk.gov.hmcts.reform.civil.sampledata.CaseDetailsBuilder;
 import uk.gov.hmcts.reform.civil.service.CoreCaseDataService;
@@ -81,7 +81,7 @@ void init() {
     @Test
     void shouldHaveCorrectEventDetails_whenObligationDataIsProvided() {
         CaseData caseData = CaseData.builder()
-            .storedObligationData(List.of(Element.<ObligationData>builder().id(UUID.randomUUID()).value(ObligationData.builder().obligationReason(
+            .storedObligationData(List.of(Element.<StoredObligationData>builder().id(UUID.randomUUID()).value(StoredObligationData.builder().obligationReason(
                 ObligationReason.DISMISS_CASE).obligationDate(
                 null).obligationAction("action").build()).build()))
             .businessProcess(