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

#!/bin/sh
#
# Copyright (c) 2005 Junio C Hamano
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see http://www.gnu.org/licenses/ .

# 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
	EDITOR='"$FAKE_EDITOR"'
	export EDITOR
}

test_decode_color () {
	awk '
		function name(n) {
			if (n == 0) return "RESET";
			if (n == 1) return "BOLD";
			if (n == 30) return "BLACK";
			if (n == 31) return "RED";
			if (n == 32) return "GREEN";
			if (n == 33) return "YELLOW";
			if (n == 34) return "BLUE";
			if (n == 35) return "MAGENTA";
			if (n == 36) return "CYAN";
			if (n == 37) return "WHITE";
			if (n == 40) return "BLACK";
			if (n == 41) return "BRED";
			if (n == 42) return "BGREEN";
			if (n == 43) return "BYELLOW";
			if (n == 44) return "BBLUE";
			if (n == 45) return "BMAGENTA";
			if (n == 46) return "BCYAN";
			if (n == 47) return "BWHITE";
		}
		{
			while (match($0, /\033\[[0-9;]*m/) != 0) {
				printf "%s<", substr($0, 1, RSTART-1);
				codes = substr($0, RSTART+2, RLENGTH-3);
				if (length(codes) == 0)
					printf "%s", name(0)
				else {
					n = split(codes, ary, ";");
					sep = "";
					for (i = 1; i <= n; i++) {
						printf "%s%s", sep, name(ary[i]);
						sep = ";"
					}
				}
				printf ">";
				$0 = substr($0, RSTART + RLENGTH, length($0) - RSTART - RLENGTH + 1);
			}
			print
		}
	'
}

nul_to_q () {
	"$PERL_PATH" -pe 'y/\000/Q/'
}

q_to_nul () {
	"$PERL_PATH" -pe 'y/Q/\000/'
}

q_to_cr () {
	tr Q '\015'
}

q_to_tab () {
	tr Q '\011'
}

qz_to_tab_space () {
	tr QZ '\011\040'
}

append_cr () {
	sed -e 's/$/Q/' | tr Q '\015'
}

remove_cr () {
	tr '\015' Q | sed -e 's/Q$//'
}

# In some bourne shell implementations, the "unset" builtin returns
# nonzero status when a variable to be unset was not set in the first
# place.
#
# Use sane_unset when that should not be considered an error.

sane_unset () {
	unset "$@"
	return 0
}

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
}

# Stop execution and start a shell. This is useful for debugging tests and
# only makes sense together with "-v".
#
# Be sure to remove all invocations of this command before submitting.

test_pause () {
	if test "$verbose" = t; then
		"$SHELL_PATH" <&6 >&3 2>&4
	else
		error >&5 "test_pause requires --verbose"
	fi
}

# Call test_commit with the arguments "<message> [<file> [<contents>]]"
#
# This will commit a file with the given contents and the given commit
# message.  It will also add a tag with <message> as name.
#
# Both <file> and <contents> default to <message>.

test_commit () {
	notick= &&
	signoff= &&
	while test $# != 0
	do
		case "$1" in
		--notick)
			notick=yes
			;;
		--signoff)
			signoff="$1"
			;;
		*)
			break
			;;
		esac
		shift
	done &&
	file=${2:-"$1.t"} &&
	echo "${3-$1}" > "$file" &&
	git add "$file" &&
	if test -z "$notick"
	then
		test_tick
	fi &&
	git commit $signoff -m "$1" &&
	git tag "$1"
}

# Call test_merge with the arguments "<message> <commit>", where <commit>
# can be a tag pointing to the commit-to-merge.

test_merge () {
	test_tick &&
	git merge -m "$1" "$2" &&
	git tag "$1"
}

# This function helps systems where core.filemode=false is set.
# Use it instead of plain 'chmod +x' to set or unset the executable bit
# of a file in the working directory and add it to the index.

test_chmod () {
	chmod "$@" &&
	git update-index --add "--chmod=$@"
}

# Unset a configuration variable, but don't fail if it doesn't exist.
test_unconfig () {
	git config --unset-all "$@"
	config_status=$?
	case "$config_status" in
	5) # ok, nothing to unset
		config_status=0
		;;
	esac
	return $config_status
}

# Set git config, automatically unsetting it after the test is over.
test_config () {
	test_when_finished "test_unconfig '$1'" &&
	git config "$@"
}

test_config_global () {
	test_when_finished "test_unconfig --global '$1'" &&
	git config --global "$@"
}

write_script () {
	{
		echo "#!${2-"$SHELL_PATH"}" &&
		cat
	} >"$1" &&
	chmod +x "$1"
}

