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