summaryrefslogtreecommitdiff
path: root/t/README
diff options
context:
space:
mode:
authorPhilippe Blain <levraiphilippeblain@gmail.com>2021-09-06 04:38:59 (GMT)
committerJunio C Hamano <gitster@pobox.com>2021-09-07 17:53:39 (GMT)
commitadd5240fa53fef8c9fad9081d927ffb9cbaaeb56 (patch)
treeca7763ce394f8dc22ad44e69b3c8d1bedb8f48a8 /t/README
parent0aa496b6d5d8953ed51d5601f4cdf1d4cf19b82c (diff)
downloadgit-add5240fa53fef8c9fad9081d927ffb9cbaaeb56.zip
git-add5240fa53fef8c9fad9081d927ffb9cbaaeb56.tar.gz
git-add5240fa53fef8c9fad9081d927ffb9cbaaeb56.tar.bz2
test-lib-functions: optionally keep HOME, TERM and SHELL in 'test_pause'
The 'test_pause' function, which is designed to help interactive debugging and exploration of tests, currently inherits the value of HOME and TERM set by 'test-lib.sh': HOME="$TRASH_DIRECTORY" and TERM=dumb. It also invokes the shell defined by TEST_SHELL_PATH, which defaults to /bin/sh (through SHELL_PATH). Changing the value of HOME means that any customization configured in a developers' shell startup files and any Git aliases defined in their global Git configuration file are not available in the shell invoked by 'test_pause'. Changing the value of TERM to 'dumb' means that colored output is disabled for all commands in that shell. Using /bin/sh as the shell invoked by 'test_pause' is not ideal since some platforms (i.e. Debian and derivatives) use Dash as /bin/sh, and this shell is usually compiled without readline support, which makes for a poor interactive command line experience. To make the interactive command line experience in the shell invoked by 'test_pause' more pleasant, save the values of HOME and TERM in USER_HOME and USER_TERM before changing them in test-lib.sh, and add options to 'test_pause' to optionally use these variables to invoke the shell. Also add an option to invoke SHELL instead of TEST_SHELL_PATH, so that developer's interactive shell is used. We use options instead of changing the behaviour unconditionally since these three variables can slightly change command behaviour. Moreover, using the original HOME means commands could overwrite files in a user's home directory. Be explicit about these caveats in the new 'Usage' section in test-lib-functions.sh. Finally, add '[options]' to the test_pause synopsys in t/README, and mention that the full list of helper functions and their options can be found in test-lib-functions.sh. Helped-by: Elijah Newren <newren@gmail.com> Signed-off-by: Philippe Blain <levraiphilippeblain@gmail.com> Acked-by: Elijah Newren <newren@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 't/README')
-rw-r--r--t/README5
1 files changed, 3 insertions, 2 deletions
diff --git a/t/README b/t/README
index 9e70122..cc8be6e 100644
--- a/t/README
+++ b/t/README
@@ -753,7 +753,8 @@ Test harness library
--------------------
There are a handful helper functions defined in the test harness
-library for your script to use.
+library for your script to use. Some of them are listed below;
+see test-lib-functions.sh for the full list and their options.
- test_expect_success [<prereq>] <message> <script>
@@ -989,7 +990,7 @@ library for your script to use.
EOF
- - test_pause
+ - test_pause [options]
This command is useful for writing and debugging tests and must be
removed before submitting. It halts the execution of the test and