vcs-svn: read instructions from deltas
[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 --verbose::
75         This makes the test more verbose.  Specifically, the
76         command being run and their output if any are also
77         output.
78
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
83 --immediate::
84         This causes the test to immediately exit upon the first
85         failed test.
86
87 --long-tests::
88         This causes additional long-running tests to be run (where
89         available), for more exhaustive testing.
90
91 --valgrind::
92         Execute all Git binaries with valgrind and exit with status
93         126 on errors (just like regular tests, this will only stop
94         the test script when running under -i).  Valgrind errors
95         go to stderr, so you might want to pass the -v option, too.
96
97         Since it makes no sense to run the tests with --valgrind and
98         not see any output, this option implies --verbose.  For
99         convenience, it also implies --tee.
100
101 --tee::
102         In addition to printing the test output to the terminal,
103         write it to files named 't/test-results/$TEST_NAME.out'.
104         As the names depend on the tests' file names, it is safe to
105         run the tests with this option in parallel.
106
107 --with-dashes::
108         By default tests are run without dashed forms of
109         commands (like git-commit) in the PATH (it only uses
110         wrappers from ../bin-wrappers).  Use this option to include
111         the build directory (..) in the PATH, which contains all
112         the dashed forms of commands.  This option is currently
113         implied by other options like --valgrind and
114         GIT_TEST_INSTALLED.
115
116 --root=<directory>::
117         Create "trash" directories used to store all temporary data during
118         testing under <directory>, instead of the t/ directory.
119         Using this option with a RAM-based filesystem (such as tmpfs)
120         can massively speed up the test suite.
121
122 You can also set the GIT_TEST_INSTALLED environment variable to
123 the bindir of an existing git installation to test that installation.
124 You still need to have built this git sandbox, from which various
125 test-* support programs, templates, and perl libraries are used.
126 If your installed git is incomplete, it will silently test parts of
127 your built version instead.
128
129 When using GIT_TEST_INSTALLED, you can also set GIT_TEST_EXEC_PATH to
130 override the location of the dashed-form subcommands (what
131 GIT_EXEC_PATH would be used for during normal operation).
132 GIT_TEST_EXEC_PATH defaults to `$GIT_TEST_INSTALLED/git --exec-path`.
133
134
135 Skipping Tests
136 --------------
137
138 In some environments, certain tests have no way of succeeding
139 due to platform limitation, such as lack of 'unzip' program, or
140 filesystem that do not allow arbitrary sequence of non-NUL bytes
141 as pathnames.
142
143 You should be able to say something like
144
145     $ GIT_SKIP_TESTS=t9200.8 sh ./t9200-git-cvsexport-commit.sh
146
147 and even:
148
149     $ GIT_SKIP_TESTS='t[0-4]??? t91?? t9200.8' make
150
151 to omit such tests.  The value of the environment variable is a
152 SP separated list of patterns that tells which tests to skip,
153 and either can match the "t[0-9]{4}" part to skip the whole
154 test, or t[0-9]{4} followed by ".$number" to say which
155 particular test to skip.
156
157 Note that some tests in the existing test suite rely on previous
158 test item, so you cannot arbitrarily disable one and expect the
159 remainder of test to check what the test originally was intended
160 to check.
161
162
163 Naming Tests
164 ------------
165
166 The test files are named as:
167
168         tNNNN-commandname-details.sh
169
170 where N is a decimal digit.
171
172 First digit tells the family:
173
174         0 - the absolute basics and global stuff
175         1 - the basic commands concerning database
176         2 - the basic commands concerning the working tree
177         3 - the other basic commands (e.g. ls-files)
178         4 - the diff commands
179         5 - the pull and exporting commands
180         6 - the revision tree commands (even e.g. merge-base)
181         7 - the porcelainish commands concerning the working tree
182         8 - the porcelainish commands concerning forensics
183         9 - the git tools
184
185 Second digit tells the particular command we are testing.
186
187 Third digit (optionally) tells the particular switch or group of switches
188 we are testing.
189
190 If you create files under t/ directory (i.e. here) that is not
191 the top-level test script, never name the file to match the above
192 pattern.  The Makefile here considers all such files as the
193 top-level test script and tries to run all of them.  A care is
194 especially needed if you are creating a common test library
195 file, similar to test-lib.sh, because such a library file may
196 not be suitable for standalone execution.
197
198
199 Writing Tests
200 -------------
201
202 The test script is written as a shell script.  It should start
203 with the standard "#!/bin/sh" with copyright notices, and an
204 assignment to variable 'test_description', like this:
205
206         #!/bin/sh
207         #
208         # Copyright (c) 2005 Junio C Hamano
209         #
210
211         test_description='xxx test (option --frotz)
212
213         This test registers the following structure in the cache
214         and tries to run git-ls-files with option --frotz.'
215
216
217 Source 'test-lib.sh'
218 --------------------
219
220 After assigning test_description, the test script should source
221 test-lib.sh like this:
222
223         . ./test-lib.sh
224
225 This test harness library does the following things:
226
227  - If the script is invoked with command line argument --help
228    (or -h), it shows the test_description and exits.
229
230  - Creates an empty test directory with an empty .git/objects database
231    and chdir(2) into it.  This directory is 't/trash
232    directory.$test_name_without_dotsh', with t/ subject to change by
233    the --root option documented above.
234
235  - Defines standard test helper functions for your scripts to
236    use.  These functions are designed to make all scripts behave
237    consistently when command line arguments --verbose (or -v),
238    --debug (or -d), and --immediate (or -i) is given.
239
240 Do's, don'ts & things to keep in mind
241 -------------------------------------
242
243 Here are a few examples of things you probably should and shouldn't do
244 when writing tests.
245
246 Do:
247
248  - Put all code inside test_expect_success and other assertions.
249
250    Even code that isn't a test per se, but merely some setup code
251    should be inside a test assertion.
252
253  - Chain your test assertions
254
255    Write test code like this:
256
257         git merge foo &&
258         git push bar &&
259         test ...
260
261    Instead of:
262
263         git merge hla
264         git push gh
265         test ...
266
267    That way all of the commands in your tests will succeed or fail. If
268    you must ignore the return value of something, consider using a
269    helper function (e.g. use sane_unset instead of unset, in order
270    to avoid unportable return value for unsetting a variable that was
271    already unset), or prepending the command with test_might_fail or
272    test_must_fail.
273
274  - Check the test coverage for your tests. See the "Test coverage"
275    below.
276
277    Don't blindly follow test coverage metrics, they're a good way to
278    spot if you've missed something. If a new function you added
279    doesn't have any coverage you're probably doing something wrong,
280    but having 100% coverage doesn't necessarily mean that you tested
281    everything.
282
283    Tests that are likely to smoke out future regressions are better
284    than tests that just inflate the coverage metrics.
285
286  - When a test checks for an absolute path that a git command generated,
287    construct the expected value using $(pwd) rather than $PWD,
288    $TEST_DIRECTORY, or $TRASH_DIRECTORY. It makes a difference on
289    Windows, where the shell (MSYS bash) mangles absolute path names.
290    For details, see the commit message of 4114156ae9.
291
292 Don't:
293
294  - exit() within a <script> part.
295
296    The harness will catch this as a programming error of the test.
297    Use test_done instead if you need to stop the tests early (see
298    "Skipping tests" below).
299
300  - Break the TAP output
301
302    The raw output from your test may be interpreted by a TAP harness. TAP
303    harnesses will ignore everything they don't know about, but don't step
304    on their toes in these areas:
305
306    - Don't print lines like "$x..$y" where $x and $y are integers.
307
308    - Don't print lines that begin with "ok" or "not ok".
309
310    TAP harnesses expect a line that begins with either "ok" and "not
311    ok" to signal a test passed or failed (and our harness already
312    produces such lines), so your script shouldn't emit such lines to
313    their output.
314
315    You can glean some further possible issues from the TAP grammar
316    (see http://search.cpan.org/perldoc?TAP::Parser::Grammar#TAP_Grammar)
317    but the best indication is to just run the tests with prove(1),
318    it'll complain if anything is amiss.
319
320 Keep in mind:
321
322  - Inside <script> part, the standard output and standard error
323    streams are discarded, and the test harness only reports "ok" or
324    "not ok" to the end user running the tests. Under --verbose, they
325    are shown to help debugging the tests.
326
327
328 Skipping tests
329 --------------
330
331 If you need to skip tests you should do so be using the three-arg form
332 of the test_* functions (see the "Test harness library" section
333 below), e.g.:
334
335     test_expect_success PERL 'I need Perl' "
336         '$PERL_PATH' -e 'hlagh() if unf_unf()'
337     "
338
339 The advantage of skipping tests like this is that platforms that don't
340 have the PERL and other optional dependencies get an indication of how
341 many tests they're missing.
342
343 If the test code is too hairy for that (i.e. does a lot of setup work
344 outside test assertions) you can also skip all remaining tests by
345 setting skip_all and immediately call test_done:
346
347         if ! test_have_prereq PERL
348         then
349             skip_all='skipping perl interface tests, perl not available'
350             test_done
351         fi
352
353 The string you give to skip_all will be used as an explanation for why
354 the test was skipped.
355
356 End with test_done
357 ------------------
358
359 Your script will be a sequence of tests, using helper functions
360 from the test harness library.  At the end of the script, call
361 'test_done'.
362
363
364 Test harness library
365 --------------------
366
367 There are a handful helper functions defined in the test harness
368 library for your script to use.
369
370  - test_expect_success [<prereq>] <message> <script>
371
372    Usually takes two strings as parameter, and evaluates the
373    <script>.  If it yields success, test is considered
374    successful.  <message> should state what it is testing.
375
376    Example:
377
378         test_expect_success \
379             'git-write-tree should be able to write an empty tree.' \
380             'tree=$(git-write-tree)'
381
382    If you supply three parameters the first will be taken to be a
383    prerequisite, see the test_set_prereq and test_have_prereq
384    documentation below:
385
386         test_expect_success TTY 'git --paginate rev-list uses a pager' \
387             ' ... '
388
389    You can also supply a comma-separated list of prerequisites, in the
390    rare case where your test depends on more than one:
391
392         test_expect_success PERL,PYTHON 'yo dawg' \
393             ' test $(perl -E 'print eval "1 +" . qx[python -c "print 2"]') == "4" '
394
395  - test_expect_failure [<prereq>] <message> <script>
396
397    This is NOT the opposite of test_expect_success, but is used
398    to mark a test that demonstrates a known breakage.  Unlike
399    the usual test_expect_success tests, which say "ok" on
400    success and "FAIL" on failure, this will say "FIXED" on
401    success and "still broken" on failure.  Failures from these
402    tests won't cause -i (immediate) to stop.
403
404    Like test_expect_success this function can optionally use a three
405    argument invocation with a prerequisite as the first argument.
406
407  - test_debug <script>
408
409    This takes a single argument, <script>, and evaluates it only
410    when the test script is started with --debug command line
411    argument.  This is primarily meant for use during the
412    development of a new test script.
413
414  - test_done
415
416    Your test script must have test_done at the end.  Its purpose
417    is to summarize successes and failures in the test script and
418    exit with an appropriate error code.
419
420  - test_tick
421
422    Make commit and tag names consistent by setting the author and
423    committer times to defined stated.  Subsequent calls will
424    advance the times by a fixed amount.
425
426  - test_commit <message> [<filename> [<contents>]]
427
428    Creates a commit with the given message, committing the given
429    file with the given contents (default for both is to reuse the
430    message string), and adds a tag (again reusing the message
431    string as name).  Calls test_tick to make the SHA-1s
432    reproducible.
433
434  - test_merge <message> <commit-or-tag>
435
436    Merges the given rev using the given message.  Like test_commit,
437    creates a tag and calls test_tick before committing.
438
439  - test_set_prereq SOME_PREREQ
440
441    Set a test prerequisite to be used later with test_have_prereq. The
442    test-lib will set some prerequisites for you, see the
443    "Prerequisites" section below for a full list of these.
444
445    Others you can set yourself and use later with either
446    test_have_prereq directly, or the three argument invocation of
447    test_expect_success and test_expect_failure.
448
449  - test_have_prereq SOME PREREQ
450
451    Check if we have a prerequisite previously set with
452    test_set_prereq. The most common use of this directly is to skip
453    all the tests if we don't have some essential prerequisite:
454
455         if ! test_have_prereq PERL
456         then
457             skip_all='skipping perl interface tests, perl not available'
458             test_done
459         fi
460
461  - test_external [<prereq>] <message> <external> <script>
462
463    Execute a <script> with an <external> interpreter (like perl). This
464    was added for tests like t9700-perl-git.sh which do most of their
465    work in an external test script.
466
467         test_external \
468             'GitwebCache::*FileCache*' \
469             "$PERL_PATH" "$TEST_DIRECTORY"/t9503/test_cache_interface.pl
470
471    If the test is outputting its own TAP you should set the
472    test_external_has_tap variable somewhere before calling the first
473    test_external* function. See t9700-perl-git.sh for an example.
474
475         # The external test will outputs its own plan
476         test_external_has_tap=1
477
478  - test_external_without_stderr [<prereq>] <message> <external> <script>
479
480    Like test_external but fail if there's any output on stderr,
481    instead of checking the exit code.
482
483         test_external_without_stderr \
484             'Perl API' \
485             "$PERL_PATH" "$TEST_DIRECTORY"/t9700/test.pl
486
487  - test_expect_code <exit-code> <command>
488
489    Run a command and ensure that it exits with the given exit code.
490    For example:
491
492         test_expect_success 'Merge with d/f conflicts' '
493                 test_expect_code 1 git merge "merge msg" B master
494         '
495
496  - test_must_fail <git-command>
497
498    Run a git command and ensure it fails in a controlled way.  Use
499    this instead of "! <git-command>".  When git-command dies due to a
500    segfault, test_must_fail diagnoses it as an error; "! <git-command>"
501    treats it as just another expected failure, which would let such a
502    bug go unnoticed.
503
504  - test_might_fail <git-command>
505
506    Similar to test_must_fail, but tolerate success, too.  Use this
507    instead of "<git-command> || :" to catch failures due to segv.
508
509  - test_cmp <expected> <actual>
510
511    Check whether the content of the <actual> file matches the
512    <expected> file.  This behaves like "cmp" but produces more
513    helpful output when the test is run with "-v" option.
514
515  - test_line_count (= | -lt | -ge | ...) <length> <file>
516
517    Check whether a file has the length it is expected to.
518
519  - test_path_is_file <file> [<diagnosis>]
520    test_path_is_dir <dir> [<diagnosis>]
521    test_path_is_missing <path> [<diagnosis>]
522
523    Check whether a file/directory exists or doesn't. <diagnosis> will
524    be displayed if the test fails.
525
526  - test_when_finished <script>
527
528    Prepend <script> to a list of commands to run to clean up
529    at the end of the current test.  If some clean-up command
530    fails, the test will not pass.
531
532    Example:
533
534         test_expect_success 'branch pointing to non-commit' '
535                 git rev-parse HEAD^{tree} >.git/refs/heads/invalid &&
536                 test_when_finished "git update-ref -d refs/heads/invalid" &&
537                 ...
538         '
539
540 Prerequisites
541 -------------
542
543 These are the prerequisites that the test library predefines with
544 test_have_prereq.
545
546 See the prereq argument to the test_* functions in the "Test harness
547 library" section above and the "test_have_prereq" function for how to
548 use these, and "test_set_prereq" for how to define your own.
549
550  - PERL & PYTHON
551
552    Git wasn't compiled with NO_PERL=YesPlease or
553    NO_PYTHON=YesPlease. Wrap any tests that need Perl or Python in
554    these.
555
556  - POSIXPERM
557
558    The filesystem supports POSIX style permission bits.
559
560  - BSLASHPSPEC
561
562    Backslashes in pathspec are not directory separators. This is not
563    set on Windows. See 6fd1106a for details.
564
565  - EXECKEEPSPID
566
567    The process retains the same pid across exec(2). See fb9a2bea for
568    details.
569
570  - SYMLINKS
571
572    The filesystem we're on supports symbolic links. E.g. a FAT
573    filesystem doesn't support these. See 704a3143 for details.
574
575  - SANITY
576
577    Test is not run by root user, and an attempt to write to an
578    unwritable file is expected to fail correctly.
579
580 Tips for Writing Tests
581 ----------------------
582
583 As with any programming projects, existing programs are the best
584 source of the information.  However, do _not_ emulate
585 t0000-basic.sh when writing your tests.  The test is special in
586 that it tries to validate the very core of GIT.  For example, it
587 knows that there will be 256 subdirectories under .git/objects/,
588 and it knows that the object ID of an empty tree is a certain
589 40-byte string.  This is deliberately done so in t0000-basic.sh
590 because the things the very basic core test tries to achieve is
591 to serve as a basis for people who are changing the GIT internal
592 drastically.  For these people, after making certain changes,
593 not seeing failures from the basic test _is_ a failure.  And
594 such drastic changes to the core GIT that even changes these
595 otherwise supposedly stable object IDs should be accompanied by
596 an update to t0000-basic.sh.
597
598 However, other tests that simply rely on basic parts of the core
599 GIT working properly should not have that level of intimate
600 knowledge of the core GIT internals.  If all the test scripts
601 hardcoded the object IDs like t0000-basic.sh does, that defeats
602 the purpose of t0000-basic.sh, which is to isolate that level of
603 validation in one place.  Your test also ends up needing
604 updating when such a change to the internal happens, so do _not_
605 do it and leave the low level of validation to t0000-basic.sh.
606
607 Test coverage
608 -------------
609
610 You can use the coverage tests to find code paths that are not being
611 used or properly exercised yet.
612
613 To do that, run the coverage target at the top-level (not in the t/
614 directory):
615
616     make coverage
617
618 That'll compile Git with GCC's coverage arguments, and generate a test
619 report with gcov after the tests finish. Running the coverage tests
620 can take a while, since running the tests in parallel is incompatible
621 with GCC's coverage mode.
622
623 After the tests have run you can generate a list of untested
624 functions:
625
626     make coverage-untested-functions
627
628 You can also generate a detailed per-file HTML report using the
629 Devel::Cover module. To install it do:
630
631    # On Debian or Ubuntu:
632    sudo aptitude install libdevel-cover-perl
633
634    # From the CPAN with cpanminus
635    curl -L http://cpanmin.us | perl - --sudo --self-upgrade
636    cpanm --sudo Devel::Cover
637
638 Then, at the top-level:
639
640     make cover_db_html
641
642 That'll generate a detailed cover report in the "cover_db_html"
643 directory, which you can then copy to a webserver, or inspect locally
644 in a browser.
645
646 Smoke testing
647 -------------
648
649 The Git test suite has support for smoke testing. Smoke testing is
650 when you submit the results of a test run to a central server for
651 analysis and aggregation.
652
653 Running a smoke tester is an easy and valuable way of contributing to
654 Git development, particularly if you have access to an uncommon OS on
655 obscure hardware.
656
657 After building Git you can generate a smoke report like this in the
658 "t" directory:
659
660     make clean smoke
661
662 You can also pass arguments via the environment. This should make it
663 faster:
664
665     GIT_TEST_OPTS='--root=/dev/shm' TEST_JOBS=10 make clean smoke
666
667 The "smoke" target will run the Git test suite with Perl's
668 "TAP::Harness" module, and package up the results in a .tar.gz archive
669 with "TAP::Harness::Archive". The former is included with Perl v5.10.1
670 or later, but you'll need to install the latter from the CPAN. See the
671 "Test coverage" section above for how you might do that.
672
673 Once the "smoke" target finishes you'll see a message like this:
674
675     TAP Archive created at <path to git>/t/test-results/git-smoke.tar.gz
676
677 To upload the smoke report you need to have curl(1) installed, then
678 do:
679
680     make smoke_report
681
682 To upload the report anonymously. Hopefully that'll return something
683 like "Reported #7 added.".
684
685 If you're going to be uploading reports frequently please request a
686 user account by E-Mailing gitsmoke@v.nix.is. Once you have a username
687 and password you'll be able to do:
688
689     SMOKE_USERNAME=<username> SMOKE_PASSWORD=<password> make smoke_report
690
691 You can also add an additional comment to attach to the report, and/or
692 a comma separated list of tags:
693
694     SMOKE_USERNAME=<username> SMOKE_PASSWORD=<password> \
695         SMOKE_COMMENT=<comment> SMOKE_TAGS=<tags> \
696         make smoke_report
697
698 Once the report is uploaded it'll be made available at
699 http://smoke.git.nix.is, here's an overview of Recent Smoke Reports
700 for Git:
701
702     http://smoke.git.nix.is/app/projects/smoke_reports/1
703
704 The reports will also be mirrored to GitHub every few hours:
705
706     http://github.com/gitsmoke/smoke-reports
707
708 The Smolder SQLite database is also mirrored and made available for
709 download:
710
711     http://github.com/gitsmoke/smoke-database
712
713 Note that the database includes hashed (with crypt()) user passwords
714 and E-Mail addresses. Don't use a valuable password for the smoke
715 service if you have an account, or an E-Mail address you don't want to
716 be publicly known. The user accounts are just meant to be convenient
717 labels, they're not meant to be secure.