test-lib tests: don't provide a description for the sub-tests

Change the $test_description provided for the generated subtests to be
constant, since the only purpose of having it is that test-lib.sh will
barf if it isn't supplied.

The other purpose of having it was to effectively split up the test
description between the argument to test_expect_success and the
argument to "write_and_run_sub_test_lib_test". Let's only use one of
the two.

Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/t/lib-subtest.sh b/t/lib-subtest.sh
index 21fa570d0b25b06d6f5b54a048ca8f2135807dd6..cdbc2d933206bb966add3d8db6b217861ae6bda4 100644 (file)
--- a/t/lib-subtest.sh
+++ b/t/lib-subtest.sh
@@ -1,12 +1,8 @@
 write_sub_test_lib_test () {
-       name="$1" descr="$2" # stdin is the body of the test code
+       name="$1" # stdin is the body of the test code
        mkdir "$name" &&
        write_script "$name/$name.sh" "$TEST_SHELL_PATH" <<-EOF &&
-       test_description='$descr (run in sub test-lib)
-
-       This is run in a sub test-lib so that we do not get incorrect
-       passing metrics
-       '
+       test_description='A test of test-lib.sh itself'
 
        # Point to the t/test-lib.sh, which isn't in ../ as usual
        . "\$TEST_DIRECTORY"/test-lib.sh
@@ -15,8 +11,8 @@ write_sub_test_lib_test () {
 }
 
 _run_sub_test_lib_test_common () {
-       neg="$1" name="$2" descr="$3" # stdin is the body of the test code
-       shift 3
+       neg="$1" name="$2" # stdin is the body of the test code
+       shift 2
 
        # intercept pseudo-options at the front of the argument list that we
        # will not pass to child script

diff --git a/t/t0000-basic.sh b/t/t0000-basic.sh
index a7c5aaacab6bc524e4421d1a1aab8c6446b69892..6fdd5f43caecc381d9243f75e3776aef7dca38e0 100755 (executable)
--- a/t/t0000-basic.sh
+++ b/t/t0000-basic.sh
@@ -67,8 +67,8 @@ test_expect_success 'success is reported like this' '
        :
 '
 
-test_expect_success 'pretend we have a fully passing test suite' '
-       write_and_run_sub_test_lib_test full-pass "3 passing tests" <<-\EOF &&
+test_expect_success 'subtest: 3 passing tests' '
+       write_and_run_sub_test_lib_test full-pass <<-\EOF &&
        for i in 1 2 3
        do
                test_expect_success "passing test #$i" "true"
@@ -84,9 +84,8 @@ test_expect_success 'pretend we have a fully passing test suite' '
        EOF
 '
 
-test_expect_success 'pretend we have a partially passing test suite' '
-       write_and_run_sub_test_lib_test_err \
-               partial-pass "2/3 tests passing" <<-\EOF &&
+test_expect_success 'subtest: 2/3 tests passing' '
+       write_and_run_sub_test_lib_test_err partial-pass <<-\EOF &&
        test_expect_success "passing test #1" "true"
        test_expect_success "failing test #2" "false"
        test_expect_success "passing test #3" "true"
@@ -102,8 +101,8 @@ test_expect_success 'pretend we have a partially passing test suite' '
        EOF
 '
 
-test_expect_success 'pretend we have a known breakage' '
-       write_and_run_sub_test_lib_test failing-todo "A failing TODO test" <<-\EOF &&
+test_expect_success 'subtest: a failing TODO test' '
+       write_and_run_sub_test_lib_test failing-todo <<-\EOF &&
        test_expect_success "passing test" "true"
        test_expect_failure "pretend we have a known breakage" "false"
        test_done
@@ -117,8 +116,8 @@ test_expect_success 'pretend we have a known breakage' '
        EOF
 '
 
-test_expect_success 'pretend we have fixed a known breakage' '
-       write_and_run_sub_test_lib_test passing-todo "A passing TODO test" <<-\EOF &&
+test_expect_success 'subtest: a passing TODO test' '
+       write_and_run_sub_test_lib_test passing-todo <<-\EOF &&
        test_expect_failure "pretend we have fixed a known breakage" "true"
        test_done
        EOF
@@ -129,9 +128,8 @@ test_expect_success 'pretend we have fixed a known breakage' '
        EOF
 '
 
-test_expect_success 'pretend we have fixed one of two known breakages (run in sub test-lib)' '
-       write_and_run_sub_test_lib_test partially-passing-todos \
-               "2 TODO tests, one passing" <<-\EOF &&
+test_expect_success 'subtest: 2 TODO tests, one passin' '
+       write_and_run_sub_test_lib_test partially-passing-todos <<-\EOF &&
        test_expect_failure "pretend we have a known breakage" "false"
        test_expect_success "pretend we have a passing test" "true"
        test_expect_failure "pretend we have fixed another known breakage" "true"
@@ -148,9 +146,8 @@ test_expect_success 'pretend we have fixed one of two known breakages (run in su
        EOF
 '
 
-test_expect_success 'pretend we have a pass, fail, and known breakage' '
-       write_and_run_sub_test_lib_test_err \
-               mixed-results1 "mixed results #1" <<-\EOF &&
+test_expect_success 'subtest: mixed results: pass, failure and a TODO test' '
+       write_and_run_sub_test_lib_test_err mixed-results1 <<-\EOF &&
        test_expect_success "passing test" "true"
        test_expect_success "failing test" "false"
        test_expect_failure "pretend we have a known breakage" "false"
@@ -167,9 +164,8 @@ test_expect_success 'pretend we have a pass, fail, and known breakage' '
        EOF
 '
 
-test_expect_success 'pretend we have a mix of all possible results' '
-       write_and_run_sub_test_lib_test_err \
-               mixed-results2 "mixed results #2" <<-\EOF &&
+test_expect_success 'subtest: mixed results: a mixture of all possible results' '
+       write_and_run_sub_test_lib_test_err mixed-results2 <<-\EOF &&
        test_expect_success "passing test" "true"
        test_expect_success "passing test" "true"
        test_expect_success "passing test" "true"
@@ -203,9 +199,8 @@ test_expect_success 'pretend we have a mix of all possible results' '
        EOF
 '
 
-test_expect_success 'test --verbose' '
-       write_and_run_sub_test_lib_test_err \
-               t1234-verbose "test verbose" --verbose <<-\EOF &&
+test_expect_success 'subtest: --verbose option' '
+       write_and_run_sub_test_lib_test_err t1234-verbose --verbose <<-\EOF &&
        test_expect_success "passing test" true
        test_expect_success "test with output" "echo foo"
        test_expect_success "failing test" false
@@ -230,9 +225,9 @@ test_expect_success 'test --verbose' '
        EOF
 '
 
-test_expect_success 'test --verbose-only' '
+test_expect_success 'subtest: --verbose-only option' '
        write_and_run_sub_test_lib_test_err \
-               t2345-verbose-only-2 "test verbose-only=2" \
+               t2345-verbose-only-2 \
                --verbose-only=2 <<-\EOF &&
        test_expect_success "passing test" true
        test_expect_success "test with output" "echo foo"
@@ -253,10 +248,9 @@ test_expect_success 'test --verbose-only' '
        EOF
 '
 
-test_expect_success 'GIT_SKIP_TESTS' '
+test_expect_success 'subtest: skip one with GIT_SKIP_TESTS' '
        (
                write_and_run_sub_test_lib_test git-skip-tests-basic \
-                       "GIT_SKIP_TESTS" \
                        --skip="git.2" <<-\EOF &&
                for i in 1 2 3
                do
@@ -274,10 +268,9 @@ test_expect_success 'GIT_SKIP_TESTS' '
        )
 '
 
-test_expect_success 'GIT_SKIP_TESTS several tests' '
+test_expect_success 'subtest: skip several with GIT_SKIP_TESTS' '
        (
                write_and_run_sub_test_lib_test git-skip-tests-several \
-                       "GIT_SKIP_TESTS several tests" \
                        --skip="git.2 git.5" <<-\EOF &&
                for i in 1 2 3 4 5 6
                do
@@ -298,10 +291,9 @@ test_expect_success 'GIT_SKIP_TESTS several tests' '
        )
 '
 
-test_expect_success 'GIT_SKIP_TESTS sh pattern' '
+test_expect_success 'subtest: sh pattern skipping with GIT_SKIP_TESTS' '
        (
                write_and_run_sub_test_lib_test git-skip-tests-sh-pattern \
-                       "GIT_SKIP_TESTS sh pattern" \
                        --skip="git.[2-5]" <<-\EOF &&
                for i in 1 2 3 4 5 6
                do
@@ -322,10 +314,9 @@ test_expect_success 'GIT_SKIP_TESTS sh pattern' '
        )
 '
 
-test_expect_success 'GIT_SKIP_TESTS entire suite' '
+test_expect_success 'subtest: skip entire test suite with GIT_SKIP_TESTS' '
        (
                write_and_run_sub_test_lib_test git-skip-tests-entire-suite \
-                       "GIT_SKIP_TESTS entire suite" \
                        --skip="git" <<-\EOF &&
                for i in 1 2 3
                do
@@ -339,10 +330,9 @@ test_expect_success 'GIT_SKIP_TESTS entire suite' '
        )
 '
 
-test_expect_success 'GIT_SKIP_TESTS does not skip unmatched suite' '
+test_expect_success 'subtest: GIT_SKIP_TESTS does not skip unmatched suite' '
        (
                write_and_run_sub_test_lib_test git-skip-tests-unmatched-suite \
-                       "GIT_SKIP_TESTS does not skip unmatched suite" \
                        --skip="notgit" <<-\EOF &&
                for i in 1 2 3
                do
@@ -360,9 +350,8 @@ test_expect_success 'GIT_SKIP_TESTS does not skip unmatched suite' '
        )
 '
 
-test_expect_success '--run basic' '
-       write_and_run_sub_test_lib_test run-basic \
-               "--run basic" --run="1,3,5" <<-\EOF &&
+test_expect_success 'subtest: --run basic' '
+       write_and_run_sub_test_lib_test run-basic --run="1,3,5" <<-\EOF &&
        for i in 1 2 3 4 5 6
        do
                test_expect_success "passing test #$i" "true"
@@ -381,9 +370,9 @@ test_expect_success '--run basic' '
        EOF
 '
 
-test_expect_success '--run with a range' '
+test_expect_success 'subtest: --run with a range' '
        write_and_run_sub_test_lib_test run-range \
-               "--run with a range" --run="1-3" <<-\EOF &&
+               --run="1-3" <<-\EOF &&
        for i in 1 2 3 4 5 6
        do
                test_expect_success "passing test #$i" "true"
@@ -402,9 +391,9 @@ test_expect_success '--run with a range' '
        EOF
 '
 
-test_expect_success '--run with two ranges' '
+test_expect_success 'subtest: --run with two ranges' '
        write_and_run_sub_test_lib_test run-two-ranges \
-               "--run with two ranges" --run="1-2,5-6" <<-\EOF &&
+               --run="1-2,5-6" <<-\EOF &&
        for i in 1 2 3 4 5 6
        do
                test_expect_success "passing test #$i" "true"
@@ -423,9 +412,9 @@ test_expect_success '--run with two ranges' '
        EOF
 '
 
-test_expect_success '--run with a left open range' '
+test_expect_success 'subtest: --run with a left open range' '
        write_and_run_sub_test_lib_test run-left-open-range \
-               "--run with a left open range" --run="-3" <<-\EOF &&
+               --run="-3" <<-\EOF &&
        for i in 1 2 3 4 5 6
        do
                test_expect_success "passing test #$i" "true"
@@ -444,9 +433,9 @@ test_expect_success '--run with a left open range' '
        EOF
 '
 
-test_expect_success '--run with a right open range' '
+test_expect_success 'subtest: --run with a right open range' '
        write_and_run_sub_test_lib_test run-right-open-range \
-               "--run with a right open range" --run="4-" <<-\EOF &&
+               --run="4-" <<-\EOF &&
        for i in 1 2 3 4 5 6
        do
                test_expect_success "passing test #$i" "true"
@@ -465,9 +454,9 @@ test_expect_success '--run with a right open range' '
        EOF
 '
 
-test_expect_success '--run with basic negation' '
+test_expect_success 'subtest: --run with basic negation' '
        write_and_run_sub_test_lib_test run-basic-neg \
-               "--run with basic negation" --run="!3" <<-\EOF &&
+               --run="!3" <<-\EOF &&
        for i in 1 2 3 4 5 6
        do
                test_expect_success "passing test #$i" "true"
@@ -486,9 +475,9 @@ test_expect_success '--run with basic negation' '
        EOF
 '
 
-test_expect_success '--run with two negations' '
+test_expect_success 'subtest: --run with two negations' '
        write_and_run_sub_test_lib_test run-two-neg \
-               "--run with two negations" --run="!3,!6" <<-\EOF &&
+               --run="!3,!6" <<-\EOF &&
        for i in 1 2 3 4 5 6
        do
                test_expect_success "passing test #$i" "true"
@@ -507,9 +496,9 @@ test_expect_success '--run with two negations' '
        EOF
 '
 
-test_expect_success '--run a range and negation' '
+test_expect_success 'subtest: --run a range and negation' '
        write_and_run_sub_test_lib_test run-range-and-neg \
-               "--run a range and negation" --run="-4,!2" <<-\EOF &&
+               --run="-4,!2" <<-\EOF &&
        for i in 1 2 3 4 5 6
        do
                test_expect_success "passing test #$i" "true"
@@ -528,9 +517,9 @@ test_expect_success '--run a range and negation' '
        EOF
 '
 
-test_expect_success '--run range negation' '
+test_expect_success 'subtest: --run range negation' '
        write_and_run_sub_test_lib_test run-range-neg \
-               "--run range negation" --run="!1-3" <<-\EOF &&
+               --run="!1-3" <<-\EOF &&
        for i in 1 2 3 4 5 6
        do
                test_expect_success "passing test #$i" "true"
@@ -549,9 +538,8 @@ test_expect_success '--run range negation' '
        EOF
 '
 
-test_expect_success '--run include, exclude and include' '
+test_expect_success 'subtest: --run include, exclude and include' '
        write_and_run_sub_test_lib_test run-inc-neg-inc \
-               "--run include, exclude and include" \
                --run="1-5,!1-3,2" <<-\EOF &&
        for i in 1 2 3 4 5 6
        do
@@ -571,9 +559,8 @@ test_expect_success '--run include, exclude and include' '
        EOF
 '
 
-test_expect_success '--run include, exclude and include, comma separated' '
+test_expect_success 'subtest: --run include, exclude and include, comma separated' '
        write_and_run_sub_test_lib_test run-inc-neg-inc-comma \
-               "--run include, exclude and include, comma separated" \
                --run=1-5,!1-3,2 <<-\EOF &&
        for i in 1 2 3 4 5 6
        do
@@ -593,9 +580,8 @@ test_expect_success '--run include, exclude and include, comma separated' '
        EOF
 '
 
-test_expect_success '--run exclude and include' '
+test_expect_success 'subtest: --run exclude and include' '
        write_and_run_sub_test_lib_test run-neg-inc \
-               "--run exclude and include" \
                --run="!3-,5" <<-\EOF &&
        for i in 1 2 3 4 5 6
        do
@@ -615,9 +601,8 @@ test_expect_success '--run exclude and include' '
        EOF
 '
 
-test_expect_success '--run empty selectors' '
+test_expect_success 'subtest: --run empty selectors' '
        write_and_run_sub_test_lib_test run-empty-sel \
-               "--run empty selectors" \
                --run="1,,3,,,5" <<-\EOF &&
        for i in 1 2 3 4 5 6
        do
@@ -637,9 +622,8 @@ test_expect_success '--run empty selectors' '
        EOF
 '
 
-test_expect_success '--run substring selector' '
+test_expect_success 'subtest: --run substring selector' '
        write_and_run_sub_test_lib_test run-substring-selector \
-               "--run empty selectors" \
                --run="relevant" <<-\EOF &&
        test_expect_success "relevant test" "true"
        for i in 1 2 3 4 5 6
@@ -661,9 +645,8 @@ test_expect_success '--run substring selector' '
        EOF
 '
 
-test_expect_success '--run keyword selection' '
+test_expect_success 'subtest: --run keyword selection' '
        write_and_run_sub_test_lib_test_err run-inv-range-start \
-               "--run invalid range start" \
                --run="a-5" <<-\EOF &&
        test_expect_success "passing test #1" "true"
        test_done
@@ -676,9 +659,8 @@ test_expect_success '--run keyword selection' '
        EOF_ERR
 '
 
-test_expect_success '--run invalid range end' '
+test_expect_success 'subtest: --run invalid range end' '
        write_and_run_sub_test_lib_test_err run-inv-range-end \
-               "--run invalid range end" \
                --run="1-z" <<-\EOF &&
        test_expect_success "passing test #1" "true"
        test_done
@@ -691,8 +673,8 @@ test_expect_success '--run invalid range end' '
        EOF_ERR
 '
 
-test_expect_success 'tests respect prerequisites' '
-       write_and_run_sub_test_lib_test prereqs "tests respect prereqs" <<-\EOF &&
+test_expect_success 'subtest: tests respect prerequisites' '
+       write_and_run_sub_test_lib_test prereqs <<-\EOF &&
 
        test_set_prereq HAVEIT
        test_expect_success HAVEIT "prereq is satisfied" "true"
@@ -721,8 +703,8 @@ test_expect_success 'tests respect prerequisites' '
        EOF
 '
 
-test_expect_success 'tests respect lazy prerequisites' '
-       write_and_run_sub_test_lib_test lazy-prereqs "respect lazy prereqs" <<-\EOF &&
+test_expect_success 'subtest: tests respect lazy prerequisites' '
+       write_and_run_sub_test_lib_test lazy-prereqs <<-\EOF &&
 
        test_lazy_prereq LAZY_TRUE true
        test_expect_success LAZY_TRUE "lazy prereq is satisifed" "true"
@@ -745,8 +727,8 @@ test_expect_success 'tests respect lazy prerequisites' '
        EOF
 '
 
-test_expect_success 'nested lazy prerequisites' '
-       write_and_run_sub_test_lib_test nested-lazy "nested lazy prereqs" <<-\EOF &&
+test_expect_success 'subtest: nested lazy prerequisites' '
+       write_and_run_sub_test_lib_test nested-lazy <<-\EOF &&
 
        test_lazy_prereq NESTED_INNER "
                >inner &&
@@ -771,9 +753,9 @@ test_expect_success 'nested lazy prerequisites' '
        EOF
 '
 
-test_expect_success 'lazy prereqs do not turn off tracing' '
+test_expect_success 'subtest: lazy prereqs do not turn off tracing' '
        write_and_run_sub_test_lib_test lazy-prereq-and-tracing \
-               "lazy prereqs and -x" -v -x <<-\EOF &&
+               -v -x <<-\EOF &&
        test_lazy_prereq LAZY true
 
        test_expect_success lazy "test_have_prereq LAZY && echo trace"
@@ -784,8 +766,8 @@ test_expect_success 'lazy prereqs do not turn off tracing' '
        grep "echo trace" lazy-prereq-and-tracing/err
 '
 
-test_expect_success 'tests clean up after themselves' '
-       write_and_run_sub_test_lib_test cleanup "test with cleanup" <<-\EOF &&
+test_expect_success 'subtest: tests clean up after themselves' '
+       write_and_run_sub_test_lib_test cleanup <<-\EOF &&
        clean=no
        test_expect_success "do cleanup" "
                test_when_finished clean=yes
@@ -804,9 +786,9 @@ test_expect_success 'tests clean up after themselves' '
        EOF
 '
 
-test_expect_success 'tests clean up even on failures' '
+test_expect_success 'subtest: tests clean up even on failures' '
        write_and_run_sub_test_lib_test_err \
-               failing-cleanup "Failing tests with cleanup commands" <<-\EOF &&
+               failing-cleanup <<-\EOF &&
        test_expect_success "tests clean up even after a failure" "
                touch clean-after-failure &&
                test_when_finished rm clean-after-failure &&
@@ -833,9 +815,9 @@ test_expect_success 'tests clean up even on failures' '
        EOF
 '
 
-test_expect_success 'test_atexit is run' '
+test_expect_success 'subtest: test_atexit is run' '
        write_and_run_sub_test_lib_test_err \
-               atexit-cleanup "Run atexit commands" -i <<-\EOF &&
+               atexit-cleanup -i <<-\EOF &&
        test_expect_success "tests clean up even after a failure" "
                > ../../clean-atexit &&
                test_atexit rm ../../clean-atexit &&