FINERACT-1724: Batch API enhancements

fineract-provider/src/main/java/org/apache/fineract/batch/command/CommandStrategyProvider.java

@@ -119,6 +119,10 @@ public class CommandStrategyProvider {
                 "getTransactionByIdCommandStrategy");
         commandStrategies.put(CommandContext.resource("datatables\\/[a-zA-Z0-9_]*\\/\\d+").method("GET").build(),
                 "getDatatableEntryByAppTableIdCommandStrategy");
+        commandStrategies.put(CommandContext.resource("datatables\\/[a-zA-Z0-9_]*\\/\\d+").method("POST").build(),
+                "createDatatableEntryCommandStrategy");
+        commandStrategies.put(CommandContext.resource("datatables\\/[a-zA-Z0-9_]*\\/\\d+\\/\\d+").method("PUT").build(),
+                "updateDatatableEntryOneToManyCommandStrategy");
         commandStrategies.put(
                 CommandContext.resource("datatables\\/[a-zA-Z0-9_]*\\/\\d+(\\?(\\w+(?:\\=[\\w,]+|&)+)+)").method("GET").build(),
                 "getDatatableEntryByAppTableIdCommandStrategy");

fineract-provider/src/main/java/org/apache/fineract/batch/command/internal/CreateDatatableEntryCommandStrategy.java

@@ -0,0 +1,71 @@
+/**
+ * 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.batch.command.internal;
+
+import com.google.common.base.Splitter;
+import java.util.List;
+import javax.ws.rs.core.UriInfo;
+import lombok.RequiredArgsConstructor;
+import org.apache.fineract.batch.command.CommandStrategy;
+import org.apache.fineract.batch.domain.BatchRequest;
+import org.apache.fineract.batch.domain.BatchResponse;
+import org.apache.fineract.infrastructure.dataqueries.api.DatatablesApiResource;
+import org.springframework.stereotype.Component;
+
+/**
+ * Implements {@link CommandStrategy} and creates a new datatable entry for a given loan. It passes the contents of the
+ * body from the BatchRequest to {@link DatatablesApiResource} and gets back the response. This class will also catch
+ * any errors raised by {@link DatatablesApiResource} and map those errors to appropriate status codes in BatchResponse.
+ *
+ * @see CommandStrategy
+ * @see BatchRequest
+ * @see BatchResponse
+ */
+@Component
+@RequiredArgsConstructor
+public class CreateDatatableEntryCommandStrategy implements CommandStrategy {
+
+    private final DatatablesApiResource datatablesApiResource;
+
+    @Override
+    public BatchResponse execute(BatchRequest request, @SuppressWarnings("unused") UriInfo uriInfo) {
+
+        final BatchResponse response = new BatchResponse();
+        final String responseBody;
+
+        response.setRequestId(request.getRequestId());
+        response.setHeaders(request.getHeaders());
+
+        final List<String> pathParameters = Splitter.on('/').splitToList(request.getRelativeUrl());
+        // Pluck out the datatable name & loanId out of the relative path
+        final String datatableName = pathParameters.get(1);
+        final Long loanId = Long.parseLong(pathParameters.get(2));
+
+        // Calls 'createDatatableEntry' function from
+        // 'DatatablesApiResource' to create a datatable entry on an existing loan
+        responseBody = datatablesApiResource.createDatatableEntry(datatableName, loanId, request.getBody());
+
+        response.setStatusCode(200);
+        // Sets the body of the response after datatable entry is successfully
+        // created
+        response.setBody(responseBody);
+
+        return response;
+    }
+}

fineract-provider/src/main/java/org/apache/fineract/batch/command/internal/UpdateDatatableEntryOneToManyCommandStrategy.java

