This is an automated email from the ASF dual-hosted git repository.
meonkeys pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/fineract.git
The following commit(s) were added to refs/heads/develop by this push:
new 3d33388fb5 don't duplicate testing instructions ☠️
new 9c2e66c889 Merge pull request #6680 from
meonkeys/FINERACT-2835-improve-testing-docs
3d33388fb5 is described below
commit 3d33388fb5b8fd73047cd48a0a00ee340fdc474e
Author: Adam Monsen <[email protected]>
AuthorDate: Tue Sep 22 15:32:25 2026 -0700
don't duplicate testing instructions ☠️
also: add `-x :fineract-e2e-tests-runner:test` -- those require a
Fineract server.
also: link to /develop/ docs instead of /current/ when we're in the
context of dev/test. It makes more sense to direct testers at the
bleeding edge docs since that's more likely to closer in time to the
code they're testing.
---
CONTRIBUTING.md | 26 ++++++++++++++------------
README.md | 43 ++-----------------------------------------
2 files changed, 16 insertions(+), 53 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index c5bf0ecf3e..b637a6944d 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -25,15 +25,18 @@ We need a lot of help besides code changes. For example, we
also welcome wiki ed
Here's how to run the set of relatively fast and independent Fineract tests:
```bash
-./gradlew test -x :twofactor-tests:test -x :oauth2-tests:test -x
:integration-tests:test
+./gradlew test -x :twofactor-tests:test -x :oauth2-tests:test -x
:integration-tests:test -x :fineract-e2e-tests-runner:test
```
-This runs nearly 1,000 tests and completes in a few minutes on decent hardware.
+This runs over 1,500 tests and completes in ~5 minutes on decent hardware.
They shouldn't need any special servers/services running.
+The integration, two-factor, OAuth2 and Cucumber E2E suites all require a live
Fineract instance over HTTP, and the
+build does not start one for you. Start one first, or every API-dependent test
will fail.
+
#### Cucumber E2E tests
-The Cucumber E2E tests run against a live Fineract instance instead of
starting one for you.
+The Cucumber E2E tests run against a live Fineract instance. You must start
Fineract yourself.
Before running them locally, create the required databases and start Fineract:
```bash
@@ -75,8 +78,8 @@ See [Cucumber E2E
Tests](https://fineract.apache.org/docs/current/#testing-cucum
#### Integration tests
-Like the Cucumber tests, the integration tests run against a live Fineract
instance instead of starting one for you.
-Bring one up first — the Docker stack is what CI uses, so it is the
configuration these suites are verified against:
+Like the Cucumber tests, the integration tests also require a live Fineract
instance.
+Bring one up first. The Docker stack is what CI uses, so it is the
configuration these suites are verified against:
```bash
# Build the image once
@@ -89,11 +92,10 @@ docker compose -f docker-compose-postgresql-test.yml up -d
./gradlew :integration-tests:test --tests ClientLoanIntegrationTest
```
-`./gradlew :fineract-provider:bootRun` works too, provided you created the
databases as shown above for the
-Cucumber tests. `:twofactor-tests` and `:oauth2-tests` need the server started
in a different authentication mode,
-and `docker-compose-war-test.yml` runs the WAR in a stock Tomcat instead of
the Spring Boot jar; see
-[Integration
Testing](https://fineract.apache.org/docs/current/#testing-integration) for
those and for the
-`BACKEND_*` variables that point the suites at a non-default address.
+Docker is not required, though.
+Starting `ServerApplication` from your IDE or `./gradlew devRun` from the
command line both work too provided you have a running, initialized database as
shown above for the Cucumber tests (and have customized `BACKEND_PROTOCOL`,
`BACKEND_HOST`, and `BACKEND_PORT` environment variables as necessary).
+
+`:twofactor-tests` and `:oauth2-tests` need the server started in a different
authentication mode, and `docker-compose-war-test.yml` runs the WAR in a stock
Tomcat instead of the Spring Boot jar; see [Integration
Testing](https://fineract.apache.org/docs/develop/#testing-integration) for
those and for the `BACKEND_*` variables that point the suites at a non-default
address.
Running tests with external dependencies is a multi-step process with many
moving parts.
Sometimes there are arbitrary failures and the prerequisite setup can be
daunting.
@@ -177,7 +179,7 @@ Some dependencies are required (e.g. Ghostscript,
Graphviz), see [.github/workfl
IDEs such as IntelliJ are useful for editing the AsciiDoc source files while
providing a live rendered preview.
-HTML rendered from the AsciiDoc source files is also available online at
[https://fineract.apache.org/docs/current/](https://fineract.apache.org/docs/current/).
+HTML rendered from the AsciiDoc source files is also available online at
<https://fineract.apache.org/docs/develop/>.
## Recommended IDEs
@@ -357,7 +359,7 @@ If merging the PR resolved a JIRA issue, mark that issue as
resolved and set "Fi
All commits must be signed with GPG keys.
-For GPG setup instructions, see the [Fineract GPG
Guide](https://fineract.apache.org/docs/current/#_gpg_2).
+For GPG setup instructions, see the [Fineract GPG
Guide](https://fineract.apache.org/docs/develop/#_signing_releases).
Commit signatures may be checked locally with `git log --show-signature`, and
a "Verified" badge should appear on GitHub for [every
commit](https://github.com/apache/fineract/commits/).
diff --git a/README.md b/README.md
index c690a8c611..cac377026f 100644
--- a/README.md
+++ b/README.md
@@ -39,7 +39,7 @@ For a list of known vulnerabilities, see [Apache Fineract
Security Reports](http
If you believe you have found a new vulnerability, [let us know
privately](https://fineract.apache.org/#contribute).
-For details about security during development and deployment, see the
documentation [here](https://fineract.apache.org/docs/stable/#_security).
+For details about security during development and deployment, see the
documentation [here](https://fineract.apache.org/docs/develop/#_security).
PRIVATE FORKS
============
@@ -116,46 +116,7 @@ Expected response for fresh instance:
How to run the tests
---
-Unit tests need nothing running:
-
-```bash
-./gradlew test -x :integration-tests:test -x :twofactor-tests:test -x
:oauth2-tests:test
-```
-
-The integration, two-factor, OAuth2 and Cucumber E2E suites all drive a **live
Fineract instance over HTTP, and the
-build does not start one for you** — start it first, or every test fails on
connection refused. The Docker stack is
-what CI uses, so it is the configuration these suites are actually verified
against:
-
-```bash
-# build the image once
-./gradlew :fineract-provider:jibDockerBuild -Djib.to.image=fineract -x test -x
cucumber
-
-# start Fineract plus its database, LocalStack and the mock OAuth2 server
-docker compose -f docker-compose-postgresql-test.yml up -d
-./gradlew :integration-tests:waitForFineract
-
-./gradlew :integration-tests:test --tests ClientLoanIntegrationTest
-```
-
-Use `docker-compose-mariadb-test.yml` or `docker-compose-mysql-test.yml` for
the other database engines.
-
-Docker is not a requirement, though. Anything that serves
`https://localhost:8443/fineract-provider` works just as
-well — `./gradlew devRun` from the Quick Start above, or `ServerApplication`
from your IDE — since that is the
-address the suites default to. Point them somewhere else with the
`BACKEND_PROTOCOL`, `BACKEND_HOST` and
-`BACKEND_PORT` environment variables.
-
-`:twofactor-tests` and `:oauth2-tests` need the server started in a different
authentication mode, so they cannot
-share an instance with `:integration-tests`. Layer the matching override on
top and recreate the service:
-
-```bash
-docker compose -f docker-compose-postgresql-test.yml -f
docker-compose-twofactor-test.yml \
- up -d --force-recreate fineract
-./gradlew :twofactor-tests:test
-```
-
-See [CONTRIBUTING.md](CONTRIBUTING.md#how-to-run-tests) and the
-[Integration
Testing](https://fineract.apache.org/docs/current/#testing-integration) chapter
for the rest.
-
+See [CONTRIBUTING.md](CONTRIBUTING.md#how-to-run-tests) and [Integration
Testing](https://fineract.apache.org/docs/develop/#_integration_testing).
How to run for production
---