Skip to content

Commit 5ea6a2e

Browse files
committed
Enhance E2E flaky test guide with flakeguard validation instructions and additional parameters
1 parent ae1f4a1 commit 5ea6a2e

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

tools/flakeguard/e2e-flaky-test-guide.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,30 @@ Below are the some of the GitHub-hosted runners available in our organization:
3636
Flaky tests don't fail on every run, so you need to execute them multiple times to isolate problems.
3737

3838
### 2.1 Repeat Runs
39-
For E2E tests, run them 5–10 times consecutively to expose intermittent issues.
39+
For E2E tests, run them 5–10 times consecutively to expose intermittent issues. To run the tests with flakeguard validation, execute the following command from the `chainlink-core/` directory:
40+
41+
```sh
42+
cd chainlink-core/
43+
make run_flakeguard_validate_e2e_tests
44+
```
45+
46+
You’ll be prompted to provide:
47+
- **Test IDs** (e.g., `smoke/forwarders_ocr2_test.go:*,smoke/vrf_test.go:*`)
48+
49+
*Note: Test IDs can be taken from the `e2e-tests.yml` file.*
50+
51+
- **Number of runs** (default: 5)
52+
- **Chainlink version** (default: develop)
53+
- **Branch name** (default: develop)
54+
4055

4156
### 2.2 Flaky Unit Tests in the Core Repository
4257
For unit tests in the core repository, you can use a dedicated command to detect flakiness in an updated test:
4358

4459

4560
```sh
4661
cd chainlink-core/
47-
make run_flakeguard_validate_tests
62+
make run_flakeguard_validate_unit_tests
4863
```
4964

5065

0 commit comments

Comments
 (0)