test-lib.sh 22.9 KB
Newer Older
1 2 3 4
#!/bin/sh
#
# Copyright (c) 2005 Junio C Hamano
#
5 6 7 8 9 10 11 12 13 14 15 16
# 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/ .
17

18 19 20 21 22 23
# if --tee was passed, write the output not only to the terminal, but
# additionally to the file test-results/$BASENAME.out, too.
case "$GIT_TEST_TEE_STARTED, $* " in
done,*)
	# do not redirect again
	;;
24
*' --tee '*|*' --va'*)
25 26 27 28 29 30 31 32 33
	mkdir -p test-results
	BASE=test-results/$(basename "$0" .sh)
	(GIT_TEST_TEE_STARTED=done ${SHELL-sh} "$0" "$@" 2>&1;
	 echo $? > $BASE.exit) | tee $BASE.out
	test "$(cat $BASE.exit)" = 0
	exit
	;;
esac

34 35 36
# Keep the original TERM for say_color
ORIGINAL_TERM=$TERM

37 38
# For repeatability, reset the environment to known value.
LANG=C
39
LC_ALL=C
40
PAGER=cat
41
TZ=UTC
42 43
TERM=dumb
export LANG LC_ALL PAGER TERM TZ
44
EDITOR=:
45
unset VISUAL
46
unset GIT_EDITOR
47 48 49 50 51
unset AUTHOR_DATE
unset AUTHOR_EMAIL
unset AUTHOR_NAME
unset COMMIT_AUTHOR_EMAIL
unset COMMIT_AUTHOR_NAME
52
unset EMAIL
53 54
unset GIT_ALTERNATE_OBJECT_DIRECTORIES
unset GIT_AUTHOR_DATE
55 56
GIT_AUTHOR_EMAIL=author@example.com
GIT_AUTHOR_NAME='A U Thor'
57
unset GIT_COMMITTER_DATE
58 59
GIT_COMMITTER_EMAIL=committer@example.com
GIT_COMMITTER_NAME='C O Mitter'
60 61
unset GIT_DIFF_OPTS
unset GIT_DIR
62
unset GIT_WORK_TREE
63 64 65
unset GIT_EXTERNAL_DIFF
unset GIT_INDEX_FILE
unset GIT_OBJECT_DIRECTORY
66
unset GIT_CEILING_DIRECTORIES
67 68
unset SHA1_FILE_DIRECTORIES
unset SHA1_FILE_DIRECTORY
69
unset GIT_NOTES_REF
70
unset GIT_NOTES_DISPLAY_REF
71 72
unset GIT_NOTES_REWRITE_REF
unset GIT_NOTES_REWRITE_MODE
73 74
GIT_MERGE_VERBOSITY=5
export GIT_MERGE_VERBOSITY
75 76
export GIT_AUTHOR_EMAIL GIT_AUTHOR_NAME
export GIT_COMMITTER_EMAIL GIT_COMMITTER_NAME
77
export EDITOR
78

79 80 81 82
# Protect ourselves from common misconfiguration to export
# CDPATH into the environment
unset CDPATH

B
Bert Wesarg 已提交
83 84
unset GREP_OPTIONS

85
case $(echo $GIT_TRACE |tr "[A-Z]" "[a-z]") in
86 87 88 89 90 91 92 93
	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

94 95 96 97 98 99
# Convenience
#
# A regexp to match 5 and 40 hexdigits
_x05='[0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f]'
_x40="$_x05$_x05$_x05$_x05$_x05$_x05$_x05$_x05"

100 101 102 103 104 105
# 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
106 107 108 109 110 111 112 113
[ "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
	) &&
114
	color=t
115 116 117 118 119 120

while test "$#" -ne 0
do
	case "$1" in
	-d|--d|--de|--deb|--debu|--debug)
		debug=t; shift ;;
J
Junio C Hamano 已提交
121 122
	-i|--i|--im|--imm|--imme|--immed|--immedi|--immedia|--immediat|--immediate)
		immediate=t; shift ;;
123
	-l|--l|--lo|--lon|--long|--long-|--long-t|--long-te|--long-tes|--long-test|--long-tests)
J
Junio C Hamano 已提交
124
		GIT_TEST_LONG=t; export GIT_TEST_LONG; shift ;;
125
	-h|--h|--he|--hel|--help)
126
		help=t; shift ;;
