git/t/t7006-pager.sh
Jonathan Nieder 2d3ca21677 t7006-pager: if stdout is not a terminal, make a new one
Testing pagination requires (fake or real) access to a terminal so we
can see whether the pagination automatically kicks in, which makes it
hard to get good coverage when running tests without --verbose.  There
are a number of ways to work around that:

 - Replace all isatty calls with calls to a custom xisatty wrapper
   that usually checks for a terminal but can be overridden for tests.
   This would be workable, but it would require implementing xisatty
   separately in three languages (C, shell, and perl) and making sure
   that any code that is to be tested always uses the wrapper.

 - Redirect stdout to /dev/tty.  This would be problematic because
   there might be no terminal available, and even if a terminal is
   available, it might not be appropriate to spew output to it.

 - Create a new pseudo-terminal on the fly and capture its output.

This patch implements the third approach.

The new test-terminal.perl helper uses IO::Pty from Expect.pm to create
a terminal and executes the program specified by its arguments with
that terminal as stdout.  If the IO::Pty module is missing or not
working on a system, the test script will maintain its old behavior
(skipping most of its tests unless GIT_TEST_OPTS includes --verbose).

Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2010-02-21 11:08:17 -08:00

177 lines
3.8 KiB
Bash
Executable File

#!/bin/sh
test_description='Test automatic use of a pager.'
. ./test-lib.sh
rm -f stdout_is_tty
test_expect_success 'set up terminal for tests' '
if test -t 1
then
: > stdout_is_tty
elif
test_have_prereq PERL &&
"$PERL_PATH" "$TEST_DIRECTORY"/t7006/test-terminal.perl \
sh -c "test -t 1"
then
: > test_terminal_works
fi
'
if test -e stdout_is_tty
then
test_terminal() { "$@"; }
test_set_prereq TTY
elif test -e test_terminal_works
then
test_terminal() {
"$PERL_PATH" "$TEST_DIRECTORY"/t7006/test-terminal.perl "$@"
}
test_set_prereq TTY
else
say no usable terminal, so skipping some tests
fi
unset GIT_PAGER GIT_PAGER_IN_USE
git config --unset core.pager
PAGER='cat > paginated.out'
export PAGER
test_expect_success 'setup' '
test_commit initial
'
rm -f paginated.out
test_expect_success TTY 'some commands use a pager' '
test_terminal git log &&
test -e paginated.out
'
rm -f paginated.out
test_expect_success TTY 'some commands do not use a pager' '
test_terminal git rev-list HEAD &&
! test -e paginated.out
'
rm -f paginated.out
test_expect_success 'no pager when stdout is a pipe' '
git log | cat &&
! test -e paginated.out
'
rm -f paginated.out
test_expect_success 'no pager when stdout is a regular file' '
git log > file &&
! test -e paginated.out
'
rm -f paginated.out
test_expect_success TTY 'git --paginate rev-list uses a pager' '
test_terminal git --paginate rev-list HEAD &&
test -e paginated.out
'
rm -f file paginated.out
test_expect_success 'no pager even with --paginate when stdout is a pipe' '
git --paginate log | cat &&
! test -e paginated.out
'
rm -f paginated.out
test_expect_success TTY 'no pager with --no-pager' '
test_terminal git --no-pager log &&
! test -e paginated.out
'
# A colored commit log will begin with an appropriate ANSI escape
# for the first color; the text "commit" comes later.
colorful() {
read firstline < $1
! expr "$firstline" : "^[a-zA-Z]" >/dev/null
}
rm -f colorful.log colorless.log
test_expect_success 'tests can detect color' '
git log --no-color > colorless.log &&
git log --color > colorful.log &&
! colorful colorless.log &&
colorful colorful.log
'
rm -f colorless.log
git config color.ui auto
test_expect_success 'no color when stdout is a regular file' '
git log > colorless.log &&
! colorful colorless.log
'
rm -f paginated.out
git config color.ui auto
test_expect_success TTY 'color when writing to a pager' '
TERM=vt100 test_terminal git log &&
colorful paginated.out
'
rm -f colorful.log
git config color.ui auto
test_expect_success 'color when writing to a file intended for a pager' '
TERM=vt100 GIT_PAGER_IN_USE=true git log > colorful.log &&
colorful colorful.log
'
unset PAGER GIT_PAGER
git config --unset core.pager
test_expect_success 'determine default pager' '
less=$(git var GIT_PAGER) &&
test -n "$less"
'
if expr "$less" : '^[a-z]*$' > /dev/null && test_have_prereq TTY
then
test_set_prereq SIMPLEPAGER
fi
unset PAGER GIT_PAGER
git config --unset core.pager
rm -f default_pager_used
test_expect_success SIMPLEPAGER 'default pager is used by default' '
cat > $less <<-EOF &&
#!$SHELL_PATH
: > default_pager_used
EOF
chmod +x $less &&
PATH=.:$PATH test_terminal git log &&
test -e default_pager_used
'
unset GIT_PAGER
git config --unset core.pager
rm -f PAGER_used
test_expect_success TTY 'PAGER overrides default pager' '
PAGER=": > PAGER_used" &&
export PAGER &&
test_terminal git log &&
test -e PAGER_used
'
unset GIT_PAGER
rm -f core.pager_used
test_expect_success TTY 'core.pager overrides PAGER' '
PAGER=: &&
export PAGER &&
git config core.pager ": > core.pager_used" &&
test_terminal git log &&
test -e core.pager_used
'
rm -f GIT_PAGER_used
test_expect_success TTY 'GIT_PAGER overrides core.pager' '
git config core.pager : &&
GIT_PAGER=": > GIT_PAGER_used" &&
export GIT_PAGER &&
test_terminal git log &&
test -e GIT_PAGER_used
'
test_done