Merge branch 'master' of git://git.bogomips.org/git-svn
[git/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";
45 if (n == 30) return "BLACK";
46 if (n == 31) return "RED";
47 if (n == 32) return "GREEN";
48 if (n == 33) return "YELLOW";
49 if (n == 34) return "BLUE";
50 if (n == 35) return "MAGENTA";
51 if (n == 36) return "CYAN";
52 if (n == 37) return "WHITE";
53 if (n == 40) return "BLACK";
54 if (n == 41) return "BRED";
55 if (n == 42) return "BGREEN";
56 if (n == 43) return "BYELLOW";
57 if (n == 44) return "BBLUE";
58 if (n == 45) return "BMAGENTA";
59 if (n == 46) return "BCYAN";
60 if (n == 47) return "BWHITE";
61 }
62 {
63 while (match($0, /\033\[[0-9;]*m/) != 0) {
64 printf "%s<", substr($0, 1, RSTART-1);
65 codes = substr($0, RSTART+2, RLENGTH-3);
66 if (length(codes) == 0)
67 printf "%s", name(0)
68 else {
69 n = split(codes, ary, ";");
70 sep = "";
71 for (i = 1; i <= n; i++) {
72 printf "%s%s", sep, name(ary[i]);
73 sep = ";"
74 }
75 }
76 printf ">";
77 $0 = substr($0, RSTART + RLENGTH, length($0) - RSTART - RLENGTH + 1);
78 }
79 print
80 }
81 '
82}
83
84nul_to_q () {
94221d22 85 perl -pe 'y/\000/Q/'
12a29b1a
TR
86}
87
88q_to_nul () {
94221d22 89 perl -pe 'y/Q/\000/'
12a29b1a
TR
90}
91
92q_to_cr () {
93 tr Q '\015'
94}
95
96q_to_tab () {
97 tr Q '\011'
98}
99
250b3c6c
JH
100qz_to_tab_space () {
101 tr QZ '\011\040'
12a29b1a
TR
102}
103
104append_cr () {
105 sed -e 's/$/Q/' | tr Q '\015'
106}
107
108remove_cr () {
109 tr '\015' Q | sed -e 's/Q$//'
110}
111
112# In some bourne shell implementations, the "unset" builtin returns
113# nonzero status when a variable to be unset was not set in the first
114# place.
115#
116# Use sane_unset when that should not be considered an error.
117
118sane_unset () {
119 unset "$@"
120 return 0
121}
122
123test_tick () {
124 if test -z "${test_tick+set}"
125 then
126 test_tick=1112911993
127 else
128 test_tick=$(($test_tick + 60))
129 fi
130 GIT_COMMITTER_DATE="$test_tick -0700"
131 GIT_AUTHOR_DATE="$test_tick -0700"
132 export GIT_COMMITTER_DATE GIT_AUTHOR_DATE
133}
134
135# Stop execution and start a shell. This is useful for debugging tests and
136# only makes sense together with "-v".
137#
138# Be sure to remove all invocations of this command before submitting.
139
140test_pause () {
141 if test "$verbose" = t; then
142 "$SHELL_PATH" <&6 >&3 2>&4
143 else
144 error >&5 "test_pause requires --verbose"
145 fi
146}
147
6a94088c
JS
148# Wrap git in gdb. Adding this to a command can make it easier to
149# understand what is going on in a failing test.
150#
151# Example: "debug git checkout master".
152debug () {
153 GIT_TEST_GDB=1 "$@"
154}
155
4c994194 156# Call test_commit with the arguments "<message> [<file> [<contents> [<tag>]]]"
12a29b1a
TR
157#
158# This will commit a file with the given contents and the given commit
4c994194 159# message, and tag the resulting commit with the given tag name.
12a29b1a 160#
4c994194 161# <file>, <contents>, and <tag> all default to <message>.
12a29b1a
TR
162
163test_commit () {
9a0231b3 164 notick= &&
5ed75e2a
MV
165 signoff= &&
166 while test $# != 0
167 do
168 case "$1" in
169 --notick)
170 notick=yes
171 ;;
172 --signoff)
173 signoff="$1"
174 ;;
175 *)
176 break
177 ;;
178 esac
9a0231b3 179 shift
5ed75e2a 180 done &&
9a0231b3 181 file=${2:-"$1.t"} &&
12a29b1a
TR
182 echo "${3-$1}" > "$file" &&
183 git add "$file" &&
9a0231b3
JH
184 if test -z "$notick"
185 then
186 test_tick
187 fi &&
5ed75e2a 188 git commit $signoff -m "$1" &&
4c994194 189 git tag "${4:-$1}"
12a29b1a
TR
190}
191
192# Call test_merge with the arguments "<message> <commit>", where <commit>
193# can be a tag pointing to the commit-to-merge.
194
195test_merge () {
196 test_tick &&
197 git merge -m "$1" "$2" &&
198 git tag "$1"
199}
200
201# This function helps systems where core.filemode=false is set.
202# Use it instead of plain 'chmod +x' to set or unset the executable bit
203# of a file in the working directory and add it to the index.
204
205test_chmod () {
206 chmod "$@" &&
207 git update-index --add "--chmod=$@"
208}
209
210# Unset a configuration variable, but don't fail if it doesn't exist.
211test_unconfig () {
5fafc07f
JK
212 config_dir=
213 if test "$1" = -C
214 then
215 shift
216 config_dir=$1
217 shift
218 fi
219 git ${config_dir:+-C "$config_dir"} config --unset-all "$@"
12a29b1a
TR
220 config_status=$?
221 case "$config_status" in
222 5) # ok, nothing to unset
223 config_status=0
224 ;;
225 esac
226 return $config_status
227}
228
229# Set git config, automatically unsetting it after the test is over.
230test_config () {
5fafc07f
JK
231 config_dir=
232 if test "$1" = -C
233 then
234 shift
235 config_dir=$1
236 shift
237 fi
238 test_when_finished "test_unconfig ${config_dir:+-C '$config_dir'} '$1'" &&
239 git ${config_dir:+-C "$config_dir"} config "$@"
12a29b1a
TR
240}
241
242test_config_global () {
243 test_when_finished "test_unconfig --global '$1'" &&
244 git config --global "$@"
245}
246
247write_script () {
248 {
249 echo "#!${2-"$SHELL_PATH"}" &&
250 cat
251 } >"$1" &&
252 chmod +x "$1"
253}
254
255# Use test_set_prereq to tell that a particular prerequisite is available.
256# The prerequisite can later be checked for in two ways:
257#
258# - Explicitly using test_have_prereq.
259#
260# - Implicitly by specifying the prerequisite tag in the calls to
261# test_expect_{success,failure,code}.
262#
263# The single parameter is the prerequisite tag (a simple word, in all
264# capital letters by convention).
265
266test_set_prereq () {
f3cfc3b2 267 satisfied_prereq="$satisfied_prereq$1 "
12a29b1a 268}
f3cfc3b2 269satisfied_prereq=" "
04083f27
JH
270lazily_testable_prereq= lazily_tested_prereq=
271
272# Usage: test_lazy_prereq PREREQ 'script'
273test_lazy_prereq () {
274 lazily_testable_prereq="$lazily_testable_prereq$1 "
275 eval test_prereq_lazily_$1=\$2
276}
277
278test_run_lazy_prereq_ () {
279 script='
280mkdir -p "$TRASH_DIRECTORY/prereq-test-dir" &&
281(
282 cd "$TRASH_DIRECTORY/prereq-test-dir" &&'"$2"'
283)'
284 say >&3 "checking prerequisite: $1"
285 say >&3 "$script"
286 test_eval_ "$script"
287 eval_ret=$?
288 rm -rf "$TRASH_DIRECTORY/prereq-test-dir"
289 if test "$eval_ret" = 0; then
290 say >&3 "prerequisite $1 ok"
291 else
292 say >&3 "prerequisite $1 not satisfied"
293 fi
294 return $eval_ret
295}
12a29b1a
TR
296
297test_have_prereq () {
298 # prerequisites can be concatenated with ','
299 save_IFS=$IFS
300 IFS=,
301 set -- $*
302 IFS=$save_IFS
303
304 total_prereq=0
305 ok_prereq=0
306 missing_prereq=
307
308 for prerequisite
309 do
bdccd3c1
JK
310 case "$prerequisite" in
311 !*)
312 negative_prereq=t
313 prerequisite=${prerequisite#!}
314 ;;
315 *)
316 negative_prereq=
317 esac
318
04083f27
JH
319 case " $lazily_tested_prereq " in
320 *" $prerequisite "*)
321 ;;
322 *)
323 case " $lazily_testable_prereq " in
324 *" $prerequisite "*)
325 eval "script=\$test_prereq_lazily_$prerequisite" &&
326 if test_run_lazy_prereq_ "$prerequisite" "$script"
327 then
328 test_set_prereq $prerequisite
329 fi
330 lazily_tested_prereq="$lazily_tested_prereq$prerequisite "
331 esac
332 ;;
333 esac
334
12a29b1a 335 total_prereq=$(($total_prereq + 1))
f3cfc3b2 336 case "$satisfied_prereq" in
12a29b1a 337 *" $prerequisite "*)
bdccd3c1
JK
338 satisfied_this_prereq=t
339 ;;
340 *)
341 satisfied_this_prereq=
342 esac
343
344 case "$satisfied_this_prereq,$negative_prereq" in
345 t,|,t)
12a29b1a
TR
346 ok_prereq=$(($ok_prereq + 1))
347 ;;
348 *)
bdccd3c1
JK
349 # Keep a list of missing prerequisites; restore
350 # the negative marker if necessary.
351 prerequisite=${negative_prereq:+!}$prerequisite
12a29b1a
TR
352 if test -z "$missing_prereq"
353 then
354 missing_prereq=$prerequisite
355 else
356 missing_prereq="$prerequisite,$missing_prereq"
357 fi
358 esac
359 done
360
361 test $total_prereq = $ok_prereq
362}
363
364test_declared_prereq () {
365 case ",$test_prereq," in
366 *,$1,*)
367 return 0
368 ;;
369 esac
370 return 1
371}
372
d93d5d51
JH
373test_verify_prereq () {
374 test -z "$test_prereq" ||
375 expr >/dev/null "$test_prereq" : '[A-Z0-9_,!]*$' ||
376 error "bug in the test script: '$test_prereq' does not look like a prereq"
377}
378
12a29b1a 379test_expect_failure () {
ae75342c 380 test_start_
12a29b1a
TR
381 test "$#" = 3 && { test_prereq=$1; shift; } || test_prereq=
382 test "$#" = 2 ||
383 error "bug in the test script: not 2 or 3 parameters to test-expect-failure"
d93d5d51 384 test_verify_prereq
12a29b1a
TR
385 export test_prereq
386 if ! test_skip "$@"
387 then
388 say >&3 "checking known breakage: $2"
389 if test_run_ "$2" expecting_failure
390 then
391 test_known_broken_ok_ "$1"
392 else
393 test_known_broken_failure_ "$1"
394 fi
395 fi
ae75342c 396 test_finish_
12a29b1a
TR
397}
398
399test_expect_success () {
ae75342c 400 test_start_
12a29b1a
TR
401 test "$#" = 3 && { test_prereq=$1; shift; } || test_prereq=
402 test "$#" = 2 ||
403 error "bug in the test script: not 2 or 3 parameters to test-expect-success"
d93d5d51 404 test_verify_prereq
12a29b1a
TR
405 export test_prereq
406 if ! test_skip "$@"
407 then
408 say >&3 "expecting success: $2"
409 if test_run_ "$2"
410 then
411 test_ok_ "$1"
412 else
413 test_failure_ "$@"
414 fi
415 fi
ae75342c 416 test_finish_
12a29b1a
TR
417}
418
419# test_external runs external test scripts that provide continuous
420# test output about their progress, and succeeds/fails on
421# zero/non-zero exit code. It outputs the test output on stdout even
422# in non-verbose mode, and announces the external script with "# run
423# <n>: ..." before running it. When providing relative paths, keep in
424# mind that all scripts run in "trash directory".
425# Usage: test_external description command arguments...
426# Example: test_external 'Perl API' perl ../path/to/test.pl
427test_external () {
428 test "$#" = 4 && { test_prereq=$1; shift; } || test_prereq=
429 test "$#" = 3 ||
430 error >&5 "bug in the test script: not 3 or 4 parameters to test_external"
431 descr="$1"
432 shift
d93d5d51 433 test_verify_prereq
12a29b1a
TR
434 export test_prereq
435 if ! test_skip "$descr" "$@"
436 then
437 # Announce the script to reduce confusion about the
438 # test output that follows.
439 say_color "" "# run $test_count: $descr ($*)"
440 # Export TEST_DIRECTORY, TRASH_DIRECTORY and GIT_TEST_LONG
441 # to be able to use them in script
442 export TEST_DIRECTORY TRASH_DIRECTORY GIT_TEST_LONG
443 # Run command; redirect its stderr to &4 as in
444 # test_run_, but keep its stdout on our stdout even in
445 # non-verbose mode.
446 "$@" 2>&4
9e8f8dea 447 if test "$?" = 0
12a29b1a
TR
448 then
449 if test $test_external_has_tap -eq 0; then
450 test_ok_ "$descr"
451 else
452 say_color "" "# test_external test $descr was ok"
453 test_success=$(($test_success + 1))
454 fi
455 else
456 if test $test_external_has_tap -eq 0; then
457 test_failure_ "$descr" "$@"
458 else
459 say_color error "# test_external test $descr failed: $@"
460 test_failure=$(($test_failure + 1))
461 fi
462 fi
463 fi
464}
465
466# Like test_external, but in addition tests that the command generated
467# no output on stderr.
468test_external_without_stderr () {
469 # The temporary file has no (and must have no) security
470 # implications.
471 tmp=${TMPDIR:-/tmp}
472 stderr="$tmp/git-external-stderr.$$.tmp"
473 test_external "$@" 4> "$stderr"
9e8f8dea 474 test -f "$stderr" || error "Internal error: $stderr disappeared."
12a29b1a
TR
475 descr="no stderr: $1"
476 shift
477 say >&3 "# expecting no stderr from previous command"
9e8f8dea
DA
478 if test ! -s "$stderr"
479 then
12a29b1a
TR
480 rm "$stderr"
481
482 if test $test_external_has_tap -eq 0; then
483 test_ok_ "$descr"
484 else
485 say_color "" "# test_external_without_stderr test $descr was ok"
486 test_success=$(($test_success + 1))
487 fi
488 else
9e8f8dea
DA
489 if test "$verbose" = t
490 then
491 output=$(echo; echo "# Stderr is:"; cat "$stderr")
12a29b1a
TR
492 else
493 output=
494 fi
495 # rm first in case test_failure exits.
496 rm "$stderr"
497 if test $test_external_has_tap -eq 0; then
498 test_failure_ "$descr" "$@" "$output"
499 else
500 say_color error "# test_external_without_stderr test $descr failed: $@: $output"
501 test_failure=$(($test_failure + 1))
502 fi
503 fi
504}
505
506# debugging-friendly alternatives to "test [-f|-d|-e]"
507# The commands test the existence or non-existence of $1. $2 can be
508# given to provide a more precise diagnosis.
509test_path_is_file () {
9e8f8dea 510 if ! test -f "$1"
12a29b1a 511 then
de248e92 512 echo "File $1 doesn't exist. $2"
12a29b1a
TR
513 false
514 fi
515}
516
517test_path_is_dir () {
9e8f8dea 518 if ! test -d "$1"
12a29b1a 519 then
de248e92 520 echo "Directory $1 doesn't exist. $2"
12a29b1a
TR
521 false
522 fi
523}
524
0be7d9b7
JL
525# Check if the directory exists and is empty as expected, barf otherwise.
526test_dir_is_empty () {
527 test_path_is_dir "$1" &&
528 if test -n "$(ls -a1 "$1" | egrep -v '^\.\.?$')"
529 then
530 echo "Directory '$1' is not empty, it contains:"
531 ls -la "$1"
532 return 1
533 fi
534}
535
12a29b1a 536test_path_is_missing () {
9e8f8dea 537 if test -e "$1"
12a29b1a
TR
538 then
539 echo "Path exists:"
540 ls -ld "$1"
9e8f8dea
DA
541 if test $# -ge 1
542 then
12a29b1a
TR
543 echo "$*"
544 fi
545 false
546 fi
547}
548
549# test_line_count checks that a file has the number of lines it
550# ought to. For example:
551#
552# test_expect_success 'produce exactly one line of output' '
553# do something >output &&
554# test_line_count = 1 output
555# '
556#
557# is like "test $(wc -l <output) = 1" except that it passes the
558# output through when the number of lines is wrong.
559
560test_line_count () {
561 if test $# != 3
562 then
563 error "bug in the test script: not 3 parameters to test_line_count"
564 elif ! test $(wc -l <"$3") "$1" "$2"
565 then
566 echo "test_line_count: line count for $3 !$1 $2"
567 cat "$3"
568 return 1
569 fi
570}
571
572# This is not among top-level (test_expect_success | test_expect_failure)
573# but is a prefix that can be used in the test script, like:
574#
575# test_expect_success 'complain and die' '
576# do something &&
577# do something else &&
578# test_must_fail git checkout ../outerspace
579# '
580#
581# Writing this as "! git checkout ../outerspace" is wrong, because
582# the failure could be due to a segv. We want a controlled failure.
583
584test_must_fail () {
585 "$@"
586 exit_code=$?
587 if test $exit_code = 0; then
588 echo >&2 "test_must_fail: command succeeded: $*"
589 return 1
0cfe6fd2 590 elif test $exit_code -gt 129 && test $exit_code -le 192; then
12a29b1a
TR
591 echo >&2 "test_must_fail: died by signal: $*"
592 return 1
593 elif test $exit_code = 127; then
594 echo >&2 "test_must_fail: command not found: $*"
595 return 1
eeb69131
TR
596 elif test $exit_code = 126; then
597 echo >&2 "test_must_fail: valgrind error: $*"
598 return 1
12a29b1a
TR
599 fi
600 return 0
601}
602
603# Similar to test_must_fail, but tolerates success, too. This is
604# meant to be used in contexts like:
605#
606# test_expect_success 'some command works without configuration' '
607# test_might_fail git config --unset all.configuration &&
608# do something
609# '
610#
611# Writing "git config --unset all.configuration || :" would be wrong,
612# because we want to notice if it fails due to segv.
613
614test_might_fail () {
615 "$@"
616 exit_code=$?
0cfe6fd2 617 if test $exit_code -gt 129 && test $exit_code -le 192; then
12a29b1a
TR
618 echo >&2 "test_might_fail: died by signal: $*"
619 return 1
620 elif test $exit_code = 127; then
621 echo >&2 "test_might_fail: command not found: $*"
622 return 1
623 fi
624 return 0
625}
626
627# Similar to test_must_fail and test_might_fail, but check that a
628# given command exited with a given exit code. Meant to be used as:
629#
630# test_expect_success 'Merge with d/f conflicts' '
631# test_expect_code 1 git merge "merge msg" B master
632# '
633
634test_expect_code () {
635 want_code=$1
636 shift
637 "$@"
638 exit_code=$?
639 if test $exit_code = $want_code
640 then
641 return 0
642 fi
643
644 echo >&2 "test_expect_code: command exited with $exit_code, we wanted $want_code $*"
645 return 1
646}
647
648# test_cmp is a helper function to compare actual and expected output.
649# You can use it like:
650#
651# test_expect_success 'foo works' '
652# echo expected >expected &&
653# foo >actual &&
654# test_cmp expected actual
655# '
656#
657# This could be written as either "cmp" or "diff -u", but:
658# - cmp's output is not nearly as easy to read as diff -u
659# - not all diff versions understand "-u"
660
661test_cmp() {
662 $GIT_TEST_CMP "$@"
663}
664
b93e6e36
SK
665# test_cmp_bin - helper to compare binary files
666
667test_cmp_bin() {
668 cmp "$@"
669}
670
8ad16524
JK
671# Call any command "$@" but be more verbose about its
672# failure. This is handy for commands like "test" which do
673# not output anything when they fail.
674verbose () {
675 "$@" && return 0
676 echo >&2 "command failed: $(git rev-parse --sq-quote "$@")"
677 return 1
678}
679
ca8d148d
JH
680# Check if the file expected to be empty is indeed empty, and barfs
681# otherwise.
682
683test_must_be_empty () {
684 if test -s "$1"
685 then
686 echo "'$1' is not empty, it contains:"
687 cat "$1"
688 return 1
689 fi
690}
691
5d77298d
MZ
692# Tests that its two parameters refer to the same revision
693test_cmp_rev () {
694 git rev-parse --verify "$1" >expect.rev &&
695 git rev-parse --verify "$2" >actual.rev &&
696 test_cmp expect.rev actual.rev
697}
698
d17cf5f3
MK
699# Print a sequence of numbers or letters in increasing order. This is
700# similar to GNU seq(1), but the latter might not be available
701# everywhere (and does not do letters). It may be used like:
702#
9e8f8dea
DA
703# for i in $(test_seq 100)
704# do
705# for j in $(test_seq 10 20)
706# do
707# for k in $(test_seq a z)
708# do
d17cf5f3
MK
709# echo $i-$j-$k
710# done
711# done
712# done
713
714test_seq () {
715 case $# in
716 1) set 1 "$@" ;;
717 2) ;;
718 *) error "bug in the test script: not 1 or 2 parameters to test_seq" ;;
719 esac
94221d22 720 perl -le 'print for $ARGV[0]..$ARGV[1]' -- "$@"
d17cf5f3
MK
721}
722
12a29b1a
TR
723# This function can be used to schedule some commands to be run
724# unconditionally at the end of the test to restore sanity:
725#
726# test_expect_success 'test core.capslock' '
727# git config core.capslock true &&
728# test_when_finished "git config --unset core.capslock" &&
729# hello world
730# '
731#
732# That would be roughly equivalent to
733#
734# test_expect_success 'test core.capslock' '
735# git config core.capslock true &&
736# hello world
737# git config --unset core.capslock
738# '
739#
740# except that the greeting and config --unset must both succeed for
741# the test to pass.
742#
743# Note that under --immediate mode, no clean-up is done to help diagnose
744# what went wrong.
745
746test_when_finished () {
0968f12a
JK
747 # We cannot detect when we are in a subshell in general, but by
748 # doing so on Bash is better than nothing (the test will
749 # silently pass on other shells).
750 test "${BASH_SUBSHELL-0}" = 0 ||
751 error "bug in test script: test_when_finished does nothing in a subshell"
12a29b1a
TR
752 test_cleanup="{ $*
753 } && (exit \"\$eval_ret\"); eval_ret=\$?; $test_cleanup"
754}
755
756# Most tests can use the created repository, but some may need to create more.
757# Usage: test_create_repo <directory>
758test_create_repo () {
759 test "$#" = 1 ||
760 error "bug in the test script: not 1 parameter to test-create-repo"
761 repo="$1"
762 mkdir -p "$repo"
763 (
764 cd "$repo" || error "Cannot setup test environment"
765 "$GIT_EXEC_PATH/git-init" "--template=$GIT_BUILD_DIR/templates/blt/" >&3 2>&4 ||
766 error "cannot run git init -- have you built things yet?"
767 mv .git/hooks .git/hooks-disabled
768 ) || exit
769}
9ce415d9
JS
770
771# This function helps on symlink challenged file systems when it is not
772# important that the file system entry is a symbolic link.
773# Use test_ln_s_add instead of "ln -s x y && git add y" to add a
774# symbolic link entry y to the index.
775
776test_ln_s_add () {
777 if test_have_prereq SYMLINKS
778 then
779 ln -s "$1" "$2" &&
780 git update-index --add "$2"
781 else
782 printf '%s' "$1" >"$2" &&
783 ln_s_obj=$(git hash-object -w "$2") &&
817d03e1
JS
784 git update-index --add --cacheinfo 120000 $ln_s_obj "$2" &&
785 # pick up stat info from the file
786 git update-index "$2"
9ce415d9
JS
787 fi
788}
4d715ac0 789
ac9afcc3
MT
790# This function writes out its parameters, one per line
791test_write_lines () {
792 printf "%s\n" "$@"
793}
794
a0e0ec9f
JK
795perl () {
796 command "$PERL_PATH" "$@"
797}
a3a9cff0 798
83d842dc
JK
799# Is the value one of the various ways to spell a boolean true/false?
800test_normalize_bool () {
801 git -c magic.variable="$1" config --bool magic.variable 2>/dev/null
802}
803
804# Given a variable $1, normalize the value of it to one of "true",
805# "false", or "auto" and store the result to it.
806#
807# test_tristate GIT_TEST_HTTPD
808#
809# A variable set to an empty string is set to 'false'.
810# A variable set to 'false' or 'auto' keeps its value.
811# Anything else is set to 'true'.
812# An unset variable defaults to 'auto'.
813#
814# The last rule is to allow people to set the variable to an empty
815# string and export it to decline testing the particular feature
816# for versions both before and after this change. We used to treat
817# both unset and empty variable as a signal for "do not test" and
818# took any non-empty string as "please test".
819
820test_tristate () {
821 if eval "test x\"\${$1+isset}\" = xisset"
822 then
823 # explicitly set
824 eval "
825 case \"\$$1\" in
826 '') $1=false ;;
827 auto) ;;
828 *) $1=\$(test_normalize_bool \$$1 || echo true) ;;
829 esac
830 "
831 else
832 eval "$1=auto"
833 fi
834}
835
836# Exit the test suite, either by skipping all remaining tests or by
837# exiting with an error. If "$1" is "auto", we then we assume we were
838# opportunistically trying to set up some tests and we skip. If it is
839# "true", then we report a failure.
840#
841# The error/skip message should be given by $2.
842#
843test_skip_or_die () {
844 case "$1" in
845 auto)
846 skip_all=$2
847 test_done
848 ;;
849 true)
850 error "$2"
851 ;;
852 *)
853 error "BUG: test tristate is '$1' (real error: $2)"
854 esac
855}
856
4d715ac0
JS
857# The following mingw_* functions obey POSIX shell syntax, but are actually
858# bash scripts, and are meant to be used only with bash on Windows.
859
860# A test_cmp function that treats LF and CRLF equal and avoids to fork
861# diff when possible.
862mingw_test_cmp () {
863 # Read text into shell variables and compare them. If the results
864 # are different, use regular diff to report the difference.
865 local test_cmp_a= test_cmp_b=
866
867 # When text came from stdin (one argument is '-') we must feed it
868 # to diff.
869 local stdin_for_diff=
870
871 # Since it is difficult to detect the difference between an
872 # empty input file and a failure to read the files, we go straight
873 # to diff if one of the inputs is empty.
874 if test -s "$1" && test -s "$2"
875 then
876 # regular case: both files non-empty
877 mingw_read_file_strip_cr_ test_cmp_a <"$1"
878 mingw_read_file_strip_cr_ test_cmp_b <"$2"
879 elif test -s "$1" && test "$2" = -
880 then
881 # read 2nd file from stdin
882 mingw_read_file_strip_cr_ test_cmp_a <"$1"
883 mingw_read_file_strip_cr_ test_cmp_b
884 stdin_for_diff='<<<"$test_cmp_b"'
885 elif test "$1" = - && test -s "$2"
886 then
887 # read 1st file from stdin
888 mingw_read_file_strip_cr_ test_cmp_a
889 mingw_read_file_strip_cr_ test_cmp_b <"$2"
890 stdin_for_diff='<<<"$test_cmp_a"'
891 fi
892 test -n "$test_cmp_a" &&
893 test -n "$test_cmp_b" &&
894 test "$test_cmp_a" = "$test_cmp_b" ||
895 eval "diff -u \"\$@\" $stdin_for_diff"
896}
897
898# $1 is the name of the shell variable to fill in
899mingw_read_file_strip_cr_ () {
900 # Read line-wise using LF as the line separator
901 # and use IFS to strip CR.
902 local line
903 while :
904 do
905 if IFS=$'\r' read -r -d $'\n' line
906 then
907 # good
908 line=$line$'\n'
909 else
910 # we get here at EOF, but also if the last line
911 # was not terminated by LF; in the latter case,
912 # some text was read
913 if test -z "$line"
914 then
915 # EOF, really
916 break
917 fi
918 fi
919 eval "$1=\$$1\$line"
920 done
921}