Skip to content

Commit 340fde6

Browse files
gitstergitster
committed
Merge branch 'bp/rename-test-env-var'
Some environment variables that control the runtime options of Git used during tests are getting renamed for consistency. * bp/rename-test-env-var: t0000: do not get self-test disrupted by environment warnings preload-index: update GIT_FORCE_PRELOAD_TEST support read-cache: update TEST_GIT_INDEX_VERSION support fsmonitor: update GIT_TEST_FSMONITOR support preload-index: use git_env_bool() not getenv() for customization t/README: correct spelling of "uncommon"
2 parents 929e85a + 4231d1b commit 340fde6

8 files changed

Lines changed: 58 additions & 18 deletions

File tree

‎Makefile‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -400,7 +400,7 @@ all::
400400
# (defaults to "man") if you want to have a different default when
401401
# "git help" is called without a parameter specifying the format.
402402
#
403-
# Define TEST_GIT_INDEX_VERSION to 2, 3 or 4 to run the test suite
403+
# Define GIT_TEST_INDEX_VERSION to 2, 3 or 4 to run the test suite
404404
# with a different indexfile format version. If it isn't set the index
405405
# file format used is index-v[23].
406406
#
@@ -2610,8 +2610,8 @@ endif
26102610
ifdef GIT_INTEROP_MAKE_OPTS
26112611
@echo GIT_INTEROP_MAKE_OPTS=\''$(subst ','\'',$(subst ','\'',$(GIT_INTEROP_MAKE_OPTS)))'\' >>$@+
26122612
endif
2613-
ifdef TEST_GIT_INDEX_VERSION
2614-
@echo TEST_GIT_INDEX_VERSION=\''$(subst ','\'',$(subst ','\'',$(TEST_GIT_INDEX_VERSION)))'\' >>$@+
2613+
ifdef GIT_TEST_INDEX_VERSION
2614+
@echo GIT_TEST_INDEX_VERSION=\''$(subst ','\'',$(subst ','\'',$(GIT_TEST_INDEX_VERSION)))'\' >>$@+
26152615
endif
26162616
@if cmp $@+ $@ >/dev/null 2>&1; then $(RM) $@+; else mv $@+ $@; fi
26172617

