External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2024-07-11 04:15:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

tests: new test: virsh-synopsis

Browse Source 
* tests/virsh-synopsis: new file
* tests/Makefile.am (test_scripts): Add virsh-synopsis.
* src/virsh.c: Correct help SYNOPSIS for each of seven commands.

When I first ran this script, "make check" failed like this:
  ...
  invalid help SYNOPSIS for net-create:
      create a network from an XML <file>
  invalid help SYNOPSIS for net-define:
      define a network from an XML <file>
  invalid help SYNOPSIS for net-start:
      start <network>
  invalid help SYNOPSIS for pool-create:
      create a pool from an XML <file>
  invalid help SYNOPSIS for pool-define:
      define a pool from an XML <file>
  invalid help SYNOPSIS for pool-start:
      start <pool>
  invalid help SYNOPSIS for vol-create:
      create <file>
  FAIL: virsh-synopsis
This commit is contained in:
Jim Meyering 2008-11-24 07:13:29 +00:00
parent 8275cc5eb0
commit 62bcd5d32b
4 changed files with 59 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
ChangeLog
View File

@ -1,5 +1,10 @@
Mon Nov 24 08:10:49 +0100 2008 Jim Meyering <meyering@redhat.com>
tests: new test: virsh-synopsis
* tests/virsh-synopsis: new file
* tests/Makefile.am (test_scripts): Add virsh-synopsis.
* src/virsh.c: Correct help SYNOPSIS for each of seven commands.
tests: virsh-all: new script
* tests/virsh-all: New script.
* tests/Makefile.am (test_scripts): Add virsh-all.

17
src/virsh.c
View File

@ -2365,7 +2365,7 @@ cmdNetworkAutostart(vshControl *ctl, const vshCmd *cmd)
* "net-create" command
*/
static const vshCmdInfo info_network_create[] = {
{"syntax", "create a network from an XML <file>"},
{"syntax", "net-create <file>"},
{"help", gettext_noop("create a network from an XML file")},
{"desc", gettext_noop("Create a network.")},
{NULL, NULL}
@ -2413,7 +2413,7 @@ cmdNetworkCreate(vshControl *ctl, const vshCmd *cmd)
* "net-define" command
*/
static const vshCmdInfo info_network_define[] = {
{"syntax", "define a network from an XML <file>"},
{"syntax", "net-define <file>"},
{"help", gettext_noop("define (but don't start) a network from an XML file")},
{"desc", gettext_noop("Define a network.")},
{NULL, NULL}
@ -2697,7 +2697,7 @@ cmdNetworkName(vshControl *ctl, const vshCmd *cmd)
* "net-start" command
*/
static const vshCmdInfo info_network_start[] = {
{"syntax", "start <network>"},
{"syntax", "net-start <network>"},
{"help", gettext_noop("start a (previously defined) inactive network")},
{"desc", gettext_noop("Start a network.")},
{NULL, NULL}
@ -2862,14 +2862,15 @@ cmdPoolAutostart(vshControl *ctl, const vshCmd *cmd)
* "pool-create" command
*/
static const vshCmdInfo info_pool_create[] = {
{"syntax", "create a pool from an XML <file>"},
{"syntax", "pool-create <file>"},
{"help", gettext_noop("create a pool from an XML file")},
{"desc", gettext_noop("Create a pool.")},
{NULL, NULL}
};
static const vshCmdOptDef opts_pool_create[] = {
{"file", VSH_OT_DATA, VSH_OFLAG_REQ, gettext_noop("file containing an XML pool description")},
{"file", VSH_OT_DATA, VSH_OFLAG_REQ,
gettext_noop("file containing an XML pool description")},
{NULL, 0, 0, NULL}
};
@ -3000,7 +3001,7 @@ cmdPoolCreateAs(vshControl *ctl, const vshCmd *cmd)
* "pool-define" command
*/
static const vshCmdInfo info_pool_define[] = {
{"syntax", "define a pool from an XML <file>"},
{"syntax", "pool-define <file>"},
{"help", gettext_noop("define (but don't start) a pool from an XML file")},
{"desc", gettext_noop("Define a pool.")},
{NULL, NULL}
@ -3727,7 +3728,7 @@ cmdPoolName(vshControl *ctl, const vshCmd *cmd)
* "pool-start" command
*/
static const vshCmdInfo info_pool_start[] = {
{"syntax", "start <pool>"},
{"syntax", "pool-start <pool>"},
{"help", gettext_noop("start a (previously defined) inactive pool")},
{"desc", gettext_noop("Start a pool.")},
{NULL, NULL}
@ -3965,7 +3966,7 @@ cmdPoolUuid(vshControl *ctl, const vshCmd *cmd)
* "vol-create" command
*/
static const vshCmdInfo info_vol_create[] = {
{"syntax", "create <file>"},
{"syntax", "vol-create <file>"},
{"help", gettext_noop("create a vol from an XML file")},
{"desc", gettext_noop("Create a vol.")},
{NULL, NULL}

1
tests/Makefile.am
View File

@ -63,6 +63,7 @@ test_scripts += \
undefine \
vcpupin
virsh-all
virsh-synopsis
endif
EXTRA_DIST += $(test_scripts)

44
tests/virsh-synopsis Executable file
View File

@ -0,0 +1,44 @@
#!/bin/sh
# ensure that each command's help "SYNOPSIS" line starts with the command name
# Copyright (C) 2008 Free Software Foundation, Inc.
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
if test "$VERBOSE" = yes; then
set -x
virsh --version
fi
test -z "$srcdir" && srcdir=$(pwd)
. "$srcdir/test-lib.sh"
fail=0
test_url=test:///default
virsh -c $test_url help > cmds || framework_failure
cmds=$(sed -n 's/^ \([^ ][^ ]*\) .*/\1/p' cmds) || framework_failure
test -n "$cmds" || framework_failure
for i in $cmds; do
virsh -c $test_url help $i > help || fail=1
grep -A1 '^ SYNOPSIS$' help > synopsis \
|| { echo 1>&2 missing or invalid help SYNOPSIS for $i; fail=1; }
sed -n 2p synopsis > s2 || framework_failure
grep -E "^ $i( |$)" s2 > /dev/null \
|| { echo 1>&2 "invalid help SYNOPSIS for $i:"; cat s2 1>&2; fail=1; }
done
(exit $fail); exit $fail