DTSRD-2137. Update SRA Id

src/functionalTest/java/uk/gov/hmcts/reform/professionalapi/ProfessionalInternalUserFunctionalForV2ApiTest.java

@@ -13,7 +13,9 @@
 import uk.gov.hmcts.reform.lib.util.serenity5.SerenityTest;
 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.OrganisationOtherOrgsCreationRequest;
+import uk.gov.hmcts.reform.professionalapi.controller.request.OrganisationSraUpdateRequest;
 import uk.gov.hmcts.reform.professionalapi.controller.request.UsersInOrganisationsByOrganisationIdentifiersRequest;
 import uk.gov.hmcts.reform.professionalapi.controller.response.UsersInOrganisationsByOrganisationIdentifiersResponse;
 import uk.gov.hmcts.reform.professionalapi.domain.OrganisationStatus;
@@ -22,17 +24,23 @@
 import uk.gov.hmcts.reform.professionalapi.util.OrganisationProfileIdConstants;
 import uk.gov.hmcts.reform.professionalapi.util.ToggleEnable;
 
+import java.time.LocalDate;
 import java.time.LocalDateTime;
 import java.util.ArrayList;
 import java.util.HashMap;
+import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map;
 
+import static org.apache.commons.lang.RandomStringUtils.randomAlphabetic;
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
 import static org.junit.jupiter.api.Assertions.assertTrue;
+import static org.springframework.http.HttpStatus.BAD_REQUEST;
 import static org.springframework.http.HttpStatus.NOT_FOUND;
 import static org.springframework.http.HttpStatus.NO_CONTENT;
 import static org.springframework.http.HttpStatus.OK;
+import static uk.gov.hmcts.reform.professionalapi.client.ProfessionalApiClient.createOrganisationRequest;
 import static uk.gov.hmcts.reform.professionalapi.client.ProfessionalApiClient.createOrganisationRequestForV2;
 import static uk.gov.hmcts.reform.professionalapi.util.DateUtils.convertStringToLocalDate;
 import static uk.gov.hmcts.reform.professionalapi.util.DateUtils.generateRandomDate;
@@ -529,4 +537,72 @@ private void verifyOrganisationDetailsBySinceDateV2(Map<String, Object> response
         });
     }
 
