[thirdparty/git.git] / t / test-lib.sh

#!/bin/sh
#
# Copyright (c) 2005 Junio C Hamano
#

# Keep the original TERM for say_color
ORIGINAL_TERM=$TERM

# For repeatability, reset the environment to known value.
LANG=C
LC_ALL=C
PAGER=cat
TZ=UTC
TERM=dumb
export LANG LC_ALL PAGER TERM TZ
EDITOR=:
VISUAL=:
unset GIT_EDITOR
unset AUTHOR_DATE
unset AUTHOR_EMAIL
unset AUTHOR_NAME
unset COMMIT_AUTHOR_EMAIL
unset COMMIT_AUTHOR_NAME
unset EMAIL
unset GIT_ALTERNATE_OBJECT_DIRECTORIES
unset GIT_AUTHOR_DATE
GIT_AUTHOR_EMAIL=author@example.com
GIT_AUTHOR_NAME='A U Thor'
unset GIT_COMMITTER_DATE
GIT_COMMITTER_EMAIL=committer@example.com
GIT_COMMITTER_NAME='C O Mitter'
unset GIT_DIFF_OPTS
unset GIT_DIR
unset GIT_WORK_TREE
unset GIT_EXTERNAL_DIFF
unset GIT_INDEX_FILE
unset GIT_OBJECT_DIRECTORY
unset GIT_CEILING_DIRECTORIES
unset SHA1_FILE_DIRECTORIES
unset SHA1_FILE_DIRECTORY
GIT_MERGE_VERBOSITY=5
export GIT_MERGE_VERBOSITY
export GIT_AUTHOR_EMAIL GIT_AUTHOR_NAME
export GIT_COMMITTER_EMAIL GIT_COMMITTER_NAME
export EDITOR VISUAL
GIT_TEST_CMP=${GIT_TEST_CMP:-diff -u}

# Protect ourselves from common misconfiguration to export
# CDPATH into the environment
unset CDPATH

case $(echo $GIT_TRACE |tr "[A-Z]" "[a-z]") in
	1|2|true)
		echo "* warning: Some tests will not work if GIT_TRACE" \
			"is set as to trace on STDERR ! *"
		echo "* warning: Please set GIT_TRACE to something" \
			"other than 1, 2 or true ! *"
		;;
esac

# Each test should start with something like this, after copyright notices:
#
# test_description='Description of this test...
# This test checks if command xyzzy does the right thing...
# '
# . ./test-lib.sh
[ "x$ORIGINAL_TERM" != "xdumb" ] && (
		TERM=$ORIGINAL_TERM &&
		export TERM &&
		[ -t 1 ] &&
		tput bold >/dev/null 2>&1 &&
		tput setaf 1 >/dev/null 2>&1 &&
		tput sgr0 >/dev/null 2>&1
	) &&
	color=t

while test "$#" -ne 0
do
	case "$1" in
	-d|--d|--de|--deb|--debu|--debug)
		debug=t; shift ;;
	-i|--i|--im|--imm|--imme|--immed|--immedi|--immedia|--immediat|--immediate)
		immediate=t; shift ;;
	-l|--l|--lo|--lon|--long|--long-|--long-t|--long-te|--long-tes|--long-test|--long-tests)
		export GIT_TEST_LONG=t; shift ;;
	-h|--h|--he|--hel|--help)
		help=t; shift ;;
	-v|--v|--ve|--ver|--verb|--verbo|--verbos|--verbose)
		verbose=t; shift ;;
	-q|--q|--qu|--qui|--quie|--quiet)
		quiet=t; shift ;;
	--no-color)
		color=; shift ;;
	--no-python)
		# noop now...
		shift ;;
	*)
		break ;;
	esac
done

if test -n "$color"; then
	say_color () {
		(
		TERM=$ORIGINAL_TERM
		export TERM
		case "$1" in
			error) tput bold; tput setaf 1;; # bold red
			skip)  tput bold; tput setaf 2;; # bold green
			pass)  tput setaf 2;;            # green
			info)  tput setaf 3;;            # brown
			*) test -n "$quiet" && return;;
		esac
		shift
		printf "* %s" "$*"
		tput sgr0
		echo
		)
	}
else
	say_color() {
		test -z "$1" && test -n "$quiet" && return
		shift
		echo "* $*"
	}
fi

error () {
	say_color error "error: $*"
	trap - exit
	exit 1
}

say () {
	say_color info "$*"
}

test "${test_description}" != "" ||
error "Test script did not set test_description."

if test "$help" = "t"
then
	echo "$test_description"
	exit 0
fi

exec 5>&1
if test "$verbose" = "t"
then
	exec 4>&2 3>&1
else
	exec 4>/dev/null 3>/dev/null
fi

test_failure=0
test_count=0
test_fixed=0
test_broken=0
test_success=0

die () {
	echo >&5 "FATAL: Unexpected exit with code $?"
	exit 1
}

