]> git.ipfire.org Git - thirdparty/git.git/blame - t/test-lib-functions.sh
tests: make GIT_TEST_FAIL_PREREQS a boolean
[thirdparty/git.git] / t / test-lib-functions.sh
CommitLineData
c74c7203
JN
1# Library of functions shared by all tests scripts, included by
2# test-lib.sh.
12a29b1a
TR
3#
4# Copyright (c) 2005 Junio C Hamano
5#
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.
10#
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.
15#
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/ .
18
19# The semantics of the editor variables are that of invoking
20# sh -c "$EDITOR \"$@\"" files ...
21#
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.
25#
26# In particular, quoting isn't enough, as the path may contain the same quote
27# that we're using.
28test_set_editor () {
29 FAKE_EDITOR="$1"
30 export FAKE_EDITOR
31 EDITOR='"$FAKE_EDITOR"'
32 export EDITOR
33}
34
5d9fc888
TG
35test_set_index_version () {
36 GIT_INDEX_VERSION="$1"
37 export GIT_INDEX_VERSION
38}
39
12a29b1a
TR
40test_decode_color () {
41 awk '
42 function name(n) {
43 if (n == 0) return "RESET";
44 if (n == 1) return "BOLD";
991eb4fc
SB
45 if (n == 2) return "FAINT";
46 if (n == 3) return "ITALIC";
097b681b 47 if (n == 7) return "REVERSE";
12a29b1a
TR
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";
64 }
65 {
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 = ";"
77 }
78 }
79 printf ">";
80 $0 = substr($0, RSTART + RLENGTH, length($0) - RSTART - RLENGTH + 1);
81 }
82 print
83 }
84 '
85}
86
b249e39f
JH
87lf_to_nul () {
88 perl -pe 'y/\012/\000/'
89}
90
12a29b1a 91nul_to_q () {
94221d22 92 perl -pe 'y/\000/Q/'
12a29b1a
TR
93}
94
95q_to_nul () {
94221d22 96 perl -pe 'y/Q/\000/'
12a29b1a
TR
97}
98
99q_to_cr () {
100 tr Q '\015'
101}
102
103q_to_tab () {
104 tr Q '\011'
105}
106
250b3c6c
JH
107qz_to_tab_space () {
108 tr QZ '\011\040'
12a29b1a
TR
109}
110
111append_cr () {
112 sed -e 's/$/Q/' | tr Q '\015'
113}
114
115remove_cr () {
116 tr '\015' Q | sed -e 's/Q$//'
117}
118
b0fa1a3f
RB
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.
122generate_zero_bytes () {
d5cfd142 123 test-tool genzeros "$@"
b0fa1a3f
RB
124}
125
12a29b1a
TR
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.
129#
130# Use sane_unset when that should not be considered an error.
131
132sane_unset () {
133 unset "$@"
134 return 0
135}
136
137test_tick () {
138 if test -z "${test_tick+set}"
139 then
140 test_tick=1112911993
141 else
142 test_tick=$(($test_tick + 60))
143 fi
144 GIT_COMMITTER_DATE="$test_tick -0700"
145 GIT_AUTHOR_DATE="$test_tick -0700"
146 export GIT_COMMITTER_DATE GIT_AUTHOR_DATE
147}
148
59210dd5 149# Stop execution and start a shell. This is useful for debugging tests.
12a29b1a
TR
150#
151# Be sure to remove all invocations of this command before submitting.
152
153test_pause () {
59210dd5 154 "$SHELL_PATH" <&6 >&5 2>&7
12a29b1a
TR
155}
156
84243646
EN
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.
6a94088c 159#
84243646
EN
160# Examples:
161# debug git checkout master
162# debug --debugger=nemiver git $ARGS
163# debug -d "valgrind --tool=memcheck --track-origins=yes" git $ARGS
6a94088c 164debug () {
84243646
EN
165 case "$1" in
166 -d)
167 GIT_DEBUGGER="$2" &&
168 shift 2
169 ;;
170 --debugger=*)
171 GIT_DEBUGGER="${1#*=}" &&
172 shift 1
173 ;;
174 *)
175 GIT_DEBUGGER=1
176 ;;
177 esac &&
178 GIT_DEBUGGER="${GIT_DEBUGGER}" "$@" <&6 >&5 2>&7
6a94088c
JS
179}
180
6f94351b
SB
181# Call test_commit with the arguments
182# [-C <directory>] <message> [<file> [<contents> [<tag>]]]"
12a29b1a
TR
183#
184# This will commit a file with the given contents and the given commit
4c994194 185# message, and tag the resulting commit with the given tag name.
12a29b1a 186#
4c994194 187# <file>, <contents>, and <tag> all default to <message>.
6f94351b
SB
188#
189# If the first argument is "-C", the second argument is used as a path for
190# the git invocations.
12a29b1a
TR
191
192test_commit () {
9a0231b3 193 notick= &&
5ed75e2a 194 signoff= &&
6f94351b 195 indir= &&
5ed75e2a
MV
196 while test $# != 0
197 do
198 case "$1" in
199 --notick)
200 notick=yes
201 ;;
202 --signoff)
203 signoff="$1"
204 ;;
6f94351b
SB
205 -C)
206 indir="$2"
207 shift
208 ;;
5ed75e2a
MV
209 *)
210 break
211 ;;
212 esac
9a0231b3 213 shift
5ed75e2a 214 done &&
6f94351b 215 indir=${indir:+"$indir"/} &&
9a0231b3 216 file=${2:-"$1.t"} &&
6f94351b
SB
217 echo "${3-$1}" > "$indir$file" &&
218 git ${indir:+ -C "$indir"} add "$file" &&
9a0231b3
JH
219 if test -z "$notick"
220 then
221 test_tick
222 fi &&
6f94351b
SB
223 git ${indir:+ -C "$indir"} commit $signoff -m "$1" &&
224 git ${indir:+ -C "$indir"} tag "${4:-$1}"
12a29b1a
TR
225}
226
227# Call test_merge with the arguments "<message> <commit>", where <commit>
228# can be a tag pointing to the commit-to-merge.
229
230test_merge () {
231 test_tick &&
232 git merge -m "$1" "$2" &&
233 git tag "$1"
234}
235
236# This function helps systems where core.filemode=false is set.
237# Use it instead of plain 'chmod +x' to set or unset the executable bit
238# of a file in the working directory and add it to the index.
239
240test_chmod () {
241 chmod "$@" &&
242 git update-index --add "--chmod=$@"
243}
244
73de1c93
CC
245# Get the modebits from a file.
246test_modebits () {
247 ls -l "$1" | sed -e 's|^\(..........\).*|\1|'
248}
249
12a29b1a
TR
250# Unset a configuration variable, but don't fail if it doesn't exist.
251test_unconfig () {
5fafc07f
JK
252 config_dir=
253 if test "$1" = -C
254 then
255 shift
256 config_dir=$1
257 shift
258 fi
259 git ${config_dir:+-C "$config_dir"} config --unset-all "$@"
12a29b1a
TR
260 config_status=$?
261 case "$config_status" in
262 5) # ok, nothing to unset
263 config_status=0
264 ;;
265 esac
266 return $config_status
267}
268
269# Set git config, automatically unsetting it after the test is over.
270test_config () {
5fafc07f
JK
271 config_dir=
272 if test "$1" = -C
273 then
274 shift
275 config_dir=$1
276 shift
277 fi
278 test_when_finished "test_unconfig ${config_dir:+-C '$config_dir'} '$1'" &&
279 git ${config_dir:+-C "$config_dir"} config "$@"
12a29b1a
TR
280}
281
282test_config_global () {
283 test_when_finished "test_unconfig --global '$1'" &&
284 git config --global "$@"
285}
286
287write_script () {
288 {
289 echo "#!${2-"$SHELL_PATH"}" &&
290 cat
291 } >"$1" &&
292 chmod +x "$1"
293}
294
295# Use test_set_prereq to tell that a particular prerequisite is available.
296# The prerequisite can later be checked for in two ways:
297#
298# - Explicitly using test_have_prereq.
299#
300# - Implicitly by specifying the prerequisite tag in the calls to
301# test_expect_{success,failure,code}.
302#
303# The single parameter is the prerequisite tag (a simple word, in all
304# capital letters by convention).
305
7d0ee47c
JS
306test_unset_prereq () {
307 ! test_have_prereq "$1" ||
308 satisfied_prereq="${satisfied_prereq% $1 *} ${satisfied_prereq#* $1 }"
309}
310
12a29b1a 311test_set_prereq () {
c7400399 312 if test -n "$GIT_TEST_FAIL_PREREQS_INTERNAL"
dfe1a17d
ÆAB
313 then
314 case "$1" in
315 # The "!" case is handled below with
316 # test_unset_prereq()
317 !*)
318 ;;
319 # (Temporary?) whitelist of things we can't easily
320 # pretend not to support
321 SYMLINKS)
322 ;;
323 # Inspecting whether GIT_TEST_FAIL_PREREQS is on
324 # should be unaffected.
325 FAIL_PREREQS)
326 ;;
327 *)
328 return
329 esac
330 fi
331
7d0ee47c
JS
332 case "$1" in
333 !*)
334 test_unset_prereq "${1#!}"
335 ;;
336 *)
337 satisfied_prereq="$satisfied_prereq$1 "
338 ;;
339 esac
12a29b1a 340}
f3cfc3b2 341satisfied_prereq=" "
04083f27
JH
342lazily_testable_prereq= lazily_tested_prereq=
343
344# Usage: test_lazy_prereq PREREQ 'script'
345test_lazy_prereq () {
346 lazily_testable_prereq="$lazily_testable_prereq$1 "
347 eval test_prereq_lazily_$1=\$2
348}
349
350test_run_lazy_prereq_ () {
351 script='
352mkdir -p "$TRASH_DIRECTORY/prereq-test-dir" &&
353(
354 cd "$TRASH_DIRECTORY/prereq-test-dir" &&'"$2"'
355)'
356 say >&3 "checking prerequisite: $1"
357 say >&3 "$script"
358 test_eval_ "$script"
359 eval_ret=$?
360 rm -rf "$TRASH_DIRECTORY/prereq-test-dir"
361 if test "$eval_ret" = 0; then
362 say >&3 "prerequisite $1 ok"
363 else
364 say >&3 "prerequisite $1 not satisfied"
365 fi
366 return $eval_ret
367}
12a29b1a
TR
368
369test_have_prereq () {
370 # prerequisites can be concatenated with ','
371 save_IFS=$IFS
372 IFS=,
373 set -- $*
374 IFS=$save_IFS
375
376 total_prereq=0
377 ok_prereq=0
378 missing_prereq=
379
380 for prerequisite
381 do
bdccd3c1
JK
382 case "$prerequisite" in
383 !*)
384 negative_prereq=t
385 prerequisite=${prerequisite#!}
386 ;;
387 *)
388 negative_prereq=
389 esac
390
04083f27
JH
391 case " $lazily_tested_prereq " in
392 *" $prerequisite "*)
393 ;;
394 *)
395 case " $lazily_testable_prereq " in
396 *" $prerequisite "*)
397 eval "script=\$test_prereq_lazily_$prerequisite" &&
398 if test_run_lazy_prereq_ "$prerequisite" "$script"
399 then
400 test_set_prereq $prerequisite
401 fi
402 lazily_tested_prereq="$lazily_tested_prereq$prerequisite "
403 esac
404 ;;
405 esac
406
12a29b1a 407 total_prereq=$(($total_prereq + 1))
f3cfc3b2 408 case "$satisfied_prereq" in
12a29b1a 409 *" $prerequisite "*)
bdccd3c1
JK
410 satisfied_this_prereq=t
411 ;;
412 *)
413 satisfied_this_prereq=
414 esac
415
416 case "$satisfied_this_prereq,$negative_prereq" in
417 t,|,t)
12a29b1a
TR
418 ok_prereq=$(($ok_prereq + 1))
419 ;;
420 *)
bdccd3c1
JK
421 # Keep a list of missing prerequisites; restore
422 # the negative marker if necessary.
423 prerequisite=${negative_prereq:+!}$prerequisite
12a29b1a
TR
424 if test -z "$missing_prereq"
425 then
426 missing_prereq=$prerequisite
427 else
428 missing_prereq="$prerequisite,$missing_prereq"
429 fi
430 esac
431 done
432
433 test $total_prereq = $ok_prereq
434}
435
436test_declared_prereq () {
437 case ",$test_prereq," in
438 *,$1,*)
439 return 0
440 ;;
441 esac
442 return 1
443}
444
d93d5d51
JH
445test_verify_prereq () {
446 test -z "$test_prereq" ||
447 expr >/dev/null "$test_prereq" : '[A-Z0-9_,!]*$' ||
165293af 448 BUG "'$test_prereq' does not look like a prereq"
d93d5d51
JH
449}
450
12a29b1a 451test_expect_failure () {
ae75342c 452 test_start_
12a29b1a
TR
453 test "$#" = 3 && { test_prereq=$1; shift; } || test_prereq=
454 test "$#" = 2 ||
165293af 455 BUG "not 2 or 3 parameters to test-expect-failure"
d93d5d51 456 test_verify_prereq
12a29b1a
TR
457 export test_prereq
458 if ! test_skip "$@"
459 then
460 say >&3 "checking known breakage: $2"
461 if test_run_ "$2" expecting_failure
462 then
463 test_known_broken_ok_ "$1"
464 else
465 test_known_broken_failure_ "$1"
466 fi
467 fi
ae75342c 468 test_finish_
12a29b1a
TR
469}
470
471test_expect_success () {
ae75342c 472 test_start_
12a29b1a
TR
473 test "$#" = 3 && { test_prereq=$1; shift; } || test_prereq=
474 test "$#" = 2 ||
165293af 475 BUG "not 2 or 3 parameters to test-expect-success"
d93d5d51 476 test_verify_prereq
12a29b1a
TR
477 export test_prereq
478 if ! test_skip "$@"
479 then
480 say >&3 "expecting success: $2"
481 if test_run_ "$2"
482 then
483 test_ok_ "$1"
484 else
485 test_failure_ "$@"
486 fi
487 fi
ae75342c 488 test_finish_
12a29b1a
TR
489}
490
491# test_external runs external test scripts that provide continuous
492# test output about their progress, and succeeds/fails on
493# zero/non-zero exit code. It outputs the test output on stdout even
494# in non-verbose mode, and announces the external script with "# run
495# <n>: ..." before running it. When providing relative paths, keep in
496# mind that all scripts run in "trash directory".
497# Usage: test_external description command arguments...
498# Example: test_external 'Perl API' perl ../path/to/test.pl
499test_external () {
500 test "$#" = 4 && { test_prereq=$1; shift; } || test_prereq=
501 test "$#" = 3 ||
165293af 502 BUG "not 3 or 4 parameters to test_external"
12a29b1a
TR
503 descr="$1"
504 shift
d93d5d51 505 test_verify_prereq
12a29b1a
TR
506 export test_prereq
507 if ! test_skip "$descr" "$@"
508 then
509 # Announce the script to reduce confusion about the
510 # test output that follows.
511 say_color "" "# run $test_count: $descr ($*)"
512 # Export TEST_DIRECTORY, TRASH_DIRECTORY and GIT_TEST_LONG
513 # to be able to use them in script
514 export TEST_DIRECTORY TRASH_DIRECTORY GIT_TEST_LONG
515 # Run command; redirect its stderr to &4 as in
516 # test_run_, but keep its stdout on our stdout even in
517 # non-verbose mode.
518 "$@" 2>&4
9e8f8dea 519 if test "$?" = 0
12a29b1a
TR
520 then
521 if test $test_external_has_tap -eq 0; then
522 test_ok_ "$descr"
523 else
524 say_color "" "# test_external test $descr was ok"
525 test_success=$(($test_success + 1))
526 fi
527 else
528 if test $test_external_has_tap -eq 0; then
529 test_failure_ "$descr" "$@"
530 else
531 say_color error "# test_external test $descr failed: $@"
532 test_failure=$(($test_failure + 1))
533 fi
534 fi
535 fi
536}
537
538# Like test_external, but in addition tests that the command generated
539# no output on stderr.
540test_external_without_stderr () {
541 # The temporary file has no (and must have no) security
542 # implications.
543 tmp=${TMPDIR:-/tmp}
544 stderr="$tmp/git-external-stderr.$$.tmp"
545 test_external "$@" 4> "$stderr"
9e8f8dea 546 test -f "$stderr" || error "Internal error: $stderr disappeared."
12a29b1a
TR
547 descr="no stderr: $1"
548 shift
549 say >&3 "# expecting no stderr from previous command"
9e8f8dea
DA
550 if test ! -s "$stderr"
551 then
12a29b1a
TR
552 rm "$stderr"
553
554 if test $test_external_has_tap -eq 0; then
555 test_ok_ "$descr"
556 else
557 say_color "" "# test_external_without_stderr test $descr was ok"
558 test_success=$(($test_success + 1))
559 fi
560 else
9e8f8dea
DA
561 if test "$verbose" = t
562 then
563 output=$(echo; echo "# Stderr is:"; cat "$stderr")
12a29b1a
TR
564 else
565 output=
566 fi
567 # rm first in case test_failure exits.
568 rm "$stderr"
569 if test $test_external_has_tap -eq 0; then
570 test_failure_ "$descr" "$@" "$output"
571 else
572 say_color error "# test_external_without_stderr test $descr failed: $@: $output"
573 test_failure=$(($test_failure + 1))
574 fi
575 fi
576}
577
578# debugging-friendly alternatives to "test [-f|-d|-e]"
579# The commands test the existence or non-existence of $1. $2 can be
580# given to provide a more precise diagnosis.
581test_path_is_file () {
9e8f8dea 582 if ! test -f "$1"
12a29b1a 583 then
de248e92 584 echo "File $1 doesn't exist. $2"
12a29b1a
TR
585 false
586 fi
587}
588
589test_path_is_dir () {
9e8f8dea 590 if ! test -d "$1"
12a29b1a 591 then
de248e92 592 echo "Directory $1 doesn't exist. $2"
12a29b1a
TR
593 false
594 fi
595}
596
7e9055bb
EN
597test_path_exists () {
598 if ! test -e "$1"
599 then
600 echo "Path $1 doesn't exist. $2"
601 false
602 fi
603}
604
0be7d9b7
JL
605# Check if the directory exists and is empty as expected, barf otherwise.
606test_dir_is_empty () {
607 test_path_is_dir "$1" &&
608 if test -n "$(ls -a1 "$1" | egrep -v '^\.\.?$')"
609 then
610 echo "Directory '$1' is not empty, it contains:"
611 ls -la "$1"
612 return 1
613 fi
614}
615
21d5ad91
RA
616# Check if the file exists and has a size greater than zero
617test_file_not_empty () {
618 if ! test -s "$1"
619 then
620 echo "'$1' is not a non-empty file."
621 false
622 fi
623}
624
12a29b1a 625test_path_is_missing () {
9e8f8dea 626 if test -e "$1"
12a29b1a
TR
627 then
628 echo "Path exists:"
629 ls -ld "$1"
9e8f8dea
DA
630 if test $# -ge 1
631 then
12a29b1a
TR
632 echo "$*"
633 fi
634 false
635 fi
636}
637
638# test_line_count checks that a file has the number of lines it
639# ought to. For example:
640#
641# test_expect_success 'produce exactly one line of output' '
642# do something >output &&
643# test_line_count = 1 output
644# '
645#
646# is like "test $(wc -l <output) = 1" except that it passes the
647# output through when the number of lines is wrong.
648
649test_line_count () {
650 if test $# != 3
651 then
165293af 652 BUG "not 3 parameters to test_line_count"
12a29b1a
TR
653 elif ! test $(wc -l <"$3") "$1" "$2"
654 then
655 echo "test_line_count: line count for $3 !$1 $2"
656 cat "$3"
657 return 1
658 fi
659}
660
bbfe5302
LS
661# Returns success if a comma separated string of keywords ($1) contains a
662# given keyword ($2).
663# Examples:
664# `list_contains "foo,bar" bar` returns 0
665# `list_contains "foo" bar` returns 1
666
667list_contains () {
668 case ",$1," in
669 *,$2,*)
670 return 0
671 ;;
672 esac
673 return 1
674}
675
12a29b1a
TR
676# This is not among top-level (test_expect_success | test_expect_failure)
677# but is a prefix that can be used in the test script, like:
678#
679# test_expect_success 'complain and die' '
680# do something &&
681# do something else &&
682# test_must_fail git checkout ../outerspace
683# '
684#
685# Writing this as "! git checkout ../outerspace" is wrong, because
686# the failure could be due to a segv. We want a controlled failure.
12e31a6b
SG
687#
688# Accepts the following options:
689#
690# ok=<signal-name>[,<...>]:
691# Don't treat an exit caused by the given signal as error.
692# Multiple signals can be specified as a comma separated list.
693# Currently recognized signal names are: sigpipe, success.
694# (Don't use 'success', use 'test_might_fail' instead.)
12a29b1a
TR
695
696test_must_fail () {
bbfe5302
LS
697 case "$1" in
698 ok=*)
699 _test_ok=${1#ok=}
700 shift
701 ;;
702 *)
703 _test_ok=
704 ;;
705 esac
a5bf824f 706 "$@" 2>&7
12a29b1a 707 exit_code=$?
bbfe5302
LS
708 if test $exit_code -eq 0 && ! list_contains "$_test_ok" success
709 then
03aa3783 710 echo >&4 "test_must_fail: command succeeded: $*"
12a29b1a 711 return 1
2472448c 712 elif test_match_signal 13 $exit_code && list_contains "$_test_ok" sigpipe
8bf4becf
LS
713 then
714 return 0
bbfe5302
LS
715 elif test $exit_code -gt 129 && test $exit_code -le 192
716 then
03aa3783 717 echo >&4 "test_must_fail: died by signal $(($exit_code - 128)): $*"
12a29b1a 718 return 1
bbfe5302
LS
719 elif test $exit_code -eq 127
720 then
03aa3783 721 echo >&4 "test_must_fail: command not found: $*"
12a29b1a 722 return 1
bbfe5302
LS
723 elif test $exit_code -eq 126
724 then
03aa3783 725 echo >&4 "test_must_fail: valgrind error: $*"
eeb69131 726 return 1
12a29b1a
TR
727 fi
728 return 0
a5bf824f 729} 7>&2 2>&4
12a29b1a
TR
730
731# Similar to test_must_fail, but tolerates success, too. This is
732# meant to be used in contexts like:
733#
734# test_expect_success 'some command works without configuration' '
735# test_might_fail git config --unset all.configuration &&
736# do something
737# '
738#
739# Writing "git config --unset all.configuration || :" would be wrong,
740# because we want to notice if it fails due to segv.
12e31a6b
SG
741#
742# Accepts the same options as test_must_fail.
12a29b1a
TR
743
744test_might_fail () {
a5bf824f
SG
745 test_must_fail ok=success "$@" 2>&7
746} 7>&2 2>&4
12a29b1a
TR
747
748# Similar to test_must_fail and test_might_fail, but check that a
749# given command exited with a given exit code. Meant to be used as:
750#
751# test_expect_success 'Merge with d/f conflicts' '
752# test_expect_code 1 git merge "merge msg" B master
753# '
754
755test_expect_code () {
756 want_code=$1
757 shift
a5bf824f 758 "$@" 2>&7
12a29b1a
TR
759 exit_code=$?
760 if test $exit_code = $want_code
761 then
762 return 0
763 fi
764
03aa3783 765 echo >&4 "test_expect_code: command exited with $exit_code, we wanted $want_code $*"
12a29b1a 766 return 1
a5bf824f 767} 7>&2 2>&4
12a29b1a
TR
768
769# test_cmp is a helper function to compare actual and expected output.
770# You can use it like:
771#
772# test_expect_success 'foo works' '
773# echo expected >expected &&
774# foo >actual &&
775# test_cmp expected actual
776# '
777#
778# This could be written as either "cmp" or "diff -u", but:
779# - cmp's output is not nearly as easy to read as diff -u
780# - not all diff versions understand "-u"
781
782test_cmp() {
783 $GIT_TEST_CMP "$@"
784}
785
a5db0b77
NTND
786# Check that the given config key has the expected value.
787#
788# test_cmp_config [-C <dir>] <expected-value>
789# [<git-config-options>...] <config-key>
790#
791# for example to check that the value of core.bar is foo
792#
793# test_cmp_config foo core.bar
794#
795test_cmp_config() {
796 local GD &&
797 if test "$1" = "-C"
798 then
799 shift &&
800 GD="-C $1" &&
801 shift
802 fi &&
803 printf "%s\n" "$1" >expect.config &&
804 shift &&
805 git $GD config "$@" >actual.config &&
806 test_cmp expect.config actual.config
807}
808
b93e6e36
SK
809# test_cmp_bin - helper to compare binary files
810
811test_cmp_bin() {
812 cmp "$@"
813}
814
0f59128f
SG
815# Use this instead of test_cmp to compare files that contain expected and
816# actual output from git commands that can be translated. When running
6cdccfce 817# under GIT_TEST_GETTEXT_POISON this pretends that the command produced expected
0f59128f
SG
818# results.
819test_i18ncmp () {
6cdccfce 820 ! test_have_prereq C_LOCALE_OUTPUT || test_cmp "$@"
0f59128f
SG
821}
822
823# Use this instead of "grep expected-string actual" to see if the
824# output from a git command that can be translated either contains an
825# expected string, or does not contain an unwanted one. When running
6cdccfce 826# under GIT_TEST_GETTEXT_POISON this pretends that the command produced expected
0f59128f
SG
827# results.
828test_i18ngrep () {
fd29d7b9
SG
829 eval "last_arg=\${$#}"
830
831 test -f "$last_arg" ||
165293af 832 BUG "test_i18ngrep requires a file to read as the last parameter"
fd29d7b9
SG
833
834 if test $# -lt 2 ||
835 { test "x!" = "x$1" && test $# -lt 3 ; }
836 then
165293af 837 BUG "too few parameters to test_i18ngrep"
fd29d7b9
SG
838 fi
839
6cdccfce 840 if test_have_prereq !C_LOCALE_OUTPUT
0f59128f 841 then
63b1a175
SG
842 # pretend success
843 return 0
844 fi
845
846 if test "x!" = "x$1"
0f59128f
SG
847 then
848 shift
63b1a175
SG
849 ! grep "$@" && return 0
850
03aa3783 851 echo >&4 "error: '! grep $@' did find a match in:"
0f59128f 852 else
63b1a175
SG
853 grep "$@" && return 0
854
03aa3783 855 echo >&4 "error: 'grep $@' didn't find a match in:"
0f59128f 856 fi
63b1a175
SG
857
858 if test -s "$last_arg"
859 then
03aa3783 860 cat >&4 "$last_arg"
63b1a175 861 else
03aa3783 862 echo >&4 "<File '$last_arg' is empty>"
63b1a175
SG
863 fi
864
865 return 1
0f59128f
SG
866}
867
8ad16524
JK
868# Call any command "$@" but be more verbose about its
869# failure. This is handy for commands like "test" which do
870# not output anything when they fail.
871verbose () {
872 "$@" && return 0
03aa3783 873 echo >&4 "command failed: $(git rev-parse --sq-quote "$@")"
8ad16524
JK
874 return 1
875}
876
ca8d148d
JH
877# Check if the file expected to be empty is indeed empty, and barfs
878# otherwise.
879
880test_must_be_empty () {
9eb23080
SG
881 test_path_is_file "$1" &&
882 if test -s "$1"
ca8d148d
JH
883 then
884 echo "'$1' is not empty, it contains:"
885 cat "$1"
886 return 1
887 fi
888}
889
5d77298d
MZ
890# Tests that its two parameters refer to the same revision
891test_cmp_rev () {
30d0b6dc
SG
892 if test $# != 2
893 then
894 error "bug in the test script: test_cmp_rev requires two revisions, but got $#"
895 else
896 local r1 r2
897 r1=$(git rev-parse --verify "$1") &&
898 r2=$(git rev-parse --verify "$2") &&
899 if test "$r1" != "$r2"
900 then
901 cat >&4 <<-EOF
902 error: two revisions point to different objects:
903 '$1': $r1
904 '$2': $r2
905 EOF
906 return 1
907 fi
908 fi
5d77298d
MZ
909}
910
55672a39
JH
911# Print a sequence of integers in increasing order, either with
912# two arguments (start and end):
d17cf5f3 913#
55672a39
JH
914# test_seq 1 5 -- outputs 1 2 3 4 5 one line at a time
915#
916# or with one argument (end), in which case it starts counting
917# from 1.
d17cf5f3
MK
918
919test_seq () {
920 case $# in
921 1) set 1 "$@" ;;
922 2) ;;
165293af 923 *) BUG "not 1 or 2 parameters to test_seq" ;;
d17cf5f3 924 esac
4df43135
JH
925 test_seq_counter__=$1
926 while test "$test_seq_counter__" -le "$2"
927 do
928 echo "$test_seq_counter__"
929 test_seq_counter__=$(( $test_seq_counter__ + 1 ))
930 done
d17cf5f3
MK
931}
932
12a29b1a
TR
933# This function can be used to schedule some commands to be run
934# unconditionally at the end of the test to restore sanity:
935#
936# test_expect_success 'test core.capslock' '
937# git config core.capslock true &&
938# test_when_finished "git config --unset core.capslock" &&
939# hello world
940# '
941#
942# That would be roughly equivalent to
943#
944# test_expect_success 'test core.capslock' '
945# git config core.capslock true &&
946# hello world
947# git config --unset core.capslock
948# '
949#
950# except that the greeting and config --unset must both succeed for
951# the test to pass.
952#
953# Note that under --immediate mode, no clean-up is done to help diagnose
954# what went wrong.
955
956test_when_finished () {
0968f12a
JK
957 # We cannot detect when we are in a subshell in general, but by
958 # doing so on Bash is better than nothing (the test will
959 # silently pass on other shells).
960 test "${BASH_SUBSHELL-0}" = 0 ||
165293af 961 BUG "test_when_finished does nothing in a subshell"
12a29b1a
TR
962 test_cleanup="{ $*
963 } && (exit \"\$eval_ret\"); eval_ret=\$?; $test_cleanup"
964}
965
900721e1
JS
966# This function can be used to schedule some commands to be run
967# unconditionally at the end of the test script, e.g. to stop a daemon:
968#
969# test_expect_success 'test git daemon' '
970# git daemon &
971# daemon_pid=$! &&
972# test_atexit 'kill $daemon_pid' &&
973# hello world
974# '
975#
976# The commands will be executed before the trash directory is removed,
977# i.e. the atexit commands will still be able to access any pidfiles or
978# socket files.
979#
980# Note that these commands will be run even when a test script run
981# with '--immediate' fails. Be careful with your atexit commands to
982# minimize any changes to the failed state.
983
984test_atexit () {
985 # We cannot detect when we are in a subshell in general, but by
986 # doing so on Bash is better than nothing (the test will
987 # silently pass on other shells).
988 test "${BASH_SUBSHELL-0}" = 0 ||
989 error "bug in test script: test_atexit does nothing in a subshell"
990 test_atexit_cleanup="{ $*
991 } && (exit \"\$eval_ret\"); eval_ret=\$?; $test_atexit_cleanup"
992}
993
12a29b1a
TR
994# Most tests can use the created repository, but some may need to create more.
995# Usage: test_create_repo <directory>
996test_create_repo () {
997 test "$#" = 1 ||
165293af 998 BUG "not 1 parameter to test-create-repo"
12a29b1a
TR
999 repo="$1"
1000 mkdir -p "$repo"
1001 (
1002 cd "$repo" || error "Cannot setup test environment"
8abfdf44 1003 "${GIT_TEST_INSTALLED:-$GIT_EXEC_PATH}/git$X" init \
3af4c715 1004 "--template=$GIT_BUILD_DIR/templates/blt/" >&3 2>&4 ||
12a29b1a
TR
1005 error "cannot run git init -- have you built things yet?"
1006 mv .git/hooks .git/hooks-disabled
1007 ) || exit
1008}
9ce415d9
JS
1009
1010# This function helps on symlink challenged file systems when it is not
1011# important that the file system entry is a symbolic link.
1012# Use test_ln_s_add instead of "ln -s x y && git add y" to add a
1013# symbolic link entry y to the index.
1014
1015test_ln_s_add () {
1016 if test_have_prereq SYMLINKS
1017 then
1018 ln -s "$1" "$2" &&
1019 git update-index --add "$2"
1020 else
1021 printf '%s' "$1" >"$2" &&
1022 ln_s_obj=$(git hash-object -w "$2") &&
817d03e1
JS
1023 git update-index --add --cacheinfo 120000 $ln_s_obj "$2" &&
1024 # pick up stat info from the file
1025 git update-index "$2"
9ce415d9
JS
1026 fi
1027}
4d715ac0 1028
ac9afcc3
MT
1029# This function writes out its parameters, one per line
1030test_write_lines () {
1031 printf "%s\n" "$@"
1032}
1033
a0e0ec9f 1034perl () {
a5bf824f
SG
1035 command "$PERL_PATH" "$@" 2>&7
1036} 7>&2 2>&4
a3a9cff0 1037
83d842dc 1038# Exit the test suite, either by skipping all remaining tests or by
3b072c57
ÆAB
1039# exiting with an error. If our prerequisite variable $1 falls back
1040# on a default assume we were opportunistically trying to set up some
1041# tests and we skip. If it is explicitly "true", then we report a failure.
83d842dc
JK
1042#
1043# The error/skip message should be given by $2.
1044#
1045test_skip_or_die () {
c7400399 1046 if ! git env--helper --type=bool --default=false --exit-code $1
3b072c57 1047 then
83d842dc
JK
1048 skip_all=$2
1049 test_done
3b072c57
ÆAB
1050 fi
1051 error "$2"
83d842dc
JK
1052}
1053
4d715ac0
JS
1054# The following mingw_* functions obey POSIX shell syntax, but are actually
1055# bash scripts, and are meant to be used only with bash on Windows.
1056
1057# A test_cmp function that treats LF and CRLF equal and avoids to fork
1058# diff when possible.
1059mingw_test_cmp () {
1060 # Read text into shell variables and compare them. If the results
1061 # are different, use regular diff to report the difference.
1062 local test_cmp_a= test_cmp_b=
1063
1064 # When text came from stdin (one argument is '-') we must feed it
1065 # to diff.
1066 local stdin_for_diff=
1067
1068 # Since it is difficult to detect the difference between an
1069 # empty input file and a failure to read the files, we go straight
1070 # to diff if one of the inputs is empty.
1071 if test -s "$1" && test -s "$2"
1072 then
1073 # regular case: both files non-empty
1074 mingw_read_file_strip_cr_ test_cmp_a <"$1"
1075 mingw_read_file_strip_cr_ test_cmp_b <"$2"
1076 elif test -s "$1" && test "$2" = -
1077 then
1078 # read 2nd file from stdin
1079 mingw_read_file_strip_cr_ test_cmp_a <"$1"
1080 mingw_read_file_strip_cr_ test_cmp_b
1081 stdin_for_diff='<<<"$test_cmp_b"'
1082 elif test "$1" = - && test -s "$2"
1083 then
1084 # read 1st file from stdin
1085 mingw_read_file_strip_cr_ test_cmp_a
1086 mingw_read_file_strip_cr_ test_cmp_b <"$2"
1087 stdin_for_diff='<<<"$test_cmp_a"'
1088 fi
1089 test -n "$test_cmp_a" &&
1090 test -n "$test_cmp_b" &&
1091 test "$test_cmp_a" = "$test_cmp_b" ||
1092 eval "diff -u \"\$@\" $stdin_for_diff"
1093}
1094
1095# $1 is the name of the shell variable to fill in
1096mingw_read_file_strip_cr_ () {
1097 # Read line-wise using LF as the line separator
1098 # and use IFS to strip CR.
1099 local line
1100 while :
1101 do
1102 if IFS=$'\r' read -r -d $'\n' line
1103 then
1104 # good
1105 line=$line$'\n'
1106 else
1107 # we get here at EOF, but also if the last line
1108 # was not terminated by LF; in the latter case,
1109 # some text was read
1110 if test -z "$line"
1111 then
1112 # EOF, really
1113 break
1114 fi
1115 fi
1116 eval "$1=\$$1\$line"
1117 done
1118}
d2554c72
JK
1119
1120# Like "env FOO=BAR some-program", but run inside a subshell, which means
1121# it also works for shell functions (though those functions cannot impact
1122# the environment outside of the test_env invocation).
1123test_env () {
1124 (
1125 while test $# -gt 0
1126 do
1127 case "$1" in
1128 *=*)
1129 eval "${1%%=*}=\${1#*=}"
1130 eval "export ${1%%=*}"
1131 shift
1132 ;;
1133 *)
a5bf824f 1134 "$@" 2>&7
d2554c72
JK
1135 exit
1136 ;;
1137 esac
1138 done
1139 )
a5bf824f 1140} 7>&2 2>&4
48860819 1141
9b67c994
JK
1142# Returns true if the numeric exit code in "$2" represents the expected signal
1143# in "$1". Signals should be given numerically.
1144test_match_signal () {
1145 if test "$2" = "$((128 + $1))"
1146 then
1147 # POSIX
1148 return 0
1149 elif test "$2" = "$((256 + $1))"
1150 then
1151 # ksh
1152 return 0
1153 fi
1154 return 1
1155}
39cadeec 1156
48860819
JK
1157# Read up to "$1" bytes (or to EOF) from stdin and write them to stdout.
1158test_copy_bytes () {
1159 perl -e '
1160 my $len = $ARGV[1];
1161 while ($len > 0) {
1162 my $s;
1163 my $nread = sysread(STDIN, $s, $len);
1164 die "cannot read: $!" unless defined($nread);
f7f6dc34 1165 last unless $nread;
48860819
JK
1166 print $s;
1167 $len -= $nread;
1168 }
1169 ' - "$1"
1170}
de95302a
JK
1171
1172# run "$@" inside a non-git directory
1173nongit () {
1174 test -d non-repo ||
1175 mkdir non-repo ||
1176 return 1
1177
1178 (
1179 GIT_CEILING_DIRECTORIES=$(pwd) &&
1180 export GIT_CEILING_DIRECTORIES &&
1181 cd non-repo &&
a5bf824f 1182 "$@" 2>&7
de95302a 1183 )
a5bf824f 1184} 7>&2 2>&4
4414a150
JK
1185
1186# convert stdin to pktline representation; note that empty input becomes an
1187# empty packet, not a flush packet (for that you can just print 0000 yourself).
1188packetize() {
1189 cat >packetize.tmp &&
1190 len=$(wc -c <packetize.tmp) &&
1191 printf '%04x%s' "$(($len + 4))" &&
1192 cat packetize.tmp &&
1193 rm -f packetize.tmp
1194}
1195
1196# Parse the input as a series of pktlines, writing the result to stdout.
1197# Sideband markers are removed automatically, and the output is routed to
1198# stderr if appropriate.
1199#
1200# NUL bytes are converted to "\\0" for ease of parsing with text tools.
1201depacketize () {
1202 perl -e '
1203 while (read(STDIN, $len, 4) == 4) {
1204 if ($len eq "0000") {
1205 print "FLUSH\n";
1206 } else {
1207 read(STDIN, $buf, hex($len) - 4);
1208 $buf =~ s/\0/\\0/g;
1209 if ($buf =~ s/^[\x2\x3]//) {
1210 print STDERR $buf;
1211 } else {
1212 $buf =~ s/^\x1//;
1213 print $buf;
1214 }
1215 }
1216 }
1217 '
1218}
2c02b110 1219
5c07647d
TB
1220# Converts base-16 data into base-8. The output is given as a sequence of
1221# escaped octals, suitable for consumption by 'printf'.
1222hex2oct () {
1223 perl -ne 'printf "\\%03o", hex for /../g'
1224}
1225
2c02b110 1226# Set the hash algorithm in use to $1. Only useful when testing the testsuite.
1227test_set_hash () {
1228 test_hash_algo="$1"
1229}
1230
1231# Detect the hash algorithm in use.
1232test_detect_hash () {
1233 # Currently we only support SHA-1, but in the future this function will
1234 # actually detect the algorithm in use.
1235 test_hash_algo='sha1'
1236}
1237
1238# Load common hash metadata and common placeholder object IDs for use with
1239# test_oid.
1240test_oid_init () {
1241 test -n "$test_hash_algo" || test_detect_hash &&
1242 test_oid_cache <"$TEST_DIRECTORY/oid-info/hash-info" &&
1243 test_oid_cache <"$TEST_DIRECTORY/oid-info/oid"
1244}
1245
1246# Load key-value pairs from stdin suitable for use with test_oid. Blank lines
1247# and lines starting with "#" are ignored. Keys must be shell identifier
1248# characters.
1249#
1250# Examples:
1251# rawsz sha1:20
1252# rawsz sha256:32
1253test_oid_cache () {
1254 local tag rest k v &&
1255
1256 { test -n "$test_hash_algo" || test_detect_hash; } &&
1257 while read tag rest
1258 do
1259 case $tag in
1260 \#*)
1261 continue;;
1262 ?*)
1263 # non-empty
1264 ;;
1265 *)
1266 # blank line
1267 continue;;
1268 esac &&
1269
1270 k="${rest%:*}" &&
1271 v="${rest#*:}" &&
1272
1273 if ! expr "$k" : '[a-z0-9][a-z0-9]*$' >/dev/null
1274 then
165293af 1275 BUG 'bad hash algorithm'
2c02b110 1276 fi &&
1277 eval "test_oid_${k}_$tag=\"\$v\""
1278 done
1279}
1280
1281# Look up a per-hash value based on a key ($1). The value must have been loaded
1282# by test_oid_init or test_oid_cache.
1283test_oid () {
1284 local var="test_oid_${test_hash_algo}_$1" &&
1285
1286 # If the variable is unset, we must be missing an entry for this
1287 # key-hash pair, so exit with an error.
1288 if eval "test -z \"\${$var+set}\""
1289 then
165293af 1290 BUG "undefined key '$1'"
2c02b110 1291 fi &&
1292 eval "printf '%s' \"\${$var}\""
1293}
fa840581
SG
1294
1295# Choose a port number based on the test script's number and store it in
1296# the given variable name, unless that variable already contains a number.
1297test_set_port () {
1298 local var=$1 port
1299
1300 if test $# -ne 1 || test -z "$var"
1301 then
1302 BUG "test_set_port requires a variable name"
1303 fi
1304
1305 eval port=\$$var
1306 case "$port" in
1307 "")
1308 # No port is set in the given env var, use the test
1309 # number as port number instead.
1310 # Remove not only the leading 't', but all leading zeros
1311 # as well, so the arithmetic below won't (mis)interpret
1312 # a test number like '0123' as an octal value.
1313 port=${this_test#${this_test%%[1-9]*}}
1314 if test "${port:-0}" -lt 1024
1315 then
1316 # root-only port, use a larger one instead.
1317 port=$(($port + 10000))
1318 fi
fa840581 1319 ;;
7d661e5e 1320 *[!0-9]*|0*)
fa840581
SG
1321 error >&7 "invalid port number: $port"
1322 ;;
1323 *)
1324 # The user has specified the port.
1325 ;;
1326 esac
fb7d1e3a
SG
1327
1328 # Make sure that parallel '--stress' test jobs get different
1329 # ports.
1330 port=$(($port + ${GIT_TEST_STRESS_JOB_NR:-0}))
1331 eval $var=$port
fa840581 1332}