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