trap 'die' exit

# The semantics of the editor variables are that of invoking
# sh -c "$EDITOR \"$@\"" files ...
#
# If our trash directory contains shell metacharacters, they will be
# interpreted if we just set $EDITOR directly, so do a little dance with
# environment variables to work around this.
#
# In particular, quoting isn't enough, as the path may contain the same quote
# that we're using.
test_set_editor () {
	FAKE_EDITOR="$1"
	export FAKE_EDITOR
	VISUAL='"$FAKE_EDITOR"'
	export VISUAL
}

test_tick () {
	if test -z "${test_tick+set}"
	then
		test_tick=1112911993
	else
		test_tick=$(($test_tick + 60))
	fi
	GIT_COMMITTER_DATE="$test_tick -0700"
	GIT_AUTHOR_DATE="$test_tick -0700"
	export GIT_COMMITTER_DATE GIT_AUTHOR_DATE
}

# You are not expected to call test_ok_ and test_failure_ directly, use
# the text_expect_* functions instead.

test_ok_ () {
	test_count=$(expr "$test_count" + 1)
	test_success=$(expr "$test_success" + 1)
	say_color "" "  ok $test_count: $@"
}

test_failure_ () {
	test_count=$(expr "$test_count" + 1)
	test_failure=$(expr "$test_failure" + 1);
	say_color error "FAIL $test_count: $1"
	shift
	echo "$@" | sed -e 's/^/	/'
	test "$immediate" = "" || { trap - exit; exit 1; }
}

test_known_broken_ok_ () {
	test_count=$(expr "$test_count" + 1)
	test_fixed=$(($test_fixed+1))
	say_color "" "  FIXED $test_count: $@"
}

test_known_broken_failure_ () {
	test_count=$(expr "$test_count" + 1)
	test_broken=$(($test_broken+1))
	say_color skip "  still broken $test_count: $@"
}

test_debug () {
	test "$debug" = "" || eval "$1"
}

test_run_ () {
	eval >&3 2>&4 "$1"
	eval_ret="$?"
	return 0
}

test_skip () {
	this_test=$(expr "./$0" : '.*/\(t[0-9]*\)-[^/]*$')
	this_test="$this_test.$(expr "$test_count" + 1)"
	to_skip=
	for skp in $GIT_SKIP_TESTS
	do
		case "$this_test" in
		$skp)
			to_skip=t
		esac
	done
	case "$to_skip" in
	t)
		say_color skip >&3 "skipping test: $@"
		test_count=$(expr "$test_count" + 1)
		say_color skip "skip $test_count: $1"
		: true
		;;
	*)
		false
		;;
	esac
}

test_expect_failure () {
	test "$#" = 2 ||
	error "bug in the test script: not 2 parameters to test-expect-failure"
	if ! test_skip "$@"
	then
		say >&3 "checking known breakage: $2"
		test_run_ "$2"
		if [ "$?" = 0 -a "$eval_ret" = 0 ]
		then
			test_known_broken_ok_ "$1"
		else
		    test_known_broken_failure_ "$1"
		fi
	fi
	echo >&3 ""
}

test_expect_success () {
	test "$#" = 2 ||
	error "bug in the test script: not 2 parameters to test-expect-success"
	if ! test_skip "$@"
	then
		say >&3 "expecting success: $2"
		test_run_ "$2"
		if [ "$?" = 0 -a "$eval_ret" = 0 ]
		then
			test_ok_ "$1"
		else
			test_failure_ "$@"
		fi
	fi
	echo >&3 ""
}

test_expect_code () {
	test "$#" = 3 ||
	error "bug in the test script: not 3 parameters to test-expect-code"
	if ! test_skip "$@"
	then
		say >&3 "expecting exit code $1: $3"
		test_run_ "$3"
		if [ "$?" = 0 -a "$eval_ret" = "$1" ]
		then
			test_ok_ "$2"
		else
			test_failure_ "$@"
		fi
	fi
	echo >&3 ""
}

# test_external runs external test scripts that provide continuous
# test output about their progress, and succeeds/fails on
# zero/non-zero exit code.  It outputs the test output on stdout even
# in non-verbose mode, and announces the external script with "* run
# <n>: ..." before running it.  When providing relative paths, keep in
# mind that all scripts run in "trash directory".
# Usage: test_external description command arguments...
# Example: test_external 'Perl API' perl ../path/to/test.pl
test_external () {
	test "$#" -eq 3 ||
	error >&5 "bug in the test script: not 3 parameters to test_external"
	descr="$1"
	shift
	if ! test_skip "$descr" "$@"
	then
		# Announce the script to reduce confusion about the
		# test output that follows.
		say_color "" " run $(expr "$test_count" + 1): $descr ($*)"
		# Run command; redirect its stderr to &4 as in
		# test_run_, but keep its stdout on our stdout even in
		# non-verbose mode.
		"$@" 2>&4
		if [ "$?" = 0 ]
		then
			test_ok_ "$descr"
		else
			test_failure_ "$descr" "$@"
		fi
	fi
}

