HDPI-6099: Set gen app reference on generated submission doc entity

Author: scottstewart-sl

src/main/java/uk/gov/hmcts/reform/pcs/ccd/event/genapp/MakeAnApplication.java

@@ -16,6 +16,7 @@
 import uk.gov.hmcts.reform.pcs.ccd.domain.State;
 import uk.gov.hmcts.reform.pcs.ccd.domain.VerticalYesNo;
 import uk.gov.hmcts.reform.pcs.ccd.domain.genapp.GenAppRequest;
+import uk.gov.hmcts.reform.pcs.ccd.entity.DocumentEntity;
 import uk.gov.hmcts.reform.pcs.ccd.entity.GenAppEntity;
 import uk.gov.hmcts.reform.pcs.ccd.entity.PcsCaseEntity;
 import uk.gov.hmcts.reform.pcs.ccd.entity.party.PartyEntity;
@@ -197,7 +198,13 @@ private void createSubmissionDocument(long caseReference,
             applicantParty
         );
 
-        documentImportService.addDocumentToCase(caseReference, documentUrl, CaseFileCategory.APPLICATIONS);
+        DocumentEntity importedDocumentEntity = documentImportService.addDocumentToCase(
+            caseReference,
+            documentUrl,
+            CaseFileCategory.APPLICATIONS
+        );
+
+        importedDocumentEntity.setGeneralApplication(genAppEntity);
     }
 
     @SuppressWarnings("SameParameterValue")

src/main/java/uk/gov/hmcts/reform/pcs/ccd/service/document/DocumentImportService.java