@@ -0,0 +1,72 @@
+/**
+ * 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.batch.command.internal;
+
+import com.google.common.base.Splitter;
+import java.util.List;
+import javax.ws.rs.core.UriInfo;
+import lombok.RequiredArgsConstructor;
+import org.apache.fineract.batch.command.CommandStrategy;
+import org.apache.fineract.batch.domain.BatchRequest;
+import org.apache.fineract.batch.domain.BatchResponse;
+import org.apache.fineract.infrastructure.dataqueries.api.DatatablesApiResource;
+import org.springframework.stereotype.Component;
+
+/**
+ * Implements {@link CommandStrategy} and updates a datatable entry for a given loan. It passes the contents of the body
+ * from the BatchRequest to {@link DatatablesApiResource} and gets back the response. This class will also catch any
+ * errors raised by {@link DatatablesApiResource} and map those errors to appropriate status codes in BatchResponse.
+ *
+ * @see CommandStrategy
+ * @see BatchRequest
+ * @see BatchResponse
+ */
+@Component
+@RequiredArgsConstructor
+public class UpdateDatatableEntryOneToManyCommandStrategy implements CommandStrategy {
+
+    private final DatatablesApiResource datatablesApiResource;
+
+    @Override
+    public BatchResponse execute(BatchRequest request, @SuppressWarnings("unused") UriInfo uriInfo) {
+
+        final BatchResponse response = new BatchResponse();
+        final String responseBody;
+
+        response.setRequestId(request.getRequestId());
+        response.setHeaders(request.getHeaders());
+
+        final List<String> pathParameters = Splitter.on('/').splitToList(request.getRelativeUrl());
+        // Pluck out the datatable name, loanId & datatable entry id out of the relative path
+        final String datatableName = pathParameters.get(1);
+        final Long loanId = Long.parseLong(pathParameters.get(2));
+        final Long datatableEntryId = Long.parseLong(pathParameters.get(3));
+
+        // Calls 'updateDatatableEntryOneToMany' function from
+        // 'DatatablesApiResource' to update a datatable entry on an existing loan in a one-many relationship
+        responseBody = datatablesApiResource.updateDatatableEntryOneToMany(datatableName, loanId, datatableEntryId, request.getBody());
+
+        response.setStatusCode(200);
+        // Sets the body of the response after datatable entry is successfully
+        // updated
+        response.setBody(responseBody);
+
+        return response;
+    }
+}

fineract-provider/src/test/java/org/apache/fineract/batch/command/CommandStrategyProviderTest.java

@@ -33,6 +33,7 @@ import org.apache.fineract.batch.command.internal.ApproveLoanRescheduleCommandSt
 import org.apache.fineract.batch.command.internal.CollectChargesCommandStrategy;
 import org.apache.fineract.batch.command.internal.CreateChargeCommandStrategy;
 import org.apache.fineract.batch.command.internal.CreateClientCommandStrategy;
+import org.apache.fineract.batch.command.internal.CreateDatatableEntryCommandStrategy;
 import org.apache.fineract.batch.command.internal.CreateLoanRescheduleRequestCommandStrategy;
 import org.apache.fineract.batch.command.internal.CreateTransactionLoanCommandStrategy;
 import org.apache.fineract.batch.command.internal.DisburseLoanCommandStrategy;
@@ -42,6 +43,7 @@ import org.apache.fineract.batch.command.internal.GetLoanByIdCommandStrategy;
 import org.apache.fineract.batch.command.internal.GetTransactionByIdCommandStrategy;
 import org.apache.fineract.batch.command.internal.UnknownCommandStrategy;
 import org.apache.fineract.batch.command.internal.UpdateClientCommandStrategy;
+import org.apache.fineract.batch.command.internal.UpdateDatatableEntryOneToManyCommandStrategy;
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.Arguments;
 import org.junit.jupiter.params.provider.MethodSource;
