Skip to content

Commit

Permalink
Merge pull request apache#4042 from alberto-art3ch/enhancement/loan_a…
Browse files Browse the repository at this point in the history 
…ccount_mandatory_parameters

FINERACT-2081: Validation error in mandatory loan account parameters
  • Loading branch information
@kjozsa
kjozsa committed Sep 25, 2024
2 parents 31c9079 + cc3a492 commit 7ed0a82
Show file tree
Hide file tree
Showing 6 changed files with 178 additions and 43 deletions.
8 changes: 8 additions & 0 deletions ...core/src/main/java/org/apache/fineract/infrastructure/core/data/DataValidatorBuilder.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1056,4 +1056,12 @@ public void throwValidationErrors() throws PlatformApiDataValidationException {
throw new PlatformApiDataValidationException(dataValidationErrors);
}
}

public static ApiParameterError buildValidationParameterApiError(final String resource, final String parameterName,
final String errorCode, final String errorMessage, final Object... defaultUserMessageArgs) {
final String validationErrorCode = "validation.msg." + resource + "." + parameterName + errorCode;
String defaultEnglishMessage = "The parameter `" + parameterName + "` " + errorMessage;
return ApiParameterError.parameterError(validationErrorCode, defaultEnglishMessage, parameterName, defaultUserMessageArgs);
}

}
4 changes: 2 additions & 2 deletions fineract-e2e-tests-core/src/test/java/org/apache/fineract/test/stepdef/loan/LoanStepDef.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -513,8 +513,8 @@ public void createFullyCustomizedLoanFixedLength(int fixedLength, DataTable tabl

@When("Admin creates a fully customized loan with Advanced payment allocation and with product no Advanced payment allocation set results an error:")
public void createFullyCustomizedLoanNoAdvancedPaymentError(DataTable table) throws IOException {
int errorCodeExpected = 400;
String errorMessageExpected = "Failed data validation due to: strategy.cannot.be.advanced.payment.allocation.if.not.configured.";
int errorCodeExpected = 403;
String errorMessageExpected = "Loan transaction processing strategy cannot be Advanced Payment Allocation Strategy if it's not configured on loan product";

List<List<String>> data = table.asLists();
List<String> loanData = data.get(1);
Expand Down
113 changes: 76 additions & 37 deletions ...ava/org/apache/fineract/portfolio/loanaccount/serialization/LoanApplicationValidator.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -248,6 +248,9 @@ private void validateForCreate(final JsonElement element) {
boolean isMeetingMandatoryForJLGLoans = configurationDomainService.isMeetingMandatoryForJLGLoans();

final Long productId = this.fromApiJsonHelper.extractLongNamed(LoanApiConstants.productIdParameterName, element);
if (productId == null) {
throwMandatoryParameterError(LoanApiConstants.productIdParameterName);
}
final LoanProduct loanProduct = this.loanProductRepository.findById(productId)
.orElseThrow(() -> new LoanProductNotFoundException(productId));

Expand All @@ -257,7 +260,6 @@ private void validateForCreate(final JsonElement element) {
final Group group = groupId != null ? this.groupRepository.findOneWithNotFoundDetection(groupId) : null;

validateClientOrGroup(client, group, productId);

validateOrThrow("loan", baseDataValidator -> {
final String loanTypeStr = this.fromApiJsonHelper.extractStringNamed(LoanApiConstants.loanTypeParameterName, element);
baseDataValidator.reset().parameter(LoanApiConstants.loanTypeParameterName).value(loanTypeStr).notNull();
Expand Down Expand Up @@ -394,7 +396,6 @@ private void validateForCreate(final JsonElement element) {
baseDataValidator.reset().parameter(LoanApiConstants.interestCalculationPeriodTypeParameterName)
.value(interestCalculationPeriodType).notNull().inMinMaxRange(0, 1);

boolean isInterestBearing = false;
if (loanProduct.isLinkedToFloatingInterestRate()) {
if (isEqualAmortization) {
throw new EqualAmortizationUnsupportedFeatureException("floating.interest.rate", "floating interest rate");
Expand Down Expand Up @@ -430,7 +431,6 @@ private void validateForCreate(final JsonElement element) {
baseDataValidator.reset().parameter(interestRateDifferentialParameterName).value(interestRateDifferential).notNull()
.zeroOrPositiveAmount().inMinAndMaxAmountRange(loanProduct.getFloatingRates().getMinDifferentialLendingRate(),
loanProduct.getFloatingRates().getMaxDifferentialLendingRate());
isInterestBearing = true;
} else {

if (this.fromApiJsonHelper.parameterExists(LoanApiConstants.isFloatingInterestRate, element)) {
Expand All @@ -448,7 +448,6 @@ private void validateForCreate(final JsonElement element) {
.extractBigDecimalWithLocaleNamed(LoanApiConstants.interestRatePerPeriodParameterName, element);
baseDataValidator.reset().parameter(LoanApiConstants.interestRatePerPeriodParameterName).value(interestRatePerPeriod)
.notNull().zeroOrPositiveAmount();
isInterestBearing = interestRatePerPeriod != null && interestRatePerPeriod.compareTo(BigDecimal.ZERO) > 0;
}

final Integer amortizationType = this.fromApiJsonHelper
Expand Down Expand Up @@ -511,7 +510,6 @@ private void validateForCreate(final JsonElement element) {

final LocalDate submittedOnDate = this.fromApiJsonHelper.extractLocalDateNamed(LoanApiConstants.submittedOnDateParameterName,
element);

baseDataValidator.reset().parameter(LoanApiConstants.submittedOnDateParameterName).value(submittedOnDate).notNull();

if (this.fromApiJsonHelper.parameterExists(LoanApiConstants.submittedOnNoteParameterName, element)) {
Expand All @@ -523,8 +521,8 @@ private void validateForCreate(final JsonElement element) {

final String transactionProcessingStrategy = this.fromApiJsonHelper
.extractStringNamed(LoanApiConstants.transactionProcessingStrategyCodeParameterName, element);

validateTransactionProcessingStrategy(transactionProcessingStrategy, loanProduct, baseDataValidator);
baseDataValidator.reset().parameter(LoanApiConstants.transactionProcessingStrategyCodeParameterName)
.value(transactionProcessingStrategy).notNull();

validateLinkedSavingsAccount(element, baseDataValidator);

Expand Down Expand Up @@ -727,9 +725,6 @@ private void validateForCreate(final JsonElement element) {

validateBorrowerCycle(element, loanProduct, clientId, groupId, baseDataValidator);

loanProductDataValidator.fixedLengthValidations(transactionProcessingStrategy, isInterestBearing, numberOfRepayments,
repaymentEvery, element, baseDataValidator);

// Validate If the externalId is already registered
final String externalIdStr = this.fromApiJsonHelper.extractStringNamed("externalId", element);
ExternalId externalId = ExternalIdFactory.produce(externalIdStr);
Expand All @@ -744,12 +739,11 @@ private void validateForCreate(final JsonElement element) {
loanScheduleValidator.validateDownPaymentAttribute(loanProduct.getLoanProductRelatedDetail().isEnableDownPayment(), element);

checkForProductMixRestrictions(element);
validateSubmittedOnDate(element, null, null, loanProduct);
validateDisbursementDetails(loanProduct, element);
validateCollateral(element);
// validate if disbursement date is a holiday or a non-working day
validateDisbursementDateIsOnNonWorkingDay(expectedDisbursementDate);
Long officeId = client != null ? client.getOffice().getId() : group.getOffice().getId();
Long officeId = resolveOfficeId(client, group);
validateDisbursementDateIsOnHoliday(expectedDisbursementDate, officeId);
final Integer recurringMoratoriumOnPrincipalPeriods = this.fromApiJsonHelper
.extractIntegerWithLocaleNamed("recurringMoratoriumOnPrincipalPeriods", element);
Expand All @@ -759,6 +753,32 @@ private void validateForCreate(final JsonElement element) {
graceOnInterestPayment, graceOnInterestCharged, recurringMoratoriumOnPrincipalPeriods, baseDataValidator);
}
});

validateSubmittedOnDate(element, null, null, loanProduct);

final String transactionProcessingStrategy = this.fromApiJsonHelper
.extractStringNamed(LoanApiConstants.transactionProcessingStrategyCodeParameterName, element);
validateTransactionProcessingStrategy(transactionProcessingStrategy, loanProduct);

fixedLengthValidations(element);
}

private void fixedLengthValidations(final JsonElement element) {
validateOrThrow("loan", baseDataValidator -> {
boolean isInterestBearing = false;
final String transactionProcessingStrategy = this.fromApiJsonHelper
.extractStringNamed(LoanApiConstants.transactionProcessingStrategyCodeParameterName, element);
final Integer numberOfRepayments = this.fromApiJsonHelper
.extractIntegerWithLocaleNamed(LoanApiConstants.numberOfRepaymentsParameterName, element);
final Integer repaymentEvery = this.fromApiJsonHelper
.extractIntegerWithLocaleNamed(LoanApiConstants.repaymentEveryParameterName, element);

final BigDecimal interestRatePerPeriod = this.fromApiJsonHelper
.extractBigDecimalWithLocaleNamed(LoanApiConstants.interestRatePerPeriodParameterName, element);
isInterestBearing = interestRatePerPeriod != null && interestRatePerPeriod.compareTo(BigDecimal.ZERO) > 0;
loanProductDataValidator.fixedLengthValidations(transactionProcessingStrategy, isInterestBearing, numberOfRepayments,
repaymentEvery, element, baseDataValidator);
});
}

private void validateBorrowerCycle(JsonElement element, LoanProduct loanProduct, Long clientId, Long groupId,
Expand Down Expand Up @@ -928,7 +948,7 @@ public void validateForModify(final JsonCommand command, final Loan loan) {
baseDataValidator.reset().parameter(LoanApiConstants.transactionProcessingStrategyCodeParameterName)
.value(transactionProcessingStrategy).notNull();
// Validating whether the processor is existing
validateTransactionProcessingStrategy(transactionProcessingStrategy, loanProduct, baseDataValidator);
validateTransactionProcessingStrategy(transactionProcessingStrategy, loanProduct);
}

if (!AdvancedPaymentScheduleTransactionProcessor.ADVANCED_PAYMENT_ALLOCATION_STRATEGY
Expand Down Expand Up @@ -1410,7 +1430,7 @@ public void validateForModify(final JsonCommand command, final Loan loan) {

// validate if disbursement date is a holiday or a non-working day
validateDisbursementDateIsOnNonWorkingDay(expectedDisbursementDate);
Long officeId = client != null ? client.getOffice().getId() : group.getOffice().getId();
final Long officeId = resolveOfficeId(client, group);
validateDisbursementDateIsOnHoliday(expectedDisbursementDate, officeId);

Integer recurringMoratoriumOnPrincipalPeriods = loan.getLoanProductRelatedDetail().getRecurringMoratoriumOnPrincipalPeriods();
Expand All @@ -1426,24 +1446,30 @@ public void validateForModify(final JsonCommand command, final Loan loan) {
}

private void validateClientOrGroup(Client client, Group group, Long productId) {
if (client != null) {
officeSpecificLoanProductValidation(productId, client.getOffice().getId());
if (client.isNotActive()) {
throw new ClientNotActiveException(client.getId());
}
}
if (group != null) {
officeSpecificLoanProductValidation(productId, group.getOffice().getId());
if (group.isNotActive()) {
throw new GroupNotActiveException(group.getId());
}
}
validateOrThrow("loan", baseDataValidator -> {
if (client == null && group == null) {
baseDataValidator.reset().parameter(LoanApiConstants.clientIdParameterName).value(client).notNull();
} else {
if (client != null) {
officeSpecificLoanProductValidation(productId, client.getOffice().getId());
if (client.isNotActive()) {
throw new ClientNotActiveException(client.getId());
}
}
if (group != null) {
officeSpecificLoanProductValidation(productId, group.getOffice().getId());
if (group.isNotActive()) {
throw new GroupNotActiveException(group.getId());
}
}

if (client != null && group != null) {
if (!group.hasClientAsMember(client)) {
throw new ClientNotInGroupException(client.getId(), group.getId());
if (client != null && group != null) {
if (!group.hasClientAsMember(client)) {
throw new ClientNotInGroupException(client.getId(), group.getId());
}
}
}
}
});
}

private void validateDisbursementDetails(LoanProduct loanProduct, JsonElement element) {
Expand Down Expand Up @@ -1747,18 +1773,13 @@ private void officeSpecificLoanProductValidation(final Long productId, final Lon
}
}

private void validateTransactionProcessingStrategy(final String transactionProcessingStrategy, final LoanProduct loanProduct,
final DataValidatorBuilder baseDataValidator) {

baseDataValidator.reset().parameter(LoanApiConstants.transactionProcessingStrategyCodeParameterName)
.value(transactionProcessingStrategy).notNull();
private void validateTransactionProcessingStrategy(final String transactionProcessingStrategy, final LoanProduct loanProduct) {

// TODO: Review exceptions
if (!AdvancedPaymentScheduleTransactionProcessor.ADVANCED_PAYMENT_ALLOCATION_STRATEGY
.equals(loanProduct.getTransactionProcessingStrategyCode())
&& AdvancedPaymentScheduleTransactionProcessor.ADVANCED_PAYMENT_ALLOCATION_STRATEGY.equals(transactionProcessingStrategy)) {
baseDataValidator.reset().parameter(LoanApiConstants.transactionProcessingStrategyCodeParameterName).failWithCode(
"strategy.cannot.be.advanced.payment.allocation.if.not.configured",
throw new GeneralPlatformDomainRuleException("strategy.cannot.be.advanced.payment.allocation.if.not.configured",
"Loan transaction processing strategy cannot be Advanced Payment Allocation Strategy if it's not configured on loan product");
} else {
// PROGRESSIVE: Repayment strategy MUST be only "advanced payment allocation"
Expand Down Expand Up @@ -2127,4 +2148,22 @@ public static void validateOrThrow(String resource, Consumer<DataValidatorBuilde
dataValidationErrors);
}
}

public Long resolveOfficeId(Client client, Group group) {
if (client != null) {
return client.getOffice().getId();
}
if (group != null) {
return group.getOffice().getId();
}
return null;
}

private void throwMandatoryParameterError(final String parameterName) {
final List<ApiParameterError> dataValidationErrors = new ArrayList<>();
dataValidationErrors
.add(DataValidatorBuilder.buildValidationParameterApiError("loans", parameterName, ".cannot.be.blank", "is mandatory.", 0));
throw new PlatformApiDataValidationException("validation.msg.validation.errors.exist", "Validation errors exist.",
dataValidationErrors);
}
}
1 change: 0 additions & 1 deletion ...ava/org/apache/fineract/portfolio/loanproduct/serialization/LoanProductDataValidator.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -574,7 +574,6 @@ public void validateForCreate(final JsonCommand command) {
}

// Fixed Length validation

fixedLengthValidations(transactionProcessingStrategyCode, isInterestBearing, numberOfRepayments, repaymentEvery, element,
baseDataValidator);

Expand Down
5 changes: 2 additions & 3 deletions ...tests/src/test/java/org/apache/fineract/integrationtests/LoanApplicationApprovalTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ public void loanApplicationShouldFailIfTransactionProcessingStrategyIsAdvancedPa
log.info("----------------------------------LOAN PRODUCT CREATED WITH ID------------------------------------------- {}",
loanProductId);

loanTransactionHelper = new LoanTransactionHelper(this.requestSpec, this.responseSpecForStatusCode400);
loanTransactionHelper = new LoanTransactionHelper(this.requestSpec, this.responseSpecForStatusCode403);
final String loanApplicationJSON = new LoanApplicationTestBuilder().withPrincipal("1000").withLoanTermFrequency("1")
.withLoanTermFrequencyAsMonths().withNumberOfRepayments("1").withRepaymentEveryAfter("1")
.withRepaymentFrequencyTypeAsMonths().withInterestRatePerPeriod("0").withInterestTypeAsFlatBalance()
Expand All @@ -169,8 +169,7 @@ public void loanApplicationShouldFailIfTransactionProcessingStrategyIsAdvancedPa
.withRepaymentStrategy(AdvancedPaymentScheduleTransactionProcessor.ADVANCED_PAYMENT_ALLOCATION_STRATEGY)
.build(clientId.toString(), loanProductId.toString(), null);
List<HashMap> error = (List<HashMap>) loanTransactionHelper.createLoanAccount(loanApplicationJSON, CommonConstants.RESPONSE_ERROR);
assertEquals(
"validation.msg.loan.transactionProcessingStrategyCode.strategy.cannot.be.advanced.payment.allocation.if.not.configured",
assertEquals("strategy.cannot.be.advanced.payment.allocation.if.not.configured",
error.get(0).get(CommonConstants.RESPONSE_ERROR_MESSAGE_CODE));

}
Expand Down
Loading

0 comments on commit 7ed0a82

Please sign in to comment.