t/perf/perf-lib.sh

   1 # Performance testing framework.  Each perf script starts much like
   2 # a normal test script, except it sources this library instead of
   3 # test-lib.sh.  See t/perf/README for documentation.
   4 #
   5 # Copyright (c) 2011 Thomas Rast
   6 #
   7 # This program is free software: you can redistribute it and/or modify
   8 # it under the terms of the GNU General Public License as published by
   9 # the Free Software Foundation, either version 2 of the License, or
  10 # (at your option) any later version.
  11 #
  12 # This program is distributed in the hope that it will be useful,
  13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 # GNU General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License
  18 # along with this program.  If not, see http://www.gnu.org/licenses/ .
  19
  20 # do the --tee work early; it otherwise confuses our careful
  21 # GIT_BUILD_DIR mangling
  22 case "$GIT_TEST_TEE_STARTED, $* " in
  23 done,*)
  24         # do not redirect again
  25         ;;
  26 *' --tee '*|*' --va'*)
  27         mkdir -p test-results
  28         BASE=test-results/$(basename "$0" .sh)
  29         (GIT_TEST_TEE_STARTED=done ${SHELL-sh} "$0" "$@" 2>&1;
  30          echo $? > $BASE.exit) | tee $BASE.out
  31         test "$(cat $BASE.exit)" = 0
  32         exit
  33         ;;
  34 esac
  35
  36 TEST_DIRECTORY=$(pwd)/..
  37 TEST_OUTPUT_DIRECTORY=$(pwd)
  38 if test -z "$GIT_TEST_INSTALLED"; then
  39         perf_results_prefix=
  40 else
  41         perf_results_prefix=$(printf "%s" "${GIT_TEST_INSTALLED%/bin-wrappers}" | tr -c "[a-zA-Z0-9]" "[_*]")"."
  42         # make the tested dir absolute
  43         GIT_TEST_INSTALLED=$(cd "$GIT_TEST_INSTALLED" && pwd)
  44 fi
  45
  46 TEST_NO_CREATE_REPO=t
  47 TEST_NO_MALLOC_CHECK=t
  48
  49 . ../test-lib.sh
  50
  51 # Variables from test-lib that are normally internal to the tests; we
  52 # need to export them for test_perf subshells
  53 export TEST_DIRECTORY TRASH_DIRECTORY GIT_BUILD_DIR GIT_TEST_CMP
  54
  55 MODERN_GIT=$GIT_BUILD_DIR/bin-wrappers/git
  56 export MODERN_GIT
  57
  58 perf_results_dir=$TEST_OUTPUT_DIRECTORY/test-results
  59 mkdir -p "$perf_results_dir"
  60 rm -f "$perf_results_dir"/$(basename "$0" .sh).subtests
  61
  62 die_if_build_dir_not_repo () {
  63         if ! ( cd "$TEST_DIRECTORY/.." &&
  64                     git rev-parse --build-dir >/dev/null 2>&1 ); then
  65                 error "No $1 defined, and your build directory is not a repo"
  66         fi
  67 }
  68
  69 if test -z "$GIT_PERF_REPO"; then
  70         die_if_build_dir_not_repo '$GIT_PERF_REPO'
  71         GIT_PERF_REPO=$TEST_DIRECTORY/..
  72 fi
  73 if test -z "$GIT_PERF_LARGE_REPO"; then
  74         die_if_build_dir_not_repo '$GIT_PERF_LARGE_REPO'
  75         GIT_PERF_LARGE_REPO=$TEST_DIRECTORY/..
  76 fi
  77
  78 test_perf_do_repo_symlink_config_ () {
  79         test_have_prereq SYMLINKS || git config core.symlinks false
  80 }
  81
  82 test_perf_create_repo_from () {
  83         test "$#" = 2 ||
  84         error "bug in the test script: not 2 parameters to test-create-repo"
  85         repo="$1"
  86         source="$2"
  87         source_git="$("$MODERN_GIT" -C "$source" rev-parse --git-dir)"
  88         objects_dir="$("$MODERN_GIT" -C "$source" rev-parse --git-path objects)"
  89         mkdir -p "$repo/.git"
  90         (
  91                 cd "$source" &&
  92                 { cp -Rl "$objects_dir" "$repo/.git/" 2>/dev/null ||
  93                         cp -R "$objects_dir" "$repo/.git/"; } &&
  94                 for stuff in "$source_git"/*; do
  95                         case "$stuff" in
  96                                 */objects|*/hooks|*/config|*/commondir)
  97                                         ;;
  98                                 *)
  99                                         cp -R "$stuff" "$repo/.git/" || exit 1
 100                                         ;;
 101                         esac
 102                 done
 103         ) &&
 104         (
 105                 cd "$repo" &&
 106                 "$MODERN_GIT" init -q &&
 107                 test_perf_do_repo_symlink_config_ &&
 108                 mv .git/hooks .git/hooks-disabled 2>/dev/null &&
 109                 if test -f .git/index.lock
 110                 then
 111                         # We may be copying a repo that can't run "git
 112                         # status" due to a locked index. Since we have
 113                         # a copy it's fine to remove the lock.
 114                         rm .git/index.lock
 115                 fi
 116         ) || error "failed to copy repository '$source' to '$repo'"
 117 }
 118
 119 # call at least one of these to establish an appropriately-sized repository
 120 test_perf_fresh_repo () {
 121         repo="${1:-$TRASH_DIRECTORY}"
 122         "$MODERN_GIT" init -q "$repo" &&
 123         (
 124                 cd "$repo" &&
 125                 test_perf_do_repo_symlink_config_
 126         )
 127 }
 128
 129 test_perf_default_repo () {
 130         test_perf_create_repo_from "${1:-$TRASH_DIRECTORY}" "$GIT_PERF_REPO"
 131 }
 132 test_perf_large_repo () {
 133         if test "$GIT_PERF_LARGE_REPO" = "$GIT_BUILD_DIR"; then
 134                 echo "warning: \$GIT_PERF_LARGE_REPO is \$GIT_BUILD_DIR." >&2
 135                 echo "warning: This will work, but may not be a sufficiently large repo" >&2
 136                 echo "warning: for representative measurements." >&2
 137         fi
 138         test_perf_create_repo_from "${1:-$TRASH_DIRECTORY}" "$GIT_PERF_LARGE_REPO"
 139 }
 140 test_checkout_worktree () {
 141         git checkout-index -u -a ||
 142         error "git checkout-index failed"
 143 }
 144
 145 # Performance tests should never fail.  If they do, stop immediately
 146 immediate=t
 147
 148 # Perf tests require GNU time
 149 case "$(uname -s)" in Darwin) GTIME="${GTIME:-gtime}";; esac
 150 GTIME="${GTIME:-/usr/bin/time}"
 151
 152 test_run_perf_ () {
 153         test_cleanup=:
 154         test_export_="test_cleanup"
 155         export test_cleanup test_export_
 156         "$GTIME" -f "%E %U %S" -o test_time.$i "$SHELL" -c '
 157 . '"$TEST_DIRECTORY"/test-lib-functions.sh'
 158 test_export () {
 159         [ $# != 0 ] || return 0
 160         test_export_="$test_export_\\|$1"
 161         shift
 162         test_export "$@"
 163 }
 164 '"$1"'
 165 ret=$?
 166 set | sed -n "s'"/'/'\\\\''/g"';s/^\\($test_export_\\)/export '"'&'"'/p" >test_vars
 167 exit $ret' >&3 2>&4
 168         eval_ret=$?
 169
 170         if test $eval_ret = 0 || test -n "$expecting_failure"
 171         then
 172                 test_eval_ "$test_cleanup"
 173                 . ./test_vars || error "failed to load updated environment"
 174         fi
 175         if test "$verbose" = "t" && test -n "$HARNESS_ACTIVE"; then
 176                 echo ""
 177         fi
 178         return "$eval_ret"
 179 }
 180
 181
 182 test_perf () {
 183         test_start_
 184         test "$#" = 3 && { test_prereq=$1; shift; } || test_prereq=
 185         test "$#" = 2 ||
 186         error "bug in the test script: not 2 or 3 parameters to test-expect-success"
 187         export test_prereq
 188         if ! test_skip "$@"
 189         then
 190                 base=$(basename "$0" .sh)
 191                 echo "$test_count" >>"$perf_results_dir"/$base.subtests
 192                 echo "$1" >"$perf_results_dir"/$base.$test_count.descr
 193                 if test -z "$verbose"; then
 194                         printf "%s" "perf $test_count - $1:"
 195                 else
 196                         echo "perf $test_count - $1:"
 197                 fi
 198                 for i in $(test_seq 1 $GIT_PERF_REPEAT_COUNT); do
 199                         say >&3 "running: $2"
 200                         if test_run_perf_ "$2"
 201                         then
 202                                 if test -z "$verbose"; then
 203                                         printf " %s" "$i"
 204                                 else
 205                                         echo "* timing run $i/$GIT_PERF_REPEAT_COUNT:"
 206                                 fi
 207                         else
 208                                 test -z "$verbose" && echo
 209                                 test_failure_ "$@"
 210                                 break
 211                         fi
 212                 done
 213                 if test -z "$verbose"; then
 214                         echo " ok"
 215                 else
 216                         test_ok_ "$1"
 217                 fi
 218                 base="$perf_results_dir"/"$perf_results_prefix$(basename "$0" .sh)"."$test_count"
 219                 "$TEST_DIRECTORY"/perf/min_time.perl test_time.* >"$base".times
 220         fi
 221         test_finish_
 222 }
 223
 224 # We extend test_done to print timings at the end (./run disables this
 225 # and does it after running everything)
 226 test_at_end_hook_ () {
 227         if test -z "$GIT_PERF_AGGREGATING_LATER"; then
 228                 ( cd "$TEST_DIRECTORY"/perf && ./aggregate.perl $(basename "$0") )
 229         fi
 230 }
 231
 232 test_export () {
 233         export "$@"
 234 }