Merge branch 'jc/topo-author-date-sort'
[git/jrn.git] / t / README
blobec5246886132f919ec4b6b05bfedd65eb2011690
1 Core GIT Tests
2 ==============
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.
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.
14 Running Tests
15 -------------
17 The easiest way to run tests is to say "make".  This runs all
18 the tests.
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
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):
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... )===
47 prove and other harnesses come with a lot of useful options. The
48 --state option in particular is very useful:
50     # Repeat until no more failures
51     $ prove -j 15 --state=failed,save ./t[0-9]*.sh
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.
57     $ make DEFAULT_TEST_TARGET=prove GIT_PROVE_OPTS='--timer --jobs 16' test
59 You can also run each test individually from command line, like this:
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
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".
74 --verbose::
75         This makes the test more verbose.  Specifically, the
76         command being run and their output if any are also
77         output.
79 --debug::
80         This may help the person who is developing a new test.
81         It causes the command defined with test_debug to run.
82         The "trash" directory (used to store all temporary data
83         during testing) is not deleted even if there are no
84         failed tests so that you can inspect its contents after
85         the test finished.
87 --immediate::
88         This causes the test to immediately exit upon the first
89         failed test. Cleanup commands requested with
90         test_when_finished are not executed if the test failed,
91         in order to keep the state for inspection by the tester
92         to diagnose the bug.
94 --long-tests::
95         This causes additional long-running tests to be run (where
96         available), for more exhaustive testing.
98 --valgrind=<tool>::
99         Execute all Git binaries under valgrind tool <tool> and exit
100         with status 126 on errors (just like regular tests, this will
101         only stop the test script when running under -i).
103         Since it makes no sense to run the tests with --valgrind and
104         not see any output, this option implies --verbose.  For
105         convenience, it also implies --tee.
107         <tool> defaults to 'memcheck', just like valgrind itself.
108         Other particularly useful choices include 'helgrind' and
109         'drd', but you may use any tool recognized by your valgrind
110         installation.
112         As a special case, <tool> can be 'memcheck-fast', which uses
113         memcheck but disables --track-origins.  Use this if you are
114         running tests in bulk, to see if there are _any_ memory
115         issues.
117         Note that memcheck is run with the option --leak-check=no,
118         as the git process is short-lived and some errors are not
119         interesting. In order to run a single command under the same
120         conditions manually, you should set GIT_VALGRIND to point to
121         the 't/valgrind/' directory and use the commands under
122         't/valgrind/bin/'.
124 --tee::
125         In addition to printing the test output to the terminal,
126         write it to files named 't/test-results/$TEST_NAME.out'.
127         As the names depend on the tests' file names, it is safe to
128         run the tests with this option in parallel.
130 --with-dashes::
131         By default tests are run without dashed forms of
132         commands (like git-commit) in the PATH (it only uses
133         wrappers from ../bin-wrappers).  Use this option to include
134         the build directory (..) in the PATH, which contains all
135         the dashed forms of commands.  This option is currently
136         implied by other options like --valgrind and
137         GIT_TEST_INSTALLED.
139 --root=<directory>::
140         Create "trash" directories used to store all temporary data during
141         testing under <directory>, instead of the t/ directory.
142         Using this option with a RAM-based filesystem (such as tmpfs)
143         can massively speed up the test suite.
145 You can also set the GIT_TEST_INSTALLED environment variable to
146 the bindir of an existing git installation to test that installation.
147 You still need to have built this git sandbox, from which various
148 test-* support programs, templates, and perl libraries are used.
149 If your installed git is incomplete, it will silently test parts of
150 your built version instead.
152 When using GIT_TEST_INSTALLED, you can also set GIT_TEST_EXEC_PATH to
153 override the location of the dashed-form subcommands (what
154 GIT_EXEC_PATH would be used for during normal operation).
155 GIT_TEST_EXEC_PATH defaults to `$GIT_TEST_INSTALLED/git --exec-path`.
158 Skipping Tests
159 --------------
161 In some environments, certain tests have no way of succeeding
162 due to platform limitation, such as lack of 'unzip' program, or
163 filesystem that do not allow arbitrary sequence of non-NUL bytes
164 as pathnames.
166 You should be able to say something like
168     $ GIT_SKIP_TESTS=t9200.8 sh ./t9200-git-cvsexport-commit.sh
170 and even:
172     $ GIT_SKIP_TESTS='t[0-4]??? t91?? t9200.8' make
174 to omit such tests.  The value of the environment variable is a
175 SP separated list of patterns that tells which tests to skip,
176 and either can match the "t[0-9]{4}" part to skip the whole
177 test, or t[0-9]{4} followed by ".$number" to say which
178 particular test to skip.
180 Note that some tests in the existing test suite rely on previous
181 test item, so you cannot arbitrarily disable one and expect the
182 remainder of test to check what the test originally was intended
183 to check.
186 Naming Tests
187 ------------
189 The test files are named as:
191         tNNNN-commandname-details.sh
193 where N is a decimal digit.
195 First digit tells the family:
197         0 - the absolute basics and global stuff
198         1 - the basic commands concerning database
199         2 - the basic commands concerning the working tree
200         3 - the other basic commands (e.g. ls-files)
201         4 - the diff commands
202         5 - the pull and exporting commands
203         6 - the revision tree commands (even e.g. merge-base)
204         7 - the porcelainish commands concerning the working tree
205         8 - the porcelainish commands concerning forensics
206         9 - the git tools
208 Second digit tells the particular command we are testing.
210 Third digit (optionally) tells the particular switch or group of switches
211 we are testing.
213 If you create files under t/ directory (i.e. here) that is not
214 the top-level test script, never name the file to match the above
215 pattern.  The Makefile here considers all such files as the
216 top-level test script and tries to run all of them.  Care is
217 especially needed if you are creating a common test library
218 file, similar to test-lib.sh, because such a library file may
219 not be suitable for standalone execution.
222 Writing Tests
223 -------------
225 The test script is written as a shell script.  It should start
226 with the standard "#!/bin/sh" with copyright notices, and an
227 assignment to variable 'test_description', like this:
229         #!/bin/sh
230         #
231         # Copyright (c) 2005 Junio C Hamano
232         #
234         test_description='xxx test (option --frotz)
236         This test registers the following structure in the cache
237         and tries to run git-ls-files with option --frotz.'
240 Source 'test-lib.sh'
241 --------------------
243 After assigning test_description, the test script should source
244 test-lib.sh like this:
246         . ./test-lib.sh
248 This test harness library does the following things:
250  - If the script is invoked with command line argument --help
251    (or -h), it shows the test_description and exits.
253  - Creates an empty test directory with an empty .git/objects database
254    and chdir(2) into it.  This directory is 't/trash
255    directory.$test_name_without_dotsh', with t/ subject to change by
256    the --root option documented above.
258  - Defines standard test helper functions for your scripts to
259    use.  These functions are designed to make all scripts behave
260    consistently when command line arguments --verbose (or -v),
261    --debug (or -d), and --immediate (or -i) is given.
263 Do's, don'ts & things to keep in mind
264 -------------------------------------
266 Here are a few examples of things you probably should and shouldn't do
267 when writing tests.
271  - Put all code inside test_expect_success and other assertions.
273    Even code that isn't a test per se, but merely some setup code
274    should be inside a test assertion.
276  - Chain your test assertions
278    Write test code like this:
280         git merge foo &&
281         git push bar &&
282         test ...
284    Instead of:
286         git merge hla
287         git push gh
288         test ...
290    That way all of the commands in your tests will succeed or fail. If
291    you must ignore the return value of something, consider using a
292    helper function (e.g. use sane_unset instead of unset, in order
293    to avoid unportable return value for unsetting a variable that was
294    already unset), or prepending the command with test_might_fail or
295    test_must_fail.
297  - Check the test coverage for your tests. See the "Test coverage"
298    below.
300    Don't blindly follow test coverage metrics; if a new function you added
301    doesn't have any coverage, then you're probably doing something wrong,
302    but having 100% coverage doesn't necessarily mean that you tested
303    everything.
305    Tests that are likely to smoke out future regressions are better
306    than tests that just inflate the coverage metrics.
308  - When a test checks for an absolute path that a git command generated,
309    construct the expected value using $(pwd) rather than $PWD,
310    $TEST_DIRECTORY, or $TRASH_DIRECTORY. It makes a difference on
311    Windows, where the shell (MSYS bash) mangles absolute path names.
312    For details, see the commit message of 4114156ae9.
314 Don't:
316  - exit() within a <script> part.
318    The harness will catch this as a programming error of the test.
319    Use test_done instead if you need to stop the tests early (see
320    "Skipping tests" below).
322  - use '! git cmd' when you want to make sure the git command exits
323    with failure in a controlled way by calling "die()".  Instead,
324    use 'test_must_fail git cmd'.  This will signal a failure if git
325    dies in an unexpected way (e.g. segfault).
327    On the other hand, don't use test_must_fail for running regular
328    platform commands; just use '! cmd'.
330  - use perl without spelling it as "$PERL_PATH". This is to help our
331    friends on Windows where the platform Perl often adds CR before
332    the end of line, and they bundle Git with a version of Perl that
333    does not do so, whose path is specified with $PERL_PATH.
335  - use sh without spelling it as "$SHELL_PATH", when the script can
336    be misinterpreted by broken platform shell (e.g. Solaris).
338  - chdir around in tests.  It is not sufficient to chdir to
339    somewhere and then chdir back to the original location later in
340    the test, as any intermediate step can fail and abort the test,
341    causing the next test to start in an unexpected directory.  Do so
342    inside a subshell if necessary.
344  - Break the TAP output
346    The raw output from your test may be interpreted by a TAP harness. TAP
347    harnesses will ignore everything they don't know about, but don't step
348    on their toes in these areas:
350    - Don't print lines like "$x..$y" where $x and $y are integers.
352    - Don't print lines that begin with "ok" or "not ok".
354    TAP harnesses expect a line that begins with either "ok" and "not
355    ok" to signal a test passed or failed (and our harness already
356    produces such lines), so your script shouldn't emit such lines to
357    their output.
359    You can glean some further possible issues from the TAP grammar
360    (see http://search.cpan.org/perldoc?TAP::Parser::Grammar#TAP_Grammar)
361    but the best indication is to just run the tests with prove(1),
362    it'll complain if anything is amiss.
364 Keep in mind:
366  - Inside <script> part, the standard output and standard error
367    streams are discarded, and the test harness only reports "ok" or
368    "not ok" to the end user running the tests. Under --verbose, they
369    are shown to help debugging the tests.
372 Skipping tests
373 --------------
375 If you need to skip tests you should do so by using the three-arg form
376 of the test_* functions (see the "Test harness library" section
377 below), e.g.:
379     test_expect_success PERL 'I need Perl' '
380         "$PERL_PATH" -e "hlagh() if unf_unf()"
381     '
383 The advantage of skipping tests like this is that platforms that don't
384 have the PERL and other optional dependencies get an indication of how
385 many tests they're missing.
387 If the test code is too hairy for that (i.e. does a lot of setup work
388 outside test assertions) you can also skip all remaining tests by
389 setting skip_all and immediately call test_done:
391         if ! test_have_prereq PERL
392         then
393             skip_all='skipping perl interface tests, perl not available'
394             test_done
395         fi
397 The string you give to skip_all will be used as an explanation for why
398 the test was skipped.
400 End with test_done
401 ------------------
403 Your script will be a sequence of tests, using helper functions
404 from the test harness library.  At the end of the script, call
405 'test_done'.
408 Test harness library
409 --------------------
411 There are a handful helper functions defined in the test harness
412 library for your script to use.
414  - test_expect_success [<prereq>] <message> <script>
416    Usually takes two strings as parameters, and evaluates the
417    <script>.  If it yields success, test is considered
418    successful.  <message> should state what it is testing.
420    Example:
422         test_expect_success \
423             'git-write-tree should be able to write an empty tree.' \
424             'tree=$(git-write-tree)'
426    If you supply three parameters the first will be taken to be a
427    prerequisite; see the test_set_prereq and test_have_prereq
428    documentation below:
430         test_expect_success TTY 'git --paginate rev-list uses a pager' \
431             ' ... '
433    You can also supply a comma-separated list of prerequisites, in the
434    rare case where your test depends on more than one:
436         test_expect_success PERL,PYTHON 'yo dawg' \
437             ' test $(perl -E 'print eval "1 +" . qx[python -c "print 2"]') == "4" '
439  - test_expect_failure [<prereq>] <message> <script>
441    This is NOT the opposite of test_expect_success, but is used
442    to mark a test that demonstrates a known breakage.  Unlike
443    the usual test_expect_success tests, which say "ok" on
444    success and "FAIL" on failure, this will say "FIXED" on
445    success and "still broken" on failure.  Failures from these
446    tests won't cause -i (immediate) to stop.
448    Like test_expect_success this function can optionally use a three
449    argument invocation with a prerequisite as the first argument.
451  - test_debug <script>
453    This takes a single argument, <script>, and evaluates it only
454    when the test script is started with --debug command line
455    argument.  This is primarily meant for use during the
456    development of a new test script.
458  - test_done
460    Your test script must have test_done at the end.  Its purpose
461    is to summarize successes and failures in the test script and
462    exit with an appropriate error code.
464  - test_tick
466    Make commit and tag names consistent by setting the author and
467    committer times to defined state.  Subsequent calls will
468    advance the times by a fixed amount.
470  - test_commit <message> [<filename> [<contents>]]
472    Creates a commit with the given message, committing the given
473    file with the given contents (default for both is to reuse the
474    message string), and adds a tag (again reusing the message
475    string as name).  Calls test_tick to make the SHA-1s
476    reproducible.
478  - test_merge <message> <commit-or-tag>
480    Merges the given rev using the given message.  Like test_commit,
481    creates a tag and calls test_tick before committing.
483  - test_set_prereq <prereq>
485    Set a test prerequisite to be used later with test_have_prereq. The
486    test-lib will set some prerequisites for you, see the
487    "Prerequisites" section below for a full list of these.
489    Others you can set yourself and use later with either
490    test_have_prereq directly, or the three argument invocation of
491    test_expect_success and test_expect_failure.
493  - test_have_prereq <prereq>
495    Check if we have a prerequisite previously set with
496    test_set_prereq. The most common use of this directly is to skip
497    all the tests if we don't have some essential prerequisite:
499         if ! test_have_prereq PERL
500         then
501             skip_all='skipping perl interface tests, perl not available'
502             test_done
503         fi
505  - test_external [<prereq>] <message> <external> <script>
507    Execute a <script> with an <external> interpreter (like perl). This
508    was added for tests like t9700-perl-git.sh which do most of their
509    work in an external test script.
511         test_external \
512             'GitwebCache::*FileCache*' \
513             "$PERL_PATH" "$TEST_DIRECTORY"/t9503/test_cache_interface.pl
515    If the test is outputting its own TAP you should set the
516    test_external_has_tap variable somewhere before calling the first
517    test_external* function. See t9700-perl-git.sh for an example.
519         # The external test will outputs its own plan
520         test_external_has_tap=1
522  - test_external_without_stderr [<prereq>] <message> <external> <script>
524    Like test_external but fail if there's any output on stderr,
525    instead of checking the exit code.
527         test_external_without_stderr \
528             'Perl API' \
529             "$PERL_PATH" "$TEST_DIRECTORY"/t9700/test.pl
531  - test_expect_code <exit-code> <command>
533    Run a command and ensure that it exits with the given exit code.
534    For example:
536         test_expect_success 'Merge with d/f conflicts' '
537                 test_expect_code 1 git merge "merge msg" B master
538         '
540  - test_must_fail <git-command>
542    Run a git command and ensure it fails in a controlled way.  Use
543    this instead of "! <git-command>".  When git-command dies due to a
544    segfault, test_must_fail diagnoses it as an error; "! <git-command>"
545    treats it as just another expected failure, which would let such a
546    bug go unnoticed.
548  - test_might_fail <git-command>
550    Similar to test_must_fail, but tolerate success, too.  Use this
551    instead of "<git-command> || :" to catch failures due to segv.
553  - test_cmp <expected> <actual>
555    Check whether the content of the <actual> file matches the
556    <expected> file.  This behaves like "cmp" but produces more
557    helpful output when the test is run with "-v" option.
559  - test_line_count (= | -lt | -ge | ...) <length> <file>
561    Check whether a file has the length it is expected to.
563  - test_path_is_file <path> [<diagnosis>]
564    test_path_is_dir <path> [<diagnosis>]
565    test_path_is_missing <path> [<diagnosis>]
567    Check if the named path is a file, if the named path is a
568    directory, or if the named path does not exist, respectively,
569    and fail otherwise, showing the <diagnosis> text.
571  - test_when_finished <script>
573    Prepend <script> to a list of commands to run to clean up
574    at the end of the current test.  If some clean-up command
575    fails, the test will not pass.
577    Example:
579         test_expect_success 'branch pointing to non-commit' '
580                 git rev-parse HEAD^{tree} >.git/refs/heads/invalid &&
581                 test_when_finished "git update-ref -d refs/heads/invalid" &&
582                 ...
583         '
585  - test_pause
587         This command is useful for writing and debugging tests and must be
588         removed before submitting. It halts the execution of the test and
589         spawns a shell in the trash directory. Exit the shell to continue
590         the test. Example:
592         test_expect_success 'test' '
593                 git do-something >actual &&
594                 test_pause &&
595                 test_cmp expected actual
596         '
598  - test_ln_s_add <path1> <path2>
600    This function helps systems whose filesystem does not support symbolic
601    links. Use it to add a symbolic link entry to the index when it is not
602    important that the file system entry is a symbolic link, i.e., instead
603    of the sequence
605         ln -s foo bar &&
606         git add bar
608    Sometimes it is possible to split a test in a part that does not need
609    the symbolic link in the file system and a part that does; then only
610    the latter part need be protected by a SYMLINKS prerequisite (see below).
612 Prerequisites
613 -------------
615 These are the prerequisites that the test library predefines with
616 test_have_prereq.
618 See the prereq argument to the test_* functions in the "Test harness
619 library" section above and the "test_have_prereq" function for how to
620 use these, and "test_set_prereq" for how to define your own.
622  - PERL & PYTHON
624    Git wasn't compiled with NO_PERL=YesPlease or
625    NO_PYTHON=YesPlease. Wrap any tests that need Perl or Python in
626    these.
628  - POSIXPERM
630    The filesystem supports POSIX style permission bits.
632  - BSLASHPSPEC
634    Backslashes in pathspec are not directory separators. This is not
635    set on Windows. See 6fd1106a for details.
637  - EXECKEEPSPID
639    The process retains the same pid across exec(2). See fb9a2bea for
640    details.
642  - PIPE
644    The filesystem we're on supports creation of FIFOs (named pipes)
645    via mkfifo(1).
647  - SYMLINKS
649    The filesystem we're on supports symbolic links. E.g. a FAT
650    filesystem doesn't support these. See 704a3143 for details.
652  - SANITY
654    Test is not run by root user, and an attempt to write to an
655    unwritable file is expected to fail correctly.
657  - LIBPCRE
659    Git was compiled with USE_LIBPCRE=YesPlease. Wrap any tests
660    that use git-grep --perl-regexp or git-grep -P in these.
662  - CASE_INSENSITIVE_FS
664    Test is run on a case insensitive file system.
666  - UTF8_NFD_TO_NFC
668    Test is run on a filesystem which converts decomposed utf-8 (nfd)
669    to precomposed utf-8 (nfc).
671 Tips for Writing Tests
672 ----------------------
674 As with any programming projects, existing programs are the best
675 source of the information.  However, do _not_ emulate
676 t0000-basic.sh when writing your tests.  The test is special in
677 that it tries to validate the very core of GIT.  For example, it
678 knows that there will be 256 subdirectories under .git/objects/,
679 and it knows that the object ID of an empty tree is a certain
680 40-byte string.  This is deliberately done so in t0000-basic.sh
681 because the things the very basic core test tries to achieve is
682 to serve as a basis for people who are changing the GIT internal
683 drastically.  For these people, after making certain changes,
684 not seeing failures from the basic test _is_ a failure.  And
685 such drastic changes to the core GIT that even changes these
686 otherwise supposedly stable object IDs should be accompanied by
687 an update to t0000-basic.sh.
689 However, other tests that simply rely on basic parts of the core
690 GIT working properly should not have that level of intimate
691 knowledge of the core GIT internals.  If all the test scripts
692 hardcoded the object IDs like t0000-basic.sh does, that defeats
693 the purpose of t0000-basic.sh, which is to isolate that level of
694 validation in one place.  Your test also ends up needing
695 updating when such a change to the internal happens, so do _not_
696 do it and leave the low level of validation to t0000-basic.sh.
698 Test coverage
699 -------------
701 You can use the coverage tests to find code paths that are not being
702 used or properly exercised yet.
704 To do that, run the coverage target at the top-level (not in the t/
705 directory):
707     make coverage
709 That'll compile Git with GCC's coverage arguments, and generate a test
710 report with gcov after the tests finish. Running the coverage tests
711 can take a while, since running the tests in parallel is incompatible
712 with GCC's coverage mode.
714 After the tests have run you can generate a list of untested
715 functions:
717     make coverage-untested-functions
719 You can also generate a detailed per-file HTML report using the
720 Devel::Cover module. To install it do:
722    # On Debian or Ubuntu:
723    sudo aptitude install libdevel-cover-perl
725    # From the CPAN with cpanminus
726    curl -L http://cpanmin.us | perl - --sudo --self-upgrade
727    cpanm --sudo Devel::Cover
729 Then, at the top-level:
731     make cover_db_html
733 That'll generate a detailed cover report in the "cover_db_html"
734 directory, which you can then copy to a webserver, or inspect locally
735 in a browser.