CCD-5224: CCD / Work Allocation Pact Provider Tests

Jenkinsfile_CNP

@@ -118,6 +118,9 @@ env.TESTCONTAINERS_HUB_IMAGE_NAME_PREFIX = "hmctspublic.azurecr.io/imported/"
 withPipeline(type, product, component) {
     onMaster {
         enableSlackNotifications('#ccd-master-builds')
+        enablePactAs([
+            AppPipelineDsl.PactRoles.PROVIDER
+        ])
     }
     if (env.BRANCH_NAME.equalsIgnoreCase(dataStoreApiDevelopPr)) {
         enableSlackNotifications('#ccd-develop-builds')
@@ -128,6 +131,9 @@ withPipeline(type, product, component) {
     }
     onPR {
         enableSlackNotifications('#ccd-pr-builds')
+        enablePactAs([
+            AppPipelineDsl.PactRoles.PROVIDER
+        ])
     }
 
     // Check if the build should be wired to an environment higher than 'preview'.

build.gradle

@@ -21,14 +21,14 @@ plugins {
     id 'org.jetbrains.gradle.plugin.idea-ext' version '0.7'
     id 'info.solidsoft.pitest' version '1.15.0'
     id 'uk.gov.hmcts.java' version '0.12.57'
-    id 'au.com.dius.pact' version '4.1.0'
+    id 'au.com.dius.pact' version '4.3.12'
     id "org.jsonschema2pojo" version "1.2.1"
 }
 
 apply from: './gradle/suppress.gradle'
 
 def versions = [
-        pact_version    : '4.1.7',
+        pact_version    : '4.3.4',
 ]
 
 ext['spring-security.version'] = '5.7.11'
@@ -921,7 +921,7 @@ task runProviderPactVerification(type:Test) {
         systemProperty 'pact.verifier.publishResults', project.property('pact.verifier.publishResults')
     }
     systemProperty 'pact.provider.version', project.pactVersion
-    include "uk/gov/hmcts/ccd/v2/external/controller/**"
+    include "uk/gov/hmcts/**"
 }
 
 runProviderPactVerification.finalizedBy pactVerify

charts/ccd-data-store-api/Chart.yaml

@@ -2,7 +2,7 @@ description: Helm chart for the HMCTS CCD Data Store
 name: ccd-data-store-api
 apiVersion: v2
 home: https://github.com/hmcts/ccd-data-store-api
-version: 2.0.30
+version: 2.0.31
 maintainers:
   - name: HMCTS CCD Dev Team
     email: [email protected]

charts/ccd-data-store-api/values.yaml

@@ -90,3 +90,8 @@ java:
     DATA_STORE_CROSS_JURISDICTIONAL_ROLES: caseworker-caa,caseworker-approver,next-hearing-date-admin
     DATA_STORE_CITIZEN_ROLES: citizen,letter-holder
     DATA_STORE_SECURITY_LOGGING_FILTER_PATH_REGEX: 'DISABLED'
+
+    PACT_BROKER_FULL_URL: https://pact-broker.platform.hmcts.net
+    PACT_BROKER_URL: pact-broker.platform.hmcts.net
+    PACT_BROKER_PORT: 443
+    PACT_BROKER_SCHEME: https

src/contractTest/java/uk/gov/hmcts/reform/ccd/pactprovider/wataskmanagement/GetCaseProviderTest.java

@@ -0,0 +1,69 @@
+package uk.gov.hmcts.reform.ccd.pactprovider.wataskmanagement;
+
+import au.com.dius.pact.provider.junit5.PactVerificationContext;
+import au.com.dius.pact.provider.junit5.PactVerificationInvocationContextProvider;
+import au.com.dius.pact.provider.junitsupport.IgnoreNoPactsToVerify;
+import au.com.dius.pact.provider.junitsupport.Provider;
+import au.com.dius.pact.provider.junitsupport.State;
+import au.com.dius.pact.provider.junitsupport.loader.PactBroker;
+import au.com.dius.pact.provider.junitsupport.loader.VersionSelector;
+import au.com.dius.pact.provider.spring.junit5.MockMvcTestTarget;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.TestTemplate;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.mockito.Mock;
+import org.springframework.test.context.junit.jupiter.SpringExtension;
+import uk.gov.hmcts.ccd.data.casedetails.SecurityClassification;
+import uk.gov.hmcts.ccd.domain.model.definition.CaseDetails;
+import uk.gov.hmcts.ccd.domain.service.getcase.GetCaseOperation;
+import uk.gov.hmcts.reform.ccd.pactprovider.wataskmanagement.controller.GetCaseRestController;
+import java.util.Optional;
+
+import static org.mockito.ArgumentMatchers.anyString;
+import static org.mockito.Mockito.when;
+
+// Get Case Provider Test version 1.
+
+@Provider("ccdDataStoreAPI_WorkAllocation")
+@PactBroker(
+    url = "${PACT_BROKER_FULL_URL:http://localhost:9292}",
+    consumerVersionSelectors = {@VersionSelector(tag = "master")})
+@IgnoreNoPactsToVerify
+@ExtendWith(SpringExtension.class)
+public class GetCaseProviderTest {
+
+    @Mock
+    private GetCaseOperation mockGetCaseOperation;
+
+    @BeforeEach
+    void beforeCreate(PactVerificationContext context) {
+        MockMvcTestTarget testTarget = new MockMvcTestTarget();
+        testTarget.setControllers(new GetCaseRestController(mockGetCaseOperation));
+        if (context != null) {
+            context.setTarget(testTarget);
+        }
+    }
+
+    @TestTemplate
+    @ExtendWith(PactVerificationInvocationContextProvider.class)
+    void pactVerificationTestTemplate(PactVerificationContext context) {
+        if (context != null) {
+            context.verifyInteraction();
+        }
+    }
+
+    // Mock the interaction.
+    @State("a case exists")
+    public void getCase() {
+        when(mockGetCaseOperation.execute(anyString())).thenReturn(Optional.of(mockCaseDetails()));
+    }
+
+    private CaseDetails mockCaseDetails() {
+        CaseDetails caseDetails = new CaseDetails();
+        caseDetails.setReference(1L);
+        caseDetails.setCaseTypeId("Asylum");
+        caseDetails.setJurisdiction("IA");
+        caseDetails.setSecurityClassification(SecurityClassification.PRIVATE);
+        return caseDetails;
+    }
+}

src/contractTest/java/uk/gov/hmcts/reform/ccd/pactprovider/wataskmanagement/StartEventProviderTest.java

@@ -0,0 +1,120 @@
+package uk.gov.hmcts.reform.ccd.pactprovider.wataskmanagement;
+
+import au.com.dius.pact.provider.junit5.PactVerificationContext;
+import au.com.dius.pact.provider.junit5.PactVerificationInvocationContextProvider;
+import au.com.dius.pact.provider.junitsupport.IgnoreNoPactsToVerify;
+import au.com.dius.pact.provider.junitsupport.Provider;
+import au.com.dius.pact.provider.junitsupport.State;
+import au.com.dius.pact.provider.junitsupport.loader.PactBroker;
+import au.com.dius.pact.provider.junitsupport.loader.VersionSelector;
+import au.com.dius.pact.provider.spring.junit5.MockMvcTestTarget;
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.node.TextNode;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.TestTemplate;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.mockito.Mock;
+import org.springframework.test.context.junit.jupiter.SpringExtension;
+import uk.gov.hmcts.ccd.data.casedetails.SecurityClassification;
+import uk.gov.hmcts.ccd.domain.model.callbacks.StartEventResult;
+import uk.gov.hmcts.ccd.domain.model.definition.CaseDetails;
+import uk.gov.hmcts.ccd.domain.service.startevent.StartEventOperation;
+import uk.gov.hmcts.reform.ccd.pactprovider.wataskmanagement.controller.StartEventRestController;
+import java.util.HashMap;
+
+import static org.mockito.ArgumentMatchers.anyBoolean;
+import static org.mockito.ArgumentMatchers.anyString;
+import static org.mockito.Mockito.when;
+
+// Start Event Provider Test version 1.
+
+@Provider("ccdDataStoreAPI_WorkAllocation")
+@PactBroker(
+    url = "${PACT_BROKER_FULL_URL:http://localhost:9292}",
+    consumerVersionSelectors = {@VersionSelector(tag = "master")})
+@IgnoreNoPactsToVerify
+@ExtendWith(SpringExtension.class)
+public class StartEventProviderTest {
+
+    @Mock
+    private StartEventOperation startEventOperation;
+
+    private final ObjectMapper objectMapper = new ObjectMapper();
+
+    @BeforeEach
+    void beforeCreate(PactVerificationContext context) {
+        MockMvcTestTarget testTarget = new MockMvcTestTarget();
+        testTarget.setControllers(new StartEventRestController(startEventOperation));
+        if (context != null) {
+            context.setTarget(testTarget);
+        }
+    }
+
+    @TestTemplate
+    @ExtendWith(PactVerificationInvocationContextProvider.class)
+    void pactVerificationTestTemplate(PactVerificationContext context) {
+        if (context != null) {
+            context.verifyInteraction();
+        }
+    }
+
+    // Mock the interaction.
+    @State("A Start Event for a Caseworker is  requested")
+    public void startEventForCaseworker() throws JsonProcessingException {
+        when(startEventOperation.triggerStartForCase(anyString(), anyString(), anyBoolean()))
+            .thenReturn(mockStartEventResult());
+    }
+
+    private StartEventResult mockStartEventResult() throws JsonProcessingException {
+        StartEventResult startEventResult = new StartEventResult();
+        startEventResult.setToken("someToken");
+        startEventResult.setEventId("startAppeal");
+        startEventResult.setCaseDetails(mockCaseDetails());
+        return startEventResult;
+    }
+
+    private CaseDetails mockCaseDetails() throws JsonProcessingException {
+        CaseDetails caseDetails = new CaseDetails();
+        caseDetails.setReference(1L);
+        caseDetails.setCaseTypeId("Asylum");
+        caseDetails.setJurisdiction("IA");
+        caseDetails.setSecurityClassification(SecurityClassification.PUBLIC);
+        caseDetails.setState("appealStarted");
+        caseDetails.setData(new HashMap<String,JsonNode>() {{
+                put("appealReferenceNumber", new TextNode("DRAFT"));
+                put("appealType", new TextNode("protection"));
+                put("appellantDateOfBirth", new TextNode("1990-12-07"));
+                put("appellantFamilyName", new TextNode("Smith"));
+                put("appellantGivenNames", new TextNode("Bob"));
+                put("appellantNameForDisplay", new TextNode("Bob Smith"));
+                put("appellantTitle", new TextNode("Mr"));
+                put("applicationOutOfTimeExplanation", new TextNode("test case"));
+                put("caseManagementLocation", objectMapper.readTree("{\"baseLocation\":\"765324\",\"region\":"
+                    + "\"1\"}"));
+                put("currentCaseStateVisibleToLegalRepresentative", new TextNode("appealStarted"));
+                put("homeOfficeDecisionDate", new TextNode("2019-08-01"));
+                put("homeOfficeReferenceNumber", new TextNode("000123456"));
+                put("legalRepCompanyAddress", objectMapper.readTree("{\"AddressLine1\":\"\",\"AddressLine2\":"
+                    + "\"\",\"AddressLine3\":\"\",\"Country\":\"\",\"PostCode\":\"\",\"PostTown\":\"\"}"));
+                put("legalRepCompanyName", new TextNode(""));
+                put("staffLocation", new TextNode("Taylor House"));
+                put("submissionOutOfTime", new TextNode("Yes"));
+                put("subscriptions", objectMapper.readTree("[{\"id\":\"1\",\"value\":{\"email\":"
+                    + "\"[email protected]\",\"mobileNumber\":\"0111111111\",\"subscriber\":\"appellant\","
+                    + "\"wantsEmail\":\"Yes\",\"wantsSms\":\"Yes\"}}]"));
+                put("uploadAddendumEvidenceLegalRepActionAvailable", new TextNode("No"));
+                put("uploadAdditionalEvidenceActionAvailable", new TextNode("No"));
+                put("uploadTheNoticeOfDecisionDocs", objectMapper.readTree("[{\"id\":\"1\",\"value\":"
+                    + "{\"description\":\"some notice of decision description\",\"document\":{\"document_binary_url\":"
+                    + "\"http://dm-store-aat.service.core-compute-aat.internal/documents/"
+                    + "7f63ca9b-c361-49ab-aa8c-8fbdb6bc2936\",\"document_filename\":"
+                    + "\"some-notice-of-decision-letter.pdf\",\"document_url\":"
+                    + "\"http://dm-store-aat.service.core-compute-aat.internal/documents/"
+                    + "7f63ca9b-c361-49ab-aa8c-8fbdb6bc2936\"}}}]"));
+            }
+        });
+        return caseDetails;
+    }
+}

src/contractTest/java/uk/gov/hmcts/reform/ccd/pactprovider/wataskmanagement/StartProviderTest.java

@@ -0,0 +1,85 @@
+package uk.gov.hmcts.reform.ccd.pactprovider.wataskmanagement;
+
+import au.com.dius.pact.provider.junit5.PactVerificationContext;
+import au.com.dius.pact.provider.junit5.PactVerificationInvocationContextProvider;
+import au.com.dius.pact.provider.junitsupport.IgnoreNoPactsToVerify;
+import au.com.dius.pact.provider.junitsupport.Provider;
+import au.com.dius.pact.provider.junitsupport.State;
+import au.com.dius.pact.provider.junitsupport.loader.PactBroker;
+import au.com.dius.pact.provider.junitsupport.loader.VersionSelector;
+import au.com.dius.pact.provider.spring.junit5.MockMvcTestTarget;
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.node.TextNode;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.TestTemplate;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.mockito.Mock;
+import org.springframework.test.context.junit.jupiter.SpringExtension;
+import uk.gov.hmcts.ccd.domain.model.callbacks.StartEventResult;
+import uk.gov.hmcts.ccd.domain.model.definition.CaseDetails;
+import uk.gov.hmcts.ccd.domain.service.startevent.StartEventOperation;
+import uk.gov.hmcts.reform.ccd.pactprovider.wataskmanagement.controller.StartRestController;
+import java.util.HashMap;
+
+import static org.mockito.ArgumentMatchers.anyBoolean;
+import static org.mockito.ArgumentMatchers.anyString;
+import static org.mockito.Mockito.when;
+
+// Start Provider Test version 1.
+
+@Provider("ccdDataStoreAPI_WorkAllocation")
+@PactBroker(
+    url = "${PACT_BROKER_FULL_URL:http://localhost:9292}",
+    consumerVersionSelectors = {@VersionSelector(tag = "master")})
+@IgnoreNoPactsToVerify
+@ExtendWith(SpringExtension.class)
+public class StartProviderTest {
+
+    @Mock
+    private StartEventOperation startEventOperation;
+
+    @BeforeEach
+    void beforeCreate(PactVerificationContext context) {
+        MockMvcTestTarget testTarget = new MockMvcTestTarget();
+        testTarget.setControllers(new StartRestController(startEventOperation));
+        if (context != null) {
+            context.setTarget(testTarget);
+        }
+    }
+
+    @TestTemplate
+    @ExtendWith(PactVerificationInvocationContextProvider.class)
+    void pactVerificationTestTemplate(PactVerificationContext context) {
+        if (context != null) {
+            context.verifyInteraction();
+        }
+    }
+
+    // Mock the interaction.
+    @State("A Start for a Caseworker is requested")
+    public void start() {
+        when(startEventOperation.triggerStartForCaseType(anyString(), anyString(), anyBoolean()))
+            .thenReturn(mockStartEventResult());
+    }
+
+    private StartEventResult mockStartEventResult() {
+        StartEventResult startEventResult = new StartEventResult();
+        startEventResult.setCaseDetails(mockCaseDetails());
+        startEventResult.setToken("someToken");
+        startEventResult.setEventId("startAppeal");
+        return startEventResult;
+    }
+
+    private CaseDetails mockCaseDetails() {
+        CaseDetails caseDetails = new CaseDetails();
+        caseDetails.setReference(1L);
+        caseDetails.setCaseTypeId("Asylum");
+        caseDetails.setJurisdiction("IA");
+        caseDetails.setData(new HashMap<String, JsonNode>() {{
+                put("appealOutOfCountry", new TextNode("No"));
+                put("isOutOfCountryEnabled", new TextNode("No"));
+            }
+        });
+        return caseDetails;
+    }
+}