]>
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 | ||
35 | test_decode_color () { | |
36 | awk ' | |
37 | function name(n) { | |
38 | if (n == 0) return "RESET"; | |
39 | if (n == 1) return "BOLD"; | |
991eb4fc SB |
40 | if (n == 2) return "FAINT"; |
41 | if (n == 3) return "ITALIC"; | |
097b681b | 42 | if (n == 7) return "REVERSE"; |
12a29b1a TR |
43 | if (n == 30) return "BLACK"; |
44 | if (n == 31) return "RED"; | |
45 | if (n == 32) return "GREEN"; | |
46 | if (n == 33) return "YELLOW"; | |
47 | if (n == 34) return "BLUE"; | |
48 | if (n == 35) return "MAGENTA"; | |
49 | if (n == 36) return "CYAN"; | |
50 | if (n == 37) return "WHITE"; | |
51 | if (n == 40) return "BLACK"; | |
52 | if (n == 41) return "BRED"; | |
53 | if (n == 42) return "BGREEN"; | |
54 | if (n == 43) return "BYELLOW"; | |
55 | if (n == 44) return "BBLUE"; | |
56 | if (n == 45) return "BMAGENTA"; | |
57 | if (n == 46) return "BCYAN"; | |
58 | if (n == 47) return "BWHITE"; | |
59 | } | |
60 | { | |
61 | while (match($0, /\033\[[0-9;]*m/) != 0) { | |
62 | printf "%s<", substr($0, 1, RSTART-1); | |
63 | codes = substr($0, RSTART+2, RLENGTH-3); | |
64 | if (length(codes) == 0) | |
65 | printf "%s", name(0) | |
66 | else { | |
67 | n = split(codes, ary, ";"); | |
68 | sep = ""; | |
69 | for (i = 1; i <= n; i++) { | |
70 | printf "%s%s", sep, name(ary[i]); | |
71 | sep = ";" | |
72 | } | |
73 | } | |
74 | printf ">"; | |
75 | $0 = substr($0, RSTART + RLENGTH, length($0) - RSTART - RLENGTH + 1); | |
76 | } | |
77 | ||
78 | } | |
79 | ' | |
80 | } | |
81 | ||
b249e39f JH |
82 | lf_to_nul () { |
83 | perl -pe 'y/\012/\000/' | |
84 | } | |
85 | ||
12a29b1a | 86 | nul_to_q () { |
94221d22 | 87 | perl -pe 'y/\000/Q/' |
12a29b1a TR |
88 | } |
89 | ||
90 | q_to_nul () { | |
94221d22 | 91 | perl -pe 'y/Q/\000/' |
12a29b1a TR |
92 | } |
93 | ||
94 | q_to_cr () { | |
95 | tr Q '\015' | |
96 | } | |
97 | ||
98 | q_to_tab () { | |
99 | tr Q '\011' | |
100 | } | |
101 | ||
250b3c6c JH |
102 | qz_to_tab_space () { |
103 | tr QZ '\011\040' | |
12a29b1a TR |
104 | } |
105 | ||
106 | append_cr () { | |
107 | sed -e 's/$/Q/' | tr Q '\015' | |
108 | } | |
109 | ||
110 | remove_cr () { | |
111 | tr '\015' Q | sed -e 's/Q$//' | |
112 | } | |
113 | ||
114 | # In some bourne shell implementations, the "unset" builtin returns | |
115 | # nonzero status when a variable to be unset was not set in the first | |
116 | # place. | |
117 | # | |
118 | # Use sane_unset when that should not be considered an error. | |
119 | ||
120 | sane_unset () { | |
121 | unset "$@" | |
122 | return 0 | |
123 | } | |
124 | ||
125 | test_tick () { | |
126 | if test -z "${test_tick+set}" | |
127 | then | |
128 | test_tick=1112911993 | |
129 | else | |
130 | test_tick=$(($test_tick + 60)) | |
131 | fi | |
132 | GIT_COMMITTER_DATE="$test_tick -0700" | |
133 | GIT_AUTHOR_DATE="$test_tick -0700" | |
134 | export GIT_COMMITTER_DATE GIT_AUTHOR_DATE | |
135 | } | |
136 | ||
59210dd5 | 137 | # Stop execution and start a shell. This is useful for debugging tests. |
12a29b1a TR |
138 | # |
139 | # Be sure to remove all invocations of this command before submitting. | |
add5240f PB |
140 | # WARNING: the shell invoked by this helper does not have the same environment |
141 | # as the one running the tests (shell variables and functions are not | |
142 | # available, and the options below further modify the environment). As such, | |
143 | # commands copied from a test script might behave differently than when | |
144 | # running the test. | |
145 | # | |
146 | # Usage: test_pause [options] | |
147 | # -t | |
148 | # Use your original TERM instead of test-lib.sh's "dumb". | |
149 | # This usually restores color output in the invoked shell. | |
150 | # -s | |
151 | # Invoke $SHELL instead of $TEST_SHELL_PATH. | |
152 | # -h | |
153 | # Use your original HOME instead of test-lib.sh's "$TRASH_DIRECTORY". | |
154 | # This allows you to use your regular shell environment and Git aliases. | |
155 | # CAUTION: running commands copied from a test script into the paused shell | |
156 | # might result in files in your HOME being overwritten. | |
157 | # -a | |
158 | # Shortcut for -t -s -h | |
12a29b1a TR |
159 | |
160 | test_pause () { | |
add5240f PB |
161 | PAUSE_TERM=$TERM && |
162 | PAUSE_SHELL=$TEST_SHELL_PATH && | |
163 | PAUSE_HOME=$HOME && | |
164 | while test $# != 0 | |
165 | do | |
166 | case "$1" in | |
167 | -t) | |
168 | PAUSE_TERM="$USER_TERM" | |
169 | ;; | |
170 | -s) | |
171 | PAUSE_SHELL="$SHELL" | |
172 | ;; | |
173 | -h) | |
174 | PAUSE_HOME="$USER_HOME" | |
175 | ;; | |
176 | -a) | |
177 | PAUSE_TERM="$USER_TERM" | |
178 | PAUSE_SHELL="$SHELL" | |
179 | PAUSE_HOME="$USER_HOME" | |
180 | ;; | |
181 | *) | |
182 | break | |
183 | ;; | |
184 | esac | |
185 | shift | |
186 | done && | |
187 | TERM="$PAUSE_TERM" HOME="$PAUSE_HOME" "$PAUSE_SHELL" <&6 >&5 2>&7 | |
12a29b1a TR |
188 | } |
189 | ||
84243646 EN |
190 | # Wrap git with a debugger. Adding this to a command can make it easier |
191 | # to understand what is going on in a failing test. | |
6a94088c | 192 | # |
01c38103 PB |
193 | # Usage: debug [options] <git command> |
194 | # -d <debugger> | |
195 | # --debugger=<debugger> | |
196 | # Use <debugger> instead of GDB | |
197 | # -t | |
198 | # Use your original TERM instead of test-lib.sh's "dumb". | |
199 | # This usually restores color output in the debugger. | |
200 | # WARNING: the command being debugged might behave differently than when | |
201 | # running the test. | |
202 | # | |
84243646 EN |
203 | # Examples: |
204 | # debug git checkout master | |
205 | # debug --debugger=nemiver git $ARGS | |
206 | # debug -d "valgrind --tool=memcheck --track-origins=yes" git $ARGS | |
6a94088c | 207 | debug () { |
01c38103 PB |
208 | GIT_DEBUGGER=1 && |
209 | DEBUG_TERM=$TERM && | |
210 | while test $# != 0 | |
211 | do | |
212 | case "$1" in | |
213 | -t) | |
214 | DEBUG_TERM="$USER_TERM" | |
215 | ;; | |
216 | -d) | |
217 | GIT_DEBUGGER="$2" && | |
218 | shift | |
219 | ;; | |
220 | --debugger=*) | |
221 | GIT_DEBUGGER="${1#*=}" | |
222 | ;; | |
223 | *) | |
224 | break | |
225 | ;; | |
226 | esac | |
227 | shift | |
228 | done && | |
229 | ||
230 | dotfiles=".gdbinit .lldbinit" | |
231 | ||
232 | for dotfile in $dotfiles | |
233 | do | |
234 | dotfile="$USER_HOME/$dotfile" && | |
235 | test -f "$dotfile" && cp "$dotfile" "$HOME" || : | |
236 | done && | |
237 | ||
238 | TERM="$DEBUG_TERM" GIT_DEBUGGER="${GIT_DEBUGGER}" "$@" <&6 >&5 2>&7 && | |
239 | ||
240 | for dotfile in $dotfiles | |
241 | do | |
242 | rm -f "$HOME/$dotfile" | |
243 | done | |
6a94088c JS |
244 | } |
245 | ||
f21426e1 ÆAB |
246 | # Usage: test_commit [options] <message> [<file> [<contents> [<tag>]]] |
247 | # -C <dir>: | |
248 | # Run all git commands in directory <dir> | |
76b8b8d0 ÆAB |
249 | # --notick |
250 | # Do not call test_tick before making a commit | |
3373518c | 251 | # --append |
cb8fb7f8 | 252 | # Use ">>" instead of ">" when writing "<contents>" to "<file>" |
47c88d16 ÆAB |
253 | # --printf |
254 | # Use "printf" instead of "echo" when writing "<contents>" to | |
255 | # "<file>", use this to write escape sequences such as "\0", a | |
256 | # trailing "\n" won't be added automatically. This option | |
257 | # supports nothing but the FORMAT of printf(1), i.e. no custom | |
258 | # ARGUMENT(s). | |
76b8b8d0 ÆAB |
259 | # --signoff |
260 | # Invoke "git commit" with --signoff | |
f9f30a03 DL |
261 | # --author <author> |
262 | # Invoke "git commit" with --author <author> | |
5144219b ÆAB |
263 | # --no-tag |
264 | # Do not tag the resulting commit | |
6cf8d96f ÆAB |
265 | # --annotate |
266 | # Create an annotated tag with "--annotate -m <message>". Calls | |
267 | # test_tick between making the commit and tag, unless --notick | |
268 | # is given. | |
12a29b1a TR |
269 | # |
270 | # This will commit a file with the given contents and the given commit | |
4c994194 | 271 | # message, and tag the resulting commit with the given tag name. |
12a29b1a | 272 | # |
4c994194 | 273 | # <file>, <contents>, and <tag> all default to <message>. |
12a29b1a TR |
274 | |
275 | test_commit () { | |
455f0adf PB |
276 | local notick= && |
277 | local echo=echo && | |
278 | local append= && | |
279 | local author= && | |
280 | local signoff= && | |
281 | local indir= && | |
282 | local tag=light && | |
5ed75e2a MV |
283 | while test $# != 0 |
284 | do | |
285 | case "$1" in | |
286 | --notick) | |
287 | notick=yes | |
288 | ;; | |
47c88d16 ÆAB |
289 | --printf) |
290 | echo=printf | |
291 | ;; | |
3373518c ÆAB |
292 | --append) |
293 | append=yes | |
294 | ;; | |
999cfc4f ÆAB |
295 | --author) |
296 | author="$2" | |
297 | shift | |
298 | ;; | |
5ed75e2a MV |
299 | --signoff) |
300 | signoff="$1" | |
301 | ;; | |
e8b63005 AK |
302 | --date) |
303 | notick=yes | |
304 | GIT_COMMITTER_DATE="$2" | |
305 | GIT_AUTHOR_DATE="$2" | |
306 | shift | |
307 | ;; | |
6f94351b SB |
308 | -C) |
309 | indir="$2" | |
310 | shift | |
311 | ;; | |
3803a3a0 | 312 | --no-tag) |
6cf8d96f ÆAB |
313 | tag=none |
314 | ;; | |
315 | --annotate) | |
316 | tag=annotate | |
3803a3a0 | 317 | ;; |
5ed75e2a MV |
318 | *) |
319 | break | |
320 | ;; | |
321 | esac | |
9a0231b3 | 322 | shift |
5ed75e2a | 323 | done && |
6f94351b | 324 | indir=${indir:+"$indir"/} && |
455f0adf | 325 | local file=${2:-"$1.t"} && |
3373518c ÆAB |
326 | if test -n "$append" |
327 | then | |
47c88d16 | 328 | $echo "${3-$1}" >>"$indir$file" |
3373518c | 329 | else |
47c88d16 | 330 | $echo "${3-$1}" >"$indir$file" |
3373518c | 331 | fi && |
e3c36758 | 332 | git ${indir:+ -C "$indir"} add -- "$file" && |
9a0231b3 JH |
333 | if test -z "$notick" |
334 | then | |
335 | test_tick | |
336 | fi && | |
999cfc4f ÆAB |
337 | git ${indir:+ -C "$indir"} commit \ |
338 | ${author:+ --author "$author"} \ | |
339 | $signoff -m "$1" && | |
6cf8d96f ÆAB |
340 | case "$tag" in |
341 | none) | |
342 | ;; | |
343 | light) | |
3803a3a0 | 344 | git ${indir:+ -C "$indir"} tag "${4:-$1}" |
6cf8d96f ÆAB |
345 | ;; |
346 | annotate) | |
347 | if test -z "$notick" | |
348 | then | |
349 | test_tick | |
350 | fi && | |
351 | git ${indir:+ -C "$indir"} tag -a -m "$1" "${4:-$1}" | |
352 | ;; | |
353 | esac | |
12a29b1a TR |
354 | } |
355 | ||
356 | # Call test_merge with the arguments "<message> <commit>", where <commit> | |
357 | # can be a tag pointing to the commit-to-merge. | |
358 | ||
359 | test_merge () { | |
94ba1513 DL |
360 | label="$1" && |
361 | shift && | |
12a29b1a | 362 | test_tick && |
94ba1513 DL |
363 | git merge -m "$label" "$@" && |
364 | git tag "$label" | |
12a29b1a TR |
365 | } |
366 | ||
b1c36cb8 JK |
367 | # Efficiently create <nr> commits, each with a unique number (from 1 to <nr> |
368 | # by default) in the commit message. | |
369 | # | |
370 | # Usage: test_commit_bulk [options] <nr> | |
371 | # -C <dir>: | |
372 | # Run all git commands in directory <dir> | |
373 | # --ref=<n>: | |
374 | # ref on which to create commits (default: HEAD) | |
375 | # --start=<n>: | |
376 | # number commit messages from <n> (default: 1) | |
377 | # --message=<msg>: | |
378 | # use <msg> as the commit mesasge (default: "commit %s") | |
379 | # --filename=<fn>: | |
380 | # modify <fn> in each commit (default: %s.t) | |
381 | # --contents=<string>: | |
382 | # place <string> in each file (default: "content %s") | |
383 | # --id=<string>: | |
384 | # shorthand to use <string> and %s in message, filename, and contents | |
385 | # | |
386 | # The message, filename, and contents strings are evaluated by printf, with the | |
387 | # first "%s" replaced by the current commit number. So you can do: | |
388 | # | |
389 | # test_commit_bulk --filename=file --contents="modification %s" | |
390 | # | |
391 | # to have every commit touch the same file, but with unique content. | |
392 | # | |
393 | test_commit_bulk () { | |
394 | tmpfile=.bulk-commit.input | |
395 | indir=. | |
396 | ref=HEAD | |
397 | n=1 | |
398 | message='commit %s' | |
399 | filename='%s.t' | |
400 | contents='content %s' | |
401 | while test $# -gt 0 | |
402 | do | |
403 | case "$1" in | |
404 | -C) | |
405 | indir=$2 | |
406 | shift | |
407 | ;; | |
408 | --ref=*) | |
409 | ref=${1#--*=} | |
410 | ;; | |
411 | --start=*) | |
412 | n=${1#--*=} | |
413 | ;; | |
414 | --message=*) | |
415 | message=${1#--*=} | |
416 | ;; | |
417 | --filename=*) | |
418 | filename=${1#--*=} | |
419 | ;; | |
420 | --contents=*) | |
421 | contents=${1#--*=} | |
422 | ;; | |
423 | --id=*) | |
424 | message="${1#--*=} %s" | |
425 | filename="${1#--*=}-%s.t" | |
426 | contents="${1#--*=} %s" | |
427 | ;; | |
428 | -*) | |
429 | BUG "invalid test_commit_bulk option: $1" | |
430 | ;; | |
431 | *) | |
432 | break | |
433 | ;; | |
434 | esac | |
435 | shift | |
436 | done | |
437 | total=$1 | |
438 | ||
439 | add_from= | |
fc42f20e | 440 | if git -C "$indir" rev-parse --quiet --verify "$ref" |
b1c36cb8 JK |
441 | then |
442 | add_from=t | |
443 | fi | |
444 | ||
445 | while test "$total" -gt 0 | |
446 | do | |
447 | test_tick && | |
448 | echo "commit $ref" | |
449 | printf 'author %s <%s> %s\n' \ | |
450 | "$GIT_AUTHOR_NAME" \ | |
451 | "$GIT_AUTHOR_EMAIL" \ | |
452 | "$GIT_AUTHOR_DATE" | |
453 | printf 'committer %s <%s> %s\n' \ | |
454 | "$GIT_COMMITTER_NAME" \ | |
455 | "$GIT_COMMITTER_EMAIL" \ | |
456 | "$GIT_COMMITTER_DATE" | |
457 | echo "data <<EOF" | |
458 | printf "$message\n" $n | |
459 | echo "EOF" | |
460 | if test -n "$add_from" | |
461 | then | |
462 | echo "from $ref^0" | |
463 | add_from= | |
464 | fi | |
465 | printf "M 644 inline $filename\n" $n | |
466 | echo "data <<EOF" | |
467 | printf "$contents\n" $n | |
468 | echo "EOF" | |
469 | echo | |
470 | n=$((n + 1)) | |
471 | total=$((total - 1)) | |
472 | done >"$tmpfile" | |
473 | ||
474 | git -C "$indir" \ | |
475 | -c fastimport.unpacklimit=0 \ | |
476 | fast-import <"$tmpfile" || return 1 | |
477 | ||
478 | # This will be left in place on failure, which may aid debugging. | |
479 | rm -f "$tmpfile" | |
480 | ||
481 | # If we updated HEAD, then be nice and update the index and working | |
482 | # tree, too. | |
483 | if test "$ref" = "HEAD" | |
484 | then | |
485 | git -C "$indir" checkout -f HEAD || return 1 | |
486 | fi | |
487 | ||
488 | } | |
489 | ||
12a29b1a TR |
490 | # This function helps systems where core.filemode=false is set. |
491 | # Use it instead of plain 'chmod +x' to set or unset the executable bit | |
492 | # of a file in the working directory and add it to the index. | |
493 | ||
494 | test_chmod () { | |
495 | chmod "$@" && | |
496 | git update-index --add "--chmod=$@" | |
497 | } | |
498 | ||
ea8bbf2a MT |
499 | # Get the modebits from a file or directory, ignoring the setgid bit (g+s). |
500 | # This bit is inherited by subdirectories at their creation. So we remove it | |
501 | # from the returning string to prevent callers from having to worry about the | |
502 | # state of the bit in the test directory. | |
503 | # | |
73de1c93 | 504 | test_modebits () { |
ea8bbf2a MT |
505 | ls -ld "$1" | sed -e 's|^\(..........\).*|\1|' \ |
506 | -e 's|^\(......\)S|\1-|' -e 's|^\(......\)s|\1x|' | |
73de1c93 CC |
507 | } |
508 | ||
12a29b1a TR |
509 | # Unset a configuration variable, but don't fail if it doesn't exist. |
510 | test_unconfig () { | |
5fafc07f JK |
511 | config_dir= |
512 | if test "$1" = -C | |
513 | then | |
514 | shift | |
515 | config_dir=$1 | |
516 | shift | |
517 | fi | |
518 | git ${config_dir:+-C "$config_dir"} config --unset-all "$@" | |
12a29b1a TR |
519 | config_status=$? |
520 | case "$config_status" in | |
521 | 5) # ok, nothing to unset | |
522 | config_status=0 | |
523 | ;; | |
524 | esac | |
525 | return $config_status | |
526 | } | |
527 | ||
528 | # Set git config, automatically unsetting it after the test is over. | |
529 | test_config () { | |
5fafc07f JK |
530 | config_dir= |
531 | if test "$1" = -C | |
532 | then | |
533 | shift | |
534 | config_dir=$1 | |
535 | shift | |
536 | fi | |
537 | test_when_finished "test_unconfig ${config_dir:+-C '$config_dir'} '$1'" && | |
538 | git ${config_dir:+-C "$config_dir"} config "$@" | |
12a29b1a TR |
539 | } |
540 | ||
541 | test_config_global () { | |
542 | test_when_finished "test_unconfig --global '$1'" && | |
543 | git config --global "$@" | |
544 | } | |
545 | ||
546 | write_script () { | |
547 | { | |
548 | echo "#!${2-"$SHELL_PATH"}" && | |
549 | cat | |
550 | } >"$1" && | |
551 | chmod +x "$1" | |
552 | } | |
553 | ||
7da7f63c ÆAB |
554 | # Usage: test_hook [options] <hook-name> <<-\EOF |
555 | # | |
556 | # -C <dir>: | |
557 | # Run all git commands in directory <dir> | |
558 | # --setup | |
559 | # Setup a hook for subsequent tests, i.e. don't remove it in a | |
560 | # "test_when_finished" | |
561 | # --clobber | |
562 | # Overwrite an existing <hook-name>, if it exists. Implies | |
563 | # --setup (i.e. the "test_when_finished" is assumed to have been | |
564 | # set up already). | |
66865d12 ÆAB |
565 | # --disable |
566 | # Disable (chmod -x) an existing <hook-name>, which must exist. | |
567 | # --remove | |
568 | # Remove (rm -f) an existing <hook-name>, which must exist. | |
7da7f63c ÆAB |
569 | test_hook () { |
570 | setup= && | |
571 | clobber= && | |
66865d12 ÆAB |
572 | disable= && |
573 | remove= && | |
7da7f63c ÆAB |
574 | indir= && |
575 | while test $# != 0 | |
576 | do | |
577 | case "$1" in | |
578 | -C) | |
579 | indir="$2" && | |
580 | shift | |
581 | ;; | |
582 | --setup) | |
583 | setup=t | |
584 | ;; | |
585 | --clobber) | |
586 | clobber=t | |
587 | ;; | |
66865d12 ÆAB |
588 | --disable) |
589 | disable=t | |
590 | ;; | |
591 | --remove) | |
592 | remove=t | |
593 | ;; | |
7da7f63c ÆAB |
594 | -*) |
595 | BUG "invalid argument: $1" | |
596 | ;; | |
597 | *) | |
598 | break | |
599 | ;; | |
600 | esac && | |
601 | shift | |
602 | done && | |
603 | ||
604 | git_dir=$(git -C "$indir" rev-parse --absolute-git-dir) && | |
605 | hook_dir="$git_dir/hooks" && | |
606 | hook_file="$hook_dir/$1" && | |
66865d12 ÆAB |
607 | if test -n "$disable$remove" |
608 | then | |
609 | test_path_is_file "$hook_file" && | |
610 | if test -n "$disable" | |
611 | then | |
612 | chmod -x "$hook_file" | |
613 | elif test -n "$remove" | |
614 | then | |
615 | rm -f "$hook_file" | |
616 | fi && | |
617 | return 0 | |
618 | fi && | |
7da7f63c ÆAB |
619 | if test -z "$clobber" |
620 | then | |
621 | test_path_is_missing "$hook_file" | |
622 | fi && | |
623 | if test -z "$setup$clobber" | |
624 | then | |
625 | test_when_finished "rm \"$hook_file\"" | |
626 | fi && | |
627 | write_script "$hook_file" | |
628 | } | |
629 | ||
12a29b1a TR |
630 | # Use test_set_prereq to tell that a particular prerequisite is available. |
631 | # The prerequisite can later be checked for in two ways: | |
632 | # | |
633 | # - Explicitly using test_have_prereq. | |
634 | # | |
635 | # - Implicitly by specifying the prerequisite tag in the calls to | |
5beca49a | 636 | # test_expect_{success,failure} |
12a29b1a TR |
637 | # |
638 | # The single parameter is the prerequisite tag (a simple word, in all | |
639 | # capital letters by convention). | |
640 | ||
7d0ee47c JS |
641 | test_unset_prereq () { |
642 | ! test_have_prereq "$1" || | |
643 | satisfied_prereq="${satisfied_prereq% $1 *} ${satisfied_prereq#* $1 }" | |
644 | } | |
645 | ||
12a29b1a | 646 | test_set_prereq () { |
c7400399 | 647 | if test -n "$GIT_TEST_FAIL_PREREQS_INTERNAL" |
dfe1a17d ÆAB |
648 | then |
649 | case "$1" in | |
650 | # The "!" case is handled below with | |
651 | # test_unset_prereq() | |
652 | !*) | |
653 | ;; | |
0011f94a | 654 | # List of things we can't easily pretend to not support |
dfe1a17d ÆAB |
655 | SYMLINKS) |
656 | ;; | |
657 | # Inspecting whether GIT_TEST_FAIL_PREREQS is on | |
658 | # should be unaffected. | |
659 | FAIL_PREREQS) | |
660 | ;; | |
661 | *) | |
662 | return | |
663 | esac | |
664 | fi | |
665 | ||
7d0ee47c JS |
666 | case "$1" in |
667 | !*) | |
668 | test_unset_prereq "${1#!}" | |
669 | ;; | |
670 | *) | |
671 | satisfied_prereq="$satisfied_prereq$1 " | |
672 | ;; | |
673 | esac | |
12a29b1a | 674 | } |
f3cfc3b2 | 675 | satisfied_prereq=" " |
04083f27 JH |
676 | lazily_testable_prereq= lazily_tested_prereq= |
677 | ||
678 | # Usage: test_lazy_prereq PREREQ 'script' | |
679 | test_lazy_prereq () { | |
680 | lazily_testable_prereq="$lazily_testable_prereq$1 " | |
681 | eval test_prereq_lazily_$1=\$2 | |
682 | } | |
683 | ||
684 | test_run_lazy_prereq_ () { | |
685 | script=' | |
53ff3b96 | 686 | mkdir -p "$TRASH_DIRECTORY/prereq-test-dir-'"$1"'" && |
04083f27 | 687 | ( |
53ff3b96 | 688 | cd "$TRASH_DIRECTORY/prereq-test-dir-'"$1"'" &&'"$2"' |
04083f27 JH |
689 | )' |
690 | say >&3 "checking prerequisite: $1" | |
691 | say >&3 "$script" | |
692 | test_eval_ "$script" | |
693 | eval_ret=$? | |
53ff3b96 | 694 | rm -rf "$TRASH_DIRECTORY/prereq-test-dir-$1" |
04083f27 JH |
695 | if test "$eval_ret" = 0; then |
696 | say >&3 "prerequisite $1 ok" | |
697 | else | |
698 | say >&3 "prerequisite $1 not satisfied" | |
699 | fi | |
700 | return $eval_ret | |
701 | } | |
12a29b1a TR |
702 | |
703 | test_have_prereq () { | |
704 | # prerequisites can be concatenated with ',' | |
705 | save_IFS=$IFS | |
706 | IFS=, | |
707 | set -- $* | |
708 | IFS=$save_IFS | |
709 | ||
710 | total_prereq=0 | |
711 | ok_prereq=0 | |
712 | missing_prereq= | |
713 | ||
714 | for prerequisite | |
715 | do | |
bdccd3c1 JK |
716 | case "$prerequisite" in |
717 | !*) | |
718 | negative_prereq=t | |
719 | prerequisite=${prerequisite#!} | |
720 | ;; | |
721 | *) | |
722 | negative_prereq= | |
723 | esac | |
724 | ||
04083f27 JH |
725 | case " $lazily_tested_prereq " in |
726 | *" $prerequisite "*) | |
727 | ;; | |
728 | *) | |
729 | case " $lazily_testable_prereq " in | |
730 | *" $prerequisite "*) | |
731 | eval "script=\$test_prereq_lazily_$prerequisite" && | |
732 | if test_run_lazy_prereq_ "$prerequisite" "$script" | |
733 | then | |
734 | test_set_prereq $prerequisite | |
735 | fi | |
736 | lazily_tested_prereq="$lazily_tested_prereq$prerequisite " | |
737 | esac | |
738 | ;; | |
739 | esac | |
740 | ||
12a29b1a | 741 | total_prereq=$(($total_prereq + 1)) |
f3cfc3b2 | 742 | case "$satisfied_prereq" in |
12a29b1a | 743 | *" $prerequisite "*) |
bdccd3c1 JK |
744 | satisfied_this_prereq=t |
745 | ;; | |
746 | *) | |
747 | satisfied_this_prereq= | |
748 | esac | |
749 | ||
750 | case "$satisfied_this_prereq,$negative_prereq" in | |
751 | t,|,t) | |
12a29b1a TR |
752 | ok_prereq=$(($ok_prereq + 1)) |
753 | ;; | |
754 | *) | |
bdccd3c1 JK |
755 | # Keep a list of missing prerequisites; restore |
756 | # the negative marker if necessary. | |
757 | prerequisite=${negative_prereq:+!}$prerequisite | |
5024ade1 FS |
758 | |
759 | # Abort if this prereq was marked as required | |
760 | if test -n "$GIT_TEST_REQUIRE_PREREQ" | |
761 | then | |
762 | case " $GIT_TEST_REQUIRE_PREREQ " in | |
763 | *" $prerequisite "*) | |
764 | BAIL_OUT "required prereq $prerequisite failed" | |
765 | ;; | |
766 | esac | |
767 | fi | |
768 | ||
12a29b1a TR |
769 | if test -z "$missing_prereq" |
770 | then | |
771 | missing_prereq=$prerequisite | |
772 | else | |
773 | missing_prereq="$prerequisite,$missing_prereq" | |
774 | fi | |
775 | esac | |
776 | done | |
777 | ||
778 | test $total_prereq = $ok_prereq | |
779 | } | |
780 | ||
781 | test_declared_prereq () { | |
782 | case ",$test_prereq," in | |
783 | *,$1,*) | |
784 | return 0 | |
785 | ;; | |
786 | esac | |
787 | return 1 | |
788 | } | |
789 | ||
d93d5d51 JH |
790 | test_verify_prereq () { |
791 | test -z "$test_prereq" || | |
792 | expr >/dev/null "$test_prereq" : '[A-Z0-9_,!]*$' || | |
165293af | 793 | BUG "'$test_prereq' does not look like a prereq" |
d93d5d51 JH |
794 | } |
795 | ||
12a29b1a | 796 | test_expect_failure () { |
0f5ae593 | 797 | test_start_ "$@" |
12a29b1a TR |
798 | test "$#" = 3 && { test_prereq=$1; shift; } || test_prereq= |
799 | test "$#" = 2 || | |
165293af | 800 | BUG "not 2 or 3 parameters to test-expect-failure" |
d93d5d51 | 801 | test_verify_prereq |
12a29b1a TR |
802 | export test_prereq |
803 | if ! test_skip "$@" | |
804 | then | |
110e9115 | 805 | test -n "$test_skip_test_preamble" || |
ffe1afe6 | 806 | say >&3 "checking known breakage of $TEST_NUMBER.$test_count '$1': $2" |
12a29b1a TR |
807 | if test_run_ "$2" expecting_failure |
808 | then | |
809 | test_known_broken_ok_ "$1" | |
810 | else | |
811 | test_known_broken_failure_ "$1" | |
812 | fi | |
813 | fi | |
ae75342c | 814 | test_finish_ |
12a29b1a TR |
815 | } |
816 | ||
817 | test_expect_success () { | |
0f5ae593 | 818 | test_start_ "$@" |
12a29b1a TR |
819 | test "$#" = 3 && { test_prereq=$1; shift; } || test_prereq= |
820 | test "$#" = 2 || | |
165293af | 821 | BUG "not 2 or 3 parameters to test-expect-success" |
d93d5d51 | 822 | test_verify_prereq |
12a29b1a TR |
823 | export test_prereq |
824 | if ! test_skip "$@" | |
825 | then | |
110e9115 | 826 | test -n "$test_skip_test_preamble" || |
ffe1afe6 | 827 | say >&3 "expecting success of $TEST_NUMBER.$test_count '$1': $2" |
12a29b1a TR |
828 | if test_run_ "$2" |
829 | then | |
830 | test_ok_ "$1" | |
831 | else | |
832 | test_failure_ "$@" | |
833 | fi | |
834 | fi | |
ae75342c | 835 | test_finish_ |
12a29b1a TR |
836 | } |
837 | ||
12a29b1a | 838 | # debugging-friendly alternatives to "test [-f|-d|-e]" |
45a26864 | 839 | # The commands test the existence or non-existence of $1 |
12a29b1a | 840 | test_path_is_file () { |
45a26864 | 841 | test "$#" -ne 1 && BUG "1 param" |
9e8f8dea | 842 | if ! test -f "$1" |
12a29b1a | 843 | then |
45a26864 | 844 | echo "File $1 doesn't exist" |
12a29b1a TR |
845 | false |
846 | fi | |
847 | } | |
848 | ||
456296b5 CG |
849 | test_path_is_file_not_symlink () { |
850 | test "$#" -ne 1 && BUG "1 param" | |
851 | test_path_is_file "$1" && | |
852 | if test -h "$1" | |
853 | then | |
854 | echo "$1 shouldn't be a symbolic link" | |
855 | false | |
856 | fi | |
857 | } | |
858 | ||
12a29b1a | 859 | test_path_is_dir () { |
e7884b35 | 860 | test "$#" -ne 1 && BUG "1 param" |
9e8f8dea | 861 | if ! test -d "$1" |
12a29b1a | 862 | then |
45a26864 | 863 | echo "Directory $1 doesn't exist" |
12a29b1a TR |
864 | false |
865 | fi | |
866 | } | |
867 | ||
456296b5 CG |
868 | test_path_is_dir_not_symlink () { |
869 | test "$#" -ne 1 && BUG "1 param" | |
870 | test_path_is_dir "$1" && | |
871 | if test -h "$1" | |
872 | then | |
873 | echo "$1 shouldn't be a symbolic link" | |
874 | false | |
875 | fi | |
876 | } | |
877 | ||
7e9055bb | 878 | test_path_exists () { |
45a26864 | 879 | test "$#" -ne 1 && BUG "1 param" |
7e9055bb EN |
880 | if ! test -e "$1" |
881 | then | |
45a26864 | 882 | echo "Path $1 doesn't exist" |
7e9055bb EN |
883 | false |
884 | fi | |
885 | } | |
886 | ||
456296b5 CG |
887 | test_path_is_symlink () { |
888 | test "$#" -ne 1 && BUG "1 param" | |
889 | if ! test -h "$1" | |
890 | then | |
891 | echo "Symbolic link $1 doesn't exist" | |
892 | false | |
893 | fi | |
894 | } | |
895 | ||
0be7d9b7 JL |
896 | # Check if the directory exists and is empty as expected, barf otherwise. |
897 | test_dir_is_empty () { | |
e7884b35 | 898 | test "$#" -ne 1 && BUG "1 param" |
0be7d9b7 | 899 | test_path_is_dir "$1" && |
81580fa0 | 900 | if test -n "$(ls -a1 "$1" | grep -E -v '^\.\.?$')" |
0be7d9b7 JL |
901 | then |
902 | echo "Directory '$1' is not empty, it contains:" | |
903 | ls -la "$1" | |
904 | return 1 | |
905 | fi | |
906 | } | |
907 | ||
21d5ad91 RA |
908 | # Check if the file exists and has a size greater than zero |
909 | test_file_not_empty () { | |
e7884b35 | 910 | test "$#" = 2 && BUG "2 param" |
21d5ad91 RA |
911 | if ! test -s "$1" |
912 | then | |
913 | echo "'$1' is not a non-empty file." | |
914 | false | |
915 | fi | |
916 | } | |
917 | ||
12a29b1a | 918 | test_path_is_missing () { |
e7884b35 | 919 | test "$#" -ne 1 && BUG "1 param" |
9e8f8dea | 920 | if test -e "$1" |
12a29b1a TR |
921 | then |
922 | echo "Path exists:" | |
923 | ls -ld "$1" | |
12a29b1a TR |
924 | false |
925 | fi | |
926 | } | |
927 | ||
928 | # test_line_count checks that a file has the number of lines it | |
929 | # ought to. For example: | |
930 | # | |
931 | # test_expect_success 'produce exactly one line of output' ' | |
932 | # do something >output && | |
933 | # test_line_count = 1 output | |
934 | # ' | |
935 | # | |
936 | # is like "test $(wc -l <output) = 1" except that it passes the | |
937 | # output through when the number of lines is wrong. | |
938 | ||
939 | test_line_count () { | |
940 | if test $# != 3 | |
941 | then | |
165293af | 942 | BUG "not 3 parameters to test_line_count" |
12a29b1a TR |
943 | elif ! test $(wc -l <"$3") "$1" "$2" |
944 | then | |
945 | echo "test_line_count: line count for $3 !$1 $2" | |
946 | cat "$3" | |
947 | return 1 | |
948 | fi | |
949 | } | |
950 | ||
cdff1bb5 ĐTCD |
951 | # SYNOPSIS: |
952 | # test_stdout_line_count <bin-ops> <value> <cmd> [<args>...] | |
953 | # | |
954 | # test_stdout_line_count checks that the output of a command has the number | |
955 | # of lines it ought to. For example: | |
956 | # | |
957 | # test_stdout_line_count = 3 git ls-files -u | |
958 | # test_stdout_line_count -gt 10 ls | |
959 | test_stdout_line_count () { | |
960 | local ops val trashdir && | |
961 | if test "$#" -le 3 | |
962 | then | |
963 | BUG "expect 3 or more arguments" | |
964 | fi && | |
965 | ops="$1" && | |
966 | val="$2" && | |
967 | shift 2 && | |
968 | if ! trashdir="$(git rev-parse --git-dir)/trash"; then | |
969 | BUG "expect to be run inside a worktree" | |
970 | fi && | |
971 | mkdir -p "$trashdir" && | |
972 | "$@" >"$trashdir/output" && | |
973 | test_line_count "$ops" "$val" "$trashdir/output" | |
974 | } | |
975 | ||
976 | ||
53b67a80 | 977 | test_file_size () { |
e7884b35 | 978 | test "$#" -ne 1 && BUG "1 param" |
53b67a80 JS |
979 | test-tool path-utils file-size "$1" |
980 | } | |
981 | ||
bbfe5302 LS |
982 | # Returns success if a comma separated string of keywords ($1) contains a |
983 | # given keyword ($2). | |
984 | # Examples: | |
985 | # `list_contains "foo,bar" bar` returns 0 | |
986 | # `list_contains "foo" bar` returns 1 | |
987 | ||
988 | list_contains () { | |
989 | case ",$1," in | |
990 | *,$2,*) | |
991 | return 0 | |
992 | ;; | |
993 | esac | |
994 | return 1 | |
995 | } | |
996 | ||
6a67c759 DL |
997 | # Returns success if the arguments indicate that a command should be |
998 | # accepted by test_must_fail(). If the command is run with env, the env | |
999 | # and its corresponding variable settings will be stripped before we | |
1000 | # test the command being run. | |
1001 | test_must_fail_acceptable () { | |
1002 | if test "$1" = "env" | |
1003 | then | |
1004 | shift | |
1005 | while test $# -gt 0 | |
1006 | do | |
1007 | case "$1" in | |
1008 | *?=*) | |
1009 | shift | |
1010 | ;; | |
1011 | *) | |
1012 | break | |
1013 | ;; | |
1014 | esac | |
1015 | done | |
1016 | fi | |
1017 | ||
1018 | case "$1" in | |
fc47391e | 1019 | git|__git*|test-tool|test_terminal) |
6a67c759 DL |
1020 | return 0 |
1021 | ;; | |
1022 | *) | |
1023 | return 1 | |
1024 | ;; | |
1025 | esac | |
1026 | } | |
1027 | ||
12a29b1a TR |
1028 | # This is not among top-level (test_expect_success | test_expect_failure) |
1029 | # but is a prefix that can be used in the test script, like: | |
1030 | # | |
1031 | # test_expect_success 'complain and die' ' | |
1032 | # do something && | |
1033 | # do something else && | |
1034 | # test_must_fail git checkout ../outerspace | |
1035 | # ' | |
1036 | # | |
1037 | # Writing this as "! git checkout ../outerspace" is wrong, because | |
1038 | # the failure could be due to a segv. We want a controlled failure. | |
12e31a6b SG |
1039 | # |
1040 | # Accepts the following options: | |
1041 | # | |
1042 | # ok=<signal-name>[,<...>]: | |
1043 | # Don't treat an exit caused by the given signal as error. | |
1044 | # Multiple signals can be specified as a comma separated list. | |
1045 | # Currently recognized signal names are: sigpipe, success. | |
1046 | # (Don't use 'success', use 'test_might_fail' instead.) | |
6a67c759 DL |
1047 | # |
1048 | # Do not use this to run anything but "git" and other specific testable | |
1049 | # commands (see test_must_fail_acceptable()). We are not in the | |
1050 | # business of vetting system supplied commands -- in other words, this | |
1051 | # is wrong: | |
1052 | # | |
1053 | # test_must_fail grep pattern output | |
1054 | # | |
1055 | # Instead use '!': | |
1056 | # | |
1057 | # ! grep pattern output | |
12a29b1a TR |
1058 | |
1059 | test_must_fail () { | |
bbfe5302 LS |
1060 | case "$1" in |
1061 | ok=*) | |
1062 | _test_ok=${1#ok=} | |
1063 | shift | |
1064 | ;; | |
1065 | *) | |
1066 | _test_ok= | |
1067 | ;; | |
1068 | esac | |
6a67c759 DL |
1069 | if ! test_must_fail_acceptable "$@" |
1070 | then | |
1071 | echo >&7 "test_must_fail: only 'git' is allowed: $*" | |
1072 | return 1 | |
1073 | fi | |
a5bf824f | 1074 | "$@" 2>&7 |
12a29b1a | 1075 | exit_code=$? |
bbfe5302 LS |
1076 | if test $exit_code -eq 0 && ! list_contains "$_test_ok" success |
1077 | then | |
03aa3783 | 1078 | echo >&4 "test_must_fail: command succeeded: $*" |
12a29b1a | 1079 | return 1 |
2472448c | 1080 | elif test_match_signal 13 $exit_code && list_contains "$_test_ok" sigpipe |
8bf4becf LS |
1081 | then |
1082 | return 0 | |
bbfe5302 LS |
1083 | elif test $exit_code -gt 129 && test $exit_code -le 192 |
1084 | then | |
03aa3783 | 1085 | echo >&4 "test_must_fail: died by signal $(($exit_code - 128)): $*" |
12a29b1a | 1086 | return 1 |
bbfe5302 LS |
1087 | elif test $exit_code -eq 127 |
1088 | then | |
03aa3783 | 1089 | echo >&4 "test_must_fail: command not found: $*" |
12a29b1a | 1090 | return 1 |
bbfe5302 LS |
1091 | elif test $exit_code -eq 126 |
1092 | then | |
03aa3783 | 1093 | echo >&4 "test_must_fail: valgrind error: $*" |
eeb69131 | 1094 | return 1 |
12a29b1a TR |
1095 | fi |
1096 | return 0 | |
a5bf824f | 1097 | } 7>&2 2>&4 |
12a29b1a TR |
1098 | |
1099 | # Similar to test_must_fail, but tolerates success, too. This is | |
1100 | # meant to be used in contexts like: | |
1101 | # | |
1102 | # test_expect_success 'some command works without configuration' ' | |
1103 | # test_might_fail git config --unset all.configuration && | |
1104 | # do something | |
1105 | # ' | |
1106 | # | |
1107 | # Writing "git config --unset all.configuration || :" would be wrong, | |
1108 | # because we want to notice if it fails due to segv. | |
12e31a6b SG |
1109 | # |
1110 | # Accepts the same options as test_must_fail. | |
12a29b1a TR |
1111 | |
1112 | test_might_fail () { | |
a5bf824f SG |
1113 | test_must_fail ok=success "$@" 2>&7 |
1114 | } 7>&2 2>&4 | |
12a29b1a TR |
1115 | |
1116 | # Similar to test_must_fail and test_might_fail, but check that a | |
1117 | # given command exited with a given exit code. Meant to be used as: | |
1118 | # | |
1119 | # test_expect_success 'Merge with d/f conflicts' ' | |
1120 | # test_expect_code 1 git merge "merge msg" B master | |
1121 | # ' | |
1122 | ||
1123 | test_expect_code () { | |
1124 | want_code=$1 | |
1125 | shift | |
a5bf824f | 1126 | "$@" 2>&7 |
12a29b1a TR |
1127 | exit_code=$? |
1128 | if test $exit_code = $want_code | |
1129 | then | |
1130 | return 0 | |
1131 | fi | |
1132 | ||
03aa3783 | 1133 | echo >&4 "test_expect_code: command exited with $exit_code, we wanted $want_code $*" |
12a29b1a | 1134 | return 1 |
a5bf824f | 1135 | } 7>&2 2>&4 |
12a29b1a TR |
1136 | |
1137 | # test_cmp is a helper function to compare actual and expected output. | |
1138 | # You can use it like: | |
1139 | # | |
1140 | # test_expect_success 'foo works' ' | |
1141 | # echo expected >expected && | |
1142 | # foo >actual && | |
1143 | # test_cmp expected actual | |
1144 | # ' | |
1145 | # | |
1146 | # This could be written as either "cmp" or "diff -u", but: | |
1147 | # - cmp's output is not nearly as easy to read as diff -u | |
1148 | # - not all diff versions understand "-u" | |
1149 | ||
1ab7e00e | 1150 | test_cmp () { |
e7884b35 | 1151 | test "$#" -ne 2 && BUG "2 param" |
262d5ad5 | 1152 | eval "$GIT_TEST_CMP" '"$@"' |
12a29b1a TR |
1153 | } |
1154 | ||
a5db0b77 NTND |
1155 | # Check that the given config key has the expected value. |
1156 | # | |
1157 | # test_cmp_config [-C <dir>] <expected-value> | |
1158 | # [<git-config-options>...] <config-key> | |
1159 | # | |
1160 | # for example to check that the value of core.bar is foo | |
1161 | # | |
1162 | # test_cmp_config foo core.bar | |
1163 | # | |
1ab7e00e | 1164 | test_cmp_config () { |
a5db0b77 NTND |
1165 | local GD && |
1166 | if test "$1" = "-C" | |
1167 | then | |
1168 | shift && | |
1169 | GD="-C $1" && | |
1170 | shift | |
1171 | fi && | |
1172 | printf "%s\n" "$1" >expect.config && | |
1173 | shift && | |
1174 | git $GD config "$@" >actual.config && | |
1175 | test_cmp expect.config actual.config | |
1176 | } | |
1177 | ||
b93e6e36 SK |
1178 | # test_cmp_bin - helper to compare binary files |
1179 | ||
1ab7e00e | 1180 | test_cmp_bin () { |
e7884b35 | 1181 | test "$#" -ne 2 && BUG "2 param" |
262d5ad5 | 1182 | cmp "$@" |
b93e6e36 SK |
1183 | } |
1184 | ||
d162b25f ÆAB |
1185 | # Wrapper for grep which used to be used for |
1186 | # GIT_TEST_GETTEXT_POISON=false. Only here as a shim for other | |
1187 | # in-flight changes. Should not be used and will be removed soon. | |
0f59128f | 1188 | test_i18ngrep () { |
fd29d7b9 SG |
1189 | eval "last_arg=\${$#}" |
1190 | ||
1191 | test -f "$last_arg" || | |
165293af | 1192 | BUG "test_i18ngrep requires a file to read as the last parameter" |
fd29d7b9 SG |
1193 | |
1194 | if test $# -lt 2 || | |
1195 | { test "x!" = "x$1" && test $# -lt 3 ; } | |
1196 | then | |
165293af | 1197 | BUG "too few parameters to test_i18ngrep" |
fd29d7b9 SG |
1198 | fi |
1199 | ||
63b1a175 | 1200 | if test "x!" = "x$1" |
0f59128f SG |
1201 | then |
1202 | shift | |
63b1a175 SG |
1203 | ! grep "$@" && return 0 |
1204 | ||
03aa3783 | 1205 | echo >&4 "error: '! grep $@' did find a match in:" |
0f59128f | 1206 | else |
63b1a175 SG |
1207 | grep "$@" && return 0 |
1208 | ||
03aa3783 | 1209 | echo >&4 "error: 'grep $@' didn't find a match in:" |
0f59128f | 1210 | fi |
63b1a175 SG |
1211 | |
1212 | if test -s "$last_arg" | |
1213 | then | |
03aa3783 | 1214 | cat >&4 "$last_arg" |
63b1a175 | 1215 | else |
03aa3783 | 1216 | echo >&4 "<File '$last_arg' is empty>" |
63b1a175 SG |
1217 | fi |
1218 | ||
1219 | return 1 | |
0f59128f SG |
1220 | } |
1221 | ||
8ad16524 JK |
1222 | # Call any command "$@" but be more verbose about its |
1223 | # failure. This is handy for commands like "test" which do | |
1224 | # not output anything when they fail. | |
1225 | verbose () { | |
1226 | "$@" && return 0 | |
03aa3783 | 1227 | echo >&4 "command failed: $(git rev-parse --sq-quote "$@")" |
8ad16524 JK |
1228 | return 1 |
1229 | } | |
1230 | ||
ca8d148d JH |
1231 | # Check if the file expected to be empty is indeed empty, and barfs |
1232 | # otherwise. | |
1233 | ||
1234 | test_must_be_empty () { | |
e7884b35 | 1235 | test "$#" -ne 1 && BUG "1 param" |
9eb23080 SG |
1236 | test_path_is_file "$1" && |
1237 | if test -s "$1" | |
ca8d148d JH |
1238 | then |
1239 | echo "'$1' is not empty, it contains:" | |
1240 | cat "$1" | |
1241 | return 1 | |
1242 | fi | |
1243 | } | |
1244 | ||
2c9e125b DL |
1245 | # Tests that its two parameters refer to the same revision, or if '!' is |
1246 | # provided first, that its other two parameters refer to different | |
1247 | # revisions. | |
5d77298d | 1248 | test_cmp_rev () { |
2c9e125b DL |
1249 | local op='=' wrong_result=different |
1250 | ||
1251 | if test $# -ge 1 && test "x$1" = 'x!' | |
1252 | then | |
1253 | op='!=' | |
1254 | wrong_result='the same' | |
1255 | shift | |
1256 | fi | |
30d0b6dc SG |
1257 | if test $# != 2 |
1258 | then | |
9e9c7dd6 | 1259 | BUG "test_cmp_rev requires two revisions, but got $#" |
30d0b6dc SG |
1260 | else |
1261 | local r1 r2 | |
1262 | r1=$(git rev-parse --verify "$1") && | |
2c9e125b DL |
1263 | r2=$(git rev-parse --verify "$2") || return 1 |
1264 | ||
1265 | if ! test "$r1" "$op" "$r2" | |
30d0b6dc SG |
1266 | then |
1267 | cat >&4 <<-EOF | |
2c9e125b | 1268 | error: two revisions point to $wrong_result objects: |
30d0b6dc SG |
1269 | '$1': $r1 |
1270 | '$2': $r2 | |
1271 | EOF | |
1272 | return 1 | |
1273 | fi | |
1274 | fi | |
5d77298d MZ |
1275 | } |
1276 | ||
ed33bd8f JS |
1277 | # Compare paths respecting core.ignoreCase |
1278 | test_cmp_fspath () { | |
1279 | if test "x$1" = "x$2" | |
1280 | then | |
1281 | return 0 | |
1282 | fi | |
1283 | ||
1284 | if test true != "$(git config --get --type=bool core.ignorecase)" | |
1285 | then | |
1286 | return 1 | |
1287 | fi | |
1288 | ||
1289 | test "x$(echo "$1" | tr A-Z a-z)" = "x$(echo "$2" | tr A-Z a-z)" | |
1290 | } | |
1291 | ||
55672a39 JH |
1292 | # Print a sequence of integers in increasing order, either with |
1293 | # two arguments (start and end): | |
d17cf5f3 | 1294 | # |
55672a39 JH |
1295 | # test_seq 1 5 -- outputs 1 2 3 4 5 one line at a time |
1296 | # | |
1297 | # or with one argument (end), in which case it starts counting | |
1298 | # from 1. | |
d17cf5f3 MK |
1299 | |
1300 | test_seq () { | |
1301 | case $# in | |
1302 | 1) set 1 "$@" ;; | |
1303 | 2) ;; | |
165293af | 1304 | *) BUG "not 1 or 2 parameters to test_seq" ;; |
d17cf5f3 | 1305 | esac |
4df43135 JH |
1306 | test_seq_counter__=$1 |
1307 | while test "$test_seq_counter__" -le "$2" | |
1308 | do | |
1309 | echo "$test_seq_counter__" | |
1310 | test_seq_counter__=$(( $test_seq_counter__ + 1 )) | |
1311 | done | |
d17cf5f3 MK |
1312 | } |
1313 | ||
12a29b1a TR |
1314 | # This function can be used to schedule some commands to be run |
1315 | # unconditionally at the end of the test to restore sanity: | |
1316 | # | |
1317 | # test_expect_success 'test core.capslock' ' | |
1318 | # git config core.capslock true && | |
1319 | # test_when_finished "git config --unset core.capslock" && | |
1320 | # hello world | |
1321 | # ' | |
1322 | # | |
1323 | # That would be roughly equivalent to | |
1324 | # | |
1325 | # test_expect_success 'test core.capslock' ' | |
1326 | # git config core.capslock true && | |
1327 | # hello world | |
1328 | # git config --unset core.capslock | |
1329 | # ' | |
1330 | # | |
1331 | # except that the greeting and config --unset must both succeed for | |
1332 | # the test to pass. | |
1333 | # | |
1334 | # Note that under --immediate mode, no clean-up is done to help diagnose | |
1335 | # what went wrong. | |
1336 | ||
1337 | test_when_finished () { | |
0968f12a JK |
1338 | # We cannot detect when we are in a subshell in general, but by |
1339 | # doing so on Bash is better than nothing (the test will | |
1340 | # silently pass on other shells). | |
1341 | test "${BASH_SUBSHELL-0}" = 0 || | |
165293af | 1342 | BUG "test_when_finished does nothing in a subshell" |
12a29b1a TR |
1343 | test_cleanup="{ $* |
1344 | } && (exit \"\$eval_ret\"); eval_ret=\$?; $test_cleanup" | |
1345 | } | |
1346 | ||
900721e1 JS |
1347 | # This function can be used to schedule some commands to be run |
1348 | # unconditionally at the end of the test script, e.g. to stop a daemon: | |
1349 | # | |
1350 | # test_expect_success 'test git daemon' ' | |
1351 | # git daemon & | |
1352 | # daemon_pid=$! && | |
1353 | # test_atexit 'kill $daemon_pid' && | |
1354 | # hello world | |
1355 | # ' | |
1356 | # | |
1357 | # The commands will be executed before the trash directory is removed, | |
1358 | # i.e. the atexit commands will still be able to access any pidfiles or | |
1359 | # socket files. | |
1360 | # | |
1361 | # Note that these commands will be run even when a test script run | |
1362 | # with '--immediate' fails. Be careful with your atexit commands to | |
1363 | # minimize any changes to the failed state. | |
1364 | ||
1365 | test_atexit () { | |
1366 | # We cannot detect when we are in a subshell in general, but by | |
1367 | # doing so on Bash is better than nothing (the test will | |
1368 | # silently pass on other shells). | |
1369 | test "${BASH_SUBSHELL-0}" = 0 || | |
9e9c7dd6 | 1370 | BUG "test_atexit does nothing in a subshell" |
900721e1 JS |
1371 | test_atexit_cleanup="{ $* |
1372 | } && (exit \"\$eval_ret\"); eval_ret=\$?; $test_atexit_cleanup" | |
1373 | } | |
1374 | ||
f0d4d398 | 1375 | # Deprecated wrapper for "git init", use "git init" directly instead |
12a29b1a TR |
1376 | # Usage: test_create_repo <directory> |
1377 | test_create_repo () { | |
f0d4d398 | 1378 | git init "$@" |
12a29b1a | 1379 | } |
9ce415d9 JS |
1380 | |
1381 | # This function helps on symlink challenged file systems when it is not | |
1382 | # important that the file system entry is a symbolic link. | |
1383 | # Use test_ln_s_add instead of "ln -s x y && git add y" to add a | |
1384 | # symbolic link entry y to the index. | |
1385 | ||
1386 | test_ln_s_add () { | |
1387 | if test_have_prereq SYMLINKS | |
1388 | then | |
1389 | ln -s "$1" "$2" && | |
1390 | git update-index --add "$2" | |
1391 | else | |
1392 | printf '%s' "$1" >"$2" && | |
1393 | ln_s_obj=$(git hash-object -w "$2") && | |
817d03e1 JS |
1394 | git update-index --add --cacheinfo 120000 $ln_s_obj "$2" && |
1395 | # pick up stat info from the file | |
1396 | git update-index "$2" | |
9ce415d9 JS |
1397 | fi |
1398 | } | |
4d715ac0 | 1399 | |
ac9afcc3 MT |
1400 | # This function writes out its parameters, one per line |
1401 | test_write_lines () { | |
1402 | printf "%s\n" "$@" | |
1403 | } | |
1404 | ||
a0e0ec9f | 1405 | perl () { |
a5bf824f SG |
1406 | command "$PERL_PATH" "$@" 2>&7 |
1407 | } 7>&2 2>&4 | |
a3a9cff0 | 1408 | |
43a2afee SG |
1409 | # Given the name of an environment variable with a bool value, normalize |
1410 | # its value to a 0 (true) or 1 (false or empty string) return code. | |
1411 | # | |
1412 | # test_bool_env GIT_TEST_HTTPD <default-value> | |
1413 | # | |
1414 | # Return with code corresponding to the given default value if the variable | |
1415 | # is unset. | |
1416 | # Abort the test script if either the value of the variable or the default | |
1417 | # are not valid bool values. | |
1418 | ||
1419 | test_bool_env () { | |
1420 | if test $# != 2 | |
1421 | then | |
1422 | BUG "test_bool_env requires two parameters (variable name and default value)" | |
1423 | fi | |
1424 | ||
1425 | git env--helper --type=bool --default="$2" --exit-code "$1" | |
1426 | ret=$? | |
1427 | case $ret in | |
1428 | 0|1) # unset or valid bool value | |
1429 | ;; | |
1430 | *) # invalid bool value or something unexpected | |
1431 | error >&7 "test_bool_env requires bool values both for \$$1 and for the default fallback" | |
1432 | ;; | |
1433 | esac | |
1434 | return $ret | |
1435 | } | |
1436 | ||
83d842dc | 1437 | # Exit the test suite, either by skipping all remaining tests or by |
3b072c57 ÆAB |
1438 | # exiting with an error. If our prerequisite variable $1 falls back |
1439 | # on a default assume we were opportunistically trying to set up some | |
1440 | # tests and we skip. If it is explicitly "true", then we report a failure. | |
83d842dc JK |
1441 | # |
1442 | # The error/skip message should be given by $2. | |
1443 | # | |
1444 | test_skip_or_die () { | |
43a2afee | 1445 | if ! test_bool_env "$1" false |
3b072c57 | 1446 | then |
83d842dc JK |
1447 | skip_all=$2 |
1448 | test_done | |
3b072c57 ÆAB |
1449 | fi |
1450 | error "$2" | |
83d842dc JK |
1451 | } |
1452 | ||
4d715ac0 JS |
1453 | # The following mingw_* functions obey POSIX shell syntax, but are actually |
1454 | # bash scripts, and are meant to be used only with bash on Windows. | |
1455 | ||
1456 | # A test_cmp function that treats LF and CRLF equal and avoids to fork | |
1457 | # diff when possible. | |
1458 | mingw_test_cmp () { | |
1459 | # Read text into shell variables and compare them. If the results | |
1460 | # are different, use regular diff to report the difference. | |
1461 | local test_cmp_a= test_cmp_b= | |
1462 | ||
1463 | # When text came from stdin (one argument is '-') we must feed it | |
1464 | # to diff. | |
1465 | local stdin_for_diff= | |
1466 | ||
1467 | # Since it is difficult to detect the difference between an | |
1468 | # empty input file and a failure to read the files, we go straight | |
1469 | # to diff if one of the inputs is empty. | |
1470 | if test -s "$1" && test -s "$2" | |
1471 | then | |
1472 | # regular case: both files non-empty | |
1473 | mingw_read_file_strip_cr_ test_cmp_a <"$1" | |
1474 | mingw_read_file_strip_cr_ test_cmp_b <"$2" | |
1475 | elif test -s "$1" && test "$2" = - | |
1476 | then | |
1477 | # read 2nd file from stdin | |
1478 | mingw_read_file_strip_cr_ test_cmp_a <"$1" | |
1479 | mingw_read_file_strip_cr_ test_cmp_b | |
1480 | stdin_for_diff='<<<"$test_cmp_b"' | |
1481 | elif test "$1" = - && test -s "$2" | |
1482 | then | |
1483 | # read 1st file from stdin | |
1484 | mingw_read_file_strip_cr_ test_cmp_a | |
1485 | mingw_read_file_strip_cr_ test_cmp_b <"$2" | |
1486 | stdin_for_diff='<<<"$test_cmp_a"' | |
1487 | fi | |
1488 | test -n "$test_cmp_a" && | |
1489 | test -n "$test_cmp_b" && | |
1490 | test "$test_cmp_a" = "$test_cmp_b" || | |
1491 | eval "diff -u \"\$@\" $stdin_for_diff" | |
1492 | } | |
1493 | ||
1494 | # $1 is the name of the shell variable to fill in | |
1495 | mingw_read_file_strip_cr_ () { | |
1496 | # Read line-wise using LF as the line separator | |
1497 | # and use IFS to strip CR. | |
1498 | local line | |
1499 | while : | |
1500 | do | |
1501 | if IFS=$'\r' read -r -d $'\n' line | |
1502 | then | |
1503 | # good | |
1504 | line=$line$'\n' | |
1505 | else | |
1506 | # we get here at EOF, but also if the last line | |
1507 | # was not terminated by LF; in the latter case, | |
1508 | # some text was read | |
1509 | if test -z "$line" | |
1510 | then | |
1511 | # EOF, really | |
1512 | break | |
1513 | fi | |
1514 | fi | |
1515 | eval "$1=\$$1\$line" | |
1516 | done | |
1517 | } | |
d2554c72 JK |
1518 | |
1519 | # Like "env FOO=BAR some-program", but run inside a subshell, which means | |
1520 | # it also works for shell functions (though those functions cannot impact | |
1521 | # the environment outside of the test_env invocation). | |
1522 | test_env () { | |
1523 | ( | |
1524 | while test $# -gt 0 | |
1525 | do | |
1526 | case "$1" in | |
1527 | *=*) | |
1528 | eval "${1%%=*}=\${1#*=}" | |
1529 | eval "export ${1%%=*}" | |
1530 | shift | |
1531 | ;; | |
1532 | *) | |
a5bf824f | 1533 | "$@" 2>&7 |
d2554c72 JK |
1534 | exit |
1535 | ;; | |
1536 | esac | |
1537 | done | |
1538 | ) | |
a5bf824f | 1539 | } 7>&2 2>&4 |
48860819 | 1540 | |
9b67c994 JK |
1541 | # Returns true if the numeric exit code in "$2" represents the expected signal |
1542 | # in "$1". Signals should be given numerically. | |
1543 | test_match_signal () { | |
1544 | if test "$2" = "$((128 + $1))" | |
1545 | then | |
1546 | # POSIX | |
1547 | return 0 | |
1548 | elif test "$2" = "$((256 + $1))" | |
1549 | then | |
1550 | # ksh | |
1551 | return 0 | |
1552 | fi | |
1553 | return 1 | |
1554 | } | |
39cadeec | 1555 | |
48860819 JK |
1556 | # Read up to "$1" bytes (or to EOF) from stdin and write them to stdout. |
1557 | test_copy_bytes () { | |
1558 | perl -e ' | |
1559 | my $len = $ARGV[1]; | |
1560 | while ($len > 0) { | |
1561 | my $s; | |
1562 | my $nread = sysread(STDIN, $s, $len); | |
1563 | die "cannot read: $!" unless defined($nread); | |
f7f6dc34 | 1564 | last unless $nread; |
48860819 JK |
1565 | print $s; |
1566 | $len -= $nread; | |
1567 | } | |
1568 | ' - "$1" | |
1569 | } | |
de95302a JK |
1570 | |
1571 | # run "$@" inside a non-git directory | |
1572 | nongit () { | |
1573 | test -d non-repo || | |
1574 | mkdir non-repo || | |
1575 | return 1 | |
1576 | ||
1577 | ( | |
1578 | GIT_CEILING_DIRECTORIES=$(pwd) && | |
1579 | export GIT_CEILING_DIRECTORIES && | |
1580 | cd non-repo && | |
a5bf824f | 1581 | "$@" 2>&7 |
de95302a | 1582 | ) |
a5bf824f | 1583 | } 7>&2 2>&4 |
4414a150 | 1584 | |
64f0109f ÆAB |
1585 | # These functions are historical wrappers around "test-tool pkt-line" |
1586 | # for older tests. Use "test-tool pkt-line" itself in new tests. | |
1ab7e00e | 1587 | packetize () { |
88124ab2 JK |
1588 | if test $# -gt 0 |
1589 | then | |
1590 | packet="$*" | |
1591 | printf '%04x%s' "$((4 + ${#packet}))" "$packet" | |
1592 | else | |
64f0109f | 1593 | test-tool pkt-line pack |
88124ab2 | 1594 | fi |
4414a150 JK |
1595 | } |
1596 | ||
64f0109f ÆAB |
1597 | packetize_raw () { |
1598 | test-tool pkt-line pack-raw-stdin | |
1599 | } | |
1600 | ||
4414a150 | 1601 | depacketize () { |
64f0109f | 1602 | test-tool pkt-line unpack |
4414a150 | 1603 | } |
2c02b110 | 1604 | |
5c07647d TB |
1605 | # Converts base-16 data into base-8. The output is given as a sequence of |
1606 | # escaped octals, suitable for consumption by 'printf'. | |
1607 | hex2oct () { | |
1608 | perl -ne 'printf "\\%03o", hex for /../g' | |
1609 | } | |
1610 | ||
2c02b110 | 1611 | # Set the hash algorithm in use to $1. Only useful when testing the testsuite. |
1612 | test_set_hash () { | |
1613 | test_hash_algo="$1" | |
1614 | } | |
1615 | ||
1616 | # Detect the hash algorithm in use. | |
1617 | test_detect_hash () { | |
02a32dbf | 1618 | test_hash_algo="${GIT_TEST_DEFAULT_HASH:-sha1}" |
2c02b110 | 1619 | } |
1620 | ||
1621 | # Load common hash metadata and common placeholder object IDs for use with | |
1622 | # test_oid. | |
1623 | test_oid_init () { | |
1624 | test -n "$test_hash_algo" || test_detect_hash && | |
1625 | test_oid_cache <"$TEST_DIRECTORY/oid-info/hash-info" && | |
1626 | test_oid_cache <"$TEST_DIRECTORY/oid-info/oid" | |
1627 | } | |
1628 | ||
1629 | # Load key-value pairs from stdin suitable for use with test_oid. Blank lines | |
1630 | # and lines starting with "#" are ignored. Keys must be shell identifier | |
1631 | # characters. | |
1632 | # | |
1633 | # Examples: | |
1634 | # rawsz sha1:20 | |
1635 | # rawsz sha256:32 | |
1636 | test_oid_cache () { | |
1637 | local tag rest k v && | |
1638 | ||
1639 | { test -n "$test_hash_algo" || test_detect_hash; } && | |
1640 | while read tag rest | |
1641 | do | |
1642 | case $tag in | |
1643 | \#*) | |
1644 | continue;; | |
1645 | ?*) | |
1646 | # non-empty | |
1647 | ;; | |
1648 | *) | |
1649 | # blank line | |
1650 | continue;; | |
1651 | esac && | |
1652 | ||
1653 | k="${rest%:*}" && | |
1654 | v="${rest#*:}" && | |
1655 | ||
1656 | if ! expr "$k" : '[a-z0-9][a-z0-9]*$' >/dev/null | |
1657 | then | |
165293af | 1658 | BUG 'bad hash algorithm' |
2c02b110 | 1659 | fi && |
1660 | eval "test_oid_${k}_$tag=\"\$v\"" | |
1661 | done | |
1662 | } | |
1663 | ||
1664 | # Look up a per-hash value based on a key ($1). The value must have been loaded | |
1665 | # by test_oid_init or test_oid_cache. | |
1666 | test_oid () { | |
ceaa4b3a | 1667 | local algo="${test_hash_algo}" && |
1668 | ||
1669 | case "$1" in | |
1670 | --hash=*) | |
1671 | algo="${1#--hash=}" && | |
1672 | shift;; | |
1673 | *) | |
1674 | ;; | |
1675 | esac && | |
1676 | ||
1677 | local var="test_oid_${algo}_$1" && | |
2c02b110 | 1678 | |
1679 | # If the variable is unset, we must be missing an entry for this | |
1680 | # key-hash pair, so exit with an error. | |
1681 | if eval "test -z \"\${$var+set}\"" | |
1682 | then | |
165293af | 1683 | BUG "undefined key '$1'" |
2c02b110 | 1684 | fi && |
1685 | eval "printf '%s' \"\${$var}\"" | |
1686 | } | |
fa840581 | 1687 | |
56d88924 | 1688 | # Insert a slash into an object ID so it can be used to reference a location |
1689 | # under ".git/objects". For example, "deadbeef..." becomes "de/adbeef..". | |
1690 | test_oid_to_path () { | |
1c1f6e03 JN |
1691 | local basename=${1#??} |
1692 | echo "${1%$basename}/$basename" | |
56d88924 | 1693 | } |
1694 | ||
fb2d0db5 NS |
1695 | # Parse oids from git ls-files --staged output |
1696 | test_parse_ls_files_stage_oids () { | |
1697 | awk '{print $2}' - | |
1698 | } | |
1699 | ||
1700 | # Parse oids from git ls-tree output | |
1701 | test_parse_ls_tree_oids () { | |
1702 | awk '{print $3}' - | |
1703 | } | |
1704 | ||
fa840581 SG |
1705 | # Choose a port number based on the test script's number and store it in |
1706 | # the given variable name, unless that variable already contains a number. | |
1707 | test_set_port () { | |
1708 | local var=$1 port | |
1709 | ||
1710 | if test $# -ne 1 || test -z "$var" | |
1711 | then | |
1712 | BUG "test_set_port requires a variable name" | |
1713 | fi | |
1714 | ||
1715 | eval port=\$$var | |
1716 | case "$port" in | |
1717 | "") | |
1718 | # No port is set in the given env var, use the test | |
1719 | # number as port number instead. | |
1720 | # Remove not only the leading 't', but all leading zeros | |
1721 | # as well, so the arithmetic below won't (mis)interpret | |
1722 | # a test number like '0123' as an octal value. | |
1723 | port=${this_test#${this_test%%[1-9]*}} | |
1724 | if test "${port:-0}" -lt 1024 | |
1725 | then | |
1726 | # root-only port, use a larger one instead. | |
1727 | port=$(($port + 10000)) | |
1728 | fi | |
fa840581 | 1729 | ;; |
7d661e5e | 1730 | *[!0-9]*|0*) |
fa840581 SG |
1731 | error >&7 "invalid port number: $port" |
1732 | ;; | |
1733 | *) | |
1734 | # The user has specified the port. | |
1735 | ;; | |
1736 | esac | |
fb7d1e3a SG |
1737 | |
1738 | # Make sure that parallel '--stress' test jobs get different | |
1739 | # ports. | |
1740 | port=$(($port + ${GIT_TEST_STRESS_JOB_NR:-0})) | |
1741 | eval $var=$port | |
fa840581 | 1742 | } |
ea047a8e | 1743 | |
176a66a7 JS |
1744 | # Tests for the hidden file attribute on Windows |
1745 | test_path_is_hidden () { | |
1746 | test_have_prereq MINGW || | |
1747 | BUG "test_path_is_hidden can only be used on Windows" | |
1748 | ||
7c2dfca7 | 1749 | # Use the output of `attrib`, ignore the absolute path |
9814d0a4 | 1750 | case "$("$SYSTEMROOT"/system32/attrib "$1")" in *H*?:*) return 0;; esac |
7c2dfca7 JS |
1751 | return 1 |
1752 | } | |
2057d750 DS |
1753 | |
1754 | # Check that the given command was invoked as part of the | |
1755 | # trace2-format trace on stdin. | |
1756 | # | |
1757 | # test_subcommand [!] <command> <args>... < <trace> | |
1758 | # | |
1759 | # For example, to look for an invocation of "git upload-pack | |
1760 | # /path/to/repo" | |
1761 | # | |
1762 | # GIT_TRACE2_EVENT=event.log git fetch ... && | |
1763 | # test_subcommand git upload-pack "$PATH" <event.log | |
1764 | # | |
1765 | # If the first parameter passed is !, this instead checks that | |
1766 | # the given command was not called. | |
1767 | # | |
1768 | test_subcommand () { | |
1769 | local negate= | |
1770 | if test "$1" = "!" | |
1771 | then | |
1772 | negate=t | |
1773 | shift | |
1774 | fi | |
1775 | ||
1776 | local expr=$(printf '"%s",' "$@") | |
1777 | expr="${expr%,}" | |
1778 | ||
1779 | if test -n "$negate" | |
1780 | then | |
1781 | ! grep "\[$expr\]" | |
1782 | else | |
1783 | grep "\[$expr\]" | |
1784 | fi | |
1785 | } | |
3b144363 DS |
1786 | |
1787 | # Check that the given command was invoked as part of the | |
1788 | # trace2-format trace on stdin. | |
1789 | # | |
1790 | # test_region [!] <category> <label> git <command> <args>... | |
1791 | # | |
1792 | # For example, to look for trace2_region_enter("index", "do_read_index", repo) | |
1793 | # in an invocation of "git checkout HEAD~1", run | |
1794 | # | |
1795 | # GIT_TRACE2_EVENT="$(pwd)/trace.txt" GIT_TRACE2_EVENT_NESTING=10 \ | |
1796 | # git checkout HEAD~1 && | |
1797 | # test_region index do_read_index <trace.txt | |
1798 | # | |
1799 | # If the first parameter passed is !, this instead checks that | |
1800 | # the given region was not entered. | |
1801 | # | |
1802 | test_region () { | |
1803 | local expect_exit=0 | |
1804 | if test "$1" = "!" | |
1805 | then | |
1806 | expect_exit=1 | |
1807 | shift | |
1808 | fi | |
1809 | ||
1810 | grep -e '"region_enter".*"category":"'"$1"'","label":"'"$2"\" "$3" | |
1811 | exitcode=$? | |
1812 | ||
1813 | if test $exitcode != $expect_exit | |
1814 | then | |
1815 | return 1 | |
1816 | fi | |
1817 | ||
1818 | grep -e '"region_leave".*"category":"'"$1"'","label":"'"$2"\" "$3" | |
1819 | exitcode=$? | |
1820 | ||
1821 | if test $exitcode != $expect_exit | |
1822 | then | |
1823 | return 1 | |
1824 | fi | |
1825 | ||
1826 | return 0 | |
1827 | } | |
7c0afdf2 JK |
1828 | |
1829 | # Print the destination of symlink(s) provided as arguments. Basically | |
1830 | # the same as the readlink command, but it's not available everywhere. | |
1831 | test_readlink () { | |
1832 | perl -le 'print readlink($_) for @ARGV' "$@" | |
1833 | } | |
ab6245bd MS |
1834 | |
1835 | # Set mtime to a fixed "magic" timestamp in mid February 2009, before we | |
1836 | # run an operation that may or may not touch the file. If the file was | |
1837 | # touched, its timestamp will not accidentally have such an old timestamp, | |
1838 | # as long as your filesystem clock is reasonably correct. To verify the | |
1839 | # timestamp, follow up with test_is_magic_mtime. | |
1840 | # | |
1841 | # An optional increment to the magic timestamp may be specified as second | |
1842 | # argument. | |
1843 | test_set_magic_mtime () { | |
1844 | local inc=${2:-0} && | |
1845 | local mtime=$((1234567890 + $inc)) && | |
1846 | test-tool chmtime =$mtime "$1" && | |
1847 | test_is_magic_mtime "$1" $inc | |
1848 | } | |
1849 | ||
1850 | # Test whether the given file has the "magic" mtime set. This is meant to | |
1851 | # be used in combination with test_set_magic_mtime. | |
1852 | # | |
1853 | # An optional increment to the magic timestamp may be specified as second | |
1854 | # argument. Usually, this should be the same increment which was used for | |
1855 | # the associated test_set_magic_mtime. | |
1856 | test_is_magic_mtime () { | |
1857 | local inc=${2:-0} && | |
1858 | local mtime=$((1234567890 + $inc)) && | |
1859 | echo $mtime >.git/test-mtime-expect && | |
1860 | test-tool chmtime --get "$1" >.git/test-mtime-actual && | |
1861 | test_cmp .git/test-mtime-expect .git/test-mtime-actual | |
1862 | local ret=$? | |
1863 | rm -f .git/test-mtime-expect | |
1864 | rm -f .git/test-mtime-actual | |
1865 | return $ret | |
1866 | } | |
d796cedb ÆAB |
1867 | |
1868 | # Given two filenames, parse both using 'git config --list --file' | |
1869 | # and compare the sorted output of those commands. Useful when | |
1870 | # wanting to ignore whitespace differences and sorting concerns. | |
1871 | test_cmp_config_output () { | |
1872 | git config --list --file="$1" >config-expect && | |
1873 | git config --list --file="$2" >config-actual && | |
1874 | sort config-expect >sorted-expect && | |
1875 | sort config-actual >sorted-actual && | |
1876 | test_cmp sorted-expect sorted-actual | |
1877 | } |