# Use test_set_prereq to tell that a particular prerequisite is available.
# The prerequisite can later be checked for in two ways:
#
# - Explicitly using test_have_prereq.
#
# - Implicitly by specifying the prerequisite tag in the calls to
#   test_expect_{success,failure,code}.
#
# The single parameter is the prerequisite tag (a simple word, in all
# capital letters by convention).

test_set_prereq () {
	satisfied_prereq="$satisfied_prereq$1 "
}
satisfied_prereq=" "
lazily_testable_prereq= lazily_tested_prereq=

# Usage: test_lazy_prereq PREREQ 'script'
test_lazy_prereq () {
	lazily_testable_prereq="$lazily_testable_prereq$1 "
	eval test_prereq_lazily_$1=\$2
}

test_run_lazy_prereq_ () {
	script='
mkdir -p "$TRASH_DIRECTORY/prereq-test-dir" &&
(
	cd "$TRASH_DIRECTORY/prereq-test-dir" &&'"$2"'
)'
	say >&3 "checking prerequisite: $1"
	say >&3 "$script"
	test_eval_ "$script"
	eval_ret=$?
	rm -rf "$TRASH_DIRECTORY/prereq-test-dir"
	if test "$eval_ret" = 0; then
		say >&3 "prerequisite $1 ok"
	else
		say >&3 "prerequisite $1 not satisfied"
	fi
	return $eval_ret
}

test_have_prereq () {
	# prerequisites can be concatenated with ','
	save_IFS=$IFS
	IFS=,
	set -- $*
	IFS=$save_IFS

	total_prereq=0
	ok_prereq=0
	missing_prereq=

	for prerequisite
	do
		case "$prerequisite" in
		!*)
			negative_prereq=t
			prerequisite=${prerequisite#!}
			;;
		*)
			negative_prereq=
		esac

		case " $lazily_tested_prereq " in
		*" $prerequisite "*)
			;;
		*)
			case " $lazily_testable_prereq " in
			*" $prerequisite "*)
				eval "script=\$test_prereq_lazily_$prerequisite" &&
				if test_run_lazy_prereq_ "$prerequisite" "$script"
				then
					test_set_prereq $prerequisite
				fi
				lazily_tested_prereq="$lazily_tested_prereq$prerequisite "
			esac
			;;
		esac

		total_prereq=$(($total_prereq + 1))
		case "$satisfied_prereq" in
		*" $prerequisite "*)
			satisfied_this_prereq=t
			;;
		*)
			satisfied_this_prereq=
		esac

		case "$satisfied_this_prereq,$negative_prereq" in
		t,|,t)
			ok_prereq=$(($ok_prereq + 1))
			;;
		*)
			# Keep a list of missing prerequisites; restore
			# the negative marker if necessary.
			prerequisite=${negative_prereq:+!}$prerequisite
			if test -z "$missing_prereq"
			then
				missing_prereq=$prerequisite
			else
				missing_prereq="$prerequisite,$missing_prereq"
			fi
		esac
	done

	test $total_prereq = $ok_prereq
}

test_declared_prereq () {
	case ",$test_prereq," in
	*,$1,*)
		return 0
		;;
	esac
	return 1
}

test_expect_failure () {
	test "$#" = 3 && { test_prereq=$1; shift; } || test_prereq=
	test "$#" = 2 ||
	error "bug in the test script: not 2 or 3 parameters to test-expect-failure"
	export test_prereq
	if ! test_skip "$@"
	then
		say >&3 "checking known breakage: $2"
		if test_run_ "$2" expecting_failure
		then
			test_known_broken_ok_ "$1"
		else
			test_known_broken_failure_ "$1"
		fi
	fi
	echo >&3 ""
}

test_expect_success () {
	test "$#" = 3 && { test_prereq=$1; shift; } || test_prereq=
	test "$#" = 2 ||
	error "bug in the test script: not 2 or 3 parameters to test-expect-success"
	export test_prereq
	if ! test_skip "$@"
	then
		say >&3 "expecting success: $2"
		if test_run_ "$2"
		then
			test_ok_ "$1"
		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 "$#" = 4 && { test_prereq=$1; shift; } || test_prereq=
	test "$#" = 3 ||
	error >&5 "bug in the test script: not 3 or 4 parameters to test_external"
	descr="$1"
	shift
	export test_prereq
	if ! test_skip "$descr" "$@"
	then
		# Announce the script to reduce confusion about the
		# test output that follows.
		say_color "" "# run $test_count: $descr ($*)"
		# Export TEST_DIRECTORY, TRASH_DIRECTORY and GIT_TEST_LONG
		# to be able to use them in script
		export TEST_DIRECTORY TRASH_DIRECTORY GIT_TEST_LONG
		# 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
			if test $test_external_has_tap -eq 0; then
				test_ok_ "$descr"
			else
				say_color "" "# test_external test $descr was ok"
				test_success=$(($test_success + 1))
			fi
		else
			if test $test_external_has_tap -eq 0; then
				test_failure_ "$descr" "$@"
			else
				say_color error "# test_external test $descr failed: $@"
				test_failure=$(($test_failure + 1))
			fi
		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:-/tmp}
	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"

		if test $test_external_has_tap -eq 0; then
			test_ok_ "$descr"
		else
			say_color "" "# test_external_without_stderr test $descr was ok"
			test_success=$(($test_success + 1))
		fi
	else
		if [ "$verbose" = t ]; then
			output=`echo; echo "# Stderr is:"; cat "$stderr"`
		else
			output=
		fi
		# rm first in case test_failure exits.
		rm "$stderr"
		if test $test_external_has_tap -eq 0; then
			test_failure_ "$descr" "$@" "$output"
		else
			say_color error "# test_external_without_stderr test $descr failed: $@: $output"
			test_failure=$(($test_failure + 1))
		fi
	fi
}

