doc: describe in fuzzing.md how to reproduce a CI crash #22056
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Concept ACK, this is definitely required information if we keep running the fuzz corpus in CI. |
jonatack
force-pushed
the
fuzzing-doc-describe-how-to-reproduce-ci-crash
branch
from
8c0d7d5
to
86f7f22
Compare
maflcko
approved these changes
May 25, 2021
doc/fuzzing.md
Outdated
| @@ -81,6 +81,17 @@ INFO: seed corpus: files: 991 min: 1b max: 1858b total: 288291b rss: 150Mb | |||
| … | |||
| ``` | |||
|
|
|||
| ## Reproduce a fuzzer crash found by the CI | |||
There was a problem hiding this comment.
After a private discussion. "found" might confuse some readers, as the CI currently does not search for new inputs. It is repeating the existing test inputs like the unit tests.
There was a problem hiding this comment.
I hesitated on "found" as well..."reported"?
|
How about -## Fuzzing harnesses, fuzzing output and fuzzing corpora
+## Fuzzing harnesses and output
[`process_message`](https://github.com/bitcoin/bitcoin/blob/master/src/test/fuzz/process_message.cpp) is a fuzzing harness for the [`ProcessMessage(...)` function (`net_processing`)](https://github.com/bitcoin/bitcoin/blob/master/src/net_processing.cpp). The available fuzzing harnesses are found in [`src/test/fuzz/`](https://github.com/bitcoin/bitcoin/tree/master/src/test/fuzz).
@@ -64,6 +64,8 @@ block^@M-^?M-^?M-^?M-^?M-^?nM-^?M-^?
In this case the fuzzer managed to create a `block` message which when passed to `ProcessMessage(...)` increased coverage.
+## Fuzzing corpora
+
The project's collection of seed corpora is found in the [`bitcoin-core/qa-assets`](https://github.com/bitcoin-core/qa-assets) repo.
|
jonatack
force-pushed
the
fuzzing-doc-describe-how-to-reproduce-ci-crash
branch
from
86f7f22
to
fdb20ea
Compare
and add/improve a few headers
jonatack
force-pushed
the
fuzzing-doc-describe-how-to-reproduce-ci-crash
branch
from
fdb20ea
to
d8f1ea7
Compare
|
@MarcoFalke I added a bullet point from your IRC comment.
|
|
Concept ACK Thanks for documenting this! Will review. |
|
ACK d8f1ea7 |
sidhujag
pushed a commit
to syscoin/syscoin
that referenced
this pull request
May 27, 2021
…I crash d8f1ea7 doc: describe in fuzzing.md how to reproduce a CI crash (Jon Atack) Pull request description: Not sure if this is 100% accurate or missing any pertinent info, but I misremembered how to do this today and it seems like useful information to provide. ACKs for top commit: practicalswift: ACK d8f1ea7 Tree-SHA512: 1b74e4187e6ea13b04eb03b3c6e2615c4eb18cc38cce215ad1645f8b135c5c31a243748eb313ccec05f1f62187ba33d550119acf07088968d2d2c1c09bc4c653
gwillen
pushed a commit
to ElementsProject/elements
that referenced
this pull request
Jun 1, 2022
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Not sure if this is 100% accurate or missing any pertinent info, but I misremembered how to do this today and it seems like useful information to provide.