-}
+
+    @Test
+    void updateOrganisationSraIdShouldReturnSuccess() {
+        log.info("updateOrganisationSraIdShouldReturnSuccess :: STARTED");
+        String updatedSra = randomAlphabetic(7);
+        String organisationIdentifier = getActiveOrganisationId();
+        //create request to update sraid
+        OrganisationSraUpdateRequest organisationSraUpdateRequest =
+            new OrganisationSraUpdateRequest(updatedSra);
+
+        //call endpoint to update name as 'updatedsraid'
+        Response orgUpdatedSraResponse =  professionalApiClient.updatesOrganisationSra(
+            organisationSraUpdateRequest,organisationIdentifier, OK);
+        assertNotNull(orgUpdatedSraResponse);
+        assertThat(orgUpdatedSraResponse.statusCode()).isEqualTo(200);
+
+        //retrieve saved organisation by id
+        var orgResponse = professionalApiClient.retrieveOrganisationDetailsForV2(organisationIdentifier, hmctsAdmin,
+            OK);
+        assertThat(orgResponse).isNotNull();
+        assertNotNull(orgResponse.get("sraId"));
+        assertThat(orgResponse.get("sraId").toString()).isEqualTo(updatedSra);
+
+        List organisationAttributes = (List)orgResponse.get("orgAttributes");
+        assertThat(organisationAttributes).isNotNull();
+
+        LinkedHashMap<String, Object> attr = (LinkedHashMap)organisationAttributes.get(0);
+        assertThat(attr).isNotNull();
+        assertThat(attr.get("key")).isEqualTo("regulators-0");
+        assertThat(attr.get("value").toString()).isEqualTo(
+            "{\"regulatorType\":\"Solicitor Regulation Authority "
+                + "(SRA)\",\"organisationRegistrationNumber\":\"" + updatedSra + "\"}");
+
+        LocalDateTime updatedDate =  LocalDateTime.parse(orgResponse.get("lastUpdated").toString());
+        assertThat(updatedDate.toLocalDate()).isEqualTo(LocalDate.now());
+
+        log.info("updateOrganisationSraIdShouldReturnSuccess :: END");
+    }
+
+    @Test
+    void updateOrganisationSraIdShouldReturnFailureIfNoSraId() {
+        log.info("updateOrganisationNameShouldReturnFailureIfNoName :: STARTED");
+        String organisationIdentifier = getActiveOrganisationId();
+        OrganisationSraUpdateRequest organisationSraUpdateRequest =
+            new OrganisationSraUpdateRequest("");
+
+        Response orgUpdatedSraIdResponse = professionalApiClient.updatesOrganisationSra(
+            organisationSraUpdateRequest,organisationIdentifier, BAD_REQUEST);
+
+        assertNotNull(orgUpdatedSraIdResponse);
+        assertThat(orgUpdatedSraIdResponse.statusCode()).isEqualTo(400);
+
+        log.info("updateOrganisationNameShouldReturnFailureIfNoName :: END");
+    }
+
+    private String getActiveOrganisationId() {
+        Map<String, Object> response = professionalApiClient.createOrganisation();
+        String organisationIdentifier = (String) response.get("organisationIdentifier");
+        assertThat(organisationIdentifier).isNotEmpty();
+
+        OrganisationCreationRequest organisationCreationRequest = createOrganisationRequest().status("ACTIVE").build();
+
+        professionalApiClient.updateOrganisation(organisationCreationRequest, hmctsAdmin, organisationIdentifier,OK);
+
+        return organisationIdentifier;
+    }
+
+
+}

src/functionalTest/java/uk/gov/hmcts/reform/professionalapi/ProfessionalInternalUserFunctionalTest.java

@@ -47,6 +47,7 @@
 import static org.junit.jupiter.api.Assertions.assertNotNull;
 import static org.junit.jupiter.api.Assertions.assertTrue;
 import static org.springframework.http.HttpStatus.BAD_REQUEST;
+import static org.springframework.http.HttpStatus.CONFLICT;
 import static org.springframework.http.HttpStatus.FORBIDDEN;
 import static org.springframework.http.HttpStatus.NOT_FOUND;
 import static org.springframework.http.HttpStatus.NO_CONTENT;
@@ -245,7 +246,7 @@ public void inviteUserWithDuplicateUserShouldReturnConflict(NewUserCreationReque
         NewUserCreationRequest newUserCreationRequest = professionalApiClient.createNewUserRequest();
         newUserCreationRequest.setEmail(existingUserCreationRequest.getEmail());
         Map<String, Object> newUserResponse = professionalApiClient.addNewUserToAnOrganisation(intActiveOrgId,
-                hmctsAdmin, newUserCreationRequest, HttpStatus.CONFLICT);
+                hmctsAdmin, newUserCreationRequest, CONFLICT);
         assertThat((String) newUserResponse.get("errorDescription")).contains("409 User already exists");
         log.info("inviteUserWithDuplicateUserShouldReturnConflict :: END");
     }
@@ -1231,4 +1232,5 @@ private static List<Map<String, Object>> sortByValue(final List<Map<String, Obje
                 .sorted(Comparator.comparing(map -> (String) map.get(key)))
                 .collect(Collectors.toList());
     }
+
 }

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

@@ -22,6 +22,7 @@
 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.OrganisationOtherOrgsCreationRequest;
+import uk.gov.hmcts.reform.professionalapi.controller.request.OrganisationSraUpdateRequest;
 import uk.gov.hmcts.reform.professionalapi.controller.request.PbaRequest;
 import uk.gov.hmcts.reform.professionalapi.controller.request.UpdatePbaRequest;
 import uk.gov.hmcts.reform.professionalapi.controller.request.UserCreationRequest;
