You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@fineract.apache.org by "DeathGun44 (via GitHub)" <gi...@apache.org> on 2026/08/07 06:29:58 UTC
[PR] FINERACT-2732: migrate the savings and deposit integration tests to the Feign client (Tier 1) [fineract]
DeathGun44 opened a new pull request, #6241:
URL: https://github.com/apache/fineract/pull/6241
## Description
Tier 1 of moving the savings and deposit integration tests onto the generated Feign client, so they call the API through typed models instead of raw JSON. It covers the 14 smaller savings classes.
## Production changes
Limited to four Swagger files.
**Most are additive** - optional fields that typed clients need but the schema does not
describe:
- savings product accounting mappings and overdraft fields
- a transaction `note`
- `transactionId` on two datatable responses
- `withdrawalFeeForTransfers`
The endpoints already accept and return these; only the documented shape changes.
**One is not additive.** `SavingsAccountTransactionsSearchResponse.content` is a `List` rather than a `Set`. The endpoint returns a page ordered by the request's `orderBy`/`sortOrder`, and a set throws that order away in generated clients with no way to get it back. The response is a JSON array either way, so the wire format is unchanged.
## Backward compatibility
The CI gate was reproduced locally against a spec built from the merge base. No breaking changes. The two specs differ in 52 places - 51 additions and one removal, the `uniqueItems` flag a list does not carry.
## Notes on a few choices
- Each test class resets every global configuration to its default after each test and verifies it, so no test leaks configuration into the next.
- The scheduler helper asserts that the run it awaited was triggered by the test itself and finished with status `success`, so a failed job cannot look like a passing one. The helper is shared with `FeignLoanTestBase`, so the loan suites get the same check.
- The accrual accounting test gives every GL mapping its own account, so an assertion about one mapping cannot be satisfied by another.
- Boolean checks on generated getters are null-safe, since those getters are nullable.
- The batch endpoint answers 200 even when a sub-request fails, so the tests assert on each sub-request's own status code.
## Checklist
Please make sure these boxes are checked before submitting your pull request - thanks!
- [ ] Write the commit message as per [our guidelines](https://github.com/apache/fineract/blob/develop/CONTRIBUTING.md#pull-requests)
- [ ] Acknowledge that we will not review PRs that are not passing the build _("green")_ - it is your responsibility to get a proposed PR to pass the build, not primarily the project's maintainers.
- [ ] Create/update [unit or integration tests](https://fineract.apache.org/docs/current/#_testing) for verifying the changes made.
- [ ] Follow our [coding conventions](https://cwiki.apache.org/confluence/display/FINERACT/Coding+Conventions).
- [ ] Add required Swagger annotation and update API documentation at fineract-provider/src/main/resources/static/legacy-docs/apiLive.htm with details of any API changes
- [ ] [This PR must not be a "code dump"](https://cwiki.apache.org/confluence/display/FINERACT/Pull+Request+Size+Limit). Large changes can be made in a branch, with assistance. Ask for help on the [developer mailing list](https://fineract.apache.org/#contribute).
- [ ] If merging this PR resolves a JIRA issue, I will mark that issue as resolved and set "Fix Version/s" appropriately.
Your assigned reviewer(s) will follow our [guidelines for code reviews](https://cwiki.apache.org/confluence/display/FINERACT/Code+Review+Guide).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@fineract.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] FINERACT-2732: migrate the savings and deposit integration tests to the Feign client (Tier 1) [fineract]
Posted by "DeathGun44 (via GitHub)" <gi...@apache.org>.
DeathGun44 commented on code in PR #6241:
URL: https://github.com/apache/fineract/pull/6241#discussion_r3825502957
##########
integration-tests/src/test/java/org/apache/fineract/integrationtests/client/feign/helpers/SavingsTransactionCommandsApi.java:
##########
@@ -0,0 +1,39 @@
+/**
+ * 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.integrationtests.client.feign.helpers;
+
+import feign.Headers;
+import feign.Param;
+import feign.RequestLine;
+import org.apache.fineract.client.models.CommandProcessingResult;
+import org.apache.fineract.client.models.PostSavingsAccountBulkReversalTransactionsRequest;
+
+/**
+ * Adjusts a savings transaction - {@code reverse}, {@code undo} or {@code releaseAmount}. Hand-written because
+ * {@code SavingsAccountTransactionsApiResource} documents the 200 as an array of request models, so the generated
+ * client cannot read the {@code resourceId} these tests assert on. Correcting that {@code @ApiResponse} is a breaking
+ * OpenAPI change, so it is prepared separately rather than carried by a test migration.
+ */
+@Headers({ "Accept: application/json", "Content-Type: application/json" })
Review Comment:
Done!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@fineract.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] FINERACT-2732: migrate the savings and deposit integration tests to the Feign client (Tier 1) [fineract]
Posted by "adamsaghy (via GitHub)" <gi...@apache.org>.
adamsaghy commented on code in PR #6241:
URL: https://github.com/apache/fineract/pull/6241#discussion_r3863148038
##########
integration-tests/src/test/java/org/apache/fineract/integrationtests/client/feign/helpers/FeignSavingsTransactionHelper.java:
##########
@@ -48,4 +62,93 @@ public PostSavingsAccountTransactionsResponse withdraw(Long savingsId, PostSavin
public PostSavingsAccountTransactionsResponse withdraw(Long savingsId, String amount, String transactionDate) {
return withdraw(savingsId, SavingsRequestBuilders.withdrawal(amount, transactionDate));
}
+
+ /** The server only accepts this command while the force-withdrawal global configuration is enabled. */
+ public PostSavingsAccountTransactionsResponse forceWithdraw(Long savingsId, PostSavingsAccountTransactionsRequest request) {
+ return ok(
+ () -> fineractClient.savingsAccountTransactions().createSavingsAccountTransaction(savingsId, request, "force-withdrawal"));
+ }
+
+ public PostSavingsAccountTransactionsResponse forceWithdraw(Long savingsId, String amount, String transactionDate) {
+ return forceWithdraw(savingsId, SavingsRequestBuilders.withdrawal(amount, transactionDate));
+ }
+
+ public CallFailedRuntimeException withdrawExpectingError(Long savingsId, String amount, String transactionDate) {
+ PostSavingsAccountTransactionsRequest request = SavingsRequestBuilders.withdrawal(amount, transactionDate);
+ return fail(() -> fineractClient.savingsAccountTransactions().createSavingsAccountTransaction(savingsId, request, "withdrawal"));
+ }
+
+ public PostSavingsAccountTransactionsResponse postInterestAsOn(Long savingsId, String transactionDate) {
+ PostSavingsAccountTransactionsRequest request = SavingsRequestBuilders.postInterestAsOn(transactionDate);
+ return ok(
+ () -> fineractClient.savingsAccountTransactions().createSavingsAccountTransaction(savingsId, request, "postInterestAsOn"));
+ }
+
+ public PostSavingsAccountTransactionsResponse holdAmount(Long savingsId, String amount, String transactionDate, String reasonForBlock) {
+ PostSavingsAccountTransactionsRequest request = SavingsRequestBuilders.holdAmount(amount, transactionDate, reasonForBlock);
+ return ok(() -> fineractClient.savingsAccountTransactions().createSavingsAccountTransaction(savingsId, request, "holdAmount"));
+ }
+
+ public CommandProcessingResult reverseTransaction(Long savingsId, Long transactionId) {
+ return adjustTransaction(savingsId, transactionId, "reverse");
+ }
+
+ public CommandProcessingResult undoTransaction(Long savingsId, Long transactionId) {
+ return adjustTransaction(savingsId, transactionId, "undo");
+ }
+
+ public CommandProcessingResult releaseAmount(Long savingsId, Long holdTransactionId) {
+ return adjustTransaction(savingsId, holdTransactionId, "releaseAmount");
+ }
+
+ /** All three commands are driven by the query parameter alone and read no payload, hence the empty body. */
+ private CommandProcessingResult adjustTransaction(Long savingsId, Long transactionId, String command) {
+ PostSavingsAccountBulkReversalTransactionsRequest request = new PostSavingsAccountBulkReversalTransactionsRequest();
+ return ok(() -> fineractClient.savingsAccountTransactions().adjustSavingsAccountTransaction(savingsId, transactionId, request,
+ command));
+ }
+
+ /** The generated client types this response as a bare {@code String}, so the JSON is mapped here. */
+ public SavingsAccountTransactionData getTransaction(Long savingsId, Long transactionId) {
+ String json = ok(() -> fineractClient.savingsAccountTransactions().retrieveOneSavingsAccountTransaction(savingsId, transactionId));
Review Comment:
Instead of keeping String, it would be better to update the swagger to return the valid data type
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@fineract.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] FINERACT-2732: migrate the savings and deposit integration tests to the Feign client (Tier 1) [fineract]
Posted by "DeathGun44 (via GitHub)" <gi...@apache.org>.
DeathGun44 commented on code in PR #6241:
URL: https://github.com/apache/fineract/pull/6241#discussion_r3865581395
##########
integration-tests/src/test/java/org/apache/fineract/integrationtests/client/feign/helpers/FeignSavingsTransactionHelper.java:
##########
@@ -48,4 +62,93 @@ public PostSavingsAccountTransactionsResponse withdraw(Long savingsId, PostSavin
public PostSavingsAccountTransactionsResponse withdraw(Long savingsId, String amount, String transactionDate) {
return withdraw(savingsId, SavingsRequestBuilders.withdrawal(amount, transactionDate));
}
+
+ /** The server only accepts this command while the force-withdrawal global configuration is enabled. */
+ public PostSavingsAccountTransactionsResponse forceWithdraw(Long savingsId, PostSavingsAccountTransactionsRequest request) {
+ return ok(
+ () -> fineractClient.savingsAccountTransactions().createSavingsAccountTransaction(savingsId, request, "force-withdrawal"));
+ }
+
+ public PostSavingsAccountTransactionsResponse forceWithdraw(Long savingsId, String amount, String transactionDate) {
+ return forceWithdraw(savingsId, SavingsRequestBuilders.withdrawal(amount, transactionDate));
+ }
+
+ public CallFailedRuntimeException withdrawExpectingError(Long savingsId, String amount, String transactionDate) {
+ PostSavingsAccountTransactionsRequest request = SavingsRequestBuilders.withdrawal(amount, transactionDate);
+ return fail(() -> fineractClient.savingsAccountTransactions().createSavingsAccountTransaction(savingsId, request, "withdrawal"));
+ }
+
+ public PostSavingsAccountTransactionsResponse postInterestAsOn(Long savingsId, String transactionDate) {
+ PostSavingsAccountTransactionsRequest request = SavingsRequestBuilders.postInterestAsOn(transactionDate);
+ return ok(
+ () -> fineractClient.savingsAccountTransactions().createSavingsAccountTransaction(savingsId, request, "postInterestAsOn"));
+ }
+
+ public PostSavingsAccountTransactionsResponse holdAmount(Long savingsId, String amount, String transactionDate, String reasonForBlock) {
+ PostSavingsAccountTransactionsRequest request = SavingsRequestBuilders.holdAmount(amount, transactionDate, reasonForBlock);
+ return ok(() -> fineractClient.savingsAccountTransactions().createSavingsAccountTransaction(savingsId, request, "holdAmount"));
+ }
+
+ public CommandProcessingResult reverseTransaction(Long savingsId, Long transactionId) {
+ return adjustTransaction(savingsId, transactionId, "reverse");
+ }
+
+ public CommandProcessingResult undoTransaction(Long savingsId, Long transactionId) {
+ return adjustTransaction(savingsId, transactionId, "undo");
+ }
+
+ public CommandProcessingResult releaseAmount(Long savingsId, Long holdTransactionId) {
+ return adjustTransaction(savingsId, holdTransactionId, "releaseAmount");
+ }
+
+ /** All three commands are driven by the query parameter alone and read no payload, hence the empty body. */
+ private CommandProcessingResult adjustTransaction(Long savingsId, Long transactionId, String command) {
+ PostSavingsAccountBulkReversalTransactionsRequest request = new PostSavingsAccountBulkReversalTransactionsRequest();
+ return ok(() -> fineractClient.savingsAccountTransactions().adjustSavingsAccountTransaction(savingsId, transactionId, request,
+ command));
+ }
+
+ /** The generated client types this response as a bare {@code String}, so the JSON is mapped here. */
+ public SavingsAccountTransactionData getTransaction(Long savingsId, Long transactionId) {
+ String json = ok(() -> fineractClient.savingsAccountTransactions().retrieveOneSavingsAccountTransaction(savingsId, transactionId));
Review Comment:
The endpoint had no @ApiResponse at all, so the spec fell back to the method's Java return type and documented the response as a string. Added the real type to all four retrieveOne variants. SavingsAccountTransactionData was already in the spec, so no new model. The helper is now a plain typed call. The API compatibility check goes red with R015 on those four paths - response type string → object. The wire format is unchanged.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@fineract.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] FINERACT-2732: migrate the savings and deposit integration tests to the Feign client (Tier 1) [fineract]
Posted by "DeathGun44 (via GitHub)" <gi...@apache.org>.
DeathGun44 commented on PR #6241:
URL: https://github.com/apache/fineract/pull/6241#issuecomment-5361962816
@adamsaghy rebased and ready for review!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@fineract.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] FINERACT-2732: migrate the savings and deposit integration tests to the Feign client (Tier 1) [fineract]
Posted by "adamsaghy (via GitHub)" <gi...@apache.org>.
adamsaghy commented on code in PR #6241:
URL: https://github.com/apache/fineract/pull/6241#discussion_r3773977768
##########
integration-tests/src/test/java/org/apache/fineract/integrationtests/client/feign/helpers/SavingsTransactionCommandsApi.java:
##########
@@ -0,0 +1,39 @@
+/**
+ * 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.integrationtests.client.feign.helpers;
+
+import feign.Headers;
+import feign.Param;
+import feign.RequestLine;
+import org.apache.fineract.client.models.CommandProcessingResult;
+import org.apache.fineract.client.models.PostSavingsAccountBulkReversalTransactionsRequest;
+
+/**
+ * Adjusts a savings transaction - {@code reverse}, {@code undo} or {@code releaseAmount}. Hand-written because
+ * {@code SavingsAccountTransactionsApiResource} documents the 200 as an array of request models, so the generated
+ * client cannot read the {@code resourceId} these tests assert on. Correcting that {@code @ApiResponse} is a breaking
+ * OpenAPI change, so it is prepared separately rather than carried by a test migration.
+ */
+@Headers({ "Accept: application/json", "Content-Type: application/json" })
Review Comment:
Lets correct the swagger if it is incorrect.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@fineract.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] FINERACT-2732: migrate the savings and deposit integration tests to the Feign client (Tier 1) [fineract]
Posted by "DeathGun44 (via GitHub)" <gi...@apache.org>.
DeathGun44 commented on code in PR #6241:
URL: https://github.com/apache/fineract/pull/6241#discussion_r3865587716
##########
integration-tests/src/test/java/org/apache/fineract/integrationtests/client/feign/helpers/FeignSavingsTransactionHelper.java:
##########
@@ -48,4 +62,93 @@ public PostSavingsAccountTransactionsResponse withdraw(Long savingsId, PostSavin
public PostSavingsAccountTransactionsResponse withdraw(Long savingsId, String amount, String transactionDate) {
return withdraw(savingsId, SavingsRequestBuilders.withdrawal(amount, transactionDate));
}
+
+ /** The server only accepts this command while the force-withdrawal global configuration is enabled. */
+ public PostSavingsAccountTransactionsResponse forceWithdraw(Long savingsId, PostSavingsAccountTransactionsRequest request) {
+ return ok(
+ () -> fineractClient.savingsAccountTransactions().createSavingsAccountTransaction(savingsId, request, "force-withdrawal"));
+ }
+
+ public PostSavingsAccountTransactionsResponse forceWithdraw(Long savingsId, String amount, String transactionDate) {
+ return forceWithdraw(savingsId, SavingsRequestBuilders.withdrawal(amount, transactionDate));
+ }
+
+ public CallFailedRuntimeException withdrawExpectingError(Long savingsId, String amount, String transactionDate) {
+ PostSavingsAccountTransactionsRequest request = SavingsRequestBuilders.withdrawal(amount, transactionDate);
+ return fail(() -> fineractClient.savingsAccountTransactions().createSavingsAccountTransaction(savingsId, request, "withdrawal"));
+ }
+
+ public PostSavingsAccountTransactionsResponse postInterestAsOn(Long savingsId, String transactionDate) {
+ PostSavingsAccountTransactionsRequest request = SavingsRequestBuilders.postInterestAsOn(transactionDate);
+ return ok(
+ () -> fineractClient.savingsAccountTransactions().createSavingsAccountTransaction(savingsId, request, "postInterestAsOn"));
+ }
+
+ public PostSavingsAccountTransactionsResponse holdAmount(Long savingsId, String amount, String transactionDate, String reasonForBlock) {
+ PostSavingsAccountTransactionsRequest request = SavingsRequestBuilders.holdAmount(amount, transactionDate, reasonForBlock);
+ return ok(() -> fineractClient.savingsAccountTransactions().createSavingsAccountTransaction(savingsId, request, "holdAmount"));
+ }
+
+ public CommandProcessingResult reverseTransaction(Long savingsId, Long transactionId) {
+ return adjustTransaction(savingsId, transactionId, "reverse");
+ }
+
+ public CommandProcessingResult undoTransaction(Long savingsId, Long transactionId) {
+ return adjustTransaction(savingsId, transactionId, "undo");
+ }
+
+ public CommandProcessingResult releaseAmount(Long savingsId, Long holdTransactionId) {
+ return adjustTransaction(savingsId, holdTransactionId, "releaseAmount");
+ }
+
+ /** All three commands are driven by the query parameter alone and read no payload, hence the empty body. */
+ private CommandProcessingResult adjustTransaction(Long savingsId, Long transactionId, String command) {
+ PostSavingsAccountBulkReversalTransactionsRequest request = new PostSavingsAccountBulkReversalTransactionsRequest();
+ return ok(() -> fineractClient.savingsAccountTransactions().adjustSavingsAccountTransaction(savingsId, transactionId, request,
+ command));
+ }
+
+ /** The generated client types this response as a bare {@code String}, so the JSON is mapped here. */
+ public SavingsAccountTransactionData getTransaction(Long savingsId, Long transactionId) {
+ String json = ok(() -> fineractClient.savingsAccountTransactions().retrieveOneSavingsAccountTransaction(savingsId, transactionId));
Review Comment:
only two others return a String, both on datatables. Those stay, because a datatable's columns are defined at runtime and that endpoint returns two different shapes - I added a javadoc saying so. I also replaced a hand-built map of 15 query-string keys in the search test with the generated query-params builder.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@fineract.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] FINERACT-2732: migrate the savings and deposit integration tests to the Feign client (Tier 1) [fineract]
Posted by "adamsaghy (via GitHub)" <gi...@apache.org>.
adamsaghy merged PR #6241:
URL: https://github.com/apache/fineract/pull/6241
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@fineract.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org