127 128
	-v|--v|--ve|--ver|--verb|--verbo|--verbos|--verbose)
		verbose=t; shift ;;
129
	-q|--q|--qu|--qui|--quie|--quiet)
130 131 132
		# Ignore --quiet under a TAP::Harness. Saying how many tests
		# passed without the ok/not ok details is always an error.
		test -z "$HARNESS_ACTIVE" && quiet=t; shift ;;
133 134
	--with-dashes)
		with_dashes=t; shift ;;
135
	--no-color)
136
		color=; shift ;;
137
	--va|--val|--valg|--valgr|--valgri|--valgrin|--valgrind)
138
		valgrind=t; verbose=t; shift ;;
139 140
	--tee)
		shift ;; # was handled already
141 142 143
	--root=*)
		root=$(expr "z$1" : 'z[^=]*=\(.*\)')
		shift ;;
144
	*)
145
		echo "error: unknown test option '$1'" >&2; exit 1 ;;
146 147 148
	esac
done

149 150
if test -n "$color"; then
	say_color () {
151 152 153
		(
		TERM=$ORIGINAL_TERM
		export TERM
154 155 156 157 158
		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
159
			*) test -n "$quiet" && return;;
160 161
		esac
		shift
162
		printf "%s" "$*"
163
		tput sgr0
164
		echo
165
		)
166 167 168
	}
else
	say_color() {
169
		test -z "$1" && test -n "$quiet" && return
170
		shift
171
		echo "$*"
172 173 174 175 176
	}
fi

error () {
	say_color error "error: $*"
177
	GIT_EXIT_OK=t
178 179 180 181 182 183 184
	exit 1
}

say () {
	say_color info "$*"
}

185 186 187 188 189 190 191 192 193
test "${test_description}" != "" ||
error "Test script did not set test_description."

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

194
exec 5>&1
195 196 197 198 199 200 201 202 203
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
J
Junio C Hamano 已提交
204 205
test_fixed=0
test_broken=0
206
test_success=0
207

208 209
test_external_has_tap=0

210
die () {
211 212 213 214 215 216 217 218
	code=$?
	if test -n "$GIT_EXIT_OK"
	then
		exit $code
	else
		echo >&5 "FATAL: Unexpected exit with code $code"
		exit 1
	fi
219 220
}

221
GIT_EXIT_OK=
222
trap 'die' EXIT
223

224 225 226 227 228 229 230 231
# 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
232
# that we're using.
233 234 235
test_set_editor () {
	FAKE_EDITOR="$1"
	export FAKE_EDITOR
236 237
	EDITOR='"$FAKE_EDITOR"'
	export EDITOR
238 239
}

240 241 242 243 244 245 246 247 248 249 250
test_decode_color () {
	sed	-e 's/.\[1m/<WHITE>/g' \
		-e 's/.\[31m/<RED>/g' \
		-e 's/.\[32m/<GREEN>/g' \
		-e 's/.\[33m/<YELLOW>/g' \
		-e 's/.\[34m/<BLUE>/g' \
		-e 's/.\[35m/<MAGENTA>/g' \
		-e 's/.\[36m/<CYAN>/g' \
		-e 's/.\[m/<RESET>/g'
}

251 252 253 254 255 256 257 258
q_to_nul () {
	perl -pe 'y/Q/\000/'
}

q_to_cr () {
	tr Q '\015'
}

J
Jonathan Nieder 已提交
259 260 261 262
q_to_tab () {
	tr Q '\011'
}

263 264 265 266 267 268 269 270
append_cr () {
	sed -e 's/$/Q/' | tr Q '\015'
}

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

271 272 273
test_tick () {
	if test -z "${test_tick+set}"
	then
J
Junio C Hamano 已提交
274
		test_tick=1112911993
275 276 277
	else
		test_tick=$(($test_tick + 60))
	fi
J
Junio C Hamano 已提交
278 279
	GIT_COMMITTER_DATE="$test_tick -0700"
	GIT_AUTHOR_DATE="$test_tick -0700"
280 281
	export GIT_COMMITTER_DATE GIT_AUTHOR_DATE
}
282

283 284 285 286 287 288 289 290
# 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 () {
291
	file=${2:-"$1.t"}
292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307
	echo "${3-$1}" > "$file" &&
	git add "$file" &&
	test_tick &&
	git commit -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"
}

308 309 310 311 312 313 314 315 316
# 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=$@"
}