@@ -1315,6 +1316,24 @@ public void updateOrganisation(OrganisationCreationRequest organisationCreationR
             .statusCode(expectedStatus.value());
     }
 
+    public Response updatesOrganisationSra(OrganisationSraUpdateRequest organisationSraUpdateRequest,
+                                                      String organisationIdentifier, HttpStatus expectedStatus) {
+
+        Response response = getMultipleAuthHeadersInternal()
+            .body(organisationSraUpdateRequest)
+            .put("/refdata/internal/v2/organisations/" + organisationIdentifier + "/sra")
+            .andReturn();
+
+        log.info("{}:: Update organisation SraId  response: {}",
+            loggingComponentName, response.getStatusCode());
+
+        response.then()
+            .assertThat()
+            .statusCode(expectedStatus.value());
+
+        return response;
+    }
+
     public void updateOrganisationToReview(String organisationIdentifier, String statusMessage, String role) {
 
         OrganisationCreationRequest organisationCreationRequest = createOrganisationRequest()

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

@@ -0,0 +1,112 @@
+package uk.gov.hmcts.reform.professionalapi;
+
+import org.junit.jupiter.api.Test;
+import uk.gov.hmcts.reform.professionalapi.controller.request.OrganisationSraUpdateRequest;
+import uk.gov.hmcts.reform.professionalapi.util.AuthorizationEnabledIntegrationTest;
+
+import java.time.LocalDate;
+import java.time.LocalDateTime;
+import java.util.LinkedHashMap;
+import java.util.List;
+import java.util.Map;
+
+import static org.apache.commons.lang.RandomStringUtils.randomAlphabetic;
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+
+
+class UpdateOrgSraIntegrationTest extends AuthorizationEnabledIntegrationTest {
+
+
+    @Test
+    void update_sra_of_an_active_organisation_with_prd_admin_role_should_return_200() {
+
+        String orgIdentifier = getOrganisationId();
+        String sraId = randomAlphabetic(7);
+        OrganisationSraUpdateRequest organisationSraUpdateRequest =
+            new OrganisationSraUpdateRequest(sraId);
+        Map<String, Object> orgResponse = professionalReferenceDataClient
+                .updateOrgSra(organisationSraUpdateRequest,
+                    hmctsAdmin,orgIdentifier);
+        assertThat(orgResponse).isNotNull();
+        assertThat(orgResponse.get("http_status")).isEqualTo(200);
+
+        Map<String, Object> responseBody = professionalReferenceDataClient
+            .retrieveSingleOrganisationForV2Api(orgIdentifier,hmctsAdmin);
+        assertThat(responseBody).isNotNull();
+        assertNotNull(responseBody.get("sraId"));
+        assertThat(responseBody.get("sraId").toString()).isEqualTo(sraId);
+
+        List organisationAttributes = (List)responseBody.get("orgAttributes");
+        assertThat(organisationAttributes).isNotNull();
+
+        LinkedHashMap<String, Object> attr = (LinkedHashMap)organisationAttributes.get(0);
+        assertThat(attr).isNotNull();
+        assertThat(attr.get("key")).isEqualTo("regulators-0");
+        assertThat(attr.get("value").toString()).isEqualTo(
+            "{\"regulatorType\":\"Solicitor Regulation Authority "
+                + "(SRA)\",\"organisationRegistrationNumber\":\"" + sraId + "\"}");
+
+        LocalDateTime updatedDate =  LocalDateTime.parse(responseBody.get("lastUpdated").toString());
+        assertThat(updatedDate.toLocalDate()).isEqualTo(LocalDate.now());
+    }
+
+    @Test
+    void update_sra_with_bad_request_should_return_400() {
+        Map<String, Object> updateResponse = professionalReferenceDataClient
+                .updateOrgSra(null,  hmctsAdmin,getOrganisationId());
+
+        assertThat(updateResponse).containsEntry("http_status", "400");
+        assertThat(updateResponse.get("response_body").toString())
+            .contains("Required request body is missing:");
+    }
+
+    @Test
+    void update_sra_with_bad_request_OrgId_missing_should_return_400() {
+        Map<String, Object> updateResponse = professionalReferenceDataClient
+            .updateOrgSra(new OrganisationSraUpdateRequest("some-SraId"),  hmctsAdmin,null);
+
+        assertThat(updateResponse).containsEntry("http_status", "400");
+        assertThat(updateResponse.get("response_body").toString())
+            .contains("The given organisationIdentifier must be 7 Alphanumeric Characters");
+
+    }
+
+    @Test
+    void update_sra_with_invalid_name_should_return_400() {
+
+        OrganisationSraUpdateRequest organisationSraUpdateRequest =
+            new OrganisationSraUpdateRequest("");
+
+        Map<String, Object> updateResponse = professionalReferenceDataClient
+                .updateOrgSra(organisationSraUpdateRequest,
+                    hmctsAdmin,getOrganisationId());
+
+        assertThat(updateResponse).containsEntry("http_status", "400");
+        assertThat(updateResponse.get("response_body").toString()).contains("SRA Id is required");
+
+    }
+
+    @Test
+    void update_sra_with_blank_name_should_return_400() {
+        OrganisationSraUpdateRequest organisationSraUpdateRequest =
+            new OrganisationSraUpdateRequest("    ");
+
+        Map<String, Object> updateResponse = professionalReferenceDataClient
+            .updateOrgSra(organisationSraUpdateRequest,
+                hmctsAdmin,getOrganisationId());
+
+        assertThat(updateResponse).containsEntry("http_status", "400");
+        assertThat(updateResponse.get("response_body").toString()).contains("SRA Id is required");
+
+    }
+
+
+    private String getOrganisationId() {
+        String organisationIdentifier = createOrganisationRequest();
+        updateOrganisation(organisationIdentifier, hmctsAdmin, "ACTIVE");
+
+        return organisationIdentifier;
+    }
+
+}

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

@@ -26,6 +26,7 @@
 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.OrganisationOtherOrgsCreationRequest;
+import uk.gov.hmcts.reform.professionalapi.controller.request.OrganisationSraUpdateRequest;
 import uk.gov.hmcts.reform.professionalapi.controller.request.PbaRequest;
 import uk.gov.hmcts.reform.professionalapi.controller.request.UpdatePbaRequest;
 import uk.gov.hmcts.reform.professionalapi.controller.request.UsersInOrganisationsByOrganisationIdentifiersRequest;
@@ -1022,6 +1023,31 @@ public Map<String, Object> findOrganisationsByUserId(String userId, String role)
         return getResponse(responseEntity);
     }
 
