FINERACT-2494: Standardized Savings API operationIds and synchronized integration tests

Author: Ambika-Sony

fineract-provider/src/main/java/org/apache/fineract/portfolio/savings/api/SavingsAccountsApiResource.java

@@ -122,7 +122,8 @@ public String template(@QueryParam("clientId") @Parameter(description = "clientI
     @Consumes({ MediaType.APPLICATION_JSON })
     @Produces({ MediaType.APPLICATION_JSON })
     @Operation(summary = "List savings applications/accounts", description = "Lists savings applications/accounts\n\n"
-            + "Example Requests:\n" + "\n" + "savingsaccounts\n" + "\n" + "\n" + "savingsaccounts?fields=name")
+            + "Example Requests:\n" + "\n" + "savingsaccounts\n" + "\n" + "\n"
+            + "savingsaccounts?fields=name", operationId = "retrieveAllSavings")
     @ApiResponse(responseCode = "200", description = "OK", content = @Content(schema = @Schema(implementation = SavingsAccountsApiResourceSwagger.GetSavingsAccountsResponse.class)))
     public String retrieveAll(@Context final UriInfo uriInfo,
             @QueryParam("externalId") @Parameter(description = "externalId") final String externalId,
@@ -153,7 +154,7 @@ public String retrieveAll(@Context final UriInfo uriInfo,
             + "Mandatory Fields: clientId or groupId, productId, submittedOnDate\n\n"
             + "Optional Fields: accountNo, externalId, fieldOfficerId\n\n"
             + "Inherited from Product (if not provided): nominalAnnualInterestRate, interestCompoundingPeriodType, interestCalculationType, interestCalculationDaysInYearType, minRequiredOpeningBalance, lockinPeriodFrequency, lockinPeriodFrequencyType, withdrawalFeeForTransfers, allowOverdraft, overdraftLimit, withHoldTax\n\n"
-            + "Additional Mandatory Field if Entity-Datatable Check is enabled for the entity of type Savings: datatables")
+            + "Additional Mandatory Field if Entity-Datatable Check is enabled for the entity of type Savings: datatables", operationId = "submitSavingsApplication")
     @RequestBody(required = true, content = @Content(schema = @Schema(implementation = SavingsAccountsApiResourceSwagger.PostSavingsAccountsRequest.class)))
     @ApiResponse(responseCode = "200", description = "OK", content = @Content(schema = @Schema(implementation = SavingsAccountsApiResourceSwagger.PostSavingsAccountsResponse.class)))
     public String submitApplication(@Parameter(hidden = true) final String apiRequestBodyAsJson) {
@@ -182,6 +183,8 @@ public String submitGSIMApplication(final String apiRequestBodyAsJson) {
     @Path("{accountId}")
     @Consumes({ MediaType.APPLICATION_JSON })
     @Produces({ MediaType.APPLICATION_JSON })
+    @Operation(summary = "Retrieve a savings account", description = "Retrieves a savings account\n\n" + "Example Requests:\n" + "\n"
+            + "savingsaccounts/1", operationId = "retrieveSavingsAccount")
     public SavingsAccountData retrieveOne(@PathParam("accountId") final Long accountId,
             @DefaultValue("false") @QueryParam("staffInSelectedOfficeOnly") final boolean staffInSelectedOfficeOnly,
             @DefaultValue("all") @QueryParam("chargeStatus") final String chargeStatus,
@@ -210,7 +213,7 @@ public SavingsAccountData retrieveOne(@PathParam("externalId") final String exte
             + "Savings application can only be modified when in 'Submitted and pending approval' state. Once the application is approved, the details cannot be changed using this method. Specific api endpoints will be created to allow change of interest detail such as rate, compounding period, posting period etc\n\n"
             + "Modify savings account withhold tax applicability:\n\n"
             + "Savings application's withhold tax can be modified when in 'Active' state. Once the application is activated, can modify the account withhold tax to post tax or vice-versa"
-            + "Showing request/response for 'Modify a savings application'")
+            + "Showing request/response for 'Modify a savings application'", operationId = "updateSavingsAccount")
     @RequestBody(required = true, content = @Content(schema = @Schema(implementation = SavingsAccountsApiResourceSwagger.PutSavingsAccountsAccountIdRequest.class)))
     @ApiResponse(responseCode = "200", description = "OK", content = @Content(schema = @Schema(implementation = SavingsAccountsApiResourceSwagger.PutSavingsAccountsAccountIdResponse.class)))
     public String update(@PathParam("accountId") @Parameter(description = "accountId") final Long accountId,
@@ -341,7 +344,8 @@ public String handleGSIMCommands(@PathParam("parentAccountId") final Long parent
             + "Block Savings Account Debit transactions:\n\n" + "All types of debit operations from Savings account wil be blocked\n\n"
             + "Unblock Savings Account debit transactions:\n\n"
             + "It unblocks the Saving account's debit operations. Now all types of debits can be transacted from Savings account\n\n"
-            + "Showing request/response for 'Unassign Savings Officer'")
+            + "Showing request/response for 'Unassign Savings Officer'", operationId = "handleSavingsCommands")
+
     @RequestBody(required = true, content = @Content(schema = @Schema(implementation = SavingsAccountsApiResourceSwagger.PostSavingsAccountsAccountIdRequest.class)))
     @ApiResponse(responseCode = "200", description = "OK", content = @Content(schema = @Schema(implementation = SavingsAccountsApiResourceSwagger.PostSavingsAccountsAccountIdResponse.class)))
     public String handleCommands(@PathParam("accountId") @Parameter(description = "accountId") final Long accountId,
@@ -404,7 +408,7 @@ private boolean is(final String commandParam, final String commandValue) {
     @Path("{accountId}")
     @Consumes({ MediaType.APPLICATION_JSON })
     @Produces({ MediaType.APPLICATION_JSON })
-    @Operation(summary = "Delete a savings application", description = "At present we support hard delete of savings application so long as its in 'Submitted and pending approval' state. One the application is moves past this state, it is not possible to do a 'hard' delete of the application or the account. An API endpoint will be added to close/de-activate the savings account.")
+    @Operation(summary = "Delete a savings application", description = "At present we support hard delete of savings application so long as its in 'Submitted and pending approval' state. One the application is moves past this state, it is not possible to do a 'hard' delete of the application or the account. An API endpoint will be added to close/de-activate the savings account.", operationId = "deleteSavingsAccount")
     @ApiResponse(responseCode = "200", description = "OK", content = @Content(schema = @Schema(implementation = SavingsAccountsApiResourceSwagger.DeleteSavingsAccountsAccountIdResponse.class)))
     public String delete(@PathParam("accountId") @Parameter(description = "accountId") final Long accountId) {
 

integration-tests/src/test/java/org/apache/fineract/integrationtests/SavingsAccountsExternalIdTest.java

@@ -18,7 +18,11 @@
  */
 package org.apache.fineract.integrationtests;
 
+import static org.assertj.core.api.Assertions.assertThat;
+
 import java.math.BigDecimal;
+import java.time.LocalDate;
+import java.time.ZoneId;
 import java.time.format.DateTimeFormatter;
 import java.util.UUID;
 import org.apache.fineract.client.models.DeleteSavingsAccountsAccountIdResponse;
@@ -33,21 +37,25 @@
 import org.apache.fineract.integrationtests.client.IntegrationTest;
 import org.apache.fineract.integrationtests.common.Utils;
 import org.apache.fineract.integrationtests.common.savings.SavingsTestLifecycleExtension;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.MethodOrderer;
 import org.junit.jupiter.api.Order;
 import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.TestMethodOrder;
 import org.junit.jupiter.api.extension.ExtendWith;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import retrofit2.Response;
 
 @ExtendWith({ SavingsTestLifecycleExtension.class })
+@TestMethodOrder(MethodOrderer.OrderAnnotation.class)
 public class SavingsAccountsExternalIdTest extends IntegrationTest {
 
     private static final Logger LOG = LoggerFactory.getLogger(SavingsAccountsExternalIdTest.class);
-    public static final String EXTERNAL_ID = UUID.randomUUID().toString();
+    private static String externalId;
     private final String dateFormat = "dd MMMM yyyy";
     private final String locale = "en";
-    private final String formattedDate = Utils.getLocalDateOfTenant().format(DateTimeFormatter.ofPattern(dateFormat));
+    private final String formattedDate = LocalDate.now(ZoneId.systemDefault()).minusDays(5).format(DateTimeFormatter.ofPattern(dateFormat));
 
     @Test
     @Order(1)
@@ -58,10 +66,10 @@ void submitSavingsAccountsApplication() {
         request.setProductId(1L);
         request.setLocale(locale);
         request.setDateFormat(dateFormat);
-        request.setSubmittedOnDate(formattedDate);
+        request.submittedOnDate(formattedDate);
         request.setExternalId(EXTERNAL_ID);
 
-        Response<PostSavingsAccountsResponse> response = okR(fineractClient().savingsAccounts.submitApplication2(request));
+        Response<PostSavingsAccountsResponse> response = okR(fineractClient().savingsAccounts.submitSavingsApplication(request));
 
         assertThat(response.isSuccessful()).isTrue();
         assertThat(response.body()).isNotNull();
@@ -74,8 +82,8 @@ void updateSavingsAccountWithExternalId() {
         PutSavingsAccountsAccountIdRequest request = new PutSavingsAccountsAccountIdRequest();
         request.setLocale(locale);
         request.setNominalAnnualInterestRate(5.999);
-        Response<PutSavingsAccountsAccountIdResponse> response = okR(fineractClient().savingsAccounts.update22(EXTERNAL_ID, request, ""));
-
+        Response<PutSavingsAccountsAccountIdResponse> response = okR(
+                fineractClient().savingsAccounts.updateSavingsAccount(externalId, request, ""));
         assertThat(response.isSuccessful()).isTrue();
         assertThat(response.body()).isNotNull();
     }
@@ -89,7 +97,7 @@ void approveSavingsAccount() {
         request.setLocale(locale);
         request.setApprovedOnDate(formattedDate);
         Response<PostSavingsAccountsAccountIdResponse> response = okR(
-                fineractClient().savingsAccounts.handleCommands7(EXTERNAL_ID, request, "approve"));
+                fineractClient().savingsAccounts.handleSavingsCommands(externalId, request, "approve"));
 
         assertThat(response.isSuccessful()).isTrue();
         assertThat(response.body()).isNotNull();
@@ -103,7 +111,8 @@ void retrieveSavingsAccountWithExternalId() {
         request.dateFormat(dateFormat);
         request.setLocale(locale);
         request.setActivatedOnDate(formattedDate);
-        Response<SavingsAccountData> response = okR(fineractClient().savingsAccounts.retrieveOne27(EXTERNAL_ID, false, null, "all"));
+        Response<SavingsAccountData> response = okR(
+                fineractClient().savingsAccounts.retrieveSavingsAccount(externalId, false, null, "all"));
 
         assertThat(response.isSuccessful()).isTrue();
         assertThat(response.body()).isNotNull();
@@ -117,7 +126,7 @@ void undoApprovalSavingsAccountWithExternalId() {
         LOG.info("------------------------------ UNDO APPROVAL SAVINGS ACCOUNT ---------------------------------------");
         PostSavingsAccountsAccountIdRequest request = new PostSavingsAccountsAccountIdRequest();
         Response<PostSavingsAccountsAccountIdResponse> response = okR(
-                fineractClient().savingsAccounts.handleCommands7(EXTERNAL_ID, request, "undoapproval"));
+                fineractClient().savingsAccounts.handleSavingsCommands(externalId, request, "undoapproval"));
 
         assertThat(response.isSuccessful()).isTrue();
         assertThat(response.body()).isNotNull();
@@ -131,7 +140,8 @@ void retrieveSavingsAccountWithExternalIdSecondTime() {
         request.dateFormat(dateFormat);
         request.setLocale(locale);
         request.setActivatedOnDate(formattedDate);
-        Response<SavingsAccountData> response = okR(fineractClient().savingsAccounts.retrieveOne27(EXTERNAL_ID, false, null, "all"));
+        Response<SavingsAccountData> response = okR(
+                fineractClient().savingsAccounts.retrieveSavingsAccount(externalId, false, null, "all"));
 
         assertThat(response.isSuccessful()).isTrue();
         assertThat(response.body()).isNotNull();
@@ -146,7 +156,7 @@ void deleteSavingsAccountWithExternalId() {
         request.dateFormat(dateFormat);
         request.setLocale(locale);
         request.setActivatedOnDate(formattedDate);
-        Response<DeleteSavingsAccountsAccountIdResponse> response = okR(fineractClient().savingsAccounts.delete20(EXTERNAL_ID));
+        Response<DeleteSavingsAccountsAccountIdResponse> response = okR(fineractClient().savingsAccounts.deleteSavingsAccount(externalId));
 
         assertThat(response.isSuccessful()).isTrue();
         assertThat(response.body()).isNotNull();
@@ -161,7 +171,7 @@ void retrieveSavingsAccountWithExternalIdThirdTime() {
         request.setLocale(locale);
         request.setActivatedOnDate(formattedDate);
         Response<SavingsAccountData> response = Calls
-                .executeU(fineractClient().savingsAccounts.retrieveOne27(EXTERNAL_ID, false, null, "all"));
+                .executeU(fineractClient().savingsAccounts.retrieveSavingsAccount(externalId, false, null, "all"));
 
         assertThat(response.raw().code()).isEqualTo(404);
     }