317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333
# 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="$satisfied$1 "
}
satisfied=" "

test_have_prereq () {
334 335 336 337 338
	# prerequisites can be concatenated with ','
	save_IFS=$IFS
	IFS=,
	set -- $*
	IFS=$save_IFS
339 340 341 342 343

	total_prereq=0
	ok_prereq=0
	missing_prereq=

344 345
	for prerequisite
	do
346
		total_prereq=$(($total_prereq + 1))
347 348
		case $satisfied in
		*" $prerequisite "*)
349 350
			ok_prereq=$(($ok_prereq + 1))
			;;
351
		*)
352 353 354 355 356 357 358
			# Keep a list of missing prerequisites
			if test -z "$missing_prereq"
			then
				missing_prereq=$prerequisite
			else
				missing_prereq="$prerequisite,$missing_prereq"
			fi
359 360
		esac
	done
361 362

	test $total_prereq = $ok_prereq
363 364
}

J
Junio C Hamano 已提交
365 366 367 368
# You are not expected to call test_ok_ and test_failure_ directly, use
# the text_expect_* functions instead.

test_ok_ () {
369
	test_success=$(($test_success + 1))
370
	say_color "" "ok $test_count - $@"
371 372
}

J
Junio C Hamano 已提交
373
test_failure_ () {
374
	test_failure=$(($test_failure + 1))
375
	say_color error "not ok - $test_count $1"
376
	shift
377
	echo "$@" | sed -e 's/^/#	/'
378
	test "$immediate" = "" || { GIT_EXIT_OK=t; exit 1; }
J
Junio C Hamano 已提交
379 380
}

J
Junio C Hamano 已提交
381 382
test_known_broken_ok_ () {
	test_fixed=$(($test_fixed+1))
383
	say_color "" "ok $test_count - $@ # TODO known breakage"
J
Junio C Hamano 已提交
384 385 386 387
}

test_known_broken_failure_ () {
	test_broken=$(($test_broken+1))
388
	say_color skip "not ok $test_count - $@ # TODO known breakage"
J
Junio C Hamano 已提交
389
}
J
Junio C Hamano 已提交
390 391

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

395
test_run_ () {
396
	test_cleanup=:
397
	eval >&3 2>&4 "$1"
398
	eval_ret=$?
399
	eval >&3 2>&4 "$test_cleanup"
400 401 402
	if test "$verbose" = "t" && test -n "$HARNESS_ACTIVE"; then
		echo ""
	fi
403 404 405
	return 0
}

406
test_skip () {
407
	test_count=$(($test_count+1))
408 409 410
	to_skip=
	for skp in $GIT_SKIP_TESTS
	do
411
		case $this_test.$test_count in
412 413
		$skp)
			to_skip=t
414
			break
415 416
		esac
	done
417 418 419 420 421
	if test -z "$to_skip" && test -n "$prereq" &&
	   ! test_have_prereq "$prereq"
	then
		to_skip=t
	fi
422 423
	case "$to_skip" in
	t)
424 425 426 427 428 429
		of_prereq=
		if test "$missing_prereq" != "$prereq"
		then
			of_prereq=" of $prereq"
		fi

430
		say_color skip >&3 "skipping test: $@"
431
		say_color skip "ok $test_count # skip $1 (missing $missing_prereq${of_prereq})"
432 433 434 435 436 437 438 439
		: true
		;;
	*)
		false
		;;
	esac
}

440
test_expect_failure () {
441
	test "$#" = 3 && { prereq=$1; shift; } || prereq=
442
	test "$#" = 2 ||
443
	error "bug in the test script: not 2 or 3 parameters to test-expect-failure"
444
	if ! test_skip "$@"
445
	then
J
Junio C Hamano 已提交
446
		say >&3 "checking known breakage: $2"
447
		test_run_ "$2"
J
Junio C Hamano 已提交
448
		if [ "$?" = 0 -a "$eval_ret" = 0 ]
449
		then
J
Junio C Hamano 已提交
450
			test_known_broken_ok_ "$1"
451
		else
452
			test_known_broken_failure_ "$1"
453
		fi
454
	fi
455
	echo >&3 ""
456 457 458
}