@@ -23,9 +23,9 @@ public class DocumentImportService {
     private final IdamService idamService;
     private final AuthTokenGenerator authTokenGenerator;
 
-    public void addDocumentToCase(long caseReference,
-                                  String documentUrl,
-                                  CaseFileCategory caseFileCategory) {
+    public DocumentEntity addDocumentToCase(long caseReference,
+                                            String documentUrl,
+                                            CaseFileCategory caseFileCategory) {
 
         String[] urlParts = documentUrl.split("/");
         UUID documentId = UUID.fromString(urlParts[urlParts.length - 1]);
@@ -48,6 +48,8 @@ public void addDocumentToCase(long caseReference,
 
         PcsCaseEntity pcsCaseEntity = pcsCaseService.loadCase(caseReference);
         pcsCaseEntity.addDocuments(List.of(documentEntity));
+
+        return documentEntity;
     }
 
 }

src/test/java/uk/gov/hmcts/reform/pcs/ccd/event/genapp/MakeAnApplicationTest.java

@@ -22,6 +22,7 @@
 import uk.gov.hmcts.reform.pcs.ccd.domain.genapp.CitizenGenAppRequest;
 import uk.gov.hmcts.reform.pcs.ccd.domain.genapp.GenAppType;
 import uk.gov.hmcts.reform.pcs.ccd.domain.genapp.XuiGenAppRequest;
+import uk.gov.hmcts.reform.pcs.ccd.entity.DocumentEntity;
 import uk.gov.hmcts.reform.pcs.ccd.entity.GenAppEntity;
 import uk.gov.hmcts.reform.pcs.ccd.entity.PcsCaseEntity;
 import uk.gov.hmcts.reform.pcs.ccd.entity.party.PartyEntity;
@@ -48,7 +49,9 @@
 import static org.junit.jupiter.params.provider.Arguments.arguments;
 import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.ArgumentMatchers.eq;
+import static org.mockito.ArgumentMatchers.nullable;
 import static org.mockito.BDDMockito.given;
+import static org.mockito.Mock.Strictness.LENIENT;
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.never;
 import static org.mockito.Mockito.verify;
@@ -69,7 +72,7 @@ class MakeAnApplicationTest extends BaseEventTest {
     private GenAppRepository genAppRepository;
     @Mock
     private GenAppDocumentGenerator genAppDocumentGenerator;
-    @Mock
+    @Mock(strictness = LENIENT)
     private DocumentImportService documentImportService;
     @Mock
     private LegalRepresentativeService legalRepresentativeService;
@@ -221,6 +224,7 @@ class XuiSubmitEventTests {
 
         @BeforeEach
         void setUp() {
+            stubDocumentImport();
             given(pcsCaseService.loadCase(TEST_CASE_REFERENCE)).willReturn(pcsCaseEntity);
         }
 
@@ -259,6 +263,7 @@ class CitizenSubmitEventTests {
 
         @BeforeEach
         void setUp() {
+            stubDocumentImport();
             given(pcsCaseService.loadCase(TEST_CASE_REFERENCE)).willReturn(pcsCaseEntity);
         }
 
@@ -344,6 +349,37 @@ void shouldGenerateGenAppDocumentAndStoreMetadata() {
             );
         }
 
+        @Test
+        void shouldSetGenAppReferenceOnImportedDocumentEntity() {
+            CitizenGenAppRequest genAppRequest = CitizenGenAppRequest.builder()
+                .applicationType(GenAppType.ADJOURN)
+                .clientReference("some reference")
+                .build();
+
+            final PCSCase caseData = PCSCase.builder()
+                .citizenGenAppRequest(genAppRequest)
+                .build();
+
+            PartyEntity applicantParty = stubCurrentUserParty();
+
+            GenAppEntity genAppEntity = mock(GenAppEntity.class);
+            when(genAppService.createGenAppEntity(genAppRequest, pcsCaseEntity, applicantParty))
+                .thenReturn(genAppEntity);
+
+            String documentUrl = "some document URL";
+            when(genAppDocumentGenerator
+                     .generateSubmissionDocument(TEST_CASE_REFERENCE, genAppRequest, genAppEntity, applicantParty))
+                .thenReturn(documentUrl);
+
+            DocumentEntity importedDocumentEntity = stubDocumentImport();
+
+            // When
+            callSubmitHandler(caseData);
+
+            // Then
+            verify(importedDocumentEntity).setGeneralApplication(genAppEntity);
+        }
+
         private PartyEntity stubCurrentUserParty() {
             PartyEntity currentUserParty = mock(PartyEntity.class);
             UUID currentUserId = UUID.randomUUID();
@@ -353,4 +389,12 @@ private PartyEntity stubCurrentUserParty() {
         }
 
     }
+
+    private DocumentEntity stubDocumentImport() {
+        DocumentEntity importedDocumentEntity = mock(DocumentEntity.class);
+        when(documentImportService
+                 .addDocumentToCase(eq(TEST_CASE_REFERENCE), nullable(String.class), any(CaseFileCategory.class)))
+            .thenReturn(importedDocumentEntity);
+        return importedDocumentEntity;
+    }
 }

src/test/java/uk/gov/hmcts/reform/pcs/ccd/service/document/DocumentImportServiceTest.java

@@ -71,17 +71,23 @@ void shouldAddDocumentToCaseWithMetadata() {
         when(pcsCaseService.loadCase(CASE_REFERENCE)).thenReturn(pcsCaseEntity);
 
         // When
-        underTest.addDocumentToCase(CASE_REFERENCE, documentUrl, CaseFileCategory.HEARING_DOCUMENTS);
+        DocumentEntity returnedDocumentEntity = underTest.addDocumentToCase(
+            CASE_REFERENCE,
+            documentUrl,
+            CaseFileCategory.HEARING_DOCUMENTS
+        );
 
         // Then
         verify(pcsCaseEntity).addDocuments(documentEntityListCaptor.capture());
         assertThat(documentEntityListCaptor.getValue()).hasSize(1);
 
-        DocumentEntity documentEntity = documentEntityListCaptor.getValue().getFirst();
-        assertThat(documentEntity.getFileName()).isEqualTo("original filename");
-        assertThat(documentEntity.getUrl()).isEqualTo("test url");
-        assertThat(documentEntity.getBinaryUrl()).isEqualTo("test binary url");
-        assertThat(documentEntity.getCategoryId()).isEqualTo(CaseFileCategory.HEARING_DOCUMENTS.getId());
+        DocumentEntity addedDocumentEntity = documentEntityListCaptor.getValue().getFirst();
+        assertThat(addedDocumentEntity.getFileName()).isEqualTo("original filename");
+        assertThat(addedDocumentEntity.getUrl()).isEqualTo("test url");
+        assertThat(addedDocumentEntity.getBinaryUrl()).isEqualTo("test binary url");
+        assertThat(addedDocumentEntity.getCategoryId()).isEqualTo(CaseFileCategory.HEARING_DOCUMENTS.getId());
+
+        assertThat(returnedDocumentEntity).isSameAs(addedDocumentEntity);
     }
 
     @SuppressWarnings("SameParameterValue")