# debugging-friendly alternatives to "test [-f|-d|-e]"
# The commands test the existence or non-existence of $1. $2 can be
# given to provide a more precise diagnosis.
test_path_is_file () {
	if ! [ -f "$1" ]
	then
		echo "File $1 doesn't exist. $*"
		false
	fi
}

test_path_is_dir () {
	if ! [ -d "$1" ]
	then
		echo "Directory $1 doesn't exist. $*"
		false
	fi
}

test_path_is_missing () {
	if [ -e "$1" ]
	then
		echo "Path exists:"
		ls -ld "$1"
		if [ $# -ge 1 ]; then
			echo "$*"
		fi
		false
	fi
}

# test_line_count checks that a file has the number of lines it
# ought to. For example:
#
#	test_expect_success 'produce exactly one line of output' '
#		do something >output &&
#		test_line_count = 1 output
#	'
#
# is like "test $(wc -l <output) = 1" except that it passes the
# output through when the number of lines is wrong.

test_line_count () {
	if test $# != 3
	then
		error "bug in the test script: not 3 parameters to test_line_count"
	elif ! test $(wc -l <"$3") "$1" "$2"
	then
		echo "test_line_count: line count for $3 !$1 $2"
		cat "$3"
		return 1
	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 () {
	"$@"
	exit_code=$?
	if test $exit_code = 0; then
		echo >&2 "test_must_fail: command succeeded: $*"
		return 1
	elif test $exit_code -gt 129 -a $exit_code -le 192; then
		echo >&2 "test_must_fail: died by signal: $*"
		return 1
	elif test $exit_code = 127; then
		echo >&2 "test_must_fail: command not found: $*"
		return 1
	fi
	return 0
}

# Similar to test_must_fail, but tolerates success, too.  This is
# meant to be used in contexts like:
#
#	test_expect_success 'some command works without configuration' '
#		test_might_fail git config --unset all.configuration &&
#		do something
#	'
#
# Writing "git config --unset all.configuration || :" would be wrong,
# because we want to notice if it fails due to segv.

test_might_fail () {
	"$@"
	exit_code=$?
	if test $exit_code -gt 129 -a $exit_code -le 192; then
		echo >&2 "test_might_fail: died by signal: $*"
		return 1
	elif test $exit_code = 127; then
		echo >&2 "test_might_fail: command not found: $*"
		return 1
	fi
	return 0
}

# Similar to test_must_fail and test_might_fail, but check that a
# given command exited with a given exit code. Meant to be used as:
#
#	test_expect_success 'Merge with d/f conflicts' '
#		test_expect_code 1 git merge "merge msg" B master
#	'

test_expect_code () {
	want_code=$1
	shift
	"$@"
	exit_code=$?
	if test $exit_code = $want_code
	then
		return 0
	fi

	echo >&2 "test_expect_code: command exited with $exit_code, we wanted $want_code $*"
	return 1
}

# 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 "$@"
}

# Tests that its two parameters refer to the same revision
test_cmp_rev () {
	git rev-parse --verify "$1" >expect.rev &&
	git rev-parse --verify "$2" >actual.rev &&
	test_cmp expect.rev actual.rev
}

# Print a sequence of numbers or letters in increasing order.  This is
# similar to GNU seq(1), but the latter might not be available
# everywhere (and does not do letters).  It may be used like:
#
#	for i in `test_seq 100`; do
#		for j in `test_seq 10 20`; do
#			for k in `test_seq a z`; do
#				echo $i-$j-$k
#			done
#		done
#	done

test_seq () {
	case $# in
	1)	set 1 "$@" ;;
	2)	;;
	*)	error "bug in the test script: not 1 or 2 parameters to test_seq" ;;
	esac
	"$PERL_PATH" -le 'print for $ARGV[0]..$ARGV[1]' -- "$@"
}

