Skip to content

Fix fuzzer issue template #6963

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
connortsui20 wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Fix fuzzer issue template #6963

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 29 additions & 8 deletions .github/scripts/fuzz_report/templates/new_issue.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,25 +40,33 @@ cargo +nightly fuzz run -D --sanitizer=none {{FUZZ_TARGET}} ./fuzz/artifacts/{{F
```

<details>
<summary>First-time setup: download and extract the crash artifact</summary>
<summary>Reproduction Steps</summary>

1. Download the crash artifact:
- **Direct download**: {{ARTIFACT_URL}}
- Extract the zip file (`unzip`)
- The path should look like `/path/to/{{FUZZ_TARGET}}/{{CRASH_FILE}}`
- You can create a `./fuzz/artifacts` directory that will be git-ignored in the `vortex` repo
- Full path would be `./fuzz/artifacts/{{FUZZ_TARGET}}/{{CRASH_FILE}}`
1. Download the crash artifact: {{ARTIFACT_URL}}

2. Assuming you download the zipfile to `~/Downloads`, and your working directory is the repository root:

```bash
# Create the artifacts directory if you haven't already.
mkdir -p ./fuzz/artifacts

# Move the zipfile.
mv ~/Downloads/{{FUZZ_TARGET}}-crash-artifacts.zip ./fuzz/artifacts/

# Unzip the zipfile.
unzip ./fuzz/artifacts/{{FUZZ_TARGET}}-crash-artifacts.zip -d ./fuzz/artifacts/

# You can remove the zipfile now if you want to.
rm ./fuzz/artifacts/{{FUZZ_TARGET}}-crash-artifacts.zip
```

3. Get a backtrace:
3. Reproduce the crash:

```bash
cargo +nightly fuzz run -D --sanitizer=none {{FUZZ_TARGET}} ./fuzz/artifacts/{{FUZZ_TARGET}}/{{CRASH_FILE}} -- -rss_limit_mb=0
```

If you want a backtrace:

```bash
RUST_BACKTRACE=1 cargo +nightly fuzz run -D --sanitizer=none {{FUZZ_TARGET}} ./fuzz/artifacts/{{FUZZ_TARGET}}/{{CRASH_FILE}} -- -rss_limit_mb=0
Expand All @@ -70,6 +78,19 @@ RUST_BACKTRACE=full cargo +nightly fuzz run -D --sanitizer=none {{FUZZ_TARGET}}

</details>

<details>
<summary>Single command to get a backtrace</summary>

```bash
mkdir -p ./fuzz/artifacts
mv ~/Downloads/{{FUZZ_TARGET}}-crash-artifacts.zip ./fuzz/artifacts/
unzip ./fuzz/artifacts/{{FUZZ_TARGET}}-crash-artifacts.zip -d ./fuzz/artifacts/
rm ./fuzz/artifacts/{{FUZZ_TARGET}}-crash-artifacts.zip
RUST_BACKTRACE=1 cargo +nightly fuzz run -D --sanitizer=none {{FUZZ_TARGET}} ./fuzz/artifacts/{{FUZZ_TARGET}}/{{CRASH_FILE}} -- -rss_limit_mb=0
```

</details>

<!-- seed_hash:{{SEED_HASH}} stack_hash:{{STACK_TRACE_HASH}} message_hash:{{MESSAGE_HASH}} -->

---
Expand Down
Loading