# Like test_external, but in addition tests that the command generated
# no output on stderr.
test_external_without_stderr () {
	# The temporary file has no (and must have no) security
	# implications.
	tmp="$TMPDIR"; if [ -z "$tmp" ]; then tmp=/tmp; fi
	stderr="$tmp/git-external-stderr.$$.tmp"
	test_external "$@" 4> "$stderr"
	[ -f "$stderr" ] || error "Internal error: $stderr disappeared."
	descr="no stderr: $1"
	shift
	say >&3 "expecting no stderr from previous command"
	if [ ! -s "$stderr" ]; then
		rm "$stderr"
		test_ok_ "$descr"
	else
		if [ "$verbose" = t ]; then
			output=`echo; echo Stderr is:; cat "$stderr"`
		else
			output=
		fi
		# rm first in case test_failure exits.
		rm "$stderr"
		test_failure_ "$descr" "$@" "$output"
	fi
}

# This is not among top-level (test_expect_success | test_expect_failure)
# but is a prefix that can be used in the test script, like:
#
#	test_expect_success 'complain and die' '
#           do something &&
#           do something else &&
#	    test_must_fail git checkout ../outerspace
#	'
#
# Writing this as "! git checkout ../outerspace" is wrong, because
# the failure could be due to a segv.  We want a controlled failure.

test_must_fail () {
	"$@"
	test $? -gt 0 -a $? -le 129 -o $? -gt 192
}

# test_cmp is a helper function to compare actual and expected output.
# You can use it like:
#
#	test_expect_success 'foo works' '
#		echo expected >expected &&
#		foo >actual &&
#		test_cmp expected actual
#	'
#
# This could be written as either "cmp" or "diff -u", but:
# - cmp's output is not nearly as easy to read as diff -u
# - not all diff versions understand "-u"

test_cmp() {
	$GIT_TEST_CMP "$@"
}

# Most tests can use the created repository, but some may need to create more.
# Usage: test_create_repo <directory>
test_create_repo () {
	test "$#" = 1 ||
	error "bug in the test script: not 1 parameter to test-create-repo"
	owd=`pwd`
	repo="$1"
	mkdir -p "$repo"
	cd "$repo" || error "Cannot setup test environment"
	"$GIT_EXEC_PATH/git" init "--template=$GIT_EXEC_PATH/templates/blt/" >&3 2>&4 ||
	error "cannot run git init -- have you built things yet?"
	mv .git/hooks .git/hooks-disabled
	cd "$owd"
}

test_done () {
	trap - exit
	test_results_dir="$TEST_DIRECTORY/test-results"
	mkdir -p "$test_results_dir"
	test_results_path="$test_results_dir/${0%-*}-$$"

	echo "total $test_count" >> $test_results_path
	echo "success $test_success" >> $test_results_path
	echo "fixed $test_fixed" >> $test_results_path
	echo "broken $test_broken" >> $test_results_path
	echo "failed $test_failure" >> $test_results_path
	echo "" >> $test_results_path

	if test "$test_fixed" != 0
	then
		say_color pass "fixed $test_fixed known breakage(s)"
	fi
	if test "$test_broken" != 0
	then
		say_color error "still have $test_broken known breakage(s)"
		msg="remaining $(($test_count-$test_broken)) test(s)"
	else
		msg="$test_count test(s)"
	fi
	case "$test_failure" in
	0)
		# We could:
		# cd .. && rm -fr 'trash directory'
		# but that means we forbid any tests that use their own
		# subdirectory from calling test_done without coming back
		# to where they started from.
		# The Makefile provided will clean this test area so
		# we will leave things as they are.

		say_color pass "passed all $msg"

		test -d "$remove_trash" &&
		cd "$(dirname "$remove_trash")" &&
		rm -rf "$(basename "$remove_trash")"

		exit 0 ;;

	*)
		say_color error "failed $test_failure among $msg"
		exit 1 ;;

	esac
}

# Test the binaries we have just built.  The tests are kept in
# t/ subdirectory and are run in 'trash directory' subdirectory.
TEST_DIRECTORY=$(pwd)
PATH=$TEST_DIRECTORY/..:$PATH
GIT_EXEC_PATH=$(pwd)/..
GIT_TEMPLATE_DIR=$(pwd)/../templates/blt
unset GIT_CONFIG
GIT_CONFIG_NOSYSTEM=1
GIT_CONFIG_NOGLOBAL=1
export PATH GIT_EXEC_PATH GIT_TEMPLATE_DIR GIT_CONFIG_NOSYSTEM GIT_CONFIG_NOGLOBAL