test_expect_success () {
459
	test "$#" = 3 && { prereq=$1; shift; } || prereq=
460
	test "$#" = 2 ||
461
	error "bug in the test script: not 2 or 3 parameters to test-expect-success"
462
	if ! test_skip "$@"
463
	then
464 465 466 467 468 469 470 471
		say >&3 "expecting success: $2"
		test_run_ "$2"
		if [ "$?" = 0 -a "$eval_ret" = 0 ]
		then
			test_ok_ "$1"
		else
			test_failure_ "$@"
		fi
472
	fi
473
	echo >&3 ""
474 475
}

476
test_expect_code () {
477
	test "$#" = 4 && { prereq=$1; shift; } || prereq=
478
	test "$#" = 3 ||
479
	error "bug in the test script: not 3 or 4 parameters to test-expect-code"
480
	if ! test_skip "$@"
481
	then
482 483 484 485 486 487 488 489
		say >&3 "expecting exit code $1: $3"
		test_run_ "$3"
		if [ "$?" = 0 -a "$eval_ret" = "$1" ]
		then
			test_ok_ "$2"
		else
			test_failure_ "$@"
		fi
490
	fi
491
	echo >&3 ""
492 493
}

494 495 496
# 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
497
# in non-verbose mode, and announces the external script with "# run
498 499 500 501 502
# <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 () {
503 504 505
	test "$#" = 4 && { prereq=$1; shift; } || prereq=
	test "$#" = 3 ||
	error >&5 "bug in the test script: not 3 or 4 parameters to test_external"
506 507 508 509 510 511
	descr="$1"
	shift
	if ! test_skip "$descr" "$@"
	then
		# Announce the script to reduce confusion about the
		# test output that follows.
512
		say_color "" "# run $test_count: $descr ($*)"
513 514 515
		# 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
516 517 518 519 520 521
		# 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
522 523 524 525 526 527
			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
528
		else
529 530 531 532 533 534
			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
535 536 537 538 539 540 541 542 543 544 545 546 547 548 549
		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
550
	say >&3 "# expecting no stderr from previous command"
551 552
	if [ ! -s "$stderr" ]; then
		rm "$stderr"
553 554 555 556 557 558 559

		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
560 561
	else
		if [ "$verbose" = t ]; then
562
			output=`echo; echo "# Stderr is:"; cat "$stderr"`
563 564 565 566 567
		else
			output=
		fi
		# rm first in case test_failure exits.
		rm "$stderr"
568 569 570 571 572 573
		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
574 575 576
	fi
}

577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608
# 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
}


J
Junio C Hamano 已提交
609 610 611 612 613 614 615 616 617 618 619 620 621 622
# 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 () {
	"$@"
623 624 625 626 627 628 629
	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
630 631 632
	elif test $exit_code = 127; then
		echo >&2 "test_must_fail: command not found: $*"
		return 1
633 634
	fi
	return 0
J
Junio C Hamano 已提交
635 636
}

637 638 639 640 641 642 643 644 645 646 647 648 649
# 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 () {
	"$@"
650 651 652 653
	exit_code=$?
	if test $exit_code -gt 129 -a $exit_code -le 192; then
		echo >&2 "test_might_fail: died by signal: $*"
		return 1
654 655 656
	elif test $exit_code = 127; then
		echo >&2 "test_might_fail: command not found: $*"
		return 1
657 658
	fi
	return 0
659 660
}

661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677
# 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 "$@"
}

678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698
# 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.

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

703
# Most tests can use the created repository, but some may need to create more.
704 705 706 707 708
# 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"
709
	mkdir -p "$repo"
710 711 712 713 714 715
	(
		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
716
}
J
Junio C Hamano 已提交
717

718
test_done () {
719
	GIT_EXIT_OK=t
720

721 722 723 724 725 726 727 728 729 730 731 732
	if test -z "$HARNESS_ACTIVE"; then
		test_results_dir="$TEST_DIRECTORY/test-results"
		mkdir -p "$test_results_dir"
		test_results_path="$test_results_dir/${0%.sh}-$$.counts"

		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
	fi
J
Junio C Hamano 已提交
733 734 735

	if test "$test_fixed" != 0
	then
736
		say_color pass "# fixed $test_fixed known breakage(s)"
J
Junio C Hamano 已提交
737 738 739
	fi
	if test "$test_broken" != 0
	then
740
		say_color error "# still have $test_broken known breakage(s)"
741 742 743
		msg="remaining $(($test_count-$test_broken)) test(s)"
	else
		msg="$test_count test(s)"
J
Junio C Hamano 已提交
744
	fi
745
	case "$test_failure" in
746
	0)
