Merge branch 'ta/glossary'
[git] / t / test-lib-functions.sh
1 #!/bin/sh
2 #
3 # Copyright (c) 2005 Junio C Hamano
4 #
5 # This program is free software: you can redistribute it and/or modify
6 # it under the terms of the GNU General Public License as published by
7 # the Free Software Foundation, either version 2 of the License, or
8 # (at your option) any later version.
9 #
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 # GNU General Public License for more details.
14 #
15 # You should have received a copy of the GNU General Public License
16 # along with this program.  If not, see http://www.gnu.org/licenses/ .
17
18 # The semantics of the editor variables are that of invoking
19 # sh -c "$EDITOR \"$@\"" files ...
20 #
21 # If our trash directory contains shell metacharacters, they will be
22 # interpreted if we just set $EDITOR directly, so do a little dance with
23 # environment variables to work around this.
24 #
25 # In particular, quoting isn't enough, as the path may contain the same quote
26 # that we're using.
27 test_set_editor () {
28         FAKE_EDITOR="$1"
29         export FAKE_EDITOR
30         EDITOR='"$FAKE_EDITOR"'
31         export EDITOR
32 }
33
34 test_decode_color () {
35         awk '
36                 function name(n) {
37                         if (n == 0) return "RESET";
38                         if (n == 1) return "BOLD";
39                         if (n == 30) return "BLACK";
40                         if (n == 31) return "RED";
41                         if (n == 32) return "GREEN";
42                         if (n == 33) return "YELLOW";
43                         if (n == 34) return "BLUE";
44                         if (n == 35) return "MAGENTA";
45                         if (n == 36) return "CYAN";
46                         if (n == 37) return "WHITE";
47                         if (n == 40) return "BLACK";
48                         if (n == 41) return "BRED";
49                         if (n == 42) return "BGREEN";
50                         if (n == 43) return "BYELLOW";
51                         if (n == 44) return "BBLUE";
52                         if (n == 45) return "BMAGENTA";
53                         if (n == 46) return "BCYAN";
54                         if (n == 47) return "BWHITE";
55                 }
56                 {
57                         while (match($0, /\033\[[0-9;]*m/) != 0) {
58                                 printf "%s<", substr($0, 1, RSTART-1);
59                                 codes = substr($0, RSTART+2, RLENGTH-3);
60                                 if (length(codes) == 0)
61                                         printf "%s", name(0)
62                                 else {
63                                         n = split(codes, ary, ";");
64                                         sep = "";
65                                         for (i = 1; i <= n; i++) {
66                                                 printf "%s%s", sep, name(ary[i]);
67                                                 sep = ";"
68                                         }
69                                 }
70                                 printf ">";
71                                 $0 = substr($0, RSTART + RLENGTH, length($0) - RSTART - RLENGTH + 1);
72                         }
73                         print
74                 }
75         '
76 }
77
78 nul_to_q () {
79         "$PERL_PATH" -pe 'y/\000/Q/'
80 }
81
82 q_to_nul () {
83         "$PERL_PATH" -pe 'y/Q/\000/'
84 }
85
86 q_to_cr () {
87         tr Q '\015'
88 }
89
90 q_to_tab () {
91         tr Q '\011'
92 }
93
94 qz_to_tab_space () {
95         tr QZ '\011\040'
96 }
97
98 append_cr () {
99         sed -e 's/$/Q/' | tr Q '\015'
100 }
101
102 remove_cr () {
103         tr '\015' Q | sed -e 's/Q$//'
104 }
105
106 # In some bourne shell implementations, the "unset" builtin returns
107 # nonzero status when a variable to be unset was not set in the first
108 # place.
109 #
110 # Use sane_unset when that should not be considered an error.
111
112 sane_unset () {
113         unset "$@"
114         return 0
115 }
116
117 test_tick () {
118         if test -z "${test_tick+set}"
119         then
120                 test_tick=1112911993
121         else
122                 test_tick=$(($test_tick + 60))
123         fi
124         GIT_COMMITTER_DATE="$test_tick -0700"
125         GIT_AUTHOR_DATE="$test_tick -0700"
126         export GIT_COMMITTER_DATE GIT_AUTHOR_DATE
127 }
128
129 # Stop execution and start a shell. This is useful for debugging tests and
130 # only makes sense together with "-v".
131 #
132 # Be sure to remove all invocations of this command before submitting.
133
134 test_pause () {
135         if test "$verbose" = t; then
136                 "$SHELL_PATH" <&6 >&3 2>&4
137         else
138                 error >&5 "test_pause requires --verbose"
139         fi
140 }
141
142 # Call test_commit with the arguments "<message> [<file> [<contents> [<tag>]]]"
143 #
144 # This will commit a file with the given contents and the given commit
145 # message, and tag the resulting commit with the given tag name.
146 #
147 # <file>, <contents>, and <tag> all default to <message>.
148
149 test_commit () {
150         notick= &&
151         signoff= &&
152         while test $# != 0
153         do
154                 case "$1" in
155                 --notick)
156                         notick=yes
157                         ;;
158                 --signoff)
159                         signoff="$1"
160                         ;;
161                 *)
162                         break
163                         ;;
164                 esac
165                 shift
166         done &&
167         file=${2:-"$1.t"} &&
168         echo "${3-$1}" > "$file" &&
169         git add "$file" &&
170         if test -z "$notick"
171         then
172                 test_tick
173         fi &&
174         git commit $signoff -m "$1" &&
175         git tag "${4:-$1}"
176 }
177
178 # Call test_merge with the arguments "<message> <commit>", where <commit>
179 # can be a tag pointing to the commit-to-merge.
180
181 test_merge () {
182         test_tick &&
183         git merge -m "$1" "$2" &&
184         git tag "$1"
185 }
186
187 # This function helps systems where core.filemode=false is set.
188 # Use it instead of plain 'chmod +x' to set or unset the executable bit
189 # of a file in the working directory and add it to the index.
190
191 test_chmod () {
192         chmod "$@" &&
193         git update-index --add "--chmod=$@"
194 }
195
196 # Unset a configuration variable, but don't fail if it doesn't exist.
197 test_unconfig () {
198         git config --unset-all "$@"
199         config_status=$?
200         case "$config_status" in
201         5) # ok, nothing to unset
202                 config_status=0
203                 ;;
204         esac
205         return $config_status
206 }
207
208 # Set git config, automatically unsetting it after the test is over.
209 test_config () {
210         test_when_finished "test_unconfig '$1'" &&
211         git config "$@"
212 }
213
214 test_config_global () {
215         test_when_finished "test_unconfig --global '$1'" &&
216         git config --global "$@"
217 }
218
219 write_script () {
220         {
221                 echo "#!${2-"$SHELL_PATH"}" &&
222                 cat
223         } >"$1" &&
224         chmod +x "$1"
225 }
226
227 # Use test_set_prereq to tell that a particular prerequisite is available.
228 # The prerequisite can later be checked for in two ways:
229 #
230 # - Explicitly using test_have_prereq.
231 #
232 # - Implicitly by specifying the prerequisite tag in the calls to
233 #   test_expect_{success,failure,code}.
234 #
235 # The single parameter is the prerequisite tag (a simple word, in all
236 # capital letters by convention).
237
238 test_set_prereq () {
239         satisfied_prereq="$satisfied_prereq$1 "
240 }
241 satisfied_prereq=" "
242 lazily_testable_prereq= lazily_tested_prereq=
243
244 # Usage: test_lazy_prereq PREREQ 'script'
245 test_lazy_prereq () {
246         lazily_testable_prereq="$lazily_testable_prereq$1 "
247         eval test_prereq_lazily_$1=\$2
248 }
249
250 test_run_lazy_prereq_ () {
251         script='
252 mkdir -p "$TRASH_DIRECTORY/prereq-test-dir" &&
253 (
254         cd "$TRASH_DIRECTORY/prereq-test-dir" &&'"$2"'
255 )'
256         say >&3 "checking prerequisite: $1"
257         say >&3 "$script"
258         test_eval_ "$script"
259         eval_ret=$?
260         rm -rf "$TRASH_DIRECTORY/prereq-test-dir"
261         if test "$eval_ret" = 0; then
262                 say >&3 "prerequisite $1 ok"
263         else
264                 say >&3 "prerequisite $1 not satisfied"
265         fi
266         return $eval_ret
267 }
268
269 test_have_prereq () {
270         # prerequisites can be concatenated with ','
271         save_IFS=$IFS
272         IFS=,
273         set -- $*
274         IFS=$save_IFS
275
276         total_prereq=0
277         ok_prereq=0
278         missing_prereq=
279
280         for prerequisite
281         do
282                 case "$prerequisite" in
283                 !*)
284                         negative_prereq=t
285                         prerequisite=${prerequisite#!}
286                         ;;
287                 *)
288                         negative_prereq=
289                 esac
290
291                 case " $lazily_tested_prereq " in
292                 *" $prerequisite "*)
293                         ;;
294                 *)
295                         case " $lazily_testable_prereq " in
296                         *" $prerequisite "*)
297                                 eval "script=\$test_prereq_lazily_$prerequisite" &&
298                                 if test_run_lazy_prereq_ "$prerequisite" "$script"
299                                 then
300                                         test_set_prereq $prerequisite
301                                 fi
302                                 lazily_tested_prereq="$lazily_tested_prereq$prerequisite "
303                         esac
304                         ;;
305                 esac
306
307                 total_prereq=$(($total_prereq + 1))
308                 case "$satisfied_prereq" in
309                 *" $prerequisite "*)
310                         satisfied_this_prereq=t
311                         ;;
312                 *)
313                         satisfied_this_prereq=
314                 esac
315
316                 case "$satisfied_this_prereq,$negative_prereq" in
317                 t,|,t)
318                         ok_prereq=$(($ok_prereq + 1))
319                         ;;
320                 *)
321                         # Keep a list of missing prerequisites; restore
322                         # the negative marker if necessary.
323                         prerequisite=${negative_prereq:+!}$prerequisite
324                         if test -z "$missing_prereq"
325                         then
326                                 missing_prereq=$prerequisite
327                         else
328                                 missing_prereq="$prerequisite,$missing_prereq"
329                         fi
330                 esac
331         done
332
333         test $total_prereq = $ok_prereq
334 }
335
336 test_declared_prereq () {
337         case ",$test_prereq," in
338         *,$1,*)
339                 return 0
340                 ;;
341         esac
342         return 1
343 }
344
345 test_expect_failure () {
346         test "$#" = 3 && { test_prereq=$1; shift; } || test_prereq=
347         test "$#" = 2 ||
348         error "bug in the test script: not 2 or 3 parameters to test-expect-failure"
349         export test_prereq
350         if ! test_skip "$@"
351         then
352                 say >&3 "checking known breakage: $2"
353                 if test_run_ "$2" expecting_failure
354                 then
355                         test_known_broken_ok_ "$1"
356                 else
357                         test_known_broken_failure_ "$1"
358                 fi
359         fi
360         echo >&3 ""
361 }
362
363 test_expect_success () {
364         test "$#" = 3 && { test_prereq=$1; shift; } || test_prereq=
365         test "$#" = 2 ||
366         error "bug in the test script: not 2 or 3 parameters to test-expect-success"
367         export test_prereq
368         if ! test_skip "$@"
369         then
370                 say >&3 "expecting success: $2"
371                 if test_run_ "$2"
372                 then
373                         test_ok_ "$1"
374                 else
375                         test_failure_ "$@"
376                 fi
377         fi
378         echo >&3 ""
379 }
380
381 # test_external runs external test scripts that provide continuous
382 # test output about their progress, and succeeds/fails on
383 # zero/non-zero exit code.  It outputs the test output on stdout even
384 # in non-verbose mode, and announces the external script with "# run
385 # <n>: ..." before running it.  When providing relative paths, keep in
386 # mind that all scripts run in "trash directory".
387 # Usage: test_external description command arguments...
388 # Example: test_external 'Perl API' perl ../path/to/test.pl
389 test_external () {
390         test "$#" = 4 && { test_prereq=$1; shift; } || test_prereq=
391         test "$#" = 3 ||
392         error >&5 "bug in the test script: not 3 or 4 parameters to test_external"
393         descr="$1"
394         shift
395         export test_prereq
396         if ! test_skip "$descr" "$@"
397         then
398                 # Announce the script to reduce confusion about the
399                 # test output that follows.
400                 say_color "" "# run $test_count: $descr ($*)"
401                 # Export TEST_DIRECTORY, TRASH_DIRECTORY and GIT_TEST_LONG
402                 # to be able to use them in script
403                 export TEST_DIRECTORY TRASH_DIRECTORY GIT_TEST_LONG
404                 # Run command; redirect its stderr to &4 as in
405                 # test_run_, but keep its stdout on our stdout even in
406                 # non-verbose mode.
407                 "$@" 2>&4
408                 if [ "$?" = 0 ]
409                 then
410                         if test $test_external_has_tap -eq 0; then
411                                 test_ok_ "$descr"
412                         else
413                                 say_color "" "# test_external test $descr was ok"
414                                 test_success=$(($test_success + 1))
415                         fi
416                 else
417                         if test $test_external_has_tap -eq 0; then
418                                 test_failure_ "$descr" "$@"
419                         else
420                                 say_color error "# test_external test $descr failed: $@"
421                                 test_failure=$(($test_failure + 1))
422                         fi
423                 fi
424         fi
425 }
426
427 # Like test_external, but in addition tests that the command generated
428 # no output on stderr.
429 test_external_without_stderr () {
430         # The temporary file has no (and must have no) security
431         # implications.
432         tmp=${TMPDIR:-/tmp}
433         stderr="$tmp/git-external-stderr.$$.tmp"
434         test_external "$@" 4> "$stderr"
435         [ -f "$stderr" ] || error "Internal error: $stderr disappeared."
436         descr="no stderr: $1"
437         shift
438         say >&3 "# expecting no stderr from previous command"
439         if [ ! -s "$stderr" ]; then
440                 rm "$stderr"
441
442                 if test $test_external_has_tap -eq 0; then
443                         test_ok_ "$descr"
444                 else
445                         say_color "" "# test_external_without_stderr test $descr was ok"
446                         test_success=$(($test_success + 1))
447                 fi
448         else
449                 if [ "$verbose" = t ]; then
450                         output=`echo; echo "# Stderr is:"; cat "$stderr"`
451                 else
452                         output=
453                 fi
454                 # rm first in case test_failure exits.
455                 rm "$stderr"
456                 if test $test_external_has_tap -eq 0; then
457                         test_failure_ "$descr" "$@" "$output"
458                 else
459                         say_color error "# test_external_without_stderr test $descr failed: $@: $output"
460                         test_failure=$(($test_failure + 1))
461                 fi
462         fi
463 }
464
465 # debugging-friendly alternatives to "test [-f|-d|-e]"
466 # The commands test the existence or non-existence of $1. $2 can be
467 # given to provide a more precise diagnosis.
468 test_path_is_file () {
469         if ! [ -f "$1" ]
470         then
471                 echo "File $1 doesn't exist. $*"
472                 false
473         fi
474 }
475
476 test_path_is_dir () {
477         if ! [ -d "$1" ]
478         then
479                 echo "Directory $1 doesn't exist. $*"
480                 false
481         fi
482 }
483
484 test_path_is_missing () {
485         if [ -e "$1" ]
486         then
487                 echo "Path exists:"
488                 ls -ld "$1"
489                 if [ $# -ge 1 ]; then
490                         echo "$*"
491                 fi
492                 false
493         fi
494 }
495
496 # test_line_count checks that a file has the number of lines it
497 # ought to. For example:
498 #
499 #       test_expect_success 'produce exactly one line of output' '
500 #               do something >output &&
501 #               test_line_count = 1 output
502 #       '
503 #
504 # is like "test $(wc -l <output) = 1" except that it passes the
505 # output through when the number of lines is wrong.
506
507 test_line_count () {
508         if test $# != 3
509         then
510                 error "bug in the test script: not 3 parameters to test_line_count"
511         elif ! test $(wc -l <"$3") "$1" "$2"
512         then
513                 echo "test_line_count: line count for $3 !$1 $2"
514                 cat "$3"
515                 return 1
516         fi
517 }
518
519 # This is not among top-level (test_expect_success | test_expect_failure)
520 # but is a prefix that can be used in the test script, like:
521 #
522 #       test_expect_success 'complain and die' '
523 #           do something &&
524 #           do something else &&
525 #           test_must_fail git checkout ../outerspace
526 #       '
527 #
528 # Writing this as "! git checkout ../outerspace" is wrong, because
529 # the failure could be due to a segv.  We want a controlled failure.
530
531 test_must_fail () {
532         "$@"
533         exit_code=$?
534         if test $exit_code = 0; then
535                 echo >&2 "test_must_fail: command succeeded: $*"
536                 return 1
537         elif test $exit_code -gt 129 -a $exit_code -le 192; then
538                 echo >&2 "test_must_fail: died by signal: $*"
539                 return 1
540         elif test $exit_code = 127; then
541                 echo >&2 "test_must_fail: command not found: $*"
542                 return 1
543         elif test $exit_code = 126; then
544                 echo >&2 "test_must_fail: valgrind error: $*"
545                 return 1
546         fi
547         return 0
548 }
549
550 # Similar to test_must_fail, but tolerates success, too.  This is
551 # meant to be used in contexts like:
552 #
553 #       test_expect_success 'some command works without configuration' '
554 #               test_might_fail git config --unset all.configuration &&
555 #               do something
556 #       '
557 #
558 # Writing "git config --unset all.configuration || :" would be wrong,
559 # because we want to notice if it fails due to segv.
560
561 test_might_fail () {
562         "$@"
563         exit_code=$?
564         if test $exit_code -gt 129 -a $exit_code -le 192; then
565                 echo >&2 "test_might_fail: died by signal: $*"
566                 return 1
567         elif test $exit_code = 127; then
568                 echo >&2 "test_might_fail: command not found: $*"
569                 return 1
570         fi
571         return 0
572 }
573
574 # Similar to test_must_fail and test_might_fail, but check that a
575 # given command exited with a given exit code. Meant to be used as:
576 #
577 #       test_expect_success 'Merge with d/f conflicts' '
578 #               test_expect_code 1 git merge "merge msg" B master
579 #       '
580
581 test_expect_code () {
582         want_code=$1
583         shift
584         "$@"
585         exit_code=$?
586         if test $exit_code = $want_code
587         then
588                 return 0
589         fi
590
591         echo >&2 "test_expect_code: command exited with $exit_code, we wanted $want_code $*"
592         return 1
593 }
594
595 # test_cmp is a helper function to compare actual and expected output.
596 # You can use it like:
597 #
598 #       test_expect_success 'foo works' '
599 #               echo expected >expected &&
600 #               foo >actual &&
601 #               test_cmp expected actual
602 #       '
603 #
604 # This could be written as either "cmp" or "diff -u", but:
605 # - cmp's output is not nearly as easy to read as diff -u
606 # - not all diff versions understand "-u"
607
608 test_cmp() {
609         $GIT_TEST_CMP "$@"
610 }
611
612 # Tests that its two parameters refer to the same revision
613 test_cmp_rev () {
614         git rev-parse --verify "$1" >expect.rev &&
615         git rev-parse --verify "$2" >actual.rev &&
616         test_cmp expect.rev actual.rev
617 }
618
619 # Print a sequence of numbers or letters in increasing order.  This is
620 # similar to GNU seq(1), but the latter might not be available
621 # everywhere (and does not do letters).  It may be used like:
622 #
623 #       for i in `test_seq 100`; do
624 #               for j in `test_seq 10 20`; do
625 #                       for k in `test_seq a z`; do
626 #                               echo $i-$j-$k
627 #                       done
628 #               done
629 #       done
630
631 test_seq () {
632         case $# in
633         1)      set 1 "$@" ;;
634         2)      ;;
635         *)      error "bug in the test script: not 1 or 2 parameters to test_seq" ;;
636         esac
637         "$PERL_PATH" -le 'print for $ARGV[0]..$ARGV[1]' -- "$@"
638 }
639
640 # This function can be used to schedule some commands to be run
641 # unconditionally at the end of the test to restore sanity:
642 #
643 #       test_expect_success 'test core.capslock' '
644 #               git config core.capslock true &&
645 #               test_when_finished "git config --unset core.capslock" &&
646 #               hello world
647 #       '
648 #
649 # That would be roughly equivalent to
650 #
651 #       test_expect_success 'test core.capslock' '
652 #               git config core.capslock true &&
653 #               hello world
654 #               git config --unset core.capslock
655 #       '
656 #
657 # except that the greeting and config --unset must both succeed for
658 # the test to pass.
659 #
660 # Note that under --immediate mode, no clean-up is done to help diagnose
661 # what went wrong.
662
663 test_when_finished () {
664         test_cleanup="{ $*
665                 } && (exit \"\$eval_ret\"); eval_ret=\$?; $test_cleanup"
666 }
667
668 # Most tests can use the created repository, but some may need to create more.
669 # Usage: test_create_repo <directory>
670 test_create_repo () {
671         test "$#" = 1 ||
672         error "bug in the test script: not 1 parameter to test-create-repo"
673         repo="$1"
674         mkdir -p "$repo"
675         (
676                 cd "$repo" || error "Cannot setup test environment"
677                 "$GIT_EXEC_PATH/git-init" "--template=$GIT_BUILD_DIR/templates/blt/" >&3 2>&4 ||
678                 error "cannot run git init -- have you built things yet?"
679                 mv .git/hooks .git/hooks-disabled
680         ) || exit
681 }