NuKVM/libvirt
3
0
Fork 0
mirror of https://github.com/libvirt/libvirt.git synced 2025-02-25 18:55:26 -06:00
Code Issues Packages Projects Releases Wiki Activity

virsh: Make self-test failures noisy

Browse Source 
In local testing, I accidentally introduced a self-test failure,
and spent way too much time debugging it. Make sure the testsuite
log includes some hint as to why command option validation failed.
Lone exception: allocation failure is unlikely during self-test,
and if it happens, we are better off asserting (vsh.c can do this,
even if libvirt.so cannot).

Signed-off-by: Eric Blake <eblake@redhat.com>
Reviewed-by: Erik Skultety <eskultet@redhat.com>
Acked-by: Peter Krempa <pkrempa@redhat.com>
This commit is contained in:
Eric Blake 2019-03-11 21:17:33 -05:00
parent bf8c8755dc
commit 23e0bf1c4e
1 changed files with 39 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
tools/vsh.c
View File

@ -331,21 +331,26 @@ vshCmddefGetInfo(const vshCmdDef * cmd, const char *name)
/* Check if the internal command definitions are correct */ /* Check if the internal command definitions are correct */
static int static int
vshCmddefCheckInternals(const vshCmdDef *cmd) vshCmddefCheckInternals(vshControl *ctl,
const vshCmdDef *cmd)
{ {
size_t i; size_t i;
const char *help = NULL; const char *help = NULL;
/* in order to perform the validation resolve the alias first */ /* in order to perform the validation resolve the alias first */
if (cmd->flags & VSH_CMD_FLAG_ALIAS) { if (cmd->flags & VSH_CMD_FLAG_ALIAS) {
if (!cmd->alias) if (!cmd->alias) {
vshError(ctl, _("command '%s' has inconsistent alias"), cmd->name);
return -1; return -1;
}
cmd = vshCmddefSearch(cmd->alias); cmd = vshCmddefSearch(cmd->alias);
} }
/* Each command has to provide a non-empty help string. */ /* Each command has to provide a non-empty help string. */
if (!(help = vshCmddefGetInfo(cmd, "help")) || !*help) if (!(help = vshCmddefGetInfo(cmd, "help")) || !*help) {
vshError(ctl, _("command '%s' lacks help"), cmd->name);
return -1; return -1;
}
if (!cmd->opts) if (!cmd->opts)
return 0; return 0;
@ -353,14 +358,19 @@ vshCmddefCheckInternals(const vshCmdDef *cmd)
for (i = 0; cmd->opts[i].name; i++) { for (i = 0; cmd->opts[i].name; i++) {
const vshCmdOptDef *opt = &cmd->opts[i]; const vshCmdOptDef *opt = &cmd->opts[i];
if (i > 63) if (i > 63) {
vshError(ctl, _("command '%s' has too many options"), cmd->name);
return -1; /* too many options */ return -1; /* too many options */
}
switch (opt->type) { switch (opt->type) {
case VSH_OT_STRING: case VSH_OT_STRING:
case VSH_OT_BOOL: case VSH_OT_BOOL:
if (opt->flags & VSH_OFLAG_REQ) if (opt->flags & VSH_OFLAG_REQ) {
return -1; /* nor bool nor string options can't be mandatory */ vshError(ctl, _("command '%s' misused VSH_OFLAG_REQ"),
cmd->name);
return -1; /* neither bool nor string options can be mandatory */
}
break; break;
case VSH_OT_ALIAS: { case VSH_OT_ALIAS: {
@ -368,11 +378,14 @@ vshCmddefCheckInternals(const vshCmdDef *cmd)
char *name = (char *)opt->help; /* cast away const */ char *name = (char *)opt->help; /* cast away const */
char *p; char *p;
if (opt->flags || !opt->help) if (opt->flags || !opt->help) {
vshError(ctl, _("command '%s' has incorrect alias option"),
cmd->name);
return -1; /* alias options are tracked by the original name */ return -1; /* alias options are tracked by the original name */
}
if ((p = strchr(name, '=')) && if ((p = strchr(name, '=')) &&
VIR_STRNDUP(name, name, p - name) < 0) VIR_STRNDUP(name, name, p - name) < 0)
return -1; assert(false); /* Allocation failure during self-test is bad */
for (j = i + 1; cmd->opts[j].name; j++) { for (j = i + 1; cmd->opts[j].name; j++) {
if (STREQ(name, cmd->opts[j].name) && if (STREQ(name, cmd->opts[j].name) &&
cmd->opts[j].type != VSH_OT_ALIAS) cmd->opts[j].type != VSH_OT_ALIAS)
@ -381,21 +394,33 @@ vshCmddefCheckInternals(const vshCmdDef *cmd)
if (name != opt->help) { if (name != opt->help) {
VIR_FREE(name); VIR_FREE(name);
/* If alias comes with value, replacement must not be bool */ /* If alias comes with value, replacement must not be bool */
if (cmd->opts[j].type == VSH_OT_BOOL) if (cmd->opts[j].type == VSH_OT_BOOL) {
vshError(ctl, _("command '%s' has mismatched alias type"),
cmd->name);
return -1; return -1;
}
} }
if (!cmd->opts[j].name) if (!cmd->opts[j].name) {
vshError(ctl, _("command '%s' has missing alias option"),
cmd->name);
return -1; /* alias option must map to a later option name */ return -1; /* alias option must map to a later option name */
}
} }
break; break;
case VSH_OT_ARGV: case VSH_OT_ARGV:
if (cmd->opts[i + 1].name) if (cmd->opts[i + 1].name) {
vshError(ctl, _("command '%s' does not list argv option last"),
cmd->name);
return -1; /* argv option must be listed last */ return -1; /* argv option must be listed last */
}
break; break;
case VSH_OT_DATA: case VSH_OT_DATA:
if (!(opt->flags & VSH_OFLAG_REQ)) if (!(opt->flags & VSH_OFLAG_REQ)) {
vshError(ctl, _("command '%s' has non-required VSH_OT_DATA"),
cmd->name);
return -1; /* OT_DATA should always be required. */ return -1; /* OT_DATA should always be required. */
}
break; break;
case VSH_OT_INT: case VSH_OT_INT:
@ -3405,7 +3430,7 @@ const vshCmdInfo info_selftest[] = {
* That runs vshCmddefOptParse which validates * That runs vshCmddefOptParse which validates
* the per-command options structure. */ * the per-command options structure. */
bool bool
cmdSelfTest(vshControl *ctl ATTRIBUTE_UNUSED, cmdSelfTest(vshControl *ctl,
const vshCmd *cmd ATTRIBUTE_UNUSED) const vshCmd *cmd ATTRIBUTE_UNUSED)
{ {
const vshCmdGrp *grp; const vshCmdGrp *grp;
@ -3413,7 +3438,7 @@ cmdSelfTest(vshControl *ctl ATTRIBUTE_UNUSED,
for (grp = cmdGroups; grp->name; grp++) { for (grp = cmdGroups; grp->name; grp++) {
for (def = grp->commands; def->name; def++) { for (def = grp->commands; def->name; def++) {
if (vshCmddefCheckInternals(def) < 0) if (vshCmddefCheckInternals(ctl, def) < 0)
return false; return false;
} }
} }