FINERACT-2455: e2e test scenarios for near breach management config

Author: MarianaDmytrivBinariks

fineract-e2e-tests-core/src/test/java/org/apache/fineract/test/data/workingcapitalproduct/DefaultWorkingCapitalLoanProduct.java

@@ -24,7 +24,12 @@ public enum DefaultWorkingCapitalLoanProduct implements WorkingCapitalLoanProduc
     WCLP_DISCOUNT, //
     WCLP_DISALLOW_ATTRIBUTES_OVERRIDE, //
     WCLP_DISCOUNT_DISALLOW_ATTRIBUTES_OVERRIDE, //
-    WCLP_FOR_UPDATE; //
+    WCLP_FOR_UPDATE, //
+    WCLP_DELINQUENCY_RESCHEDULE, //
+    WCLP_BREACH, //
+    WCLP_BREACH_NEAR_BREACH, //
+    WCLP_BREACH_DISALLOW_ATTRIBUTES_OVERRIDE, //
+    WCLP_BREACH_NEAR_BREACH_DISALLOW_ATTRIBUTES_OVERRIDE; //
 
     @Override
     public String getName() {

fineract-e2e-tests-core/src/test/java/org/apache/fineract/test/data/workingcapitalproduct/WorkingCapitalBreachCalculationType.java

@@ -0,0 +1,35 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.fineract.test.data.workingcapitalproduct;
+
+import lombok.Getter;
+import lombok.RequiredArgsConstructor;
+
+@Getter
+@RequiredArgsConstructor
+public enum WorkingCapitalBreachCalculationType {
+
+    FLAT(0L, "FLAT", "Flat"), //
+    PERCENTAGE(1L, "PERCENTAGE", "Percentage"); //
+
+    private final Long id;
+    private final String code;
+    private final String value;
+}

fineract-e2e-tests-core/src/test/java/org/apache/fineract/test/data/workingcapitalproduct/WorkingCapitalBreachFrequencyType.java

@@ -0,0 +1,36 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.fineract.test.data.workingcapitalproduct;
+
+import lombok.Getter;
+import lombok.RequiredArgsConstructor;
+
+@Getter
+@RequiredArgsConstructor
+public enum WorkingCapitalBreachFrequencyType {
+
+    DAYS(0L, "DAYS", "Days"), //
+    MONTHS(1L, "MONTHS", "Months"), //
+    YEARS(2L, "YEARS", "Years");
+
+    private final Long id;
+    private final String code;
+    private final String value;
+}

fineract-e2e-tests-core/src/test/java/org/apache/fineract/test/factory/WorkingCapitalRequestFactory.java

@@ -43,12 +43,17 @@
 import org.apache.fineract.client.models.PostWorkingCapitalLoanProductsRequest.AccountingRuleEnum;
 import org.apache.fineract.client.models.PostWorkingCapitalLoanTransactionsRequest;
 import org.apache.fineract.client.models.PutWorkingCapitalLoanProductsProductIdRequest;
+import org.apache.fineract.client.models.WorkingCapitalBreachData;
 import org.apache.fineract.client.models.WorkingCapitalBreachRequest;
+import org.apache.fineract.client.models.WorkingCapitalNearBreachData;
+import org.apache.fineract.client.models.WorkingCapitalNearBreachRequest;
 import org.apache.fineract.test.data.accounttype.AccountTypeResolver;
 import org.apache.fineract.test.data.accounttype.DefaultAccountType;
 import org.apache.fineract.test.data.delinquency.DelinquencyBucketType;
 import org.apache.fineract.test.data.delinquency.DelinquencyFrequencyType;
 import org.apache.fineract.test.data.delinquency.DelinquencyMinimumPayment;
+import org.apache.fineract.test.data.workingcapitalproduct.WorkingCapitalBreachCalculationType;
+import org.apache.fineract.test.data.workingcapitalproduct.WorkingCapitalBreachFrequencyType;
 import org.apache.fineract.test.helper.Utils;
 import org.springframework.stereotype.Component;
 
@@ -63,14 +68,19 @@ public class WorkingCapitalRequestFactory {
     public static final String WCLP_NAME_PREFIX = "WCLP-";
     public static final String WCLP_DESCRIPTION = "Working Capital Loan Product";
     public static final String DEFAULT_WC_DELINQUENCY_BUCKET_NAME = "Default Working Capital delinquency bucket";
+    public static final String DEFAULT_WC_BREACH_NAME = "Default Working Capital breach";
+    public static final String DEFAULT_WC_NEAR_BREACH_NAME = "Default Working Capital near breach";
     public static final String PENALTY = "PENALTY";
     public static final String FEE = "FEE";
     public static final String PRINCIPAL = "PRINCIPAL";
     public static final Integer DEFAULT_WC_BREACH_FREQUENCY = 2;
-    public static final String DEFAULT_WC_BREACH_FREQUENCY_TYPE = "MONTHS";
-    public static final String DEFAULT_WC_BREACH_AMOUNT_CALCULATION_TYPE = "PERCENTAGE";
+    public static final String DEFAULT_WC_BREACH_FREQUENCY_TYPE = WorkingCapitalBreachFrequencyType.MONTHS.getCode();
+    public static final String DEFAULT_WC_BREACH_AMOUNT_CALCULATION_TYPE = WorkingCapitalBreachCalculationType.PERCENTAGE.getCode();
     public static final BigDecimal DEFAULT_WC_BREACH_AMOUNT = new BigDecimal("1.23");
     public static final String DEFAULT_WC_BREACH_NAME_PREFIX = "WCB-";
+    public static final Integer DEFAULT_WC_NEAR_BREACH_FREQUENCY = 12;
+    public static final String DEFAULT_WC_NEAR_BREACH_FREQUENCY_TYPE = WorkingCapitalBreachFrequencyType.DAYS.getCode();
+    public static final BigDecimal DEFAULT_WC_NEAR_BREACH_THRESHOLD = new BigDecimal("70.23");
 
     public PostWorkingCapitalLoanProductsRequest defaultWorkingCapitalLoanProductRequestWithCashAccounting() {
         return defaultWorkingCapitalLoanProductRequest()//
@@ -150,12 +160,34 @@ public PostWorkingCapitalLoanProductsRequest defaultWorkingCapitalLoanProductAll
                 .allowAttributeOverrides(allowAttributeOverrides);
     }
 
+    public PostWorkingCapitalLoanProductsRequest defaultWorkingCapitalLoanProductBreachRequest() {
+        String name = Utils.randomStringGenerator(WCLP_NAME_PREFIX, 10);
+        String shortName = loanProductsRequestFactory.generateShortNameSafely();
+
+        Long breachId = getWCBreachIdByName(DEFAULT_WC_BREACH_NAME);
+        return defaultWorkingCapitalLoanProductAllowAttributesOverrideRequest().name(name)//
+                .shortName(shortName)//
+                .breachId(breachId);
+    }
+
+    public PostWorkingCapitalLoanProductsRequest defaultWorkingCapitalLoanProductBreachNearBreachRequest() {
+        String name = Utils.randomStringGenerator(WCLP_NAME_PREFIX, 10);
+        String shortName = loanProductsRequestFactory.generateShortNameSafely();
+
+        Long breachId = getWCBreachIdByName(DEFAULT_WC_BREACH_NAME);
+        Long nearBreachId = getWCNearBreachIdByName(DEFAULT_WC_NEAR_BREACH_NAME);
+        return defaultWorkingCapitalLoanProductAllowAttributesOverrideRequest().name(name)//
+                .shortName(shortName)//
+                .breachId(breachId) //
+                .nearBreachId(nearBreachId); //
+    }
+
     public PutWorkingCapitalLoanProductsProductIdRequest defaultWorkingCapitalLoanProductRequestUpdate() {
         String name = Utils.randomStringGenerator(WCLP_NAME_PREFIX, 10);
         String shortName = loanProductsRequestFactory.generateShortNameSafely();
 
         PostAllowAttributeOverrides allowAttributeOverrides = new PostAllowAttributeOverrides().delinquencyBucketClassification(true)
-                .discountDefault(false).periodPaymentFrequencyType(false).periodPaymentFrequency(true);
+                .breach(true).discountDefault(false).periodPaymentFrequencyType(false).periodPaymentFrequency(true);
 
         return new PutWorkingCapitalLoanProductsProductIdRequest()//
                 .name(name)//
@@ -173,9 +205,10 @@ public PutWorkingCapitalLoanProductsProductIdRequest defaultWorkingCapitalLoanPr
                 .principal(new BigDecimal(200))//
                 .minPrincipal(new BigDecimal(15))//
                 .maxPrincipal(new BigDecimal(300000))//
-                .discount(new BigDecimal(50)).amortizationType(PutWorkingCapitalLoanProductsProductIdRequest.AmortizationTypeEnum.EIR)//
+                .discount(new BigDecimal(50)) //
+                .amortizationType(PutWorkingCapitalLoanProductsProductIdRequest.AmortizationTypeEnum.EIR)//
                 .npvDayCount(DAYS365.value)//
-                .delinquencyBucketId(null)//
+                .delinquencyBucketId(getWCDelinquencyBucketIdByName(DEFAULT_WC_DELINQUENCY_BUCKET_NAME))//
                 .dateFormat(DATE_FORMAT)//
                 .locale(LOCALE_EN)//
                 .allowAttributeOverrides(allowAttributeOverrides)//
@@ -246,6 +279,14 @@ public WorkingCapitalBreachRequest defaultWorkingCapitalBreachRequest() {
                 .breachAmount(DEFAULT_WC_BREACH_AMOUNT);
     }
 
+    public WorkingCapitalNearBreachRequest defaultWorkingCapitalNearBreachRequest() {
+        return new WorkingCapitalNearBreachRequest() //
+                .nearBreachName("NearBreach-WCL-" + Utils.randomStringGenerator(8)) //
+                .nearBreachFrequency(DEFAULT_WC_NEAR_BREACH_FREQUENCY) //
+                .nearBreachFrequencyType(DEFAULT_WC_NEAR_BREACH_FREQUENCY_TYPE) //
+                .nearBreachThreshold(DEFAULT_WC_NEAR_BREACH_THRESHOLD); //
+    }
+
     public PostWorkingCapitalLoanTransactionsRequest defaultWorkingCapitalLoanRepaymentRequest() {
         return new PostWorkingCapitalLoanTransactionsRequest() //
                 .dateFormat(DATE_FORMAT) //
@@ -262,4 +303,25 @@ private Long getWCDelinquencyBucketIdByName(String bucketName) {
         }
     }
 
+    private Long getWCBreachIdByName(String breachName) {
+        try {
+            List<WorkingCapitalBreachData> breaches = fineractClient.workingCapitalBreaches().retrieveAllWorkingCapitalBreaches(Map.of());
+            return breaches.stream().filter(b -> breachName.equals(b.getName())).findFirst().map(WorkingCapitalBreachData::getId)
+                    .orElseThrow(() -> new RuntimeException("Working Capital Breach not found with name: " + breachName));
+        } catch (Exception e) {
+            throw new RuntimeException("Failed to fetch Working Capital Breacht by name: " + breachName, e);
+        }
+    }
+
+    private Long getWCNearBreachIdByName(String breachName) {
+        try {
+            List<WorkingCapitalNearBreachData> breaches = fineractClient.workingCapitalNearBreaches()
+                    .retrieveAllWorkingCapitalNearBreaches(Map.of());
+            return breaches.stream().filter(b -> breachName.equals(b.getName())).findFirst().map(WorkingCapitalNearBreachData::getId)
+                    .orElseThrow(() -> new RuntimeException("Working Capital Breach not found with name: " + breachName));
+        } catch (Exception e) {
+            throw new RuntimeException("Failed to fetch Working Capital Breacht by name: " + breachName, e);
+        }
+    }
+
 }

fineract-e2e-tests-core/src/test/java/org/apache/fineract/test/helper/ErrorMessageHelper.java

@@ -1067,6 +1067,10 @@ public static String workingCapitalBreachNotFoundFailure(final Long id) {
         return String.format("Working Capital Breach with id %d was not found.", id);
     }
 
+    public static String workingCapitalNearBreachNotFoundFailure(final Long id) {
+        return String.format("Working Capital Near Breach with id %d was not found.", id);
+    }
+
     public static String workingCapitalBreachDuplicateNameFailure(final Long id) {
         return String.format("Data integrity issue with resource: %d", id);
     }
@@ -1095,7 +1099,27 @@ public static String discountDiffDateFromDisburseFailure() {
         return "Failed data validation due to: transaction.date.must.be.equal.disbursement.date.";
     }
 
-    public static String discountOverrideDisallowedByProductFailure() {
+    public static String overrideDisallowedByProductFailure() {
         return "Failed data validation due to: override.not.allowed.by.product.";
     }
+
+    public static String discountExceedCreatedDiscountFailure() {
+        return "Failed data validation due to: amount.cannot.exceed.created.discount.";
+    }
+
+    public static String nearBreachCannotEnableWithoutBreachFailure() {
+        return "Failed data validation due to: cannot.enable.near.breach.without.breach.";
+    }
+
+    public static String nearBreachMustBeLowerThenBreachFailure() {
+        return "Failed data validation due to: near.breach.frequency.must.be.lower.than.breach.frequency.";
+    }
+
+    public static String breachIdNotFoundFailure(long breachId) {
+        return String.format("Working Capital Breach with id %s was not found.", breachId);
+    }
+
+    public static String nearBreachIdNotFoundFailure(long nearBreachId) {
+        return String.format("Working Capital Near Breach with id %s was not found.", nearBreachId);
+    }
 }