# This function can be used to schedule some commands to be run
# unconditionally at the end of the test to restore sanity:
#
#	test_expect_success 'test core.capslock' '
#		git config core.capslock true &&
#		test_when_finished "git config --unset core.capslock" &&
#		hello world
#	'
#
# That would be roughly equivalent to
#
#	test_expect_success 'test core.capslock' '
#		git config core.capslock true &&
#		hello world
#		git config --unset core.capslock
#	'
#
# except that the greeting and config --unset must both succeed for
# the test to pass.
#
# Note that under --immediate mode, no clean-up is done to help diagnose
# what went wrong.

test_when_finished () {
	test_cleanup="{ $*
		} && (exit \"\$eval_ret\"); eval_ret=\$?; $test_cleanup"
}

# 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"
	repo="$1"
	mkdir -p "$repo"
	(
		cd "$repo" || error "Cannot setup test environment"
		"$GIT_EXEC_PATH/git-init" "--template=$GIT_BUILD_DIR/templates/blt/" >&3 2>&4 ||
		error "cannot run git init -- have you built things yet?"
		mv .git/hooks .git/hooks-disabled
	) || exit
}
Commit	Line	Data
12a29b1a TR	1	#!/bin/sh
	2	#
	3	# Copyright (c) 2005 Junio C Hamano
	4	#
	5	# This program is free software: you can redistribute it and/or modify
	6	# it under the terms of the GNU General Public License as published by
	7	# the Free Software Foundation, either version 2 of the License, or
	8	# (at your option) any later version.
	9	#
	10	# This program is distributed in the hope that it will be useful,
	11	# but WITHOUT ANY WARRANTY; without even the implied warranty of
	12	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	13	# GNU General Public License for more details.
	14	#
	15	# You should have received a copy of the GNU General Public License
	16	# along with this program. If not, see http://www.gnu.org/licenses/ .
	17
	18	# The semantics of the editor variables are that of invoking
	19	# sh -c "$EDITOR \"$@\"" files ...
	20	#
	21	# If our trash directory contains shell metacharacters, they will be
	22	# interpreted if we just set $EDITOR directly, so do a little dance with
	23	# environment variables to work around this.
	24	#
	25	# In particular, quoting isn't enough, as the path may contain the same quote
	26	# that we're using.
	27	test_set_editor () {
	28	FAKE_EDITOR="$1"
	29	export FAKE_EDITOR
	30	EDITOR='"$FAKE_EDITOR"'
	31	export EDITOR
	32	}
	33
	34	test_decode_color () {
	35	awk '
	36	function name(n) {
	37	if (n == 0) return "RESET";
	38	if (n == 1) return "BOLD";
	39	if (n == 30) return "BLACK";
	40	if (n == 31) return "RED";
	41	if (n == 32) return "GREEN";
	42	if (n == 33) return "YELLOW";
	43	if (n == 34) return "BLUE";
	44	if (n == 35) return "MAGENTA";
	45	if (n == 36) return "CYAN";
	46	if (n == 37) return "WHITE";
	47	if (n == 40) return "BLACK";
	48	if (n == 41) return "BRED";
	49	if (n == 42) return "BGREEN";
	50	if (n == 43) return "BYELLOW";
	51	if (n == 44) return "BBLUE";
	52	if (n == 45) return "BMAGENTA";
	53	if (n == 46) return "BCYAN";
	54	if (n == 47) return "BWHITE";
	55	}
	56	{
	57	while (match($0, /\033\[[0-9;]*m/) != 0) {
	58	printf "%s<", substr($0, 1, RSTART-1);
	59	codes = substr($0, RSTART+2, RLENGTH-3);
	60	if (length(codes) == 0)
	61	printf "%s", name(0)
	62	else {
	63	n = split(codes, ary, ";");
	64	sep = "";
65	for (i = 1; i <= n; i++) {
66	printf "%s%s", sep, name(ary[i]);
67	sep = ";"
68	}
69	}
70	printf ">";
71	$0 = substr($0, RSTART + RLENGTH, length($0) - RSTART - RLENGTH + 1);
72	}
73	print
74	}
75	'
76	}
77
78	nul_to_q () {
7096b648	79	"$PERL_PATH" -pe 'y/\000/Q/'
12a29b1a TR	80	}
	81
	82	q_to_nul () {
7096b648	83	"$PERL_PATH" -pe 'y/Q/\000/'
12a29b1a TR	84	}
	85
	86	q_to_cr () {
	87	tr Q '\015'
	88	}
	89
	90	q_to_tab () {
	91	tr Q '\011'
	92	}
	93
250b3c6c JH	94	qz_to_tab_space () {
250b3c6c JH	95	tr QZ '\011\040'
12a29b1a TR	96	}
	97
	98	append_cr () {
	99	sed -e 's/$/Q/' \| tr Q '\015'
	100	}
	101
	102	remove_cr () {
	103	tr '\015' Q \| sed -e 's/Q$//'
	104	}
	105
	106	# In some bourne shell implementations, the "unset" builtin returns
	107	# nonzero status when a variable to be unset was not set in the first
	108	# place.
	109	#
	110	# Use sane_unset when that should not be considered an error.
	111
	112	sane_unset () {
	113	unset "$@"
	114	return 0
	115	}
	116
	117	test_tick () {
	118	if test -z "${test_tick+set}"
	119	then
	120	test_tick=1112911993
	121	else
	122	test_tick=$(($test_tick + 60))
	123	fi
	124	GIT_COMMITTER_DATE="$test_tick -0700"
	125	GIT_AUTHOR_DATE="$test_tick -0700"
	126	export GIT_COMMITTER_DATE GIT_AUTHOR_DATE
	127	}
	128
	129	# Stop execution and start a shell. This is useful for debugging tests and
	130	# only makes sense together with "-v".
	131	#
	132	# Be sure to remove all invocations of this command before submitting.
	133
	134	test_pause () {
	135	if test "$verbose" = t; then
	136	"$SHELL_PATH" <&6 >&3 2>&4
	137	else
	138	error >&5 "test_pause requires --verbose"
	139	fi
	140	}
	141
	142	# Call test_commit with the arguments "<message> [<file> [<contents>]]"
	143	#
	144	# This will commit a file with the given contents and the given commit
	145	# message. It will also add a tag with <message> as name.
	146	#
	147	# Both <file> and <contents> default to <message>.
	148
	149	test_commit () {
9a0231b3	150	notick= &&
5ed75e2a MV	151	signoff= &&
	152	while test $# != 0
	153	do
	154	case "$1" in
	155	--notick)
	156	notick=yes
	157	;;
	158	--signoff)
	159	signoff="$1"
	160	;;
	161	*)
	162	break
	163	;;
	164	esac
