mirror of
https://github.com/apache/datafusion-sqlparser-rs.git
synced 2025-07-07 17:04:59 +00:00
docs: fuzzing
Signed-off-by: Chojan Shang <psiace@outlook.com>
This commit is contained in:
parent
1e65984613
commit
0c52491191
1 changed files with 6 additions and 3 deletions
38
docs/fuzzing.md
Normal file
38
docs/fuzzing.md
Normal file
|
@ -0,0 +1,38 @@
|
|||
# Fuzzing
|
||||
|
||||
## Installing `honggfuzz`
|
||||
|
||||
```
|
||||
cargo install honggfuzz
|
||||
```
|
||||
|
||||
Install [dependencies](https://github.com/rust-fuzz/honggfuzz-rs#dependencies) for your system.
|
||||
|
||||
## Running the fuzzer
|
||||
|
||||
Running the fuzzer is as easy as running in the `fuzz` directory.
|
||||
|
||||
Choose a target:
|
||||
|
||||
These are `[[bin]]` entries in `Cargo.toml`.
|
||||
List them with `cargo read-manifest | jq '.targets[].name'` from the `fuzz` directory.
|
||||
|
||||
Run the fuzzer:
|
||||
|
||||
```shell
|
||||
cd fuzz
|
||||
cargo hfuzz run <target>
|
||||
```
|
||||
|
||||
After a panic is found, get a stack trace with:
|
||||
|
||||
```shell
|
||||
cargo hfuzz run-debug <target> hfuzz_workspace/<target>/*.fuzz
|
||||
```
|
||||
|
||||
For example, with the `fuzz_parse_sql` target:
|
||||
|
||||
```shell
|
||||
cargo hfuzz run fuzz_parse_sql
|
||||
cargo hfuzz run-debug fuzz_parse_sql hfuzz_workspace/fuzz_parse_sql/*.fuzz
|
||||
```
|
Loading…
Add table
Add a link
Reference in a new issue