GITPERLLIB=$(pwd)/../perl/blib/lib:$(pwd)/../perl/blib/arch/auto/Git
export GITPERLLIB
test -d ../templates/blt || {
	error "You haven't built things yet, have you?"
}

if ! test -x ../test-chmtime; then
	echo >&2 'You need to build test-chmtime:'
	echo >&2 'Run "make test-chmtime" in the source (toplevel) directory'
	exit 1
fi

. ../GIT-BUILD-OPTIONS

# Test repository
test="trash directory.$(basename "$0" .sh)"
test ! -z "$debug" || remove_trash="$TEST_DIRECTORY/$test"
rm -fr "$test" || {
	trap - exit
	echo >&5 "FATAL: Cannot prepare test area"
	exit 1
}

test_create_repo "$test"
# Use -P to resolve symlinks in our working directory so that the cwd
# in subprocesses like git equals our $PWD (for pathname comparisons).
cd -P "$test" || exit 1

this_test=$(expr "./$0" : '.*/\(t[0-9]*\)-[^/]*$')
for skp in $GIT_SKIP_TESTS
do
	to_skip=
	for skp in $GIT_SKIP_TESTS
	do
		case "$this_test" in
		$skp)
			to_skip=t
		esac
	done
	case "$to_skip" in
	t)
		say_color skip >&3 "skipping test $this_test altogether"
		say_color skip "skip all tests in $this_test"
		test_done
	esac
done
Commit	Line	Data
e1970ce4 JH	1	#!/bin/sh
	2	#
	3	# Copyright (c) 2005 Junio C Hamano
	4	#
	5
c2116a17 JH	6	# Keep the original TERM for say_color
	7	ORIGINAL_TERM=$TERM
	8
e1970ce4 JH	9	# For repeatability, reset the environment to known value.
e1970ce4 JH	10	LANG=C
899460f3	11	LC_ALL=C
d9bdd39e	12	PAGER=cat
e1970ce4	13	TZ=UTC
c2116a17 JH	14	TERM=dumb
c2116a17 JH	15	export LANG LC_ALL PAGER TERM TZ
8ff99e74 EW	16	EDITOR=:
8ff99e74 EW	17	VISUAL=:
18508c39	18	unset GIT_EDITOR
e1970ce4 JH	19	unset AUTHOR_DATE
	20	unset AUTHOR_EMAIL
	21	unset AUTHOR_NAME
	22	unset COMMIT_AUTHOR_EMAIL
	23	unset COMMIT_AUTHOR_NAME
28a94f88	24	unset EMAIL
e1970ce4 JH	25	unset GIT_ALTERNATE_OBJECT_DIRECTORIES
e1970ce4 JH	26	unset GIT_AUTHOR_DATE
29e55cd5 JH	27	GIT_AUTHOR_EMAIL=author@example.com
29e55cd5 JH	28	GIT_AUTHOR_NAME='A U Thor'
6677c466	29	unset GIT_COMMITTER_DATE
29e55cd5 JH	30	GIT_COMMITTER_EMAIL=committer@example.com
29e55cd5 JH	31	GIT_COMMITTER_NAME='C O Mitter'
e1970ce4 JH	32	unset GIT_DIFF_OPTS
e1970ce4 JH	33	unset GIT_DIR
892c41b9	34	unset GIT_WORK_TREE
e1970ce4 JH	35	unset GIT_EXTERNAL_DIFF
	36	unset GIT_INDEX_FILE
	37	unset GIT_OBJECT_DIRECTORY
0454dd93	38	unset GIT_CEILING_DIRECTORIES
e1970ce4 JH	39	unset SHA1_FILE_DIRECTORIES
e1970ce4 JH	40	unset SHA1_FILE_DIRECTORY
8d0fc48f SP	41	GIT_MERGE_VERBOSITY=5
8d0fc48f SP	42	export GIT_MERGE_VERBOSITY
29e55cd5 JH	43	export GIT_AUTHOR_EMAIL GIT_AUTHOR_NAME
29e55cd5 JH	44	export GIT_COMMITTER_EMAIL GIT_COMMITTER_NAME
8ff99e74	45	export EDITOR VISUAL
82ebb0b6	46	GIT_TEST_CMP=${GIT_TEST_CMP:-diff -u}
e1970ce4	47
886a3907 JH	48	# Protect ourselves from common misconfiguration to export
	49	# CDPATH into the environment
	50	unset CDPATH
	51
3d5c0cc9	52	case $(echo $GIT_TRACE \|tr "[A-Z]" "[a-z]") in
6ce4e61f CC	53	1\|2\|true)
	54	echo "* warning: Some tests will not work if GIT_TRACE" \
	55	"is set as to trace on STDERR ! *"
	56	echo "* warning: Please set GIT_TRACE to something" \
	57	"other than 1, 2 or true ! *"
	58	;;
	59	esac
	60