@@ -99,7 +101,11 @@ public class CommandStrategyProviderTest {
                 Arguments.of("datatables/test_dt_table/123", HttpMethod.GET, "getDatatableEntryByAppTableIdCommandStrategy",
                         mock(GetDatatableEntryByAppTableIdCommandStrategy.class)),
                 Arguments.of("datatables/test_dt_table/123?genericResultSet=true", HttpMethod.GET,
-                        "getDatatableEntryByAppTableIdCommandStrategy", mock(GetDatatableEntryByAppTableIdCommandStrategy.class)));
+                        "getDatatableEntryByAppTableIdCommandStrategy", mock(GetDatatableEntryByAppTableIdCommandStrategy.class)),
+                Arguments.of("datatables/test_dt_table/123", HttpMethod.POST, "createDatatableEntryCommandStrategy",
+                        mock(CreateDatatableEntryCommandStrategy.class)),
+                Arguments.of("datatables/test_dt_table/123/1", HttpMethod.PUT, "updateDatatableEntryOneToManyCommandStrategy",
+                        mock(UpdateDatatableEntryOneToManyCommandStrategy.class)));
     }
 
     /**

fineract-provider/src/test/java/org/apache/fineract/batch/command/internal/CreateDatatableEntryCommandStrategyTest.java

@@ -0,0 +1,104 @@
+/**
+ * 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.batch.command.internal;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.mockito.ArgumentMatchers.eq;
+import static org.mockito.BDDMockito.given;
+
+import javax.ws.rs.HttpMethod;
+import javax.ws.rs.core.UriInfo;
+import org.apache.commons.lang3.RandomStringUtils;
+import org.apache.fineract.batch.domain.BatchRequest;
+import org.apache.fineract.batch.domain.BatchResponse;
+import org.apache.fineract.infrastructure.dataqueries.api.DatatablesApiResource;
+import org.apache.http.HttpStatus;
+import org.junit.Test;
+import org.mockito.Mock;
+import org.mockito.MockitoAnnotations;
+
+public class CreateDatatableEntryCommandStrategyTest {
+
+    /**
+     * Test {@link CreateDatatableEntryCommandStrategy#execute} happy path scenario.
+     */
+    @Test
+    public void testExecuteSuccessScenario() {
+        // given
+        final TestContext testContext = new TestContext();
+
+        final Long loanId = Long.valueOf(RandomStringUtils.randomNumeric(4));
+        final String datatableName = RandomStringUtils.randomAlphabetic(10);
+        final BatchRequest request = getBatchRequest(datatableName, loanId);
+        final String responseBody = "{\"resourceId\":193}";
+
+        given(testContext.datatablesApiResource.createDatatableEntry(eq(datatableName), eq(loanId), eq(request.getBody())))
+                .willReturn(responseBody);
+
+        // when
+        final BatchResponse response = testContext.subjectToTest.execute(request, testContext.uriInfo);
+
+        // then
+        assertEquals(response.getStatusCode(), HttpStatus.SC_OK);
+        assertEquals(response.getRequestId(), request.getRequestId());
+        assertEquals(response.getHeaders(), request.getHeaders());
+        assertEquals(response.getBody(), responseBody);
+    }
+
+    /**
+     * Creates and returns a create datatable entry request with the given loan id.
+     *
+     * @param datatableName
+     *            the name of the datatable
+     * @param loanId
+     *            the loan id
+     * @return BatchRequest
+     */
+    private BatchRequest getBatchRequest(final String datatableName, final Long loanId) {
+
+        final BatchRequest br = new BatchRequest();
+        String relativeUrl = String.format("datatables/%s/%s", datatableName, loanId);
+
+        br.setRequestId(Long.valueOf(RandomStringUtils.randomNumeric(5)));
+        br.setRelativeUrl(relativeUrl);
+        br.setMethod(HttpMethod.POST);
+        br.setBody("{\"locale\":\"en\",\"dateFormat\":\"dd MMMM yyyy\",\"enabled\":true,\"amount\":500.10}");
+
+        return br;
+    }
+
+    /**
+     * Private test context class used since testng runs in parallel to avoid state between tests
+     */
+    private static class TestContext {
+
+        @Mock
+        private UriInfo uriInfo;
+
+        @Mock
+        private DatatablesApiResource datatablesApiResource;
+
+        private final CreateDatatableEntryCommandStrategy subjectToTest;
+
+        TestContext() {
+            MockitoAnnotations.openMocks(this);
+            subjectToTest = new CreateDatatableEntryCommandStrategy(datatablesApiResource);
+        }
+    }
+}

