FINERACT-2398: Re-amortization:- Preview Schedule API during re-amortization

fineract-e2e-tests-core/src/test/java/org/apache/fineract/test/stepdef/loan/LoanReAgingStepDef.java

@@ -413,7 +413,7 @@ public class LoanReAgingStepDef extends AbstractStepDef {
         }
     }
 
-    @Then("Loan Repayment schedule preview has the following data in Total row:")
+    @Then("Loan Re-Aged Repayment schedule preview has the following data in Total row:")
     public void loanRepaymentScheduleAmountCheck(DataTable table) {
         List<List<String>> data = table.asLists();
         List<String> header = data.get(0);

fineract-e2e-tests-core/src/test/java/org/apache/fineract/test/stepdef/loan/LoanReAmortizationStepDef.java

@@ -19,16 +19,28 @@
 package org.apache.fineract.test.stepdef.loan;
 
 import static org.apache.fineract.client.feign.util.FeignCalls.ok;
+import static org.assertj.core.api.Assertions.assertThat;
 
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
+import io.cucumber.datatable.DataTable;
 import io.cucumber.java.en.Then;
 import io.cucumber.java.en.When;
-import java.io.IOException;
+import java.math.BigDecimal;
+import java.math.RoundingMode;
+import java.time.format.DateTimeFormatter;
+import java.util.ArrayList;
+import java.util.List;
 import java.util.Map;
+import java.util.stream.Collectors;
 import org.apache.fineract.client.feign.FineractFeignClient;
+import org.apache.fineract.client.models.LoanScheduleData;
+import org.apache.fineract.client.models.LoanSchedulePeriodData;
 import org.apache.fineract.client.models.PostLoansLoanIdTransactionsRequest;
 import org.apache.fineract.client.models.PostLoansLoanIdTransactionsResponse;
 import org.apache.fineract.client.models.PostLoansResponse;
 import org.apache.fineract.test.factory.LoanRequestFactory;
+import org.apache.fineract.test.helper.ErrorMessageHelper;
+import org.apache.fineract.test.helper.Utils;
 import org.apache.fineract.test.messaging.EventAssertion;
 import org.apache.fineract.test.messaging.event.loan.LoanReAmortizeEvent;
 import org.apache.fineract.test.stepdef.AbstractStepDef;
@@ -37,6 +49,9 @@ import org.springframework.beans.factory.annotation.Autowired;
 
 public class LoanReAmortizationStepDef extends AbstractStepDef {
 
+    private static final String DATE_FORMAT = "dd MMMM yyyy";
+    private static final DateTimeFormatter FORMATTER = DateTimeFormatter.ofPattern(DATE_FORMAT);
+
     @Autowired
     private FineractFeignClient fineractClient;
 
@@ -44,7 +59,7 @@ public class LoanReAmortizationStepDef extends AbstractStepDef {
     private EventAssertion eventAssertion;
 
     @When("When Admin creates a Loan re-amortization transaction on current business date")
-    public void createLoanReAmortization() throws IOException {
+    public void createLoanReAmortization() {
         PostLoansResponse loanResponse = testContext().get(TestContextKey.LOAN_CREATE_RESPONSE);
         long loanId = loanResponse.getLoanId();
 
@@ -56,7 +71,7 @@ public class LoanReAmortizationStepDef extends AbstractStepDef {
     }
 
     @When("When Admin creates a Loan re-amortization transaction on current business date by loan external ID")
-    public void createLoanReAmortizationByLoanExternalId() throws IOException {
+    public void createLoanReAmortizationByLoanExternalId() {
         PostLoansResponse loanResponse = testContext().get(TestContextKey.LOAN_CREATE_RESPONSE);
         String loanExternalId = loanResponse.getResourceExternalId();
 
@@ -68,7 +83,7 @@ public class LoanReAmortizationStepDef extends AbstractStepDef {
     }
 
     @When("When Admin undo Loan re-amortization transaction on current business date")
-    public void undoLoanReAmortization() throws IOException {
+    public void undoLoanReAmortization() {
         PostLoansResponse loanResponse = testContext().get(TestContextKey.LOAN_CREATE_RESPONSE);
         long loanId = loanResponse.getLoanId();
 
@@ -84,4 +99,157 @@ public class LoanReAmortizationStepDef extends AbstractStepDef {
 
         eventAssertion.assertEventRaised(LoanReAmortizeEvent.class, loanId);
     }
+
+    @When("Admin creates a Loan re-amortization preview by Loan external ID with the following data:")
+    public void createReAmortizedPreviewByLoanExternalId(final DataTable table) {
+        final LoanScheduleData response = reAmortizedPreviewByLoanExternalId(table);
+        testContext().set(TestContextKey.LOAN_REAMORTIZATION_PREVIEW_RESPONSE, response);
+    }
+
+    @Then("Loan Re-Amortization Repayment schedule preview has the following data in Total row:")
+    public void loanRepaymentDScheduleAmountCheck(final DataTable table) {
+        final List<List<String>> data = table.asLists();
+        final List<String> header = data.get(0);
+        final List<String> expectedValues = data.get(1);
+        final LoanScheduleData scheduleResponse = testContext().get(TestContextKey.LOAN_REAMORTIZATION_PREVIEW_RESPONSE);
+        validateRepaymentScheduleTotal(header, scheduleResponse, expectedValues);
+    }
+
+    @Then("Loan Re-Amortization Repayment schedule preview has {int} periods, with the following data for periods:")
+    public void loanRepaymentSchedulePreviewPeriodsCheck(final int linesExpected, final DataTable table) {
+        final LoanScheduleData scheduleResponse = testContext().get(TestContextKey.LOAN_REAMORTIZATION_PREVIEW_RESPONSE);
+        final List<LoanSchedulePeriodData> repaymentPeriods = scheduleResponse.getPeriods();
+
+        final PostLoansResponse loanResponse = testContext().get(TestContextKey.LOAN_CREATE_RESPONSE);
+        final String resourceId = String.valueOf(loanResponse.getLoanId());
+        final List<List<String>> data = table.asLists();
+        final int nrLines = data.size();
+        final int linesActual = (int) repaymentPeriods.stream().filter(r -> r.getPeriod() != null).count();
+
+        for (int i = 1; i < nrLines; i++) {
+            List<String> expectedValues = data.get(i);
+            String dueDateExpected = expectedValues.get(2);
+
+            List<List<String>> actualValuesList = repaymentPeriods.stream()
+                    .filter(r -> dueDateExpected.equals(FORMATTER.format(r.getDueDate())))
+                    .map(r -> fetchValuesOfRepaymentSchedule(data.get(0), r)).collect(Collectors.toList());
+
+            boolean containsExpectedValues = actualValuesList.stream().anyMatch(actualValues -> actualValues.equals(expectedValues));
+            assertThat(containsExpectedValues)
+                    .as(ErrorMessageHelper.wrongValueInLineInRepaymentSchedule(resourceId, i, actualValuesList, expectedValues)).isTrue();
+
+            assertThat(linesActual).as(ErrorMessageHelper.wrongNumberOfLinesInRepaymentSchedule(resourceId, linesActual, linesExpected))
+                    .isEqualTo(linesExpected);
+        }
+    }
+
+    private LoanScheduleData reAmortizedPreviewByLoanExternalId(final DataTable table) {
+        final PostLoansResponse loanResponse = testContext().get(TestContextKey.LOAN_CREATE_RESPONSE);
+        final String loanExternalId = loanResponse.getResourceExternalId();
+
+        final List<String> data = table.asLists().get(1);
+        final String reAmortizationInterestHandling = data.getFirst();
+
+        final Map<String, Object> queryParams = Map.of("reAmortizationInterestHandling", reAmortizationInterestHandling);
+        return ok(() -> fineractClient.loanTransactions().previewReAmortizationSchedule1(loanExternalId, queryParams));
+    }
+
+    @SuppressFBWarnings("SF_SWITCH_NO_DEFAULT")
+    private void validateRepaymentScheduleTotal(final List<String> header, final LoanScheduleData repaymentSchedule,
+            final List<String> expectedAmounts) {
+        Double paidActual = 0.0;
+        final List<LoanSchedulePeriodData> periods = repaymentSchedule.getPeriods();
+        for (LoanSchedulePeriodData period : periods) {
+            if (null != period.getTotalPaidForPeriod()) {
+                paidActual += period.getTotalPaidForPeriod().doubleValue();
+            }
+        }
+        final BigDecimal paidActualBd = new BigDecimal(paidActual).setScale(2, RoundingMode.HALF_DOWN);
+
+        for (int i = 0; i < header.size(); i++) {
+            final String headerName = header.get(i);
+            final String expectedValue = expectedAmounts.get(i);
+            switch (headerName) {
+                case "Principal due" -> assertThat(repaymentSchedule.getTotalPrincipalExpected())//
+                        .as(ErrorMessageHelper.wrongAmountInRepaymentSchedulePrincipal(
+                                repaymentSchedule.getTotalPrincipalExpected().doubleValue(), Double.valueOf(expectedValue)))//
+                        .isEqualByComparingTo(new BigDecimal(expectedValue));//
+                case "Interest" -> assertThat(repaymentSchedule.getTotalInterestCharged())//
+                        .as(ErrorMessageHelper.wrongAmountInRepaymentScheduleInterest(
+                                repaymentSchedule.getTotalInterestCharged().doubleValue(), Double.valueOf(expectedValue)))//
+                        .isEqualByComparingTo(new BigDecimal(expectedValue));//
+                case "Fees" -> assertThat(repaymentSchedule.getTotalFeeChargesCharged())//
+                        .as(ErrorMessageHelper.wrongAmountInRepaymentScheduleFees(
+                                repaymentSchedule.getTotalFeeChargesCharged().doubleValue(), Double.valueOf(expectedValue)))//
+                        .isEqualByComparingTo(new BigDecimal(expectedValue));//
+                case "Penalties" -> assertThat(repaymentSchedule.getTotalPenaltyChargesCharged())//
+                        .as(ErrorMessageHelper.wrongAmountInRepaymentSchedulePenalties(
+                                repaymentSchedule.getTotalPenaltyChargesCharged().doubleValue(), Double.valueOf(expectedValue)))//
+                        .isEqualByComparingTo(new BigDecimal(expectedValue));//
+                case "Due" -> assertThat(repaymentSchedule.getTotalRepaymentExpected())//
+                        .as(ErrorMessageHelper.wrongAmountInRepaymentScheduleDue(
+                                repaymentSchedule.getTotalRepaymentExpected().doubleValue(), Double.valueOf(expectedValue)))//
+                        .isEqualByComparingTo(new BigDecimal(expectedValue));//
+                case "Paid" -> assertThat(paidActualBd)//
+                        .as(ErrorMessageHelper.wrongAmountInRepaymentSchedulePaid(paidActualBd.doubleValue(),
+                                Double.valueOf(expectedValue)))//
+                        .isEqualByComparingTo(new BigDecimal(expectedValue));//
+                case "In advance" -> assertThat(repaymentSchedule.getTotalPaidInAdvance())//
+                        .as(ErrorMessageHelper.wrongAmountInRepaymentScheduleInAdvance(
+                                repaymentSchedule.getTotalPaidInAdvance().doubleValue(), Double.valueOf(expectedValue)))//
+                        .isEqualByComparingTo(new BigDecimal(expectedValue));//
+                case "Late" -> assertThat(repaymentSchedule.getTotalPaidLate())//
+                        .as(ErrorMessageHelper.wrongAmountInRepaymentScheduleLate(repaymentSchedule.getTotalPaidLate().doubleValue(),
+                                Double.valueOf(expectedValue)))//
+                        .isEqualByComparingTo(new BigDecimal(expectedValue));//
+                case "Waived" -> assertThat(repaymentSchedule.getTotalWaived())//
+                        .as(ErrorMessageHelper.wrongAmountInRepaymentScheduleWaived(repaymentSchedule.getTotalWaived().doubleValue(),
+                                Double.valueOf(expectedValue)))//
+                        .isEqualByComparingTo(new BigDecimal(expectedValue));//
+                case "Outstanding" -> assertThat(repaymentSchedule.getTotalOutstanding())//
+                        .as(ErrorMessageHelper.wrongAmountInRepaymentScheduleOutstanding(
+                                repaymentSchedule.getTotalOutstanding().doubleValue(), Double.valueOf(expectedValue)))//
+                        .isEqualByComparingTo(new BigDecimal(expectedValue));//
+            }
+        }
+    }
+
+    private List<String> fetchValuesOfRepaymentSchedule(final List<String> header, final LoanSchedulePeriodData repaymentPeriod) {
+        final List<String> actualValues = new ArrayList<>();
+        for (String headerName : header) {
+            switch (headerName) {
+                case "Nr" -> actualValues.add(repaymentPeriod.getPeriod() == null ? null : String.valueOf(repaymentPeriod.getPeriod()));
+                case "Days" ->
+                    actualValues.add(repaymentPeriod.getDaysInPeriod() == null ? null : String.valueOf(repaymentPeriod.getDaysInPeriod()));
+                case "Date" ->
+                    actualValues.add(repaymentPeriod.getDueDate() == null ? null : FORMATTER.format(repaymentPeriod.getDueDate()));
+                case "Paid date" -> actualValues.add(repaymentPeriod.getObligationsMetOnDate() == null ? null
+                        : FORMATTER.format(repaymentPeriod.getObligationsMetOnDate()));
+                case "Balance of loan" -> actualValues.add(repaymentPeriod.getPrincipalLoanBalanceOutstanding() == null ? null
+                        : new Utils.DoubleFormatter(repaymentPeriod.getPrincipalLoanBalanceOutstanding().doubleValue()).format());
+                case "Principal due" -> actualValues.add(repaymentPeriod.getPrincipalDue() == null ? null
+                        : new Utils.DoubleFormatter(repaymentPeriod.getPrincipalDue().doubleValue()).format());
+                case "Interest" -> actualValues.add(repaymentPeriod.getInterestDue() == null ? null
+                        : new Utils.DoubleFormatter(repaymentPeriod.getInterestDue().doubleValue()).format());
+                case "Fees" -> actualValues.add(repaymentPeriod.getFeeChargesDue() == null ? null
+                        : new Utils.DoubleFormatter(repaymentPeriod.getFeeChargesDue().doubleValue()).format());
+                case "Penalties" -> actualValues.add(repaymentPeriod.getPenaltyChargesDue() == null ? null
+                        : new Utils.DoubleFormatter(repaymentPeriod.getPenaltyChargesDue().doubleValue()).format());
+                case "Due" -> actualValues.add(repaymentPeriod.getTotalDueForPeriod() == null ? null
+                        : new Utils.DoubleFormatter(repaymentPeriod.getTotalDueForPeriod().doubleValue()).format());
+                case "Paid" -> actualValues.add(repaymentPeriod.getTotalPaidForPeriod() == null ? null
+                        : new Utils.DoubleFormatter(repaymentPeriod.getTotalPaidForPeriod().doubleValue()).format());
+                case "In advance" -> actualValues.add(repaymentPeriod.getTotalPaidInAdvanceForPeriod() == null ? null
+                        : new Utils.DoubleFormatter(repaymentPeriod.getTotalPaidInAdvanceForPeriod().doubleValue()).format());
+                case "Late" -> actualValues.add(repaymentPeriod.getTotalPaidLateForPeriod() == null ? null
+                        : new Utils.DoubleFormatter(repaymentPeriod.getTotalPaidLateForPeriod().doubleValue()).format());
+                case "Waived" -> actualValues.add(repaymentPeriod.getTotalWaivedForPeriod() == null ? null
+                        : new Utils.DoubleFormatter(repaymentPeriod.getTotalWaivedForPeriod().doubleValue()).format());
+                case "Outstanding" -> actualValues.add(repaymentPeriod.getTotalOutstandingForPeriod() == null ? null
+                        : new Utils.DoubleFormatter(repaymentPeriod.getTotalOutstandingForPeriod().doubleValue()).format());
+                default -> throw new IllegalStateException(String.format("Header name %s cannot be found", headerName));
+            }
+        }
+        return actualValues;
+    }
 }

fineract-e2e-tests-core/src/test/java/org/apache/fineract/test/support/TestContextKey.java

@@ -52,6 +52,7 @@ public abstract class TestContextKey {
     public static final String LOAN_REAGING_UNDO_RESPONSE = "loanReAgingUndoResponse";
     public static final String LOAN_REAGING_PREVIEW_RESPONSE = "loanReAgingPreviewResponse";
     public static final String LOAN_REAMORTIZATION_RESPONSE = "loanReAmortizationResponse";
+    public static final String LOAN_REAMORTIZATION_PREVIEW_RESPONSE = "loanReAmortizationPreviewResponse";
     public static final String LOAN_REAMORTIZATION_UNDO_RESPONSE = "loanReAmortizationUndoResponse";
     public static final String BUSINESS_DATE_RESPONSE = "businessDateResponse";
     public static final String DEFAULT_LOAN_PRODUCT_CREATE_RESPONSE_LP1 = "loanProductCreateResponseLP1";