wbrawner/toolbox
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

test/system: Shorten the names of the tests and use consistent wording

Browse source 
Currently, some of the names of the tests were too long, and had
inconsistent and verbose wording.  This made it difficult to look at
them and get a gist of all the scenarios being tested.  The names are
like headings.  They shouldn't be too long, should capture the primary
objective of the test and be consistent in their wording.

Note that the term 'usage screen' was particularly confusing.  Prior to
commit 3dc106e10a, 'usage screen' in the names of the tests also
referred to the very brief listing of the commands and options that's
shown by 'toolbox help' and 'toolbox --help' in the absence of man(1).
In the context of this change, the term referred to the brief two line
error message that's shown when an unknown command or flag is used.  So,
it will be good to not use it anymore.

https://github.com/containers/toolbox/pull/1386
This commit is contained in:
Debarshi Ray 2023-10-12 14:00:33 +02:00
parent fd5b9b5975
commit 9ec02f01b2
1 changed files with 17 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
test/system/002-help.bats
View file

@ -23,7 +23,7 @@ setup() {
_setup_environment
}
@test "help: Try to run toolbox with no command" {
@test "help: Smoke test" {
run --keep-empty-lines --separate-stderr "$TOOLBOX"
assert_failure
@ -37,9 +37,9 @@ setup() {
assert [ ${#stderr_lines[@]} -eq 7 ]
}
@test "help: Run command 'help'" {
@test "help: Command 'help'" {
if ! command -v man 2>/dev/null; then
skip "Test works only if man is in PATH"
skip "not found man(1)"
fi
run --keep-empty-lines --separate-stderr "$TOOLBOX" help
@ -52,9 +52,9 @@ setup() {
assert [ ${#stderr_lines[@]} -eq 0 ]
}
@test "help: Run command 'help' with no man present" {
@test "help: Command 'help' with man(1) absent" {
if command -v man 2>/dev/null; then
skip "Test works only if man is not in PATH"
skip "found man(1)"
fi
run --keep-empty-lines --separate-stderr "$TOOLBOX" help
@ -70,7 +70,7 @@ setup() {
assert [ ${#stderr_lines[@]} -eq 0 ]
}
@test "help: Use flag '--help'" {
@test "help: Flag '--help'" {
if ! command -v man 2>/dev/null; then
skip "not found man(1)"
fi
@ -85,7 +85,7 @@ setup() {
assert [ ${#stderr_lines[@]} -eq 0 ]
}
@test "help: Use flag '--help' with man(1) absent" {
@test "help: Flag '--help' with man(1) absent" {
if command -v man 2>/dev/null; then
skip "found man(1)"
fi
@ -110,7 +110,7 @@ setup() {
assert [ ${#stderr_lines[@]} -eq 0 ]
}
@test "help: Try to run toolbox with non-existent command (shows usage screen)" {
@test "help: Try unknown command" {
run --keep-empty-lines --separate-stderr "$TOOLBOX" foo
assert_failure
@ -121,7 +121,7 @@ setup() {
assert [ ${#stderr_lines[@]} -eq 2 ]
}
@test "help: Try to run toolbox with non-existent flag (shows usage screen)" {
@test "help: Try unknown flag" {
run --keep-empty-lines --separate-stderr "$TOOLBOX" --foo
assert_failure
@ -132,7 +132,7 @@ setup() {
assert [ ${#stderr_lines[@]} -eq 2 ]
}
@test "help: Try to run 'toolbox create' with non-existent flag (shows usage screen)" {
@test "help: Try 'create' with unknown flag" {
run --keep-empty-lines --separate-stderr "$TOOLBOX" create --foo
assert_failure
@ -143,7 +143,7 @@ setup() {
assert [ ${#stderr_lines[@]} -eq 2 ]
}
@test "help: Try to run 'toolbox enter' with non-existent flag (shows usage screen)" {
@test "help: Try 'enter' with unknown flag" {
run --keep-empty-lines --separate-stderr "$TOOLBOX" enter --foo
assert_failure
@ -154,7 +154,7 @@ setup() {
assert [ ${#stderr_lines[@]} -eq 2 ]
}
@test "help: Try to run 'toolbox help' with non-existent flag (shows usage screen)" {
@test "help: Try 'help' with unknown flag" {
run --keep-empty-lines --separate-stderr "$TOOLBOX" help --foo
assert_failure
@ -165,7 +165,7 @@ setup() {
assert [ ${#stderr_lines[@]} -eq 2 ]
}
@test "help: Try to run 'toolbox init-container' with non-existent flag (shows usage screen)" {
@test "help: Try 'init-container' with unknown flag" {
run --keep-empty-lines --separate-stderr "$TOOLBOX" init-container --foo
assert_failure
@ -176,7 +176,7 @@ setup() {
assert [ ${#stderr_lines[@]} -eq 2 ]
}
@test "help: Try to run 'toolbox list' with non-existent flag (shows usage screen)" {
@test "help: Try 'list' with unknown flag" {
run --keep-empty-lines --separate-stderr "$TOOLBOX" list --foo
assert_failure
@ -187,7 +187,7 @@ setup() {
assert [ ${#stderr_lines[@]} -eq 2 ]
}
@test "help: Try to run 'toolbox rm' with non-existent flag (shows usage screen)" {
@test "help: Try 'rm' with unknown flag" {
run --keep-empty-lines --separate-stderr "$TOOLBOX" rm --foo
assert_failure
@ -198,7 +198,7 @@ setup() {
assert [ ${#stderr_lines[@]} -eq 2 ]
}
@test "help: Try to run 'toolbox rmi' with non-existent flag (shows usage screen)" {
@test "help: Try 'rmi' with unknown flag" {
run --keep-empty-lines --separate-stderr "$TOOLBOX" rmi --foo
assert_failure
@ -209,7 +209,7 @@ setup() {
assert [ ${#stderr_lines[@]} -eq 2 ]
}
@test "help: Try to run 'toolbox run' with non-existent flag (shows usage screen)" {
@test "help: Try 'run' with unknown flag" {
run --keep-empty-lines --separate-stderr "$TOOLBOX" run --foo
assert_failure