FINERACT-2070: COB business step order

fineract-e2e-tests-core/src/test/java/org/apache/fineract/test/api/ApiProperties.java

@@ -36,4 +36,6 @@ public class ApiProperties {
     private String strongPassword;
     @Value("${fineract-test.api.tenant-id}")
     private String tenantId;
+    @Value("${fineract-test.client-read-timeout}")
+    private long readTimeout;
 }

fineract-e2e-tests-core/src/test/java/org/apache/fineract/test/api/FineractClientConfiguration.java

@@ -18,6 +18,7 @@
  */
 package org.apache.fineract.test.api;
 
+import java.time.Duration;
 import lombok.extern.slf4j.Slf4j;
 import org.apache.fineract.client.util.FineractClient;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -37,11 +38,10 @@ public class FineractClientConfiguration {
         String username = apiProperties.getUsername();
         String password = apiProperties.getPassword();
         String tenantId = apiProperties.getTenantId();
-
+        long readTimeout = apiProperties.getReadTimeout();
         String apiBaseUrl = baseUrl + "/fineract-provider/api/";
-
         log.info("Using base URL '{}'", apiBaseUrl);
-
-        return FineractClient.builder().basicAuth(username, password).tenant(tenantId).baseURL(apiBaseUrl).insecure(true).build();
+        return FineractClient.builder().readTimeout(Duration.ofSeconds(readTimeout)).basicAuth(username, password).tenant(tenantId)
+                .baseURL(apiBaseUrl).insecure(true).build();
     }
 }

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

@@ -21,29 +21,57 @@ package org.apache.fineract.test.helper;
 import java.io.IOException;
 import java.util.Comparator;
 import java.util.List;
+import java.util.stream.Collectors;
 import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
 import org.apache.fineract.client.models.BusinessStep;
 import org.apache.fineract.client.models.GetBusinessStepConfigResponse;
+import org.apache.fineract.client.models.UpdateBusinessStepConfigRequest;
 import org.apache.fineract.client.services.BusinessStepConfigurationApi;
-import org.apache.fineract.test.support.TestContext;
-import org.apache.fineract.test.support.TestContextKey;
 import org.springframework.stereotype.Component;
 import retrofit2.Response;
 
 @RequiredArgsConstructor
 @Component
