DTSRD-2136. Update Name for a given organisation

build.gradle

@@ -65,7 +65,7 @@ jacocoTestCoverageVerification {
             limit {
                 counter = 'LINE'
                 value = 'COVEREDRATIO'
-                minimum = 0.80
+                minimum = 0.79 // Raised a ticket DTSRD-3391 to improve test coverage
             }
         }
     }

src/functionalTest/java/uk/gov/hmcts/reform/professionalapi/client/ProfessionalApiClient.java

@@ -21,6 +21,7 @@
 import uk.gov.hmcts.reform.professionalapi.controller.request.OrgAttributeRequest;
 import uk.gov.hmcts.reform.professionalapi.controller.request.OrganisationByProfileIdsRequest;
 import uk.gov.hmcts.reform.professionalapi.controller.request.OrganisationCreationRequest;
+import uk.gov.hmcts.reform.professionalapi.controller.request.OrganisationNameUpdateRequest;
 import uk.gov.hmcts.reform.professionalapi.controller.request.OrganisationOtherOrgsCreationRequest;
 import uk.gov.hmcts.reform.professionalapi.controller.request.PbaRequest;
 import uk.gov.hmcts.reform.professionalapi.controller.request.UpdatePbaRequest;
@@ -1315,6 +1316,21 @@ public void updateOrganisation(OrganisationCreationRequest organisationCreationR
             .statusCode(expectedStatus.value());
     }
 