e1970ce4 JH	61	# Each test should start with something like this, after copyright notices:
	62	#
	63	# test_description='Description of this test...
	64	# This test checks if command xyzzy does the right thing...
	65	# '
	66	# . ./test-lib.sh
c2116a17 JH	67	[ "x$ORIGINAL_TERM" != "xdumb" ] && (
	68	TERM=$ORIGINAL_TERM &&
	69	export TERM &&
	70	[ -t 1 ] &&
	71	tput bold >/dev/null 2>&1 &&
	72	tput setaf 1 >/dev/null 2>&1 &&
	73	tput sgr0 >/dev/null 2>&1
	74	) &&
55db1df0	75	color=t
e1970ce4	76
e1970ce4 JH	77	while test "$#" -ne 0
	78	do
	79	case "$1" in
	80	-d\|--d\|--de\|--deb\|--debu\|--debug)
	81	debug=t; shift ;;
886856ab JH	82	-i\|--i\|--im\|--imm\|--imme\|--immed\|--immedi\|--immedia\|--immediat\|--immediate)
886856ab JH	83	immediate=t; shift ;;
5e2c08c6 LW	84	-l\|--l\|--lo\|--lon\|--long\|--long-\|--long-t\|--long-te\|--long-tes\|--long-test\|--long-tests)
5e2c08c6 LW	85	export GIT_TEST_LONG=t; shift ;;
e1970ce4	86	-h\|--h\|--he\|--hel\|--help)
570f3226	87	help=t; shift ;;
e1970ce4 JH	88	-v\|--v\|--ve\|--ver\|--verb\|--verbo\|--verbos\|--verbose)
e1970ce4 JH	89	verbose=t; shift ;;
1ece1274 PH	90	-q\|--q\|--qu\|--qui\|--quie\|--quiet)
1ece1274 PH	91	quiet=t; shift ;;
55db1df0	92	--no-color)
faa4bc35	93	color=; shift ;;
abb7c7b3	94	--no-python)
7cdbff14 JH	95	# noop now...
7cdbff14 JH	96	shift ;;
e1970ce4 JH	97	*)
	98	break ;;
	99	esac
	100	done
	101
55db1df0 PH	102	if test -n "$color"; then
55db1df0 PH	103	say_color () {
c2116a17 JH	104	(
	105	TERM=$ORIGINAL_TERM
	106	export TERM
55db1df0 PH	107	case "$1" in
	108	error) tput bold; tput setaf 1;; # bold red
	109	skip) tput bold; tput setaf 2;; # bold green
	110	pass) tput setaf 2;; # green
	111	info) tput setaf 3;; # brown
1ece1274	112	*) test -n "$quiet" && return;;
55db1df0 PH	113	esac
55db1df0 PH	114	shift
72d404de	115	printf "* %s" "$*"
55db1df0	116	tput sgr0
b8eecafd	117	echo
c2116a17	118	)
55db1df0 PH	119	}
	120	else
	121	say_color() {
1ece1274	122	test -z "$1" && test -n "$quiet" && return
55db1df0 PH	123	shift
	124	echo "* $*"
	125	}
	126	fi
	127
	128	error () {
	129	say_color error "error: $*"
	130	trap - exit
	131	exit 1
	132	}
	133
	134	say () {
	135	say_color info "$*"
	136	}
	137
570f3226 MB	138	test "${test_description}" != "" \|\|
	139	error "Test script did not set test_description."
	140
	141	if test "$help" = "t"
	142	then
	143	echo "$test_description"
	144	exit 0
	145	fi
	146
4d9d62fa	147	exec 5>&1
e1970ce4 JH	148	if test "$verbose" = "t"
	149	then
	150	exec 4>&2 3>&1
	151	else
	152	exec 4>/dev/null 3>/dev/null
	153	fi
	154
	155	test_failure=0
	156	test_count=0
41ac414e JH	157	test_fixed=0
41ac414e JH	158	test_broken=0
2d84e9fb	159	test_success=0
e1970ce4	160
faa4bc35 CB	161	die () {
	162	echo >&5 "FATAL: Unexpected exit with code $?"
	163	exit 1
	164	}
	165
	166	trap 'die' exit
41184273	167
02b35660 BD	168	# The semantics of the editor variables are that of invoking
	169	# sh -c "$EDITOR \"$@\"" files ...
	170	#
	171	# If our trash directory contains shell metacharacters, they will be
	172	# interpreted if we just set $EDITOR directly, so do a little dance with
	173	# environment variables to work around this.
	174	#
	175	# In particular, quoting isn't enough, as the path may contain the same quote
7b7b4516	176	# that we're using.
02b35660 BD	177	test_set_editor () {
	178	FAKE_EDITOR="$1"
	179	export FAKE_EDITOR
	180	VISUAL='"$FAKE_EDITOR"'
	181	export VISUAL
	182	}
	183