9a0231b3	165	shift
5ed75e2a	166	done &&
9a0231b3	167	file=${2:-"$1.t"} &&
12a29b1a TR	168	echo "${3-$1}" > "$file" &&
12a29b1a TR	169	git add "$file" &&
9a0231b3 JH	170	if test -z "$notick"
	171	then
	172	test_tick
	173	fi &&
5ed75e2a	174	git commit $signoff -m "$1" &&
12a29b1a TR	175	git tag "$1"
	176	}
	177
	178	# Call test_merge with the arguments "<message> <commit>", where <commit>
	179	# can be a tag pointing to the commit-to-merge.
	180
	181	test_merge () {
	182	test_tick &&
	183	git merge -m "$1" "$2" &&
	184	git tag "$1"
	185	}
	186
	187	# This function helps systems where core.filemode=false is set.
	188	# Use it instead of plain 'chmod +x' to set or unset the executable bit
	189	# of a file in the working directory and add it to the index.
	190
	191	test_chmod () {
	192	chmod "$@" &&
	193	git update-index --add "--chmod=$@"
	194	}
	195
	196	# Unset a configuration variable, but don't fail if it doesn't exist.
	197	test_unconfig () {
	198	git config --unset-all "$@"
	199	config_status=$?
	200	case "$config_status" in
	201	5) # ok, nothing to unset
	202	config_status=0
	203	;;
	204	esac
	205	return $config_status
	206	}
	207
	208	# Set git config, automatically unsetting it after the test is over.
	209	test_config () {
	210	test_when_finished "test_unconfig '$1'" &&
	211	git config "$@"
	212	}
	213
	214	test_config_global () {
	215	test_when_finished "test_unconfig --global '$1'" &&
	216	git config --global "$@"
	217	}
	218
	219	write_script () {
	220	{
	221	echo "#!${2-"$SHELL_PATH"}" &&
	222	cat
	223	} >"$1" &&
	224	chmod +x "$1"
	225	}
	226
	227	# Use test_set_prereq to tell that a particular prerequisite is available.
	228	# The prerequisite can later be checked for in two ways:
	229	#
	230	# - Explicitly using test_have_prereq.
	231	#
	232	# - Implicitly by specifying the prerequisite tag in the calls to
	233	# test_expect_{success,failure,code}.
	234	#
	235	# The single parameter is the prerequisite tag (a simple word, in all
	236	# capital letters by convention).
	237
	238	test_set_prereq () {
f3cfc3b2	239	satisfied_prereq="$satisfied_prereq$1 "
12a29b1a	240	}
f3cfc3b2	241	satisfied_prereq=" "
04083f27 JH	242	lazily_testable_prereq= lazily_tested_prereq=
	243
	244	# Usage: test_lazy_prereq PREREQ 'script'
	245	test_lazy_prereq () {
	246	lazily_testable_prereq="$lazily_testable_prereq$1 "
	247	eval test_prereq_lazily_$1=\$2
	248	}
	249
	250	test_run_lazy_prereq_ () {
	251	script='
	252	mkdir -p "$TRASH_DIRECTORY/prereq-test-dir" &&
	253	(
	254	cd "$TRASH_DIRECTORY/prereq-test-dir" &&'"$2"'
	255	)'
	256	say >&3 "checking prerequisite: $1"
	257	say >&3 "$script"
	258	test_eval_ "$script"
	259	eval_ret=$?
	260	rm -rf "$TRASH_DIRECTORY/prereq-test-dir"
	261	if test "$eval_ret" = 0; then
	262	say >&3 "prerequisite $1 ok"
	263	else
	264	say >&3 "prerequisite $1 not satisfied"
	265	fi
	266	return $eval_ret
	267	}
