Merge branch 'sg/t7800-difftool-robustify'
[git] / t / README
1 Core Git Tests
2 ==============
3
4 This directory holds many test scripts for core Git tools.  The
5 first part of this short document describes how to run the tests
6 and read their output.
7
8 When fixing the tools or adding enhancements, you are strongly
9 encouraged to add tests in this directory to cover what you are
10 trying to fix or enhance.  The later part of this short document
11 describes how your test scripts should be organized.
12
13
14 Running Tests
15 -------------
16
17 The easiest way to run tests is to say "make".  This runs all
18 the tests.
19
20     *** t0000-basic.sh ***
21     ok 1 - .git/objects should be empty after git init in an empty repo.
22     ok 2 - .git/objects should have 3 subdirectories.
23     ok 3 - success is reported like this
24     ...
25     ok 43 - very long name in the index handled sanely
26     # fixed 1 known breakage(s)
27     # still have 1 known breakage(s)
28     # passed all remaining 42 test(s)
29     1..43
30     *** t0001-init.sh ***
31     ok 1 - plain
32     ok 2 - plain with GIT_WORK_TREE
33     ok 3 - plain bare
34
35 Since the tests all output TAP (see http://testanything.org) they can
36 be run with any TAP harness. Here's an example of parallel testing
37 powered by a recent version of prove(1):
38
39     $ prove --timer --jobs 15 ./t[0-9]*.sh
40     [19:17:33] ./t0005-signals.sh ................................... ok       36 ms
41     [19:17:33] ./t0022-crlf-rename.sh ............................... ok       69 ms
42     [19:17:33] ./t0024-crlf-archive.sh .............................. ok      154 ms
43     [19:17:33] ./t0004-unwritable.sh ................................ ok      289 ms
44     [19:17:33] ./t0002-gitfile.sh ................................... ok      480 ms
45     ===(     102;0  25/?  6/?  5/?  16/?  1/?  4/?  2/?  1/?  3/?  1... )===
46
47 prove and other harnesses come with a lot of useful options. The
48 --state option in particular is very useful:
49
50     # Repeat until no more failures
51     $ prove -j 15 --state=failed,save ./t[0-9]*.sh
52
53 You can give DEFAULT_TEST_TARGET=prove on the make command (or define it
54 in config.mak) to cause "make test" to run tests under prove.
55 GIT_PROVE_OPTS can be used to pass additional options, e.g.
56
57     $ make DEFAULT_TEST_TARGET=prove GIT_PROVE_OPTS='--timer --jobs 16' test
58
59 You can also run each test individually from command line, like this:
60
61     $ sh ./t3010-ls-files-killed-modified.sh
62     ok 1 - git update-index --add to add various paths.
63     ok 2 - git ls-files -k to show killed files.
64     ok 3 - validate git ls-files -k output.
65     ok 4 - git ls-files -m to show modified files.
66     ok 5 - validate git ls-files -m output.
67     # passed all 5 test(s)
68     1..5
69
70 You can pass --verbose (or -v), --debug (or -d), and --immediate
71 (or -i) command line argument to the test, or by setting GIT_TEST_OPTS
72 appropriately before running "make". Short options can be bundled, i.e.
73 '-d -v' is the same as '-dv'.
74
75 -v::
76 --verbose::
77         This makes the test more verbose.  Specifically, the
78         command being run and their output if any are also
79         output.
80
81 --verbose-only=<pattern>::
82         Like --verbose, but the effect is limited to tests with
83         numbers matching <pattern>.  The number matched against is
84         simply the running count of the test within the file.
85
86 -x::
87         Turn on shell tracing (i.e., `set -x`) during the tests
88         themselves. Implies `--verbose`.
89         Ignored in test scripts that set the variable 'test_untraceable'
90         to a non-empty value, unless it's run with a Bash version
91         supporting BASH_XTRACEFD, i.e. v4.1 or later.
92
93 -d::
94 --debug::
95         This may help the person who is developing a new test.
96         It causes the command defined with test_debug to run.
97         The "trash" directory (used to store all temporary data
98         during testing) is not deleted even if there are no
99         failed tests so that you can inspect its contents after
100         the test finished.
101
102 -i::
103 --immediate::
104         This causes the test to immediately exit upon the first
105         failed test. Cleanup commands requested with
106         test_when_finished are not executed if the test failed,
107         in order to keep the state for inspection by the tester
108         to diagnose the bug.
109
110 -l::
111 --long-tests::
112         This causes additional long-running tests to be run (where
113         available), for more exhaustive testing.
114
115 -r::
116 --run=<test-selector>::
117         Run only the subset of tests indicated by
118         <test-selector>.  See section "Skipping Tests" below for
119         <test-selector> syntax.
120
121 --valgrind=<tool>::
122         Execute all Git binaries under valgrind tool <tool> and exit
123         with status 126 on errors (just like regular tests, this will
124         only stop the test script when running under -i).
125
126         Since it makes no sense to run the tests with --valgrind and
127         not see any output, this option implies --verbose.  For
128         convenience, it also implies --tee.
129
130         <tool> defaults to 'memcheck', just like valgrind itself.
131         Other particularly useful choices include 'helgrind' and
132         'drd', but you may use any tool recognized by your valgrind
133         installation.
134
135         As a special case, <tool> can be 'memcheck-fast', which uses
136         memcheck but disables --track-origins.  Use this if you are
137         running tests in bulk, to see if there are _any_ memory
138         issues.
139
140         Note that memcheck is run with the option --leak-check=no,
141         as the git process is short-lived and some errors are not
142         interesting. In order to run a single command under the same
143         conditions manually, you should set GIT_VALGRIND to point to
144         the 't/valgrind/' directory and use the commands under
145         't/valgrind/bin/'.
146
147 --valgrind-only=<pattern>::
148         Like --valgrind, but the effect is limited to tests with
149         numbers matching <pattern>.  The number matched against is
150         simply the running count of the test within the file.
151
152 --tee::
153         In addition to printing the test output to the terminal,
154         write it to files named 't/test-results/$TEST_NAME.out'.
155         As the names depend on the tests' file names, it is safe to
156         run the tests with this option in parallel.
157
158 -V::
159 --verbose-log::
160         Write verbose output to the same logfile as `--tee`, but do
161         _not_ write it to stdout. Unlike `--tee --verbose`, this option
162         is safe to use when stdout is being consumed by a TAP parser
163         like `prove`. Implies `--tee` and `--verbose`.
164
165 --with-dashes::
166         By default tests are run without dashed forms of
167         commands (like git-commit) in the PATH (it only uses
168         wrappers from ../bin-wrappers).  Use this option to include
169         the build directory (..) in the PATH, which contains all
170         the dashed forms of commands.  This option is currently
171         implied by other options like --valgrind and
172         GIT_TEST_INSTALLED.
173
174 --no-bin-wrappers::
175         By default, the test suite uses the wrappers in
176         `../bin-wrappers/` to execute `git` and friends. With this option,
177         `../git` and friends are run directly. This is not recommended
178         in general, as the wrappers contain safeguards to ensure that no
179         files from an installed Git are used, but can speed up test runs
180         especially on platforms where running shell scripts is expensive
181         (most notably, Windows).
182
183 --root=<directory>::
184         Create "trash" directories used to store all temporary data during
185         testing under <directory>, instead of the t/ directory.
186         Using this option with a RAM-based filesystem (such as tmpfs)
187         can massively speed up the test suite.
188
189 --chain-lint::
190 --no-chain-lint::
191         If --chain-lint is enabled, the test harness will check each
192         test to make sure that it properly "&&-chains" all commands (so
193         that a failure in the middle does not go unnoticed by the final
194         exit code of the test). This check is performed in addition to
195         running the tests themselves. You may also enable or disable
196         this feature by setting the GIT_TEST_CHAIN_LINT environment
197         variable to "1" or "0", respectively.
198
199 --stress::
200         Run the test script repeatedly in multiple parallel jobs until
201         one of them fails.  Useful for reproducing rare failures in
202         flaky tests.  The number of parallel jobs is, in order of
203         precedence: the value of the GIT_TEST_STRESS_LOAD
204         environment variable, or twice the number of available
205         processors (as shown by the 'getconf' utility), or 8.
206         Implies `--verbose -x --immediate` to get the most information
207         about the failure.  Note that the verbose output of each test
208         job is saved to 't/test-results/$TEST_NAME.stress-<nr>.out',
209         and only the output of the failed test job is shown on the
210         terminal.  The names of the trash directories get a
211         '.stress-<nr>' suffix, and the trash directory of the failed
212         test job is renamed to end with a '.stress-failed' suffix.
213
214 --stress-jobs=<N>::
215         Override the number of parallel jobs. Implies `--stress`.
216
217 --stress-limit=<N>::
218         When combined with --stress run the test script repeatedly
219         this many times in each of the parallel jobs or until one of
220         them fails, whichever comes first. Implies `--stress`.
221
222 You can also set the GIT_TEST_INSTALLED environment variable to
223 the bindir of an existing git installation to test that installation.
224 You still need to have built this git sandbox, from which various
225 test-* support programs, templates, and perl libraries are used.
226 If your installed git is incomplete, it will silently test parts of
227 your built version instead.
228
229 When using GIT_TEST_INSTALLED, you can also set GIT_TEST_EXEC_PATH to
230 override the location of the dashed-form subcommands (what
231 GIT_EXEC_PATH would be used for during normal operation).
232 GIT_TEST_EXEC_PATH defaults to `$GIT_TEST_INSTALLED/git --exec-path`.
233
234
235 Skipping Tests
236 --------------
237
238 In some environments, certain tests have no way of succeeding
239 due to platform limitation, such as lack of 'unzip' program, or
240 filesystem that do not allow arbitrary sequence of non-NUL bytes
241 as pathnames.
242
243 You should be able to say something like
244
245     $ GIT_SKIP_TESTS=t9200.8 sh ./t9200-git-cvsexport-commit.sh
246
247 and even:
248
249     $ GIT_SKIP_TESTS='t[0-4]??? t91?? t9200.8' make
250
251 to omit such tests.  The value of the environment variable is a
252 SP separated list of patterns that tells which tests to skip,
253 and either can match the "t[0-9]{4}" part to skip the whole
254 test, or t[0-9]{4} followed by ".$number" to say which
255 particular test to skip.
256
257 For an individual test suite --run could be used to specify that
258 only some tests should be run or that some tests should be
259 excluded from a run.
260
261 The argument for --run, <test-selector>, is a list of description
262 substrings or globs or individual test numbers or ranges with an
263 optional negation prefix (of '!') that define what tests in a test
264 suite to include (or exclude, if negated) in the run.  A range is two
265 numbers separated with a dash and matches a range of tests with both
266 ends been included.  You may omit the first or the second number to
267 mean "from the first test" or "up to the very last test" respectively.
268
269 The argument to --run is split on commas into separate strings,
270 numbers, and ranges, and picks all tests that match any of the
271 individual selection criteria.  If the substring of the description
272 text that you want to match includes a comma, use the glob character
273 '?' instead.  For example --run='rebase,merge?cherry-pick' would match
274 on all tests that match either the glob *rebase* or the glob
275 *merge?cherry-pick*.
276
277 If --run starts with an unprefixed number or range the initial
278 set of tests to run is empty. If the first item starts with '!'
279 all the tests are added to the initial set.  After initial set is
280 determined every test number or range is added or excluded from
281 the set one by one, from left to right.
282
283 For example, to run only tests up to a specific test (21), one
284 could do this:
285
286     $ sh ./t9200-git-cvsexport-commit.sh --run='1-21'
287
288 or this:
289
290     $ sh ./t9200-git-cvsexport-commit.sh --run='-21'
291
292 Common case is to run several setup tests (1, 2, 3) and then a
293 specific test (21) that relies on that setup:
294
295     $ sh ./t9200-git-cvsexport-commit.sh --run='1,2,3,21'
296
297 or:
298
299     $ sh ./t9200-git-cvsexport-commit.sh --run=1,2,3,21
300
301 or:
302
303     $ sh ./t9200-git-cvsexport-commit.sh --run='-3,21'
304
305 As noted above, the test set is built by going through the items
306 from left to right, so this:
307
308     $ sh ./t9200-git-cvsexport-commit.sh --run='1-4,!3'
309
310 will run tests 1, 2, and 4.  Items that come later have higher
311 precedence.  It means that this:
312
313     $ sh ./t9200-git-cvsexport-commit.sh --run='!3,1-4'
314
315 would just run tests from 1 to 4, including 3.
316
317 You may use negation with ranges.  The following will run all
318 test in the test suite except from 7 up to 11:
319
320     $ sh ./t9200-git-cvsexport-commit.sh --run='!7-11'
321
322 Sometimes there may be multiple tests with e.g. "setup" in their name
323 that are needed and rather than figuring out the number for all of them
324 we can just use "setup" as a substring/glob to match against the test
325 description:
326
327     $ sh ./t0050-filesystem.sh --run=setup,9-11
328
329 or one could select both the setup tests and the rename ones (assuming all
330 relevant tests had those words in their descriptions):
331
332     $ sh ./t0050-filesystem.sh --run=setup,rename
333
334 Some tests in a test suite rely on the previous tests performing
335 certain actions, specifically some tests are designated as
336 "setup" test, so you cannot _arbitrarily_ disable one test and
337 expect the rest to function correctly.
338
339 --run is mostly useful when you want to focus on a specific test
340 and know what setup is needed for it.  Or when you want to run
341 everything up to a certain test.
342
343
344 Running tests with special setups
345 ---------------------------------
346
347 The whole test suite could be run to test some special features
348 that cannot be easily covered by a few specific test cases. These
349 could be enabled by running the test suite with correct GIT_TEST_
350 environment set.
351
352 GIT_TEST_FAIL_PREREQS=<boolean> fails all prerequisites. This is
353 useful for discovering issues with the tests where say a later test
354 implicitly depends on an optional earlier test.
355
356 There's a "FAIL_PREREQS" prerequisite that can be used to test for
357 whether this mode is active, and e.g. skip some tests that are hard to
358 refactor to deal with it. The "SYMLINKS" prerequisite is currently
359 excluded as so much relies on it, but this might change in the future.
360
361 GIT_TEST_GETTEXT_POISON=<boolean> turns all strings marked for
362 translation into gibberish if true. Used for spotting those tests that
363 need to be marked with a C_LOCALE_OUTPUT prerequisite when adding more
364 strings for translation. See "Testing marked strings" in po/README for
365 details.
366
367 GIT_TEST_SPLIT_INDEX=<boolean> forces split-index mode on the whole
368 test suite. Accept any boolean values that are accepted by git-config.
369
370 GIT_TEST_PROTOCOL_VERSION=<n>, when set, makes 'protocol.version'
371 default to n.
372
373 GIT_TEST_FULL_IN_PACK_ARRAY=<boolean> exercises the uncommon
374 pack-objects code path where there are more than 1024 packs even if
375 the actual number of packs in repository is below this limit. Accept
376 any boolean values that are accepted by git-config.
377
378 GIT_TEST_OE_SIZE=<n> exercises the uncommon pack-objects code path
379 where we do not cache object size in memory and read it from existing
380 packs on demand. This normally only happens when the object size is
381 over 2GB. This variable forces the code path on any object larger than
382 <n> bytes.
383
384 GIT_TEST_OE_DELTA_SIZE=<n> exercises the uncommon pack-objects code
385 path where deltas larger than this limit require extra memory
386 allocation for bookkeeping.
387
388 GIT_TEST_VALIDATE_INDEX_CACHE_ENTRIES=<boolean> checks that cache-tree
389 records are valid when the index is written out or after a merge. This
390 is mostly to catch missing invalidation. Default is true.
391
392 GIT_TEST_COMMIT_GRAPH=<boolean>, when true, forces the commit-graph to
393 be written after every 'git commit' command, and overrides the
394 'core.commitGraph' setting to true.
395
396 GIT_TEST_COMMIT_GRAPH_CHANGED_PATHS=<boolean>, when true, forces
397 commit-graph write to compute and write changed path Bloom filters for
398 every 'git commit-graph write', as if the `--changed-paths` option was
399 passed in.
400
401 GIT_TEST_FSMONITOR=$PWD/t7519/fsmonitor-all exercises the fsmonitor
402 code path for utilizing a file system monitor to speed up detecting
403 new or changed files.
404
405 GIT_TEST_INDEX_VERSION=<n> exercises the index read/write code path
406 for the index version specified.  Can be set to any valid version
407 (currently 2, 3, or 4).
408
409 GIT_TEST_PACK_SPARSE=<boolean> if disabled will default the pack-objects
410 builtin to use the non-sparse object walk. This can still be overridden by
411 the --sparse command-line argument.
412
413 GIT_TEST_PRELOAD_INDEX=<boolean> exercises the preload-index code path
414 by overriding the minimum number of cache entries required per thread.
415
416 GIT_TEST_ADD_I_USE_BUILTIN=<boolean>, when true, enables the
417 built-in version of git add -i. See 'add.interactive.useBuiltin' in
418 git-config(1).
419
420 GIT_TEST_INDEX_THREADS=<n> enables exercising the multi-threaded loading
421 of the index for the whole test suite by bypassing the default number of
422 cache entries and thread minimums. Setting this to 1 will make the
423 index loading single threaded.
424
425 GIT_TEST_MULTI_PACK_INDEX=<boolean>, when true, forces the multi-pack-
426 index to be written after every 'git repack' command, and overrides the
427 'core.multiPackIndex' setting to true.
428
429 GIT_TEST_SIDEBAND_ALL=<boolean>, when true, overrides the
430 'uploadpack.allowSidebandAll' setting to true, and when false, forces
431 fetch-pack to not request sideband-all (even if the server advertises
432 sideband-all).
433
434 GIT_TEST_DISALLOW_ABBREVIATED_OPTIONS=<boolean>, when true (which is
435 the default when running tests), errors out when an abbreviated option
436 is used.
437
438 GIT_TEST_DEFAULT_HASH=<hash-algo> specifies which hash algorithm to
439 use in the test scripts. Recognized values for <hash-algo> are "sha1"
440 and "sha256".
441
442 Naming Tests
443 ------------
444
445 The test files are named as:
446
447         tNNNN-commandname-details.sh
448
449 where N is a decimal digit.
450
451 First digit tells the family:
452
453         0 - the absolute basics and global stuff
454         1 - the basic commands concerning database
455         2 - the basic commands concerning the working tree
456         3 - the other basic commands (e.g. ls-files)
457         4 - the diff commands
458         5 - the pull and exporting commands
459         6 - the revision tree commands (even e.g. merge-base)
460         7 - the porcelainish commands concerning the working tree
461         8 - the porcelainish commands concerning forensics
462         9 - the git tools
463
464 Second digit tells the particular command we are testing.
465
466 Third digit (optionally) tells the particular switch or group of switches
467 we are testing.
468
469 If you create files under t/ directory (i.e. here) that is not
470 the top-level test script, never name the file to match the above
471 pattern.  The Makefile here considers all such files as the
472 top-level test script and tries to run all of them.  Care is
473 especially needed if you are creating a common test library
474 file, similar to test-lib.sh, because such a library file may
475 not be suitable for standalone execution.
476
477
478 Writing Tests
479 -------------
480
481 The test script is written as a shell script.  It should start
482 with the standard "#!/bin/sh", and an
483 assignment to variable 'test_description', like this:
484
485         #!/bin/sh
486
487         test_description='xxx test (option --frotz)
488
489         This test registers the following structure in the cache
490         and tries to run git-ls-files with option --frotz.'
491
492
493 Source 'test-lib.sh'
494 --------------------
495
496 After assigning test_description, the test script should source
497 test-lib.sh like this:
498
499         . ./test-lib.sh
500
501 This test harness library does the following things:
502
503  - If the script is invoked with command line argument --help
504    (or -h), it shows the test_description and exits.
505
506  - Creates an empty test directory with an empty .git/objects database
507    and chdir(2) into it.  This directory is 't/trash
508    directory.$test_name_without_dotsh', with t/ subject to change by
509    the --root option documented above, and a '.stress-<N>' suffix
510    appended by the --stress option.
511
512  - Defines standard test helper functions for your scripts to
513    use.  These functions are designed to make all scripts behave
514    consistently when command line arguments --verbose (or -v),
515    --debug (or -d), and --immediate (or -i) is given.
516
517 Do's & don'ts
518 -------------
519
520 Here are a few examples of things you probably should and shouldn't do
521 when writing tests.
522
523 Here are the "do's:"
524
525  - Put all code inside test_expect_success and other assertions.
526
527    Even code that isn't a test per se, but merely some setup code
528    should be inside a test assertion.
529
530  - Chain your test assertions
531
532    Write test code like this:
533
534         git merge foo &&
535         git push bar &&
536         test ...
537
538    Instead of:
539
540         git merge hla
541         git push gh
542         test ...
543
544    That way all of the commands in your tests will succeed or fail. If
545    you must ignore the return value of something, consider using a
546    helper function (e.g. use sane_unset instead of unset, in order
547    to avoid unportable return value for unsetting a variable that was
548    already unset), or prepending the command with test_might_fail or
549    test_must_fail.
550
551  - Check the test coverage for your tests. See the "Test coverage"
552    below.
553
554    Don't blindly follow test coverage metrics; if a new function you added
555    doesn't have any coverage, then you're probably doing something wrong,
556    but having 100% coverage doesn't necessarily mean that you tested
557    everything.
558
559    Tests that are likely to smoke out future regressions are better
560    than tests that just inflate the coverage metrics.
561
562  - When a test checks for an absolute path that a git command generated,
563    construct the expected value using $(pwd) rather than $PWD,
564    $TEST_DIRECTORY, or $TRASH_DIRECTORY. It makes a difference on
565    Windows, where the shell (MSYS bash) mangles absolute path names.
566    For details, see the commit message of 4114156ae9.
567
568  - Remember that inside the <script> part, the standard output and
569    standard error streams are discarded, and the test harness only
570    reports "ok" or "not ok" to the end user running the tests. Under
571    --verbose, they are shown to help debug the tests.
572
573  - Be careful when you loop
574
575    You may need to verify multiple things in a loop, but the
576    following does not work correctly:
577
578         test_expect_success 'test three things' '
579             for i in one two three
580             do
581                 test_something "$i"
582             done &&
583             test_something_else
584         '
585
586    Because the status of the loop itself is the exit status of the
587    test_something in the last round, the loop does not fail when
588    "test_something" for "one" or "two" fails.  This is not what you
589    want.
590
591    Instead, you can break out of the loop immediately when you see a
592    failure.  Because all test_expect_* snippets are executed inside
593    a function, "return 1" can be used to fail the test immediately
594    upon a failure:
595
596         test_expect_success 'test three things' '
597             for i in one two three
598             do
599                 test_something "$i" || return 1
600             done &&
601             test_something_else
602         '
603
604    Note that we still &&-chain the loop to propagate failures from
605    earlier commands.
606
607
608 And here are the "don'ts:"
609
610  - Don't exit() within a <script> part.
611
612    The harness will catch this as a programming error of the test.
613    Use test_done instead if you need to stop the tests early (see
614    "Skipping tests" below).
615
616  - Don't use '! git cmd' when you want to make sure the git command
617    exits with failure in a controlled way by calling "die()".  Instead,
618    use 'test_must_fail git cmd'.  This will signal a failure if git
619    dies in an unexpected way (e.g. segfault).
620
621    On the other hand, don't use test_must_fail for running regular
622    platform commands; just use '! cmd'.  We are not in the business
623    of verifying that the world given to us sanely works.
624
625  - Don't feed the output of a git command to a pipe, as in:
626
627      git -C repo ls-files |
628      xargs -n 1 basename |
629      grep foo
630
631    which will discard git's exit code and may mask a crash. In the
632    above example, all exit codes are ignored except grep's.
633
634    Instead, write the output of that command to a temporary
635    file with ">" or assign it to a variable with "x=$(git ...)" rather
636    than pipe it.
637
638  - Don't use command substitution in a way that discards git's exit
639    code. When assigning to a variable, the exit code is not discarded,
640    e.g.:
641
642      x=$(git cat-file -p $sha) &&
643      ...
644
645    is OK because a crash in "git cat-file" will cause the "&&" chain
646    to fail, but:
647
648      test "refs/heads/foo" = "$(git symbolic-ref HEAD)"
649
650    is not OK and a crash in git could go undetected.
651
652  - Don't use perl without spelling it as "$PERL_PATH". This is to help
653    our friends on Windows where the platform Perl often adds CR before
654    the end of line, and they bundle Git with a version of Perl that
655    does not do so, whose path is specified with $PERL_PATH. Note that we
656    provide a "perl" function which uses $PERL_PATH under the hood, so
657    you do not need to worry when simply running perl in the test scripts
658    (but you do, for example, on a shebang line or in a sub script
659    created via "write_script").
660
661  - Don't use sh without spelling it as "$SHELL_PATH", when the script
662    can be misinterpreted by broken platform shell (e.g. Solaris).
663
664  - Don't chdir around in tests.  It is not sufficient to chdir to
665    somewhere and then chdir back to the original location later in
666    the test, as any intermediate step can fail and abort the test,
667    causing the next test to start in an unexpected directory.  Do so
668    inside a subshell if necessary.
669
670  - Don't save and verify the standard error of compound commands, i.e.
671    group commands, subshells, and shell functions (except test helper
672    functions like 'test_must_fail') like this:
673
674      ( cd dir && git cmd ) 2>error &&
675      test_cmp expect error
676
677    When running the test with '-x' tracing, then the trace of commands
678    executed in the compound command will be included in standard error
679    as well, quite possibly throwing off the subsequent checks examining
680    the output.  Instead, save only the relevant git command's standard
681    error:
682
683      ( cd dir && git cmd 2>../error ) &&
684      test_cmp expect error
685
686  - Don't break the TAP output
687
688    The raw output from your test may be interpreted by a TAP harness. TAP
689    harnesses will ignore everything they don't know about, but don't step
690    on their toes in these areas:
691
692    - Don't print lines like "$x..$y" where $x and $y are integers.
693
694    - Don't print lines that begin with "ok" or "not ok".
695
696    TAP harnesses expect a line that begins with either "ok" and "not
697    ok" to signal a test passed or failed (and our harness already
698    produces such lines), so your script shouldn't emit such lines to
699    their output.
700
701    You can glean some further possible issues from the TAP grammar
702    (see https://metacpan.org/pod/TAP::Parser::Grammar#TAP-GRAMMAR)
703    but the best indication is to just run the tests with prove(1),
704    it'll complain if anything is amiss.
705
706
707 Skipping tests
708 --------------
709
710 If you need to skip tests you should do so by using the three-arg form
711 of the test_* functions (see the "Test harness library" section
712 below), e.g.:
713
714     test_expect_success PERL 'I need Perl' '
715         perl -e "hlagh() if unf_unf()"
716     '
717
718 The advantage of skipping tests like this is that platforms that don't
719 have the PERL and other optional dependencies get an indication of how
720 many tests they're missing.
721
722 If the test code is too hairy for that (i.e. does a lot of setup work
723 outside test assertions) you can also skip all remaining tests by
724 setting skip_all and immediately call test_done:
725
726         if ! test_have_prereq PERL
727         then
728             skip_all='skipping perl interface tests, perl not available'
729             test_done
730         fi
731
732 The string you give to skip_all will be used as an explanation for why
733 the test was skipped.
734
735 End with test_done
736 ------------------
737
738 Your script will be a sequence of tests, using helper functions
739 from the test harness library.  At the end of the script, call
740 'test_done'.
741
742
743 Test harness library
744 --------------------
745
746 There are a handful helper functions defined in the test harness
747 library for your script to use.
748
749  - test_expect_success [<prereq>] <message> <script>
750
751    Usually takes two strings as parameters, and evaluates the
752    <script>.  If it yields success, test is considered
753    successful.  <message> should state what it is testing.
754
755    Example:
756
757         test_expect_success \
758             'git-write-tree should be able to write an empty tree.' \
759             'tree=$(git-write-tree)'
760
761    If you supply three parameters the first will be taken to be a
762    prerequisite; see the test_set_prereq and test_have_prereq
763    documentation below:
764
765         test_expect_success TTY 'git --paginate rev-list uses a pager' \
766             ' ... '
767
768    You can also supply a comma-separated list of prerequisites, in the
769    rare case where your test depends on more than one:
770
771         test_expect_success PERL,PYTHON 'yo dawg' \
772             ' test $(perl -E 'print eval "1 +" . qx[python -c "print 2"]') == "4" '
773
774  - test_expect_failure [<prereq>] <message> <script>
775
776    This is NOT the opposite of test_expect_success, but is used
777    to mark a test that demonstrates a known breakage.  Unlike
778    the usual test_expect_success tests, which say "ok" on
779    success and "FAIL" on failure, this will say "FIXED" on
780    success and "still broken" on failure.  Failures from these
781    tests won't cause -i (immediate) to stop.
782
783    Like test_expect_success this function can optionally use a three
784    argument invocation with a prerequisite as the first argument.
785
786  - test_debug <script>
787
788    This takes a single argument, <script>, and evaluates it only
789    when the test script is started with --debug command line
790    argument.  This is primarily meant for use during the
791    development of a new test script.
792
793  - debug <git-command>
794
795    Run a git command inside a debugger. This is primarily meant for
796    use when debugging a failing test script.
797
798  - test_done
799
800    Your test script must have test_done at the end.  Its purpose
801    is to summarize successes and failures in the test script and
802    exit with an appropriate error code.
803
804  - test_tick
805
806    Make commit and tag names consistent by setting the author and
807    committer times to defined state.  Subsequent calls will
808    advance the times by a fixed amount.
809
810  - test_commit <message> [<filename> [<contents>]]
811
812    Creates a commit with the given message, committing the given
813    file with the given contents (default for both is to reuse the
814    message string), and adds a tag (again reusing the message
815    string as name).  Calls test_tick to make the SHA-1s
816    reproducible.
817
818  - test_merge <message> <commit-or-tag>
819
820    Merges the given rev using the given message.  Like test_commit,
821    creates a tag and calls test_tick before committing.
822
823  - test_set_prereq <prereq>
824
825    Set a test prerequisite to be used later with test_have_prereq. The
826    test-lib will set some prerequisites for you, see the
827    "Prerequisites" section below for a full list of these.
828
829    Others you can set yourself and use later with either
830    test_have_prereq directly, or the three argument invocation of
831    test_expect_success and test_expect_failure.
832
833  - test_have_prereq <prereq>
834
835    Check if we have a prerequisite previously set with test_set_prereq.
836    The most common way to use this explicitly (as opposed to the
837    implicit use when an argument is passed to test_expect_*) is to skip
838    all the tests at the start of the test script if we don't have some
839    essential prerequisite:
840
841         if ! test_have_prereq PERL
842         then
843             skip_all='skipping perl interface tests, perl not available'
844             test_done
845         fi
846
847  - test_external [<prereq>] <message> <external> <script>
848
849    Execute a <script> with an <external> interpreter (like perl). This
850    was added for tests like t9700-perl-git.sh which do most of their
851    work in an external test script.
852
853         test_external \
854             'GitwebCache::*FileCache*' \
855             perl "$TEST_DIRECTORY"/t9503/test_cache_interface.pl
856
857    If the test is outputting its own TAP you should set the
858    test_external_has_tap variable somewhere before calling the first
859    test_external* function. See t9700-perl-git.sh for an example.
860
861         # The external test will outputs its own plan
862         test_external_has_tap=1
863
864  - test_external_without_stderr [<prereq>] <message> <external> <script>
865
866    Like test_external but fail if there's any output on stderr,
867    instead of checking the exit code.
868
869         test_external_without_stderr \
870             'Perl API' \
871             perl "$TEST_DIRECTORY"/t9700/test.pl
872
873  - test_expect_code <exit-code> <command>
874
875    Run a command and ensure that it exits with the given exit code.
876    For example:
877
878         test_expect_success 'Merge with d/f conflicts' '
879                 test_expect_code 1 git merge "merge msg" B master
880         '
881
882  - test_must_fail [<options>] <git-command>
883
884    Run a git command and ensure it fails in a controlled way.  Use
885    this instead of "! <git-command>".  When git-command dies due to a
886    segfault, test_must_fail diagnoses it as an error; "! <git-command>"
887    treats it as just another expected failure, which would let such a
888    bug go unnoticed.
889
890    Accepts the following options:
891
892      ok=<signal-name>[,<...>]:
893        Don't treat an exit caused by the given signal as error.
894        Multiple signals can be specified as a comma separated list.
895        Currently recognized signal names are: sigpipe, success.
896        (Don't use 'success', use 'test_might_fail' instead.)
897
898  - test_might_fail [<options>] <git-command>
899
900    Similar to test_must_fail, but tolerate success, too.  Use this
901    instead of "<git-command> || :" to catch failures due to segv.
902
903    Accepts the same options as test_must_fail.
904
905  - test_cmp <expected> <actual>
906
907    Check whether the content of the <actual> file matches the
908    <expected> file.  This behaves like "cmp" but produces more
909    helpful output when the test is run with "-v" option.
910
911  - test_cmp_rev <expected> <actual>
912
913    Check whether the <expected> rev points to the same commit as the
914    <actual> rev.
915
916  - test_line_count (= | -lt | -ge | ...) <length> <file>
917
918    Check whether a file has the length it is expected to.
919
920  - test_path_is_file <path> [<diagnosis>]
921    test_path_is_dir <path> [<diagnosis>]
922    test_path_is_missing <path> [<diagnosis>]
923
924    Check if the named path is a file, if the named path is a
925    directory, or if the named path does not exist, respectively,
926    and fail otherwise, showing the <diagnosis> text.
927
928  - test_when_finished <script>
929
930    Prepend <script> to a list of commands to run to clean up
931    at the end of the current test.  If some clean-up command
932    fails, the test will not pass.
933
934    Example:
935
936         test_expect_success 'branch pointing to non-commit' '
937                 git rev-parse HEAD^{tree} >.git/refs/heads/invalid &&
938                 test_when_finished "git update-ref -d refs/heads/invalid" &&
939                 ...
940         '
941
942  - test_atexit <script>
943
944    Prepend <script> to a list of commands to run unconditionally to
945    clean up before the test script exits, e.g. to stop a daemon:
946
947         test_expect_success 'test git daemon' '
948                 git daemon &
949                 daemon_pid=$! &&
950                 test_atexit 'kill $daemon_pid' &&
951                 hello world
952         '
953
954    The commands will be executed before the trash directory is removed,
955    i.e. the atexit commands will still be able to access any pidfiles or
956    socket files.
957
958    Note that these commands will be run even when a test script run
959    with '--immediate' fails.  Be careful with your atexit commands to
960    minimize any changes to the failed state.
961
962  - test_write_lines <lines>
963
964    Write <lines> on standard output, one line per argument.
965    Useful to prepare multi-line files in a compact form.
966
967    Example:
968
969         test_write_lines a b c d e f g >foo
970
971    Is a more compact equivalent of:
972         cat >foo <<-EOF
973         a
974         b
975         c
976         d
977         e
978         f
979         g
980         EOF
981
982
983  - test_pause
984
985         This command is useful for writing and debugging tests and must be
986         removed before submitting. It halts the execution of the test and
987         spawns a shell in the trash directory. Exit the shell to continue
988         the test. Example:
989
990         test_expect_success 'test' '
991                 git do-something >actual &&
992                 test_pause &&
993                 test_cmp expected actual
994         '
995
996  - test_ln_s_add <path1> <path2>
997
998    This function helps systems whose filesystem does not support symbolic
999    links. Use it to add a symbolic link entry to the index when it is not
1000    important that the file system entry is a symbolic link, i.e., instead
1001    of the sequence
1002
1003         ln -s foo bar &&
1004         git add bar
1005
1006    Sometimes it is possible to split a test in a part that does not need
1007    the symbolic link in the file system and a part that does; then only
1008    the latter part need be protected by a SYMLINKS prerequisite (see below).
1009
1010  - test_oid_init
1011
1012    This function loads facts and useful object IDs related to the hash
1013    algorithm(s) in use from the files in t/oid-info.
1014
1015  - test_oid_cache
1016
1017    This function reads per-hash algorithm information from standard
1018    input (usually a heredoc) in the format described in
1019    t/oid-info/README.  This is useful for test-specific values, such as
1020    object IDs, which must vary based on the hash algorithm.
1021
1022    Certain fixed values, such as hash sizes and common placeholder
1023    object IDs, can be loaded with test_oid_init (described above).
1024
1025  - test_oid <key>
1026
1027    This function looks up a value for the hash algorithm in use, based
1028    on the key given.  The value must have been loaded using
1029    test_oid_init or test_oid_cache.  Providing an unknown key is an
1030    error.
1031
1032  - yes [<string>]
1033
1034    This is often seen in modern UNIX but some platforms lack it, so
1035    the test harness overrides the platform implementation with a
1036    more limited one.  Use this only when feeding a handful lines of
1037    output to the downstream---unlike the real version, it generates
1038    only up to 99 lines.
1039
1040  - test_bool_env <env-variable-name> <default-value>
1041
1042    Given the name of an environment variable with a bool value,
1043    normalize its value to a 0 (true) or 1 (false or empty string)
1044    return code.  Return with code corresponding to the given default
1045    value if the variable is unset.
1046    Abort the test script if either the value of the variable or the
1047    default are not valid bool values.
1048
1049
1050 Prerequisites
1051 -------------
1052
1053 These are the prerequisites that the test library predefines with
1054 test_have_prereq.
1055
1056 See the prereq argument to the test_* functions in the "Test harness
1057 library" section above and the "test_have_prereq" function for how to
1058 use these, and "test_set_prereq" for how to define your own.
1059
1060  - PYTHON
1061
1062    Git wasn't compiled with NO_PYTHON=YesPlease. Wrap any tests that
1063    need Python with this.
1064
1065  - PERL
1066
1067    Git wasn't compiled with NO_PERL=YesPlease.
1068
1069    Even without the PERL prerequisite, tests can assume there is a
1070    usable perl interpreter at $PERL_PATH, though it need not be
1071    particularly modern.
1072
1073  - POSIXPERM
1074
1075    The filesystem supports POSIX style permission bits.
1076
1077  - BSLASHPSPEC
1078
1079    Backslashes in pathspec are not directory separators. This is not
1080    set on Windows. See 6fd1106a for details.
1081
1082  - EXECKEEPSPID
1083
1084    The process retains the same pid across exec(2). See fb9a2bea for
1085    details.
1086
1087  - PIPE
1088
1089    The filesystem we're on supports creation of FIFOs (named pipes)
1090    via mkfifo(1).
1091
1092  - SYMLINKS
1093
1094    The filesystem we're on supports symbolic links. E.g. a FAT
1095    filesystem doesn't support these. See 704a3143 for details.
1096
1097  - SANITY
1098
1099    Test is not run by root user, and an attempt to write to an
1100    unwritable file is expected to fail correctly.
1101
1102  - PCRE
1103
1104    Git was compiled with support for PCRE. Wrap any tests
1105    that use git-grep --perl-regexp or git-grep -P in these.
1106
1107  - LIBPCRE1
1108
1109    Git was compiled with PCRE v1 support via
1110    USE_LIBPCRE1=YesPlease. Wrap any PCRE using tests that for some
1111    reason need v1 of the PCRE library instead of v2 in these.
1112
1113  - LIBPCRE2
1114
1115    Git was compiled with PCRE v2 support via
1116    USE_LIBPCRE2=YesPlease. Wrap any PCRE using tests that for some
1117    reason need v2 of the PCRE library instead of v1 in these.
1118
1119  - CASE_INSENSITIVE_FS
1120
1121    Test is run on a case insensitive file system.
1122
1123  - UTF8_NFD_TO_NFC
1124
1125    Test is run on a filesystem which converts decomposed utf-8 (nfd)
1126    to precomposed utf-8 (nfc).
1127
1128  - PTHREADS
1129
1130    Git wasn't compiled with NO_PTHREADS=YesPlease.
1131
1132 Tips for Writing Tests
1133 ----------------------
1134
1135 As with any programming projects, existing programs are the best
1136 source of the information.  However, do _not_ emulate
1137 t0000-basic.sh when writing your tests.  The test is special in
1138 that it tries to validate the very core of Git.  For example, it
1139 knows that there will be 256 subdirectories under .git/objects/,
1140 and it knows that the object ID of an empty tree is a certain
1141 40-byte string.  This is deliberately done so in t0000-basic.sh
1142 because the things the very basic core test tries to achieve is
1143 to serve as a basis for people who are changing the Git internals
1144 drastically.  For these people, after making certain changes,
1145 not seeing failures from the basic test _is_ a failure.  And
1146 such drastic changes to the core Git that even changes these
1147 otherwise supposedly stable object IDs should be accompanied by
1148 an update to t0000-basic.sh.
1149
1150 However, other tests that simply rely on basic parts of the core
1151 Git working properly should not have that level of intimate
1152 knowledge of the core Git internals.  If all the test scripts
1153 hardcoded the object IDs like t0000-basic.sh does, that defeats
1154 the purpose of t0000-basic.sh, which is to isolate that level of
1155 validation in one place.  Your test also ends up needing
1156 updating when such a change to the internal happens, so do _not_
1157 do it and leave the low level of validation to t0000-basic.sh.
1158
1159 Test coverage
1160 -------------
1161
1162 You can use the coverage tests to find code paths that are not being
1163 used or properly exercised yet.
1164
1165 To do that, run the coverage target at the top-level (not in the t/
1166 directory):
1167
1168     make coverage
1169
1170 That'll compile Git with GCC's coverage arguments, and generate a test
1171 report with gcov after the tests finish. Running the coverage tests
1172 can take a while, since running the tests in parallel is incompatible
1173 with GCC's coverage mode.
1174
1175 After the tests have run you can generate a list of untested
1176 functions:
1177
1178     make coverage-untested-functions
1179
1180 You can also generate a detailed per-file HTML report using the
1181 Devel::Cover module. To install it do:
1182
1183    # On Debian or Ubuntu:
1184    sudo aptitude install libdevel-cover-perl
1185
1186    # From the CPAN with cpanminus
1187    curl -L http://cpanmin.us | perl - --sudo --self-upgrade
1188    cpanm --sudo Devel::Cover
1189
1190 Then, at the top-level:
1191
1192     make cover_db_html
1193
1194 That'll generate a detailed cover report in the "cover_db_html"
1195 directory, which you can then copy to a webserver, or inspect locally
1196 in a browser.