test: prepare test-lib.sh for possible test system debug session

When something in tests fails one possibility to test is to run
the test script as `bash -x TXXX-testname.sh`. As stderr (fd 2) was
redirected to separate file during test execution also this set -x
(xtrace) output would also go there.
test-lib.sh saves the stderr to fd 7 from where it can be restored,
and bash has BASH_XTRACEFD variable, which is now given the same value
7, making bash to output all xtrade information (consistently) there.

This lib file used to save fd's 1 & 2 to 6 & 7 (respectively) in
test_begin_subtest(), but as those needs to be set *before* XTRACEFD
variable is set those are now saved at the beginning of the lib (once).
This is safe and simple thing to do.
To make xtrace output more verbose PS4 variable was set to contain the
source file, line number and if execution is in function, that function
name. Setting this variable has no effect when not xtracing.

As it is known that fd 6 is redirected stdout, printing status can now
use that fd, instead of saving stdout to fd 5 and use it.

diff --git a/test/test-lib-common.sh b/test/test-lib-common.sh
index 4903038dd9ce531ea7dda467a0d0eac6f86d8bd4..f99ed11162ade498eaef756b9a65774a6a29afec 100644 (file)
--- a/test/test-lib-common.sh
+++ b/test/test-lib-common.sh
@@ -122,7 +122,7 @@ esac
 test ! -z "$debug" || remove_tmp=$TMP_DIRECTORY
 rm -fr "$test" || {
        GIT_EXIT_OK=t
 test ! -z "$debug" || remove_tmp=$TMP_DIRECTORY
 rm -fr "$test" || {
        GIT_EXIT_OK=t

-       echo >&5 "FATAL: Cannot prepare test area"
+       echo >&6 "FATAL: Cannot prepare test area"

        exit 1
 }
 
        exit 1
 }
 

diff --git a/test/test-lib.sh b/test/test-lib.sh
index 6057238c7e3cc9f6880efd49e20923cf2d6c0140..133fbe4025143ffebf68ddaab47ff582a275dafe 100644 (file)
--- a/test/test-lib.sh
+++ b/test/test-lib.sh
@@ -45,6 +45,12 @@ done,*)
        ;;
 esac
 
        ;;
 esac
 

+# Save STDOUT to fd 6 and STDERR to fd 7.
+exec 6>&1 7>&2
+# Make xtrace debugging (when used) use redirected STDERR, with verbose lead:
+BASH_XTRACEFD=7
+export PS4='+(${BASH_SOURCE}:${LINENO}): ${FUNCNAME[0]:+${FUNCNAME[0]}(): }'
+

 # Keep the original TERM for say_color and test_emacs
 ORIGINAL_TERM=$TERM
 
 # Keep the original TERM for say_color and test_emacs
 ORIGINAL_TERM=$TERM
 


@@ -204,8 +210,6 @@ then
        print_test_description
 fi
 
        print_test_description
 fi
 

-exec 5>&1
-

 test_failure=0
 test_count=0
 test_fixed=0
 test_failure=0
 test_count=0
 test_fixed=0


@@ -225,7 +229,7 @@ die () {
        then
                exit $code
        else
        then
                exit $code
        else

-               exec >&5
+               exec >&6

                say_color error '%-6s' FATAL
                echo " $test_subtest_name"
                echo
                say_color error '%-6s' FATAL
                echo " $test_subtest_name"
                echo


@@ -236,7 +240,7 @@ die () {
 
 die_signal () {
        _die_common
 
 die_signal () {
        _die_common

-       echo >&5 "FATAL: $0: interrupted by signal" $((code - 128))
+       echo >&6 "FATAL: $0: interrupted by signal" $((code - 128))

        exit $code
 }
 
        exit $code
 }
 


@@ -546,11 +550,10 @@ test_begin_subtest ()
     fi
     test_subtest_name="$1"
     test_reset_state_
     fi
     test_subtest_name="$1"
     test_reset_state_

-    # Remember stdout and stderr file descriptors and redirect test
-    # output to the previously prepared file descriptors 3 and 4 (see
-    # below)
+    # Redirect test output to the previously prepared file descriptors
+    # 3 and 4 (see below)

     if test "$verbose" != "t"; then exec 4>test.output 3>&4; fi
     if test "$verbose" != "t"; then exec 4>test.output 3>&4; fi

-    exec 6>&1 7>&2 >&3 2>&4
+    exec >&3 2>&4

     inside_subtest=t
 }
 
     inside_subtest=t
 }
 


@@ -941,7 +944,7 @@ test_expect_code () {
 test_external () {
        test "$#" = 4 && { prereq=$1; shift; } || prereq=
        test "$#" = 3 ||
 test_external () {
        test "$#" = 4 && { prereq=$1; shift; } || prereq=
        test "$#" = 3 ||

-       error >&5 "bug in the test script: not 3 or 4 parameters to test_external"
+       error >&6 "bug in the test script: not 3 or 4 parameters to test_external"

        test_subtest_name="$1"
        shift
        test_reset_state_
        test_subtest_name="$1"
        shift
        test_reset_state_