12a29b1a TR	268
	269	test_have_prereq () {
	270	# prerequisites can be concatenated with ','
	271	save_IFS=$IFS
	272	IFS=,
	273	set -- $*
	274	IFS=$save_IFS
	275
	276	total_prereq=0
	277	ok_prereq=0
	278	missing_prereq=
	279
	280	for prerequisite
	281	do
bdccd3c1 JK	282	case "$prerequisite" in
	283	!*)
	284	negative_prereq=t
	285	prerequisite=${prerequisite#!}
	286	;;
	287	*)
	288	negative_prereq=
	289	esac
	290
04083f27 JH	291	case " $lazily_tested_prereq " in
	292	" $prerequisite ")
	293	;;
	294	*)
	295	case " $lazily_testable_prereq " in
	296	" $prerequisite ")
	297	eval "script=\$test_prereq_lazily_$prerequisite" &&
	298	if test_run_lazy_prereq_ "$prerequisite" "$script"
	299	then
	300	test_set_prereq $prerequisite
	301	fi
	302	lazily_tested_prereq="$lazily_tested_prereq$prerequisite "
	303	esac
	304	;;
	305	esac
	306
12a29b1a	307	total_prereq=$(($total_prereq + 1))
f3cfc3b2	308	case "$satisfied_prereq" in
12a29b1a	309	" $prerequisite ")
bdccd3c1 JK	310	satisfied_this_prereq=t
	311	;;
	312	*)
	313	satisfied_this_prereq=
	314	esac
	315
	316	case "$satisfied_this_prereq,$negative_prereq" in
	317	t,\|,t)
12a29b1a TR	318	ok_prereq=$(($ok_prereq + 1))
	319	;;
	320	*)
bdccd3c1 JK	321	# Keep a list of missing prerequisites; restore
	322	# the negative marker if necessary.
	323	prerequisite=${negative_prereq:+!}$prerequisite
12a29b1a TR	324	if test -z "$missing_prereq"
	325	then
	326	missing_prereq=$prerequisite
	327	else
	328	missing_prereq="$prerequisite,$missing_prereq"
	329	fi
	330	esac
	331	done
	332
	333	test $total_prereq = $ok_prereq
	334	}
	335
	336	test_declared_prereq () {
	337	case ",$test_prereq," in
	338	,$1,)
	339	return 0
	340	;;
	341	esac
	342	return 1
	343	}
	344
	345	test_expect_failure () {
	346	test "$#" = 3 && { test_prereq=$1; shift; } \|\| test_prereq=
	347	test "$#" = 2 \|\|
	348	error "bug in the test script: not 2 or 3 parameters to test-expect-failure"
	349	export test_prereq
	350	if ! test_skip "$@"
	351	then
	352	say >&3 "checking known breakage: $2"
	353	if test_run_ "$2" expecting_failure
	354	then
	355	test_known_broken_ok_ "$1"
	356	else
	357	test_known_broken_failure_ "$1"
	358	fi
	359	fi
	360	echo >&3 ""
	361	}
	362
	363	test_expect_success () {
	364	test "$#" = 3 && { test_prereq=$1; shift; } \|\| test_prereq=
	365	test "$#" = 2 \|\|
	366	error "bug in the test script: not 2 or 3 parameters to test-expect-success"
	367	export test_prereq
	368	if ! test_skip "$@"
	369	then
	370	say >&3 "expecting success: $2"
	371	if test_run_ "$2"
	372	then
	373	test_ok_ "$1"
	374	else
	375	test_failure_ "$@"
	376	fi
	377	fi
	378	echo >&3 ""
	379	}
	380
	381	# test_external runs external test scripts that provide continuous
	382	# test output about their progress, and succeeds/fails on
	383	# zero/non-zero exit code. It outputs the test output on stdout even
	384	# in non-verbose mode, and announces the external script with "# run
	385	# <n>: ..." before running it. When providing relative paths, keep in
	386	# mind that all scripts run in "trash directory".
	387	# Usage: test_external description command arguments...
