]>
Commit | Line | Data |
---|---|---|
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. | |
28 | test_set_editor () { | |
29 | FAKE_EDITOR="$1" | |
30 | export FAKE_EDITOR | |
31 | EDITOR='"$FAKE_EDITOR"' | |
32 | export EDITOR | |
33 | } | |
34 | ||
5d9fc888 TG |
35 | test_set_index_version () { |
36 | GIT_INDEX_VERSION="$1" | |
37 | export GIT_INDEX_VERSION | |
38 | } | |
39 | ||
12a29b1a TR |
40 | test_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 | ||
83 | } | |
84 | ' | |
85 | } | |
86 | ||
b249e39f JH |
87 | lf_to_nul () { |
88 | perl -pe 'y/\012/\000/' | |
89 | } | |
90 | ||
12a29b1a | 91 | nul_to_q () { |
94221d22 | 92 | perl -pe 'y/\000/Q/' |
12a29b1a TR |
93 | } |
94 | ||
95 | q_to_nul () { | |
94221d22 | 96 | perl -pe 'y/Q/\000/' |
12a29b1a TR |
97 | } |
98 | ||
99 | q_to_cr () { | |
100 | tr Q '\015' | |
101 | } | |
102 | ||
103 | q_to_tab () { | |
104 | tr Q '\011' | |
105 | } | |
106 | ||
250b3c6c JH |
107 | qz_to_tab_space () { |
108 | tr QZ '\011\040' | |
12a29b1a TR |
109 | } |
110 | ||
111 | append_cr () { | |
112 | sed -e 's/$/Q/' | tr Q '\015' | |
113 | } | |
114 | ||
115 | remove_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. | |
122 | generate_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 | ||
132 | sane_unset () { | |
133 | unset "$@" | |
134 | return 0 | |
135 | } | |
136 | ||
137 | test_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 | ||
153 | test_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 | 164 | debug () { |
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 | |
192 | test_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 | ||
230 | test_merge () { | |
94ba1513 DL |
231 | label="$1" && |
232 | shift && | |
12a29b1a | 233 | test_tick && |
94ba1513 DL |
234 | git merge -m "$label" "$@" && |
235 | git tag "$label" | |
12a29b1a TR |
236 | } |
237 | ||
b1c36cb8 JK |
238 | # Efficiently create <nr> commits, each with a unique number (from 1 to <nr> |
239 | # by default) in the commit message. | |
240 | # | |
241 | # Usage: test_commit_bulk [options] <nr> | |
242 | # -C <dir>: | |
243 | # Run all git commands in directory <dir> | |
244 | # --ref=<n>: | |
245 | # ref on which to create commits (default: HEAD) | |
246 | # --start=<n>: | |
247 | # number commit messages from <n> (default: 1) | |
248 | # --message=<msg>: | |
249 | # use <msg> as the commit mesasge (default: "commit %s") | |
250 | # --filename=<fn>: | |
251 | # modify <fn> in each commit (default: %s.t) | |
252 | # --contents=<string>: | |
253 | # place <string> in each file (default: "content %s") | |
254 | # --id=<string>: | |
255 | # shorthand to use <string> and %s in message, filename, and contents | |
256 | # | |
257 | # The message, filename, and contents strings are evaluated by printf, with the | |
258 | # first "%s" replaced by the current commit number. So you can do: | |
259 | # | |
260 | # test_commit_bulk --filename=file --contents="modification %s" | |
261 | # | |
262 | # to have every commit touch the same file, but with unique content. | |
263 | # | |
264 | test_commit_bulk () { | |
265 | tmpfile=.bulk-commit.input | |
266 | indir=. | |
267 | ref=HEAD | |
268 | n=1 | |
269 | message='commit %s' | |
270 | filename='%s.t' | |
271 | contents='content %s' | |
272 | while test $# -gt 0 | |
273 | do | |
274 | case "$1" in | |
275 | -C) | |
276 | indir=$2 | |
277 | shift | |
278 | ;; | |
279 | --ref=*) | |
280 | ref=${1#--*=} | |
281 | ;; | |
282 | --start=*) | |
283 | n=${1#--*=} | |
284 | ;; | |
285 | --message=*) | |
286 | message=${1#--*=} | |
287 | ;; | |
288 | --filename=*) | |
289 | filename=${1#--*=} | |
290 | ;; | |
291 | --contents=*) | |
292 | contents=${1#--*=} | |
293 | ;; | |
294 | --id=*) | |
295 | message="${1#--*=} %s" | |
296 | filename="${1#--*=}-%s.t" | |
297 | contents="${1#--*=} %s" | |
298 | ;; | |
299 | -*) | |
300 | BUG "invalid test_commit_bulk option: $1" | |
301 | ;; | |
302 | *) | |
303 | break | |
304 | ;; | |
305 | esac | |
306 | shift | |
307 | done | |
308 | total=$1 | |
309 | ||
310 | add_from= | |
fc42f20e | 311 | if git -C "$indir" rev-parse --quiet --verify "$ref" |
b1c36cb8 JK |
312 | then |
313 | add_from=t | |
314 | fi | |
315 | ||
316 | while test "$total" -gt 0 | |
317 | do | |
318 | test_tick && | |
319 | echo "commit $ref" | |
320 | printf 'author %s <%s> %s\n' \ | |
321 | "$GIT_AUTHOR_NAME" \ | |
322 | "$GIT_AUTHOR_EMAIL" \ | |
323 | "$GIT_AUTHOR_DATE" | |
324 | printf 'committer %s <%s> %s\n' \ | |
325 | "$GIT_COMMITTER_NAME" \ | |
326 | "$GIT_COMMITTER_EMAIL" \ | |
327 | "$GIT_COMMITTER_DATE" | |
328 | echo "data <<EOF" | |
329 | printf "$message\n" $n | |
330 | echo "EOF" | |
331 | if test -n "$add_from" | |
332 | then | |
333 | echo "from $ref^0" | |
334 | add_from= | |
335 | fi | |
336 | printf "M 644 inline $filename\n" $n | |
337 | echo "data <<EOF" | |
338 | printf "$contents\n" $n | |
339 | echo "EOF" | |
340 | echo | |
341 | n=$((n + 1)) | |
342 | total=$((total - 1)) | |
343 | done >"$tmpfile" | |
344 | ||
345 | git -C "$indir" \ | |
346 | -c fastimport.unpacklimit=0 \ | |
347 | fast-import <"$tmpfile" || return 1 | |
348 | ||
349 | # This will be left in place on failure, which may aid debugging. | |
350 | rm -f "$tmpfile" | |
351 | ||
352 | # If we updated HEAD, then be nice and update the index and working | |
353 | # tree, too. | |
354 | if test "$ref" = "HEAD" | |
355 | then | |
356 | git -C "$indir" checkout -f HEAD || return 1 | |
357 | fi | |
358 | ||
359 | } | |
360 | ||
12a29b1a TR |
361 | # This function helps systems where core.filemode=false is set. |
362 | # Use it instead of plain 'chmod +x' to set or unset the executable bit | |
363 | # of a file in the working directory and add it to the index. | |
364 | ||
365 | test_chmod () { | |
366 | chmod "$@" && | |
367 | git update-index --add "--chmod=$@" | |
368 | } | |
369 | ||
ea8bbf2a MT |
370 | # Get the modebits from a file or directory, ignoring the setgid bit (g+s). |
371 | # This bit is inherited by subdirectories at their creation. So we remove it | |
372 | # from the returning string to prevent callers from having to worry about the | |
373 | # state of the bit in the test directory. | |
374 | # | |
73de1c93 | 375 | test_modebits () { |
ea8bbf2a MT |
376 | ls -ld "$1" | sed -e 's|^\(..........\).*|\1|' \ |
377 | -e 's|^\(......\)S|\1-|' -e 's|^\(......\)s|\1x|' | |
73de1c93 CC |
378 | } |
379 | ||
12a29b1a TR |
380 | # Unset a configuration variable, but don't fail if it doesn't exist. |
381 | test_unconfig () { | |
5fafc07f JK |
382 | config_dir= |
383 | if test "$1" = -C | |
384 | then | |
385 | shift | |
386 | config_dir=$1 | |
387 | shift | |
388 | fi | |
389 | git ${config_dir:+-C "$config_dir"} config --unset-all "$@" | |
12a29b1a TR |
390 | config_status=$? |
391 | case "$config_status" in | |
392 | 5) # ok, nothing to unset | |
393 | config_status=0 | |
394 | ;; | |
395 | esac | |
396 | return $config_status | |
397 | } | |
398 | ||
399 | # Set git config, automatically unsetting it after the test is over. | |
400 | test_config () { | |
5fafc07f JK |
401 | config_dir= |
402 | if test "$1" = -C | |
403 | then | |
404 | shift | |
405 | config_dir=$1 | |
406 | shift | |
407 | fi | |
408 | test_when_finished "test_unconfig ${config_dir:+-C '$config_dir'} '$1'" && | |
409 | git ${config_dir:+-C "$config_dir"} config "$@" | |
12a29b1a TR |
410 | } |
411 | ||
412 | test_config_global () { | |
413 | test_when_finished "test_unconfig --global '$1'" && | |
414 | git config --global "$@" | |
415 | } | |
416 | ||
417 | write_script () { | |
418 | { | |
419 | echo "#!${2-"$SHELL_PATH"}" && | |
420 | cat | |
421 | } >"$1" && | |
422 | chmod +x "$1" | |
423 | } | |
424 | ||
425 | # Use test_set_prereq to tell that a particular prerequisite is available. | |
426 | # The prerequisite can later be checked for in two ways: | |
427 | # | |
428 | # - Explicitly using test_have_prereq. | |
429 | # | |
430 | # - Implicitly by specifying the prerequisite tag in the calls to | |
7f9c59dd | 431 | # test_expect_{success,failure} and test_external{,_without_stderr}. |
12a29b1a TR |
432 | # |
433 | # The single parameter is the prerequisite tag (a simple word, in all | |
434 | # capital letters by convention). | |
435 | ||
7d0ee47c JS |
436 | test_unset_prereq () { |
437 | ! test_have_prereq "$1" || | |
438 | satisfied_prereq="${satisfied_prereq% $1 *} ${satisfied_prereq#* $1 }" | |
439 | } | |
440 | ||
12a29b1a | 441 | test_set_prereq () { |
c7400399 | 442 | if test -n "$GIT_TEST_FAIL_PREREQS_INTERNAL" |
dfe1a17d ÆAB |
443 | then |
444 | case "$1" in | |
445 | # The "!" case is handled below with | |
446 | # test_unset_prereq() | |
447 | !*) | |
448 | ;; | |
449 | # (Temporary?) whitelist of things we can't easily | |
450 | # pretend not to support | |
451 | SYMLINKS) | |
452 | ;; | |
453 | # Inspecting whether GIT_TEST_FAIL_PREREQS is on | |
454 | # should be unaffected. | |
455 | FAIL_PREREQS) | |
456 | ;; | |
457 | *) | |
458 | return | |
459 | esac | |
460 | fi | |
461 | ||
7d0ee47c JS |
462 | case "$1" in |
463 | !*) | |
464 | test_unset_prereq "${1#!}" | |
465 | ;; | |
466 | *) | |
467 | satisfied_prereq="$satisfied_prereq$1 " | |
468 | ;; | |
469 | esac | |
12a29b1a | 470 | } |
f3cfc3b2 | 471 | satisfied_prereq=" " |
04083f27 JH |
472 | lazily_testable_prereq= lazily_tested_prereq= |
473 | ||
474 | # Usage: test_lazy_prereq PREREQ 'script' | |
475 | test_lazy_prereq () { | |
476 | lazily_testable_prereq="$lazily_testable_prereq$1 " | |
477 | eval test_prereq_lazily_$1=\$2 | |
478 | } | |
479 | ||
480 | test_run_lazy_prereq_ () { | |
481 | script=' | |
53ff3b96 | 482 | mkdir -p "$TRASH_DIRECTORY/prereq-test-dir-'"$1"'" && |
04083f27 | 483 | ( |
53ff3b96 | 484 | cd "$TRASH_DIRECTORY/prereq-test-dir-'"$1"'" &&'"$2"' |
04083f27 JH |
485 | )' |
486 | say >&3 "checking prerequisite: $1" | |
487 | say >&3 "$script" | |
488 | test_eval_ "$script" | |
489 | eval_ret=$? | |
53ff3b96 | 490 | rm -rf "$TRASH_DIRECTORY/prereq-test-dir-$1" |
04083f27 JH |
491 | if test "$eval_ret" = 0; then |
492 | say >&3 "prerequisite $1 ok" | |
493 | else | |
494 | say >&3 "prerequisite $1 not satisfied" | |
495 | fi | |
496 | return $eval_ret | |
497 | } | |
12a29b1a TR |
498 | |
499 | test_have_prereq () { | |
500 | # prerequisites can be concatenated with ',' | |
501 | save_IFS=$IFS | |
502 | IFS=, | |
503 | set -- $* | |
504 | IFS=$save_IFS | |
505 | ||
506 | total_prereq=0 | |
507 | ok_prereq=0 | |
508 | missing_prereq= | |
509 | ||
510 | for prerequisite | |
511 | do | |
bdccd3c1 JK |
512 | case "$prerequisite" in |
513 | !*) | |
514 | negative_prereq=t | |
515 | prerequisite=${prerequisite#!} | |
516 | ;; | |
517 | *) | |
518 | negative_prereq= | |
519 | esac | |
520 | ||
04083f27 JH |
521 | case " $lazily_tested_prereq " in |
522 | *" $prerequisite "*) | |
523 | ;; | |
524 | *) | |
525 | case " $lazily_testable_prereq " in | |
526 | *" $prerequisite "*) | |
527 | eval "script=\$test_prereq_lazily_$prerequisite" && | |
528 | if test_run_lazy_prereq_ "$prerequisite" "$script" | |
529 | then | |
530 | test_set_prereq $prerequisite | |
531 | fi | |
532 | lazily_tested_prereq="$lazily_tested_prereq$prerequisite " | |
533 | esac | |
534 | ;; | |
535 | esac | |
536 | ||
12a29b1a | 537 | total_prereq=$(($total_prereq + 1)) |
f3cfc3b2 | 538 | case "$satisfied_prereq" in |
12a29b1a | 539 | *" $prerequisite "*) |
bdccd3c1 JK |
540 | satisfied_this_prereq=t |
541 | ;; | |
542 | *) | |
543 | satisfied_this_prereq= | |
544 | esac | |
545 | ||
546 | case "$satisfied_this_prereq,$negative_prereq" in | |
547 | t,|,t) | |
12a29b1a TR |
548 | ok_prereq=$(($ok_prereq + 1)) |
549 | ;; | |
550 | *) | |
bdccd3c1 JK |
551 | # Keep a list of missing prerequisites; restore |
552 | # the negative marker if necessary. | |
553 | prerequisite=${negative_prereq:+!}$prerequisite | |
12a29b1a TR |
554 | if test -z "$missing_prereq" |
555 | then | |
556 | missing_prereq=$prerequisite | |
557 | else | |
558 | missing_prereq="$prerequisite,$missing_prereq" | |
559 | fi | |
560 | esac | |
561 | done | |
562 | ||
563 | test $total_prereq = $ok_prereq | |
564 | } | |
565 | ||
566 | test_declared_prereq () { | |
567 | case ",$test_prereq," in | |
568 | *,$1,*) | |
569 | return 0 | |
570 | ;; | |
571 | esac | |
572 | return 1 | |
573 | } | |
574 | ||
d93d5d51 JH |
575 | test_verify_prereq () { |
576 | test -z "$test_prereq" || | |
577 | expr >/dev/null "$test_prereq" : '[A-Z0-9_,!]*$' || | |
165293af | 578 | BUG "'$test_prereq' does not look like a prereq" |
d93d5d51 JH |
579 | } |
580 | ||
12a29b1a | 581 | test_expect_failure () { |
ae75342c | 582 | test_start_ |
12a29b1a TR |
583 | test "$#" = 3 && { test_prereq=$1; shift; } || test_prereq= |
584 | test "$#" = 2 || | |
165293af | 585 | BUG "not 2 or 3 parameters to test-expect-failure" |
d93d5d51 | 586 | test_verify_prereq |
12a29b1a TR |
587 | export test_prereq |
588 | if ! test_skip "$@" | |
589 | then | |
ffe1afe6 | 590 | say >&3 "checking known breakage of $TEST_NUMBER.$test_count '$1': $2" |
12a29b1a TR |
591 | if test_run_ "$2" expecting_failure |
592 | then | |
593 | test_known_broken_ok_ "$1" | |
594 | else | |
595 | test_known_broken_failure_ "$1" | |
596 | fi | |
597 | fi | |
ae75342c | 598 | test_finish_ |
12a29b1a TR |
599 | } |
600 | ||
601 | test_expect_success () { | |
ae75342c | 602 | test_start_ |
12a29b1a TR |
603 | test "$#" = 3 && { test_prereq=$1; shift; } || test_prereq= |
604 | test "$#" = 2 || | |
165293af | 605 | BUG "not 2 or 3 parameters to test-expect-success" |
d93d5d51 | 606 | test_verify_prereq |
12a29b1a TR |
607 | export test_prereq |
608 | if ! test_skip "$@" | |
609 | then | |
ffe1afe6 | 610 | say >&3 "expecting success of $TEST_NUMBER.$test_count '$1': $2" |
12a29b1a TR |
611 | if test_run_ "$2" |
612 | then | |
613 | test_ok_ "$1" | |
614 | else | |
615 | test_failure_ "$@" | |
616 | fi | |
617 | fi | |
ae75342c | 618 | test_finish_ |
12a29b1a TR |
619 | } |
620 | ||
621 | # test_external runs external test scripts that provide continuous | |
622 | # test output about their progress, and succeeds/fails on | |
623 | # zero/non-zero exit code. It outputs the test output on stdout even | |
624 | # in non-verbose mode, and announces the external script with "# run | |
625 | # <n>: ..." before running it. When providing relative paths, keep in | |
626 | # mind that all scripts run in "trash directory". | |
627 | # Usage: test_external description command arguments... | |
628 | # Example: test_external 'Perl API' perl ../path/to/test.pl | |
629 | test_external () { | |
630 | test "$#" = 4 && { test_prereq=$1; shift; } || test_prereq= | |
631 | test "$#" = 3 || | |
165293af | 632 | BUG "not 3 or 4 parameters to test_external" |
12a29b1a TR |
633 | descr="$1" |
634 | shift | |
d93d5d51 | 635 | test_verify_prereq |
12a29b1a TR |
636 | export test_prereq |
637 | if ! test_skip "$descr" "$@" | |
638 | then | |
639 | # Announce the script to reduce confusion about the | |
640 | # test output that follows. | |
641 | say_color "" "# run $test_count: $descr ($*)" | |
642 | # Export TEST_DIRECTORY, TRASH_DIRECTORY and GIT_TEST_LONG | |
643 | # to be able to use them in script | |
644 | export TEST_DIRECTORY TRASH_DIRECTORY GIT_TEST_LONG | |
645 | # Run command; redirect its stderr to &4 as in | |
646 | # test_run_, but keep its stdout on our stdout even in | |
647 | # non-verbose mode. | |
648 | "$@" 2>&4 | |
9e8f8dea | 649 | if test "$?" = 0 |
12a29b1a TR |
650 | then |
651 | if test $test_external_has_tap -eq 0; then | |
652 | test_ok_ "$descr" | |
653 | else | |
654 | say_color "" "# test_external test $descr was ok" | |
655 | test_success=$(($test_success + 1)) | |
656 | fi | |
657 | else | |
658 | if test $test_external_has_tap -eq 0; then | |
659 | test_failure_ "$descr" "$@" | |
660 | else | |
661 | say_color error "# test_external test $descr failed: $@" | |
662 | test_failure=$(($test_failure + 1)) | |
663 | fi | |
664 | fi | |
665 | fi | |
666 | } | |
667 | ||
668 | # Like test_external, but in addition tests that the command generated | |
669 | # no output on stderr. | |
670 | test_external_without_stderr () { | |
671 | # The temporary file has no (and must have no) security | |
672 | # implications. | |
673 | tmp=${TMPDIR:-/tmp} | |
674 | stderr="$tmp/git-external-stderr.$$.tmp" | |
675 | test_external "$@" 4> "$stderr" | |
9e8f8dea | 676 | test -f "$stderr" || error "Internal error: $stderr disappeared." |
12a29b1a TR |
677 | descr="no stderr: $1" |
678 | shift | |
679 | say >&3 "# expecting no stderr from previous command" | |
9e8f8dea DA |
680 | if test ! -s "$stderr" |
681 | then | |
12a29b1a TR |
682 | rm "$stderr" |
683 | ||
684 | if test $test_external_has_tap -eq 0; then | |
685 | test_ok_ "$descr" | |
686 | else | |
687 | say_color "" "# test_external_without_stderr test $descr was ok" | |
688 | test_success=$(($test_success + 1)) | |
689 | fi | |
690 | else | |
9e8f8dea DA |
691 | if test "$verbose" = t |
692 | then | |
693 | output=$(echo; echo "# Stderr is:"; cat "$stderr") | |
12a29b1a TR |
694 | else |
695 | output= | |
696 | fi | |
697 | # rm first in case test_failure exits. | |
698 | rm "$stderr" | |
699 | if test $test_external_has_tap -eq 0; then | |
700 | test_failure_ "$descr" "$@" "$output" | |
701 | else | |
702 | say_color error "# test_external_without_stderr test $descr failed: $@: $output" | |
703 | test_failure=$(($test_failure + 1)) | |
704 | fi | |
705 | fi | |
706 | } | |
707 | ||
708 | # debugging-friendly alternatives to "test [-f|-d|-e]" | |
709 | # The commands test the existence or non-existence of $1. $2 can be | |
710 | # given to provide a more precise diagnosis. | |
711 | test_path_is_file () { | |
9e8f8dea | 712 | if ! test -f "$1" |
12a29b1a | 713 | then |
de248e92 | 714 | echo "File $1 doesn't exist. $2" |
12a29b1a TR |
715 | false |
716 | fi | |
717 | } | |
718 | ||
719 | test_path_is_dir () { | |
9e8f8dea | 720 | if ! test -d "$1" |
12a29b1a | 721 | then |
de248e92 | 722 | echo "Directory $1 doesn't exist. $2" |
12a29b1a TR |
723 | false |
724 | fi | |
725 | } | |
726 | ||
7e9055bb EN |
727 | test_path_exists () { |
728 | if ! test -e "$1" | |
729 | then | |
730 | echo "Path $1 doesn't exist. $2" | |
731 | false | |
732 | fi | |
733 | } | |
734 | ||
0be7d9b7 JL |
735 | # Check if the directory exists and is empty as expected, barf otherwise. |
736 | test_dir_is_empty () { | |
737 | test_path_is_dir "$1" && | |
738 | if test -n "$(ls -a1 "$1" | egrep -v '^\.\.?$')" | |
739 | then | |
740 | echo "Directory '$1' is not empty, it contains:" | |
741 | ls -la "$1" | |
742 | return 1 | |
743 | fi | |
744 | } | |
745 | ||
21d5ad91 RA |
746 | # Check if the file exists and has a size greater than zero |
747 | test_file_not_empty () { | |
748 | if ! test -s "$1" | |
749 | then | |
750 | echo "'$1' is not a non-empty file." | |
751 | false | |
752 | fi | |
753 | } | |
754 | ||
12a29b1a | 755 | test_path_is_missing () { |
9e8f8dea | 756 | if test -e "$1" |
12a29b1a TR |
757 | then |
758 | echo "Path exists:" | |
759 | ls -ld "$1" | |
9e8f8dea DA |
760 | if test $# -ge 1 |
761 | then | |
12a29b1a TR |
762 | echo "$*" |
763 | fi | |
764 | false | |
765 | fi | |
766 | } | |
767 | ||
768 | # test_line_count checks that a file has the number of lines it | |
769 | # ought to. For example: | |
770 | # | |
771 | # test_expect_success 'produce exactly one line of output' ' | |
772 | # do something >output && | |
773 | # test_line_count = 1 output | |
774 | # ' | |
775 | # | |
776 | # is like "test $(wc -l <output) = 1" except that it passes the | |
777 | # output through when the number of lines is wrong. | |
778 | ||
779 | test_line_count () { | |
780 | if test $# != 3 | |
781 | then | |
165293af | 782 | BUG "not 3 parameters to test_line_count" |
12a29b1a TR |
783 | elif ! test $(wc -l <"$3") "$1" "$2" |
784 | then | |
785 | echo "test_line_count: line count for $3 !$1 $2" | |
786 | cat "$3" | |
787 | return 1 | |
788 | fi | |
789 | } | |
790 | ||
53b67a80 JS |
791 | test_file_size () { |
792 | test-tool path-utils file-size "$1" | |
793 | } | |
794 | ||
bbfe5302 LS |
795 | # Returns success if a comma separated string of keywords ($1) contains a |
796 | # given keyword ($2). | |
797 | # Examples: | |
798 | # `list_contains "foo,bar" bar` returns 0 | |
799 | # `list_contains "foo" bar` returns 1 | |
800 | ||
801 | list_contains () { | |
802 | case ",$1," in | |
803 | *,$2,*) | |
804 | return 0 | |
805 | ;; | |
806 | esac | |
807 | return 1 | |
808 | } | |
809 | ||
6a67c759 DL |
810 | # Returns success if the arguments indicate that a command should be |
811 | # accepted by test_must_fail(). If the command is run with env, the env | |
812 | # and its corresponding variable settings will be stripped before we | |
813 | # test the command being run. | |
814 | test_must_fail_acceptable () { | |
815 | if test "$1" = "env" | |
816 | then | |
817 | shift | |
818 | while test $# -gt 0 | |
819 | do | |
820 | case "$1" in | |
821 | *?=*) | |
822 | shift | |
823 | ;; | |
824 | *) | |
825 | break | |
826 | ;; | |
827 | esac | |
828 | done | |
829 | fi | |
830 | ||
831 | case "$1" in | |
fc47391e | 832 | git|__git*|test-tool|test_terminal) |
6a67c759 DL |
833 | return 0 |
834 | ;; | |
835 | *) | |
836 | return 1 | |
837 | ;; | |
838 | esac | |
839 | } | |
840 | ||
12a29b1a TR |
841 | # This is not among top-level (test_expect_success | test_expect_failure) |
842 | # but is a prefix that can be used in the test script, like: | |
843 | # | |
844 | # test_expect_success 'complain and die' ' | |
845 | # do something && | |
846 | # do something else && | |
847 | # test_must_fail git checkout ../outerspace | |
848 | # ' | |
849 | # | |
850 | # Writing this as "! git checkout ../outerspace" is wrong, because | |
851 | # the failure could be due to a segv. We want a controlled failure. | |
12e31a6b SG |
852 | # |
853 | # Accepts the following options: | |
854 | # | |
855 | # ok=<signal-name>[,<...>]: | |
856 | # Don't treat an exit caused by the given signal as error. | |
857 | # Multiple signals can be specified as a comma separated list. | |
858 | # Currently recognized signal names are: sigpipe, success. | |
859 | # (Don't use 'success', use 'test_might_fail' instead.) | |
6a67c759 DL |
860 | # |
861 | # Do not use this to run anything but "git" and other specific testable | |
862 | # commands (see test_must_fail_acceptable()). We are not in the | |
863 | # business of vetting system supplied commands -- in other words, this | |
864 | # is wrong: | |
865 | # | |
866 | # test_must_fail grep pattern output | |
867 | # | |
868 | # Instead use '!': | |
869 | # | |
870 | # ! grep pattern output | |
12a29b1a TR |
871 | |
872 | test_must_fail () { | |
bbfe5302 LS |
873 | case "$1" in |
874 | ok=*) | |
875 | _test_ok=${1#ok=} | |
876 | shift | |
877 | ;; | |
878 | *) | |
879 | _test_ok= | |
880 | ;; | |
881 | esac | |
6a67c759 DL |
882 | if ! test_must_fail_acceptable "$@" |
883 | then | |
884 | echo >&7 "test_must_fail: only 'git' is allowed: $*" | |
885 | return 1 | |
886 | fi | |
a5bf824f | 887 | "$@" 2>&7 |
12a29b1a | 888 | exit_code=$? |
bbfe5302 LS |
889 | if test $exit_code -eq 0 && ! list_contains "$_test_ok" success |
890 | then | |
03aa3783 | 891 | echo >&4 "test_must_fail: command succeeded: $*" |
12a29b1a | 892 | return 1 |
2472448c | 893 | elif test_match_signal 13 $exit_code && list_contains "$_test_ok" sigpipe |
8bf4becf LS |
894 | then |
895 | return 0 | |
bbfe5302 LS |
896 | elif test $exit_code -gt 129 && test $exit_code -le 192 |
897 | then | |
03aa3783 | 898 | echo >&4 "test_must_fail: died by signal $(($exit_code - 128)): $*" |
12a29b1a | 899 | return 1 |
bbfe5302 LS |
900 | elif test $exit_code -eq 127 |
901 | then | |
03aa3783 | 902 | echo >&4 "test_must_fail: command not found: $*" |
12a29b1a | 903 | return 1 |
bbfe5302 LS |
904 | elif test $exit_code -eq 126 |
905 | then | |
03aa3783 | 906 | echo >&4 "test_must_fail: valgrind error: $*" |
eeb69131 | 907 | return 1 |
12a29b1a TR |
908 | fi |
909 | return 0 | |
a5bf824f | 910 | } 7>&2 2>&4 |
12a29b1a TR |
911 | |
912 | # Similar to test_must_fail, but tolerates success, too. This is | |
913 | # meant to be used in contexts like: | |
914 | # | |
915 | # test_expect_success 'some command works without configuration' ' | |
916 | # test_might_fail git config --unset all.configuration && | |
917 | # do something | |
918 | # ' | |
919 | # | |
920 | # Writing "git config --unset all.configuration || :" would be wrong, | |
921 | # because we want to notice if it fails due to segv. | |
12e31a6b SG |
922 | # |
923 | # Accepts the same options as test_must_fail. | |
12a29b1a TR |
924 | |
925 | test_might_fail () { | |
a5bf824f SG |
926 | test_must_fail ok=success "$@" 2>&7 |
927 | } 7>&2 2>&4 | |
12a29b1a TR |
928 | |
929 | # Similar to test_must_fail and test_might_fail, but check that a | |
930 | # given command exited with a given exit code. Meant to be used as: | |
931 | # | |
932 | # test_expect_success 'Merge with d/f conflicts' ' | |
933 | # test_expect_code 1 git merge "merge msg" B master | |
934 | # ' | |
935 | ||
936 | test_expect_code () { | |
937 | want_code=$1 | |
938 | shift | |
a5bf824f | 939 | "$@" 2>&7 |
12a29b1a TR |
940 | exit_code=$? |
941 | if test $exit_code = $want_code | |
942 | then | |
943 | return 0 | |
944 | fi | |
945 | ||
03aa3783 | 946 | echo >&4 "test_expect_code: command exited with $exit_code, we wanted $want_code $*" |
12a29b1a | 947 | return 1 |
a5bf824f | 948 | } 7>&2 2>&4 |
12a29b1a TR |
949 | |
950 | # test_cmp is a helper function to compare actual and expected output. | |
951 | # You can use it like: | |
952 | # | |
953 | # test_expect_success 'foo works' ' | |
954 | # echo expected >expected && | |
955 | # foo >actual && | |
956 | # test_cmp expected actual | |
957 | # ' | |
958 | # | |
959 | # This could be written as either "cmp" or "diff -u", but: | |
960 | # - cmp's output is not nearly as easy to read as diff -u | |
961 | # - not all diff versions understand "-u" | |
962 | ||
1ab7e00e | 963 | test_cmp () { |
262d5ad5 | 964 | eval "$GIT_TEST_CMP" '"$@"' |
12a29b1a TR |
965 | } |
966 | ||
a5db0b77 NTND |
967 | # Check that the given config key has the expected value. |
968 | # | |
969 | # test_cmp_config [-C <dir>] <expected-value> | |
970 | # [<git-config-options>...] <config-key> | |
971 | # | |
972 | # for example to check that the value of core.bar is foo | |
973 | # | |
974 | # test_cmp_config foo core.bar | |
975 | # | |
1ab7e00e | 976 | test_cmp_config () { |
a5db0b77 NTND |
977 | local GD && |
978 | if test "$1" = "-C" | |
979 | then | |
980 | shift && | |
981 | GD="-C $1" && | |
982 | shift | |
983 | fi && | |
984 | printf "%s\n" "$1" >expect.config && | |
985 | shift && | |
986 | git $GD config "$@" >actual.config && | |
987 | test_cmp expect.config actual.config | |
988 | } | |
989 | ||
b93e6e36 SK |
990 | # test_cmp_bin - helper to compare binary files |
991 | ||
1ab7e00e | 992 | test_cmp_bin () { |
262d5ad5 | 993 | cmp "$@" |
b93e6e36 SK |
994 | } |
995 | ||
0f59128f SG |
996 | # Use this instead of test_cmp to compare files that contain expected and |
997 | # actual output from git commands that can be translated. When running | |
6cdccfce | 998 | # under GIT_TEST_GETTEXT_POISON this pretends that the command produced expected |
0f59128f SG |
999 | # results. |
1000 | test_i18ncmp () { | |
6cdccfce | 1001 | ! test_have_prereq C_LOCALE_OUTPUT || test_cmp "$@" |
0f59128f SG |
1002 | } |
1003 | ||
1004 | # Use this instead of "grep expected-string actual" to see if the | |
1005 | # output from a git command that can be translated either contains an | |
1006 | # expected string, or does not contain an unwanted one. When running | |
6cdccfce | 1007 | # under GIT_TEST_GETTEXT_POISON this pretends that the command produced expected |
0f59128f SG |
1008 | # results. |
1009 | test_i18ngrep () { | |
fd29d7b9 SG |
1010 | eval "last_arg=\${$#}" |
1011 | ||
1012 | test -f "$last_arg" || | |
165293af | 1013 | BUG "test_i18ngrep requires a file to read as the last parameter" |
fd29d7b9 SG |
1014 | |
1015 | if test $# -lt 2 || | |
1016 | { test "x!" = "x$1" && test $# -lt 3 ; } | |
1017 | then | |
165293af | 1018 | BUG "too few parameters to test_i18ngrep" |
fd29d7b9 SG |
1019 | fi |
1020 | ||
6cdccfce | 1021 | if test_have_prereq !C_LOCALE_OUTPUT |
0f59128f | 1022 | then |
63b1a175 SG |
1023 | # pretend success |
1024 | return 0 | |
1025 | fi | |
1026 | ||
1027 | if test "x!" = "x$1" | |
0f59128f SG |
1028 | then |
1029 | shift | |
63b1a175 SG |
1030 | ! grep "$@" && return 0 |
1031 | ||
03aa3783 | 1032 | echo >&4 "error: '! grep $@' did find a match in:" |
0f59128f | 1033 | else |
63b1a175 SG |
1034 | grep "$@" && return 0 |
1035 | ||
03aa3783 | 1036 | echo >&4 "error: 'grep $@' didn't find a match in:" |
0f59128f | 1037 | fi |
63b1a175 SG |
1038 | |
1039 | if test -s "$last_arg" | |
1040 | then | |
03aa3783 | 1041 | cat >&4 "$last_arg" |
63b1a175 | 1042 | else |
03aa3783 | 1043 | echo >&4 "<File '$last_arg' is empty>" |
63b1a175 SG |
1044 | fi |
1045 | ||
1046 | return 1 | |
0f59128f SG |
1047 | } |
1048 | ||
8ad16524 JK |
1049 | # Call any command "$@" but be more verbose about its |
1050 | # failure. This is handy for commands like "test" which do | |
1051 | # not output anything when they fail. | |
1052 | verbose () { | |
1053 | "$@" && return 0 | |
03aa3783 | 1054 | echo >&4 "command failed: $(git rev-parse --sq-quote "$@")" |
8ad16524 JK |
1055 | return 1 |
1056 | } | |
1057 | ||
ca8d148d JH |
1058 | # Check if the file expected to be empty is indeed empty, and barfs |
1059 | # otherwise. | |
1060 | ||
1061 | test_must_be_empty () { | |
9eb23080 SG |
1062 | test_path_is_file "$1" && |
1063 | if test -s "$1" | |
ca8d148d JH |
1064 | then |
1065 | echo "'$1' is not empty, it contains:" | |
1066 | cat "$1" | |
1067 | return 1 | |
1068 | fi | |
1069 | } | |
1070 | ||
2c9e125b DL |
1071 | # Tests that its two parameters refer to the same revision, or if '!' is |
1072 | # provided first, that its other two parameters refer to different | |
1073 | # revisions. | |
5d77298d | 1074 | test_cmp_rev () { |
2c9e125b DL |
1075 | local op='=' wrong_result=different |
1076 | ||
1077 | if test $# -ge 1 && test "x$1" = 'x!' | |
1078 | then | |
1079 | op='!=' | |
1080 | wrong_result='the same' | |
1081 | shift | |
1082 | fi | |
30d0b6dc SG |
1083 | if test $# != 2 |
1084 | then | |
1085 | error "bug in the test script: test_cmp_rev requires two revisions, but got $#" | |
1086 | else | |
1087 | local r1 r2 | |
1088 | r1=$(git rev-parse --verify "$1") && | |
2c9e125b DL |
1089 | r2=$(git rev-parse --verify "$2") || return 1 |
1090 | ||
1091 | if ! test "$r1" "$op" "$r2" | |
30d0b6dc SG |
1092 | then |
1093 | cat >&4 <<-EOF | |
2c9e125b | 1094 | error: two revisions point to $wrong_result objects: |
30d0b6dc SG |
1095 | '$1': $r1 |
1096 | '$2': $r2 | |
1097 | EOF | |
1098 | return 1 | |
1099 | fi | |
1100 | fi | |
5d77298d MZ |
1101 | } |
1102 | ||
ed33bd8f JS |
1103 | # Compare paths respecting core.ignoreCase |
1104 | test_cmp_fspath () { | |
1105 | if test "x$1" = "x$2" | |
1106 | then | |
1107 | return 0 | |
1108 | fi | |
1109 | ||
1110 | if test true != "$(git config --get --type=bool core.ignorecase)" | |
1111 | then | |
1112 | return 1 | |
1113 | fi | |
1114 | ||
1115 | test "x$(echo "$1" | tr A-Z a-z)" = "x$(echo "$2" | tr A-Z a-z)" | |
1116 | } | |
1117 | ||
55672a39 JH |
1118 | # Print a sequence of integers in increasing order, either with |
1119 | # two arguments (start and end): | |
d17cf5f3 | 1120 | # |
55672a39 JH |
1121 | # test_seq 1 5 -- outputs 1 2 3 4 5 one line at a time |
1122 | # | |
1123 | # or with one argument (end), in which case it starts counting | |
1124 | # from 1. | |
d17cf5f3 MK |
1125 | |
1126 | test_seq () { | |
1127 | case $# in | |
1128 | 1) set 1 "$@" ;; | |
1129 | 2) ;; | |
165293af | 1130 | *) BUG "not 1 or 2 parameters to test_seq" ;; |
d17cf5f3 | 1131 | esac |
4df43135 JH |
1132 | test_seq_counter__=$1 |
1133 | while test "$test_seq_counter__" -le "$2" | |
1134 | do | |
1135 | echo "$test_seq_counter__" | |
1136 | test_seq_counter__=$(( $test_seq_counter__ + 1 )) | |
1137 | done | |
d17cf5f3 MK |
1138 | } |
1139 | ||
12a29b1a TR |
1140 | # This function can be used to schedule some commands to be run |
1141 | # unconditionally at the end of the test to restore sanity: | |
1142 | # | |
1143 | # test_expect_success 'test core.capslock' ' | |
1144 | # git config core.capslock true && | |
1145 | # test_when_finished "git config --unset core.capslock" && | |
1146 | # hello world | |
1147 | # ' | |
1148 | # | |
1149 | # That would be roughly equivalent to | |
1150 | # | |
1151 | # test_expect_success 'test core.capslock' ' | |
1152 | # git config core.capslock true && | |
1153 | # hello world | |
1154 | # git config --unset core.capslock | |
1155 | # ' | |
1156 | # | |
1157 | # except that the greeting and config --unset must both succeed for | |
1158 | # the test to pass. | |
1159 | # | |
1160 | # Note that under --immediate mode, no clean-up is done to help diagnose | |
1161 | # what went wrong. | |
1162 | ||
1163 | test_when_finished () { | |
0968f12a JK |
1164 | # We cannot detect when we are in a subshell in general, but by |
1165 | # doing so on Bash is better than nothing (the test will | |
1166 | # silently pass on other shells). | |
1167 | test "${BASH_SUBSHELL-0}" = 0 || | |
165293af | 1168 | BUG "test_when_finished does nothing in a subshell" |
12a29b1a TR |
1169 | test_cleanup="{ $* |
1170 | } && (exit \"\$eval_ret\"); eval_ret=\$?; $test_cleanup" | |
1171 | } | |
1172 | ||
900721e1 JS |
1173 | # This function can be used to schedule some commands to be run |
1174 | # unconditionally at the end of the test script, e.g. to stop a daemon: | |
1175 | # | |
1176 | # test_expect_success 'test git daemon' ' | |
1177 | # git daemon & | |
1178 | # daemon_pid=$! && | |
1179 | # test_atexit 'kill $daemon_pid' && | |
1180 | # hello world | |
1181 | # ' | |
1182 | # | |
1183 | # The commands will be executed before the trash directory is removed, | |
1184 | # i.e. the atexit commands will still be able to access any pidfiles or | |
1185 | # socket files. | |
1186 | # | |
1187 | # Note that these commands will be run even when a test script run | |
1188 | # with '--immediate' fails. Be careful with your atexit commands to | |
1189 | # minimize any changes to the failed state. | |
1190 | ||
1191 | test_atexit () { | |
1192 | # We cannot detect when we are in a subshell in general, but by | |
1193 | # doing so on Bash is better than nothing (the test will | |
1194 | # silently pass on other shells). | |
1195 | test "${BASH_SUBSHELL-0}" = 0 || | |
1196 | error "bug in test script: test_atexit does nothing in a subshell" | |
1197 | test_atexit_cleanup="{ $* | |
1198 | } && (exit \"\$eval_ret\"); eval_ret=\$?; $test_atexit_cleanup" | |
1199 | } | |
1200 | ||
12a29b1a TR |
1201 | # Most tests can use the created repository, but some may need to create more. |
1202 | # Usage: test_create_repo <directory> | |
1203 | test_create_repo () { | |
1204 | test "$#" = 1 || | |
165293af | 1205 | BUG "not 1 parameter to test-create-repo" |
12a29b1a TR |
1206 | repo="$1" |
1207 | mkdir -p "$repo" | |
1208 | ( | |
1209 | cd "$repo" || error "Cannot setup test environment" | |
675704c7 JS |
1210 | "${GIT_TEST_INSTALLED:-$GIT_EXEC_PATH}/git$X" -c \ |
1211 | init.defaultBranch="${GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME-master}" \ | |
1212 | init \ | |
3af4c715 | 1213 | "--template=$GIT_BUILD_DIR/templates/blt/" >&3 2>&4 || |
12a29b1a TR |
1214 | error "cannot run git init -- have you built things yet?" |
1215 | mv .git/hooks .git/hooks-disabled | |
1216 | ) || exit | |
1217 | } | |
9ce415d9 JS |
1218 | |
1219 | # This function helps on symlink challenged file systems when it is not | |
1220 | # important that the file system entry is a symbolic link. | |
1221 | # Use test_ln_s_add instead of "ln -s x y && git add y" to add a | |
1222 | # symbolic link entry y to the index. | |
1223 | ||
1224 | test_ln_s_add () { | |
1225 | if test_have_prereq SYMLINKS | |
1226 | then | |
1227 | ln -s "$1" "$2" && | |
1228 | git update-index --add "$2" | |
1229 | else | |
1230 | printf '%s' "$1" >"$2" && | |
1231 | ln_s_obj=$(git hash-object -w "$2") && | |
817d03e1 JS |
1232 | git update-index --add --cacheinfo 120000 $ln_s_obj "$2" && |
1233 | # pick up stat info from the file | |
1234 | git update-index "$2" | |
9ce415d9 JS |
1235 | fi |
1236 | } | |
4d715ac0 | 1237 | |
ac9afcc3 MT |
1238 | # This function writes out its parameters, one per line |
1239 | test_write_lines () { | |
1240 | printf "%s\n" "$@" | |
1241 | } | |
1242 | ||
a0e0ec9f | 1243 | perl () { |
a5bf824f SG |
1244 | command "$PERL_PATH" "$@" 2>&7 |
1245 | } 7>&2 2>&4 | |
a3a9cff0 | 1246 | |
43a2afee SG |
1247 | # Given the name of an environment variable with a bool value, normalize |
1248 | # its value to a 0 (true) or 1 (false or empty string) return code. | |
1249 | # | |
1250 | # test_bool_env GIT_TEST_HTTPD <default-value> | |
1251 | # | |
1252 | # Return with code corresponding to the given default value if the variable | |
1253 | # is unset. | |
1254 | # Abort the test script if either the value of the variable or the default | |
1255 | # are not valid bool values. | |
1256 | ||
1257 | test_bool_env () { | |
1258 | if test $# != 2 | |
1259 | then | |
1260 | BUG "test_bool_env requires two parameters (variable name and default value)" | |
1261 | fi | |
1262 | ||
1263 | git env--helper --type=bool --default="$2" --exit-code "$1" | |
1264 | ret=$? | |
1265 | case $ret in | |
1266 | 0|1) # unset or valid bool value | |
1267 | ;; | |
1268 | *) # invalid bool value or something unexpected | |
1269 | error >&7 "test_bool_env requires bool values both for \$$1 and for the default fallback" | |
1270 | ;; | |
1271 | esac | |
1272 | return $ret | |
1273 | } | |
1274 | ||
83d842dc | 1275 | # Exit the test suite, either by skipping all remaining tests or by |
3b072c57 ÆAB |
1276 | # exiting with an error. If our prerequisite variable $1 falls back |
1277 | # on a default assume we were opportunistically trying to set up some | |
1278 | # tests and we skip. If it is explicitly "true", then we report a failure. | |
83d842dc JK |
1279 | # |
1280 | # The error/skip message should be given by $2. | |
1281 | # | |
1282 | test_skip_or_die () { | |
43a2afee | 1283 | if ! test_bool_env "$1" false |
3b072c57 | 1284 | then |
83d842dc JK |
1285 | skip_all=$2 |
1286 | test_done | |
3b072c57 ÆAB |
1287 | fi |
1288 | error "$2" | |
83d842dc JK |
1289 | } |
1290 | ||
4d715ac0 JS |
1291 | # The following mingw_* functions obey POSIX shell syntax, but are actually |
1292 | # bash scripts, and are meant to be used only with bash on Windows. | |
1293 | ||
1294 | # A test_cmp function that treats LF and CRLF equal and avoids to fork | |
1295 | # diff when possible. | |
1296 | mingw_test_cmp () { | |
1297 | # Read text into shell variables and compare them. If the results | |
1298 | # are different, use regular diff to report the difference. | |
1299 | local test_cmp_a= test_cmp_b= | |
1300 | ||
1301 | # When text came from stdin (one argument is '-') we must feed it | |
1302 | # to diff. | |
1303 | local stdin_for_diff= | |
1304 | ||
1305 | # Since it is difficult to detect the difference between an | |
1306 | # empty input file and a failure to read the files, we go straight | |
1307 | # to diff if one of the inputs is empty. | |
1308 | if test -s "$1" && test -s "$2" | |
1309 | then | |
1310 | # regular case: both files non-empty | |
1311 | mingw_read_file_strip_cr_ test_cmp_a <"$1" | |
1312 | mingw_read_file_strip_cr_ test_cmp_b <"$2" | |
1313 | elif test -s "$1" && test "$2" = - | |
1314 | then | |
1315 | # read 2nd file from stdin | |
1316 | mingw_read_file_strip_cr_ test_cmp_a <"$1" | |
1317 | mingw_read_file_strip_cr_ test_cmp_b | |
1318 | stdin_for_diff='<<<"$test_cmp_b"' | |
1319 | elif test "$1" = - && test -s "$2" | |
1320 | then | |
1321 | # read 1st file from stdin | |
1322 | mingw_read_file_strip_cr_ test_cmp_a | |
1323 | mingw_read_file_strip_cr_ test_cmp_b <"$2" | |
1324 | stdin_for_diff='<<<"$test_cmp_a"' | |
1325 | fi | |
1326 | test -n "$test_cmp_a" && | |
1327 | test -n "$test_cmp_b" && | |
1328 | test "$test_cmp_a" = "$test_cmp_b" || | |
1329 | eval "diff -u \"\$@\" $stdin_for_diff" | |
1330 | } | |
1331 | ||
1332 | # $1 is the name of the shell variable to fill in | |
1333 | mingw_read_file_strip_cr_ () { | |
1334 | # Read line-wise using LF as the line separator | |
1335 | # and use IFS to strip CR. | |
1336 | local line | |
1337 | while : | |
1338 | do | |
1339 | if IFS=$'\r' read -r -d $'\n' line | |
1340 | then | |
1341 | # good | |
1342 | line=$line$'\n' | |
1343 | else | |
1344 | # we get here at EOF, but also if the last line | |
1345 | # was not terminated by LF; in the latter case, | |
1346 | # some text was read | |
1347 | if test -z "$line" | |
1348 | then | |
1349 | # EOF, really | |
1350 | break | |
1351 | fi | |
1352 | fi | |
1353 | eval "$1=\$$1\$line" | |
1354 | done | |
1355 | } | |
d2554c72 JK |
1356 | |
1357 | # Like "env FOO=BAR some-program", but run inside a subshell, which means | |
1358 | # it also works for shell functions (though those functions cannot impact | |
1359 | # the environment outside of the test_env invocation). | |
1360 | test_env () { | |
1361 | ( | |
1362 | while test $# -gt 0 | |
1363 | do | |
1364 | case "$1" in | |
1365 | *=*) | |
1366 | eval "${1%%=*}=\${1#*=}" | |
1367 | eval "export ${1%%=*}" | |
1368 | shift | |
1369 | ;; | |
1370 | *) | |
a5bf824f | 1371 | "$@" 2>&7 |
d2554c72 JK |
1372 | exit |
1373 | ;; | |
1374 | esac | |
1375 | done | |
1376 | ) | |
a5bf824f | 1377 | } 7>&2 2>&4 |
48860819 | 1378 | |
9b67c994 JK |
1379 | # Returns true if the numeric exit code in "$2" represents the expected signal |
1380 | # in "$1". Signals should be given numerically. | |
1381 | test_match_signal () { | |
1382 | if test "$2" = "$((128 + $1))" | |
1383 | then | |
1384 | # POSIX | |
1385 | return 0 | |
1386 | elif test "$2" = "$((256 + $1))" | |
1387 | then | |
1388 | # ksh | |
1389 | return 0 | |
1390 | fi | |
1391 | return 1 | |
1392 | } | |
39cadeec | 1393 | |
48860819 JK |
1394 | # Read up to "$1" bytes (or to EOF) from stdin and write them to stdout. |
1395 | test_copy_bytes () { | |
1396 | perl -e ' | |
1397 | my $len = $ARGV[1]; | |
1398 | while ($len > 0) { | |
1399 | my $s; | |
1400 | my $nread = sysread(STDIN, $s, $len); | |
1401 | die "cannot read: $!" unless defined($nread); | |
f7f6dc34 | 1402 | last unless $nread; |
48860819 JK |
1403 | print $s; |
1404 | $len -= $nread; | |
1405 | } | |
1406 | ' - "$1" | |
1407 | } | |
de95302a JK |
1408 | |
1409 | # run "$@" inside a non-git directory | |
1410 | nongit () { | |
1411 | test -d non-repo || | |
1412 | mkdir non-repo || | |
1413 | return 1 | |
1414 | ||
1415 | ( | |
1416 | GIT_CEILING_DIRECTORIES=$(pwd) && | |
1417 | export GIT_CEILING_DIRECTORIES && | |
1418 | cd non-repo && | |
a5bf824f | 1419 | "$@" 2>&7 |
de95302a | 1420 | ) |
a5bf824f | 1421 | } 7>&2 2>&4 |
4414a150 | 1422 | |
88124ab2 JK |
1423 | # convert function arguments or stdin (if not arguments given) to pktline |
1424 | # representation. If multiple arguments are given, they are separated by | |
1425 | # whitespace and put in a single packet. Note that data containing NULs must be | |
1426 | # given on stdin, and that empty input becomes an empty packet, not a flush | |
1427 | # packet (for that you can just print 0000 yourself). | |
1ab7e00e | 1428 | packetize () { |
88124ab2 JK |
1429 | if test $# -gt 0 |
1430 | then | |
1431 | packet="$*" | |
1432 | printf '%04x%s' "$((4 + ${#packet}))" "$packet" | |
1433 | else | |
cacae432 JK |
1434 | perl -e ' |
1435 | my $packet = do { local $/; <STDIN> }; | |
1436 | printf "%04x%s", 4 + length($packet), $packet; | |
1437 | ' | |
88124ab2 | 1438 | fi |
4414a150 JK |
1439 | } |
1440 | ||
1441 | # Parse the input as a series of pktlines, writing the result to stdout. | |
1442 | # Sideband markers are removed automatically, and the output is routed to | |
1443 | # stderr if appropriate. | |
1444 | # | |
1445 | # NUL bytes are converted to "\\0" for ease of parsing with text tools. | |
1446 | depacketize () { | |
1447 | perl -e ' | |
1448 | while (read(STDIN, $len, 4) == 4) { | |
1449 | if ($len eq "0000") { | |
1450 | print "FLUSH\n"; | |
1451 | } else { | |
1452 | read(STDIN, $buf, hex($len) - 4); | |
1453 | $buf =~ s/\0/\\0/g; | |
1454 | if ($buf =~ s/^[\x2\x3]//) { | |
1455 | print STDERR $buf; | |
1456 | } else { | |
1457 | $buf =~ s/^\x1//; | |
1458 | print $buf; | |
1459 | } | |
1460 | } | |
1461 | } | |
1462 | ' | |
1463 | } | |
2c02b110 | 1464 | |
5c07647d TB |
1465 | # Converts base-16 data into base-8. The output is given as a sequence of |
1466 | # escaped octals, suitable for consumption by 'printf'. | |
1467 | hex2oct () { | |
1468 | perl -ne 'printf "\\%03o", hex for /../g' | |
1469 | } | |
1470 | ||
2c02b110 | 1471 | # Set the hash algorithm in use to $1. Only useful when testing the testsuite. |
1472 | test_set_hash () { | |
1473 | test_hash_algo="$1" | |
1474 | } | |
1475 | ||
1476 | # Detect the hash algorithm in use. | |
1477 | test_detect_hash () { | |
02a32dbf | 1478 | test_hash_algo="${GIT_TEST_DEFAULT_HASH:-sha1}" |
2c02b110 | 1479 | } |
1480 | ||
1481 | # Load common hash metadata and common placeholder object IDs for use with | |
1482 | # test_oid. | |
1483 | test_oid_init () { | |
1484 | test -n "$test_hash_algo" || test_detect_hash && | |
1485 | test_oid_cache <"$TEST_DIRECTORY/oid-info/hash-info" && | |
1486 | test_oid_cache <"$TEST_DIRECTORY/oid-info/oid" | |
1487 | } | |
1488 | ||
1489 | # Load key-value pairs from stdin suitable for use with test_oid. Blank lines | |
1490 | # and lines starting with "#" are ignored. Keys must be shell identifier | |
1491 | # characters. | |
1492 | # | |
1493 | # Examples: | |
1494 | # rawsz sha1:20 | |
1495 | # rawsz sha256:32 | |
1496 | test_oid_cache () { | |
1497 | local tag rest k v && | |
1498 | ||
1499 | { test -n "$test_hash_algo" || test_detect_hash; } && | |
1500 | while read tag rest | |
1501 | do | |
1502 | case $tag in | |
1503 | \#*) | |
1504 | continue;; | |
1505 | ?*) | |
1506 | # non-empty | |
1507 | ;; | |
1508 | *) | |
1509 | # blank line | |
1510 | continue;; | |
1511 | esac && | |
1512 | ||
1513 | k="${rest%:*}" && | |
1514 | v="${rest#*:}" && | |
1515 | ||
1516 | if ! expr "$k" : '[a-z0-9][a-z0-9]*$' >/dev/null | |
1517 | then | |
165293af | 1518 | BUG 'bad hash algorithm' |
2c02b110 | 1519 | fi && |
1520 | eval "test_oid_${k}_$tag=\"\$v\"" | |
1521 | done | |
1522 | } | |
1523 | ||
1524 | # Look up a per-hash value based on a key ($1). The value must have been loaded | |
1525 | # by test_oid_init or test_oid_cache. | |
1526 | test_oid () { | |
ceaa4b3a | 1527 | local algo="${test_hash_algo}" && |
1528 | ||
1529 | case "$1" in | |
1530 | --hash=*) | |
1531 | algo="${1#--hash=}" && | |
1532 | shift;; | |
1533 | *) | |
1534 | ;; | |
1535 | esac && | |
1536 | ||
1537 | local var="test_oid_${algo}_$1" && | |
2c02b110 | 1538 | |
1539 | # If the variable is unset, we must be missing an entry for this | |
1540 | # key-hash pair, so exit with an error. | |
1541 | if eval "test -z \"\${$var+set}\"" | |
1542 | then | |
165293af | 1543 | BUG "undefined key '$1'" |
2c02b110 | 1544 | fi && |
1545 | eval "printf '%s' \"\${$var}\"" | |
1546 | } | |
fa840581 | 1547 | |
56d88924 | 1548 | # Insert a slash into an object ID so it can be used to reference a location |
1549 | # under ".git/objects". For example, "deadbeef..." becomes "de/adbeef..". | |
1550 | test_oid_to_path () { | |
1c1f6e03 JN |
1551 | local basename=${1#??} |
1552 | echo "${1%$basename}/$basename" | |
56d88924 | 1553 | } |
1554 | ||
fa840581 SG |
1555 | # Choose a port number based on the test script's number and store it in |
1556 | # the given variable name, unless that variable already contains a number. | |
1557 | test_set_port () { | |
1558 | local var=$1 port | |
1559 | ||
1560 | if test $# -ne 1 || test -z "$var" | |
1561 | then | |
1562 | BUG "test_set_port requires a variable name" | |
1563 | fi | |
1564 | ||
1565 | eval port=\$$var | |
1566 | case "$port" in | |
1567 | "") | |
1568 | # No port is set in the given env var, use the test | |
1569 | # number as port number instead. | |
1570 | # Remove not only the leading 't', but all leading zeros | |
1571 | # as well, so the arithmetic below won't (mis)interpret | |
1572 | # a test number like '0123' as an octal value. | |
1573 | port=${this_test#${this_test%%[1-9]*}} | |
1574 | if test "${port:-0}" -lt 1024 | |
1575 | then | |
1576 | # root-only port, use a larger one instead. | |
1577 | port=$(($port + 10000)) | |
1578 | fi | |
fa840581 | 1579 | ;; |
7d661e5e | 1580 | *[!0-9]*|0*) |
fa840581 SG |
1581 | error >&7 "invalid port number: $port" |
1582 | ;; | |
1583 | *) | |
1584 | # The user has specified the port. | |
1585 | ;; | |
1586 | esac | |
fb7d1e3a SG |
1587 | |
1588 | # Make sure that parallel '--stress' test jobs get different | |
1589 | # ports. | |
1590 | port=$(($port + ${GIT_TEST_STRESS_JOB_NR:-0})) | |
1591 | eval $var=$port | |
fa840581 | 1592 | } |
ea047a8e JK |
1593 | |
1594 | # Compare a file containing rev-list bitmap traversal output to its non-bitmap | |
1595 | # counterpart. You can't just use test_cmp for this, because the two produce | |
1596 | # subtly different output: | |
1597 | # | |
1598 | # - regular output is in traversal order, whereas bitmap is split by type, | |
1599 | # with non-packed objects at the end | |
1600 | # | |
1601 | # - regular output has a space and the pathname appended to non-commit | |
1602 | # objects; bitmap output omits this | |
1603 | # | |
1604 | # This function normalizes and compares the two. The second file should | |
1605 | # always be the bitmap output. | |
1606 | test_bitmap_traversal () { | |
1607 | if test "$1" = "--no-confirm-bitmaps" | |
1608 | then | |
1609 | shift | |
1610 | elif cmp "$1" "$2" | |
1611 | then | |
1612 | echo >&2 "identical raw outputs; are you sure bitmaps were used?" | |
1613 | return 1 | |
1614 | fi && | |
1615 | cut -d' ' -f1 "$1" | sort >"$1.normalized" && | |
1616 | sort "$2" >"$2.normalized" && | |
1617 | test_cmp "$1.normalized" "$2.normalized" && | |
1618 | rm -f "$1.normalized" "$2.normalized" | |
1619 | } | |
7c2dfca7 | 1620 | |
176a66a7 JS |
1621 | # Tests for the hidden file attribute on Windows |
1622 | test_path_is_hidden () { | |
1623 | test_have_prereq MINGW || | |
1624 | BUG "test_path_is_hidden can only be used on Windows" | |
1625 | ||
7c2dfca7 | 1626 | # Use the output of `attrib`, ignore the absolute path |
9814d0a4 | 1627 | case "$("$SYSTEMROOT"/system32/attrib "$1")" in *H*?:*) return 0;; esac |
7c2dfca7 JS |
1628 | return 1 |
1629 | } | |
2057d750 DS |
1630 | |
1631 | # Check that the given command was invoked as part of the | |
1632 | # trace2-format trace on stdin. | |
1633 | # | |
1634 | # test_subcommand [!] <command> <args>... < <trace> | |
1635 | # | |
1636 | # For example, to look for an invocation of "git upload-pack | |
1637 | # /path/to/repo" | |
1638 | # | |
1639 | # GIT_TRACE2_EVENT=event.log git fetch ... && | |
1640 | # test_subcommand git upload-pack "$PATH" <event.log | |
1641 | # | |
1642 | # If the first parameter passed is !, this instead checks that | |
1643 | # the given command was not called. | |
1644 | # | |
1645 | test_subcommand () { | |
1646 | local negate= | |
1647 | if test "$1" = "!" | |
1648 | then | |
1649 | negate=t | |
1650 | shift | |
1651 | fi | |
1652 | ||
1653 | local expr=$(printf '"%s",' "$@") | |
1654 | expr="${expr%,}" | |
1655 | ||
1656 | if test -n "$negate" | |
1657 | then | |
1658 | ! grep "\[$expr\]" | |
1659 | else | |
1660 | grep "\[$expr\]" | |
1661 | fi | |
1662 | } |