04509738 JH	184	test_tick () {
	185	if test -z "${test_tick+set}"
	186	then
21afc41c	187	test_tick=1112911993
04509738 JH	188	else
	189	test_tick=$(($test_tick + 60))
	190	fi
21afc41c JH	191	GIT_COMMITTER_DATE="$test_tick -0700"
21afc41c JH	192	GIT_AUTHOR_DATE="$test_tick -0700"
04509738 JH	193	export GIT_COMMITTER_DATE GIT_AUTHOR_DATE
04509738 JH	194	}
e1970ce4	195
886856ab JH	196	# You are not expected to call test_ok_ and test_failure_ directly, use
	197	# the text_expect_* functions instead.
	198
	199	test_ok_ () {
e1970ce4	200	test_count=$(expr "$test_count" + 1)
2d84e9fb	201	test_success=$(expr "$test_success" + 1)
55db1df0	202	say_color "" " ok $test_count: $@"
e1970ce4 JH	203	}
e1970ce4 JH	204
886856ab	205	test_failure_ () {
e1970ce4 JH	206	test_count=$(expr "$test_count" + 1)
e1970ce4 JH	207	test_failure=$(expr "$test_failure" + 1);
55db1df0	208	say_color error "FAIL $test_count: $1"
bf0dd8a8 JH	209	shift
bf0dd8a8 JH	210	echo "$@" \| sed -e 's/^/ /'
41184273	211	test "$immediate" = "" \|\| { trap - exit; exit 1; }
886856ab JH	212	}
886856ab JH	213
41ac414e JH	214	test_known_broken_ok_ () {
	215	test_count=$(expr "$test_count" + 1)
	216	test_fixed=$(($test_fixed+1))
	217	say_color "" " FIXED $test_count: $@"
	218	}
	219
	220	test_known_broken_failure_ () {
	221	test_count=$(expr "$test_count" + 1)
	222	test_broken=$(($test_broken+1))
	223	say_color skip " still broken $test_count: $@"
	224	}
886856ab JH	225
886856ab JH	226	test_debug () {
8e832ebc	227	test "$debug" = "" \|\| eval "$1"
e1970ce4 JH	228	}
e1970ce4 JH	229
4d9d62fa	230	test_run_ () {
4d9d62fa PR	231	eval >&3 2>&4 "$1"
4d9d62fa PR	232	eval_ret="$?"
4d9d62fa PR	233	return 0
	234	}
	235
04ece593 JH	236	test_skip () {
	237	this_test=$(expr "./$0" : './\(t[0-9]\)-[^/]*$')
	238	this_test="$this_test.$(expr "$test_count" + 1)"
	239	to_skip=
	240	for skp in $GIT_SKIP_TESTS
	241	do
	242	case "$this_test" in
	243	$skp)
	244	to_skip=t
	245	esac
	246	done
	247	case "$to_skip" in
	248	t)
55db1df0	249	say_color skip >&3 "skipping test: $@"
04ece593	250	test_count=$(expr "$test_count" + 1)
55db1df0	251	say_color skip "skip $test_count: $1"
04ece593 JH	252	: true
	253	;;
	254	*)
	255	false
	256	;;
	257	esac
	258	}
	259
