Upgrade to clap 4 #263
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,7 @@ | ||
| use clap::crate_version; | ||
|
|
||
| use std::env; | ||
| use std::ffi::{OsStr, OsString}; | ||
| use std::io; | ||
| use std::process::{self, Command, ExitStatus, Stdio}; | ||
| use std::sync::{Arc, Condvar, Mutex}; | ||
|
|
@@ -30,59 +30,55 @@ fn main() { | |
| match afl_matches.subcommand() { | ||
| Some(("analyze", sub_matches)) => { | ||
| let args = sub_matches | ||
| .get_many::<OsString>("afl-analyze args") | ||
| .unwrap_or_default(); | ||
| run_afl(args, "afl-analyze", None); | ||
| } | ||
| Some(("cmin", sub_matches)) => { | ||
| let args = sub_matches | ||
| .get_many::<OsString>("afl-cmin args") | ||
| .unwrap_or_default(); | ||
| run_afl(args, "afl-cmin", None); | ||
| } | ||
| Some(("fuzz", sub_matches)) => { | ||
| let args = sub_matches | ||
| .get_many::<OsString>("afl-fuzz args") | ||
| .unwrap_or_default(); | ||
| let timeout = sub_matches.get_one::<u64>("max_total_time").copied(); | ||
| run_afl(args, "afl-fuzz", timeout); | ||
| } | ||
| Some(("gotcpu", sub_matches)) => { | ||
| let args = sub_matches | ||
| .get_many::<OsString>("afl-gotcpu args") | ||
| .unwrap_or_default(); | ||
| run_afl(args, "afl-gotcpu", None); | ||
| } | ||
| Some(("plot", sub_matches)) => { | ||
| let args = sub_matches | ||
| .get_many::<OsString>("afl-plot args") | ||
| .unwrap_or_default(); | ||
| run_afl(args, "afl-plot", None); | ||
| } | ||
| Some(("showmap", sub_matches)) => { | ||
| let args = sub_matches | ||
| .get_many::<OsString>("afl-showmap args") | ||
| .unwrap_or_default(); | ||
| run_afl(args, "afl-showmap", None); | ||
| } | ||
| Some(("tmin", sub_matches)) => { | ||
| let args = sub_matches | ||
| .get_many::<OsString>("afl-tmin args") | ||
| .unwrap_or_default(); | ||
| run_afl(args, "afl-tmin", None); | ||
| } | ||
| Some(("whatsup", sub_matches)) => { | ||
| let args = sub_matches | ||
| .get_many::<OsString>("afl-whatsup args") | ||
| .unwrap_or_default(); | ||
| run_afl(args, "afl-whatsup", None); | ||
| } | ||
| Some((subcommand, sub_matches)) => { | ||
| let args = sub_matches.get_many::<OsString>("").unwrap_or_default(); | ||
| run_cargo(subcommand, args); | ||
| } | ||
| // unreachable due to SubcommandRequiredElseHelp on "afl" subcommand | ||
|
|
@@ -91,138 +87,134 @@ fn main() { | |
| } | ||
|
|
||
| #[allow(clippy::too_many_lines)] | ||
| fn clap_app() -> clap::Command { | ||
| use clap::{value_parser, Arg, Command}; | ||
|
|
||
| Command::new("cargo afl") | ||
| .display_name("cargo") | ||
| .subcommand_required(true) | ||
| .arg_required_else_help(true) | ||
| .subcommand( | ||
| Command::new("afl") | ||
| .version(crate_version!()) | ||
| .subcommand_required(true) | ||
| .arg_required_else_help(true) | ||
| .allow_external_subcommands(true) | ||
| .external_subcommand_value_parser(value_parser!(OsString)) | ||
|
There was a problem hiding this comment. Nit: I think this is the default value parser for external subcommands, so you can probably omit this line. There was a problem hiding this comment. My experiments support this. However, I think I would prefer keep this line. If someone later reviews this change, I would like it to be clear that this line was not lost: Line 112 in 3cba662 |
||
| .override_usage("cargo afl [SUBCOMMAND or Cargo SUBCOMMAND]") | ||
| .after_help( | ||
| "In addition to the subcommands above, Cargo subcommands are also \ | ||
| supported (see `cargo help` for a list of all Cargo subcommands).", | ||
| ) | ||
| .subcommand( | ||
| Command::new("analyze") | ||
| .about("Invoke afl-analyze") | ||
| .allow_hyphen_values(true) | ||
| .disable_help_subcommand(true) | ||
| .disable_help_flag(true) | ||
| .disable_version_flag(true) | ||
|
There was a problem hiding this comment. Needs to be tested, but I believe subcommands now have their version flags disabled by default. So you might no longer need this line. There was a problem hiding this comment. I added several tests. Please tell me if you think there are still gaps, or if you do not like their approach(es). |
||
| .arg( | ||
| Arg::new("afl-analyze args") | ||
| .value_parser(value_parser!(OsString)) | ||
| .num_args(0..), | ||
| ), | ||
| ) | ||
| .subcommand( | ||
| Command::new("cmin") | ||
| .about("Invoke afl-cmin") | ||
| .allow_hyphen_values(true) | ||
| .disable_help_subcommand(true) | ||
| .disable_help_flag(true) | ||
| .disable_version_flag(true) | ||
| .arg( | ||
| Arg::new("afl-cmin args") | ||
| .value_parser(value_parser!(OsString)) | ||
| .num_args(0..), | ||
| ), | ||
| ) | ||
| .subcommand( | ||
| Command::new("fuzz") | ||
| .about("Invoke afl-fuzz") | ||
| .allow_hyphen_values(true) | ||
| .disable_help_subcommand(true) | ||
| .disable_help_flag(true) | ||
| .disable_version_flag(true) | ||
| .arg( | ||
| Arg::new("max_total_time") | ||
| .long("max_total_time") | ||
| .num_args(1) | ||
| .value_parser(value_parser!(u64)) | ||
| .help("Maximum amount of time to run the fuzzer"), | ||
| ) | ||
| .arg( | ||
| Arg::new("afl-fuzz args") | ||
| .value_parser(value_parser!(OsString)) | ||
| .num_args(0..), | ||
| ), | ||
| ) | ||
| .subcommand( | ||
| Command::new("gotcpu") | ||
| .about("Invoke afl-gotcpu") | ||
| .allow_hyphen_values(true) | ||
| .disable_help_subcommand(true) | ||
| .disable_help_flag(true) | ||
| .disable_version_flag(true) | ||
| .arg( | ||
| Arg::new("afl-gotcpu args") | ||
| .value_parser(value_parser!(OsString)) | ||
| .num_args(0..), | ||
| ), | ||
| ) | ||
| .subcommand( | ||
| Command::new("plot") | ||
| .about("Invoke afl-plot") | ||
| .allow_hyphen_values(true) | ||
| .disable_help_subcommand(true) | ||
| .disable_help_flag(true) | ||
| .disable_version_flag(true) | ||
| .arg( | ||
| Arg::new("afl-plot args") | ||
| .value_parser(value_parser!(OsString)) | ||
| .num_args(0..), | ||
| ), | ||
| ) | ||
| .subcommand( | ||
| Command::new("showmap") | ||
| .about("Invoke afl-showmap") | ||
| .allow_hyphen_values(true) | ||
| .disable_help_subcommand(true) | ||
| .disable_help_flag(true) | ||
| .disable_version_flag(true) | ||
| .arg( | ||
| Arg::new("afl-showmap args") | ||
| .value_parser(value_parser!(OsString)) | ||
| .num_args(0..), | ||
| ), | ||
| ) | ||
| .subcommand( | ||
| Command::new("tmin") | ||
| .about("Invoke afl-tmin") | ||
| .allow_hyphen_values(true) | ||
| .disable_help_subcommand(true) | ||
| .disable_help_flag(true) | ||
| .disable_version_flag(true) | ||
| .arg( | ||
| Arg::new("afl-tmin args") | ||
| .value_parser(value_parser!(OsString)) | ||
| .num_args(0..), | ||
| ), | ||
| ) | ||
| .subcommand( | ||
| Command::new("whatsup") | ||
| .about("Invoke afl-whatsup") | ||
| .allow_hyphen_values(true) | ||
| .disable_help_subcommand(true) | ||
| .disable_help_flag(true) | ||
| .disable_version_flag(true) | ||
| .arg( | ||
| Arg::new("afl-whatsup args") | ||
| .value_parser(value_parser!(OsString)) | ||
| .num_args(0..), | ||
| ), | ||
| ), | ||
| ) | ||
|
|
||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Tiny nit, but it might be worth considering bumping to the latest minor here (
4.0.9), since they had a couple of bug fixes since 4.0.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have very mixed feelings about this. But the way I have been leaning lately is to not include patch versions in Cargo.toml files. Tracking patch versions tends to introduce a lot of noise, and I prefer changes to the Cargo.toml file to be "significant," e.g., addition/removal of a dependency.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, this was based on a misunderstanding on my part. This is good to ignore.