submodule--helper: advise on fatal alternate error
[git.git] / t / test-lib-functions.sh
blobb299ecc3265357bfb38e2131854b02868b5e9e0e
1 # Library of functions shared by all tests scripts, included by
2 # test-lib.sh.
4 # Copyright (c) 2005 Junio C Hamano
6 # This program is free software: you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation, either version 2 of the License, or
9 # (at your option) any later version.
11 # This program is distributed in the hope that it will be useful,
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 # GNU General Public License for more details.
16 # You should have received a copy of the GNU General Public License
17 # along with this program. If not, see http://www.gnu.org/licenses/ .
19 # The semantics of the editor variables are that of invoking
20 # sh -c "$EDITOR \"$@\"" files ...
22 # If our trash directory contains shell metacharacters, they will be
23 # interpreted if we just set $EDITOR directly, so do a little dance with
24 # environment variables to work around this.
26 # In particular, quoting isn't enough, as the path may contain the same quote
27 # that we're using.
28 test_set_editor () {
29 FAKE_EDITOR="$1"
30 export FAKE_EDITOR
31 EDITOR='"$FAKE_EDITOR"'
32 export EDITOR
35 test_set_index_version () {
36 GIT_INDEX_VERSION="$1"
37 export GIT_INDEX_VERSION
40 test_decode_color () {
41 awk '
42 function name(n) {
43 if (n == 0) return "RESET";
44 if (n == 1) return "BOLD";
45 if (n == 2) return "FAINT";
46 if (n == 3) return "ITALIC";
47 if (n == 7) return "REVERSE";
48 if (n == 30) return "BLACK";
49 if (n == 31) return "RED";
50 if (n == 32) return "GREEN";
51 if (n == 33) return "YELLOW";
52 if (n == 34) return "BLUE";
53 if (n == 35) return "MAGENTA";
54 if (n == 36) return "CYAN";
55 if (n == 37) return "WHITE";
56 if (n == 40) return "BLACK";
57 if (n == 41) return "BRED";
58 if (n == 42) return "BGREEN";
59 if (n == 43) return "BYELLOW";
60 if (n == 44) return "BBLUE";
61 if (n == 45) return "BMAGENTA";
62 if (n == 46) return "BCYAN";
63 if (n == 47) return "BWHITE";
66 while (match($0, /\033\[[0-9;]*m/) != 0) {
67 printf "%s<", substr($0, 1, RSTART-1);
68 codes = substr($0, RSTART+2, RLENGTH-3);
69 if (length(codes) == 0)
70 printf "%s", name(0)
71 else {
72 n = split(codes, ary, ";");
73 sep = "";
74 for (i = 1; i <= n; i++) {
75 printf "%s%s", sep, name(ary[i]);
76 sep = ";"
79 printf ">";
80 $0 = substr($0, RSTART + RLENGTH, length($0) - RSTART - RLENGTH + 1);
82 print
87 lf_to_nul () {
88 perl -pe 'y/\012/\000/'
91 nul_to_q () {
92 perl -pe 'y/\000/Q/'
95 q_to_nul () {
96 perl -pe 'y/Q/\000/'
99 q_to_cr () {
100 tr Q '\015'
103 q_to_tab () {
104 tr Q '\011'
107 qz_to_tab_space () {
108 tr QZ '\011\040'
111 append_cr () {
112 sed -e 's/$/Q/' | tr Q '\015'
115 remove_cr () {
116 tr '\015' Q | sed -e 's/Q$//'
119 # Generate an output of $1 bytes of all zeroes (NULs, not ASCII zeroes).
120 # If $1 is 'infinity', output forever or until the receiving pipe stops reading,
121 # whichever comes first.
122 generate_zero_bytes () {
123 test-tool genzeros "$@"
126 # In some bourne shell implementations, the "unset" builtin returns
127 # nonzero status when a variable to be unset was not set in the first
128 # place.
130 # Use sane_unset when that should not be considered an error.
132 sane_unset () {
133 unset "$@"
134 return 0
137 test_tick () {
138 if test -z "${test_tick+set}"
139 then
140 test_tick=1112911993
141 else
142 test_tick=$(($test_tick + 60))
144 GIT_COMMITTER_DATE="$test_tick -0700"
145 GIT_AUTHOR_DATE="$test_tick -0700"
146 export GIT_COMMITTER_DATE GIT_AUTHOR_DATE
149 # Stop execution and start a shell. This is useful for debugging tests.
151 # Be sure to remove all invocations of this command before submitting.
153 test_pause () {
154 "$SHELL_PATH" <&6 >&5 2>&7
157 # Wrap git with a debugger. Adding this to a command can make it easier
158 # to understand what is going on in a failing test.
160 # Examples:
161 # debug git checkout master
162 # debug --debugger=nemiver git $ARGS
163 # debug -d "valgrind --tool=memcheck --track-origins=yes" git $ARGS
164 debug () {
165 case "$1" in
167 GIT_DEBUGGER="$2" &&
168 shift 2
170 --debugger=*)
171 GIT_DEBUGGER="${1#*=}" &&
172 shift 1
175 GIT_DEBUGGER=1
177 esac &&
178 GIT_DEBUGGER="${GIT_DEBUGGER}" "$@" <&6 >&5 2>&7
181 # Call test_commit with the arguments
182 # [-C <directory>] <message> [<file> [<contents> [<tag>]]]"
184 # This will commit a file with the given contents and the given commit
185 # message, and tag the resulting commit with the given tag name.
187 # <file>, <contents>, and <tag> all default to <message>.
189 # If the first argument is "-C", the second argument is used as a path for
190 # the git invocations.
192 test_commit () {
193 notick= &&
194 signoff= &&
195 indir= &&
196 while test $# != 0
198 case "$1" in
199 --notick)
200 notick=yes
202 --signoff)
203 signoff="$1"
206 indir="$2"
207 shift
210 break
212 esac
213 shift
214 done &&
215 indir=${indir:+"$indir"/} &&
216 file=${2:-"$1.t"} &&
217 echo "${3-$1}" > "$indir$file" &&
218 git ${indir:+ -C "$indir"} add "$file" &&
219 if test -z "$notick"
220 then
221 test_tick
222 fi &&
223 git ${indir:+ -C "$indir"} commit $signoff -m "$1" &&
224 git ${indir:+ -C "$indir"} tag "${4:-$1}"
227 # Call test_merge with the arguments "<message> <commit>", where <commit>
228 # can be a tag pointing to the commit-to-merge.
230 test_merge () {
231 label="$1" &&
232 shift &&
233 test_tick &&
234 git merge -m "$label" "$@" &&
235 git tag "$label"
238 # Efficiently create <nr> commits, each with a unique number (from 1 to <nr>
239 # by default) in the commit message.
241 # Usage: test_commit_bulk [options] <nr>
242 # -C <dir>:
243 # Run all git commands in directory <dir>
244 # --ref=<n>:
245 # ref on which to create commits (default: HEAD)
246 # --start=<n>:
247 # number commit messages from <n> (default: 1)
248 # --message=<msg>:
249 # use <msg> as the commit mesasge (default: "commit %s")
250 # --filename=<fn>:
251 # modify <fn> in each commit (default: %s.t)
252 # --contents=<string>:
253 # place <string> in each file (default: "content %s")
254 # --id=<string>:
255 # shorthand to use <string> and %s in message, filename, and contents
257 # The message, filename, and contents strings are evaluated by printf, with the
258 # first "%s" replaced by the current commit number. So you can do:
260 # test_commit_bulk --filename=file --contents="modification %s"
262 # to have every commit touch the same file, but with unique content.
264 test_commit_bulk () {
265 tmpfile=.bulk-commit.input
266 indir=.
267 ref=HEAD
269 message='commit %s'
270 filename='%s.t'
271 contents='content %s'
272 while test $# -gt 0
274 case "$1" in
276 indir=$2
277 shift
279 --ref=*)
280 ref=${1#--*=}
282 --start=*)
283 n=${1#--*=}
285 --message=*)
286 message=${1#--*=}
288 --filename=*)
289 filename=${1#--*=}
291 --contents=*)
292 contents=${1#--*=}
294 --id=*)
295 message="${1#--*=} %s"
296 filename="${1#--*=}-%s.t"
297 contents="${1#--*=} %s"
300 BUG "invalid test_commit_bulk option: $1"
303 break
305 esac
306 shift
307 done
308 total=$1
310 add_from=
311 if git -C "$indir" rev-parse --verify "$ref"
312 then
313 add_from=t
316 while test "$total" -gt 0
318 test_tick &&
319 echo "commit $ref"
320 printf 'author %s <%s> %s\n' \
321 "$GIT_AUTHOR_NAME" \
322 "$GIT_AUTHOR_EMAIL" \
323 "$GIT_AUTHOR_DATE"
324 printf 'committer %s <%s> %s\n' \
325 "$GIT_COMMITTER_NAME" \
326 "$GIT_COMMITTER_EMAIL" \
327 "$GIT_COMMITTER_DATE"
328 echo "data <<EOF"
329 printf "$message\n" $n
330 echo "EOF"
331 if test -n "$add_from"
332 then
333 echo "from $ref^0"
334 add_from=
336 printf "M 644 inline $filename\n" $n
337 echo "data <<EOF"
338 printf "$contents\n" $n
339 echo "EOF"
340 echo
341 n=$((n + 1))
342 total=$((total - 1))
343 done >"$tmpfile"
345 git -C "$indir" \
346 -c fastimport.unpacklimit=0 \
347 fast-import <"$tmpfile" || return 1
349 # This will be left in place on failure, which may aid debugging.
350 rm -f "$tmpfile"
352 # If we updated HEAD, then be nice and update the index and working
353 # tree, too.
354 if test "$ref" = "HEAD"
355 then
356 git -C "$indir" checkout -f HEAD || return 1
361 # This function helps systems where core.filemode=false is set.
362 # Use it instead of plain 'chmod +x' to set or unset the executable bit
363 # of a file in the working directory and add it to the index.
365 test_chmod () {
366 chmod "$@" &&
367 git update-index --add "--chmod=$@"
370 # Get the modebits from a file.
371 test_modebits () {
372 ls -l "$1" | sed -e 's|^\(..........\).*|\1|'
375 # Unset a configuration variable, but don't fail if it doesn't exist.
376 test_unconfig () {
377 config_dir=
378 if test "$1" = -C
379 then
380 shift
381 config_dir=$1
382 shift
384 git ${config_dir:+-C "$config_dir"} config --unset-all "$@"
385 config_status=$?
386 case "$config_status" in
387 5) # ok, nothing to unset
388 config_status=0
390 esac
391 return $config_status
394 # Set git config, automatically unsetting it after the test is over.
395 test_config () {
396 config_dir=
397 if test "$1" = -C
398 then
399 shift
400 config_dir=$1
401 shift
403 test_when_finished "test_unconfig ${config_dir:+-C '$config_dir'} '$1'" &&
404 git ${config_dir:+-C "$config_dir"} config "$@"
407 test_config_global () {
408 test_when_finished "test_unconfig --global '$1'" &&
409 git config --global "$@"
412 write_script () {
414 echo "#!${2-"$SHELL_PATH"}" &&
416 } >"$1" &&
417 chmod +x "$1"
420 # Use test_set_prereq to tell that a particular prerequisite is available.
421 # The prerequisite can later be checked for in two ways:
423 # - Explicitly using test_have_prereq.
425 # - Implicitly by specifying the prerequisite tag in the calls to
426 # test_expect_{success,failure,code}.
428 # The single parameter is the prerequisite tag (a simple word, in all
429 # capital letters by convention).
431 test_unset_prereq () {
432 ! test_have_prereq "$1" ||
433 satisfied_prereq="${satisfied_prereq% $1 *} ${satisfied_prereq#* $1 }"
436 test_set_prereq () {
437 if test -n "$GIT_TEST_FAIL_PREREQS_INTERNAL"
438 then
439 case "$1" in
440 # The "!" case is handled below with
441 # test_unset_prereq()
444 # (Temporary?) whitelist of things we can't easily
445 # pretend not to support
446 SYMLINKS)
448 # Inspecting whether GIT_TEST_FAIL_PREREQS is on
449 # should be unaffected.
450 FAIL_PREREQS)
453 return
454 esac
457 case "$1" in
459 test_unset_prereq "${1#!}"
462 satisfied_prereq="$satisfied_prereq$1 "
464 esac
466 satisfied_prereq=" "
467 lazily_testable_prereq= lazily_tested_prereq=
469 # Usage: test_lazy_prereq PREREQ 'script'
470 test_lazy_prereq () {
471 lazily_testable_prereq="$lazily_testable_prereq$1 "
472 eval test_prereq_lazily_$1=\$2
475 test_run_lazy_prereq_ () {
476 script='
477 mkdir -p "$TRASH_DIRECTORY/prereq-test-dir" &&
479 cd "$TRASH_DIRECTORY/prereq-test-dir" &&'"$2"'
481 say >&3 "checking prerequisite: $1"
482 say >&3 "$script"
483 test_eval_ "$script"
484 eval_ret=$?
485 rm -rf "$TRASH_DIRECTORY/prereq-test-dir"
486 if test "$eval_ret" = 0; then
487 say >&3 "prerequisite $1 ok"
488 else
489 say >&3 "prerequisite $1 not satisfied"
491 return $eval_ret
494 test_have_prereq () {
495 # prerequisites can be concatenated with ','
496 save_IFS=$IFS
497 IFS=,
498 set -- $*
499 IFS=$save_IFS
501 total_prereq=0
502 ok_prereq=0
503 missing_prereq=
505 for prerequisite
507 case "$prerequisite" in
509 negative_prereq=t
510 prerequisite=${prerequisite#!}
513 negative_prereq=
514 esac
516 case " $lazily_tested_prereq " in
517 *" $prerequisite "*)
520 case " $lazily_testable_prereq " in
521 *" $prerequisite "*)
522 eval "script=\$test_prereq_lazily_$prerequisite" &&
523 if test_run_lazy_prereq_ "$prerequisite" "$script"
524 then
525 test_set_prereq $prerequisite
527 lazily_tested_prereq="$lazily_tested_prereq$prerequisite "
528 esac
530 esac
532 total_prereq=$(($total_prereq + 1))
533 case "$satisfied_prereq" in
534 *" $prerequisite "*)
535 satisfied_this_prereq=t
538 satisfied_this_prereq=
539 esac
541 case "$satisfied_this_prereq,$negative_prereq" in
542 t,|,t)
543 ok_prereq=$(($ok_prereq + 1))
546 # Keep a list of missing prerequisites; restore
547 # the negative marker if necessary.
548 prerequisite=${negative_prereq:+!}$prerequisite
549 if test -z "$missing_prereq"
550 then
551 missing_prereq=$prerequisite
552 else
553 missing_prereq="$prerequisite,$missing_prereq"
555 esac
556 done
558 test $total_prereq = $ok_prereq
561 test_declared_prereq () {
562 case ",$test_prereq," in
563 *,$1,*)
564 return 0
566 esac
567 return 1
570 test_verify_prereq () {
571 test -z "$test_prereq" ||
572 expr >/dev/null "$test_prereq" : '[A-Z0-9_,!]*$' ||
573 BUG "'$test_prereq' does not look like a prereq"
576 test_expect_failure () {
577 test_start_
578 test "$#" = 3 && { test_prereq=$1; shift; } || test_prereq=
579 test "$#" = 2 ||
580 BUG "not 2 or 3 parameters to test-expect-failure"
581 test_verify_prereq
582 export test_prereq
583 if ! test_skip "$@"
584 then
585 say >&3 "checking known breakage of $TEST_NUMBER.$test_count '$1': $2"
586 if test_run_ "$2" expecting_failure
587 then
588 test_known_broken_ok_ "$1"
589 else
590 test_known_broken_failure_ "$1"
593 test_finish_
596 test_expect_success () {
597 test_start_
598 test "$#" = 3 && { test_prereq=$1; shift; } || test_prereq=
599 test "$#" = 2 ||
600 BUG "not 2 or 3 parameters to test-expect-success"
601 test_verify_prereq
602 export test_prereq
603 if ! test_skip "$@"
604 then
605 say >&3 "expecting success of $TEST_NUMBER.$test_count '$1': $2"
606 if test_run_ "$2"
607 then
608 test_ok_ "$1"
609 else
610 test_failure_ "$@"
613 test_finish_
616 # test_external runs external test scripts that provide continuous
617 # test output about their progress, and succeeds/fails on
618 # zero/non-zero exit code. It outputs the test output on stdout even
619 # in non-verbose mode, and announces the external script with "# run
620 # <n>: ..." before running it. When providing relative paths, keep in
621 # mind that all scripts run in "trash directory".
622 # Usage: test_external description command arguments...
623 # Example: test_external 'Perl API' perl ../path/to/test.pl
624 test_external () {
625 test "$#" = 4 && { test_prereq=$1; shift; } || test_prereq=
626 test "$#" = 3 ||
627 BUG "not 3 or 4 parameters to test_external"
628 descr="$1"
629 shift
630 test_verify_prereq
631 export test_prereq
632 if ! test_skip "$descr" "$@"
633 then
634 # Announce the script to reduce confusion about the
635 # test output that follows.
636 say_color "" "# run $test_count: $descr ($*)"
637 # Export TEST_DIRECTORY, TRASH_DIRECTORY and GIT_TEST_LONG
638 # to be able to use them in script
639 export TEST_DIRECTORY TRASH_DIRECTORY GIT_TEST_LONG
640 # Run command; redirect its stderr to &4 as in
641 # test_run_, but keep its stdout on our stdout even in
642 # non-verbose mode.
643 "$@" 2>&4
644 if test "$?" = 0
645 then
646 if test $test_external_has_tap -eq 0; then
647 test_ok_ "$descr"
648 else
649 say_color "" "# test_external test $descr was ok"
650 test_success=$(($test_success + 1))
652 else
653 if test $test_external_has_tap -eq 0; then
654 test_failure_ "$descr" "$@"
655 else
656 say_color error "# test_external test $descr failed: $@"
657 test_failure=$(($test_failure + 1))
663 # Like test_external, but in addition tests that the command generated
664 # no output on stderr.
665 test_external_without_stderr () {
666 # The temporary file has no (and must have no) security
667 # implications.
668 tmp=${TMPDIR:-/tmp}
669 stderr="$tmp/git-external-stderr.$$.tmp"
670 test_external "$@" 4> "$stderr"
671 test -f "$stderr" || error "Internal error: $stderr disappeared."
672 descr="no stderr: $1"
673 shift
674 say >&3 "# expecting no stderr from previous command"
675 if test ! -s "$stderr"
676 then
677 rm "$stderr"
679 if test $test_external_has_tap -eq 0; then
680 test_ok_ "$descr"
681 else
682 say_color "" "# test_external_without_stderr test $descr was ok"
683 test_success=$(($test_success + 1))
685 else
686 if test "$verbose" = t
687 then
688 output=$(echo; echo "# Stderr is:"; cat "$stderr")
689 else
690 output=
692 # rm first in case test_failure exits.
693 rm "$stderr"
694 if test $test_external_has_tap -eq 0; then
695 test_failure_ "$descr" "$@" "$output"
696 else
697 say_color error "# test_external_without_stderr test $descr failed: $@: $output"
698 test_failure=$(($test_failure + 1))
703 # debugging-friendly alternatives to "test [-f|-d|-e]"
704 # The commands test the existence or non-existence of $1. $2 can be
705 # given to provide a more precise diagnosis.
706 test_path_is_file () {
707 if ! test -f "$1"
708 then
709 echo "File $1 doesn't exist. $2"
710 false
714 test_path_is_dir () {
715 if ! test -d "$1"
716 then
717 echo "Directory $1 doesn't exist. $2"
718 false
722 test_path_exists () {
723 if ! test -e "$1"
724 then
725 echo "Path $1 doesn't exist. $2"
726 false
730 # Check if the directory exists and is empty as expected, barf otherwise.
731 test_dir_is_empty () {
732 test_path_is_dir "$1" &&
733 if test -n "$(ls -a1 "$1" | egrep -v '^\.\.?$')"
734 then
735 echo "Directory '$1' is not empty, it contains:"
736 ls -la "$1"
737 return 1
741 # Check if the file exists and has a size greater than zero
742 test_file_not_empty () {
743 if ! test -s "$1"
744 then
745 echo "'$1' is not a non-empty file."
746 false
750 test_path_is_missing () {
751 if test -e "$1"
752 then
753 echo "Path exists:"
754 ls -ld "$1"
755 if test $# -ge 1
756 then
757 echo "$*"
759 false
763 # test_line_count checks that a file has the number of lines it
764 # ought to. For example:
766 # test_expect_success 'produce exactly one line of output' '
767 # do something >output &&
768 # test_line_count = 1 output
771 # is like "test $(wc -l <output) = 1" except that it passes the
772 # output through when the number of lines is wrong.
774 test_line_count () {
775 if test $# != 3
776 then
777 BUG "not 3 parameters to test_line_count"
778 elif ! test $(wc -l <"$3") "$1" "$2"
779 then
780 echo "test_line_count: line count for $3 !$1 $2"
781 cat "$3"
782 return 1
786 # Returns success if a comma separated string of keywords ($1) contains a
787 # given keyword ($2).
788 # Examples:
789 # `list_contains "foo,bar" bar` returns 0
790 # `list_contains "foo" bar` returns 1
792 list_contains () {
793 case ",$1," in
794 *,$2,*)
795 return 0
797 esac
798 return 1
801 # This is not among top-level (test_expect_success | test_expect_failure)
802 # but is a prefix that can be used in the test script, like:
804 # test_expect_success 'complain and die' '
805 # do something &&
806 # do something else &&
807 # test_must_fail git checkout ../outerspace
810 # Writing this as "! git checkout ../outerspace" is wrong, because
811 # the failure could be due to a segv. We want a controlled failure.
813 # Accepts the following options:
815 # ok=<signal-name>[,<...>]:
816 # Don't treat an exit caused by the given signal as error.
817 # Multiple signals can be specified as a comma separated list.
818 # Currently recognized signal names are: sigpipe, success.
819 # (Don't use 'success', use 'test_might_fail' instead.)
821 test_must_fail () {
822 case "$1" in
823 ok=*)
824 _test_ok=${1#ok=}
825 shift
828 _test_ok=
830 esac
831 "$@" 2>&7
832 exit_code=$?
833 if test $exit_code -eq 0 && ! list_contains "$_test_ok" success
834 then
835 echo >&4 "test_must_fail: command succeeded: $*"
836 return 1
837 elif test_match_signal 13 $exit_code && list_contains "$_test_ok" sigpipe
838 then
839 return 0
840 elif test $exit_code -gt 129 && test $exit_code -le 192
841 then
842 echo >&4 "test_must_fail: died by signal $(($exit_code - 128)): $*"
843 return 1
844 elif test $exit_code -eq 127
845 then
846 echo >&4 "test_must_fail: command not found: $*"
847 return 1
848 elif test $exit_code -eq 126
849 then
850 echo >&4 "test_must_fail: valgrind error: $*"
851 return 1
853 return 0
854 } 7>&2 2>&4
856 # Similar to test_must_fail, but tolerates success, too. This is
857 # meant to be used in contexts like:
859 # test_expect_success 'some command works without configuration' '
860 # test_might_fail git config --unset all.configuration &&
861 # do something
864 # Writing "git config --unset all.configuration || :" would be wrong,
865 # because we want to notice if it fails due to segv.
867 # Accepts the same options as test_must_fail.
869 test_might_fail () {
870 test_must_fail ok=success "$@" 2>&7
871 } 7>&2 2>&4
873 # Similar to test_must_fail and test_might_fail, but check that a
874 # given command exited with a given exit code. Meant to be used as:
876 # test_expect_success 'Merge with d/f conflicts' '
877 # test_expect_code 1 git merge "merge msg" B master
880 test_expect_code () {
881 want_code=$1
882 shift
883 "$@" 2>&7
884 exit_code=$?
885 if test $exit_code = $want_code
886 then
887 return 0
890 echo >&4 "test_expect_code: command exited with $exit_code, we wanted $want_code $*"
891 return 1
892 } 7>&2 2>&4
894 # test_cmp is a helper function to compare actual and expected output.
895 # You can use it like:
897 # test_expect_success 'foo works' '
898 # echo expected >expected &&
899 # foo >actual &&
900 # test_cmp expected actual
903 # This could be written as either "cmp" or "diff -u", but:
904 # - cmp's output is not nearly as easy to read as diff -u
905 # - not all diff versions understand "-u"
907 test_cmp() {
908 $GIT_TEST_CMP "$@"
911 # Check that the given config key has the expected value.
913 # test_cmp_config [-C <dir>] <expected-value>
914 # [<git-config-options>...] <config-key>
916 # for example to check that the value of core.bar is foo
918 # test_cmp_config foo core.bar
920 test_cmp_config() {
921 local GD &&
922 if test "$1" = "-C"
923 then
924 shift &&
925 GD="-C $1" &&
926 shift
927 fi &&
928 printf "%s\n" "$1" >expect.config &&
929 shift &&
930 git $GD config "$@" >actual.config &&
931 test_cmp expect.config actual.config
934 # test_cmp_bin - helper to compare binary files
936 test_cmp_bin() {
937 cmp "$@"
940 # Use this instead of test_cmp to compare files that contain expected and
941 # actual output from git commands that can be translated. When running
942 # under GIT_TEST_GETTEXT_POISON this pretends that the command produced expected
943 # results.
944 test_i18ncmp () {
945 ! test_have_prereq C_LOCALE_OUTPUT || test_cmp "$@"
948 # Use this instead of "grep expected-string actual" to see if the
949 # output from a git command that can be translated either contains an
950 # expected string, or does not contain an unwanted one. When running
951 # under GIT_TEST_GETTEXT_POISON this pretends that the command produced expected
952 # results.
953 test_i18ngrep () {
954 eval "last_arg=\${$#}"
956 test -f "$last_arg" ||
957 BUG "test_i18ngrep requires a file to read as the last parameter"
959 if test $# -lt 2 ||
960 { test "x!" = "x$1" && test $# -lt 3 ; }
961 then
962 BUG "too few parameters to test_i18ngrep"
965 if test_have_prereq !C_LOCALE_OUTPUT
966 then
967 # pretend success
968 return 0
971 if test "x!" = "x$1"
972 then
973 shift
974 ! grep "$@" && return 0
976 echo >&4 "error: '! grep $@' did find a match in:"
977 else
978 grep "$@" && return 0
980 echo >&4 "error: 'grep $@' didn't find a match in:"
983 if test -s "$last_arg"
984 then
985 cat >&4 "$last_arg"
986 else
987 echo >&4 "<File '$last_arg' is empty>"
990 return 1
993 # Call any command "$@" but be more verbose about its
994 # failure. This is handy for commands like "test" which do
995 # not output anything when they fail.
996 verbose () {
997 "$@" && return 0
998 echo >&4 "command failed: $(git rev-parse --sq-quote "$@")"
999 return 1
1002 # Check if the file expected to be empty is indeed empty, and barfs
1003 # otherwise.
1005 test_must_be_empty () {
1006 test_path_is_file "$1" &&
1007 if test -s "$1"
1008 then
1009 echo "'$1' is not empty, it contains:"
1010 cat "$1"
1011 return 1
1015 # Tests that its two parameters refer to the same revision
1016 test_cmp_rev () {
1017 if test $# != 2
1018 then
1019 error "bug in the test script: test_cmp_rev requires two revisions, but got $#"
1020 else
1021 local r1 r2
1022 r1=$(git rev-parse --verify "$1") &&
1023 r2=$(git rev-parse --verify "$2") &&
1024 if test "$r1" != "$r2"
1025 then
1026 cat >&4 <<-EOF
1027 error: two revisions point to different objects:
1028 '$1': $r1
1029 '$2': $r2
1031 return 1
1036 # Compare paths respecting core.ignoreCase
1037 test_cmp_fspath () {
1038 if test "x$1" = "x$2"
1039 then
1040 return 0
1043 if test true != "$(git config --get --type=bool core.ignorecase)"
1044 then
1045 return 1
1048 test "x$(echo "$1" | tr A-Z a-z)" = "x$(echo "$2" | tr A-Z a-z)"
1051 # Print a sequence of integers in increasing order, either with
1052 # two arguments (start and end):
1054 # test_seq 1 5 -- outputs 1 2 3 4 5 one line at a time
1056 # or with one argument (end), in which case it starts counting
1057 # from 1.
1059 test_seq () {
1060 case $# in
1061 1) set 1 "$@" ;;
1062 2) ;;
1063 *) BUG "not 1 or 2 parameters to test_seq" ;;
1064 esac
1065 test_seq_counter__=$1
1066 while test "$test_seq_counter__" -le "$2"
1068 echo "$test_seq_counter__"
1069 test_seq_counter__=$(( $test_seq_counter__ + 1 ))
1070 done
1073 # This function can be used to schedule some commands to be run
1074 # unconditionally at the end of the test to restore sanity:
1076 # test_expect_success 'test core.capslock' '
1077 # git config core.capslock true &&
1078 # test_when_finished "git config --unset core.capslock" &&
1079 # hello world
1082 # That would be roughly equivalent to
1084 # test_expect_success 'test core.capslock' '
1085 # git config core.capslock true &&
1086 # hello world
1087 # git config --unset core.capslock
1090 # except that the greeting and config --unset must both succeed for
1091 # the test to pass.
1093 # Note that under --immediate mode, no clean-up is done to help diagnose
1094 # what went wrong.
1096 test_when_finished () {
1097 # We cannot detect when we are in a subshell in general, but by
1098 # doing so on Bash is better than nothing (the test will
1099 # silently pass on other shells).
1100 test "${BASH_SUBSHELL-0}" = 0 ||
1101 BUG "test_when_finished does nothing in a subshell"
1102 test_cleanup="{ $*
1103 } && (exit \"\$eval_ret\"); eval_ret=\$?; $test_cleanup"
1106 # This function can be used to schedule some commands to be run
1107 # unconditionally at the end of the test script, e.g. to stop a daemon:
1109 # test_expect_success 'test git daemon' '
1110 # git daemon &
1111 # daemon_pid=$! &&
1112 # test_atexit 'kill $daemon_pid' &&
1113 # hello world
1116 # The commands will be executed before the trash directory is removed,
1117 # i.e. the atexit commands will still be able to access any pidfiles or
1118 # socket files.
1120 # Note that these commands will be run even when a test script run
1121 # with '--immediate' fails. Be careful with your atexit commands to
1122 # minimize any changes to the failed state.
1124 test_atexit () {
1125 # We cannot detect when we are in a subshell in general, but by
1126 # doing so on Bash is better than nothing (the test will
1127 # silently pass on other shells).
1128 test "${BASH_SUBSHELL-0}" = 0 ||
1129 error "bug in test script: test_atexit does nothing in a subshell"
1130 test_atexit_cleanup="{ $*
1131 } && (exit \"\$eval_ret\"); eval_ret=\$?; $test_atexit_cleanup"
1134 # Most tests can use the created repository, but some may need to create more.
1135 # Usage: test_create_repo <directory>
1136 test_create_repo () {
1137 test "$#" = 1 ||
1138 BUG "not 1 parameter to test-create-repo"
1139 repo="$1"
1140 mkdir -p "$repo"
1142 cd "$repo" || error "Cannot setup test environment"
1143 "${GIT_TEST_INSTALLED:-$GIT_EXEC_PATH}/git$X" init \
1144 "--template=$GIT_BUILD_DIR/templates/blt/" >&3 2>&4 ||
1145 error "cannot run git init -- have you built things yet?"
1146 mv .git/hooks .git/hooks-disabled
1147 ) || exit
1150 # This function helps on symlink challenged file systems when it is not
1151 # important that the file system entry is a symbolic link.
1152 # Use test_ln_s_add instead of "ln -s x y && git add y" to add a
1153 # symbolic link entry y to the index.
1155 test_ln_s_add () {
1156 if test_have_prereq SYMLINKS
1157 then
1158 ln -s "$1" "$2" &&
1159 git update-index --add "$2"
1160 else
1161 printf '%s' "$1" >"$2" &&
1162 ln_s_obj=$(git hash-object -w "$2") &&
1163 git update-index --add --cacheinfo 120000 $ln_s_obj "$2" &&
1164 # pick up stat info from the file
1165 git update-index "$2"
1169 # This function writes out its parameters, one per line
1170 test_write_lines () {
1171 printf "%s\n" "$@"
1174 perl () {
1175 command "$PERL_PATH" "$@" 2>&7
1176 } 7>&2 2>&4
1178 # Exit the test suite, either by skipping all remaining tests or by
1179 # exiting with an error. If our prerequisite variable $1 falls back
1180 # on a default assume we were opportunistically trying to set up some
1181 # tests and we skip. If it is explicitly "true", then we report a failure.
1183 # The error/skip message should be given by $2.
1185 test_skip_or_die () {
1186 if ! git env--helper --type=bool --default=false --exit-code $1
1187 then
1188 skip_all=$2
1189 test_done
1191 error "$2"
1194 # The following mingw_* functions obey POSIX shell syntax, but are actually
1195 # bash scripts, and are meant to be used only with bash on Windows.
1197 # A test_cmp function that treats LF and CRLF equal and avoids to fork
1198 # diff when possible.
1199 mingw_test_cmp () {
1200 # Read text into shell variables and compare them. If the results
1201 # are different, use regular diff to report the difference.
1202 local test_cmp_a= test_cmp_b=
1204 # When text came from stdin (one argument is '-') we must feed it
1205 # to diff.
1206 local stdin_for_diff=
1208 # Since it is difficult to detect the difference between an
1209 # empty input file and a failure to read the files, we go straight
1210 # to diff if one of the inputs is empty.
1211 if test -s "$1" && test -s "$2"
1212 then
1213 # regular case: both files non-empty
1214 mingw_read_file_strip_cr_ test_cmp_a <"$1"
1215 mingw_read_file_strip_cr_ test_cmp_b <"$2"
1216 elif test -s "$1" && test "$2" = -
1217 then
1218 # read 2nd file from stdin
1219 mingw_read_file_strip_cr_ test_cmp_a <"$1"
1220 mingw_read_file_strip_cr_ test_cmp_b
1221 stdin_for_diff='<<<"$test_cmp_b"'
1222 elif test "$1" = - && test -s "$2"
1223 then
1224 # read 1st file from stdin
1225 mingw_read_file_strip_cr_ test_cmp_a
1226 mingw_read_file_strip_cr_ test_cmp_b <"$2"
1227 stdin_for_diff='<<<"$test_cmp_a"'
1229 test -n "$test_cmp_a" &&
1230 test -n "$test_cmp_b" &&
1231 test "$test_cmp_a" = "$test_cmp_b" ||
1232 eval "diff -u \"\$@\" $stdin_for_diff"
1235 # $1 is the name of the shell variable to fill in
1236 mingw_read_file_strip_cr_ () {
1237 # Read line-wise using LF as the line separator
1238 # and use IFS to strip CR.
1239 local line
1240 while :
1242 if IFS=$'\r' read -r -d $'\n' line
1243 then
1244 # good
1245 line=$line$'\n'
1246 else
1247 # we get here at EOF, but also if the last line
1248 # was not terminated by LF; in the latter case,
1249 # some text was read
1250 if test -z "$line"
1251 then
1252 # EOF, really
1253 break
1256 eval "$1=\$$1\$line"
1257 done
1260 # Like "env FOO=BAR some-program", but run inside a subshell, which means
1261 # it also works for shell functions (though those functions cannot impact
1262 # the environment outside of the test_env invocation).
1263 test_env () {
1265 while test $# -gt 0
1267 case "$1" in
1268 *=*)
1269 eval "${1%%=*}=\${1#*=}"
1270 eval "export ${1%%=*}"
1271 shift
1274 "$@" 2>&7
1275 exit
1277 esac
1278 done
1280 } 7>&2 2>&4
1282 # Returns true if the numeric exit code in "$2" represents the expected signal
1283 # in "$1". Signals should be given numerically.
1284 test_match_signal () {
1285 if test "$2" = "$((128 + $1))"
1286 then
1287 # POSIX
1288 return 0
1289 elif test "$2" = "$((256 + $1))"
1290 then
1291 # ksh
1292 return 0
1294 return 1
1297 # Read up to "$1" bytes (or to EOF) from stdin and write them to stdout.
1298 test_copy_bytes () {
1299 perl -e '
1300 my $len = $ARGV[1];
1301 while ($len > 0) {
1302 my $s;
1303 my $nread = sysread(STDIN, $s, $len);
1304 die "cannot read: $!" unless defined($nread);
1305 last unless $nread;
1306 print $s;
1307 $len -= $nread;
1309 ' - "$1"
1312 # run "$@" inside a non-git directory
1313 nongit () {
1314 test -d non-repo ||
1315 mkdir non-repo ||
1316 return 1
1319 GIT_CEILING_DIRECTORIES=$(pwd) &&
1320 export GIT_CEILING_DIRECTORIES &&
1321 cd non-repo &&
1322 "$@" 2>&7
1324 } 7>&2 2>&4
1326 # convert stdin to pktline representation; note that empty input becomes an
1327 # empty packet, not a flush packet (for that you can just print 0000 yourself).
1328 packetize() {
1329 cat >packetize.tmp &&
1330 len=$(wc -c <packetize.tmp) &&
1331 printf '%04x%s' "$(($len + 4))" &&
1332 cat packetize.tmp &&
1333 rm -f packetize.tmp
1336 # Parse the input as a series of pktlines, writing the result to stdout.
1337 # Sideband markers are removed automatically, and the output is routed to
1338 # stderr if appropriate.
1340 # NUL bytes are converted to "\\0" for ease of parsing with text tools.
1341 depacketize () {
1342 perl -e '
1343 while (read(STDIN, $len, 4) == 4) {
1344 if ($len eq "0000") {
1345 print "FLUSH\n";
1346 } else {
1347 read(STDIN, $buf, hex($len) - 4);
1348 $buf =~ s/\0/\\0/g;
1349 if ($buf =~ s/^[\x2\x3]//) {
1350 print STDERR $buf;
1351 } else {
1352 $buf =~ s/^\x1//;
1353 print $buf;
1360 # Converts base-16 data into base-8. The output is given as a sequence of
1361 # escaped octals, suitable for consumption by 'printf'.
1362 hex2oct () {
1363 perl -ne 'printf "\\%03o", hex for /../g'
1366 # Set the hash algorithm in use to $1. Only useful when testing the testsuite.
1367 test_set_hash () {
1368 test_hash_algo="$1"
1371 # Detect the hash algorithm in use.
1372 test_detect_hash () {
1373 # Currently we only support SHA-1, but in the future this function will
1374 # actually detect the algorithm in use.
1375 test_hash_algo='sha1'
1378 # Load common hash metadata and common placeholder object IDs for use with
1379 # test_oid.
1380 test_oid_init () {
1381 test -n "$test_hash_algo" || test_detect_hash &&
1382 test_oid_cache <"$TEST_DIRECTORY/oid-info/hash-info" &&
1383 test_oid_cache <"$TEST_DIRECTORY/oid-info/oid"
1386 # Load key-value pairs from stdin suitable for use with test_oid. Blank lines
1387 # and lines starting with "#" are ignored. Keys must be shell identifier
1388 # characters.
1390 # Examples:
1391 # rawsz sha1:20
1392 # rawsz sha256:32
1393 test_oid_cache () {
1394 local tag rest k v &&
1396 { test -n "$test_hash_algo" || test_detect_hash; } &&
1397 while read tag rest
1399 case $tag in
1400 \#*)
1401 continue;;
1403 # non-empty
1406 # blank line
1407 continue;;
1408 esac &&
1410 k="${rest%:*}" &&
1411 v="${rest#*:}" &&
1413 if ! expr "$k" : '[a-z0-9][a-z0-9]*$' >/dev/null
1414 then
1415 BUG 'bad hash algorithm'
1416 fi &&
1417 eval "test_oid_${k}_$tag=\"\$v\""
1418 done
1421 # Look up a per-hash value based on a key ($1). The value must have been loaded
1422 # by test_oid_init or test_oid_cache.
1423 test_oid () {
1424 local var="test_oid_${test_hash_algo}_$1" &&
1426 # If the variable is unset, we must be missing an entry for this
1427 # key-hash pair, so exit with an error.
1428 if eval "test -z \"\${$var+set}\""
1429 then
1430 BUG "undefined key '$1'"
1431 fi &&
1432 eval "printf '%s' \"\${$var}\""
1435 # Insert a slash into an object ID so it can be used to reference a location
1436 # under ".git/objects". For example, "deadbeef..." becomes "de/adbeef..".
1437 test_oid_to_path () {
1438 local basename=${1#??}
1439 echo "${1%$basename}/$basename"
1442 # Choose a port number based on the test script's number and store it in
1443 # the given variable name, unless that variable already contains a number.
1444 test_set_port () {
1445 local var=$1 port
1447 if test $# -ne 1 || test -z "$var"
1448 then
1449 BUG "test_set_port requires a variable name"
1452 eval port=\$$var
1453 case "$port" in
1455 # No port is set in the given env var, use the test
1456 # number as port number instead.
1457 # Remove not only the leading 't', but all leading zeros
1458 # as well, so the arithmetic below won't (mis)interpret
1459 # a test number like '0123' as an octal value.
1460 port=${this_test#${this_test%%[1-9]*}}
1461 if test "${port:-0}" -lt 1024
1462 then
1463 # root-only port, use a larger one instead.
1464 port=$(($port + 10000))
1467 *[!0-9]*|0*)
1468 error >&7 "invalid port number: $port"
1471 # The user has specified the port.
1473 esac
1475 # Make sure that parallel '--stress' test jobs get different
1476 # ports.
1477 port=$(($port + ${GIT_TEST_STRESS_JOB_NR:-0}))
1478 eval $var=$port