Merge branch 'jc/test-i18ngrep'
[alt-git.git] / t / test-lib-functions.sh
blob9c3cf12b268ab5457f2abaf7e9181b1332a5ba96
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 # Like test_set_editor but sets GIT_SEQUENCE_EDITOR instead of EDITOR
36 test_set_sequence_editor () {
37 FAKE_SEQUENCE_EDITOR="$1"
38 export FAKE_SEQUENCE_EDITOR
39 GIT_SEQUENCE_EDITOR='"$FAKE_SEQUENCE_EDITOR"'
40 export GIT_SEQUENCE_EDITOR
43 test_decode_color () {
44 awk '
45 function name(n) {
46 if (n == 0) return "RESET";
47 if (n == 1) return "BOLD";
48 if (n == 2) return "FAINT";
49 if (n == 3) return "ITALIC";
50 if (n == 7) return "REVERSE";
51 if (n == 30) return "BLACK";
52 if (n == 31) return "RED";
53 if (n == 32) return "GREEN";
54 if (n == 33) return "YELLOW";
55 if (n == 34) return "BLUE";
56 if (n == 35) return "MAGENTA";
57 if (n == 36) return "CYAN";
58 if (n == 37) return "WHITE";
59 if (n == 40) return "BLACK";
60 if (n == 41) return "BRED";
61 if (n == 42) return "BGREEN";
62 if (n == 43) return "BYELLOW";
63 if (n == 44) return "BBLUE";
64 if (n == 45) return "BMAGENTA";
65 if (n == 46) return "BCYAN";
66 if (n == 47) return "BWHITE";
69 while (match($0, /\033\[[0-9;]*m/) != 0) {
70 printf "%s<", substr($0, 1, RSTART-1);
71 codes = substr($0, RSTART+2, RLENGTH-3);
72 if (length(codes) == 0)
73 printf "%s", name(0)
74 else {
75 n = split(codes, ary, ";");
76 sep = "";
77 for (i = 1; i <= n; i++) {
78 printf "%s%s", sep, name(ary[i]);
79 sep = ";"
82 printf ">";
83 $0 = substr($0, RSTART + RLENGTH, length($0) - RSTART - RLENGTH + 1);
85 print
90 lf_to_nul () {
91 perl -pe 'y/\012/\000/'
94 nul_to_q () {
95 perl -pe 'y/\000/Q/'
98 q_to_nul () {
99 perl -pe 'y/Q/\000/'
102 q_to_cr () {
103 tr Q '\015'
106 q_to_tab () {
107 tr Q '\011'
110 qz_to_tab_space () {
111 tr QZ '\011\040'
114 append_cr () {
115 sed -e 's/$/Q/' | tr Q '\015'
118 remove_cr () {
119 tr '\015' Q | sed -e 's/Q$//'
122 # In some bourne shell implementations, the "unset" builtin returns
123 # nonzero status when a variable to be unset was not set in the first
124 # place.
126 # Use sane_unset when that should not be considered an error.
128 sane_unset () {
129 unset "$@"
130 return 0
133 test_tick () {
134 if test -z "${test_tick+set}"
135 then
136 test_tick=1112911993
137 else
138 test_tick=$(($test_tick + 60))
140 GIT_COMMITTER_DATE="$test_tick -0700"
141 GIT_AUTHOR_DATE="$test_tick -0700"
142 export GIT_COMMITTER_DATE GIT_AUTHOR_DATE
145 # Stop execution and start a shell. This is useful for debugging tests.
147 # Be sure to remove all invocations of this command before submitting.
148 # WARNING: the shell invoked by this helper does not have the same environment
149 # as the one running the tests (shell variables and functions are not
150 # available, and the options below further modify the environment). As such,
151 # commands copied from a test script might behave differently than when
152 # running the test.
154 # Usage: test_pause [options]
155 # -t
156 # Use your original TERM instead of test-lib.sh's "dumb".
157 # This usually restores color output in the invoked shell.
158 # -s
159 # Invoke $SHELL instead of $TEST_SHELL_PATH.
160 # -h
161 # Use your original HOME instead of test-lib.sh's "$TRASH_DIRECTORY".
162 # This allows you to use your regular shell environment and Git aliases.
163 # CAUTION: running commands copied from a test script into the paused shell
164 # might result in files in your HOME being overwritten.
165 # -a
166 # Shortcut for -t -s -h
168 test_pause () {
169 PAUSE_TERM=$TERM &&
170 PAUSE_SHELL=$TEST_SHELL_PATH &&
171 PAUSE_HOME=$HOME &&
172 while test $# != 0
174 case "$1" in
176 PAUSE_TERM="$USER_TERM"
179 PAUSE_SHELL="$SHELL"
182 PAUSE_HOME="$USER_HOME"
185 PAUSE_TERM="$USER_TERM"
186 PAUSE_SHELL="$SHELL"
187 PAUSE_HOME="$USER_HOME"
190 break
192 esac
193 shift
194 done &&
195 TERM="$PAUSE_TERM" HOME="$PAUSE_HOME" "$PAUSE_SHELL" <&6 >&5 2>&7
198 # Wrap git with a debugger. Adding this to a command can make it easier
199 # to understand what is going on in a failing test.
201 # Usage: debug [options] <git command>
202 # -d <debugger>
203 # --debugger=<debugger>
204 # Use <debugger> instead of GDB
205 # -t
206 # Use your original TERM instead of test-lib.sh's "dumb".
207 # This usually restores color output in the debugger.
208 # WARNING: the command being debugged might behave differently than when
209 # running the test.
211 # Examples:
212 # debug git checkout master
213 # debug --debugger=nemiver git $ARGS
214 # debug -d "valgrind --tool=memcheck --track-origins=yes" git $ARGS
215 debug () {
216 GIT_DEBUGGER=1 &&
217 DEBUG_TERM=$TERM &&
218 while test $# != 0
220 case "$1" in
222 DEBUG_TERM="$USER_TERM"
225 GIT_DEBUGGER="$2" &&
226 shift
228 --debugger=*)
229 GIT_DEBUGGER="${1#*=}"
232 break
234 esac
235 shift
236 done &&
238 dotfiles=".gdbinit .lldbinit"
240 for dotfile in $dotfiles
242 dotfile="$USER_HOME/$dotfile" &&
243 test -f "$dotfile" && cp "$dotfile" "$HOME" || :
244 done &&
246 TERM="$DEBUG_TERM" GIT_DEBUGGER="${GIT_DEBUGGER}" "$@" <&6 >&5 2>&7 &&
248 for dotfile in $dotfiles
250 rm -f "$HOME/$dotfile"
251 done
254 # Usage: test_ref_exists [options] <ref>
256 # -C <dir>:
257 # Run all git commands in directory <dir>
259 # This helper function checks whether a reference exists. Symrefs or object IDs
260 # will not be resolved. Can be used to check references with bad names.
261 test_ref_exists () {
262 local indir=
264 while test $# != 0
266 case "$1" in
268 indir="$2"
269 shift
272 break
274 esac
275 shift
276 done &&
278 indir=${indir:+"$indir"/} &&
280 if test "$#" != 1
281 then
282 BUG "expected exactly one reference"
283 fi &&
285 git ${indir:+ -C "$indir"} show-ref --exists "$1"
288 # Behaves the same as test_ref_exists, except that it checks for the absence of
289 # a reference. This is preferable to `! test_ref_exists` as this function is
290 # able to distinguish actually-missing references from other, generic errors.
291 test_ref_missing () {
292 test_ref_exists "$@"
293 case "$?" in
295 # This is the good case.
296 return 0
299 echo >&4 "test_ref_missing: reference exists"
300 return 1
303 echo >&4 "test_ref_missing: generic error"
304 return 1
306 esac
309 # Usage: test_commit [options] <message> [<file> [<contents> [<tag>]]]
310 # -C <dir>:
311 # Run all git commands in directory <dir>
312 # --notick
313 # Do not call test_tick before making a commit
314 # --append
315 # Use ">>" instead of ">" when writing "<contents>" to "<file>"
316 # --printf
317 # Use "printf" instead of "echo" when writing "<contents>" to
318 # "<file>", use this to write escape sequences such as "\0", a
319 # trailing "\n" won't be added automatically. This option
320 # supports nothing but the FORMAT of printf(1), i.e. no custom
321 # ARGUMENT(s).
322 # --signoff
323 # Invoke "git commit" with --signoff
324 # --author <author>
325 # Invoke "git commit" with --author <author>
326 # --no-tag
327 # Do not tag the resulting commit
328 # --annotate
329 # Create an annotated tag with "--annotate -m <message>". Calls
330 # test_tick between making the commit and tag, unless --notick
331 # is given.
333 # This will commit a file with the given contents and the given commit
334 # message, and tag the resulting commit with the given tag name.
336 # <file>, <contents>, and <tag> all default to <message>.
338 test_commit () {
339 local notick= &&
340 local echo=echo &&
341 local append= &&
342 local author= &&
343 local signoff= &&
344 local indir= &&
345 local tag=light &&
346 while test $# != 0
348 case "$1" in
349 --notick)
350 notick=yes
352 --printf)
353 echo=printf
355 --append)
356 append=yes
358 --author)
359 author="$2"
360 shift
362 --signoff)
363 signoff="$1"
365 --date)
366 notick=yes
367 GIT_COMMITTER_DATE="$2"
368 GIT_AUTHOR_DATE="$2"
369 shift
372 indir="$2"
373 shift
375 --no-tag)
376 tag=none
378 --annotate)
379 tag=annotate
382 break
384 esac
385 shift
386 done &&
387 indir=${indir:+"$indir"/} &&
388 local file=${2:-"$1.t"} &&
389 if test -n "$append"
390 then
391 $echo "${3-$1}" >>"$indir$file"
392 else
393 $echo "${3-$1}" >"$indir$file"
394 fi &&
395 git ${indir:+ -C "$indir"} add -- "$file" &&
396 if test -z "$notick"
397 then
398 test_tick
399 fi &&
400 git ${indir:+ -C "$indir"} commit \
401 ${author:+ --author "$author"} \
402 $signoff -m "$1" &&
403 case "$tag" in
404 none)
406 light)
407 git ${indir:+ -C "$indir"} tag "${4:-$1}"
409 annotate)
410 if test -z "$notick"
411 then
412 test_tick
413 fi &&
414 git ${indir:+ -C "$indir"} tag -a -m "$1" "${4:-$1}"
416 esac
419 # Call test_merge with the arguments "<message> <commit>", where <commit>
420 # can be a tag pointing to the commit-to-merge.
422 test_merge () {
423 label="$1" &&
424 shift &&
425 test_tick &&
426 git merge -m "$label" "$@" &&
427 git tag "$label"
430 # Efficiently create <nr> commits, each with a unique number (from 1 to <nr>
431 # by default) in the commit message.
433 # Usage: test_commit_bulk [options] <nr>
434 # -C <dir>:
435 # Run all git commands in directory <dir>
436 # --ref=<n>:
437 # ref on which to create commits (default: HEAD)
438 # --start=<n>:
439 # number commit messages from <n> (default: 1)
440 # --message=<msg>:
441 # use <msg> as the commit mesasge (default: "commit %s")
442 # --filename=<fn>:
443 # modify <fn> in each commit (default: %s.t)
444 # --contents=<string>:
445 # place <string> in each file (default: "content %s")
446 # --id=<string>:
447 # shorthand to use <string> and %s in message, filename, and contents
449 # The message, filename, and contents strings are evaluated by printf, with the
450 # first "%s" replaced by the current commit number. So you can do:
452 # test_commit_bulk --filename=file --contents="modification %s"
454 # to have every commit touch the same file, but with unique content.
456 test_commit_bulk () {
457 tmpfile=.bulk-commit.input
458 indir=.
459 ref=HEAD
461 message='commit %s'
462 filename='%s.t'
463 contents='content %s'
464 while test $# -gt 0
466 case "$1" in
468 indir=$2
469 shift
471 --ref=*)
472 ref=${1#--*=}
474 --start=*)
475 n=${1#--*=}
477 --message=*)
478 message=${1#--*=}
480 --filename=*)
481 filename=${1#--*=}
483 --contents=*)
484 contents=${1#--*=}
486 --id=*)
487 message="${1#--*=} %s"
488 filename="${1#--*=}-%s.t"
489 contents="${1#--*=} %s"
492 BUG "invalid test_commit_bulk option: $1"
495 break
497 esac
498 shift
499 done
500 total=$1
502 add_from=
503 if git -C "$indir" rev-parse --quiet --verify "$ref"
504 then
505 add_from=t
508 while test "$total" -gt 0
510 test_tick &&
511 echo "commit $ref"
512 printf 'author %s <%s> %s\n' \
513 "$GIT_AUTHOR_NAME" \
514 "$GIT_AUTHOR_EMAIL" \
515 "$GIT_AUTHOR_DATE"
516 printf 'committer %s <%s> %s\n' \
517 "$GIT_COMMITTER_NAME" \
518 "$GIT_COMMITTER_EMAIL" \
519 "$GIT_COMMITTER_DATE"
520 echo "data <<EOF"
521 printf "$message\n" $n
522 echo "EOF"
523 if test -n "$add_from"
524 then
525 echo "from $ref^0"
526 add_from=
528 printf "M 644 inline $filename\n" $n
529 echo "data <<EOF"
530 printf "$contents\n" $n
531 echo "EOF"
532 echo
533 n=$((n + 1))
534 total=$((total - 1))
535 done >"$tmpfile"
537 git -C "$indir" \
538 -c fastimport.unpacklimit=0 \
539 fast-import <"$tmpfile" || return 1
541 # This will be left in place on failure, which may aid debugging.
542 rm -f "$tmpfile"
544 # If we updated HEAD, then be nice and update the index and working
545 # tree, too.
546 if test "$ref" = "HEAD"
547 then
548 git -C "$indir" checkout -f HEAD || return 1
553 # This function helps systems where core.filemode=false is set.
554 # Use it instead of plain 'chmod +x' to set or unset the executable bit
555 # of a file in the working directory and add it to the index.
557 test_chmod () {
558 chmod "$@" &&
559 git update-index --add "--chmod=$@"
562 # Get the modebits from a file or directory, ignoring the setgid bit (g+s).
563 # This bit is inherited by subdirectories at their creation. So we remove it
564 # from the returning string to prevent callers from having to worry about the
565 # state of the bit in the test directory.
567 test_modebits () {
568 ls -ld "$1" | sed -e 's|^\(..........\).*|\1|' \
569 -e 's|^\(......\)S|\1-|' -e 's|^\(......\)s|\1x|'
572 # Unset a configuration variable, but don't fail if it doesn't exist.
573 test_unconfig () {
574 config_dir=
575 if test "$1" = -C
576 then
577 shift
578 config_dir=$1
579 shift
581 git ${config_dir:+-C "$config_dir"} config --unset-all "$@"
582 config_status=$?
583 case "$config_status" in
584 5) # ok, nothing to unset
585 config_status=0
587 esac
588 return $config_status
591 # Set git config, automatically unsetting it after the test is over.
592 test_config () {
593 config_dir=
594 if test "$1" = -C
595 then
596 shift
597 config_dir=$1
598 shift
601 # If --worktree is provided, use it to configure/unconfigure
602 is_worktree=
603 if test "$1" = --worktree
604 then
605 is_worktree=1
606 shift
609 test_when_finished "test_unconfig ${config_dir:+-C '$config_dir'} ${is_worktree:+--worktree} '$1'" &&
610 git ${config_dir:+-C "$config_dir"} config ${is_worktree:+--worktree} "$@"
613 test_config_global () {
614 test_when_finished "test_unconfig --global '$1'" &&
615 git config --global "$@"
618 write_script () {
620 echo "#!${2-"$SHELL_PATH"}" &&
622 } >"$1" &&
623 chmod +x "$1"
626 # Usage: test_hook [options] <hook-name> <<-\EOF
628 # -C <dir>:
629 # Run all git commands in directory <dir>
630 # --setup
631 # Setup a hook for subsequent tests, i.e. don't remove it in a
632 # "test_when_finished"
633 # --clobber
634 # Overwrite an existing <hook-name>, if it exists. Implies
635 # --setup (i.e. the "test_when_finished" is assumed to have been
636 # set up already).
637 # --disable
638 # Disable (chmod -x) an existing <hook-name>, which must exist.
639 # --remove
640 # Remove (rm -f) an existing <hook-name>, which must exist.
641 test_hook () {
642 setup= &&
643 clobber= &&
644 disable= &&
645 remove= &&
646 indir= &&
647 while test $# != 0
649 case "$1" in
651 indir="$2" &&
652 shift
654 --setup)
655 setup=t
657 --clobber)
658 clobber=t
660 --disable)
661 disable=t
663 --remove)
664 remove=t
667 BUG "invalid argument: $1"
670 break
672 esac &&
673 shift
674 done &&
676 git_dir=$(git -C "$indir" rev-parse --absolute-git-dir) &&
677 hook_dir="$git_dir/hooks" &&
678 hook_file="$hook_dir/$1" &&
679 if test -n "$disable$remove"
680 then
681 test_path_is_file "$hook_file" &&
682 if test -n "$disable"
683 then
684 chmod -x "$hook_file"
685 elif test -n "$remove"
686 then
687 rm -f "$hook_file"
688 fi &&
689 return 0
690 fi &&
691 if test -z "$clobber"
692 then
693 test_path_is_missing "$hook_file"
694 fi &&
695 if test -z "$setup$clobber"
696 then
697 test_when_finished "rm \"$hook_file\""
698 fi &&
699 write_script "$hook_file"
702 # Use test_set_prereq to tell that a particular prerequisite is available.
703 # The prerequisite can later be checked for in two ways:
705 # - Explicitly using test_have_prereq.
707 # - Implicitly by specifying the prerequisite tag in the calls to
708 # test_expect_{success,failure}
710 # The single parameter is the prerequisite tag (a simple word, in all
711 # capital letters by convention).
713 test_unset_prereq () {
714 ! test_have_prereq "$1" ||
715 satisfied_prereq="${satisfied_prereq% $1 *} ${satisfied_prereq#* $1 }"
718 test_set_prereq () {
719 if test -n "$GIT_TEST_FAIL_PREREQS_INTERNAL"
720 then
721 case "$1" in
722 # The "!" case is handled below with
723 # test_unset_prereq()
726 # List of things we can't easily pretend to not support
727 SYMLINKS)
729 # Inspecting whether GIT_TEST_FAIL_PREREQS is on
730 # should be unaffected.
731 FAIL_PREREQS)
734 return
735 esac
738 case "$1" in
740 test_unset_prereq "${1#!}"
743 satisfied_prereq="$satisfied_prereq$1 "
745 esac
747 satisfied_prereq=" "
748 lazily_testable_prereq= lazily_tested_prereq=
750 # Usage: test_lazy_prereq PREREQ 'script'
751 test_lazy_prereq () {
752 lazily_testable_prereq="$lazily_testable_prereq$1 "
753 eval test_prereq_lazily_$1=\$2
756 test_run_lazy_prereq_ () {
757 script='
758 mkdir -p "$TRASH_DIRECTORY/prereq-test-dir-'"$1"'" &&
760 cd "$TRASH_DIRECTORY/prereq-test-dir-'"$1"'" &&'"$2"'
762 say >&3 "checking prerequisite: $1"
763 say >&3 "$script"
764 test_eval_ "$script"
765 eval_ret=$?
766 rm -rf "$TRASH_DIRECTORY/prereq-test-dir-$1"
767 if test "$eval_ret" = 0; then
768 say >&3 "prerequisite $1 ok"
769 else
770 say >&3 "prerequisite $1 not satisfied"
772 return $eval_ret
775 test_have_prereq () {
776 # prerequisites can be concatenated with ','
777 save_IFS=$IFS
778 IFS=,
779 set -- $*
780 IFS=$save_IFS
782 total_prereq=0
783 ok_prereq=0
784 missing_prereq=
786 for prerequisite
788 case "$prerequisite" in
790 negative_prereq=t
791 prerequisite=${prerequisite#!}
794 negative_prereq=
795 esac
797 case " $lazily_tested_prereq " in
798 *" $prerequisite "*)
801 case " $lazily_testable_prereq " in
802 *" $prerequisite "*)
803 eval "script=\$test_prereq_lazily_$prerequisite" &&
804 if test_run_lazy_prereq_ "$prerequisite" "$script"
805 then
806 test_set_prereq $prerequisite
808 lazily_tested_prereq="$lazily_tested_prereq$prerequisite "
809 esac
811 esac
813 total_prereq=$(($total_prereq + 1))
814 case "$satisfied_prereq" in
815 *" $prerequisite "*)
816 satisfied_this_prereq=t
819 satisfied_this_prereq=
820 esac
822 case "$satisfied_this_prereq,$negative_prereq" in
823 t,|,t)
824 ok_prereq=$(($ok_prereq + 1))
827 # Keep a list of missing prerequisites; restore
828 # the negative marker if necessary.
829 prerequisite=${negative_prereq:+!}$prerequisite
831 # Abort if this prereq was marked as required
832 if test -n "$GIT_TEST_REQUIRE_PREREQ"
833 then
834 case " $GIT_TEST_REQUIRE_PREREQ " in
835 *" $prerequisite "*)
836 BAIL_OUT "required prereq $prerequisite failed"
838 esac
841 if test -z "$missing_prereq"
842 then
843 missing_prereq=$prerequisite
844 else
845 missing_prereq="$prerequisite,$missing_prereq"
847 esac
848 done
850 test $total_prereq = $ok_prereq
853 test_declared_prereq () {
854 case ",$test_prereq," in
855 *,$1,*)
856 return 0
858 esac
859 return 1
862 test_verify_prereq () {
863 test -z "$test_prereq" ||
864 expr >/dev/null "$test_prereq" : '[A-Z0-9_,!]*$' ||
865 BUG "'$test_prereq' does not look like a prereq"
868 test_expect_failure () {
869 test_start_ "$@"
870 test "$#" = 3 && { test_prereq=$1; shift; } || test_prereq=
871 test "$#" = 2 ||
872 BUG "not 2 or 3 parameters to test-expect-failure"
873 test_verify_prereq
874 export test_prereq
875 if ! test_skip "$@"
876 then
877 test -n "$test_skip_test_preamble" ||
878 say >&3 "checking known breakage of $TEST_NUMBER.$test_count '$1': $2"
879 if test_run_ "$2" expecting_failure
880 then
881 test_known_broken_ok_ "$1"
882 else
883 test_known_broken_failure_ "$1"
886 test_finish_
889 test_expect_success () {
890 test_start_ "$@"
891 test "$#" = 3 && { test_prereq=$1; shift; } || test_prereq=
892 test "$#" = 2 ||
893 BUG "not 2 or 3 parameters to test-expect-success"
894 test_verify_prereq
895 export test_prereq
896 if ! test_skip "$@"
897 then
898 test -n "$test_skip_test_preamble" ||
899 say >&3 "expecting success of $TEST_NUMBER.$test_count '$1': $2"
900 if test_run_ "$2"
901 then
902 test_ok_ "$1"
903 else
904 test_failure_ "$@"
907 test_finish_
910 # debugging-friendly alternatives to "test [-f|-d|-e]"
911 # The commands test the existence or non-existence of $1
912 test_path_is_file () {
913 test "$#" -ne 1 && BUG "1 param"
914 if ! test -f "$1"
915 then
916 echo "File $1 doesn't exist"
917 false
921 test_path_is_file_not_symlink () {
922 test "$#" -ne 1 && BUG "1 param"
923 test_path_is_file "$1" &&
924 if test -h "$1"
925 then
926 echo "$1 shouldn't be a symbolic link"
927 false
931 test_path_is_dir () {
932 test "$#" -ne 1 && BUG "1 param"
933 if ! test -d "$1"
934 then
935 echo "Directory $1 doesn't exist"
936 false
940 test_path_is_dir_not_symlink () {
941 test "$#" -ne 1 && BUG "1 param"
942 test_path_is_dir "$1" &&
943 if test -h "$1"
944 then
945 echo "$1 shouldn't be a symbolic link"
946 false
950 test_path_exists () {
951 test "$#" -ne 1 && BUG "1 param"
952 if ! test -e "$1"
953 then
954 echo "Path $1 doesn't exist"
955 false
959 test_path_is_symlink () {
960 test "$#" -ne 1 && BUG "1 param"
961 if ! test -h "$1"
962 then
963 echo "Symbolic link $1 doesn't exist"
964 false
968 test_path_is_executable () {
969 test "$#" -ne 1 && BUG "1 param"
970 if ! test -x "$1"
971 then
972 echo "$1 is not executable"
973 false
977 # Check if the directory exists and is empty as expected, barf otherwise.
978 test_dir_is_empty () {
979 test "$#" -ne 1 && BUG "1 param"
980 test_path_is_dir "$1" &&
981 if test -n "$(ls -a1 "$1" | grep -E -v '^\.\.?$')"
982 then
983 echo "Directory '$1' is not empty, it contains:"
984 ls -la "$1"
985 return 1
989 # Check if the file exists and has a size greater than zero
990 test_file_not_empty () {
991 test "$#" = 2 && BUG "2 param"
992 if ! test -s "$1"
993 then
994 echo "'$1' is not a non-empty file."
995 false
999 test_path_is_missing () {
1000 test "$#" -ne 1 && BUG "1 param"
1001 if test -e "$1"
1002 then
1003 echo "Path exists:"
1004 ls -ld "$1"
1005 false
1009 # test_line_count checks that a file has the number of lines it
1010 # ought to. For example:
1012 # test_expect_success 'produce exactly one line of output' '
1013 # do something >output &&
1014 # test_line_count = 1 output
1017 # is like "test $(wc -l <output) = 1" except that it passes the
1018 # output through when the number of lines is wrong.
1020 test_line_count () {
1021 if test $# != 3
1022 then
1023 BUG "not 3 parameters to test_line_count"
1024 elif ! test $(wc -l <"$3") "$1" "$2"
1025 then
1026 echo "test_line_count: line count for $3 !$1 $2"
1027 cat "$3"
1028 return 1
1032 # SYNOPSIS:
1033 # test_stdout_line_count <bin-ops> <value> <cmd> [<args>...]
1035 # test_stdout_line_count checks that the output of a command has the number
1036 # of lines it ought to. For example:
1038 # test_stdout_line_count = 3 git ls-files -u
1039 # test_stdout_line_count -gt 10 ls
1040 test_stdout_line_count () {
1041 local ops val trashdir &&
1042 if test "$#" -le 3
1043 then
1044 BUG "expect 3 or more arguments"
1045 fi &&
1046 ops="$1" &&
1047 val="$2" &&
1048 shift 2 &&
1049 if ! trashdir="$(git rev-parse --git-dir)/trash"; then
1050 BUG "expect to be run inside a worktree"
1051 fi &&
1052 mkdir -p "$trashdir" &&
1053 "$@" >"$trashdir/output" &&
1054 test_line_count "$ops" "$val" "$trashdir/output"
1058 test_file_size () {
1059 test "$#" -ne 1 && BUG "1 param"
1060 test-tool path-utils file-size "$1"
1063 # Returns success if a comma separated string of keywords ($1) contains a
1064 # given keyword ($2).
1065 # Examples:
1066 # `list_contains "foo,bar" bar` returns 0
1067 # `list_contains "foo" bar` returns 1
1069 list_contains () {
1070 case ",$1," in
1071 *,$2,*)
1072 return 0
1074 esac
1075 return 1
1078 # Returns success if the arguments indicate that a command should be
1079 # accepted by test_must_fail(). If the command is run with env, the env
1080 # and its corresponding variable settings will be stripped before we
1081 # test the command being run.
1082 test_must_fail_acceptable () {
1083 if test "$1" = "env"
1084 then
1085 shift
1086 while test $# -gt 0
1088 case "$1" in
1089 *?=*)
1090 shift
1093 break
1095 esac
1096 done
1099 case "$1" in
1100 git|__git*|scalar|test-tool|test_terminal)
1101 return 0
1104 return 1
1106 esac
1109 # This is not among top-level (test_expect_success | test_expect_failure)
1110 # but is a prefix that can be used in the test script, like:
1112 # test_expect_success 'complain and die' '
1113 # do something &&
1114 # do something else &&
1115 # test_must_fail git checkout ../outerspace
1118 # Writing this as "! git checkout ../outerspace" is wrong, because
1119 # the failure could be due to a segv. We want a controlled failure.
1121 # Accepts the following options:
1123 # ok=<signal-name>[,<...>]:
1124 # Don't treat an exit caused by the given signal as error.
1125 # Multiple signals can be specified as a comma separated list.
1126 # Currently recognized signal names are: sigpipe, success.
1127 # (Don't use 'success', use 'test_might_fail' instead.)
1129 # Do not use this to run anything but "git" and other specific testable
1130 # commands (see test_must_fail_acceptable()). We are not in the
1131 # business of vetting system supplied commands -- in other words, this
1132 # is wrong:
1134 # test_must_fail grep pattern output
1136 # Instead use '!':
1138 # ! grep pattern output
1140 test_must_fail () {
1141 case "$1" in
1142 ok=*)
1143 _test_ok=${1#ok=}
1144 shift
1147 _test_ok=
1149 esac
1150 if ! test_must_fail_acceptable "$@"
1151 then
1152 echo >&7 "test_must_fail: only 'git' is allowed: $*"
1153 return 1
1155 "$@" 2>&7
1156 exit_code=$?
1157 if test $exit_code -eq 0 && ! list_contains "$_test_ok" success
1158 then
1159 echo >&4 "test_must_fail: command succeeded: $*"
1160 return 1
1161 elif test_match_signal 13 $exit_code && list_contains "$_test_ok" sigpipe
1162 then
1163 return 0
1164 elif test $exit_code -gt 129 && test $exit_code -le 192
1165 then
1166 echo >&4 "test_must_fail: died by signal $(($exit_code - 128)): $*"
1167 return 1
1168 elif test $exit_code -eq 127
1169 then
1170 echo >&4 "test_must_fail: command not found: $*"
1171 return 1
1172 elif test $exit_code -eq 126
1173 then
1174 echo >&4 "test_must_fail: valgrind error: $*"
1175 return 1
1177 return 0
1178 } 7>&2 2>&4
1180 # Similar to test_must_fail, but tolerates success, too. This is
1181 # meant to be used in contexts like:
1183 # test_expect_success 'some command works without configuration' '
1184 # test_might_fail git config --unset all.configuration &&
1185 # do something
1188 # Writing "git config --unset all.configuration || :" would be wrong,
1189 # because we want to notice if it fails due to segv.
1191 # Accepts the same options as test_must_fail.
1193 test_might_fail () {
1194 test_must_fail ok=success "$@" 2>&7
1195 } 7>&2 2>&4
1197 # Similar to test_must_fail and test_might_fail, but check that a
1198 # given command exited with a given exit code. Meant to be used as:
1200 # test_expect_success 'Merge with d/f conflicts' '
1201 # test_expect_code 1 git merge "merge msg" B master
1204 test_expect_code () {
1205 want_code=$1
1206 shift
1207 "$@" 2>&7
1208 exit_code=$?
1209 if test $exit_code = $want_code
1210 then
1211 return 0
1214 echo >&4 "test_expect_code: command exited with $exit_code, we wanted $want_code $*"
1215 return 1
1216 } 7>&2 2>&4
1218 # test_cmp is a helper function to compare actual and expected output.
1219 # You can use it like:
1221 # test_expect_success 'foo works' '
1222 # echo expected >expected &&
1223 # foo >actual &&
1224 # test_cmp expected actual
1227 # This could be written as either "cmp" or "diff -u", but:
1228 # - cmp's output is not nearly as easy to read as diff -u
1229 # - not all diff versions understand "-u"
1231 test_cmp () {
1232 test "$#" -ne 2 && BUG "2 param"
1233 eval "$GIT_TEST_CMP" '"$@"'
1236 # Check that the given config key has the expected value.
1238 # test_cmp_config [-C <dir>] <expected-value>
1239 # [<git-config-options>...] <config-key>
1241 # for example to check that the value of core.bar is foo
1243 # test_cmp_config foo core.bar
1245 test_cmp_config () {
1246 local GD &&
1247 if test "$1" = "-C"
1248 then
1249 shift &&
1250 GD="-C $1" &&
1251 shift
1252 fi &&
1253 printf "%s\n" "$1" >expect.config &&
1254 shift &&
1255 git $GD config "$@" >actual.config &&
1256 test_cmp expect.config actual.config
1259 # test_cmp_bin - helper to compare binary files
1261 test_cmp_bin () {
1262 test "$#" -ne 2 && BUG "2 param"
1263 cmp "$@"
1266 # Deprecated - do not use this in new code
1267 test_i18ngrep () {
1268 test_grep "$@"
1271 test_grep () {
1272 eval "last_arg=\${$#}"
1274 test -f "$last_arg" ||
1275 BUG "test_grep requires a file to read as the last parameter"
1277 if test $# -lt 2 ||
1278 { test "x!" = "x$1" && test $# -lt 3 ; }
1279 then
1280 BUG "too few parameters to test_i18ngrep"
1283 if test "x!" = "x$1"
1284 then
1285 shift
1286 ! grep "$@" && return 0
1288 echo >&4 "error: '! grep $@' did find a match in:"
1289 else
1290 grep "$@" && return 0
1292 echo >&4 "error: 'grep $@' didn't find a match in:"
1295 if test -s "$last_arg"
1296 then
1297 cat >&4 "$last_arg"
1298 else
1299 echo >&4 "<File '$last_arg' is empty>"
1302 return 1
1305 # Check if the file expected to be empty is indeed empty, and barfs
1306 # otherwise.
1308 test_must_be_empty () {
1309 test "$#" -ne 1 && BUG "1 param"
1310 test_path_is_file "$1" &&
1311 if test -s "$1"
1312 then
1313 echo "'$1' is not empty, it contains:"
1314 cat "$1"
1315 return 1
1319 # Tests that its two parameters refer to the same revision, or if '!' is
1320 # provided first, that its other two parameters refer to different
1321 # revisions.
1322 test_cmp_rev () {
1323 local op='=' wrong_result=different
1325 if test $# -ge 1 && test "x$1" = 'x!'
1326 then
1327 op='!='
1328 wrong_result='the same'
1329 shift
1331 if test $# != 2
1332 then
1333 BUG "test_cmp_rev requires two revisions, but got $#"
1334 else
1335 local r1 r2
1336 r1=$(git rev-parse --verify "$1") &&
1337 r2=$(git rev-parse --verify "$2") || return 1
1339 if ! test "$r1" "$op" "$r2"
1340 then
1341 cat >&4 <<-EOF
1342 error: two revisions point to $wrong_result objects:
1343 '$1': $r1
1344 '$2': $r2
1346 return 1
1351 # Tests that a commit message matches the expected text
1353 # Usage: test_commit_message <rev> [-m <msg> | <file>]
1355 # When using "-m" <msg> will have a line feed appended. If the second
1356 # argument is omitted then the expected message is read from stdin.
1358 test_commit_message () {
1359 local msg_file=expect.msg
1361 case $# in
1363 if test "$2" = "-m"
1364 then
1365 printf "%s\n" "$3" >"$msg_file"
1366 else
1367 BUG "Usage: test_commit_message <rev> [-m <message> | <file>]"
1371 msg_file="$2"
1374 cat >"$msg_file"
1377 BUG "Usage: test_commit_message <rev> [-m <message> | <file>]"
1379 esac
1380 git show --no-patch --pretty=format:%B "$1" -- >actual.msg &&
1381 test_cmp "$msg_file" actual.msg
1384 # Compare paths respecting core.ignoreCase
1385 test_cmp_fspath () {
1386 if test "x$1" = "x$2"
1387 then
1388 return 0
1391 if test true != "$(git config --get --type=bool core.ignorecase)"
1392 then
1393 return 1
1396 test "x$(echo "$1" | tr A-Z a-z)" = "x$(echo "$2" | tr A-Z a-z)"
1399 # Print a sequence of integers in increasing order, either with
1400 # two arguments (start and end):
1402 # test_seq 1 5 -- outputs 1 2 3 4 5 one line at a time
1404 # or with one argument (end), in which case it starts counting
1405 # from 1.
1407 test_seq () {
1408 case $# in
1409 1) set 1 "$@" ;;
1410 2) ;;
1411 *) BUG "not 1 or 2 parameters to test_seq" ;;
1412 esac
1413 test_seq_counter__=$1
1414 while test "$test_seq_counter__" -le "$2"
1416 echo "$test_seq_counter__"
1417 test_seq_counter__=$(( $test_seq_counter__ + 1 ))
1418 done
1421 # This function can be used to schedule some commands to be run
1422 # unconditionally at the end of the test to restore sanity:
1424 # test_expect_success 'test core.capslock' '
1425 # git config core.capslock true &&
1426 # test_when_finished "git config --unset core.capslock" &&
1427 # hello world
1430 # That would be roughly equivalent to
1432 # test_expect_success 'test core.capslock' '
1433 # git config core.capslock true &&
1434 # hello world
1435 # git config --unset core.capslock
1438 # except that the greeting and config --unset must both succeed for
1439 # the test to pass.
1441 # Note that under --immediate mode, no clean-up is done to help diagnose
1442 # what went wrong.
1444 test_when_finished () {
1445 # We cannot detect when we are in a subshell in general, but by
1446 # doing so on Bash is better than nothing (the test will
1447 # silently pass on other shells).
1448 test "${BASH_SUBSHELL-0}" = 0 ||
1449 BUG "test_when_finished does nothing in a subshell"
1450 test_cleanup="{ $*
1451 } && (exit \"\$eval_ret\"); eval_ret=\$?; $test_cleanup"
1454 # This function can be used to schedule some commands to be run
1455 # unconditionally at the end of the test script, e.g. to stop a daemon:
1457 # test_expect_success 'test git daemon' '
1458 # git daemon &
1459 # daemon_pid=$! &&
1460 # test_atexit 'kill $daemon_pid' &&
1461 # hello world
1464 # The commands will be executed before the trash directory is removed,
1465 # i.e. the atexit commands will still be able to access any pidfiles or
1466 # socket files.
1468 # Note that these commands will be run even when a test script run
1469 # with '--immediate' fails. Be careful with your atexit commands to
1470 # minimize any changes to the failed state.
1472 test_atexit () {
1473 # We cannot detect when we are in a subshell in general, but by
1474 # doing so on Bash is better than nothing (the test will
1475 # silently pass on other shells).
1476 test "${BASH_SUBSHELL-0}" = 0 ||
1477 BUG "test_atexit does nothing in a subshell"
1478 test_atexit_cleanup="{ $*
1479 } && (exit \"\$eval_ret\"); eval_ret=\$?; $test_atexit_cleanup"
1482 # Deprecated wrapper for "git init", use "git init" directly instead
1483 # Usage: test_create_repo <directory>
1484 test_create_repo () {
1485 git init "$@"
1488 # This function helps on symlink challenged file systems when it is not
1489 # important that the file system entry is a symbolic link.
1490 # Use test_ln_s_add instead of "ln -s x y && git add y" to add a
1491 # symbolic link entry y to the index.
1493 test_ln_s_add () {
1494 if test_have_prereq SYMLINKS
1495 then
1496 ln -s "$1" "$2" &&
1497 git update-index --add "$2"
1498 else
1499 printf '%s' "$1" >"$2" &&
1500 ln_s_obj=$(git hash-object -w "$2") &&
1501 git update-index --add --cacheinfo 120000 $ln_s_obj "$2" &&
1502 # pick up stat info from the file
1503 git update-index "$2"
1507 # This function writes out its parameters, one per line
1508 test_write_lines () {
1509 printf "%s\n" "$@"
1512 perl () {
1513 command "$PERL_PATH" "$@" 2>&7
1514 } 7>&2 2>&4
1516 # Given the name of an environment variable with a bool value, normalize
1517 # its value to a 0 (true) or 1 (false or empty string) return code.
1519 # test_bool_env GIT_TEST_HTTPD <default-value>
1521 # Return with code corresponding to the given default value if the variable
1522 # is unset.
1523 # Abort the test script if either the value of the variable or the default
1524 # are not valid bool values.
1526 test_bool_env () {
1527 if test $# != 2
1528 then
1529 BUG "test_bool_env requires two parameters (variable name and default value)"
1532 test-tool env-helper --type=bool --default="$2" --exit-code "$1"
1533 ret=$?
1534 case $ret in
1535 0|1) # unset or valid bool value
1537 *) # invalid bool value or something unexpected
1538 error >&7 "test_bool_env requires bool values both for \$$1 and for the default fallback"
1540 esac
1541 return $ret
1544 # Exit the test suite, either by skipping all remaining tests or by
1545 # exiting with an error. If our prerequisite variable $1 falls back
1546 # on a default assume we were opportunistically trying to set up some
1547 # tests and we skip. If it is explicitly "true", then we report a failure.
1549 # The error/skip message should be given by $2.
1551 test_skip_or_die () {
1552 if ! test_bool_env "$1" false
1553 then
1554 skip_all=$2
1555 test_done
1557 error "$2"
1560 # Like "env FOO=BAR some-program", but run inside a subshell, which means
1561 # it also works for shell functions (though those functions cannot impact
1562 # the environment outside of the test_env invocation).
1563 test_env () {
1565 while test $# -gt 0
1567 case "$1" in
1568 *=*)
1569 eval "${1%%=*}=\${1#*=}"
1570 eval "export ${1%%=*}"
1571 shift
1574 "$@" 2>&7
1575 exit
1577 esac
1578 done
1580 } 7>&2 2>&4
1582 # Returns true if the numeric exit code in "$2" represents the expected signal
1583 # in "$1". Signals should be given numerically.
1584 test_match_signal () {
1585 if test "$2" = "$((128 + $1))"
1586 then
1587 # POSIX
1588 return 0
1589 elif test "$2" = "$((256 + $1))"
1590 then
1591 # ksh
1592 return 0
1594 return 1
1597 # Read up to "$1" bytes (or to EOF) from stdin and write them to stdout.
1598 test_copy_bytes () {
1599 perl -e '
1600 my $len = $ARGV[1];
1601 while ($len > 0) {
1602 my $s;
1603 my $nread = sysread(STDIN, $s, $len);
1604 die "cannot read: $!" unless defined($nread);
1605 last unless $nread;
1606 print $s;
1607 $len -= $nread;
1609 ' - "$1"
1612 # run "$@" inside a non-git directory
1613 nongit () {
1614 test -d non-repo ||
1615 mkdir non-repo ||
1616 return 1
1619 GIT_CEILING_DIRECTORIES=$(pwd) &&
1620 export GIT_CEILING_DIRECTORIES &&
1621 cd non-repo &&
1622 "$@" 2>&7
1624 } 7>&2 2>&4
1626 # These functions are historical wrappers around "test-tool pkt-line"
1627 # for older tests. Use "test-tool pkt-line" itself in new tests.
1628 packetize () {
1629 if test $# -gt 0
1630 then
1631 packet="$*"
1632 printf '%04x%s' "$((4 + ${#packet}))" "$packet"
1633 else
1634 test-tool pkt-line pack
1638 packetize_raw () {
1639 test-tool pkt-line pack-raw-stdin
1642 depacketize () {
1643 test-tool pkt-line unpack
1646 # Converts base-16 data into base-8. The output is given as a sequence of
1647 # escaped octals, suitable for consumption by 'printf'.
1648 hex2oct () {
1649 perl -ne 'printf "\\%03o", hex for /../g'
1652 # Set the hash algorithm in use to $1. Only useful when testing the testsuite.
1653 test_set_hash () {
1654 test_hash_algo="$1"
1657 # Detect the hash algorithm in use.
1658 test_detect_hash () {
1659 test_hash_algo="${GIT_TEST_DEFAULT_HASH:-sha1}"
1662 # Load common hash metadata and common placeholder object IDs for use with
1663 # test_oid.
1664 test_oid_init () {
1665 test -n "$test_hash_algo" || test_detect_hash &&
1666 test_oid_cache <"$TEST_DIRECTORY/oid-info/hash-info" &&
1667 test_oid_cache <"$TEST_DIRECTORY/oid-info/oid"
1670 # Load key-value pairs from stdin suitable for use with test_oid. Blank lines
1671 # and lines starting with "#" are ignored. Keys must be shell identifier
1672 # characters.
1674 # Examples:
1675 # rawsz sha1:20
1676 # rawsz sha256:32
1677 test_oid_cache () {
1678 local tag rest k v &&
1680 { test -n "$test_hash_algo" || test_detect_hash; } &&
1681 while read tag rest
1683 case $tag in
1684 \#*)
1685 continue;;
1687 # non-empty
1690 # blank line
1691 continue;;
1692 esac &&
1694 k="${rest%:*}" &&
1695 v="${rest#*:}" &&
1697 if ! expr "$k" : '[a-z0-9][a-z0-9]*$' >/dev/null
1698 then
1699 BUG 'bad hash algorithm'
1700 fi &&
1701 eval "test_oid_${k}_$tag=\"\$v\""
1702 done
1705 # Look up a per-hash value based on a key ($1). The value must have been loaded
1706 # by test_oid_init or test_oid_cache.
1707 test_oid () {
1708 local algo="${test_hash_algo}" &&
1710 case "$1" in
1711 --hash=*)
1712 algo="${1#--hash=}" &&
1713 shift;;
1716 esac &&
1718 local var="test_oid_${algo}_$1" &&
1720 # If the variable is unset, we must be missing an entry for this
1721 # key-hash pair, so exit with an error.
1722 if eval "test -z \"\${$var+set}\""
1723 then
1724 BUG "undefined key '$1'"
1725 fi &&
1726 eval "printf '%s\n' \"\${$var}\""
1729 # Insert a slash into an object ID so it can be used to reference a location
1730 # under ".git/objects". For example, "deadbeef..." becomes "de/adbeef..".
1731 test_oid_to_path () {
1732 local basename=${1#??}
1733 echo "${1%$basename}/$basename"
1736 # Parse oids from git ls-files --staged output
1737 test_parse_ls_files_stage_oids () {
1738 awk '{print $2}' -
1741 # Parse oids from git ls-tree output
1742 test_parse_ls_tree_oids () {
1743 awk '{print $3}' -
1746 # Choose a port number based on the test script's number and store it in
1747 # the given variable name, unless that variable already contains a number.
1748 test_set_port () {
1749 local var=$1 port
1751 if test $# -ne 1 || test -z "$var"
1752 then
1753 BUG "test_set_port requires a variable name"
1756 eval port=\$$var
1757 case "$port" in
1759 # No port is set in the given env var, use the test
1760 # number as port number instead.
1761 # Remove not only the leading 't', but all leading zeros
1762 # as well, so the arithmetic below won't (mis)interpret
1763 # a test number like '0123' as an octal value.
1764 port=${this_test#${this_test%%[1-9]*}}
1765 if test "${port:-0}" -lt 1024
1766 then
1767 # root-only port, use a larger one instead.
1768 port=$(($port + 10000))
1771 *[!0-9]*|0*)
1772 error >&7 "invalid port number: $port"
1775 # The user has specified the port.
1777 esac
1779 # Make sure that parallel '--stress' test jobs get different
1780 # ports.
1781 port=$(($port + ${GIT_TEST_STRESS_JOB_NR:-0}))
1782 eval $var=$port
1785 # Tests for the hidden file attribute on Windows
1786 test_path_is_hidden () {
1787 test_have_prereq MINGW ||
1788 BUG "test_path_is_hidden can only be used on Windows"
1790 # Use the output of `attrib`, ignore the absolute path
1791 case "$("$SYSTEMROOT"/system32/attrib "$1")" in *H*?:*) return 0;; esac
1792 return 1
1795 # Poor man's URI escaping. Good enough for the test suite whose trash
1796 # directory has a space in it. See 93c3fcbe4d4 (git-svn: attempt to
1797 # mimic SVN 1.7 URL canonicalization, 2012-07-28) for prior art.
1798 test_uri_escape() {
1799 sed 's/ /%20/g'
1802 # Check that the given command was invoked as part of the
1803 # trace2-format trace on stdin.
1805 # test_subcommand [!] <command> <args>... < <trace>
1807 # For example, to look for an invocation of "git upload-pack
1808 # /path/to/repo"
1810 # GIT_TRACE2_EVENT=event.log git fetch ... &&
1811 # test_subcommand git upload-pack "$PATH" <event.log
1813 # If the first parameter passed is !, this instead checks that
1814 # the given command was not called.
1816 test_subcommand () {
1817 local negate=
1818 if test "$1" = "!"
1819 then
1820 negate=t
1821 shift
1824 local expr=$(printf '"%s",' "$@")
1825 expr="${expr%,}"
1827 if test -n "$negate"
1828 then
1829 ! grep "\[$expr\]"
1830 else
1831 grep "\[$expr\]"
1835 # Check that the given command was invoked as part of the
1836 # trace2-format trace on stdin.
1838 # test_region [!] <category> <label> git <command> <args>...
1840 # For example, to look for trace2_region_enter("index", "do_read_index", repo)
1841 # in an invocation of "git checkout HEAD~1", run
1843 # GIT_TRACE2_EVENT="$(pwd)/trace.txt" GIT_TRACE2_EVENT_NESTING=10 \
1844 # git checkout HEAD~1 &&
1845 # test_region index do_read_index <trace.txt
1847 # If the first parameter passed is !, this instead checks that
1848 # the given region was not entered.
1850 test_region () {
1851 local expect_exit=0
1852 if test "$1" = "!"
1853 then
1854 expect_exit=1
1855 shift
1858 grep -e '"region_enter".*"category":"'"$1"'","label":"'"$2"\" "$3"
1859 exitcode=$?
1861 if test $exitcode != $expect_exit
1862 then
1863 return 1
1866 grep -e '"region_leave".*"category":"'"$1"'","label":"'"$2"\" "$3"
1867 exitcode=$?
1869 if test $exitcode != $expect_exit
1870 then
1871 return 1
1874 return 0
1877 # Given a GIT_TRACE2_EVENT log over stdin, writes to stdout a list of URLs
1878 # sent to git-remote-https child processes.
1879 test_remote_https_urls() {
1880 grep -e '"event":"child_start".*"argv":\["git-remote-https",".*"\]' |
1881 sed -e 's/{"event":"child_start".*"argv":\["git-remote-https","//g' \
1882 -e 's/"\]}//g'
1885 # Print the destination of symlink(s) provided as arguments. Basically
1886 # the same as the readlink command, but it's not available everywhere.
1887 test_readlink () {
1888 perl -le 'print readlink($_) for @ARGV' "$@"
1891 # Set mtime to a fixed "magic" timestamp in mid February 2009, before we
1892 # run an operation that may or may not touch the file. If the file was
1893 # touched, its timestamp will not accidentally have such an old timestamp,
1894 # as long as your filesystem clock is reasonably correct. To verify the
1895 # timestamp, follow up with test_is_magic_mtime.
1897 # An optional increment to the magic timestamp may be specified as second
1898 # argument.
1899 test_set_magic_mtime () {
1900 local inc=${2:-0} &&
1901 local mtime=$((1234567890 + $inc)) &&
1902 test-tool chmtime =$mtime "$1" &&
1903 test_is_magic_mtime "$1" $inc
1906 # Test whether the given file has the "magic" mtime set. This is meant to
1907 # be used in combination with test_set_magic_mtime.
1909 # An optional increment to the magic timestamp may be specified as second
1910 # argument. Usually, this should be the same increment which was used for
1911 # the associated test_set_magic_mtime.
1912 test_is_magic_mtime () {
1913 local inc=${2:-0} &&
1914 local mtime=$((1234567890 + $inc)) &&
1915 echo $mtime >.git/test-mtime-expect &&
1916 test-tool chmtime --get "$1" >.git/test-mtime-actual &&
1917 test_cmp .git/test-mtime-expect .git/test-mtime-actual
1918 local ret=$?
1919 rm -f .git/test-mtime-expect
1920 rm -f .git/test-mtime-actual
1921 return $ret
1924 # Given two filenames, parse both using 'git config --list --file'
1925 # and compare the sorted output of those commands. Useful when
1926 # wanting to ignore whitespace differences and sorting concerns.
1927 test_cmp_config_output () {
1928 git config --list --file="$1" >config-expect &&
1929 git config --list --file="$2" >config-actual &&
1930 sort config-expect >sorted-expect &&
1931 sort config-actual >sorted-actual &&
1932 test_cmp sorted-expect sorted-actual
1935 # Given a filename, extract its trailing hash as a hex string
1936 test_trailing_hash () {
1937 local file="$1" &&
1938 tail -c $(test_oid rawsz) "$file" |
1939 test-tool hexdump |
1940 sed "s/ //g"