Skip to content

Commit 66a103d

Browse files
committed
readme: improve core and tests doc
1 parent 6916627 commit 66a103d

File tree

2 files changed

+18
-1
lines changed

2 files changed

+18
-1
lines changed

core/README.md

+16-1
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ You'll need:
3333
- Java 17
3434
- Python >= 3.9 (For generating example / test files)
3535
- Install the `python/railjson_generator` library using poetry:
36+
3637
```sh
3738
poetry --directory=../python/railjson_generator install
3839
```
@@ -47,7 +48,7 @@ You'll need:
4748
gradlew.bat processTestResources shadowJar
4849

4950
# Run as service
50-
java -jar build/libs/osrd-all.jar api --url http://localhost:8090/ -p 8080
51+
java -jar build/libs/osrd-all.jar api --editoast-url http://localhost:8090/ -p 8080
5152

5253
# Check that an infra can be loaded
5354
java -jar build/libs/osrd-all.jar load-infra --path RAILJSON_INFRA
@@ -67,3 +68,17 @@ gradlew.bat processTestResources shadowJar
6768
java -jar build/libs/osrd-all.jar standalone-simulation --infra_path example/infra.json \
6869
--sim_path example/simulation.json --res_path example/results.json
6970
```
71+
72+
### Tests and tooling
73+
74+
To launch all the checks on core (tests and code quality), run:
75+
76+
```sh
77+
./gradlew check
78+
```
79+
80+
To launch tests only, run:
81+
82+
```sh
83+
./gradlew test
84+
```

tests/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ To run tests `poetry run pytest` after starting docker containers (`docker compo
66

77
To run a list of specific tests, run `poetry run pytest -k test_name_1 test_name_2 ...`.
88

9+
To setup end-to-end (e2e) tests, please see [front readme](../front/README.md#yarn-e2e-tests).
10+
911
### Create new integration tests
1012

1113
To add a test, follow [pytest doc](https://docs.pytest.org/).

0 commit comments

Comments
 (0)