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 # These variables must be set before the inclusion of test-lib.sh below,
21 # because it will change our working directory.
22 TEST_DIRECTORY
=$
(pwd)/..
23 TEST_OUTPUT_DIRECTORY
=$
(pwd)
26 TEST_NO_MALLOC_CHECK
=t
30 if test -n "$GIT_TEST_INSTALLED" -a -z "$PERF_SET_GIT_TEST_INSTALLED"
32 error
"Do not use GIT_TEST_INSTALLED with the perf tests.
36 ./run <path-to-git> -- <tests>
38 See t/perf/README for details."
41 # Variables from test-lib that are normally internal to the tests; we
42 # need to export them for test_perf subshells
43 export TEST_DIRECTORY TRASH_DIRECTORY GIT_BUILD_DIR GIT_TEST_CMP
45 MODERN_GIT
=$GIT_BUILD_DIR/bin-wrappers
/git
48 perf_results_dir
=$TEST_OUTPUT_DIRECTORY/test-results
49 test -n "$GIT_PERF_SUBSECTION" && perf_results_dir
="$perf_results_dir/$GIT_PERF_SUBSECTION"
50 mkdir
-p "$perf_results_dir"
51 rm -f "$perf_results_dir"/$
(basename "$0" .sh
).subtests
53 die_if_build_dir_not_repo
() {
54 if ! ( cd "$TEST_DIRECTORY/.." &&
55 git rev-parse
--build-dir >/dev
/null
2>&1 ); then
56 error
"No $1 defined, and your build directory is not a repo"
60 if test -z "$GIT_PERF_REPO"; then
61 die_if_build_dir_not_repo
'$GIT_PERF_REPO'
62 GIT_PERF_REPO
=$TEST_DIRECTORY/..
64 if test -z "$GIT_PERF_LARGE_REPO"; then
65 die_if_build_dir_not_repo
'$GIT_PERF_LARGE_REPO'
66 GIT_PERF_LARGE_REPO
=$TEST_DIRECTORY/..
69 test_perf_do_repo_symlink_config_
() {
70 test_have_prereq SYMLINKS || git config core.symlinks false
73 test_perf_create_repo_from
() {
75 BUG
"not 2 parameters to test-create-repo"
78 source_git
="$("$MODERN_GIT" -C "$source" rev-parse --git-dir)"
79 objects_dir
="$("$MODERN_GIT" -C "$source" rev-parse --git-path objects)"
83 { cp -Rl "$objects_dir" "$repo/.git/" 2>/dev
/null ||
84 cp -R "$objects_dir" "$repo/.git/"; } &&
85 for stuff
in "$source_git"/*; do
87 */objects|
*/hooks|
*/config|
*/commondir
)
90 cp -R "$stuff" "$repo/.git/" ||
exit 1
97 "$MODERN_GIT" init
-q &&
98 test_perf_do_repo_symlink_config_
&&
99 mv .git
/hooks .git
/hooks-disabled
2>/dev
/null
&&
100 if test -f .git
/index.lock
102 # We may be copying a repo that can't run "git
103 # status" due to a locked index. Since we have
104 # a copy it's fine to remove the lock.
107 ) || error
"failed to copy repository '$source' to '$repo'"
110 # call at least one of these to establish an appropriately-sized repository
111 test_perf_fresh_repo
() {
112 repo
="${1:-$TRASH_DIRECTORY}"
113 "$MODERN_GIT" init
-q "$repo" &&
116 test_perf_do_repo_symlink_config_
120 test_perf_default_repo
() {
121 test_perf_create_repo_from
"${1:-$TRASH_DIRECTORY}" "$GIT_PERF_REPO"
123 test_perf_large_repo
() {
124 if test "$GIT_PERF_LARGE_REPO" = "$GIT_BUILD_DIR"; then
125 echo "warning: \$GIT_PERF_LARGE_REPO is \$GIT_BUILD_DIR." >&2
126 echo "warning: This will work, but may not be a sufficiently large repo" >&2
127 echo "warning: for representative measurements." >&2
129 test_perf_create_repo_from
"${1:-$TRASH_DIRECTORY}" "$GIT_PERF_LARGE_REPO"
131 test_checkout_worktree
() {
132 git checkout-index
-u -a ||
133 error
"git checkout-index failed"
136 # Performance tests should never fail. If they do, stop immediately
139 # Perf tests require GNU time
140 case "$(uname -s)" in Darwin
) GTIME
="${GTIME:-gtime}";; esac
141 GTIME
="${GTIME:-/usr/bin/time}"
145 test_export_
="test_cleanup"
146 export test_cleanup test_export_
147 "$GTIME" -f "%E %U %S" -o test_time.
$i "$SHELL" -c '
148 . '"$TEST_DIRECTORY"/test-lib-functions.sh
'
150 [ $# != 0 ] || return 0
151 test_export_="$test_export_\\|$1"
157 set | sed -n "s'"/'/'\\\\''/g"';s/^\\($test_export_\\)/export '"'&'"'/p" >test_vars
161 if test $eval_ret = 0 ||
test -n "$expecting_failure"
163 test_eval_
"$test_cleanup"
164 . .
/test_vars || error
"failed to load updated environment"
166 if test "$verbose" = "t" && test -n "$HARNESS_ACTIVE"; then
173 test_wrapper_func_
=$1; shift
175 test "$#" = 3 && { test_prereq
=$1; shift; } || test_prereq
=
177 BUG
"not 2 or 3 parameters to test-expect-success"
181 base
=$
(basename "$0" .sh
)
182 echo "$test_count" >>"$perf_results_dir"/$base.subtests
183 echo "$1" >"$perf_results_dir"/$base.
$test_count.descr
184 base
="$perf_results_dir"/"$PERF_RESULTS_PREFIX$(basename "$0" .sh)".
"$test_count"
185 "$test_wrapper_func_" "$@"
192 if test -z "$verbose"; then
193 printf "%s" "perf $test_count - $1:"
195 echo "perf $test_count - $1:"
197 for i
in $
(test_seq
1 $GIT_PERF_REPEAT_COUNT); do
198 say
>&3 "running: $2"
199 if test_run_perf_
"$2"
201 if test -z "$verbose"; then
204 echo "* timing run $i/$GIT_PERF_REPEAT_COUNT:"
207 test -z "$verbose" && echo
212 if test -z "$verbose"; then
217 "$TEST_DIRECTORY"/perf
/min_time.perl test_time.
* >"$base".
times
221 test_wrapper_ test_perf_
"$@"
225 say
>&3 "running: $2"
226 if test_eval_
"$2" 3>"$base".size
; then
234 test_wrapper_ test_size_
"$@"
237 # We extend test_done to print timings at the end (./run disables this
238 # and does it after running everything)
239 test_at_end_hook_
() {
240 if test -z "$GIT_PERF_AGGREGATING_LATER"; then
241 ( cd "$TEST_DIRECTORY"/perf
&& .
/aggregate.perl $
(basename "$0") )