1# Library of functions shared by all tests scripts, included by 2# test-lib.sh. 3# 4# Copyright (c) 2005 Junio C Hamano 5# 6# This program is free software: you can redistribute it and/or modify 7# it under the terms of the GNU General Public License as published by 8# the Free Software Foundation, either version 2 of the License, or 9# (at your option) any later version. 10# 11# This program is distributed in the hope that it will be useful, 12# but WITHOUT ANY WARRANTY; without even the implied warranty of 13# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14# GNU General Public License for more details. 15# 16# You should have received a copy of the GNU General Public License 17# along with this program. If not, see http://www.gnu.org/licenses/ . 18 19# The semantics of the editor variables are that of invoking 20# sh -c "$EDITOR \"$@\"" files ... 21# 22# If our trash directory contains shell metacharacters, they will be 23# interpreted if we just set $EDITOR directly, so do a little dance with 24# environment variables to work around this. 25# 26# In particular, quoting isn't enough, as the path may contain the same quote 27# that we're using. 28test_set_editor () { 29 FAKE_EDITOR="$1" 30 export FAKE_EDITOR 31 EDITOR='"$FAKE_EDITOR"' 32 export EDITOR 33} 34 35test_set_index_version () { 36 GIT_INDEX_VERSION="$1" 37 export GIT_INDEX_VERSION 38} 39 40test_decode_color () { 41 awk ' 42 function name(n) { 43 if (n == 0) return "RESET"; 44 if (n == 1) return "BOLD"; 45 if (n == 2) return "FAINT"; 46 if (n == 3) return "ITALIC"; 47 if (n == 7) return "REVERSE"; 48 if (n == 30) return "BLACK"; 49 if (n == 31) return "RED"; 50 if (n == 32) return "GREEN"; 51 if (n == 33) return "YELLOW"; 52 if (n == 34) return "BLUE"; 53 if (n == 35) return "MAGENTA"; 54 if (n == 36) return "CYAN"; 55 if (n == 37) return "WHITE"; 56 if (n == 40) return "BLACK"; 57 if (n == 41) return "BRED"; 58 if (n == 42) return "BGREEN"; 59 if (n == 43) return "BYELLOW"; 60 if (n == 44) return "BBLUE"; 61 if (n == 45) return "BMAGENTA"; 62 if (n == 46) return "BCYAN"; 63 if (n == 47) return "BWHITE"; 64 } 65 { 66 while (match($0, /\033\[[0-9;]*m/) != 0) { 67 printf "%s<", substr($0, 1, RSTART-1); 68 codes = substr($0, RSTART+2, RLENGTH-3); 69 if (length(codes) == 0) 70 printf "%s", name(0) 71 else { 72 n = split(codes, ary, ";"); 73 sep = ""; 74 for (i = 1; i <= n; i++) { 75 printf "%s%s", sep, name(ary[i]); 76 sep = ";" 77 } 78 } 79 printf ">"; 80 $0 = substr($0, RSTART + RLENGTH, length($0) - RSTART - RLENGTH + 1); 81 } 82 print 83 } 84 ' 85} 86 87lf_to_nul () { 88 perl -pe 'y/\012/\000/' 89} 90 91nul_to_q () { 92 perl -pe 'y/\000/Q/' 93} 94 95q_to_nul () { 96 perl -pe 'y/Q/\000/' 97} 98 99q_to_cr () { 100 tr Q '\015' 101} 102 103q_to_tab () { 104 tr Q '\011' 105} 106 107qz_to_tab_space () { 108 tr QZ '\011\040' 109} 110 111append_cr () { 112 sed -e 's/$/Q/' | tr Q '\015' 113} 114 115remove_cr () { 116 tr '\015' Q | sed -e 's/Q$//' 117} 118 119# Generate an output of $1 bytes of all zeroes (NULs, not ASCII zeroes). 120# If $1 is 'infinity', output forever or until the receiving pipe stops reading, 121# whichever comes first. 122generate_zero_bytes () { 123 test-tool genzeros "$@" 124} 125 126# In some bourne shell implementations, the "unset" builtin returns 127# nonzero status when a variable to be unset was not set in the first 128# place. 129# 130# Use sane_unset when that should not be considered an error. 131 132sane_unset () { 133 unset "$@" 134 return 0 135} 136 137test_tick () { 138 if test -z "${test_tick+set}" 139 then 140 test_tick=1112911993 141 else 142 test_tick=$(($test_tick + 60)) 143 fi 144 GIT_COMMITTER_DATE="$test_tick -0700" 145 GIT_AUTHOR_DATE="$test_tick -0700" 146 export GIT_COMMITTER_DATE GIT_AUTHOR_DATE 147} 148 149# Stop execution and start a shell. This is useful for debugging tests. 150# 151# Be sure to remove all invocations of this command before submitting. 152 153test_pause () { 154 "$SHELL_PATH" <&6 >&5 2>&7 155} 156 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. 159# 160# Examples: 161# debug git checkout master 162# debug --debugger=nemiver git $ARGS 163# debug -d "valgrind --tool=memcheck --track-origins=yes" git $ARGS 164debug () { 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 179} 180 181# Call test_commit with the arguments 182# [-C <directory>] <message> [<file> [<contents> [<tag>]]]" 183# 184# This will commit a file with the given contents and the given commit 185# message, and tag the resulting commit with the given tag name. 186# 187# <file>, <contents>, and <tag> all default to <message>. 188# 189# If the first argument is "-C", the second argument is used as a path for 190# the git invocations. 191 192test_commit () { 193 notick= && 194 signoff= && 195 indir= && 196 while test $# != 0 197 do 198 case "$1" in 199 --notick) 200 notick=yes 201 ;; 202 --signoff) 203 signoff="$1" 204 ;; 205 -C) 206 indir="$2" 207 shift 208 ;; 209 *) 210 break 211 ;; 212 esac 213 shift 214 done && 215 indir=${indir:+"$indir"/} && 216 file=${2:-"$1.t"} && 217 echo "${3-$1}" > "$indir$file" && 218 git ${indir:+ -C "$indir"} add "$file" && 219 if test -z "$notick" 220 then 221 test_tick 222 fi && 223 git ${indir:+ -C "$indir"} commit $signoff -m "$1" && 224 git ${indir:+ -C "$indir"} tag "${4:-$1}" 225} 226 227# Call test_merge with the arguments "<message> <commit>", where <commit> 228# can be a tag pointing to the commit-to-merge. 229 230test_merge () { 231 test_tick && 232 git merge -m "$1" "$2" && 233 git tag "$1" 234} 235 236# This function helps systems where core.filemode=false is set. 237# Use it instead of plain 'chmod +x' to set or unset the executable bit 238# of a file in the working directory and add it to the index. 239 240test_chmod () { 241 chmod "$@" && 242 git update-index --add "--chmod=$@" 243} 244 245# Get the modebits from a file. 246test_modebits () { 247 ls -l "$1" | sed -e 's|^\(..........\).*|\1|' 248} 249 250# Unset a configuration variable, but don't fail if it doesn't exist. 251test_unconfig () { 252 config_dir= 253 if test "$1" = -C 254 then 255 shift 256 config_dir=$1 257 shift 258 fi 259 git ${config_dir:+-C "$config_dir"} config --unset-all "$@" 260 config_status=$? 261 case "$config_status" in 262 5) # ok, nothing to unset 263 config_status=0 264 ;; 265 esac 266 return $config_status 267} 268 269# Set git config, automatically unsetting it after the test is over. 270test_config () { 271 config_dir= 272 if test "$1" = -C 273 then 274 shift 275 config_dir=$1 276 shift 277 fi 278 test_when_finished "test_unconfig ${config_dir:+-C '$config_dir'} '$1'" && 279 git ${config_dir:+-C "$config_dir"} config "$@" 280} 281 282test_config_global () { 283 test_when_finished "test_unconfig --global '$1'" && 284 git config --global "$@" 285} 286 287write_script () { 288 { 289 echo "#!${2-"$SHELL_PATH"}" && 290 cat 291 } >"$1" && 292 chmod +x "$1" 293} 294 295# Use test_set_prereq to tell that a particular prerequisite is available. 296# The prerequisite can later be checked for in two ways: 297# 298# - Explicitly using test_have_prereq. 299# 300# - Implicitly by specifying the prerequisite tag in the calls to 301# test_expect_{success,failure,code}. 302# 303# The single parameter is the prerequisite tag (a simple word, in all 304# capital letters by convention). 305 306test_unset_prereq () { 307 ! test_have_prereq "$1" || 308 satisfied_prereq="${satisfied_prereq% $1 *} ${satisfied_prereq#* $1 }" 309} 310 311test_set_prereq () { 312 case "$1" in 313 !*) 314 test_unset_prereq "${1#!}" 315 ;; 316 *) 317 satisfied_prereq="$satisfied_prereq$1 " 318 ;; 319 esac 320} 321satisfied_prereq=" " 322lazily_testable_prereq= lazily_tested_prereq= 323 324# Usage: test_lazy_prereq PREREQ 'script' 325test_lazy_prereq () { 326 lazily_testable_prereq="$lazily_testable_prereq$1 " 327 eval test_prereq_lazily_$1=\$2 328} 329 330test_run_lazy_prereq_ () { 331 script=' 332mkdir -p "$TRASH_DIRECTORY/prereq-test-dir" && 333( 334 cd "$TRASH_DIRECTORY/prereq-test-dir" &&'"$2"' 335)' 336 say >&3 "checking prerequisite: $1" 337 say >&3 "$script" 338 test_eval_ "$script" 339 eval_ret=$? 340 rm -rf "$TRASH_DIRECTORY/prereq-test-dir" 341 if test "$eval_ret" = 0; then 342 say >&3 "prerequisite $1 ok" 343 else 344 say >&3 "prerequisite $1 not satisfied" 345 fi 346 return $eval_ret 347} 348 349test_have_prereq () { 350 # prerequisites can be concatenated with ',' 351 save_IFS=$IFS 352 IFS=, 353 set -- $* 354 IFS=$save_IFS 355 356 total_prereq=0 357 ok_prereq=0 358 missing_prereq= 359 360 for prerequisite 361 do 362 case "$prerequisite" in 363 !*) 364 negative_prereq=t 365 prerequisite=${prerequisite#!} 366 ;; 367 *) 368 negative_prereq= 369 esac 370 371 case " $lazily_tested_prereq " in 372 *" $prerequisite "*) 373 ;; 374 *) 375 case " $lazily_testable_prereq " in 376 *" $prerequisite "*) 377 eval "script=\$test_prereq_lazily_$prerequisite" && 378 if test_run_lazy_prereq_ "$prerequisite" "$script" 379 then 380 test_set_prereq $prerequisite 381 fi 382 lazily_tested_prereq="$lazily_tested_prereq$prerequisite " 383 esac 384 ;; 385 esac 386 387 total_prereq=$(($total_prereq + 1)) 388 case "$satisfied_prereq" in 389 *" $prerequisite "*) 390 satisfied_this_prereq=t 391 ;; 392 *) 393 satisfied_this_prereq= 394 esac 395 396 case "$satisfied_this_prereq,$negative_prereq" in 397 t,|,t) 398 ok_prereq=$(($ok_prereq + 1)) 399 ;; 400 *) 401 # Keep a list of missing prerequisites; restore 402 # the negative marker if necessary. 403 prerequisite=${negative_prereq:+!}$prerequisite 404 if test -z "$missing_prereq" 405 then 406 missing_prereq=$prerequisite 407 else 408 missing_prereq="$prerequisite,$missing_prereq" 409 fi 410 esac 411 done 412 413 test $total_prereq = $ok_prereq 414} 415 416test_declared_prereq () { 417 case ",$test_prereq," in 418 *,$1,*) 419 return 0 420 ;; 421 esac 422 return 1 423} 424 425test_verify_prereq () { 426 test -z "$test_prereq" || 427 expr >/dev/null "$test_prereq" : '[A-Z0-9_,!]*$' || 428 BUG "'$test_prereq' does not look like a prereq" 429} 430 431test_expect_failure () { 432 test_start_ 433 test "$#" = 3 && { test_prereq=$1; shift; } || test_prereq= 434 test "$#" = 2 || 435 BUG "not 2 or 3 parameters to test-expect-failure" 436 test_verify_prereq 437 export test_prereq 438 if ! test_skip "$@" 439 then 440 say >&3 "checking known breakage: $2" 441 if test_run_ "$2" expecting_failure 442 then 443 test_known_broken_ok_ "$1" 444 else 445 test_known_broken_failure_ "$1" 446 fi 447 fi 448 test_finish_ 449} 450 451test_expect_success () { 452 test_start_ 453 test "$#" = 3 && { test_prereq=$1; shift; } || test_prereq= 454 test "$#" = 2 || 455 BUG "not 2 or 3 parameters to test-expect-success" 456 test_verify_prereq 457 export test_prereq 458 if ! test_skip "$@" 459 then 460 say >&3 "expecting success: $2" 461 if test_run_ "$2" 462 then 463 test_ok_ "$1" 464 else 465 test_failure_ "$@" 466 fi 467 fi 468 test_finish_ 469} 470 471# test_external runs external test scripts that provide continuous 472# test output about their progress, and succeeds/fails on 473# zero/non-zero exit code. It outputs the test output on stdout even 474# in non-verbose mode, and announces the external script with "# run 475# <n>: ..." before running it. When providing relative paths, keep in 476# mind that all scripts run in "trash directory". 477# Usage: test_external description command arguments... 478# Example: test_external 'Perl API' perl ../path/to/test.pl 479test_external () { 480 test "$#" = 4 && { test_prereq=$1; shift; } || test_prereq= 481 test "$#" = 3 || 482 BUG "not 3 or 4 parameters to test_external" 483 descr="$1" 484 shift 485 test_verify_prereq 486 export test_prereq 487 if ! test_skip "$descr" "$@" 488 then 489 # Announce the script to reduce confusion about the 490 # test output that follows. 491 say_color "" "# run $test_count: $descr ($*)" 492 # Export TEST_DIRECTORY, TRASH_DIRECTORY and GIT_TEST_LONG 493 # to be able to use them in script 494 export TEST_DIRECTORY TRASH_DIRECTORY GIT_TEST_LONG 495 # Run command; redirect its stderr to &4 as in 496 # test_run_, but keep its stdout on our stdout even in 497 # non-verbose mode. 498 "$@" 2>&4 499 if test "$?" = 0 500 then 501 if test $test_external_has_tap -eq 0; then 502 test_ok_ "$descr" 503 else 504 say_color "" "# test_external test $descr was ok" 505 test_success=$(($test_success + 1)) 506 fi 507 else 508 if test $test_external_has_tap -eq 0; then 509 test_failure_ "$descr" "$@" 510 else 511 say_color error "# test_external test $descr failed: $@" 512 test_failure=$(($test_failure + 1)) 513 fi 514 fi 515 fi 516} 517 518# Like test_external, but in addition tests that the command generated 519# no output on stderr. 520test_external_without_stderr () { 521 # The temporary file has no (and must have no) security 522 # implications. 523 tmp=${TMPDIR:-/tmp} 524 stderr="$tmp/git-external-stderr.$$.tmp" 525 test_external "$@" 4> "$stderr" 526 test -f "$stderr" || error "Internal error: $stderr disappeared." 527 descr="no stderr: $1" 528 shift 529 say >&3 "# expecting no stderr from previous command" 530 if test ! -s "$stderr" 531 then 532 rm "$stderr" 533 534 if test $test_external_has_tap -eq 0; then 535 test_ok_ "$descr" 536 else 537 say_color "" "# test_external_without_stderr test $descr was ok" 538 test_success=$(($test_success + 1)) 539 fi 540 else 541 if test "$verbose" = t 542 then 543 output=$(echo; echo "# Stderr is:"; cat "$stderr") 544 else 545 output= 546 fi 547 # rm first in case test_failure exits. 548 rm "$stderr" 549 if test $test_external_has_tap -eq 0; then 550 test_failure_ "$descr" "$@" "$output" 551 else 552 say_color error "# test_external_without_stderr test $descr failed: $@: $output" 553 test_failure=$(($test_failure + 1)) 554 fi 555 fi 556} 557 558# debugging-friendly alternatives to "test [-f|-d|-e]" 559# The commands test the existence or non-existence of $1. $2 can be 560# given to provide a more precise diagnosis. 561test_path_is_file () { 562 if ! test -f "$1" 563 then 564 echo "File $1 doesn't exist. $2" 565 false 566 fi 567} 568 569test_path_is_dir () { 570 if ! test -d "$1" 571 then 572 echo "Directory $1 doesn't exist. $2" 573 false 574 fi 575} 576 577test_path_exists () { 578 if ! test -e "$1" 579 then 580 echo "Path $1 doesn't exist. $2" 581 false 582 fi 583} 584 585# Check if the directory exists and is empty as expected, barf otherwise. 586test_dir_is_empty () { 587 test_path_is_dir "$1" && 588 if test -n "$(ls -a1 "$1" | egrep -v '^\.\.?$')" 589 then 590 echo "Directory '$1' is not empty, it contains:" 591 ls -la "$1" 592 return 1 593 fi 594} 595 596test_path_is_missing () { 597 if test -e "$1" 598 then 599 echo "Path exists:" 600 ls -ld "$1" 601 if test $# -ge 1 602 then 603 echo "$*" 604 fi 605 false 606 fi 607} 608 609# test_line_count checks that a file has the number of lines it 610# ought to. For example: 611# 612# test_expect_success 'produce exactly one line of output' ' 613# do something >output && 614# test_line_count = 1 output 615# ' 616# 617# is like "test $(wc -l <output) = 1" except that it passes the 618# output through when the number of lines is wrong. 619 620test_line_count () { 621 if test $# != 3 622 then 623 BUG "not 3 parameters to test_line_count" 624 elif ! test $(wc -l <"$3") "$1" "$2" 625 then 626 echo "test_line_count: line count for $3 !$1 $2" 627 cat "$3" 628 return 1 629 fi 630} 631 632# Returns success if a comma separated string of keywords ($1) contains a 633# given keyword ($2). 634# Examples: 635# `list_contains "foo,bar" bar` returns 0 636# `list_contains "foo" bar` returns 1 637 638list_contains () { 639 case ",$1," in 640 *,$2,*) 641 return 0 642 ;; 643 esac 644 return 1 645} 646 647# This is not among top-level (test_expect_success | test_expect_failure) 648# but is a prefix that can be used in the test script, like: 649# 650# test_expect_success 'complain and die' ' 651# do something && 652# do something else && 653# test_must_fail git checkout ../outerspace 654# ' 655# 656# Writing this as "! git checkout ../outerspace" is wrong, because 657# the failure could be due to a segv. We want a controlled failure. 658# 659# Accepts the following options: 660# 661# ok=<signal-name>[,<...>]: 662# Don't treat an exit caused by the given signal as error. 663# Multiple signals can be specified as a comma separated list. 664# Currently recognized signal names are: sigpipe, success. 665# (Don't use 'success', use 'test_might_fail' instead.) 666 667test_must_fail () { 668 case "$1" in 669 ok=*) 670 _test_ok=${1#ok=} 671 shift 672 ;; 673 *) 674 _test_ok= 675 ;; 676 esac 677 "$@" 2>&7 678 exit_code=$? 679 if test $exit_code -eq 0 && ! list_contains "$_test_ok" success 680 then 681 echo >&4 "test_must_fail: command succeeded: $*" 682 return 1 683 elif test_match_signal 13 $exit_code && list_contains "$_test_ok" sigpipe 684 then 685 return 0 686 elif test $exit_code -gt 129 && test $exit_code -le 192 687 then 688 echo >&4 "test_must_fail: died by signal $(($exit_code - 128)): $*" 689 return 1 690 elif test $exit_code -eq 127 691 then 692 echo >&4 "test_must_fail: command not found: $*" 693 return 1 694 elif test $exit_code -eq 126 695 then 696 echo >&4 "test_must_fail: valgrind error: $*" 697 return 1 698 fi 699 return 0 700} 7>&2 2>&4 701 702# Similar to test_must_fail, but tolerates success, too. This is 703# meant to be used in contexts like: 704# 705# test_expect_success 'some command works without configuration' ' 706# test_might_fail git config --unset all.configuration && 707# do something 708# ' 709# 710# Writing "git config --unset all.configuration || :" would be wrong, 711# because we want to notice if it fails due to segv. 712# 713# Accepts the same options as test_must_fail. 714 715test_might_fail () { 716 test_must_fail ok=success "$@" 2>&7 717} 7>&2 2>&4 718 719# Similar to test_must_fail and test_might_fail, but check that a 720# given command exited with a given exit code. Meant to be used as: 721# 722# test_expect_success 'Merge with d/f conflicts' ' 723# test_expect_code 1 git merge "merge msg" B master 724# ' 725 726test_expect_code () { 727 want_code=$1 728 shift 729 "$@" 2>&7 730 exit_code=$? 731 if test $exit_code = $want_code 732 then 733 return 0 734 fi 735 736 echo >&4 "test_expect_code: command exited with $exit_code, we wanted $want_code $*" 737 return 1 738} 7>&2 2>&4 739 740# test_cmp is a helper function to compare actual and expected output. 741# You can use it like: 742# 743# test_expect_success 'foo works' ' 744# echo expected >expected && 745# foo >actual && 746# test_cmp expected actual 747# ' 748# 749# This could be written as either "cmp" or "diff -u", but: 750# - cmp's output is not nearly as easy to read as diff -u 751# - not all diff versions understand "-u" 752 753test_cmp() { 754 $GIT_TEST_CMP "$@" 755} 756 757# Check that the given config key has the expected value. 758# 759# test_cmp_config [-C <dir>] <expected-value> 760# [<git-config-options>...] <config-key> 761# 762# for example to check that the value of core.bar is foo 763# 764# test_cmp_config foo core.bar 765# 766test_cmp_config() { 767 local GD && 768 if test "$1" = "-C" 769 then 770 shift && 771 GD="-C $1" && 772 shift 773 fi && 774 printf "%s\n" "$1" >expect.config && 775 shift && 776 git $GD config "$@" >actual.config && 777 test_cmp expect.config actual.config 778} 779 780# test_cmp_bin - helper to compare binary files 781 782test_cmp_bin() { 783 cmp "$@" 784} 785 786# Use this instead of test_cmp to compare files that contain expected and 787# actual output from git commands that can be translated. When running 788# under GIT_TEST_GETTEXT_POISON this pretends that the command produced expected 789# results. 790test_i18ncmp () { 791 ! test_have_prereq C_LOCALE_OUTPUT || test_cmp "$@" 792} 793 794# Use this instead of "grep expected-string actual" to see if the 795# output from a git command that can be translated either contains an 796# expected string, or does not contain an unwanted one. When running 797# under GIT_TEST_GETTEXT_POISON this pretends that the command produced expected 798# results. 799test_i18ngrep () { 800 eval "last_arg=\${$#}" 801 802 test -f "$last_arg" || 803 BUG "test_i18ngrep requires a file to read as the last parameter" 804 805 if test $# -lt 2 || 806 { test "x!" = "x$1" && test $# -lt 3 ; } 807 then 808 BUG "too few parameters to test_i18ngrep" 809 fi 810 811 if test_have_prereq !C_LOCALE_OUTPUT 812 then 813 # pretend success 814 return 0 815 fi 816 817 if test "x!" = "x$1" 818 then 819 shift 820 ! grep "$@" && return 0 821 822 echo >&4 "error: '! grep $@' did find a match in:" 823 else 824 grep "$@" && return 0 825 826 echo >&4 "error: 'grep $@' didn't find a match in:" 827 fi 828 829 if test -s "$last_arg" 830 then 831 cat >&4 "$last_arg" 832 else 833 echo >&4 "<File '$last_arg' is empty>" 834 fi 835 836 return 1 837} 838 839# Call any command "$@" but be more verbose about its 840# failure. This is handy for commands like "test" which do 841# not output anything when they fail. 842verbose () { 843 "$@" && return 0 844 echo >&4 "command failed: $(git rev-parse --sq-quote "$@")" 845 return 1 846} 847 848# Check if the file expected to be empty is indeed empty, and barfs 849# otherwise. 850 851test_must_be_empty () { 852 test_path_is_file "$1" && 853 if test -s "$1" 854 then 855 echo "'$1' is not empty, it contains:" 856 cat "$1" 857 return 1 858 fi 859} 860 861# Tests that its two parameters refer to the same revision 862test_cmp_rev () { 863 if test $# != 2 864 then 865 error "bug in the test script: test_cmp_rev requires two revisions, but got $#" 866 else 867 local r1 r2 868 r1=$(git rev-parse --verify "$1") && 869 r2=$(git rev-parse --verify "$2") && 870 if test "$r1" != "$r2" 871 then 872 cat >&4 <<-EOF 873 error: two revisions point to different objects: 874 '$1': $r1 875 '$2': $r2 876 EOF 877 return 1 878 fi 879 fi 880} 881 882# Print a sequence of integers in increasing order, either with 883# two arguments (start and end): 884# 885# test_seq 1 5 -- outputs 1 2 3 4 5 one line at a time 886# 887# or with one argument (end), in which case it starts counting 888# from 1. 889 890test_seq () { 891 case $# in 892 1) set 1 "$@" ;; 893 2) ;; 894 *) BUG "not 1 or 2 parameters to test_seq" ;; 895 esac 896 test_seq_counter__=$1 897 while test "$test_seq_counter__" -le "$2" 898 do 899 echo "$test_seq_counter__" 900 test_seq_counter__=$(( $test_seq_counter__ + 1 )) 901 done 902} 903 904# This function can be used to schedule some commands to be run 905# unconditionally at the end of the test to restore sanity: 906# 907# test_expect_success 'test core.capslock' ' 908# git config core.capslock true && 909# test_when_finished "git config --unset core.capslock" && 910# hello world 911# ' 912# 913# That would be roughly equivalent to 914# 915# test_expect_success 'test core.capslock' ' 916# git config core.capslock true && 917# hello world 918# git config --unset core.capslock 919# ' 920# 921# except that the greeting and config --unset must both succeed for 922# the test to pass. 923# 924# Note that under --immediate mode, no clean-up is done to help diagnose 925# what went wrong. 926 927test_when_finished () { 928 # We cannot detect when we are in a subshell in general, but by 929 # doing so on Bash is better than nothing (the test will 930 # silently pass on other shells). 931 test "${BASH_SUBSHELL-0}" = 0 || 932 BUG "test_when_finished does nothing in a subshell" 933 test_cleanup="{ $* 934 } && (exit \"\$eval_ret\"); eval_ret=\$?; $test_cleanup" 935} 936 937# Most tests can use the created repository, but some may need to create more. 938# Usage: test_create_repo <directory> 939test_create_repo () { 940 test "$#" = 1 || 941 BUG "not 1 parameter to test-create-repo" 942 repo="$1" 943 mkdir -p "$repo" 944 ( 945 cd "$repo" || error "Cannot setup test environment" 946 "${GIT_TEST_INSTALLED:-$GIT_EXEC_PATH}/git$X" init \ 947 "--template=$GIT_BUILD_DIR/templates/blt/" >&3 2>&4 || 948 error "cannot run git init -- have you built things yet?" 949 mv .git/hooks .git/hooks-disabled 950 ) || exit 951} 952 953# This function helps on symlink challenged file systems when it is not 954# important that the file system entry is a symbolic link. 955# Use test_ln_s_add instead of "ln -s x y && git add y" to add a 956# symbolic link entry y to the index. 957 958test_ln_s_add () { 959 if test_have_prereq SYMLINKS 960 then 961 ln -s "$1" "$2" && 962 git update-index --add "$2" 963 else 964 printf '%s' "$1" >"$2" && 965 ln_s_obj=$(git hash-object -w "$2") && 966 git update-index --add --cacheinfo 120000 $ln_s_obj "$2" && 967 # pick up stat info from the file 968 git update-index "$2" 969 fi 970} 971 972# This function writes out its parameters, one per line 973test_write_lines () { 974 printf "%s\n" "$@" 975} 976 977perl () { 978 command "$PERL_PATH" "$@" 2>&7 979} 7>&2 2>&4 980 981# Is the value one of the various ways to spell a boolean true/false? 982test_normalize_bool () { 983 git -c magic.variable="$1" config --bool magic.variable 2>/dev/null 984} 985 986# Given a variable $1, normalize the value of it to one of "true", 987# "false", or "auto" and store the result to it. 988# 989# test_tristate GIT_TEST_HTTPD 990# 991# A variable set to an empty string is set to 'false'. 992# A variable set to 'false' or 'auto' keeps its value. 993# Anything else is set to 'true'. 994# An unset variable defaults to 'auto'. 995# 996# The last rule is to allow people to set the variable to an empty 997# string and export it to decline testing the particular feature 998# for versions both before and after this change. We used to treat 999# both unset and empty variable as a signal for "do not test" and1000# took any non-empty string as "please test".10011002test_tristate () {1003 if eval "test x\"\${$1+isset}\" = xisset"1004 then1005 # explicitly set1006 eval "1007 case \"\$$1\" in1008 '') $1=false ;;1009 auto) ;;1010 *) $1=\$(test_normalize_bool \$$1 || echo true) ;;1011 esac1012 "1013 else1014 eval "$1=auto"1015 fi1016}10171018# Exit the test suite, either by skipping all remaining tests or by1019# exiting with an error. If "$1" is "auto", we then we assume we were1020# opportunistically trying to set up some tests and we skip. If it is1021# "true", then we report a failure.1022#1023# The error/skip message should be given by $2.1024#1025test_skip_or_die () {1026 case "$1" in1027 auto)1028 skip_all=$21029 test_done1030 ;;1031 true)1032 error "$2"1033 ;;1034 *)1035 error "BUG: test tristate is '$1' (real error: $2)"1036 esac1037}10381039# The following mingw_* functions obey POSIX shell syntax, but are actually1040# bash scripts, and are meant to be used only with bash on Windows.10411042# A test_cmp function that treats LF and CRLF equal and avoids to fork1043# diff when possible.1044mingw_test_cmp () {1045 # Read text into shell variables and compare them. If the results1046 # are different, use regular diff to report the difference.1047 local test_cmp_a= test_cmp_b=10481049 # When text came from stdin (one argument is '-') we must feed it1050 # to diff.1051 local stdin_for_diff=10521053 # Since it is difficult to detect the difference between an1054 # empty input file and a failure to read the files, we go straight1055 # to diff if one of the inputs is empty.1056 if test -s "$1" && test -s "$2"1057 then1058 # regular case: both files non-empty1059 mingw_read_file_strip_cr_ test_cmp_a <"$1"1060 mingw_read_file_strip_cr_ test_cmp_b <"$2"1061 elif test -s "$1" && test "$2" = -1062 then1063 # read 2nd file from stdin1064 mingw_read_file_strip_cr_ test_cmp_a <"$1"1065 mingw_read_file_strip_cr_ test_cmp_b1066 stdin_for_diff='<<<"$test_cmp_b"'1067 elif test "$1" = - && test -s "$2"1068 then1069 # read 1st file from stdin1070 mingw_read_file_strip_cr_ test_cmp_a1071 mingw_read_file_strip_cr_ test_cmp_b <"$2"1072 stdin_for_diff='<<<"$test_cmp_a"'1073 fi1074 test -n "$test_cmp_a" &&1075 test -n "$test_cmp_b" &&1076 test "$test_cmp_a" = "$test_cmp_b" ||1077 eval "diff -u \"\$@\" $stdin_for_diff"1078}10791080# $1 is the name of the shell variable to fill in1081mingw_read_file_strip_cr_ () {1082 # Read line-wise using LF as the line separator1083 # and use IFS to strip CR.1084 local line1085 while :1086 do1087 if IFS=$'\r' read -r -d $'\n' line1088 then1089 # good1090 line=$line$'\n'1091 else1092 # we get here at EOF, but also if the last line1093 # was not terminated by LF; in the latter case,1094 # some text was read1095 if test -z "$line"1096 then1097 # EOF, really1098 break1099 fi1100 fi1101 eval "$1=\$$1\$line"1102 done1103}11041105# Like "env FOO=BAR some-program", but run inside a subshell, which means1106# it also works for shell functions (though those functions cannot impact1107# the environment outside of the test_env invocation).1108test_env () {1109 (1110 while test $# -gt 01111 do1112 case "$1" in1113 *=*)1114 eval "${1%%=*}=\${1#*=}"1115 eval "export ${1%%=*}"1116 shift1117 ;;1118 *)1119 "$@" 2>&71120 exit1121 ;;1122 esac1123 done1124 )1125} 7>&2 2>&411261127# Returns true if the numeric exit code in "$2" represents the expected signal1128# in "$1". Signals should be given numerically.1129test_match_signal () {1130 if test "$2" = "$((128 + $1))"1131 then1132 # POSIX1133 return 01134 elif test "$2" = "$((256 + $1))"1135 then1136 # ksh1137 return 01138 fi1139 return 11140}11411142# Read up to "$1" bytes (or to EOF) from stdin and write them to stdout.1143test_copy_bytes () {1144 perl -e '1145 my $len = $ARGV[1];1146 while ($len > 0) {1147 my $s;1148 my $nread = sysread(STDIN, $s, $len);1149 die "cannot read: $!" unless defined($nread);1150 last unless $nread;1151 print $s;1152 $len -= $nread;1153 }1154 ' - "$1"1155}11561157# run "$@" inside a non-git directory1158nongit () {1159 test -d non-repo ||1160 mkdir non-repo ||1161 return 111621163 (1164 GIT_CEILING_DIRECTORIES=$(pwd) &&1165 export GIT_CEILING_DIRECTORIES &&1166 cd non-repo &&1167 "$@" 2>&71168 )1169} 7>&2 2>&411701171# convert stdin to pktline representation; note that empty input becomes an1172# empty packet, not a flush packet (for that you can just print 0000 yourself).1173packetize() {1174 cat >packetize.tmp &&1175 len=$(wc -c <packetize.tmp) &&1176 printf '%04x%s' "$(($len + 4))" &&1177 cat packetize.tmp &&1178 rm -f packetize.tmp1179}11801181# Parse the input as a series of pktlines, writing the result to stdout.1182# Sideband markers are removed automatically, and the output is routed to1183# stderr if appropriate.1184#1185# NUL bytes are converted to "\\0" for ease of parsing with text tools.1186depacketize () {1187 perl -e '1188 while (read(STDIN, $len, 4) == 4) {1189 if ($len eq "0000") {1190 print "FLUSH\n";1191 } else {1192 read(STDIN, $buf, hex($len) - 4);1193 $buf =~ s/\0/\\0/g;1194 if ($buf =~ s/^[\x2\x3]//) {1195 print STDERR $buf;1196 } else {1197 $buf =~ s/^\x1//;1198 print $buf;1199 }1200 }1201 }1202 '1203}12041205# Set the hash algorithm in use to $1. Only useful when testing the testsuite.1206test_set_hash () {1207 test_hash_algo="$1"1208}12091210# Detect the hash algorithm in use.1211test_detect_hash () {1212 # Currently we only support SHA-1, but in the future this function will1213 # actually detect the algorithm in use.1214 test_hash_algo='sha1'1215}12161217# Load common hash metadata and common placeholder object IDs for use with1218# test_oid.1219test_oid_init () {1220 test -n "$test_hash_algo" || test_detect_hash &&1221 test_oid_cache <"$TEST_DIRECTORY/oid-info/hash-info" &&1222 test_oid_cache <"$TEST_DIRECTORY/oid-info/oid"1223}12241225# Load key-value pairs from stdin suitable for use with test_oid. Blank lines1226# and lines starting with "#" are ignored. Keys must be shell identifier1227# characters.1228#1229# Examples:1230# rawsz sha1:201231# rawsz sha256:321232test_oid_cache () {1233 local tag rest k v &&12341235 { test -n "$test_hash_algo" || test_detect_hash; } &&1236 while read tag rest1237 do1238 case $tag in1239 \#*)1240 continue;;1241 ?*)1242 # non-empty1243 ;;1244 *)1245 # blank line1246 continue;;1247 esac &&12481249 k="${rest%:*}" &&1250 v="${rest#*:}" &&12511252 if ! expr "$k" : '[a-z0-9][a-z0-9]*$' >/dev/null1253 then1254 BUG 'bad hash algorithm'1255 fi &&1256 eval "test_oid_${k}_$tag=\"\$v\""1257 done1258}12591260# Look up a per-hash value based on a key ($1). The value must have been loaded1261# by test_oid_init or test_oid_cache.1262test_oid () {1263 local var="test_oid_${test_hash_algo}_$1" &&12641265 # If the variable is unset, we must be missing an entry for this1266 # key-hash pair, so exit with an error.1267 if eval "test -z \"\${$var+set}\""1268 then1269 BUG "undefined key '$1'"1270 fi &&1271 eval "printf '%s' \"\${$var}\""1272}12731274# Choose a port number based on the test script's number and store it in1275# the given variable name, unless that variable already contains a number.1276test_set_port () {1277 local var=$1 port12781279 if test $# -ne 1 || test -z "$var"1280 then1281 BUG "test_set_port requires a variable name"1282 fi12831284 eval port=\$$var1285 case "$port" in1286 "")1287 # No port is set in the given env var, use the test1288 # number as port number instead.1289 # Remove not only the leading 't', but all leading zeros1290 # as well, so the arithmetic below won't (mis)interpret1291 # a test number like '0123' as an octal value.1292 port=${this_test#${this_test%%[1-9]*}}1293 if test "${port:-0}" -lt 10241294 then1295 # root-only port, use a larger one instead.1296 port=$(($port + 10000))1297 fi1298 ;;1299 *[!0-9]*|0*)1300 error >&7 "invalid port number: $port"1301 ;;1302 *)1303 # The user has specified the port.1304 ;;1305 esac13061307 # Make sure that parallel '--stress' test jobs get different1308 # ports.1309 port=$(($port + ${GIT_TEST_STRESS_JOB_NR:-0}))1310 eval $var=$port1311}