fineract-provider/src/test/java/org/apache/fineract/batch/command/internal/UpdateDatatableEntryOneToManyCommandStrategyTest.java

@@ -0,0 +1,107 @@
+/**
+ * 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.batch.command.internal;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.mockito.ArgumentMatchers.eq;
+import static org.mockito.BDDMockito.given;
+
+import javax.ws.rs.HttpMethod;
+import javax.ws.rs.core.UriInfo;
+import org.apache.commons.lang3.RandomStringUtils;
+import org.apache.fineract.batch.domain.BatchRequest;
+import org.apache.fineract.batch.domain.BatchResponse;
+import org.apache.fineract.infrastructure.dataqueries.api.DatatablesApiResource;
+import org.apache.http.HttpStatus;
+import org.junit.Test;
+import org.mockito.Mock;
+import org.mockito.MockitoAnnotations;
+
+public class UpdateDatatableEntryOneToManyCommandStrategyTest {
+
+    /**
+     * Test {@link UpdateDatatableEntryOneToManyCommandStrategy#execute} happy path scenario.
+     */
+    @Test
+    public void testExecuteSuccessScenario() {
+        // given
+        final TestContext testContext = new TestContext();
+
+        final Long loanId = Long.valueOf(RandomStringUtils.randomNumeric(4));
+        final Long datatableEntryId = Long.valueOf(RandomStringUtils.randomNumeric(3));
+        final String datatableName = RandomStringUtils.randomAlphabetic(10);
+        final BatchRequest request = getBatchRequest(datatableName, loanId, datatableEntryId);
+        final String responseBody = "{\"resourceId\":193}";
+
+        given(testContext.datatablesApiResource.updateDatatableEntryOneToMany(eq(datatableName), eq(loanId), eq(datatableEntryId),
+                eq(request.getBody()))).willReturn(responseBody);
+
+        // when
+        final BatchResponse response = testContext.subjectToTest.execute(request, testContext.uriInfo);
+
+        // then
+        assertEquals(response.getStatusCode(), HttpStatus.SC_OK);
+        assertEquals(response.getRequestId(), request.getRequestId());
+        assertEquals(response.getHeaders(), request.getHeaders());
+        assertEquals(response.getBody(), responseBody);
+    }
+
+    /**
+     * Creates and returns a create datatable entry request with the given loan id.
+     *
+     * @param datatableName
+     *            the name of the datatable
+     * @param loanId
+     *            the loan id
+     * @param datatableEntryId
+     *            the datatable entry id
+     * @return BatchRequest
+     */
+    private BatchRequest getBatchRequest(final String datatableName, final Long loanId, final Long datatableEntryId) {
+
+        final BatchRequest br = new BatchRequest();
+        String relativeUrl = String.format("datatables/%s/%s/%s", datatableName, loanId, datatableEntryId);
+
+        br.setRequestId(Long.valueOf(RandomStringUtils.randomNumeric(5)));
+        br.setRelativeUrl(relativeUrl);
+        br.setMethod(HttpMethod.PUT);
+        br.setBody("{\"locale\":\"en\",\"dateFormat\":\"dd MMMM yyyy\",\"enabled\":true,\"amount\":500.10}");
+
+        return br;
+    }
+
+    /**
+     * Private test context class used since testng runs in parallel to avoid state between tests
+     */
+    private static class TestContext {
+
+        @Mock
+        private UriInfo uriInfo;
+
+        @Mock
+        private DatatablesApiResource datatablesApiResource;
+
+        private final UpdateDatatableEntryOneToManyCommandStrategy subjectToTest;
+
+        TestContext() {
+            MockitoAnnotations.openMocks(this);
+            subjectToTest = new UpdateDatatableEntryOneToManyCommandStrategy(datatablesApiResource);
+        }
+    }
+}