opensource/podman
1
0
Fork 0
mirror of https://github.com/containers/podman.git synced 2025-06-26 21:07:02 +08:00
Code Issues Packages Projects Releases Wiki Activity

BATS help-message test: improve diagnostics

Browse Source 
The error messages from the 'podman xxx --help' cross-check
test are unhelpful, and cause much wasted time when they trigger.

Solution: instead of using the built-in exit-status check
in run_podman, do an explicit check outside of run_podman.
This lets us die() with a custom, hopefully useful, message.

Signed-off-by: Ed Santiago <santiago@redhat.com>
This commit is contained in:
Ed Santiago
2020-07-21 08:31:56 -06:00
parent df6920aa79
commit 2b323f2238
1 changed files with 14 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
test/system/015-help.bats
View File

@ -78,7 +78,8 @@ function check_help() {
if ! expr "$usage" : '.*[A-Z]' >/dev/null; then if ! expr "$usage" : '.*[A-Z]' >/dev/null; then
if [ "$cmd" != "help" ]; then if [ "$cmd" != "help" ]; then
dprint "$command_string invalid-arg" dprint "$command_string invalid-arg"
run_podman 125 "$@" $cmd invalid-arg run_podman '?' "$@" $cmd invalid-arg
is "$status" 125 "'$command_string invalid-arg' - exit status"
is "$output" "Error: .* takes no arguments" \ is "$output" "Error: .* takes no arguments" \
"'$command_string' with extra (invalid) arguments" "'$command_string' with extra (invalid) arguments"
fi fi
@ -104,7 +105,8 @@ function check_help() {
# The </dev/null protects us from 'podman login' which will # The </dev/null protects us from 'podman login' which will
# try to read username/password from stdin. # try to read username/password from stdin.
dprint "$command_string (without required args)" dprint "$command_string (without required args)"
run_podman 125 "$@" $cmd </dev/null run_podman '?' "$@" $cmd </dev/null
is "$status" 125 "'$command_string' with no arguments - exit status"
is "$output" "Error:.* \(require\|specif\|must\|provide\|need\|choose\|accepts\)" \ is "$output" "Error:.* \(require\|specif\|must\|provide\|need\|choose\|accepts\)" \
"'$command_string' without required arg" "'$command_string' without required arg"
@ -126,7 +128,8 @@ function check_help() {
local rhs=$(sed -e 's/^[^A-Z]\+[A-Z]/X/' -e 's/ | /-or-/g' <<<"$usage") local rhs=$(sed -e 's/^[^A-Z]\+[A-Z]/X/' -e 's/ | /-or-/g' <<<"$usage")
local n_args=$(wc -w <<<"$rhs") local n_args=$(wc -w <<<"$rhs")
run_podman 125 "$@" $cmd $(seq --format='x%g' 0 $n_args) run_podman '?' "$@" $cmd $(seq --format='x%g' 0 $n_args)
is "$status" 125 "'$command_string' with >$n_args arguments - exit status"
is "$output" "Error:.* \(takes no arguments\|requires exactly $n_args arg\|accepts at most\|too many arguments\|accepts $n_args arg(s), received\|accepts between .* and .* arg(s), received \)" \ is "$output" "Error:.* \(takes no arguments\|requires exactly $n_args arg\|accepts at most\|too many arguments\|accepts $n_args arg(s), received\|accepts between .* and .* arg(s), received \)" \
"'$command_string' with >$n_args arguments" "'$command_string' with >$n_args arguments"
@ -140,13 +143,17 @@ function check_help() {
# Any command that takes subcommands, must throw error if called # Any command that takes subcommands, must throw error if called
# without one. # without one.
dprint "podman $@" dprint "podman $@"
run_podman 125 "$@" run_podman '?' "$@"
is "$output" "Error: missing command .*$@ COMMAND" is "$status" 125 "'podman $*' without any subcommand - exit status"
is "$output" "Error: missing command .*$@ COMMAND" \
"'podman $*' without any subcommand - expected error message"
# Assume that 'NoSuchCommand' is not a command # Assume that 'NoSuchCommand' is not a command
dprint "podman $@ NoSuchCommand" dprint "podman $@ NoSuchCommand"
run_podman 125 "$@" NoSuchCommand run_podman '?' "$@" NoSuchCommand
is "$output" "Error: unrecognized command .*$@ NoSuchCommand" is "$status" 125 "'podman $* NoSuchCommand' - exit status"
is "$output" "Error: unrecognized command .*$@ NoSuchCommand" \
"'podman $* NoSuchCommand' - expected error message"
# This can happen if the output of --help changes, such as between # This can happen if the output of --help changes, such as between
# the old command parser and cobra. # the old command parser and cobra.