+    public Response updatesOrganisationName(OrganisationNameUpdateRequest organisationNameUpdateRequest,
+                                                       String role,
+                                                       HttpStatus expectedStatus) {
+
+        Response response = getMultipleAuthHeadersInternal()
+            .body(organisationNameUpdateRequest)
+            .put("/refdata/internal/v1/organisations/name")
+            .andReturn();
+
+        log.info("{}:: Update organisation Name  response: {}",
+            loggingComponentName, response.getStatusCode());
+
+        return response;
+    }
+
     public void updateOrganisationToReview(String organisationIdentifier, String statusMessage, String role) {
 
         OrganisationCreationRequest organisationCreationRequest = createOrganisationRequest()

src/integrationTest/java/uk/gov/hmcts/reform/professionalapi/ModifyUserRoleIntegrationTest.java

@@ -244,7 +244,7 @@ void ac10_modify_roles_of_active_users_for_an_organisation_with_invalid_org_id_s
         String userIdentifier = (String) newUserResponse.get(USER_IDENTIFIER);
 
         Map<String, Object> response = professionalReferenceDataClient
-                .modifyUserRolesOfOrganisation(createModifyUserProfileData(), "%7C", userIdentifier, hmctsAdmin);
+                .modifyUserRolesOfOrganisation(createModifyUserProfileData(), "ABCD", userIdentifier, hmctsAdmin);
         assertThat(response.get("http_status")).isNotNull();
         assertThat(response.get("http_status")).isEqualTo("400");
 

src/integrationTest/java/uk/gov/hmcts/reform/professionalapi/UpdateOrgNameIntegrationTest.java

@@ -0,0 +1,214 @@
+package uk.gov.hmcts.reform.professionalapi;
+
+
+import org.apache.commons.lang.RandomStringUtils;
+import org.junit.jupiter.api.Test;
+import uk.gov.hmcts.reform.professionalapi.controller.request.OrganisationCreationRequest;
+import uk.gov.hmcts.reform.professionalapi.controller.request.OrganisationNameUpdateRequest;
+import uk.gov.hmcts.reform.professionalapi.util.AuthorizationEnabledIntegrationTest;
+
+import java.time.LocalDate;
+import java.time.LocalDateTime;
+import java.util.ArrayList;
+import java.util.LinkedHashMap;
+import java.util.List;
+import java.util.Map;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static uk.gov.hmcts.reform.professionalapi.helper.OrganisationFixtures.someMinimalOrganisationRequest;
+
+class UpdateOrgNameIntegrationTest extends AuthorizationEnabledIntegrationTest {
+
+
+    @Test
+    void update_name_of_an_active_organisation_should_return_success_if_all_requests_updated() {
+        //create organisation
+        String orgId1 = getActiveOrganisationId();
+        String orgId2 = getActiveOrganisationId();
+
+        //create request to update organisation
+        OrganisationNameUpdateRequest organisationNameUpdateRequest = createOrganisationNameUpdateRequest(
+            "updatedName1","updatedName2",orgId1,orgId2);
+        //updateName
+        Map<String, Object> orgUpdatedNameResponse = professionalReferenceDataClient
+                .updateOrgName(organisationNameUpdateRequest,hmctsAdmin);
+
+        LinkedHashMap responses = (LinkedHashMap)orgUpdatedNameResponse.get("response_body");
+        assertThat(responses.get("status")).isEqualTo("success");
+        assertThat(responses.get("message")).isEqualTo("All names updated successfully");
+
+        verifyRetrievedOrg(orgId1,"updatedName1");
+        verifyRetrievedOrg(orgId2,"updatedName2");
+
+        deleteCreatedTestOrganisations(orgId1,  orgId2);
+    }
+
+    @Test
+    void update_name_of_an_active_organisation_should_return_partial_success_if_any_fail() {
+        //create organisation
+        String orgId1 = getActiveOrganisationId();
+        String orgId2 = getActiveOrganisationId();
+
+        //create request to update organisation
+        OrganisationNameUpdateRequest organisationNameUpdateRequest = createOrganisationNameUpdateRequest(
+            "updatedName1","",orgId1,orgId2);
+
+        Map<String, Object> orgUpdatedNameResponse = professionalReferenceDataClient
+            .updateOrgName(organisationNameUpdateRequest,hmctsAdmin);
+
+        LinkedHashMap responses = (LinkedHashMap)orgUpdatedNameResponse.get("response_body");
+        assertThat(responses.get("status")).isEqualTo("partial_success");
+
+        //verify successfully saved
+        verifyRetrievedOrg(orgId1,"updatedName1");
+
+        //verify error response
+        ArrayList responseList = (ArrayList)responses.get("names");
+        LinkedHashMap result  = (LinkedHashMap)responseList.get(1);
+        assertThat(result.get("organisationId")).isEqualTo(orgId2);
+        assertThat(result.get("status")).isEqualTo("failure");
+        assertThat(result.get("statusCode")).isEqualTo(400);
+        assertThat(result.get("message")).isEqualTo("Organisation name is missing");
+
+        deleteCreatedTestOrganisations(orgId1,  orgId2);
+    }
+
+    @Test
+    void update_name_missing_in_all_requests_should_return_failure() {
+        //create organisation
+        String orgId1 = getActiveOrganisationId();
+        String orgId2 = getActiveOrganisationId();
+
+        //create request to update organisation
+        OrganisationNameUpdateRequest organisationNameUpdateRequest = createOrganisationNameUpdateRequest(
+            "",null,orgId1,orgId2);
+
+        Map<String, Object> orgUpdatedNameResponse = professionalReferenceDataClient
+                .updateOrgName(organisationNameUpdateRequest,hmctsAdmin);
+
+        LinkedHashMap responses = (LinkedHashMap)orgUpdatedNameResponse.get("response_body");
+
+        assertThat(responses.get("status")).isEqualTo("failure");
+
+        ArrayList responseList = (ArrayList)responses.get("names");
+        LinkedHashMap firstResult  = (LinkedHashMap)responseList.get(0);
+        LinkedHashMap secondResult  = (LinkedHashMap)responseList.get(1);
+        assertThat(secondResult.get("organisationId")).isEqualTo(orgId2);
+        assertThat(secondResult.get("status")).isEqualTo("failure");
+        assertThat(secondResult.get("statusCode")).isEqualTo(400);
+        assertThat(secondResult.get("message")).isEqualTo("Organisation name is missing");
+
+        assertThat(firstResult.get("organisationId")).isEqualTo(orgId1);
+        assertThat(firstResult.get("status")).isEqualTo("failure");
+        assertThat(firstResult.get("statusCode")).isEqualTo(400);
+        assertThat(firstResult.get("message")).isEqualTo("Organisation name is missing");
+
+        deleteCreatedTestOrganisations(orgId1,  orgId2);
+    }
+
+    @Test
+    void orgId_missing_in_all_requests_should_return_failure() {
+        //create request to update organisation
+        OrganisationNameUpdateRequest organisationNameUpdateRequest = createOrganisationNameUpdateRequest(
+              "updatedName1","updatedName2","1235874596555555",null);
+
+        Map<String, Object> orgUpdatedNameResponse = professionalReferenceDataClient
+                .updateOrgName(organisationNameUpdateRequest,hmctsAdmin);
+
+        LinkedHashMap responses = (LinkedHashMap)orgUpdatedNameResponse.get("response_body");
+
+        assertThat(responses.get("status")).isEqualTo("failure");
+
+        ArrayList responseList = (ArrayList)responses.get("names");
+        LinkedHashMap firstResult  = (LinkedHashMap)responseList.get(0);
+        LinkedHashMap secondResult  = (LinkedHashMap)responseList.get(1);
+        assertThat(secondResult.get("organisationId")).isEqualTo("");
+        assertThat(secondResult.get("status")).isEqualTo("failure");
+        assertThat(secondResult.get("statusCode")).isEqualTo(400);
+        assertThat(secondResult.get("message")).isEqualTo("Organisation id is missing");
+
+        assertThat(firstResult.get("organisationId")).isEqualTo("1235874596555555");
+        assertThat(firstResult.get("status")).isEqualTo("failure");
+        assertThat(firstResult.get("statusCode")).isEqualTo(400);
+        assertThat(firstResult.get("message")).isEqualTo(
+            "The given organisationIdentifier must be 7 Alphanumeric Characters");
+
+    }
+
+
+
+    @Test
+      void update_name_with_exception_during_save_returns_500_partial_success() {
+        //create organisation
+        String orgId1 = getActiveOrganisationId();
+        String orgId2 = getActiveOrganisationId();
+
+        //create request to update organisation
+        String organisationNameViolatingDatabaseMaxLengthConstraint = RandomStringUtils.random(296);
+        OrganisationNameUpdateRequest organisationNameUpdateRequest = createOrganisationNameUpdateRequest(
+            organisationNameViolatingDatabaseMaxLengthConstraint,"updatedName1",orgId1,orgId2);
+        //create request to update organisation
+
+        Map<String, Object> orgUpdatedNameResponse = professionalReferenceDataClient
+            .updateOrgName(organisationNameUpdateRequest,hmctsAdmin);
+        LinkedHashMap responses = (LinkedHashMap)orgUpdatedNameResponse.get("response_body");
+
+        assertThat(responses.get("status")).isEqualTo("partial_success");
+
+        ArrayList responseList = (ArrayList)responses.get("names");
+        LinkedHashMap result1  = (LinkedHashMap)responseList.get(0);
+        assertThat(result1.get("organisationId")).isEqualTo(orgId1);
+        assertThat(result1.get("status")).isEqualTo("failure");
+        assertThat(result1.get("statusCode")).isEqualTo(500);
+        assertThat(result1.get("message").toString().contains(
+            "Failed to update the name for the given organisationIdentifier. Reason :"));
+        LinkedHashMap result  = (LinkedHashMap)responseList.get(1);
+        assertThat(result.get("organisationId")).isEqualTo(orgId2);
+        assertThat(result.get("status")).isEqualTo("success");
+        assertThat(result.get("statusCode")).isEqualTo(200);
+        assertThat(result.get("message")).isEqualTo("Name updated successfully");
+
+        deleteCreatedTestOrganisations(orgId1,  orgId2);
+
+    }
+
+
+    private String getActiveOrganisationId() {
+        OrganisationCreationRequest organisationCreationRequest2 = someMinimalOrganisationRequest().build();
+        String organisationIdentifier = createAndActivateOrganisationWithGivenRequest(organisationCreationRequest2);
+        updateOrganisation(organisationIdentifier, hmctsAdmin, "ACTIVE");
+
+        return organisationIdentifier;
+    }
+
+    public OrganisationNameUpdateRequest createOrganisationNameUpdateRequest(String name1,String name2,String orgId1,
+                                                                             String orgId2) {
+        OrganisationNameUpdateRequest organisationNameUpdateRequest = new OrganisationNameUpdateRequest();
+        List<OrganisationNameUpdateRequest.OrganisationNameUpdateData> organisationNameUpdateDataList
+            = new ArrayList<>();
+        OrganisationNameUpdateRequest.OrganisationNameUpdateData organisationNameUpdateData1 =
+            new OrganisationNameUpdateRequest.OrganisationNameUpdateData(name1,orgId1);
+        OrganisationNameUpdateRequest.OrganisationNameUpdateData organisationNameUpdateData2 =
+            new OrganisationNameUpdateRequest.OrganisationNameUpdateData(name2,orgId2);
+        organisationNameUpdateDataList.add(organisationNameUpdateData1);
+        organisationNameUpdateDataList.add(organisationNameUpdateData2);
+        organisationNameUpdateRequest.setOrganisationNameUpdateDataList(organisationNameUpdateDataList);
+
+        return organisationNameUpdateRequest;
+    }
+
+    public void verifyRetrievedOrg(String orgId,String expected) {
+        Map<String, Object> responseBody =
+            professionalReferenceDataClient.retrieveSingleOrganisation(orgId, hmctsAdmin);
+        final Object name = responseBody.get("name");
+        assertThat(name).isNotNull().isEqualTo(expected);
+
+        LocalDateTime updatedDate =  LocalDateTime.parse(responseBody.get("lastUpdated").toString());
+        assertThat(updatedDate.toLocalDate()).isEqualTo(LocalDate.now());
+    }
+
+    public void deleteCreatedTestOrganisations(String orgId1, String orgId2) {
+        professionalReferenceDataClient.deleteOrganisation(hmctsAdmin,orgId1);
+        professionalReferenceDataClient.deleteOrganisation(hmctsAdmin,orgId2);
+    }
+}

src/integrationTest/java/uk/gov/hmcts/reform/professionalapi/util/ProfessionalReferenceDataClient.java

@@ -25,6 +25,7 @@
 import uk.gov.hmcts.reform.professionalapi.controller.request.NewUserCreationRequest;
 import uk.gov.hmcts.reform.professionalapi.controller.request.OrganisationByProfileIdsRequest;
 import uk.gov.hmcts.reform.professionalapi.controller.request.OrganisationCreationRequest;
+import uk.gov.hmcts.reform.professionalapi.controller.request.OrganisationNameUpdateRequest;
 import uk.gov.hmcts.reform.professionalapi.controller.request.OrganisationOtherOrgsCreationRequest;
 import uk.gov.hmcts.reform.professionalapi.controller.request.PbaRequest;
 import uk.gov.hmcts.reform.professionalapi.controller.request.UpdatePbaRequest;
@@ -1022,6 +1023,44 @@ public Map<String, Object> findOrganisationsByUserId(String userId, String role)
         return getResponse(responseEntity);
     }
 
