1 # Library of functions shared by all tests scripts, included by
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
31 EDITOR
='"$FAKE_EDITOR"'
35 test_decode_color
() {
38 if (n == 0) return "RESET";
39 if (n == 1) return "BOLD";
40 if (n == 2) return "FAINT";
41 if (n == 3) return "ITALIC";
42 if (n == 7) return "REVERSE";
43 if (n == 30) return "BLACK";
44 if (n == 31) return "RED";
45 if (n == 32) return "GREEN";
46 if (n == 33) return "YELLOW";
47 if (n == 34) return "BLUE";
48 if (n == 35) return "MAGENTA";
49 if (n == 36) return "CYAN";
50 if (n == 37) return "WHITE";
51 if (n == 40) return "BLACK";
52 if (n == 41) return "BRED";
53 if (n == 42) return "BGREEN";
54 if (n == 43) return "BYELLOW";
55 if (n == 44) return "BBLUE";
56 if (n == 45) return "BMAGENTA";
57 if (n == 46) return "BCYAN";
58 if (n == 47) return "BWHITE";
61 while (match($0, /\033\[[0-9;]*m/) != 0) {
62 printf "%s<", substr($0, 1, RSTART-1);
63 codes = substr($0, RSTART+2, RLENGTH-3);
64 if (length(codes) == 0)
67 n = split(codes, ary, ";");
69 for (i = 1; i <= n; i++) {
70 printf "%s%s", sep, name(ary[i]);
75 $0 = substr($0, RSTART + RLENGTH, length($0) - RSTART - RLENGTH + 1);
83 perl
-pe 'y/\012/\000/'
107 sed -e 's/$/Q/' |
tr Q
'\015'
111 tr '\015' Q |
sed -e 's/Q$//'
114 # In some bourne shell implementations, the "unset" builtin returns
115 # nonzero status when a variable to be unset was not set in the first
118 # Use sane_unset when that should not be considered an error.
126 if test -z "${test_tick+set}"
130 test_tick
=$
(($test_tick + 60))
132 GIT_COMMITTER_DATE
="$test_tick -0700"
133 GIT_AUTHOR_DATE
="$test_tick -0700"
134 export GIT_COMMITTER_DATE GIT_AUTHOR_DATE
137 # Stop execution and start a shell. This is useful for debugging tests.
139 # Be sure to remove all invocations of this command before submitting.
140 # WARNING: the shell invoked by this helper does not have the same environment
141 # as the one running the tests (shell variables and functions are not
142 # available, and the options below further modify the environment). As such,
143 # commands copied from a test script might behave differently than when
146 # Usage: test_pause [options]
148 # Use your original TERM instead of test-lib.sh's "dumb".
149 # This usually restores color output in the invoked shell.
151 # Invoke $SHELL instead of $TEST_SHELL_PATH.
153 # Use your original HOME instead of test-lib.sh's "$TRASH_DIRECTORY".
154 # This allows you to use your regular shell environment and Git aliases.
155 # CAUTION: running commands copied from a test script into the paused shell
156 # might result in files in your HOME being overwritten.
158 # Shortcut for -t -s -h
162 PAUSE_SHELL
=$TEST_SHELL_PATH &&
168 PAUSE_TERM
="$USER_TERM"
174 PAUSE_HOME
="$USER_HOME"
177 PAUSE_TERM
="$USER_TERM"
179 PAUSE_HOME
="$USER_HOME"
187 TERM
="$PAUSE_TERM" HOME
="$PAUSE_HOME" "$PAUSE_SHELL" <&6 >&5 2>&7
190 # Wrap git with a debugger. Adding this to a command can make it easier
191 # to understand what is going on in a failing test.
193 # Usage: debug [options] <git command>
195 # --debugger=<debugger>
196 # Use <debugger> instead of GDB
198 # Use your original TERM instead of test-lib.sh's "dumb".
199 # This usually restores color output in the debugger.
200 # WARNING: the command being debugged might behave differently than when
204 # debug git checkout master
205 # debug --debugger=nemiver git $ARGS
206 # debug -d "valgrind --tool=memcheck --track-origins=yes" git $ARGS
214 DEBUG_TERM
="$USER_TERM"
221 GIT_DEBUGGER
="${1#*=}"
230 dotfiles
=".gdbinit .lldbinit"
232 for dotfile
in $dotfiles
234 dotfile
="$USER_HOME/$dotfile" &&
235 test -f "$dotfile" && cp "$dotfile" "$HOME" ||
:
238 TERM
="$DEBUG_TERM" GIT_DEBUGGER
="${GIT_DEBUGGER}" "$@" <&6 >&5 2>&7 &&
240 for dotfile
in $dotfiles
242 rm -f "$HOME/$dotfile"
246 # Usage: test_commit [options] <message> [<file> [<contents> [<tag>]]]
248 # Run all git commands in directory <dir>
250 # Do not call test_tick before making a commit
252 # Use ">>" instead of ">" when writing "<contents>" to "<file>"
254 # Use "printf" instead of "echo" when writing "<contents>" to
255 # "<file>", use this to write escape sequences such as "\0", a
256 # trailing "\n" won't be added automatically. This option
257 # supports nothing but the FORMAT of printf(1), i.e. no custom
260 # Invoke "git commit" with --signoff
262 # Invoke "git commit" with --author <author>
264 # Do not tag the resulting commit
266 # Create an annotated tag with "--annotate -m <message>". Calls
267 # test_tick between making the commit and tag, unless --notick
270 # This will commit a file with the given contents and the given commit
271 # message, and tag the resulting commit with the given tag name.
273 # <file>, <contents>, and <tag> all default to <message>.
304 GIT_COMMITTER_DATE
="$2"
324 indir
=${indir:+"$indir"/} &&
328 $echo "${3-$1}" >>"$indir$file"
330 $echo "${3-$1}" >"$indir$file"
332 git
${indir:+ -C "$indir"} add
"$file" &&
337 git
${indir:+ -C "$indir"} commit \
338 ${author:+ --author "$author"} \
344 git
${indir:+ -C "$indir"} tag
"${4:-$1}"
351 git
${indir:+ -C "$indir"} tag
-a -m "$1" "${4:-$1}"
356 # Call test_merge with the arguments "<message> <commit>", where <commit>
357 # can be a tag pointing to the commit-to-merge.
363 git merge
-m "$label" "$@" &&
367 # Efficiently create <nr> commits, each with a unique number (from 1 to <nr>
368 # by default) in the commit message.
370 # Usage: test_commit_bulk [options] <nr>
372 # Run all git commands in directory <dir>
374 # ref on which to create commits (default: HEAD)
376 # number commit messages from <n> (default: 1)
378 # use <msg> as the commit mesasge (default: "commit %s")
380 # modify <fn> in each commit (default: %s.t)
381 # --contents=<string>:
382 # place <string> in each file (default: "content %s")
384 # shorthand to use <string> and %s in message, filename, and contents
386 # The message, filename, and contents strings are evaluated by printf, with the
387 # first "%s" replaced by the current commit number. So you can do:
389 # test_commit_bulk --filename=file --contents="modification %s"
391 # to have every commit touch the same file, but with unique content.
393 test_commit_bulk
() {
394 tmpfile
=.bulk-commit.input
400 contents
='content %s'
424 message
="${1#--*=} %s"
425 filename
="${1#--*=}-%s.t"
426 contents
="${1#--*=} %s"
429 BUG
"invalid test_commit_bulk option: $1"
440 if git
-C "$indir" rev-parse
--quiet --verify "$ref"
445 while test "$total" -gt 0
449 printf 'author %s <%s> %s\n' \
451 "$GIT_AUTHOR_EMAIL" \
453 printf 'committer %s <%s> %s\n' \
454 "$GIT_COMMITTER_NAME" \
455 "$GIT_COMMITTER_EMAIL" \
456 "$GIT_COMMITTER_DATE"
458 printf "$message\n" $n
460 if test -n "$add_from"
465 printf "M
644 inline
$filename\n" $n
467 printf "$contents\n" $n
475 -c fastimport.unpacklimit=0 \
476 fast-import <"$tmpfile" || return 1
478 # This will be left in place on failure, which may aid debugging.
481 # If we updated HEAD, then be nice and update the index and working
483 if test "$ref" = "HEAD
"
485 git -C "$indir" checkout -f HEAD || return 1
490 # This function helps systems where core.filemode=false is set.
491 # Use it instead of plain 'chmod +x' to set or unset the executable bit
492 # of a file in the working directory and add it to the index.
496 git update-index --add "--chmod=$@
"
499 # Get the modebits from a file or directory, ignoring the setgid bit (g+s).
500 # This bit is inherited by subdirectories at their creation. So we remove it
501 # from the returning string to prevent callers from having to worry about the
502 # state of the bit in the test directory.
505 ls -ld "$1" | sed -e 's|^\(..........\).*|\1|' \
506 -e 's|^\(......\)S|\1-|' -e 's|^\(......\)s|\1x|'
509 # Unset a configuration variable, but don't fail if it doesn't exist.
518 git ${config_dir:+-C "$config_dir"} config --unset-all "$@
"
520 case "$config_status" in
521 5) # ok, nothing to unset
525 return $config_status
528 # Set git config, automatically unsetting it after the test is over.
537 test_when_finished "test_unconfig
${config_dir:+-C '$config_dir'} '$1'" &&
538 git ${config_dir:+-C "$config_dir"} config "$@
"
541 test_config_global () {
542 test_when_finished "test_unconfig
--global '$1'" &&
543 git config --global "$@
"
548 echo "#!${2-"$SHELL_PATH"}" &&
554 # Use test_set_prereq to tell that a particular prerequisite is available.
555 # The prerequisite can later be checked for in two ways:
557 # - Explicitly using test_have_prereq.
559 # - Implicitly by specifying the prerequisite tag in the calls to
560 # test_expect_{success,failure} and test_external{,_without_stderr}.
562 # The single parameter is the prerequisite tag (a simple word, in all
563 # capital letters by convention).
565 test_unset_prereq
() {
566 ! test_have_prereq
"$1" ||
567 satisfied_prereq
="${satisfied_prereq% $1 *} ${satisfied_prereq#* $1 }"
571 if test -n "$GIT_TEST_FAIL_PREREQS_INTERNAL"
574 # The "!" case is handled below with
575 # test_unset_prereq()
578 # (Temporary?) whitelist of things we can't easily
579 # pretend not to support
582 # Inspecting whether GIT_TEST_FAIL_PREREQS is on
583 # should be unaffected.
593 test_unset_prereq
"${1#!}"
596 satisfied_prereq
="$satisfied_prereq$1 "
601 lazily_testable_prereq
= lazily_tested_prereq
=
603 # Usage: test_lazy_prereq PREREQ 'script'
604 test_lazy_prereq
() {
605 lazily_testable_prereq
="$lazily_testable_prereq$1 "
606 eval test_prereq_lazily_
$1=\
$2
609 test_run_lazy_prereq_
() {
611 mkdir -p "$TRASH_DIRECTORY/prereq-test-dir-'"$1"'" &&
613 cd "$TRASH_DIRECTORY/prereq-test-dir-'"$1"'" &&'"$2"'
615 say
>&3 "checking prerequisite: $1"
619 rm -rf "$TRASH_DIRECTORY/prereq-test-dir-$1"
620 if test "$eval_ret" = 0; then
621 say
>&3 "prerequisite $1 ok"
623 say
>&3 "prerequisite $1 not satisfied"
628 test_have_prereq
() {
629 # prerequisites can be concatenated with ','
641 case "$prerequisite" in
644 prerequisite
=${prerequisite#!}
650 case " $lazily_tested_prereq " in
654 case " $lazily_testable_prereq " in
656 eval "script=\$test_prereq_lazily_$prerequisite" &&
657 if test_run_lazy_prereq_
"$prerequisite" "$script"
659 test_set_prereq
$prerequisite
661 lazily_tested_prereq
="$lazily_tested_prereq$prerequisite "
666 total_prereq
=$
(($total_prereq + 1))
667 case "$satisfied_prereq" in
669 satisfied_this_prereq
=t
672 satisfied_this_prereq
=
675 case "$satisfied_this_prereq,$negative_prereq" in
677 ok_prereq
=$
(($ok_prereq + 1))
680 # Keep a list of missing prerequisites; restore
681 # the negative marker if necessary.
682 prerequisite
=${negative_prereq:+!}$prerequisite
684 # Abort if this prereq was marked as required
685 if test -n "$GIT_TEST_REQUIRE_PREREQ"
687 case " $GIT_TEST_REQUIRE_PREREQ " in
689 BAIL_OUT
"required prereq $prerequisite failed"
694 if test -z "$missing_prereq"
696 missing_prereq
=$prerequisite
698 missing_prereq
="$prerequisite,$missing_prereq"
703 test $total_prereq = $ok_prereq
706 test_declared_prereq
() {
707 case ",$test_prereq," in
715 test_verify_prereq
() {
716 test -z "$test_prereq" ||
717 expr >/dev
/null
"$test_prereq" : '[A-Z0-9_,!]*$' ||
718 BUG
"'$test_prereq' does not look like a prereq"
721 test_expect_failure
() {
723 test "$#" = 3 && { test_prereq
=$1; shift; } || test_prereq
=
725 BUG
"not 2 or 3 parameters to test-expect-failure"
730 say
>&3 "checking known breakage of $TEST_NUMBER.$test_count '$1': $2"
731 if test_run_
"$2" expecting_failure
733 test_known_broken_ok_
"$1"
735 test_known_broken_failure_
"$1"
741 test_expect_success
() {
743 test "$#" = 3 && { test_prereq
=$1; shift; } || test_prereq
=
745 BUG
"not 2 or 3 parameters to test-expect-success"
750 say
>&3 "expecting success of $TEST_NUMBER.$test_count '$1': $2"
761 # test_external runs external test scripts that provide continuous
762 # test output about their progress, and succeeds/fails on
763 # zero/non-zero exit code. It outputs the test output on stdout even
764 # in non-verbose mode, and announces the external script with "# run
765 # <n>: ..." before running it. When providing relative paths, keep in
766 # mind that all scripts run in "trash directory".
767 # Usage: test_external description command arguments...
768 # Example: test_external 'Perl API' perl ../path/to/test.pl
770 test "$#" = 4 && { test_prereq
=$1; shift; } || test_prereq
=
772 BUG
"not 3 or 4 parameters to test_external"
777 if ! test_skip
"$descr" "$@"
779 # Announce the script to reduce confusion about the
780 # test output that follows.
781 say_color
"" "# run $test_count: $descr ($*)"
782 # Export TEST_DIRECTORY, TRASH_DIRECTORY and GIT_TEST_LONG
783 # to be able to use them in script
784 export TEST_DIRECTORY TRASH_DIRECTORY GIT_TEST_LONG
785 # Run command; redirect its stderr to &4 as in
786 # test_run_, but keep its stdout on our stdout even in
791 if test $test_external_has_tap -eq 0; then
794 say_color
"" "# test_external test $descr was ok"
795 test_success
=$
(($test_success + 1))
798 if test $test_external_has_tap -eq 0; then
799 test_failure_
"$descr" "$@"
801 say_color error
"# test_external test $descr failed: $@"
802 test_failure
=$
(($test_failure + 1))
808 # Like test_external, but in addition tests that the command generated
809 # no output on stderr.
810 test_external_without_stderr
() {
811 # The temporary file has no (and must have no) security
814 stderr
="$tmp/git-external-stderr.$$.tmp"
815 test_external
"$@" 4> "$stderr"
816 test -f "$stderr" || error
"Internal error: $stderr disappeared."
817 descr
="no stderr: $1"
819 say
>&3 "# expecting no stderr from previous command"
820 if test ! -s "$stderr"
824 if test $test_external_has_tap -eq 0; then
827 say_color
"" "# test_external_without_stderr test $descr was ok"
828 test_success
=$
(($test_success + 1))
831 if test "$verbose" = t
833 output
=$
(echo; echo "# Stderr is:"; cat "$stderr")
837 # rm first in case test_failure exits.
839 if test $test_external_has_tap -eq 0; then
840 test_failure_
"$descr" "$@" "$output"
842 say_color error
"# test_external_without_stderr test $descr failed: $@: $output"
843 test_failure
=$
(($test_failure + 1))
848 # debugging-friendly alternatives to "test [-f|-d|-e]"
849 # The commands test the existence or non-existence of $1
850 test_path_is_file
() {
851 test "$#" -ne 1 && BUG
"1 param"
854 echo "File $1 doesn't exist"
859 test_path_is_dir
() {
860 test "$#" -ne 1 && BUG
"1 param"
863 echo "Directory $1 doesn't exist"
868 test_path_exists
() {
869 test "$#" -ne 1 && BUG
"1 param"
872 echo "Path $1 doesn't exist"
877 # Check if the directory exists and is empty as expected, barf otherwise.
878 test_dir_is_empty
() {
879 test "$#" -ne 1 && BUG
"1 param"
880 test_path_is_dir
"$1" &&
881 if test -n "$(ls -a1 "$1" | egrep -v '^\.\.?$')"
883 echo "Directory '$1' is not empty, it contains:"
889 # Check if the file exists and has a size greater than zero
890 test_file_not_empty
() {
891 test "$#" = 2 && BUG
"2 param"
894 echo "'$1' is not a non-empty file."
899 test_path_is_missing
() {
900 test "$#" -ne 1 && BUG
"1 param"
913 # test_line_count checks that a file has the number of lines it
914 # ought to. For example:
916 # test_expect_success 'produce exactly one line of output' '
917 # do something >output &&
918 # test_line_count = 1 output
921 # is like "test $(wc -l <output) = 1" except that it passes the
922 # output through when the number of lines is wrong.
927 BUG
"not 3 parameters to test_line_count"
928 elif ! test $
(wc -l <"$3") "$1" "$2"
930 echo "test_line_count: line count for $3 !$1 $2"
937 # test_stdout_line_count <bin-ops> <value> <cmd> [<args>...]
939 # test_stdout_line_count checks that the output of a command has the number
940 # of lines it ought to. For example:
942 # test_stdout_line_count = 3 git ls-files -u
943 # test_stdout_line_count -gt 10 ls
944 test_stdout_line_count
() {
945 local ops val trashdir
&&
948 BUG
"expect 3 or more arguments"
953 if ! trashdir
="$(git rev-parse --git-dir)/trash"; then
954 BUG
"expect to be run inside a worktree"
956 mkdir
-p "$trashdir" &&
957 "$@" >"$trashdir/output" &&
958 test_line_count
"$ops" "$val" "$trashdir/output"
963 test "$#" -ne 1 && BUG
"1 param"
964 test-tool path-utils file-size
"$1"
967 # Returns success if a comma separated string of keywords ($1) contains a
968 # given keyword ($2).
970 # `list_contains "foo,bar" bar` returns 0
971 # `list_contains "foo" bar` returns 1
982 # Returns success if the arguments indicate that a command should be
983 # accepted by test_must_fail(). If the command is run with env, the env
984 # and its corresponding variable settings will be stripped before we
985 # test the command being run.
986 test_must_fail_acceptable
() {
1004 git|__git
*|test-tool|test_terminal
)
1013 # This is not among top-level (test_expect_success | test_expect_failure)
1014 # but is a prefix that can be used in the test script, like:
1016 # test_expect_success 'complain and die' '
1018 # do something else &&
1019 # test_must_fail git checkout ../outerspace
1022 # Writing this as "! git checkout ../outerspace" is wrong, because
1023 # the failure could be due to a segv. We want a controlled failure.
1025 # Accepts the following options:
1027 # ok=<signal-name>[,<...>]:
1028 # Don't treat an exit caused by the given signal as error.
1029 # Multiple signals can be specified as a comma separated list.
1030 # Currently recognized signal names are: sigpipe, success.
1031 # (Don't use 'success', use 'test_might_fail' instead.)
1033 # Do not use this to run anything but "git" and other specific testable
1034 # commands (see test_must_fail_acceptable()). We are not in the
1035 # business of vetting system supplied commands -- in other words, this
1038 # test_must_fail grep pattern output
1042 # ! grep pattern output
1054 if ! test_must_fail_acceptable
"$@"
1056 echo >&7 "test_must_fail: only 'git' is allowed: $*"
1061 if test $exit_code -eq 0 && ! list_contains
"$_test_ok" success
1063 echo >&4 "test_must_fail: command succeeded: $*"
1065 elif test_match_signal
13 $exit_code && list_contains
"$_test_ok" sigpipe
1068 elif test $exit_code -gt 129 && test $exit_code -le 192
1070 echo >&4 "test_must_fail: died by signal $(($exit_code - 128)): $*"
1072 elif test $exit_code -eq 127
1074 echo >&4 "test_must_fail: command not found: $*"
1076 elif test $exit_code -eq 126
1078 echo >&4 "test_must_fail: valgrind error: $*"
1084 # Similar to test_must_fail, but tolerates success, too. This is
1085 # meant to be used in contexts like:
1087 # test_expect_success 'some command works without configuration' '
1088 # test_might_fail git config --unset all.configuration &&
1092 # Writing "git config --unset all.configuration || :" would be wrong,
1093 # because we want to notice if it fails due to segv.
1095 # Accepts the same options as test_must_fail.
1097 test_might_fail
() {
1098 test_must_fail ok
=success
"$@" 2>&7
1101 # Similar to test_must_fail and test_might_fail, but check that a
1102 # given command exited with a given exit code. Meant to be used as:
1104 # test_expect_success 'Merge with d/f conflicts' '
1105 # test_expect_code 1 git merge "merge msg" B master
1108 test_expect_code
() {
1113 if test $exit_code = $want_code
1118 echo >&4 "test_expect_code: command exited with $exit_code, we wanted $want_code $*"
1122 # test_cmp is a helper function to compare actual and expected output.
1123 # You can use it like:
1125 # test_expect_success 'foo works' '
1126 # echo expected >expected &&
1128 # test_cmp expected actual
1131 # This could be written as either "cmp" or "diff -u", but:
1132 # - cmp's output is not nearly as easy to read as diff -u
1133 # - not all diff versions understand "-u"
1136 test "$#" -ne 2 && BUG
"2 param"
1137 eval "$GIT_TEST_CMP" '"$@"'
1140 # Check that the given config key has the expected value.
1142 # test_cmp_config [-C <dir>] <expected-value>
1143 # [<git-config-options>...] <config-key>
1145 # for example to check that the value of core.bar is foo
1147 # test_cmp_config foo core.bar
1149 test_cmp_config
() {
1157 printf "%s\n" "$1" >expect.config
&&
1159 git
$GD config
"$@" >actual.config
&&
1160 test_cmp expect.config actual.config
1163 # test_cmp_bin - helper to compare binary files
1166 test "$#" -ne 2 && BUG
"2 param"
1170 # Wrapper for grep which used to be used for
1171 # GIT_TEST_GETTEXT_POISON=false. Only here as a shim for other
1172 # in-flight changes. Should not be used and will be removed soon.
1174 eval "last_arg=\${$#}"
1176 test -f "$last_arg" ||
1177 BUG
"test_i18ngrep requires a file to read as the last parameter"
1180 { test "x!" = "x$1" && test $# -lt 3 ; }
1182 BUG
"too few parameters to test_i18ngrep"
1185 if test "x!" = "x$1"
1188 ! grep "$@" && return 0
1190 echo >&4 "error: '! grep $@' did find a match in:"
1192 grep "$@" && return 0
1194 echo >&4 "error: 'grep $@' didn't find a match in:"
1197 if test -s "$last_arg"
1201 echo >&4 "<File '$last_arg' is empty>"
1207 # Call any command "$@" but be more verbose about its
1208 # failure. This is handy for commands like "test" which do
1209 # not output anything when they fail.
1212 echo >&4 "command failed: $(git rev-parse --sq-quote "$@
")"
1216 # Check if the file expected to be empty is indeed empty, and barfs
1219 test_must_be_empty
() {
1220 test "$#" -ne 1 && BUG
"1 param"
1221 test_path_is_file
"$1" &&
1224 echo "'$1' is not empty, it contains:"
1230 # Tests that its two parameters refer to the same revision, or if '!' is
1231 # provided first, that its other two parameters refer to different
1234 local op
='=' wrong_result
=different
1236 if test $# -ge 1 && test "x$1" = 'x!'
1239 wrong_result
='the same'
1244 BUG
"test_cmp_rev requires two revisions, but got $#"
1247 r1
=$
(git rev-parse
--verify "$1") &&
1248 r2
=$
(git rev-parse
--verify "$2") ||
return 1
1250 if ! test "$r1" "$op" "$r2"
1253 error: two revisions point to $wrong_result objects:
1262 # Compare paths respecting core.ignoreCase
1263 test_cmp_fspath
() {
1264 if test "x$1" = "x$2"
1269 if test true
!= "$(git config --get --type=bool core.ignorecase)"
1274 test "x$(echo "$1" | tr A-Z a-z)" = "x$(echo "$2" | tr A-Z a-z)"
1277 # Print a sequence of integers in increasing order, either with
1278 # two arguments (start and end):
1280 # test_seq 1 5 -- outputs 1 2 3 4 5 one line at a time
1282 # or with one argument (end), in which case it starts counting
1289 *) BUG
"not 1 or 2 parameters to test_seq" ;;
1291 test_seq_counter__
=$1
1292 while test "$test_seq_counter__" -le "$2"
1294 echo "$test_seq_counter__"
1295 test_seq_counter__
=$
(( $test_seq_counter__ + 1 ))
1299 # This function can be used to schedule some commands to be run
1300 # unconditionally at the end of the test to restore sanity:
1302 # test_expect_success 'test core.capslock' '
1303 # git config core.capslock true &&
1304 # test_when_finished "git config --unset core.capslock" &&
1308 # That would be roughly equivalent to
1310 # test_expect_success 'test core.capslock' '
1311 # git config core.capslock true &&
1313 # git config --unset core.capslock
1316 # except that the greeting and config --unset must both succeed for
1319 # Note that under --immediate mode, no clean-up is done to help diagnose
1322 test_when_finished
() {
1323 # We cannot detect when we are in a subshell in general, but by
1324 # doing so on Bash is better than nothing (the test will
1325 # silently pass on other shells).
1326 test "${BASH_SUBSHELL-0}" = 0 ||
1327 BUG
"test_when_finished does nothing in a subshell"
1329 } && (exit \"\$eval_ret\"); eval_ret=\$?; $test_cleanup"
1332 # This function can be used to schedule some commands to be run
1333 # unconditionally at the end of the test script, e.g. to stop a daemon:
1335 # test_expect_success 'test git daemon' '
1338 # test_atexit 'kill $daemon_pid' &&
1342 # The commands will be executed before the trash directory is removed,
1343 # i.e. the atexit commands will still be able to access any pidfiles or
1346 # Note that these commands will be run even when a test script run
1347 # with '--immediate' fails. Be careful with your atexit commands to
1348 # minimize any changes to the failed state.
1351 # We cannot detect when we are in a subshell in general, but by
1352 # doing so on Bash is better than nothing (the test will
1353 # silently pass on other shells).
1354 test "${BASH_SUBSHELL-0}" = 0 ||
1355 BUG
"test_atexit does nothing in a subshell"
1356 test_atexit_cleanup
="{ $*
1357 } && (exit \"\$eval_ret\"); eval_ret=\$?; $test_atexit_cleanup"
1360 # Deprecated wrapper for "git init", use "git init" directly instead
1361 # Usage: test_create_repo <directory>
1362 test_create_repo
() {
1366 # This function helps on symlink challenged file systems when it is not
1367 # important that the file system entry is a symbolic link.
1368 # Use test_ln_s_add instead of "ln -s x y && git add y" to add a
1369 # symbolic link entry y to the index.
1372 if test_have_prereq SYMLINKS
1375 git update-index
--add "$2"
1377 printf '%s' "$1" >"$2" &&
1378 ln_s_obj
=$
(git hash-object
-w "$2") &&
1379 git update-index
--add --cacheinfo 120000 $ln_s_obj "$2" &&
1380 # pick up stat info from the file
1381 git update-index
"$2"
1385 # This function writes out its parameters, one per line
1386 test_write_lines
() {
1391 command "$PERL_PATH" "$@" 2>&7
1394 # Given the name of an environment variable with a bool value, normalize
1395 # its value to a 0 (true) or 1 (false or empty string) return code.
1397 # test_bool_env GIT_TEST_HTTPD <default-value>
1399 # Return with code corresponding to the given default value if the variable
1401 # Abort the test script if either the value of the variable or the default
1402 # are not valid bool values.
1407 BUG
"test_bool_env requires two parameters (variable name and default value)"
1410 git env--helper
--type=bool
--default="$2" --exit-code "$1"
1413 0|
1) # unset or valid bool value
1415 *) # invalid bool value or something unexpected
1416 error
>&7 "test_bool_env requires bool values both for \$$1 and for the default fallback"
1422 # Exit the test suite, either by skipping all remaining tests or by
1423 # exiting with an error. If our prerequisite variable $1 falls back
1424 # on a default assume we were opportunistically trying to set up some
1425 # tests and we skip. If it is explicitly "true", then we report a failure.
1427 # The error/skip message should be given by $2.
1429 test_skip_or_die
() {
1430 if ! test_bool_env
"$1" false
1438 # The following mingw_* functions obey POSIX shell syntax, but are actually
1439 # bash scripts, and are meant to be used only with bash on Windows.
1441 # A test_cmp function that treats LF and CRLF equal and avoids to fork
1442 # diff when possible.
1444 # Read text into shell variables and compare them. If the results
1445 # are different, use regular diff to report the difference.
1446 local test_cmp_a
= test_cmp_b
=
1448 # When text came from stdin (one argument is '-') we must feed it
1450 local stdin_for_diff
=
1452 # Since it is difficult to detect the difference between an
1453 # empty input file and a failure to read the files, we go straight
1454 # to diff if one of the inputs is empty.
1455 if test -s "$1" && test -s "$2"
1457 # regular case: both files non-empty
1458 mingw_read_file_strip_cr_ test_cmp_a
<"$1"
1459 mingw_read_file_strip_cr_ test_cmp_b
<"$2"
1460 elif test -s "$1" && test "$2" = -
1462 # read 2nd file from stdin
1463 mingw_read_file_strip_cr_ test_cmp_a
<"$1"
1464 mingw_read_file_strip_cr_ test_cmp_b
1465 stdin_for_diff
='<<<"$test_cmp_b"'
1466 elif test "$1" = - && test -s "$2"
1468 # read 1st file from stdin
1469 mingw_read_file_strip_cr_ test_cmp_a
1470 mingw_read_file_strip_cr_ test_cmp_b
<"$2"
1471 stdin_for_diff
='<<<"$test_cmp_a"'
1473 test -n "$test_cmp_a" &&
1474 test -n "$test_cmp_b" &&
1475 test "$test_cmp_a" = "$test_cmp_b" ||
1476 eval "diff -u \"\$@\" $stdin_for_diff"
1479 # $1 is the name of the shell variable to fill in
1480 mingw_read_file_strip_cr_
() {
1481 # Read line-wise using LF as the line separator
1482 # and use IFS to strip CR.
1486 if IFS
=$
'\r' read -r -d $
'\n' line
1491 # we get here at EOF, but also if the last line
1492 # was not terminated by LF; in the latter case,
1493 # some text was read
1500 eval "$1=\$$1\$line"
1504 # Like "env FOO=BAR some-program", but run inside a subshell, which means
1505 # it also works for shell functions (though those functions cannot impact
1506 # the environment outside of the test_env invocation).
1513 eval "${1%%=*}=\${1#*=}"
1514 eval "export ${1%%=*}"
1526 # Returns true if the numeric exit code in "$2" represents the expected signal
1527 # in "$1". Signals should be given numerically.
1528 test_match_signal
() {
1529 if test "$2" = "$((128 + $1))"
1533 elif test "$2" = "$((256 + $1))"
1541 # Read up to "$1" bytes (or to EOF) from stdin and write them to stdout.
1542 test_copy_bytes
() {
1547 my $nread = sysread(STDIN, $s, $len);
1548 die "cannot read: $!" unless defined($nread);
1556 # run "$@" inside a non-git directory
1563 GIT_CEILING_DIRECTORIES
=$
(pwd) &&
1564 export GIT_CEILING_DIRECTORIES
&&
1570 # These functions are historical wrappers around "test-tool pkt-line"
1571 # for older tests. Use "test-tool pkt-line" itself in new tests.
1576 printf '%04x%s' "$((4 + ${#packet}))" "$packet"
1578 test-tool pkt-line pack
1583 test-tool pkt-line pack-raw-stdin
1587 test-tool pkt-line unpack
1590 # Converts base-16 data into base-8. The output is given as a sequence of
1591 # escaped octals, suitable for consumption by 'printf'.
1593 perl
-ne 'printf "\\%03o", hex for /../g'
1596 # Set the hash algorithm in use to $1. Only useful when testing the testsuite.
1601 # Detect the hash algorithm in use.
1602 test_detect_hash
() {
1603 test_hash_algo
="${GIT_TEST_DEFAULT_HASH:-sha1}"
1606 # Load common hash metadata and common placeholder object IDs for use with
1609 test -n "$test_hash_algo" || test_detect_hash
&&
1610 test_oid_cache
<"$TEST_DIRECTORY/oid-info/hash-info" &&
1611 test_oid_cache
<"$TEST_DIRECTORY/oid-info/oid"
1614 # Load key-value pairs from stdin suitable for use with test_oid. Blank lines
1615 # and lines starting with "#" are ignored. Keys must be shell identifier
1622 local tag rest k v
&&
1624 { test -n "$test_hash_algo" || test_detect_hash
; } &&
1641 if ! expr "$k" : '[a-z0-9][a-z0-9]*$' >/dev
/null
1643 BUG
'bad hash algorithm'
1645 eval "test_oid_${k}_$tag=\"\$v\""
1649 # Look up a per-hash value based on a key ($1). The value must have been loaded
1650 # by test_oid_init or test_oid_cache.
1652 local algo
="${test_hash_algo}" &&
1656 algo
="${1#--hash=}" &&
1662 local var
="test_oid_${algo}_$1" &&
1664 # If the variable is unset, we must be missing an entry for this
1665 # key-hash pair, so exit with an error.
1666 if eval "test -z \"\${$var+set}\""
1668 BUG
"undefined key '$1'"
1670 eval "printf '%s' \"\${$var}\""
1673 # Insert a slash into an object ID so it can be used to reference a location
1674 # under ".git/objects". For example, "deadbeef..." becomes "de/adbeef..".
1675 test_oid_to_path
() {
1676 local basename=${1#??}
1677 echo "${1%$basename}/$basename"
1680 # Choose a port number based on the test script's number and store it in
1681 # the given variable name, unless that variable already contains a number.
1685 if test $# -ne 1 ||
test -z "$var"
1687 BUG
"test_set_port requires a variable name"
1693 # No port is set in the given env var, use the test
1694 # number as port number instead.
1695 # Remove not only the leading 't', but all leading zeros
1696 # as well, so the arithmetic below won't (mis)interpret
1697 # a test number like '0123' as an octal value.
1698 port
=${this_test#${this_test%%[1-9]*}}
1699 if test "${port:-0}" -lt 1024
1701 # root-only port, use a larger one instead.
1702 port
=$
(($port + 10000))
1706 error
>&7 "invalid port number: $port"
1709 # The user has specified the port.
1713 # Make sure that parallel '--stress' test jobs get different
1715 port
=$
(($port + ${GIT_TEST_STRESS_JOB_NR:-0}))
1719 # Tests for the hidden file attribute on Windows
1720 test_path_is_hidden
() {
1721 test_have_prereq MINGW ||
1722 BUG
"test_path_is_hidden can only be used on Windows"
1724 # Use the output of `attrib`, ignore the absolute path
1725 case "$("$SYSTEMROOT"/system32/attrib "$1")" in *H
*?
:*) return 0;; esac
1729 # Check that the given command was invoked as part of the
1730 # trace2-format trace on stdin.
1732 # test_subcommand [!] <command> <args>... < <trace>
1734 # For example, to look for an invocation of "git upload-pack
1737 # GIT_TRACE2_EVENT=event.log git fetch ... &&
1738 # test_subcommand git upload-pack "$PATH" <event.log
1740 # If the first parameter passed is !, this instead checks that
1741 # the given command was not called.
1743 test_subcommand
() {
1751 local expr=$
(printf '"%s",' "$@")
1754 if test -n "$negate"
1762 # Check that the given command was invoked as part of the
1763 # trace2-format trace on stdin, but without an exact set of
1766 # test_subcommand [!] <command> <args>... < <trace>
1768 # For example, to look for an invocation of "git pack-objects"
1769 # with the "--honor-pack-keep" argument, use
1771 # GIT_TRACE2_EVENT=event.log git repack ... &&
1772 # test_subcommand git pack-objects --honor-pack-keep <event.log
1774 # If the first parameter passed is !, this instead checks that
1775 # the given command was not called.
1777 test_subcommand_inexact
() {
1785 local expr=$
(printf '"%s".*' "$@")
1788 if test -n "$negate"
1790 ! grep "\"event\":\"child_start\".*\[$expr\]"
1792 grep "\"event\":\"child_start\".*\[$expr\]"
1796 # Check that the given command was invoked as part of the
1797 # trace2-format trace on stdin.
1799 # test_region [!] <category> <label> git <command> <args>...
1801 # For example, to look for trace2_region_enter("index", "do_read_index", repo)
1802 # in an invocation of "git checkout HEAD~1", run
1804 # GIT_TRACE2_EVENT="$(pwd)/trace.txt" GIT_TRACE2_EVENT_NESTING=10 \
1805 # git checkout HEAD~1 &&
1806 # test_region index do_read_index <trace.txt
1808 # If the first parameter passed is !, this instead checks that
1809 # the given region was not entered.
1819 grep -e '"region_enter".*"category":"'"$1"'","label":"'"$2"\" "$3"
1822 if test $exitcode != $expect_exit
1827 grep -e '"region_leave".*"category":"'"$1"'","label":"'"$2"\" "$3"
1830 if test $exitcode != $expect_exit
1838 # Print the destination of symlink(s) provided as arguments. Basically
1839 # the same as the readlink command, but it's not available everywhere.
1841 perl
-le 'print readlink($_) for @ARGV' "$@"