388	# Example: test_external 'Perl API' perl ../path/to/test.pl
389	test_external () {
390	test "$#" = 4 && { test_prereq=$1; shift; } \|\| test_prereq=
391	test "$#" = 3 \|\|
392	error >&5 "bug in the test script: not 3 or 4 parameters to test_external"
393	descr="$1"
394	shift
395	export test_prereq
396	if ! test_skip "$descr" "$@"
397	then
398	# Announce the script to reduce confusion about the
399	# test output that follows.
400	say_color "" "# run $test_count: $descr ($*)"
401	# Export TEST_DIRECTORY, TRASH_DIRECTORY and GIT_TEST_LONG
402	# to be able to use them in script
403	export TEST_DIRECTORY TRASH_DIRECTORY GIT_TEST_LONG
404	# Run command; redirect its stderr to &4 as in
405	# test_run_, but keep its stdout on our stdout even in
406	# non-verbose mode.
407	"$@" 2>&4
408	if [ "$?" = 0 ]
409	then
410	if test $test_external_has_tap -eq 0; then
411	test_ok_ "$descr"
412	else
413	say_color "" "# test_external test $descr was ok"
414	test_success=$(($test_success + 1))
415	fi
416	else
417	if test $test_external_has_tap -eq 0; then
418	test_failure_ "$descr" "$@"
419	else
420	say_color error "# test_external test $descr failed: $@"
421	test_failure=$(($test_failure + 1))
422	fi
423	fi
424	fi
425	}
426
427	# Like test_external, but in addition tests that the command generated
428	# no output on stderr.
429	test_external_without_stderr () {
430	# The temporary file has no (and must have no) security
431	# implications.
432	tmp=${TMPDIR:-/tmp}
433	stderr="$tmp/git-external-stderr.$$.tmp"
434	test_external "$@" 4> "$stderr"
435	[ -f "$stderr" ] \|\| error "Internal error: $stderr disappeared."
436	descr="no stderr: $1"
437	shift
438	say >&3 "# expecting no stderr from previous command"
439	if [ ! -s "$stderr" ]; then
440	rm "$stderr"
441
442	if test $test_external_has_tap -eq 0; then
443	test_ok_ "$descr"
444	else
445	say_color "" "# test_external_without_stderr test $descr was ok"
446	test_success=$(($test_success + 1))
447	fi
448	else
449	if [ "$verbose" = t ]; then
450	output=`echo; echo "# Stderr is:"; cat "$stderr"`
451	else
452	output=
453	fi
454	# rm first in case test_failure exits.
455	rm "$stderr"
456	if test $test_external_has_tap -eq 0; then
457	test_failure_ "$descr" "$@" "$output"
458	else
459	say_color error "# test_external_without_stderr test $descr failed: $@: $output"
460	test_failure=$(($test_failure + 1))
461	fi
462	fi
463	}
464
465	# debugging-friendly alternatives to "test [-f\|-d\|-e]"
466	# The commands test the existence or non-existence of $1. $2 can be
467	# given to provide a more precise diagnosis.
468	test_path_is_file () {
469	if ! [ -f "$1" ]
470	then
471	echo "File $1 doesn't exist. $*"
472	false
473	fi
474	}
475
476	test_path_is_dir () {
477	if ! [ -d "$1" ]
478	then
479	echo "Directory $1 doesn't exist. $*"
480	false
481	fi
482	}
483
484	test_path_is_missing () {
485	if [ -e "$1" ]
486	then
487	echo "Path exists:"
488	ls -ld "$1"
489	if [ $# -ge 1 ]; then
490	echo "$*"
491	fi
492	false
493	fi
494	}
495
496	# test_line_count checks that a file has the number of lines it
497	# ought to. For example:
498	#
499	# test_expect_success 'produce exactly one line of output' '
500	# do something >output &&
501	# test_line_count = 1 output
502	# '
503	#
504	# is like "test $(wc -l <output) = 1" except that it passes the
505	# output through when the number of lines is wrong.
506
507	test_line_count () {
508	if test $# != 3
509	then
510	error "bug in the test script: not 3 parameters to test_line_count"
511	elif ! test $(wc -l <"$3") "$1" "$2"
512	then
513	echo "test_line_count: line count for $3 !$1 $2"
514	cat "$3"
515	return 1
516	fi
517	}
518
519	# This is not among top-level (test_expect_success \| test_expect_failure)
520	# but is a prefix that can be used in the test script, like:
521	#
522	# test_expect_success 'complain and die' '
523	# do something &&
524	# do something else &&
525	# test_must_fail git checkout ../outerspace
526	# '
527	#
528	# Writing this as "! git checkout ../outerspace" is wrong, because
529	# the failure could be due to a segv. We want a controlled failure.
530
531	test_must_fail () {
532	"$@"
533	exit_code=$?
534	if test $exit_code = 0; then
535	echo >&2 "test_must_fail: command succeeded: $*"
536	return 1
537	elif test $exit_code -gt 129 -a $exit_code -le 192; then
538	echo >&2 "test_must_fail: died by signal: $*"
539	return 1
540	elif test $exit_code = 127; then
541	echo >&2 "test_must_fail: command not found: $*"
542	return 1
543	fi
544	return 0
545	}
546
547	# Similar to test_must_fail, but tolerates success, too. This is
548	# meant to be used in contexts like:
549	#
550	# test_expect_success 'some command works without configuration' '
551	# test_might_fail git config --unset all.configuration &&
552	# do something
553	# '
554	#
555	# Writing "git config --unset all.configuration \|\| :" would be wrong,
556	# because we want to notice if it fails due to segv.
557
558	test_might_fail () {
559	"$@"
560	exit_code=$?
561	if test $exit_code -gt 129 -a $exit_code -le 192; then
562	echo >&2 "test_might_fail: died by signal: $*"
563	return 1
564	elif test $exit_code = 127; then
565	echo >&2 "test_might_fail: command not found: $*"
566	return 1
567	fi
568	return 0
569	}
570
571	# Similar to test_must_fail and test_might_fail, but check that a
572	# given command exited with a given exit code. Meant to be used as:
573	#
574	# test_expect_success 'Merge with d/f conflicts' '
575	# test_expect_code 1 git merge "merge msg" B master
576	# '
577
578	test_expect_code () {
579	want_code=$1
580	shift
581	"$@"
582	exit_code=$?
583	if test $exit_code = $want_code
584	then
585	return 0
586	fi
587
588	echo >&2 "test_expect_code: command exited with $exit_code, we wanted $want_code $*"
589	return 1
590	}
591
592	# test_cmp is a helper function to compare actual and expected output.
593	# You can use it like:
594	#
595	# test_expect_success 'foo works' '
596	# echo expected >expected &&
597	# foo >actual &&
598	# test_cmp expected actual
599	# '
600	#
601	# This could be written as either "cmp" or "diff -u", but:
602	# - cmp's output is not nearly as easy to read as diff -u
603	# - not all diff versions understand "-u"
604
605	test_cmp() {
606	$GIT_TEST_CMP "$@"
607	}
608
5d77298d MZ	609	# Tests that its two parameters refer to the same revision
	610	test_cmp_rev () {
	611	git rev-parse --verify "$1" >expect.rev &&
	612	git rev-parse --verify "$2" >actual.rev &&
	613	test_cmp expect.rev actual.rev
	614	}
	615
d17cf5f3 MK	616	# Print a sequence of numbers or letters in increasing order. This is
	617	# similar to GNU seq(1), but the latter might not be available
	618	# everywhere (and does not do letters). It may be used like:
	619	#
	620	# for i in `test_seq 100`; do
	621	# for j in `test_seq 10 20`; do
	622	# for k in `test_seq a z`; do
	623	# echo $i-$j-$k
	624	# done
	625	# done
	626	# done
	627
	628	test_seq () {
	629	case $# in
	630	1) set 1 "$@" ;;
	631	2) ;;
	632	*) error "bug in the test script: not 1 or 2 parameters to test_seq" ;;
	633	esac
	634	"$PERL_PATH" -le 'print for $ARGV[0]..$ARGV[1]' -- "$@"
	635	}
	636
