You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+11-3Lines changed: 11 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -175,20 +175,28 @@ If you see an error saying that `libjvm.so` has not been found, make sure that `
175
175
176
176
## Directories and files
177
177
178
-
Jazzer uses two directories to store inputs: the *generated corpus directory* and the *inputs directory*.
178
+
Jazzer uses two main directories to store inputs: the *generated corpus directory* and the *inputs directory*.
179
+
180
+
> [!IMPORTANT]
181
+
> If you are using Git and want to add the corpus directories to the repository, mark them as `binary` in your `.gitattributes` file:
182
+
>
183
+
> ```gitattributes
184
+
> src/test/resources/** binary
185
+
> .cifuzz-corpus/** binary
186
+
> ```
179
187
180
188
### Generated corpus directory
181
189
182
190
The *generated corpus directory* is where Jazzer saves inputs that generate new coverage during fuzzing.
183
191
It is located in `.cifuzz-corpus/<package>/<FuzzTestClass>/<fuzzTestMethod>`, where `<package>`, `<FuzzTestClass>`, and `<fuzzTestMethod>` correspond to the package name, class name, and method name of the fuzz test, respectively.
184
-
For example, if the fuzz test is in the class `src/test/java/com/example/ValidFuzzTestsInputs.java`, method `byteFuzz`, the corpus directory is located in `.cifuzz-corpus/com.example.ValidFuzzTestsInputs/byteFuzz`.
192
+
For example, if the fuzz test is in the class `src/test/java/com/example/ValidFuzzTests.java`, method `byteFuzz`, the corpus directory is located in `.cifuzz-corpus/com.example.ValidFuzzTests/byteFuzz`.
185
193
186
194
187
195
### Inputs directory
188
196
189
197
Any input that triggers a crash during fuzzing is saved to the *inputs directory*.
190
198
This directory is derived from the package and class name of the fuzz test.
191
-
For example, if the fuzz test is in the class `src/test/java/com/example/ValidFuzzTestsInputs.java`, method `byteFuzz`, the *inputs directory* is located in `src/test/resources/com/example/ValidFuzzTestsInputs/byteFuzz`.
199
+
For example, if the fuzz test is in the class `src/test/java/com/example/ValidFuzzTests.java`, method `byteFuzz`, the *inputs directory* is located in `src/test/resources/com/example/ValidFuzzTestsInputs/byteFuzz`.
192
200
If this directory does not exist, Jazzer will save crash inputs in the directory from which the tests are executed.
0 commit comments