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