+@Slf4j
 public class WorkFlowJobHelper {
 
     private static final String WORKFLOW_NAME_LOAN_CLOSE_OF_BUSINESS = "LOAN_CLOSE_OF_BUSINESS";
 
     private final BusinessStepConfigurationApi businessStepConfigurationApi;
 
-    public void saveOriginalCOBWorkflowJobBusinessStepList() throws IOException {
-        Response<GetBusinessStepConfigResponse> businessStepConfigResponse = businessStepConfigurationApi
+    public void setWorkflowJobs() throws IOException {
+        List<BusinessStep> businessSteps = List.of(new BusinessStep().stepName("APPLY_CHARGE_TO_OVERDUE_LOANS").order(1L), //
+                new BusinessStep().stepName("LOAN_DELINQUENCY_CLASSIFICATION").order(2L), //
+                new BusinessStep().stepName("CHECK_LOAN_REPAYMENT_DUE").order(3L), //
+                new BusinessStep().stepName("CHECK_LOAN_REPAYMENT_OVERDUE").order(4L), //
+                new BusinessStep().stepName("CHECK_DUE_INSTALLMENTS").order(5L), //
+                new BusinessStep().stepName("UPDATE_LOAN_ARREARS_AGING").order(6L), //
+                new BusinessStep().stepName("ADD_PERIODIC_ACCRUAL_ENTRIES").order(7L), //
+                new BusinessStep().stepName("ACCRUAL_ACTIVITY_POSTING").order(8L), //
+                new BusinessStep().stepName("LOAN_INTEREST_RECALCULATION").order(9L), //
+                new BusinessStep().stepName("EXTERNAL_ASSET_OWNER_TRANSFER").order(10L)//
+        );
+        UpdateBusinessStepConfigRequest request = new UpdateBusinessStepConfigRequest().businessSteps(businessSteps);
+        Response<Void> response = businessStepConfigurationApi.updateJobBusinessStepConfig(WORKFLOW_NAME_LOAN_CLOSE_OF_BUSINESS, request)
+                .execute();
+        ErrorHelper.checkSuccessfulApiCall(response);
+        // --- log changes ---
+        logChanges();
+    }
+
+    private void logChanges() throws IOException {
+        // --- log changes ---
+        Response<GetBusinessStepConfigResponse> changesResponse = businessStepConfigurationApi
                 .retrieveAllConfiguredBusinessStep(WORKFLOW_NAME_LOAN_CLOSE_OF_BUSINESS).execute();
-        ErrorHelper.checkSuccessfulApiCall(businessStepConfigResponse);
-        List<BusinessStep> businessSteps = businessStepConfigResponse.body().getBusinessSteps();
-        businessSteps.sort(Comparator.comparingLong(BusinessStep::getOrder));
-        TestContext.GLOBAL.set(TestContextKey.ORIGINAL_COB_WORKFLOW_JOB_BUSINESS_STEP_LIST, businessSteps);
+        List<BusinessStep> businessStepsChanged = changesResponse.body().getBusinessSteps();
+        List<String> changes = businessStepsChanged//
+                .stream()//
+                .sorted(Comparator.comparingLong(BusinessStep::getOrder))//
+                .map(BusinessStep::getStepName)//
+                .collect(Collectors.toList());//
+
+        log.debug("Business steps has been CHANGED to the following:");
+        changes.forEach(e -> log.debug(e));
     }
 }

fineract-e2e-tests-core/src/test/java/org/apache/fineract/test/initializer/base/BaseFineractInitializerConfiguration.java

@@ -21,7 +21,6 @@ package org.apache.fineract.test.initializer.base;
 import java.util.List;
 import org.apache.fineract.test.config.CacheConfiguration;
 import org.apache.fineract.test.helper.BusinessDateHelper;
-import org.apache.fineract.test.helper.WorkFlowJobHelper;
 import org.apache.fineract.test.initializer.global.FineractGlobalInitializerStep;
 import org.apache.fineract.test.initializer.scenario.FineractScenarioInitializerStep;
 import org.apache.fineract.test.initializer.suite.FineractSuiteInitializerStep;
@@ -40,8 +39,7 @@ public class BaseFineractInitializerConfiguration {
     @Bean
     public FineractInitializer fineractInitializer(List<FineractGlobalInitializerStep> globalInitializerSteps,
             List<FineractSuiteInitializerStep> suiteInitializerSteps, List<FineractScenarioInitializerStep> scenarioInitializerSteps,
-            BusinessDateHelper businessDateHelper, WorkFlowJobHelper workFlowJobHelper) {
-        return new FineractInitializer(globalInitializerSteps, suiteInitializerSteps, scenarioInitializerSteps, businessDateHelper,
-                workFlowJobHelper);
+            BusinessDateHelper businessDateHelper) {
+        return new FineractInitializer(globalInitializerSteps, suiteInitializerSteps, scenarioInitializerSteps, businessDateHelper);
     }
 }

fineract-e2e-tests-core/src/test/java/org/apache/fineract/test/initializer/base/FineractInitializer.java

@@ -23,7 +23,6 @@ import java.util.stream.Collectors;
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
 import org.apache.fineract.test.helper.BusinessDateHelper;
-import org.apache.fineract.test.helper.WorkFlowJobHelper;
 import org.apache.fineract.test.initializer.global.FineractGlobalInitializerStep;
 import org.apache.fineract.test.initializer.scenario.FineractScenarioInitializerStep;
 import org.apache.fineract.test.initializer.suite.FineractSuiteInitializerStep;
@@ -39,7 +38,6 @@ public class FineractInitializer implements InitializingBean {
     private final List<FineractSuiteInitializerStep> suiteInitializerSteps;
     private final List<FineractScenarioInitializerStep> scenarioInitializerSteps;
     private final BusinessDateHelper businessDateHelper;
-    private final WorkFlowJobHelper workFlowJobHelper;
 
     @Override
     public void afterPropertiesSet() throws Exception {
@@ -63,7 +61,6 @@ public class FineractInitializer implements InitializingBean {
         for (FineractGlobalInitializerStep initializerStep : globalInitializerSteps) {
             initializerStep.initialize();
         }
-
         businessDateHelper.setBusinessDateToday();
     }
 
@@ -71,16 +68,13 @@ public class FineractInitializer implements InitializingBean {
         for (FineractSuiteInitializerStep initializerStep : suiteInitializerSteps) {
             initializerStep.initializeForSuite();
         }
-
         businessDateHelper.setBusinessDateToday();
-        workFlowJobHelper.saveOriginalCOBWorkflowJobBusinessStepList();
     }
 
     public void setupDefaultsForScenario() throws Exception {
         for (FineractScenarioInitializerStep scenarioInitializerStep : scenarioInitializerSteps) {
             scenarioInitializerStep.initializeForScenario();
         }
-
         businessDateHelper.setBusinessDateToday();
     }
 
@@ -88,7 +82,6 @@ public class FineractInitializer implements InitializingBean {
         for (FineractSuiteInitializerStep initializerStep : suiteInitializerSteps) {
             initializerStep.resetAfterSuite();
         }
-
         businessDateHelper.setBusinessDateToday();
     }
 }

fineract-e2e-tests-core/src/test/java/org/apache/fineract/test/initializer/global/CobBusinessStepInitializerStep.java

@@ -18,42 +18,18 @@
  */
 package org.apache.fineract.test.initializer.global;
 
-import java.util.Comparator;
-import java.util.List;
 import lombok.RequiredArgsConstructor;
-import org.apache.fineract.client.models.BusinessStep;
-import org.apache.fineract.client.models.GetBusinessStepConfigResponse;
-import org.apache.fineract.client.models.UpdateBusinessStepConfigRequest;
-import org.apache.fineract.client.services.BusinessStepConfigurationApi;
-import org.apache.fineract.test.helper.ErrorHelper;
+import org.apache.fineract.test.helper.WorkFlowJobHelper;
 import org.springframework.stereotype.Component;
-import retrofit2.Response;
 
 @RequiredArgsConstructor
 @Component
 public class CobBusinessStepInitializerStep implements FineractGlobalInitializerStep {
 
-    private static final String WORKFLOW_NAME_LOAN_CLOSE_OF_BUSINESS = "LOAN_CLOSE_OF_BUSINESS";
-    private static final String BUSINESS_STEP_NAME_ACCRUAL_ACTIVITY_POSTING = "ACCRUAL_ACTIVITY_POSTING";
-    private final BusinessStepConfigurationApi businessStepConfigurationApi;
+    private final WorkFlowJobHelper workFlowJobHelper;
 
     @Override
     public void initialize() throws Exception {
-        // --- Adding ACCRUAL_ACTIVITY_POSTING to default COB steps ---
-        Response<GetBusinessStepConfigResponse> businessStepConfigResponse = businessStepConfigurationApi
-                .retrieveAllConfiguredBusinessStep(WORKFLOW_NAME_LOAN_CLOSE_OF_BUSINESS).execute();
-        ErrorHelper.checkSuccessfulApiCall(businessStepConfigResponse);
-        List<BusinessStep> businessSteps = businessStepConfigResponse.body().getBusinessSteps();
-        businessSteps.sort(Comparator.comparingLong(BusinessStep::getOrder));
-        Long lastOrder = businessSteps.get(businessSteps.size() - 1).getOrder();
-
-        BusinessStep accrualActivityPosting = new BusinessStep().stepName(BUSINESS_STEP_NAME_ACCRUAL_ACTIVITY_POSTING).order(lastOrder + 1);
-        businessSteps.add(accrualActivityPosting);
-
-        UpdateBusinessStepConfigRequest request = new UpdateBusinessStepConfigRequest().businessSteps(businessSteps);
-
-        Response<Void> response = businessStepConfigurationApi.updateJobBusinessStepConfig(WORKFLOW_NAME_LOAN_CLOSE_OF_BUSINESS, request)
-                .execute();
-        ErrorHelper.checkSuccessfulApiCall(response);
+        workFlowJobHelper.setWorkflowJobs();
     }
 }

fineract-e2e-tests-core/src/test/java/org/apache/fineract/test/stepdef/common/BusinessStepStepDef.java

@@ -1,178 +0,0 @@
-/**
- * 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.stepdef.common;
-
-import io.cucumber.java.en.Given;
-import io.cucumber.java.en.Then;
-import java.io.IOException;
-import java.util.ArrayList;
-import java.util.Comparator;
-import java.util.List;
-import java.util.stream.Collectors;
-import lombok.extern.slf4j.Slf4j;
-import org.apache.fineract.client.models.BusinessStep;
-import org.apache.fineract.client.models.GetBusinessStepConfigResponse;
-import org.apache.fineract.client.models.UpdateBusinessStepConfigRequest;
-import org.apache.fineract.client.services.BusinessStepConfigurationApi;
-import org.apache.fineract.test.data.CobBusinessStep;
-import org.apache.fineract.test.helper.ErrorHelper;
-import org.apache.fineract.test.stepdef.AbstractStepDef;
-import org.apache.fineract.test.support.TestContext;
-import org.apache.fineract.test.support.TestContextKey;
-import org.springframework.beans.factory.annotation.Autowired;
-import retrofit2.Response;
-
-@Slf4j
-public class BusinessStepStepDef extends AbstractStepDef {
-
-    private static final String WORKFLOW_NAME_LOAN_CLOSE_OF_BUSINESS = "LOAN_CLOSE_OF_BUSINESS";
-    private static final String BUSINESS_STEP_NAME_APPLY_CHARGE_TO_OVERDUE_LOANS = "APPLY_CHARGE_TO_OVERDUE_LOANS";
-    private static final String BUSINESS_STEP_NAME_LOAN_DELINQUENCY_CLASSIFICATION = "LOAN_DELINQUENCY_CLASSIFICATION";
-    private static final String BUSINESS_STEP_NAME_CHECK_LOAN_REPAYMENT_DUE = "CHECK_LOAN_REPAYMENT_DUE";
-    private static final String BUSINESS_STEP_NAME_CHECK_LOAN_REPAYMENT_OVERDUE = "CHECK_LOAN_REPAYMENT_OVERDUE";
-    private static final String BUSINESS_STEP_NAME_UPDATE_LOAN_ARREARS_AGING = "UPDATE_LOAN_ARREARS_AGING";
-    private static final String BUSINESS_STEP_NAME_ADD_PERIODIC_ACCRUAL_ENTRIES = "ADD_PERIODIC_ACCRUAL_ENTRIES";
-    private static final String BUSINESS_STEP_NAME_EXTERNAL_ASSET_OWNER_TRANSFER = "EXTERNAL_ASSET_OWNER_TRANSFER";
-    private static final String BUSINESS_STEP_NAME_CHECK_DUE_INSTALLMENTS = "CHECK_DUE_INSTALLMENTS";
-    private static final String BUSINESS_STEP_NAME_ACCRUAL_ACTIVITY_POSTING = "ACCRUAL_ACTIVITY_POSTING";
-    private static final List<BusinessStep> ORIGINAL_COB_BUSINESS_STEPS = TestContext.GLOBAL
-            .get(TestContextKey.ORIGINAL_COB_WORKFLOW_JOB_BUSINESS_STEP_LIST);
-
-    @Autowired
-    private BusinessStepConfigurationApi businessStepConfigurationApi;
-
-    @Given("Admin puts EXTERNAL_ASSET_OWNER_TRANSFER job into LOAN_CLOSE_OF_BUSINESS workflow")
-    public void putExternalAssetOwnerTransferJobInCOB() throws IOException {
-        List<BusinessStep> businessSteps = new ArrayList<>(ORIGINAL_COB_BUSINESS_STEPS);
-        Long lastOrder = businessSteps.get(businessSteps.size() - 1).getOrder();
-
-        BusinessStep externalAssetOwnerTransfer = new BusinessStep().stepName(BUSINESS_STEP_NAME_EXTERNAL_ASSET_OWNER_TRANSFER)
-                .order(lastOrder + 1);
-        businessSteps.add(externalAssetOwnerTransfer);
-
-        UpdateBusinessStepConfigRequest request = new UpdateBusinessStepConfigRequest().businessSteps(businessSteps);
-
-        Response<Void> response = businessStepConfigurationApi.updateJobBusinessStepConfig(WORKFLOW_NAME_LOAN_CLOSE_OF_BUSINESS, request)
-                .execute();
-        ErrorHelper.checkSuccessfulApiCall(response);
-
-        // --- log changes ---
-        logChanges();
-    }
-
-    @Then("Admin removes EXTERNAL_ASSET_OWNER_TRANSFER job from LOAN_CLOSE_OF_BUSINESS workflow")
-    public void removeExternalAssetOwnerTransferJobInCOB() throws IOException {
-        setBackBusinessStepsToOriginal();
-    }
-
-    @Given("Admin puts CHECK_DUE_INSTALLMENTS job into LOAN_CLOSE_OF_BUSINESS workflow")
-    public void putCheckDueInstallmentsJobInCOB() throws IOException {
-        List<BusinessStep> businessSteps = new ArrayList<>(ORIGINAL_COB_BUSINESS_STEPS);
-        Long lastOrder = businessSteps.get(businessSteps.size() - 1).getOrder();
-
-        BusinessStep checkDueInstallments = new BusinessStep().stepName(BUSINESS_STEP_NAME_CHECK_DUE_INSTALLMENTS).order(lastOrder + 1);
-        businessSteps.add(checkDueInstallments);
-
-        UpdateBusinessStepConfigRequest request = new UpdateBusinessStepConfigRequest().businessSteps(businessSteps);
-
-        Response<Void> response = businessStepConfigurationApi.updateJobBusinessStepConfig(WORKFLOW_NAME_LOAN_CLOSE_OF_BUSINESS, request)
-                .execute();
-        ErrorHelper.checkSuccessfulApiCall(response);
-
-        // --- log changes ---
-        logChanges();
-    }
-
-    @Then("Admin removes CHECK_DUE_INSTALLMENTS job from LOAN_CLOSE_OF_BUSINESS workflow")
-    public void removeCheckDueInstallmentsJobInCOB() throws IOException {
-        setBackBusinessStepsToOriginal();
-    }
-
-    @Given("Admin puts {string} business step into LOAN_CLOSE_OF_BUSINESS workflow")
-    public void putGivenJobInCOB(String businessStepName) throws IOException {
-        List<BusinessStep> businessSteps = new ArrayList<>(ORIGINAL_COB_BUSINESS_STEPS);
-        Long lastOrder = businessSteps.get(businessSteps.size() - 1).getOrder();
-
-        CobBusinessStep cobBusinessStep = CobBusinessStep.valueOf(businessStepName);
-        String stepName = cobBusinessStep.getValue();
-
-        BusinessStep businessStepToAdd = new BusinessStep().stepName(stepName).order(lastOrder + 1);
-        businessSteps.add(businessStepToAdd);
-
-        UpdateBusinessStepConfigRequest request = new UpdateBusinessStepConfigRequest().businessSteps(businessSteps);
-
-        Response<Void> response = businessStepConfigurationApi.updateJobBusinessStepConfig(WORKFLOW_NAME_LOAN_CLOSE_OF_BUSINESS, request)
-                .execute();
-        ErrorHelper.checkSuccessfulApiCall(response);
-
-        // --- log changes ---
-        logChanges();
-    }
-
-    @Then("Admin sets back LOAN_CLOSE_OF_BUSINESS workflow to its initial state")
-    public void setBackCOBToInitialState() throws IOException {
-        setBackBusinessStepsToOriginal();
-    }
-
-    @Then("Admin removes {string} business step into LOAN_CLOSE_OF_BUSINESS workflow")
-    public void removeGivenJobInCOB(String businessStepName) throws IOException {
-        List<BusinessStep> businessSteps = new ArrayList<>(ORIGINAL_COB_BUSINESS_STEPS);
-
-        CobBusinessStep cobBusinessStep = CobBusinessStep.valueOf(businessStepName);
-        String stepName = cobBusinessStep.getValue();
-
-        businessSteps.removeIf(businessStep -> businessStep.getStepName().equals(stepName));
-
-        UpdateBusinessStepConfigRequest request = new UpdateBusinessStepConfigRequest().businessSteps(businessSteps);
-
-        Response<Void> response = businessStepConfigurationApi.updateJobBusinessStepConfig(WORKFLOW_NAME_LOAN_CLOSE_OF_BUSINESS, request)
-                .execute();
-        ErrorHelper.checkSuccessfulApiCall(response);
-
-        // --- log changes ---
-        logChanges();
-    }
-
-    private void setBackBusinessStepsToOriginal() throws IOException {
-        log.debug("Setting back Business steps to original...");
-        UpdateBusinessStepConfigRequest request = new UpdateBusinessStepConfigRequest().businessSteps(ORIGINAL_COB_BUSINESS_STEPS);
-
-        Response<Void> response = businessStepConfigurationApi.updateJobBusinessStepConfig(WORKFLOW_NAME_LOAN_CLOSE_OF_BUSINESS, request)
-                .execute();
-        ErrorHelper.checkSuccessfulApiCall(response);
-
-        // --- log changes ---
-        logChanges();
-    }
-
-    private void logChanges() throws IOException {
-        // --- log changes ---
-        Response<GetBusinessStepConfigResponse> changesResponse = businessStepConfigurationApi
-                .retrieveAllConfiguredBusinessStep(WORKFLOW_NAME_LOAN_CLOSE_OF_BUSINESS).execute();
-        List<BusinessStep> businessStepsChanged = changesResponse.body().getBusinessSteps();
-        List<String> changes = businessStepsChanged//
-                .stream()//
-                .sorted(Comparator.comparingLong(BusinessStep::getOrder))//
-                .map(BusinessStep::getStepName)//
-                .collect(Collectors.toList());//
-
-        log.debug("Business steps has been CHANGED to the following:");
-        changes.forEach(e -> log.debug(e));
-    }
-}

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

@@ -24,7 +24,6 @@ import lombok.NoArgsConstructor;
 @NoArgsConstructor(access = AccessLevel.PRIVATE)
 public abstract class TestContextKey {
 
-    public static final String ORIGINAL_COB_WORKFLOW_JOB_BUSINESS_STEP_LIST = "originalCOBWorkflowJobBusinessStepList";
     public static final String CLIENT_CREATE_RESPONSE = "clientCreateResponse";
     public static final String CLIENT_CREATE_SECOND_CLIENT_RESPONSE = "clientCreateSecondClientResponse";
     public static final String LOAN_CREATE_RESPONSE = "loanCreateResponse";

fineract-e2e-tests-core/src/test/resources/fineract-test-application.properties

@@ -38,3 +38,5 @@ fineract-test.messaging.jms.topic-name=${ACTIVEMQ_TOPIC_NAME:}
 
 fineract-test.event.wait-timeout-in-sec=${EVENT_WAIT_TIMEOUT_IN_SEC:5}
 fineract-test.event.verification-enabled=${EVENT_VERIFICATION_ENABLED:false}
+
+fineract-test.client-read-timeout=${CLIENT_READ_TIMEOUT:60}