Skip to content

Commit 1770a43

Browse files
authored
Merge branch 'develop' into integration-clickhouse-benchmark-baseline
2 parents 178e43f + 34bd5ba commit 1770a43

1 file changed

Lines changed: 29 additions & 8 deletions

File tree

.github/scripts/fuzz_report/templates/new_issue.md

Lines changed: 29 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -40,25 +40,33 @@ cargo +nightly fuzz run -D --sanitizer=none {{FUZZ_TARGET}} ./fuzz/artifacts/{{F
4040
```
4141

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

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

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

5449
```bash
50+
# Create the artifacts directory if you haven't already.
5551
mkdir -p ./fuzz/artifacts
52+
53+
# Move the zipfile.
5654
mv ~/Downloads/{{FUZZ_TARGET}}-crash-artifacts.zip ./fuzz/artifacts/
55+
56+
# Unzip the zipfile.
5757
unzip ./fuzz/artifacts/{{FUZZ_TARGET}}-crash-artifacts.zip -d ./fuzz/artifacts/
58+
59+
# You can remove the zipfile now if you want to.
5860
rm ./fuzz/artifacts/{{FUZZ_TARGET}}-crash-artifacts.zip
5961
```
6062

61-
3. Get a backtrace:
63+
3. Reproduce the crash:
64+
65+
```bash
66+
cargo +nightly fuzz run -D --sanitizer=none {{FUZZ_TARGET}} ./fuzz/artifacts/{{FUZZ_TARGET}}/{{CRASH_FILE}} -- -rss_limit_mb=0
67+
```
68+
69+
If you want a backtrace:
6270

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

7179
</details>
7280

81+
<details>
82+
<summary>Single command to get a backtrace</summary>
83+
84+
```bash
85+
mkdir -p ./fuzz/artifacts
86+
mv ~/Downloads/{{FUZZ_TARGET}}-crash-artifacts.zip ./fuzz/artifacts/
87+
unzip ./fuzz/artifacts/{{FUZZ_TARGET}}-crash-artifacts.zip -d ./fuzz/artifacts/
88+
rm ./fuzz/artifacts/{{FUZZ_TARGET}}-crash-artifacts.zip
89+
RUST_BACKTRACE=1 cargo +nightly fuzz run -D --sanitizer=none {{FUZZ_TARGET}} ./fuzz/artifacts/{{FUZZ_TARGET}}/{{CRASH_FILE}} -- -rss_limit_mb=0
90+
```
91+
92+
</details>
93+
7394
<!-- seed_hash:{{SEED_HASH}} stack_hash:{{STACK_TRACE_HASH}} message_hash:{{MESSAGE_HASH}} -->
7495

7596
---

0 commit comments

Comments
 (0)