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.
5 # Copyright (c) 2011 Thomas Rast
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.
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.
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/ .
20 # do the --tee work early; it otherwise confuses our careful
21 # GIT_BUILD_DIR mangling
22 case "$GIT_TEST_TEE_STARTED, $* " in
24 # do not redirect again
26 *' --tee '*|
*' --va'*)
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
36 TEST_DIRECTORY
=$
(pwd)/..
37 TEST_OUTPUT_DIRECTORY
=$
(pwd)
38 if test -z "$GIT_TEST_INSTALLED"; then
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)
47 TEST_NO_MALLOC_CHECK
=t
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
55 MODERN_GIT
=$GIT_BUILD_DIR/bin-wrappers
/git
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
62 if test -z "$GIT_PERF_REPEAT_COUNT"; then
63 GIT_PERF_REPEAT_COUNT
=3
65 die_if_build_dir_not_repo
() {
66 if ! ( cd "$TEST_DIRECTORY/.." &&
67 git rev-parse
--build-dir >/dev
/null
2>&1 ); then
68 error
"No $1 defined, and your build directory is not a repo"
72 if test -z "$GIT_PERF_REPO"; then
73 die_if_build_dir_not_repo
'$GIT_PERF_REPO'
74 GIT_PERF_REPO
=$TEST_DIRECTORY/..
76 if test -z "$GIT_PERF_LARGE_REPO"; then
77 die_if_build_dir_not_repo
'$GIT_PERF_LARGE_REPO'
78 GIT_PERF_LARGE_REPO
=$TEST_DIRECTORY/..
81 test_perf_do_repo_symlink_config_
() {
82 test_have_prereq SYMLINKS || git config core.symlinks false
85 test_perf_create_repo_from
() {
87 error
"bug in the test script: not 2 parameters to test-create-repo"
90 source_git
="$("$MODERN_GIT" -C "$source" rev-parse --git-dir)"
91 objects_dir
="$("$MODERN_GIT" -C "$source" rev-parse --git-path objects)"
95 { cp -Rl "$objects_dir" "$repo/.git/" 2>/dev
/null ||
96 cp -R "$objects_dir" "$repo/.git/"; } &&
97 for stuff
in "$source_git"/*; do
99 */objects|
*/hooks|
*/config|
*/commondir
)
102 cp -R "$stuff" "$repo/.git/" ||
exit 1
109 "$MODERN_GIT" init
-q &&
110 test_perf_do_repo_symlink_config_
&&
111 mv .git
/hooks .git
/hooks-disabled
2>/dev
/null
112 ) || error
"failed to copy repository '$source' to '$repo'"
115 # call at least one of these to establish an appropriately-sized repository
116 test_perf_fresh_repo
() {
117 repo
="${1:-$TRASH_DIRECTORY}"
118 "$MODERN_GIT" init
-q "$repo" &&
121 test_perf_do_repo_symlink_config_
125 test_perf_default_repo
() {
126 test_perf_create_repo_from
"${1:-$TRASH_DIRECTORY}" "$GIT_PERF_REPO"
128 test_perf_large_repo
() {
129 if test "$GIT_PERF_LARGE_REPO" = "$GIT_BUILD_DIR"; then
130 echo "warning: \$GIT_PERF_LARGE_REPO is \$GIT_BUILD_DIR." >&2
131 echo "warning: This will work, but may not be a sufficiently large repo" >&2
132 echo "warning: for representative measurements." >&2
134 test_perf_create_repo_from
"${1:-$TRASH_DIRECTORY}" "$GIT_PERF_LARGE_REPO"
136 test_checkout_worktree
() {
137 git checkout-index
-u -a ||
138 error
"git checkout-index failed"
141 # Performance tests should never fail. If they do, stop immediately
144 # Perf tests require GNU time
145 case "$(uname -s)" in Darwin
) GTIME
="${GTIME:-gtime}";; esac
146 GTIME
="${GTIME:-/usr/bin/time}"
150 test_export_
="test_cleanup"
151 export test_cleanup test_export_
152 "$GTIME" -f "%E %U %S" -o test_time.
$i "$SHELL" -c '
153 . '"$TEST_DIRECTORY"/test-lib-functions.sh
'
155 [ $# != 0 ] || return 0
156 test_export_="$test_export_\\|$1"
162 set | sed -n "s'"/'/'\\\\''/g"';s/^\\($test_export_\\)/export '"'&'"'/p" >test_vars
166 if test $eval_ret = 0 ||
test -n "$expecting_failure"
168 test_eval_
"$test_cleanup"
169 . .
/test_vars || error
"failed to load updated environment"
171 if test "$verbose" = "t" && test -n "$HARNESS_ACTIVE"; then
180 test "$#" = 3 && { test_prereq
=$1; shift; } || test_prereq
=
182 error
"bug in the test script: not 2 or 3 parameters to test-expect-success"
186 base
=$
(basename "$0" .sh
)
187 echo "$test_count" >>"$perf_results_dir"/$base.subtests
188 echo "$1" >"$perf_results_dir"/$base.
$test_count.descr
189 if test -z "$verbose"; then
190 printf "%s" "perf $test_count - $1:"
192 echo "perf $test_count - $1:"
194 for i
in $
(test_seq
1 $GIT_PERF_REPEAT_COUNT); do
195 say
>&3 "running: $2"
196 if test_run_perf_
"$2"
198 if test -z "$verbose"; then
201 echo "* timing run $i/$GIT_PERF_REPEAT_COUNT:"
204 test -z "$verbose" && echo
209 if test -z "$verbose"; then
214 base
="$perf_results_dir"/"$perf_results_prefix$(basename "$0" .sh)".
"$test_count"
215 "$TEST_DIRECTORY"/perf
/min_time.perl test_time.
* >"$base".
times
220 # We extend test_done to print timings at the end (./run disables this
221 # and does it after running everything)
222 test_at_end_hook_
() {
223 if test -z "$GIT_PERF_AGGREGATING_LATER"; then
224 ( cd "$TEST_DIRECTORY"/perf
&& .
/aggregate.perl $
(basename "$0") )