747 748 749
		# Maybe print SKIP message
		[ -z "$skip_all" ] || skip_all=" # SKIP $skip_all"

750 751 752 753
		if test $test_external_has_tap -eq 0; then
			say_color pass "# passed all $msg"
			say "1..$test_count$skip_all"
		fi
J
Johannes Schindelin 已提交
754 755 756 757 758

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

759 760 761
		exit 0 ;;

	*)
762 763 764 765
		if test $test_external_has_tap -eq 0; then
			say_color error "# failed $test_failure among $msg"
			say "1..$test_count"
		fi
766

767 768 769 770 771 772
		exit 1 ;;

	esac
}

# Test the binaries we have just built.  The tests are kept in
773
# t/ subdirectory and are run in 'trash directory' subdirectory.
774 775 776 777 778 779 780
if test -z "$TEST_DIRECTORY"
then
	# We allow tests to override this, in case they want to run tests
	# outside of t/, e.g. for running tests on the test library
	# itself.
	TEST_DIRECTORY=$(pwd)
fi
781 782
GIT_BUILD_DIR="$TEST_DIRECTORY"/..

783
if test -n "$valgrind"
784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808
then
	make_symlink () {
		test -h "$2" &&
		test "$1" = "$(readlink "$2")" || {
			# be super paranoid
			if mkdir "$2".lock
			then
				rm -f "$2" &&
				ln -s "$1" "$2" &&
				rm -r "$2".lock
			else
				while test -d "$2".lock
				do
					say "Waiting for lock on $2."
					sleep 1
				done
			fi
		}
	}

	make_valgrind_symlink () {
		# handle only executables
		test -x "$1" || return

		base=$(basename "$1")
809
		symlink_target=$GIT_BUILD_DIR/$base
810 811 812 813 814 815 816
		# do not override scripts
		if test -x "$symlink_target" &&
		    test ! -d "$symlink_target" &&
		    test "#!" != "$(head -c 2 < "$symlink_target")"
		then
			symlink_target=../valgrind.sh
		fi
817 818 819 820
		case "$base" in
		*.sh|*.perl)
			symlink_target=../unprocessed-script
		esac
821 822 823 824 825 826 827
		# create the link, or replace it if it is out of date
		make_symlink "$symlink_target" "$GIT_VALGRIND/bin/$base" || exit
	}

	# override all git executables in TEST_DIRECTORY/..
	GIT_VALGRIND=$TEST_DIRECTORY/valgrind
	mkdir -p "$GIT_VALGRIND"/bin
828
	for file in $GIT_BUILD_DIR/git* $GIT_BUILD_DIR/test-*
829 830 831
	do
		make_valgrind_symlink $file
	done
832 833 834 835 836 837 838 839 840 841 842
	OLDIFS=$IFS
	IFS=:
	for path in $PATH
	do
		ls "$path"/git-* 2> /dev/null |
		while read file
		do
			make_valgrind_symlink "$file"
		done
	done
	IFS=$OLDIFS
843 844 845
	PATH=$GIT_VALGRIND/bin:$PATH
	GIT_EXEC_PATH=$GIT_VALGRIND/bin
	export GIT_VALGRIND
846 847 848
elif test -n "$GIT_TEST_INSTALLED" ; then
	GIT_EXEC_PATH=$($GIT_TEST_INSTALLED/git --exec-path)  ||
	error "Cannot run git from $GIT_TEST_INSTALLED."
849
	PATH=$GIT_TEST_INSTALLED:$GIT_BUILD_DIR:$PATH
850 851
	GIT_EXEC_PATH=${GIT_TEST_EXEC_PATH:-$GIT_EXEC_PATH}
else # normal case, use ../bin-wrappers only unless $with_dashes:
852
	git_bin_dir="$GIT_BUILD_DIR/bin-wrappers"
853 854 855 856 857 858 859
	if ! test -x "$git_bin_dir/git" ; then
		if test -z "$with_dashes" ; then
			say "$git_bin_dir/git is not executable; using GIT_EXEC_PATH"
		fi
		with_dashes=t
	fi
	PATH="$git_bin_dir:$PATH"
860
	GIT_EXEC_PATH=$GIT_BUILD_DIR
861
	if test -n "$with_dashes" ; then
862
		PATH="$GIT_BUILD_DIR:$PATH"