e1970ce4	260	test_expect_failure () {
8e832ebc	261	test "$#" = 2 \|\|
e1970ce4	262	error "bug in the test script: not 2 parameters to test-expect-failure"
04ece593	263	if ! test_skip "$@"
e1970ce4	264	then
41ac414e	265	say >&3 "checking known breakage: $2"
04ece593	266	test_run_ "$2"
41ac414e	267	if [ "$?" = 0 -a "$eval_ret" = 0 ]
04ece593	268	then
41ac414e	269	test_known_broken_ok_ "$1"
04ece593	270	else
41ac414e	271	test_known_broken_failure_ "$1"
04ece593	272	fi
e1970ce4	273	fi
7a0cf2d0	274	echo >&3 ""
e1970ce4 JH	275	}
	276
	277	test_expect_success () {
8e832ebc	278	test "$#" = 2 \|\|
e1970ce4	279	error "bug in the test script: not 2 parameters to test-expect-success"
04ece593	280	if ! test_skip "$@"
e1970ce4	281	then
04ece593 JH	282	say >&3 "expecting success: $2"
	283	test_run_ "$2"
	284	if [ "$?" = 0 -a "$eval_ret" = 0 ]
	285	then
	286	test_ok_ "$1"
	287	else
	288	test_failure_ "$@"
	289	fi
e1970ce4	290	fi
7a0cf2d0	291	echo >&3 ""
e1970ce4 JH	292	}
e1970ce4 JH	293
d3bfdb75 FK	294	test_expect_code () {
	295	test "$#" = 3 \|\|
	296	error "bug in the test script: not 3 parameters to test-expect-code"
04ece593	297	if ! test_skip "$@"
d3bfdb75	298	then
04ece593 JH	299	say >&3 "expecting exit code $1: $3"
	300	test_run_ "$3"
	301	if [ "$?" = 0 -a "$eval_ret" = "$1" ]
	302	then
	303	test_ok_ "$2"
	304	else
	305	test_failure_ "$@"
	306	fi
d3bfdb75	307	fi
7a0cf2d0	308	echo >&3 ""
d3bfdb75 FK	309	}
d3bfdb75 FK	310
fb32c410 LW	311	# test_external runs external test scripts that provide continuous
	312	# test output about their progress, and succeeds/fails on
	313	# zero/non-zero exit code. It outputs the test output on stdout even
	314	# in non-verbose mode, and announces the external script with "* run
	315	# <n>: ..." before running it. When providing relative paths, keep in
	316	# mind that all scripts run in "trash directory".
	317	# Usage: test_external description command arguments...
	318	# Example: test_external 'Perl API' perl ../path/to/test.pl
	319	test_external () {
	320	test "$#" -eq 3 \|\|
	321	error >&5 "bug in the test script: not 3 parameters to test_external"
	322	descr="$1"
	323	shift
	324	if ! test_skip "$descr" "$@"
	325	then
	326	# Announce the script to reduce confusion about the
	327	# test output that follows.
	328	say_color "" " run $(expr "$test_count" + 1): $descr ($*)"
	329	# Run command; redirect its stderr to &4 as in
	330	# test_run_, but keep its stdout on our stdout even in
	331	# non-verbose mode.
	332	"$@" 2>&4
	333	if [ "$?" = 0 ]
	334	then
	335	test_ok_ "$descr"
	336	else
	337	test_failure_ "$descr" "$@"
	338	fi
	339	fi
	340	}
	341
	342	# Like test_external, but in addition tests that the command generated
	343	# no output on stderr.
	344	test_external_without_stderr () {
	345	# The temporary file has no (and must have no) security
	346	# implications.
	347	tmp="$TMPDIR"; if [ -z "$tmp" ]; then tmp=/tmp; fi
	348	stderr="$tmp/git-external-stderr.$$.tmp"
	349	test_external "$@" 4> "$stderr"
	350	[ -f "$stderr" ] \|\| error "Internal error: $stderr disappeared."
	351	descr="no stderr: $1"
	352	shift
	353	say >&3 "expecting no stderr from previous command"
	354	if [ ! -s "$stderr" ]; then
	355	rm "$stderr"
	356	test_ok_ "$descr"
	357	else
	358	if [ "$verbose" = t ]; then
	359	output=`echo; echo Stderr is:; cat "$stderr"`
	360	else
	361	output=
	362	fi
	363	# rm first in case test_failure exits.
	364	rm "$stderr"
	365	test_failure_ "$descr" "$@" "$output"
	366	fi
	367	}
	368
74359821 JH	369	# This is not among top-level (test_expect_success \| test_expect_failure)
	370	# but is a prefix that can be used in the test script, like:
	371	#
	372	# test_expect_success 'complain and die' '
	373	# do something &&
	374	# do something else &&
	375	# test_must_fail git checkout ../outerspace
	376	# '
	377	#
	378	# Writing this as "! git checkout ../outerspace" is wrong, because
	379	# the failure could be due to a segv. We want a controlled failure.
	380
	381	test_must_fail () {
	382	"$@"
5a269730	383	test $? -gt 0 -a $? -le 129 -o $? -gt 192
74359821 JH	384	}
74359821 JH	385
82ebb0b6 JK	386	# test_cmp is a helper function to compare actual and expected output.
	387	# You can use it like:
	388	#
	389	# test_expect_success 'foo works' '
	390	# echo expected >expected &&
	391	# foo >actual &&
	392	# test_cmp expected actual
	393	# '
	394	#
	395	# This could be written as either "cmp" or "diff -u", but:
	396	# - cmp's output is not nearly as easy to read as diff -u
	397	# - not all diff versions understand "-u"
	398
	399	test_cmp() {
	400	$GIT_TEST_CMP "$@"
	401	}
	402
0509eb21	403	# Most tests can use the created repository, but some may need to create more.
eedf8f97 CW	404	# Usage: test_create_repo <directory>
	405	test_create_repo () {
	406	test "$#" = 1 \|\|
	407	error "bug in the test script: not 1 parameter to test-create-repo"
	408	owd=`pwd`
	409	repo="$1"
bfdbee98	410	mkdir -p "$repo"
eedf8f97	411	cd "$repo" \|\| error "Cannot setup test environment"
4c7ba956	412	"$GIT_EXEC_PATH/git" init "--template=$GIT_EXEC_PATH/templates/blt/" >&3 2>&4 \|\|
5c94f87e	413	error "cannot run git init -- have you built things yet?"
eedf8f97 CW	414	mv .git/hooks .git/hooks-disabled
	415	cd "$owd"
	416	}
