DIAC-1475 call Home Office Integration API (#2958)

* Initial change to create PR

* Set home-office-integration-api to Preview

* Now with the correct PR number

* Added event for Home Office appellant information

* Fixed test

* Refactoring of Nilay's CCD service code (amongst other things)

* Almost there

* Unit tests now in place - thanks ChatGPT

* Boosting test coverage

* Increasing test coverage

* More fighting with tests

* Refactor because first design was never going to work

* Adding debugging information

* Adding debugging information

* Trying to call the Home Office integration API using the midEvent instead of appealSubmitted

* Trying to call the Home Office integration API using the midEvent instead of appealSubmitted - Part Deux

* No-op change to trigger the build

* Removing unused event

* Resolving merge conflicts

* Adding suppression that the other team should have added

* Nearly ready for merging - a few bits still to go

* Increasing test coverage

* More coverage

* Bug fix

* Now ready for merging

* Tests now passing again

* Responding to review comments

* Replacing HO API image

---------

Co-authored-by: rajeshthuraiyur <48379561+rajeshthuraiyur@users.noreply.github.com>

Author: ed-graham

README.md

@@ -1,7 +1,7 @@
 
 # ia-case-api
 
-Immigration & Asylum case API
+Immigration & Asylum case API.
 
 ## Purpose
 

src/functionalTest/resources/application-functional.yaml

@@ -29,7 +29,7 @@ core_case_data:
 
 spring:
   cache:
-    cache-names: userInfoCache, accessTokenCache, homeOfficeReferenceDataCache, legalRepATokenCache, caseOfficerTokenCache, adminOfficerTokenCache, homeOfficeApcTokenCache, homeOfficeLartTokenCache, homeOfficePouTokenCache, homeOfficeGenericTokenCache, legalRepShareCaseATokenCache, legalRepOrgSuccessTokenCache, legalRepOrgDeletedTokenCache, judgeTokenCache, citizenTokenCache, systemTokenCache
+    cache-names: userInfoCache, accessTokenCache, legalRepATokenCache, caseOfficerTokenCache, adminOfficerTokenCache, homeOfficeApcTokenCache, homeOfficeLartTokenCache, homeOfficePouTokenCache, homeOfficeGenericTokenCache, legalRepShareCaseATokenCache, legalRepOrgSuccessTokenCache, legalRepOrgDeletedTokenCache, judgeTokenCache, citizenTokenCache, systemTokenCache
     caffeine:
       spec: expireAfterWrite=3600s
   security:

src/functionalTest/resources/scenarios/RIA-3680-home-office-reference-mid-event.json

@@ -38,6 +38,21 @@ public enum AsylumCaseFieldDefinition {
     HOME_OFFICE_DECISION_DATE(
         "homeOfficeDecisionDate", new TypeReference<String>(){}),
 
+    HOME_OFFICE_APPELLANT_API_RESPONSE_STATUS(
+        "homeOfficeAppellantApiResponseStatus", new TypeReference<HomeOfficeApiResponseStatusType>(){}),
+
+    HOME_OFFICE_APPELLANT_CLAIM_DATE(
+        "homeOfficeAppellantClaimDate", new TypeReference<String>(){}),
+
+    HOME_OFFICE_APPELLANT_DECISION_DATE(
+        "homeOfficeAppellantDecisionDate", new TypeReference<String>() {}),
+
+    HOME_OFFICE_APPELLANT_DECISION_LETTER_DATE(
+        "homeOfficeAppellantDecisionLetterDate", new TypeReference<String>(){}),
+
+    HOME_OFFICE_APPELLANTS(
+        "homeOfficeAppellants", new TypeReference<List<IdValue<HomeOfficeAppellant>>>(){}),
+
     APPELLANT_GIVEN_NAMES(
         "appellantGivenNames", new TypeReference<String>(){}),
 

src/functionalTest/resources/scenarios/RIA-3680-home-office-reference-mid-event_edit_appeal.json

@@ -0,0 +1,63 @@
+package uk.gov.hmcts.reform.iacaseapi.domain.entities;
+
+import com.fasterxml.jackson.annotation.JsonEnumDefaultValue;
+import com.fasterxml.jackson.annotation.JsonValue;
+
+public enum HomeOfficeApiResponseStatusType {
+
+    OTHER_APPLICATION_DATA(-3, "otherApplicationData", UserFacingErrorText.SERVER, "The Home Office validation API's response contained data from a different application."),
+    NO_DATA(-2, "noData", UserFacingErrorText.SERVER, "The Home Office validation API's response contained no data."),
+    DID_NOT_RESPOND(-1, "didNotRespond", UserFacingErrorText.SERVER, "The Home Office validation API did not respond."),
+    OK(200, "ok", "", ""),
+    BAD_REQUEST(400, "badRequest", UserFacingErrorText.CLIENT, "The request to the Home Office validation API was not correctly formed."),
+    NOT_AUTHENTICATED(401, "notAuthenticated", UserFacingErrorText.CLIENT, "The request to the Home Office validation API could not be authenticated."),
+    NOT_AUTHORISED(403, "notAuthorised", UserFacingErrorText.CLIENT, "The request to the Home Office validation API was authenticated but not authorised."),
+    NOT_FOUND(404, "notFound", UserFacingErrorText.USER, "No application matching Home Office reference number XYZYX was found."),
+    INTERNAL_SERVER_ERROR(500, "internalServerError", UserFacingErrorText.SERVER, "The Home Office validation API was not available."),
+    NOT_IMPLEMENTED(501, "notImplemented", UserFacingErrorText.SERVER, "The Home Office validation API has not been implemented yet."),
+    BAD_GATEWAY(502, "badGateway", UserFacingErrorText.SERVER, "The Home Office validation API was not available due to a gateway error."),
+    SERVICE_UNAVAILABLE(503, "serviceUnavailable", UserFacingErrorText.SERVER, "The Home Office validation API was not available because the server could not process the request."),
+    GATEWAY_TIMEOUT(504, "gatewayTimeout", UserFacingErrorText.SERVER, "The Home Office validation API was not available due to a gateway time-out."),
+
+    @JsonEnumDefaultValue
+    UNKNOWN(0, "unknown", UserFacingErrorText.CLIENT, "The Home Office validation API did not return the required information for an unknown reason.");
+
+    @JsonValue
+    private final int statusCode;
+    private final String name;
+    private final String userFacingErrorText;
+    private final String hoIntegrationErrorText;
+
+    private static final String REPLACEMENT_STRING = "XYZYX";
+
+    HomeOfficeApiResponseStatusType(int statusCode, String name, String userFacingErrorText, String hoIntegrationErrorText) {
+        this.statusCode = statusCode;
+        this.name = name;
+        this.userFacingErrorText = userFacingErrorText;
+        this.hoIntegrationErrorText = hoIntegrationErrorText;
+    }
+
+    public int getStatusCode() {
+        return statusCode;
+    }
+
+    public String getUserFacingErrorText(String hoReference) {
+        return userFacingErrorText.replace(REPLACEMENT_STRING, hoReference);
+    }
+
+    public String getHoIntegrationErrorText(String hoReference) {
+        return hoIntegrationErrorText.replace(REPLACEMENT_STRING, hoReference);
+    }
+
+    @Override
+    public String toString() {
+        return name;
+    }
+
+    private final class UserFacingErrorText {
+        private static final String CLIENT = "An error occurred.  Please report this to HMCTS.";
+        private static final String SERVER = "An error occurred.  Please try again in 15-20 minutes.  If it occurs again, please report this to HMCTS.";
+        private static final String USER = "The Home Office reference number XYZYX does not match any existing case records in Home Office systems.  Please check your decision letter and try again.";
+    }    
+}
+

src/main/java/uk/gov/hmcts/reform/iacaseapi/domain/entities/AsylumCaseFieldDefinition.java

@@ -0,0 +1,20 @@
+package uk.gov.hmcts.reform.iacaseapi.domain.entities.ccd;
+
+import lombok.Data;
+import uk.gov.hmcts.reform.iacaseapi.domain.entities.ccd.field.YesOrNo;
+
+@Data
+public class HomeOfficeAppellant {
+
+    private String pp;
+    private String familyName;
+    private String givenNames;
+    private String dateOfBirth;
+    private String nationality;
+    private YesOrNo roa;
+    private YesOrNo asylumSupport;
+    private YesOrNo hoFeeWaiver;
+    private String language;
+    private YesOrNo interpreterNeeded;
+
+}

src/main/java/uk/gov/hmcts/reform/iacaseapi/domain/entities/HomeOfficeApiResponseStatusType.java

@@ -20,7 +20,6 @@ public class RetriggerWaTasksForFixedCaseIdHandler implements PreSubmitCallbackH
 
     private final CcdDataService ccdDataService;
 
-
     public RetriggerWaTasksForFixedCaseIdHandler(CcdDataService ccdDataService) {
         this.ccdDataService = ccdDataService;
     }
@@ -56,7 +55,7 @@ public PreSubmitCallbackResponse<AsylumCase> handle(
                 log.info("No valid Case Ids found to re-trigger WA tasks");
                 return new PreSubmitCallbackResponse<>(asylumCase);
             } else {
-                ccdDataService.retriggerWaTasks(trimmedCaseId);
+                ccdDataService.raiseEvent(trimmedCaseId, Event.RE_TRIGGER_WA_TASKS);
                 asylumCase.clear(CASE_ID_LIST);
                 return new PreSubmitCallbackResponse<>(asylumCase);
             }
@@ -70,7 +69,7 @@ public PreSubmitCallbackResponse<AsylumCase> handle(
                         log.info("Invalid Case Id found to re-trigger WA tasks: {}", trimmedCaseId);
                         return;
                     }
-                    ccdDataService.retriggerWaTasks(trimmedCaseId);
+                    ccdDataService.raiseEvent(trimmedCaseId, Event.RE_TRIGGER_WA_TASKS);
                 }
             );
         asylumCase.clear(CASE_ID_LIST);