@@ -20,40 +20,11 @@ go install github.com/smartcontractkit/chainlink-testing-framework/tools/flakegu
2020
2121## Usage
2222
23- Flakeguard offers two main commands: ` find ` and ` run ` .
23+ Flakeguard offers two main commands:
24+ - ` find ` identifies test packages affected by recent changes.
25+ - ` run ` executes tests multiple times to identify flaky tests
2426
25- ### ` find ` Command
26-
27- The ` find ` command identifies test packages affected by recent changes.
28-
29- #### Flags for ` find ` Command
30-
31- - ` --project-path, -r ` : Path to the Go project. Defaults to the current directory.
32- - ` --base-ref ` (required): Git reference (branch, tag, or commit) for comparing changes.
33- - ` --verbose, -v ` : Enables verbose mode.
34- - ` --json ` : Outputs results in JSON format.
35- - ` --filter-empty-tests ` : Filters out test packages with no actual test functions (can be slow on large projects).
36- - ` --excludes ` : List of paths to exclude.
37- - ` --levels, -l ` : Levels of recursion for dependency search, with ` 0 ` for unlimited. ` 2 ` by default.
38- - ` --find-by-test-files-diff ` : Enable mode to find affected test packages by changes in test files.
39- - ` --find-by-affected-packages ` : Enable mode to find affected test packages based on changes in any project package.
40- - ` --only-show-changed-test-files ` : Display only changed test files and exit.
41-
42- ### ` run ` Command
43-
44- The ` run ` command executes tests multiple times to identify flaky tests.
45-
46- #### Flags for ` run ` Command
47-
48- - ` --project-path, -r ` : Path to the Go project. Defaults to the current directory.
49- - ` --test-packages-json ` : JSON-encoded string of test packages to run.
50- - ` --test-packages ` : List of test packages to run.
51- - ` --run-count, -c ` : Number of times to run the tests.
52- - ` --race ` : Enable race condition detection.
53- - ` --output-json ` : File path to output test results in JSON format.
54- - ` --threshold ` : Threshold (0-1) for determining flakiness (e.g., ` 0.8 ` to pass if 80% successful).
55- - ` --skip-tests ` : List of tests to skip.
56- - ` --fail-fast ` : Stop on the first failure if threshold is set to ` 1.0 ` .
27+ Run with ` --help ` to see all flags for the commands.
5728
5829### JSON Output
5930
0 commit comments