a6080a0a	417
e1970ce4	418	test_done () {
41184273	419	trap - exit
2d84e9fb SR	420	test_results_dir="$TEST_DIRECTORY/test-results"
	421	mkdir -p "$test_results_dir"
	422	test_results_path="$test_results_dir/${0%-*}-$$"
	423
	424	echo "total $test_count" >> $test_results_path
	425	echo "success $test_success" >> $test_results_path
	426	echo "fixed $test_fixed" >> $test_results_path
	427	echo "broken $test_broken" >> $test_results_path
	428	echo "failed $test_failure" >> $test_results_path
	429	echo "" >> $test_results_path
41ac414e JH	430
	431	if test "$test_fixed" != 0
	432	then
	433	say_color pass "fixed $test_fixed known breakage(s)"
	434	fi
	435	if test "$test_broken" != 0
	436	then
	437	say_color error "still have $test_broken known breakage(s)"
11d54b8b JH	438	msg="remaining $(($test_count-$test_broken)) test(s)"
	439	else
	440	msg="$test_count test(s)"
41ac414e	441	fi
e1970ce4	442	case "$test_failure" in
10b94e28	443	0)
e1970ce4	444	# We could:
9231e3a9	445	# cd .. && rm -fr 'trash directory'
e1970ce4 JH	446	# but that means we forbid any tests that use their own
	447	# subdirectory from calling test_done without coming back
	448	# to where they started from.
	449	# The Makefile provided will clean this test area so
	450	# we will leave things as they are.
	451
11d54b8b	452	say_color pass "passed all $msg"
abc5d372 JS	453
	454	test -d "$remove_trash" &&
	455	cd "$(dirname "$remove_trash")" &&
	456	rm -rf "$(basename "$remove_trash")"
	457
e1970ce4 JH	458	exit 0 ;;
	459
	460	*)
11d54b8b	461	say_color error "failed $test_failure among $msg"
e1970ce4 JH	462	exit 1 ;;
	463
	464	esac
	465	}
	466
	467	# Test the binaries we have just built. The tests are kept in
9adefee5	468	# t/ subdirectory and are run in 'trash directory' subdirectory.
2d84e9fb SR	469	TEST_DIRECTORY=$(pwd)
2d84e9fb SR	470	PATH=$TEST_DIRECTORY/..:$PATH
a0fa2a10	471	GIT_EXEC_PATH=$(pwd)/..
8683a45d	472	GIT_TEMPLATE_DIR=$(pwd)/../templates/blt
8bfa6bd6	473	unset GIT_CONFIG
8bfa6bd6 JK	474	GIT_CONFIG_NOSYSTEM=1
	475	GIT_CONFIG_NOGLOBAL=1
	476	export PATH GIT_EXEC_PATH GIT_TEMPLATE_DIR GIT_CONFIG_NOSYSTEM GIT_CONFIG_NOGLOBAL
49ccb087	477
6fcca938 PB	478	GITPERLLIB=$(pwd)/../perl/blib/lib:$(pwd)/../perl/blib/arch/auto/Git
6fcca938 PB	479	export GITPERLLIB
eea42069 JH	480	test -d ../templates/blt \|\| {
	481	error "You haven't built things yet, have you?"
	482	}
e1970ce4	483
56cf9806 EW	484	if ! test -x ../test-chmtime; then
	485	echo >&2 'You need to build test-chmtime:'
	486	echo >&2 'Run "make test-chmtime" in the source (toplevel) directory'
	487	exit 1
	488	fi
	489
7cf7f54a JK	490	. ../GIT-BUILD-OPTIONS
7cf7f54a JK	491
e1970ce4	492	# Test repository
abc5d372	493	test="trash directory.$(basename "$0" .sh)"
5a4a088a	494	test ! -z "$debug" \|\| remove_trash="$TEST_DIRECTORY/$test"
8d14ac94 JH	495	rm -fr "$test" \|\| {
	496	trap - exit
	497	echo >&5 "FATAL: Cannot prepare test area"
	498	exit 1
	499	}
	500
4a7aaccd	501	test_create_repo "$test"
1bd9c648 LW	502	# Use -P to resolve symlinks in our working directory so that the cwd
	503	# in subprocesses like git equals our $PWD (for pathname comparisons).
	504	cd -P "$test" \|\| exit 1
04ece593 JH	505
	506	this_test=$(expr "./$0" : './\(t[0-9]\)-[^/]*$')
	507	for skp in $GIT_SKIP_TESTS
	508	do
	509	to_skip=
	510	for skp in $GIT_SKIP_TESTS
	511	do
	512	case "$this_test" in
	513	$skp)
	514	to_skip=t
	515	esac
	516	done
	517	case "$to_skip" in
	518	t)
55db1df0 PH	519	say_color skip >&3 "skipping test $this_test altogether"
55db1df0 PH	520	say_color skip "skip all tests in $this_test"
04ece593 JH	521	test_done
	522	esac
	523	done