Merge pull request #2251 from ldm0/conflict

Fix only one arg printed in multiple required_unless missing situation
This commit is contained in:
Pavan Kumar Sunkara 2020-12-12 12:18:52 +00:00 committed by GitHub
commit 76effbd8f9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 65 additions and 21 deletions

View file

@ -415,7 +415,7 @@ impl<'help, 'app, 'parser> Validator<'help, 'app, 'parser> {
.find(|g| g.id == *name)
.expect(INTERNAL_ERROR_MSG);
if grp.requires.iter().any(|n| !matcher.contains(n)) {
return self.missing_required_error(matcher, Some(name));
return self.missing_required_error(matcher, vec![name.clone()]);
}
}
}
@ -519,10 +519,10 @@ impl<'help, 'app, 'parser> Validator<'help, 'app, 'parser> {
if let Some(val) = val {
let missing_req = |v| v == val && !matcher.contains(&name);
if ma.vals.iter().any(missing_req) {
return self.missing_required_error(matcher, Some(&a.id));
return self.missing_required_error(matcher, vec![a.id.clone()]);
}
} else if !matcher.contains(&name) {
return self.missing_required_error(matcher, Some(&name));
return self.missing_required_error(matcher, vec![name.clone()]);
}
}
Ok(())
@ -540,7 +540,7 @@ impl<'help, 'app, 'parser> Validator<'help, 'app, 'parser> {
if let Some(arg) = self.p.app.find(&arg_or_group) {
debug!("Validator::validate_required:iter: This is an arg");
if !self.is_missing_required_ok(arg, matcher) {
return self.missing_required_error(matcher, None);
return self.missing_required_error(matcher, vec![]);
}
} else if let Some(group) = self.p.app.groups.iter().find(|g| g.id == *arg_or_group) {
debug!("Validator::validate_required:iter: This is a group");
@ -551,7 +551,7 @@ impl<'help, 'app, 'parser> Validator<'help, 'app, 'parser> {
.iter()
.any(|a| matcher.contains(a))
{
return self.missing_required_error(matcher, None);
return self.missing_required_error(matcher, vec![]);
}
}
}
@ -561,7 +561,7 @@ impl<'help, 'app, 'parser> Validator<'help, 'app, 'parser> {
for (other, val) in &a.r_ifs {
if let Some(ma) = matcher.get(other) {
if ma.contains_val(val) && !matcher.contains(&a.id) {
return self.missing_required_error(matcher, Some(&a.id));
return self.missing_required_error(matcher, vec![a.id.clone()]);
}
}
}
@ -590,7 +590,7 @@ impl<'help, 'app, 'parser> Validator<'help, 'app, 'parser> {
fn validate_required_unless(&self, matcher: &ArgMatcher) -> ClapResult<()> {
debug!("Validator::validate_required_unless");
for a in self
let failed_args: Vec<_> = self
.p
.app
.args
@ -598,14 +598,14 @@ impl<'help, 'app, 'parser> Validator<'help, 'app, 'parser> {
.iter()
.filter(|a| !a.r_unless.is_empty())
.filter(|a| !matcher.contains(&a.id))
{
debug!("Validator::validate_required_unless:iter:{}", a.name);
if self.fails_arg_required_unless(a, matcher) {
return self.missing_required_error(matcher, Some(&a.id));
}
.filter(|a| self.fails_arg_required_unless(a, matcher))
.map(|a| a.id.clone())
.collect();
if failed_args.is_empty() {
Ok(())
} else {
self.missing_required_error(matcher, failed_args)
}
Ok(())
}
// Failing a required unless means, the arg's "unless" wasn't present, and neither were they
@ -621,7 +621,7 @@ impl<'help, 'app, 'parser> Validator<'help, 'app, 'parser> {
}
// `incl`: an arg to include in the error even if not used
fn missing_required_error(&self, matcher: &ArgMatcher, incl: Option<&Id>) -> ClapResult<()> {
fn missing_required_error(&self, matcher: &ArgMatcher, incl: Vec<Id>) -> ClapResult<()> {
debug!("Validator::missing_required_error; incl={:?}", incl);
debug!(
"Validator::missing_required_error: reqs={:?}",
@ -630,11 +630,7 @@ impl<'help, 'app, 'parser> Validator<'help, 'app, 'parser> {
let usg = Usage::new(self.p);
let req_args = if let Some(x) = incl {
usg.get_required_usage_from(&[x.clone()], Some(matcher), true)
} else {
usg.get_required_usage_from(&[], Some(matcher), true)
};
let req_args = usg.get_required_usage_from(&incl, Some(matcher), true);
debug!(
"Validator::missing_required_error: req_args={:#?}",
@ -649,7 +645,7 @@ impl<'help, 'app, 'parser> Validator<'help, 'app, 'parser> {
})
})
.cloned()
.chain(incl.cloned())
.chain(incl)
.collect();
Err(Error::missing_required_argument(

View file

@ -806,6 +806,54 @@ fn issue_1158_app() -> App<'static> {
.arg(Arg::from("-z [Z] 'Z'"))
}
#[test]
fn multiple_required_unless_usage_printing() {
static MULTIPLE_REQUIRED_UNLESS_USAGE: &'static str =
"error: The following required arguments were not provided:
--a <a>
--b <b>
USAGE:
test --c <c> --a <a> --b <b>
For more information try --help";
let app = App::new("test")
.arg(
Arg::new("a")
.long("a")
.takes_value(true)
.required_unless_present("b")
.conflicts_with("b"),
)
.arg(
Arg::new("b")
.long("b")
.takes_value(true)
.required_unless_present("a")
.conflicts_with("a"),
)
.arg(
Arg::new("c")
.long("c")
.takes_value(true)
.required_unless_present("d")
.conflicts_with("d"),
)
.arg(
Arg::new("d")
.long("d")
.takes_value(true)
.required_unless_present("c")
.conflicts_with("c"),
);
assert!(utils::compare_output(
app,
"test --c asd",
MULTIPLE_REQUIRED_UNLESS_USAGE,
true
));
}
#[test]
fn issue_1158_conflicting_requirements() {
let app = issue_1158_app();