t4001: add a test comparing basename similarity and content similarity
[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_SPLIT_INDEX=<boolean> forces split-index mode on the whole
362 test suite. Accept any boolean values that are accepted by git-config.
363
364 GIT_TEST_PROTOCOL_VERSION=<n>, when set, makes 'protocol.version'
365 default to n.
366
367 GIT_TEST_FULL_IN_PACK_ARRAY=<boolean> exercises the uncommon
368 pack-objects code path where there are more than 1024 packs even if
369 the actual number of packs in repository is below this limit. Accept
370 any boolean values that are accepted by git-config.
371
372 GIT_TEST_OE_SIZE=<n> exercises the uncommon pack-objects code path
373 where we do not cache object size in memory and read it from existing
374 packs on demand. This normally only happens when the object size is
375 over 2GB. This variable forces the code path on any object larger than
376 <n> bytes.
377
378 GIT_TEST_OE_DELTA_SIZE=<n> exercises the uncommon pack-objects code
379 path where deltas larger than this limit require extra memory
380 allocation for bookkeeping.
381
382 GIT_TEST_VALIDATE_INDEX_CACHE_ENTRIES=<boolean> checks that cache-tree
383 records are valid when the index is written out or after a merge. This
384 is mostly to catch missing invalidation. Default is true.
385
386 GIT_TEST_COMMIT_GRAPH=<boolean>, when true, forces the commit-graph to
387 be written after every 'git commit' command, and overrides the
388 'core.commitGraph' setting to true.
389
390 GIT_TEST_COMMIT_GRAPH_CHANGED_PATHS=<boolean>, when true, forces
391 commit-graph write to compute and write changed path Bloom filters for
392 every 'git commit-graph write', as if the `--changed-paths` option was
393 passed in.
394
395 GIT_TEST_FSMONITOR=$PWD/t7519/fsmonitor-all exercises the fsmonitor
396 code path for utilizing a file system monitor to speed up detecting
397 new or changed files.
398
399 GIT_TEST_INDEX_VERSION=<n> exercises the index read/write code path
400 for the index version specified.  Can be set to any valid version
401 (currently 2, 3, or 4).
402
403 GIT_TEST_PACK_SPARSE=<boolean> if disabled will default the pack-objects
404 builtin to use the non-sparse object walk. This can still be overridden by
405 the --sparse command-line argument.
406
407 GIT_TEST_PRELOAD_INDEX=<boolean> exercises the preload-index code path
408 by overriding the minimum number of cache entries required per thread.
409
410 GIT_TEST_ADD_I_USE_BUILTIN=<boolean>, when true, enables the
411 built-in version of git add -i. See 'add.interactive.useBuiltin' in
412 git-config(1).
413
414 GIT_TEST_INDEX_THREADS=<n> enables exercising the multi-threaded loading
415 of the index for the whole test suite by bypassing the default number of
416 cache entries and thread minimums. Setting this to 1 will make the
417 index loading single threaded.
418
419 GIT_TEST_MULTI_PACK_INDEX=<boolean>, when true, forces the multi-pack-
420 index to be written after every 'git repack' command, and overrides the
421 'core.multiPackIndex' setting to true.
422
423 GIT_TEST_SIDEBAND_ALL=<boolean>, when true, overrides the
424 'uploadpack.allowSidebandAll' setting to true, and when false, forces
425 fetch-pack to not request sideband-all (even if the server advertises
426 sideband-all).
427
428 GIT_TEST_DISALLOW_ABBREVIATED_OPTIONS=<boolean>, when true (which is
429 the default when running tests), errors out when an abbreviated option
430 is used.
431
432 GIT_TEST_DEFAULT_HASH=<hash-algo> specifies which hash algorithm to
433 use in the test scripts. Recognized values for <hash-algo> are "sha1"
434 and "sha256".
435
436 Naming Tests
437 ------------
438
439 The test files are named as:
440
441         tNNNN-commandname-details.sh
442
443 where N is a decimal digit.
444
445 First digit tells the family:
446
447         0 - the absolute basics and global stuff
448         1 - the basic commands concerning database
449         2 - the basic commands concerning the working tree
450         3 - the other basic commands (e.g. ls-files)
451         4 - the diff commands
452         5 - the pull and exporting commands
453         6 - the revision tree commands (even e.g. merge-base)
454         7 - the porcelainish commands concerning the working tree
455         8 - the porcelainish commands concerning forensics
456         9 - the git tools
457
458 Second digit tells the particular command we are testing.
459
460 Third digit (optionally) tells the particular switch or group of switches
461 we are testing.
462
463 If you create files under t/ directory (i.e. here) that is not
464 the top-level test script, never name the file to match the above
465 pattern.  The Makefile here considers all such files as the
466 top-level test script and tries to run all of them.  Care is
467 especially needed if you are creating a common test library
468 file, similar to test-lib.sh, because such a library file may
469 not be suitable for standalone execution.
470
471
472 Writing Tests
473 -------------
474
475 The test script is written as a shell script.  It should start
476 with the standard "#!/bin/sh", and an
477 assignment to variable 'test_description', like this:
478
479         #!/bin/sh
480
481         test_description='xxx test (option --frotz)
482
483         This test registers the following structure in the cache
484         and tries to run git-ls-files with option --frotz.'
485
486
487 Source 'test-lib.sh'
488 --------------------
489
490 After assigning test_description, the test script should source
491 test-lib.sh like this:
492
493         . ./test-lib.sh
494
495 This test harness library does the following things:
496
497  - If the script is invoked with command line argument --help
498    (or -h), it shows the test_description and exits.
499
500  - Creates an empty test directory with an empty .git/objects database
501    and chdir(2) into it.  This directory is 't/trash
502    directory.$test_name_without_dotsh', with t/ subject to change by
503    the --root option documented above, and a '.stress-<N>' suffix
504    appended by the --stress option.
505
506  - Defines standard test helper functions for your scripts to
507    use.  These functions are designed to make all scripts behave
508    consistently when command line arguments --verbose (or -v),
509    --debug (or -d), and --immediate (or -i) is given.
510
511 Do's & don'ts
512 -------------
513
514 Here are a few examples of things you probably should and shouldn't do
515 when writing tests.
516
517 Here are the "do's:"
518
519  - Put all code inside test_expect_success and other assertions.
520
521    Even code that isn't a test per se, but merely some setup code
522    should be inside a test assertion.
523
524  - Chain your test assertions
525
526    Write test code like this:
527
528         git merge foo &&
529         git push bar &&
530         test ...
531
532    Instead of:
533
534         git merge hla
535         git push gh
536         test ...
537
538    That way all of the commands in your tests will succeed or fail. If
539    you must ignore the return value of something, consider using a
540    helper function (e.g. use sane_unset instead of unset, in order
541    to avoid unportable return value for unsetting a variable that was
542    already unset), or prepending the command with test_might_fail or
543    test_must_fail.
544
545  - Check the test coverage for your tests. See the "Test coverage"
546    below.
547
548    Don't blindly follow test coverage metrics; if a new function you added
549    doesn't have any coverage, then you're probably doing something wrong,
550    but having 100% coverage doesn't necessarily mean that you tested
551    everything.
552
553    Tests that are likely to smoke out future regressions are better
554    than tests that just inflate the coverage metrics.
555
556  - When a test checks for an absolute path that a git command generated,
557    construct the expected value using $(pwd) rather than $PWD,
558    $TEST_DIRECTORY, or $TRASH_DIRECTORY. It makes a difference on
559    Windows, where the shell (MSYS bash) mangles absolute path names.
560    For details, see the commit message of 4114156ae9.
561
562  - Remember that inside the <script> part, the standard output and
563    standard error streams are discarded, and the test harness only
564    reports "ok" or "not ok" to the end user running the tests. Under
565    --verbose, they are shown to help debug the tests.
566
567  - Be careful when you loop
568
569    You may need to verify multiple things in a loop, but the
570    following does not work correctly:
571
572         test_expect_success 'test three things' '
573             for i in one two three
574             do
575                 test_something "$i"
576             done &&
577             test_something_else
578         '
579
580    Because the status of the loop itself is the exit status of the
581    test_something in the last round, the loop does not fail when
582    "test_something" for "one" or "two" fails.  This is not what you
583    want.
584
585    Instead, you can break out of the loop immediately when you see a
586    failure.  Because all test_expect_* snippets are executed inside
587    a function, "return 1" can be used to fail the test immediately
588    upon a failure:
589
590         test_expect_success 'test three things' '
591             for i in one two three
592             do
593                 test_something "$i" || return 1
594             done &&
595             test_something_else
596         '
597
598    Note that we still &&-chain the loop to propagate failures from
599    earlier commands.
600
601
602 And here are the "don'ts:"
603
604  - Don't exit() within a <script> part.
605
606    The harness will catch this as a programming error of the test.
607    Use test_done instead if you need to stop the tests early (see
608    "Skipping tests" below).
609
610  - Don't use '! git cmd' when you want to make sure the git command
611    exits with failure in a controlled way by calling "die()".  Instead,
612    use 'test_must_fail git cmd'.  This will signal a failure if git
613    dies in an unexpected way (e.g. segfault).
614
615    On the other hand, don't use test_must_fail for running regular
616    platform commands; just use '! cmd'.  We are not in the business
617    of verifying that the world given to us sanely works.
618
619  - Don't feed the output of a git command to a pipe, as in:
620
621      git -C repo ls-files |
622      xargs -n 1 basename |
623      grep foo
624
625    which will discard git's exit code and may mask a crash. In the
626    above example, all exit codes are ignored except grep's.
627
628    Instead, write the output of that command to a temporary
629    file with ">" or assign it to a variable with "x=$(git ...)" rather
630    than pipe it.
631
632  - Don't use command substitution in a way that discards git's exit
633    code. When assigning to a variable, the exit code is not discarded,
634    e.g.:
635
636      x=$(git cat-file -p $sha) &&
637      ...
638
639    is OK because a crash in "git cat-file" will cause the "&&" chain
640    to fail, but:
641
642      test "refs/heads/foo" = "$(git symbolic-ref HEAD)"
643
644    is not OK and a crash in git could go undetected.
645
646  - Don't use perl without spelling it as "$PERL_PATH". This is to help
647    our friends on Windows where the platform Perl often adds CR before
648    the end of line, and they bundle Git with a version of Perl that
649    does not do so, whose path is specified with $PERL_PATH. Note that we
650    provide a "perl" function which uses $PERL_PATH under the hood, so
651    you do not need to worry when simply running perl in the test scripts
652    (but you do, for example, on a shebang line or in a sub script
653    created via "write_script").
654
655  - Don't use sh without spelling it as "$SHELL_PATH", when the script
656    can be misinterpreted by broken platform shell (e.g. Solaris).
657
658  - Don't chdir around in tests.  It is not sufficient to chdir to
659    somewhere and then chdir back to the original location later in
660    the test, as any intermediate step can fail and abort the test,
661    causing the next test to start in an unexpected directory.  Do so
662    inside a subshell if necessary.
663
664  - Don't save and verify the standard error of compound commands, i.e.
665    group commands, subshells, and shell functions (except test helper
666    functions like 'test_must_fail') like this:
667
668      ( cd dir && git cmd ) 2>error &&
669      test_cmp expect error
670
671    When running the test with '-x' tracing, then the trace of commands
672    executed in the compound command will be included in standard error
673    as well, quite possibly throwing off the subsequent checks examining
674    the output.  Instead, save only the relevant git command's standard
675    error:
676
677      ( cd dir && git cmd 2>../error ) &&
678      test_cmp expect error
679
680  - Don't break the TAP output
681
682    The raw output from your test may be interpreted by a TAP harness. TAP
683    harnesses will ignore everything they don't know about, but don't step
684    on their toes in these areas:
685
686    - Don't print lines like "$x..$y" where $x and $y are integers.
687
688    - Don't print lines that begin with "ok" or "not ok".
689
690    TAP harnesses expect a line that begins with either "ok" and "not
691    ok" to signal a test passed or failed (and our harness already
692    produces such lines), so your script shouldn't emit such lines to
693    their output.
694
695    You can glean some further possible issues from the TAP grammar
696    (see https://metacpan.org/pod/TAP::Parser::Grammar#TAP-GRAMMAR)
697    but the best indication is to just run the tests with prove(1),
698    it'll complain if anything is amiss.
699
700
701 Skipping tests
702 --------------
703
704 If you need to skip tests you should do so by using the three-arg form
705 of the test_* functions (see the "Test harness library" section
706 below), e.g.:
707
708     test_expect_success PERL 'I need Perl' '
709         perl -e "hlagh() if unf_unf()"
710     '
711
712 The advantage of skipping tests like this is that platforms that don't
713 have the PERL and other optional dependencies get an indication of how
714 many tests they're missing.
715
716 If the test code is too hairy for that (i.e. does a lot of setup work
717 outside test assertions) you can also skip all remaining tests by
718 setting skip_all and immediately call test_done:
719
720         if ! test_have_prereq PERL
721         then
722             skip_all='skipping perl interface tests, perl not available'
723             test_done
724         fi
725
726 The string you give to skip_all will be used as an explanation for why
727 the test was skipped.
728
729 End with test_done
730 ------------------
731
732 Your script will be a sequence of tests, using helper functions
733 from the test harness library.  At the end of the script, call
734 'test_done'.
735
736
737 Test harness library
738 --------------------
739
740 There are a handful helper functions defined in the test harness
741 library for your script to use.
742
743  - test_expect_success [<prereq>] <message> <script>
744
745    Usually takes two strings as parameters, and evaluates the
746    <script>.  If it yields success, test is considered
747    successful.  <message> should state what it is testing.
748
749    Example:
750
751         test_expect_success \
752             'git-write-tree should be able to write an empty tree.' \
753             'tree=$(git-write-tree)'
754
755    If you supply three parameters the first will be taken to be a
756    prerequisite; see the test_set_prereq and test_have_prereq
757    documentation below:
758
759         test_expect_success TTY 'git --paginate rev-list uses a pager' \
760             ' ... '
761
762    You can also supply a comma-separated list of prerequisites, in the
763    rare case where your test depends on more than one:
764
765         test_expect_success PERL,PYTHON 'yo dawg' \
766             ' test $(perl -E 'print eval "1 +" . qx[python -c "print 2"]') == "4" '
767
768  - test_expect_failure [<prereq>] <message> <script>
769
770    This is NOT the opposite of test_expect_success, but is used
771    to mark a test that demonstrates a known breakage.  Unlike
772    the usual test_expect_success tests, which say "ok" on
773    success and "FAIL" on failure, this will say "FIXED" on
774    success and "still broken" on failure.  Failures from these
775    tests won't cause -i (immediate) to stop.
776
777    Like test_expect_success this function can optionally use a three
778    argument invocation with a prerequisite as the first argument.
779
780  - test_debug <script>
781
782    This takes a single argument, <script>, and evaluates it only
783    when the test script is started with --debug command line
784    argument.  This is primarily meant for use during the
785    development of a new test script.
786
787  - debug <git-command>
788
789    Run a git command inside a debugger. This is primarily meant for
790    use when debugging a failing test script.
791
792  - test_done
793
794    Your test script must have test_done at the end.  Its purpose
795    is to summarize successes and failures in the test script and
796    exit with an appropriate error code.
797
798  - test_tick
799
800    Make commit and tag names consistent by setting the author and
801    committer times to defined state.  Subsequent calls will
802    advance the times by a fixed amount.
803
804  - test_commit <message> [<filename> [<contents>]]
805
806    Creates a commit with the given message, committing the given
807    file with the given contents (default for both is to reuse the
808    message string), and adds a tag (again reusing the message
809    string as name).  Calls test_tick to make the SHA-1s
810    reproducible.
811
812  - test_merge <message> <commit-or-tag>
813
814    Merges the given rev using the given message.  Like test_commit,
815    creates a tag and calls test_tick before committing.
816
817  - test_set_prereq <prereq>
818
819    Set a test prerequisite to be used later with test_have_prereq. The
820    test-lib will set some prerequisites for you, see the
821    "Prerequisites" section below for a full list of these.
822
823    Others you can set yourself and use later with either
824    test_have_prereq directly, or the three argument invocation of
825    test_expect_success and test_expect_failure.
826
827  - test_have_prereq <prereq>
828
829    Check if we have a prerequisite previously set with test_set_prereq.
830    The most common way to use this explicitly (as opposed to the
831    implicit use when an argument is passed to test_expect_*) is to skip
832    all the tests at the start of the test script if we don't have some
833    essential prerequisite:
834
835         if ! test_have_prereq PERL
836         then
837             skip_all='skipping perl interface tests, perl not available'
838             test_done
839         fi
840
841  - test_external [<prereq>] <message> <external> <script>
842
843    Execute a <script> with an <external> interpreter (like perl). This
844    was added for tests like t9700-perl-git.sh which do most of their
845    work in an external test script.
846
847         test_external \
848             'GitwebCache::*FileCache*' \
849             perl "$TEST_DIRECTORY"/t9503/test_cache_interface.pl
850
851    If the test is outputting its own TAP you should set the
852    test_external_has_tap variable somewhere before calling the first
853    test_external* function. See t9700-perl-git.sh for an example.
854
855         # The external test will outputs its own plan
856         test_external_has_tap=1
857
858  - test_external_without_stderr [<prereq>] <message> <external> <script>
859
860    Like test_external but fail if there's any output on stderr,
861    instead of checking the exit code.
862
863         test_external_without_stderr \
864             'Perl API' \
865             perl "$TEST_DIRECTORY"/t9700/test.pl
866
867  - test_expect_code <exit-code> <command>
868
869    Run a command and ensure that it exits with the given exit code.
870    For example:
871
872         test_expect_success 'Merge with d/f conflicts' '
873                 test_expect_code 1 git merge "merge msg" B master
874         '
875
876  - test_must_fail [<options>] <git-command>
877
878    Run a git command and ensure it fails in a controlled way.  Use
879    this instead of "! <git-command>".  When git-command dies due to a
880    segfault, test_must_fail diagnoses it as an error; "! <git-command>"
881    treats it as just another expected failure, which would let such a
882    bug go unnoticed.
883
884    Accepts the following options:
885
886      ok=<signal-name>[,<...>]:
887        Don't treat an exit caused by the given signal as error.
888        Multiple signals can be specified as a comma separated list.
889        Currently recognized signal names are: sigpipe, success.
890        (Don't use 'success', use 'test_might_fail' instead.)
891
892  - test_might_fail [<options>] <git-command>
893
894    Similar to test_must_fail, but tolerate success, too.  Use this
895    instead of "<git-command> || :" to catch failures due to segv.
896
897    Accepts the same options as test_must_fail.
898
899  - test_cmp <expected> <actual>
900
901    Check whether the content of the <actual> file matches the
902    <expected> file.  This behaves like "cmp" but produces more
903    helpful output when the test is run with "-v" option.
904
905  - test_cmp_rev <expected> <actual>
906
907    Check whether the <expected> rev points to the same commit as the
908    <actual> rev.
909
910  - test_line_count (= | -lt | -ge | ...) <length> <file>
911
912    Check whether a file has the length it is expected to.
913
914  - test_path_is_file <path> [<diagnosis>]
915    test_path_is_dir <path> [<diagnosis>]
916    test_path_is_missing <path> [<diagnosis>]
917
918    Check if the named path is a file, if the named path is a
919    directory, or if the named path does not exist, respectively,
920    and fail otherwise, showing the <diagnosis> text.
921
922  - test_when_finished <script>
923
924    Prepend <script> to a list of commands to run to clean up
925    at the end of the current test.  If some clean-up command
926    fails, the test will not pass.
927
928    Example:
929
930         test_expect_success 'branch pointing to non-commit' '
931                 git rev-parse HEAD^{tree} >.git/refs/heads/invalid &&
932                 test_when_finished "git update-ref -d refs/heads/invalid" &&
933                 ...
934         '
935
936  - test_atexit <script>
937
938    Prepend <script> to a list of commands to run unconditionally to
939    clean up before the test script exits, e.g. to stop a daemon:
940
941         test_expect_success 'test git daemon' '
942                 git daemon &
943                 daemon_pid=$! &&
944                 test_atexit 'kill $daemon_pid' &&
945                 hello world
946         '
947
948    The commands will be executed before the trash directory is removed,
949    i.e. the atexit commands will still be able to access any pidfiles or
950    socket files.
951
952    Note that these commands will be run even when a test script run
953    with '--immediate' fails.  Be careful with your atexit commands to
954    minimize any changes to the failed state.
955
956  - test_write_lines <lines>
957
958    Write <lines> on standard output, one line per argument.
959    Useful to prepare multi-line files in a compact form.
960
961    Example:
962
963         test_write_lines a b c d e f g >foo
964
965    Is a more compact equivalent of:
966         cat >foo <<-EOF
967         a
968         b
969         c
970         d
971         e
972         f
973         g
974         EOF
975
976
977  - test_pause
978
979         This command is useful for writing and debugging tests and must be
980         removed before submitting. It halts the execution of the test and
981         spawns a shell in the trash directory. Exit the shell to continue
982         the test. Example:
983
984         test_expect_success 'test' '
985                 git do-something >actual &&
986                 test_pause &&
987                 test_cmp expected actual
988         '
989
990  - test_ln_s_add <path1> <path2>
991
992    This function helps systems whose filesystem does not support symbolic
993    links. Use it to add a symbolic link entry to the index when it is not
994    important that the file system entry is a symbolic link, i.e., instead
995    of the sequence
996
997         ln -s foo bar &&
998         git add bar
999
1000    Sometimes it is possible to split a test in a part that does not need
1001    the symbolic link in the file system and a part that does; then only
1002    the latter part need be protected by a SYMLINKS prerequisite (see below).
1003
1004  - test_oid_init
1005
1006    This function loads facts and useful object IDs related to the hash
1007    algorithm(s) in use from the files in t/oid-info.
1008
1009  - test_oid_cache
1010
1011    This function reads per-hash algorithm information from standard
1012    input (usually a heredoc) in the format described in
1013    t/oid-info/README.  This is useful for test-specific values, such as
1014    object IDs, which must vary based on the hash algorithm.
1015
1016    Certain fixed values, such as hash sizes and common placeholder
1017    object IDs, can be loaded with test_oid_init (described above).
1018
1019  - test_oid <key>
1020
1021    This function looks up a value for the hash algorithm in use, based
1022    on the key given.  The value must have been loaded using
1023    test_oid_init or test_oid_cache.  Providing an unknown key is an
1024    error.
1025
1026  - yes [<string>]
1027
1028    This is often seen in modern UNIX but some platforms lack it, so
1029    the test harness overrides the platform implementation with a
1030    more limited one.  Use this only when feeding a handful lines of
1031    output to the downstream---unlike the real version, it generates
1032    only up to 99 lines.
1033
1034  - test_bool_env <env-variable-name> <default-value>
1035
1036    Given the name of an environment variable with a bool value,
1037    normalize its value to a 0 (true) or 1 (false or empty string)
1038    return code.  Return with code corresponding to the given default
1039    value if the variable is unset.
1040    Abort the test script if either the value of the variable or the
1041    default are not valid bool values.
1042
1043
1044 Prerequisites
1045 -------------
1046
1047 These are the prerequisites that the test library predefines with
1048 test_have_prereq.
1049
1050 See the prereq argument to the test_* functions in the "Test harness
1051 library" section above and the "test_have_prereq" function for how to
1052 use these, and "test_set_prereq" for how to define your own.
1053
1054  - PYTHON
1055
1056    Git wasn't compiled with NO_PYTHON=YesPlease. Wrap any tests that
1057    need Python with this.
1058
1059  - PERL
1060
1061    Git wasn't compiled with NO_PERL=YesPlease.
1062
1063    Even without the PERL prerequisite, tests can assume there is a
1064    usable perl interpreter at $PERL_PATH, though it need not be
1065    particularly modern.
1066
1067  - POSIXPERM
1068
1069    The filesystem supports POSIX style permission bits.
1070
1071  - BSLASHPSPEC
1072
1073    Backslashes in pathspec are not directory separators. This is not
1074    set on Windows. See 6fd1106a for details.
1075
1076  - EXECKEEPSPID
1077
1078    The process retains the same pid across exec(2). See fb9a2bea for
1079    details.
1080
1081  - PIPE
1082
1083    The filesystem we're on supports creation of FIFOs (named pipes)
1084    via mkfifo(1).
1085
1086  - SYMLINKS
1087
1088    The filesystem we're on supports symbolic links. E.g. a FAT
1089    filesystem doesn't support these. See 704a3143 for details.
1090
1091  - SANITY
1092
1093    Test is not run by root user, and an attempt to write to an
1094    unwritable file is expected to fail correctly.
1095
1096  - PCRE
1097
1098    Git was compiled with support for PCRE. Wrap any tests
1099    that use git-grep --perl-regexp or git-grep -P in these.
1100
1101  - CASE_INSENSITIVE_FS
1102
1103    Test is run on a case insensitive file system.
1104
1105  - UTF8_NFD_TO_NFC
1106
1107    Test is run on a filesystem which converts decomposed utf-8 (nfd)
1108    to precomposed utf-8 (nfc).
1109
1110  - PTHREADS
1111
1112    Git wasn't compiled with NO_PTHREADS=YesPlease.
1113
1114 Tips for Writing Tests
1115 ----------------------
1116
1117 As with any programming projects, existing programs are the best
1118 source of the information.  However, do _not_ emulate
1119 t0000-basic.sh when writing your tests.  The test is special in
1120 that it tries to validate the very core of Git.  For example, it
1121 knows that there will be 256 subdirectories under .git/objects/,
1122 and it knows that the object ID of an empty tree is a certain
1123 40-byte string.  This is deliberately done so in t0000-basic.sh
1124 because the things the very basic core test tries to achieve is
1125 to serve as a basis for people who are changing the Git internals
1126 drastically.  For these people, after making certain changes,
1127 not seeing failures from the basic test _is_ a failure.  And
1128 such drastic changes to the core Git that even changes these
1129 otherwise supposedly stable object IDs should be accompanied by
1130 an update to t0000-basic.sh.
1131
1132 However, other tests that simply rely on basic parts of the core
1133 Git working properly should not have that level of intimate
1134 knowledge of the core Git internals.  If all the test scripts
1135 hardcoded the object IDs like t0000-basic.sh does, that defeats
1136 the purpose of t0000-basic.sh, which is to isolate that level of
1137 validation in one place.  Your test also ends up needing
1138 updating when such a change to the internal happens, so do _not_
1139 do it and leave the low level of validation to t0000-basic.sh.
1140
1141 Test coverage
1142 -------------
1143
1144 You can use the coverage tests to find code paths that are not being
1145 used or properly exercised yet.
1146
1147 To do that, run the coverage target at the top-level (not in the t/
1148 directory):
1149
1150     make coverage
1151
1152 That'll compile Git with GCC's coverage arguments, and generate a test
1153 report with gcov after the tests finish. Running the coverage tests
1154 can take a while, since running the tests in parallel is incompatible
1155 with GCC's coverage mode.
1156
1157 After the tests have run you can generate a list of untested
1158 functions:
1159
1160     make coverage-untested-functions
1161
1162 You can also generate a detailed per-file HTML report using the
1163 Devel::Cover module. To install it do:
1164
1165    # On Debian or Ubuntu:
1166    sudo aptitude install libdevel-cover-perl
1167
1168    # From the CPAN with cpanminus
1169    curl -L http://cpanmin.us | perl - --sudo --self-upgrade
1170    cpanm --sudo Devel::Cover
1171
1172 Then, at the top-level:
1173
1174     make cover_db_html
1175
1176 That'll generate a detailed cover report in the "cover_db_html"
1177 directory, which you can then copy to a webserver, or inspect locally
1178 in a browser.