+
+
+    public Map<String, Object> updateOrgSra(
+        OrganisationSraUpdateRequest organisationSraUpdateRequest, String role, String organisationIdentifier) {
+
+        ResponseEntity<Map> responseEntity = null;
+        String urlPath = "http://localhost:" + prdApiPort + APP_INT_V2_BASE_PATH
+            + "/" + organisationIdentifier + "/sra";
+        try {
+            HttpEntity<OrganisationSraUpdateRequest> requestEntity = new HttpEntity<>(organisationSraUpdateRequest,
+                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 +1064,6 @@ public Map<String, Object> retrieveUsersInOrganisationsByOrganisationIdentifiers
         }
         String uriPath = sb.toString();
         return postRequest(uriPath, request, null, null);
+
     }
 }

src/main/java/uk/gov/hmcts/reform/professionalapi/controller/internal/OrganisationInternalController.java

@@ -697,6 +697,7 @@ public ResponseEntity<OrganisationEntityResponse> retrieveOrganisationByUserId(
         return organisationService.retrieveOrganisationByUserId(userId);
     }
 
+
     @Operation(
             summary = "Retrieves Organisations by Organisation Profile IDs",
             description = "**Bearer token not required to access API. Only a valid s2s token**",
@@ -745,4 +746,5 @@ public ResponseEntity<Object> retrieveOrganisationsByProfileIds(
                 .status(HttpStatus.OK)
                 .body(response);
     }
+
 }