‎config.c‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2278,7 +2278,7 @@ int git_config_get_max_percent_split_change(void)
22782278
int git_config_get_fsmonitor(void)
22792279
{
22802280
if (git_config_get_pathname("core.fsmonitor", &core_fsmonitor))
2281-
core_fsmonitor = getenv("GIT_FSMONITOR_TEST");
2281+
core_fsmonitor = getenv("GIT_TEST_FSMONITOR");
22822282

22832283
if (core_fsmonitor && !*core_fsmonitor)
22842284
core_fsmonitor = NULL;

‎preload-index.c‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
#include "pathspec.h"
66
#include "dir.h"
77
#include "fsmonitor.h"
8+
#include "config.h"
89

910
#ifdef NO_PTHREADS
1011
static void preload_index(struct index_state *index,
@@ -83,7 +84,7 @@ static void preload_index(struct index_state *index,
8384
return;
8485

8586
threads = index->cache_nr / THREAD_COST;
86-
if ((index->cache_nr > 1) && (threads < 2) && getenv("GIT_FORCE_PRELOAD_TEST"))
87+
if ((index->cache_nr > 1) && (threads < 2) && git_env_bool("GIT_TEST_PRELOAD_INDEX", 0))
8788
threads = 2;
8889
if (threads < 2)
8990
return;

‎t/README‎

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -315,7 +315,7 @@ packs on demand. This normally only happens when the object size is
315315
over 2GB. This variable forces the code path on any object larger than
316316
<n> bytes.
317317

318-
GIT_TEST_OE_DELTA_SIZE=<n> exercises the uncomon pack-objects code
318+
GIT_TEST_OE_DELTA_SIZE=<n> exercises the uncommon pack-objects code
319319
path where deltas larger than this limit require extra memory
320320
allocation for bookkeeping.
321321

@@ -327,6 +327,17 @@ GIT_TEST_COMMIT_GRAPH=<boolean>, when true, forces the commit-graph to
327327
be written after every 'git commit' command, and overrides the
328328
'core.commitGraph' setting to true.
329329

330+
GIT_TEST_FSMONITOR=$PWD/t7519/fsmonitor-all exercises the fsmonitor
331+
code path for utilizing a file system monitor to speed up detecting
332+
new or changed files.
333+
334+
GIT_TEST_INDEX_VERSION=<n> exercises the index read/write code path
335+
for the index version specified. Can be set to any valid version
336+
(currently 2, 3, or 4).
337+
338+
GIT_TEST_PRELOAD_INDEX=<boolean> exercises the preload-index code path
339+
by overriding the minimum number of cache entries required per thread.
340+
330341
Naming Tests
331342
------------
332343

‎t/t0000-basic.sh‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,10 @@ _run_sub_test_lib_test_common () {
8787
passing metrics
8888
'
8989
90+
# Tell the framework that we are self-testing to make sure
91+
# it yields a stable result.
92+
GIT_TEST_FRAMEWORK_SELFTEST=t &&
93+
9094
# Point to the t/test-lib.sh, which isn't in ../ as usual
9195
. "\$TEST_DIRECTORY"/test-lib.sh
9296
EOF

‎t/t1700-split-index.sh‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ test_description='split index mode tests'
66

77
# We need total control of index splitting here
88
sane_unset GIT_TEST_SPLIT_INDEX
9-
sane_unset GIT_FSMONITOR_TEST
9+
sane_unset GIT_TEST_FSMONITOR
1010

1111
test_expect_success 'enable split index' '
1212
git config splitIndex.maxPercentChange 100 &&

‎t/t7519-status-fsmonitor.sh‎

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,6 @@ test_description='git status with file system watcher'
44

55
. ./test-lib.sh
66

7-
#
8-
# To run the entire git test suite using fsmonitor:
9-
#
10-
# copy t/t7519/fsmonitor-all to a location in your path and then set
11-
# GIT_FSMONITOR_TEST=fsmonitor-all and run your tests.
12-
#
13-
147
# Note, after "git reset --hard HEAD" no extensions exist other than 'TREE'
158
# "git update-index --fsmonitor" can be used to get the extension written
169
# before testing the results.
@@ -245,9 +238,9 @@ do
245238
git config core.preloadIndex $preload_val &&
246239
if test $preload_val = true
247240
then
248-
GIT_FORCE_PRELOAD_TEST=$preload_val; export GIT_FORCE_PRELOAD_TEST
241+
GIT_TEST_PRELOAD_INDEX=$preload_val; export GIT_TEST_PRELOAD_INDEX
249242
else
250-
unset GIT_FORCE_PRELOAD_TEST
243+
sane_unset GIT_TEST_PRELOAD_INDEX
251244
fi
252245
'
253246

‎t/test-lib.sh‎

Lines changed: 33 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -134,9 +134,40 @@ export EDITOR
134134
GIT_TRACE_BARE=1
135135
export GIT_TRACE_BARE
136136

137-
if test -n "${TEST_GIT_INDEX_VERSION:+isset}"
137+
check_var_migration () {
138+
# the warnings and hints given from this helper depends
139+
# on end-user settings, which will disrupt the self-test
140+
# done on the test framework itself.
141+
case "$GIT_TEST_FRAMEWORK_SELFTEST" in
142+
t) return ;;
143+
esac
144+
145+
old_name=$1 new_name=$2
146+
eval "old_isset=\${${old_name}:+isset}"
147+
eval "new_isset=\${${new_name}:+isset}"
148+
149+
case "$old_isset,$new_isset" in
150+
isset,)
151+
echo >&2 "warning: $old_name is now $new_name"
152+
echo >&2 "hint: set $new_name too during the transition period"
153+
eval "$new_name=\$$old_name"
154+
;;
155+
isset,isset)
156+
# do this later
157+
# echo >&2 "warning: $old_name is now $new_name"
158+
# echo >&2 "hint: remove $old_name"
159+
;;
160+
esac
161+
}
162+
163+
check_var_migration GIT_FSMONITOR_TEST GIT_TEST_FSMONITOR
164+
check_var_migration TEST_GIT_INDEX_VERSION GIT_TEST_INDEX_VERSION
165+
check_var_migration GIT_FORCE_PRELOAD_TEST GIT_TEST_PRELOAD_INDEX
166+
167+
# Use specific version of the index file format
168+
if test -n "${GIT_TEST_INDEX_VERSION:+isset}"
138169
then
139-
GIT_INDEX_VERSION="$TEST_GIT_INDEX_VERSION"
170+
GIT_INDEX_VERSION="$GIT_TEST_INDEX_VERSION"
140171
export GIT_INDEX_VERSION
141172
fi
142173

0 commit comments

Comments
 (0)