Skip to content

Commit 7e2b64e

Browse files
committed
More clearly document that only a single fuzz test is fuzzed per run
Work towards #599
1 parent e3412fd commit 7e2b64e

File tree

2 files changed

+3
-2
lines changed

2 files changed

+3
-2
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,7 @@ The following steps assume that JUnit 5.9.0 or higher is set up for your project
6565
3. Assuming your test class is called `com.example.MyFuzzTests`, create the *inputs directory* `src/test/resources/com/example/MyFuzzTestsInputs`.
6666
4. Run a fuzz test with the environment variable `JAZZER_FUZZ` set to `1` to let the fuzzer rapidly try new sets of arguments.
6767
If the fuzzer finds arguments that make your fuzz test fail or even trigger a security issue, it will store them in the inputs directory.
68+
In this mode, only a single fuzz test is executed per test run (see [#599](https://github.com/CodeIntelligenceTesting/jazzer/issues/599) for details).
6869
5. Run the fuzz test without `JAZZER_FUZZ` set to execute it only on the inputs in the inputs directory.
6970
This mode, which behaves just like a traditional unit test, ensures that issues previously found by the fuzzer remain fixed and can also be used to debug the fuzz test on individual inputs.
7071

src/main/java/com/code_intelligence/jazzer/junit/FuzzTest.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,8 +74,8 @@
7474
* <p>When no issue has been found after the configured {@link FuzzTest#maxDuration()}, the test
7575
* passes.
7676
*
77-
* <p>Only a single fuzz test per test run will be executed in fuzzing mode. All other fuzz tests
78-
* will be skipped.
77+
* <p><b>In fuzzing mode, only a single fuzz test per test run will be executed.</b> All other fuzz
78+
* tests will be skipped.
7979
*
8080
* <h3>Regression testing</h3>
8181
*

0 commit comments

Comments
 (0)