Skip to content

Commit 53a89c9

Browse files
committed
Add instructions for running performance tests manually.
1 parent 1849d9c commit 53a89c9

1 file changed

Lines changed: 54 additions & 0 deletions

File tree

test/performance/README.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,60 @@ The results will be displayed in the console.
2222
The test is run after every merge to dev-2.x. Its GitHub Actions workflow is defined
2323
in [performance-test.yml](/.github/workflows/performance-test.yml).
2424

25+
### Running the test manually
26+
27+
Sometimes it is desirable to run the test configuration in the CI environment manually, for
28+
example, when making changes to the tests. To do this, perform these steps:
29+
1. Create a local branch in git that contains the desired performance test configuration.
30+
2. In [performance-test.yml](/.github/workflows/performance-test.yml) add your test branch name to
31+
the configuration and change all `profile`s to `core`:
32+
```diff
33+
name: Performance test
34+
35+
on:
36+
push:
37+
branches:
38+
- dev-2.x
39+
+ - test-branch-name
40+
41+
jobs:
42+
perf-test:
43+
if: github.repository_owner == 'opentripplanner' && !startsWith(github.event.head_commit.message ,'Bump serialization version id for') && !startsWith(github.event.head_commit.message ,'Upgrade debug client to version')
44+
runs-on: performance-test
45+
strategy:
46+
fail-fast: false
47+
matrix:
48+
include:
49+
...
50+
- location: baden-wuerttemberg # German state of Baden-Württemberg: https://en.wikipedia.org/wiki/Baden-W%C3%BCrttemberg
51+
iterations: 1
52+
jfr-delay: "50s"
53+
- profile: extended
54+
+ profile: core
55+
56+
- location: switzerland
57+
iterations: 1
58+
jfr-delay: "50s"
59+
- profile: extended
60+
+ profile: core
61+
62+
- location: washington-state
63+
iterations: 1
64+
jfr-delay: "20s"
65+
- profile: extended
66+
+ profile: core
67+
68+
- location: helsinki
69+
iterations: 1
70+
jfr-delay: "50s"
71+
- profile: extended
72+
+ profile: core
73+
...
74+
```
75+
3. Commit the changes to [performance-test.yml](/.github/workflows/performance-test.yml).
76+
4. Push the changes to a branch in the **upstream** [OpenTripPlanner](https://github.com/opentripplanner/OpenTripPlanner/) repository with the same name you added to [performance-test.yml](/.github/workflows/performance-test.yml).
77+
5. The tests will run after the push.
78+
2579
## Instrumentation
2680

2781
Each run on CI is instrumented with Java Flight Recorder. The results are then saved as an artifact

0 commit comments

Comments
 (0)