Skip to content

Commit c609905

Browse files
committed
FINERACT-2562: Add Cucumber E2E test instructions to CONTRIBUTING.md
1 parent 98968e5 commit c609905

1 file changed

Lines changed: 42 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,48 @@ Here's how to run the set of relatively fast and independent Fineract tests:
2626
This runs nearly 1,000 tests and completes in a few minutes on decent hardware.
2727
They shouldn't need any special servers/services running.
2828

29+
#### Cucumber E2E tests
30+
31+
The Cucumber E2E tests run against a live Fineract instance instead of starting one for you.
32+
Before running them locally, create the required databases and start Fineract:
33+
34+
```bash
35+
# Create required databases
36+
./gradlew createDB -PdbName=fineract_tenants
37+
./gradlew createDB -PdbName=fineract_default
38+
39+
# Start Fineract in another terminal
40+
./gradlew bootRun -Dspring.profiles.active=test
41+
```
42+
43+
The default E2E test connection settings live in `fineract-e2e-tests-core/src/test/resources/fineract-test-application.properties`.
44+
By default, the test suite connects to `https://localhost:8443`.
45+
46+
Many E2E tests require seeded test data.
47+
That setup is controlled by the `INITIALIZATION_ENABLED` environment variable, which maps to `fineract-test.initialization.enabled`.
48+
For a fresh database, run the suite from `fineract-e2e-tests-runner` with initialization enabled first:
49+
50+
```bash
51+
cd fineract-e2e-tests-runner
52+
INITIALIZATION_ENABLED=true ../gradlew cucumber
53+
```
54+
55+
After the initialization data already exists, you can run all E2E tests without it:
56+
57+
```bash
58+
cd fineract-e2e-tests-runner
59+
../gradlew cucumber
60+
```
61+
62+
To run a single feature file:
63+
64+
```bash
65+
cd fineract-e2e-tests-runner
66+
../gradlew cucumber -Pcucumber.features="src/test/resources/features/Loan.feature"
67+
```
68+
69+
See [Cucumber E2E Tests](https://fineract.apache.org/docs/current/#testing-cucumber) for more details and additional options.
70+
2971
#### Integration tests
3072

3173
Running tests with external dependencies is a multi-step process with many moving parts.

0 commit comments

Comments
 (0)