Update fuzzing instructions for libFuzzer/cargo-fuzz #2702
Conversation
G8XSU
commented
Nov 3, 2023
•
G8XSU
commented
- Update fuzzing instructions for libFuzzer/cargo-fuzz
- This is also helpful for uploading fuzzing artifacts to ClusterFuzz, which can be used for distributed fuzzing.
Codecov ReportAll modified and coverable lines are covered by tests ✅
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. Additional details and impacted files@@ Coverage Diff @@
## main #2702 +/- ##
==========================================
- Coverage 89.06% 88.77% -0.29%
==========================================
Files 112 113 +1
Lines 87157 89126 +1969
Branches 87157 89126 +1969
==========================================
+ Hits 77629 79126 +1497
- Misses 7301 7751 +450
- Partials 2227 2249 +22 ☔ View full report in Codecov by Sentry. |
fuzz/README.md
Outdated
| issues locally, and Travis merely acts as a sanity check. Fuzzing is further only effective with | ||
| a lot of CPU time, indicating that if crash scenarios are discovered on Travis with its low | ||
| runtime constraints, the crash is caused relatively easily. | ||
| Typically, Travis CI will run `travis-fuzz.sh` on one of the environments the automated tests are |
There was a problem hiding this comment.
Lol we dropped travis long ago. Also its not really the longest part of our CI anymore, the test shell script takes about as long as fuzzing. Not that critical to fix, though.
There was a problem hiding this comment.
lol, I didn't know what travis ci is, i just thought we gave it a nickname.
| To run fuzzing using `cargo-fuzz / libFuzzer`, run | ||
|
|
||
| ```shell | ||
| rustup install nightly # Note: libFuzzer requires a nightly version of rust. |
There was a problem hiding this comment.
Is cargo install cargo-fuzz necessary here?
There was a problem hiding this comment.
yes it is, mentioned in setup above.
| You typically won't need to run the entire combination of different fuzzing tools. For local execution, `honggfuzz` | ||
| should be more than sufficient. | ||
| We support multiple fuzzing engines such as `honggfuzz`, `libFuzzer` and `AFL`. You typically won't | ||
| need to run the entire suite of different fuzzing tools. For local execution, `honggfuzz`should be |
There was a problem hiding this comment.
nit:
| need to run the entire suite of different fuzzing tools. For local execution, `honggfuzz`should be | |
| need to run the entire suite of different fuzzing tools. For local execution, `honggfuzz` should be |
