Skip to content
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

Jump to bottom

Rename fuzz_seed_corpus? #200

Closed
maflcko opened this issue Aug 23, 2024 · 4 comments · Fixed by #205
Closed

Rename fuzz_seed_corpus? #200

maflcko opened this issue Aug 23, 2024 · 4 comments · Fixed by #205

Comments

@maflcko
Copy link
Contributor

maflcko commented Aug 23, 2024

With the cmake-migration all fuzz scripts will have to be touched, which is probably the best time to rename the folder if there is desire to do so.

The current name is minimally confusing, because seed doesn't really apply. In reality it is a collection of fuzz input seeds, as well as fuzz inputs.

So my recommendation would be to just drop seed. This will also allow in the future (when there is a need and desire) to provide a minimal set of possibly hand-crafted or otherwise non-fuzz-generated fuzz seed inputs to some fuzz targets (and possibly store them in a separate folder and validate that their format is still accurate and matches the fuzz target code). Even if this is never done, dropping seed may still be useful.

Also, corpus could be renamed to corpora, to clarify that the folder holds the fuzz inputs for several fuzz targets.

Thoughts?
@maflcko
Copy link
Contributor Author

maflcko commented Aug 23, 2024

cc @murchandamus @dergoegge yay or nay?

@dergoegge
Copy link
Member

ACK fuzz_corpora

@murchandamus
Copy link
Contributor

Yay, fuzz_corpora!

@maflcko
Copy link
Contributor Author

maflcko commented Aug 23, 2024

Ok, I'll propose a pull request to do the git mv ./fuzz_seed_corpus fuzz_corpora on Monday, unless someone beats me to it.

This was referenced Sep 3, 2024
Merged
Merged
fanquake added a commit to bitcoin/bitcoin that referenced this issue Sep 4, 2024
@fanquake
Merge #30804: fuzz: Rename fuzz_seed_corpus to fuzz_corpora
ab317ad 
8888bee scripted-diff: fuzz: Rename fuzz_seed_corpus to fuzz_corpora (MarcoFalke)

Pull request description:

  Now that cmake was a breaking change for all fuzz scripts, it seems fine to bundle it with another breaking change to rename the fuzz corpora directory, as discussed and approved in bitcoin-core/qa-assets#200:

  * The word "seed" in the old name doesn't really apply. In reality it is a collection of fuzz input seeds, as well as fuzz inputs.
  * The rename will also allow in the future (when there is a need and desire) to provide a minimal set of possibly hand-crafted or otherwise non-fuzz-generated fuzz seed inputs to some fuzz targets (and possibly store them in a separate folder and validate that their format is still accurate and matches the fuzz target code).
  * Finally, "corpus" is renamed to corpora, to clarify that the folder holds the fuzz inputs for several fuzz targets.

ACKs for top commit:
  brunoerg:
    ACK 8888bee
  marcofleon:
    ACK 8888bee

Tree-SHA512: abc693ca5d946850f04b6349e2a98f8fbc2ba9991be5a025bc0f357e341cbe7510f2f5f0e47b997d07136736d818df361270f372b8fb70860995a0605ca81e4d
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

git mv fuzz_seed_corpus fuzz_corpora maflcko/bitcoin-core-qa-assets
3 participants
@murchandamus @maflcko @dergoegge