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