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