Fuzzing #726
Merged
Fuzzing #726
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
See fuzz/README.md for details. Example bug: XAMPPRocky#725
Most of the config is to do with what files to parse, however one setting - treat_doc_strings_as_comments - does impact parse_from_slice
|
Thank you for your PR, and related issues! Overall this looks great! I'll give a more in depth review some time soon. |
|
Thank you for your PR, and congrats on your first contribution! 🎉 I'm going to merge this in for now, and we can improve it in-tree, as it looks mostly fine to me.
Yes, I would like tokei to be consistent. |
|
Great, I'll run the fuzzer again when the existing issues are fixed. |
kornysietsma
pushed a commit
to kornysietsma/tokei
that referenced
this pull request
Nov 16, 2022
* Add fuzzing support See fuzz/README.md for details. Example bug: XAMPPRocky#725 * improve fuzz docs * fuzzing: make relevant config part of input Most of the config is to do with what files to parse, however one setting - treat_doc_strings_as_comments - does impact parse_from_slice * fuzzing: improve docs + config clarity * fuzz/README.md: install instructions + another todo item
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Add a cargo-fuzz harness to make it easy to fuzz test the file parser for robustness and accuracy.
See fuzz/README.md for details.
With only a few seconds run time I found #725 - I suspect there are many more, if this kind of consistency bug is of interest.
When looking for panics only, after a few hours and 80 million executions, it found #727. There may be more to find after this one is fixed.
I am a novice Rust programmer - apologies in advance for blunders; any suggestions for better ways of doing things are welcome.
The only change to the existing tokei code is to make each LanguageType derive from Arbitrary. This makes it really easy to write a clean fuzzing harness. If it's desirable to avoid including this in release builds, I think we could conditionally compile it using cfg(fuzzing)?