863
	fi
864
fi
865
GIT_TEMPLATE_DIR="$GIT_BUILD_DIR"/templates/blt
J
Jeff King 已提交
866 867 868 869
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
870

871
. "$GIT_BUILD_DIR"/GIT-BUILD-OPTIONS
J
Jeff King 已提交
872

873 874 875 876 877 878 879 880 881 882
if test -z "$GIT_TEST_CMP"
then
	if test -n "$GIT_TEST_CMP_USE_COPIED_CONTEXT"
	then
		GIT_TEST_CMP="$DIFF -c"
	else
		GIT_TEST_CMP="$DIFF -u"
	fi
fi

883
GITPERLLIB="$GIT_BUILD_DIR"/perl/blib/lib:"$GIT_BUILD_DIR"/perl/blib/arch/auto/Git
884
export GITPERLLIB
885
test -d "$GIT_BUILD_DIR"/templates/blt || {
886 887
	error "You haven't built things yet, have you?"
}
888

J
Jeff King 已提交
889
if test -z "$GIT_TEST_INSTALLED" && test -z "$NO_PYTHON"
890
then
891
	GITPYTHONLIB="$GIT_BUILD_DIR/git_remote_helpers/build/lib"
892
	export GITPYTHONLIB
893
	test -d "$GIT_BUILD_DIR"/git_remote_helpers/build || {
894 895 896 897
		error "You haven't built git_remote_helpers yet, have you?"
	}
fi

898
if ! test -x "$GIT_BUILD_DIR"/test-chmtime; then
E
Eric Wong 已提交
899 900 901 902 903
	echo >&2 'You need to build test-chmtime:'
	echo >&2 'Run "make test-chmtime" in the source (toplevel) directory'
	exit 1
fi

904
# Test repository
J
Johannes Schindelin 已提交
905
test="trash directory.$(basename "$0" .sh)"
906 907 908 909 910
test -n "$root" && test="$root/$test"
case "$test" in
/*) TRASH_DIRECTORY="$test" ;;
 *) TRASH_DIRECTORY="$TEST_DIRECTORY/$test" ;;
esac
911
test ! -z "$debug" || remove_trash=$TRASH_DIRECTORY
912
rm -fr "$test" || {
913
	GIT_EXIT_OK=t
914 915 916 917
	echo >&5 "FATAL: Cannot prepare test area"
	exit 1
}

918
test_create_repo "$test"
919 920 921
# 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
922

923 924 925
HOME=$(pwd)
export HOME

926 927
this_test=${0##*/}
this_test=${this_test%%-*}
928 929
for skp in $GIT_SKIP_TESTS
do
930 931
	case "$this_test" in
	$skp)
932
		say_color skip >&3 "skipping test $this_test altogether"
933
		skip_all="skip all tests in $this_test"
934 935 936
		test_done
	esac
done
937

938 939 940 941 942 943 944 945 946 947 948 949 950 951 952
# Provide an implementation of the 'yes' utility
yes () {
	if test $# = 0
	then
		y=y
	else
		y="$*"
	fi

	while echo "$y"
	do
		:
	done
}

953 954 955 956 957 958 959 960 961 962
# Fix some commands on Windows
case $(uname -s) in
*MINGW*)
	# Windows has its own (incompatible) sort and find
	sort () {
		/usr/bin/sort "$@"
	}
	find () {
		/usr/bin/find "$@"
	}
963 964 965
	sum () {
		md5sum "$@"
	}
966 967 968 969
	# git sees Windows-style pwd
	pwd () {
		builtin pwd -W
	}
970
	# no POSIX permissions
971
	# backslashes in pathspec are converted to '/'
972
	# exec does not inherit the PID
973 974 975
	;;
*)
	test_set_prereq POSIXPERM
976
	test_set_prereq BSLASHPSPEC
977
	test_set_prereq EXECKEEPSPID
978 979
	;;
esac
980

981
test -z "$NO_PERL" && test_set_prereq PERL
982
test -z "$NO_PYTHON" && test_set_prereq PYTHON
983

984 985 986
# test whether the filesystem supports symbolic links
ln -s x y 2>/dev/null && test -h y 2>/dev/null && test_set_prereq SYMLINKS
rm -f y
987 988 989 990

# When the tests are run as root, permission tests will report that
# things are writable when they shouldn't be.
test -w / || test_set_prereq SANITY