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