12a29b1a TR	637	# This function can be used to schedule some commands to be run
	638	# unconditionally at the end of the test to restore sanity:
	639	#
	640	# test_expect_success 'test core.capslock' '
	641	# git config core.capslock true &&
	642	# test_when_finished "git config --unset core.capslock" &&
	643	# hello world
	644	# '
	645	#
	646	# That would be roughly equivalent to
	647	#
	648	# test_expect_success 'test core.capslock' '
	649	# git config core.capslock true &&
	650	# hello world
	651	# git config --unset core.capslock
	652	# '
	653	#
	654	# except that the greeting and config --unset must both succeed for
	655	# the test to pass.
	656	#
	657	# Note that under --immediate mode, no clean-up is done to help diagnose
	658	# what went wrong.
	659
	660	test_when_finished () {
	661	test_cleanup="{ $*
	662	} && (exit \"\$eval_ret\"); eval_ret=\$?; $test_cleanup"
	663	}
	664
	665	# Most tests can use the created repository, but some may need to create more.
	666	# Usage: test_create_repo <directory>
	667	test_create_repo () {
	668	test "$#" = 1 \|\|
	669	error "bug in the test script: not 1 parameter to test-create-repo"
	670	repo="$1"
	671	mkdir -p "$repo"
	672	(
	673	cd "$repo" \|\| error "Cannot setup test environment"
	674	"$GIT_EXEC_PATH/git-init" "--template=$GIT_BUILD_DIR/templates/blt/" >&3 2>&4 \|\|
	675	error "cannot run git init -- have you built things yet?"
	676	mv .git/hooks .git/hooks-disabled
	677	) \|\| exit
	678	}