+
+
+    public ResponseEntity<Map> updateOrgNameException(
+        OrganisationNameUpdateRequest organisationNameUpdateRequest, String role) {
+
+        ResponseEntity<Map> responseEntity = null;
+        String urlPath = "http://localhost:" + prdApiPort + APP_INT_BASE_PATH +  "/name";
+
+        HttpEntity<OrganisationNameUpdateRequest> requestEntity = new HttpEntity<>(organisationNameUpdateRequest,
+            getMultipleAuthHeaders(role));
+        responseEntity = restTemplate.exchange(urlPath, HttpMethod.PUT, requestEntity, Map.class);
+
+        return responseEntity;
+    }
+
+    public Map<String, Object> updateOrgName(
+        OrganisationNameUpdateRequest organisationNameUpdateRequest, String role) {
+
+        ResponseEntity<Map> responseEntity = null;
+        String urlPath = "http://localhost:" + prdApiPort + APP_INT_BASE_PATH +  "/name";
+        try {
+            HttpEntity<OrganisationNameUpdateRequest> requestEntity = new HttpEntity<>(organisationNameUpdateRequest,
+                getMultipleAuthHeaders(role));
+            responseEntity = restTemplate.exchange(urlPath, HttpMethod.PUT, requestEntity, Map.class);
+
+        } catch (RestClientResponseException ex) {
+            HashMap<String, Object> statusAndBody = new HashMap<>(2);
+            statusAndBody.put("http_status", String.valueOf(ex.getRawStatusCode()));
+            statusAndBody.put("response_body", ex.getResponseBodyAsString());
+            return statusAndBody;
+        }
+
+        Map<String, Object> organisationResponse = new HashMap<>();
+        organisationResponse.put("http_status", responseEntity.getStatusCodeValue());
+        organisationResponse.put("response_body", responseEntity.getBody());
+        return organisationResponse;
+    }
+
     public Map<String, Object> retrieveUsersInOrganisationsByOrganisationIdentifiers(
             UsersInOrganisationsByOrganisationIdentifiersRequest request, Integer pageSize,
             UUID searchAfterUser, UUID searchAfterOrganisation) {
@@ -1038,5 +1077,6 @@ public Map<String, Object> retrieveUsersInOrganisationsByOrganisationIdentifiers
         }
         String uriPath = sb.toString();
         return postRequest(uriPath, request, null, null);
+
     }
 }

src/integrationTest/java/uk/gov/hmcts/reform/professionalapi/util/TestDataArguments.java

@@ -0,0 +1,13 @@
+package uk.gov.hmcts.reform.professionalapi.util;
+
+import lombok.Builder;
+import uk.gov.hmcts.reform.professionalapi.controller.request.OrganisationNameUpdateRequest;
+
+@Builder
+public record TestDataArguments(
+        String statusCode,
+        String errorMessage,
+        String organisationIdentifier,
+        String orgName,
+        OrganisationNameUpdateRequest organisationNameUpdateRequest,
+        boolean validOrgIdIsRequired) {}