]>
Commit | Line | Data |
---|---|---|
986aa7f1 JH |
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 *** | |
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 | ||
35 | Since the tests all output TAP (see http://testanything.org) they can | |
85b0b34e | 36 | be run with any TAP harness. Here's an example of parallel testing |
5099b99d ÆAB |
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 | |
986aa7f1 | 52 | |
28d836c8 MG |
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 | ||
5099b99d | 59 | You 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 | |
70 | You 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 |
72 | appropriately 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 | |
13cb3bb7 SR |
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. | |
986aa7f1 | 93 | |
5e2c08c6 LW |
94 | --long-tests:: |
95 | This causes additional long-running tests to be run (where | |
96 | available), for more exhaustive testing. | |
97 | ||
952af351 TR |
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). | |
986aa7f1 | 102 | |
3da93652 JS |
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. | |
106 | ||
952af351 TR |
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. | |
111 | ||
95d9d5ec TR |
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. | |
116 | ||
952af351 | 117 | Note that memcheck is run with the option --leak-check=no, |
9aec68d3 CMN |
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/'. | |
123 | ||
44138559 JS |
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. | |
129 | ||
e4597aae MO |
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. | |
138 | ||
0d4dbcd3 TR |
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. | |
144 | ||
e160da7f MO |
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. | |
151 | ||
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`. | |
156 | ||
157 | ||
fbd458a3 JN |
158 | Skipping Tests |
159 | -------------- | |
160 | ||
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. | |
165 | ||
166 | You should be able to say something like | |
167 | ||
168 | $ GIT_SKIP_TESTS=t9200.8 sh ./t9200-git-cvsexport-commit.sh | |
169 | ||
170 | and even: | |
171 | ||
172 | $ GIT_SKIP_TESTS='t[0-4]??? t91?? t9200.8' make | |
173 | ||
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. | |
179 | ||
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. | |
184 | ||
185 | ||
f50c9f76 PB |
186 | Naming Tests |
187 | ------------ | |
188 | ||
189 | The test files are named as: | |
190 | ||
191 | tNNNN-commandname-details.sh | |
192 | ||
193 | where N is a decimal digit. | |
194 | ||
195 | First digit tells the family: | |
196 | ||
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) | |
8f4a9b62 | 204 | 7 - the porcelainish commands concerning the working tree |
8757749e JN |
205 | 8 - the porcelainish commands concerning forensics |
206 | 9 - the git tools | |
f50c9f76 PB |
207 | |
208 | Second digit tells the particular command we are testing. | |
209 | ||
210 | Third digit (optionally) tells the particular switch or group of switches | |
211 | we are testing. | |
212 | ||
77656600 JH |
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 | |
63d32945 | 216 | top-level test script and tries to run all of them. Care is |
77656600 JH |
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. | |
220 | ||
f50c9f76 | 221 | |
986aa7f1 JH |
222 | Writing Tests |
223 | ------------- | |
224 | ||
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: | |
228 | ||
229 | #!/bin/sh | |
230 | # | |
231 | # Copyright (c) 2005 Junio C Hamano | |
232 | # | |
233 | ||
14cd1ff3 | 234 | test_description='xxx test (option --frotz) |
986aa7f1 JH |
235 | |
236 | This test registers the following structure in the cache | |
237 | and tries to run git-ls-files with option --frotz.' | |
238 | ||
f50c9f76 | 239 | |
986aa7f1 JH |
240 | Source 'test-lib.sh' |
241 | -------------------- | |
242 | ||
243 | After assigning test_description, the test script should source | |
244 | test-lib.sh like this: | |
245 | ||
246 | . ./test-lib.sh | |
247 | ||
248 | This test harness library does the following things: | |
249 | ||
250 | - If the script is invoked with command line argument --help | |
251 | (or -h), it shows the test_description and exits. | |
252 | ||
e1ca1c9d ÆAB |
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. | |
986aa7f1 JH |
257 | |
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. | |
262 | ||
20873f45 ÆAB |
263 | Do's, don'ts & things to keep in mind |
264 | ------------------------------------- | |
265 | ||
6fd45295 | 266 | Here are a few examples of things you probably should and shouldn't do |
20873f45 ÆAB |
267 | when writing tests. |
268 | ||
269 | Do: | |
270 | ||
6fd45295 | 271 | - Put all code inside test_expect_success and other assertions. |
20873f45 ÆAB |
272 | |
273 | Even code that isn't a test per se, but merely some setup code | |
6fd45295 | 274 | should be inside a test assertion. |
20873f45 ÆAB |
275 | |
276 | - Chain your test assertions | |
277 | ||
278 | Write test code like this: | |
279 | ||
280 | git merge foo && | |
281 | git push bar && | |
282 | test ... | |
283 | ||
284 | Instead of: | |
285 | ||
286 | git merge hla | |
287 | git push gh | |
288 | test ... | |
289 | ||
290 | That way all of the commands in your tests will succeed or fail. If | |
00648ba0 EN |
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. | |
20873f45 | 296 | |
0c357544 ÆAB |
297 | - Check the test coverage for your tests. See the "Test coverage" |
298 | below. | |
299 | ||
63d32945 MW |
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, | |
e8b55f5c ÆAB |
302 | but having 100% coverage doesn't necessarily mean that you tested |
303 | everything. | |
304 | ||
305 | Tests that are likely to smoke out future regressions are better | |
306 | than tests that just inflate the coverage metrics. | |
307 | ||
95b104c8 JS |
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. | |
313 | ||
20873f45 ÆAB |
314 | Don't: |
315 | ||
316 | - exit() within a <script> part. | |
317 | ||
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). | |
321 | ||
ad78585e JH |
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). | |
326 | ||
327 | - use perl without spelling it as "$PERL_PATH". This is to help our | |
328 | friends on Windows where the platform Perl often adds CR before | |
329 | the end of line, and they bundle Git with a version of Perl that | |
330 | does not do so, whose path is specified with $PERL_PATH. | |
331 | ||
332 | - use sh without spelling it as "$SHELL_PATH", when the script can | |
333 | be misinterpreted by broken platform shell (e.g. Solaris). | |
334 | ||
335 | - chdir around in tests. It is not sufficient to chdir to | |
336 | somewhere and then chdir back to the original location later in | |
337 | the test, as any intermediate step can fail and abort the test, | |
338 | causing the next test to start in an unexpected directory. Do so | |
339 | inside a subshell if necessary. | |
340 | ||
20873f45 ÆAB |
341 | - Break the TAP output |
342 | ||
6fd45295 JH |
343 | The raw output from your test may be interpreted by a TAP harness. TAP |
344 | harnesses will ignore everything they don't know about, but don't step | |
345 | on their toes in these areas: | |
20873f45 ÆAB |
346 | |
347 | - Don't print lines like "$x..$y" where $x and $y are integers. | |
348 | ||
349 | - Don't print lines that begin with "ok" or "not ok". | |
350 | ||
6fd45295 | 351 | TAP harnesses expect a line that begins with either "ok" and "not |
20873f45 ÆAB |
352 | ok" to signal a test passed or failed (and our harness already |
353 | produces such lines), so your script shouldn't emit such lines to | |
354 | their output. | |
355 | ||
356 | You can glean some further possible issues from the TAP grammar | |
357 | (see http://search.cpan.org/perldoc?TAP::Parser::Grammar#TAP_Grammar) | |
358 | but the best indication is to just run the tests with prove(1), | |
359 | it'll complain if anything is amiss. | |
360 | ||
361 | Keep in mind: | |
362 | ||
6fd45295 | 363 | - Inside <script> part, the standard output and standard error |
20873f45 ÆAB |
364 | streams are discarded, and the test harness only reports "ok" or |
365 | "not ok" to the end user running the tests. Under --verbose, they | |
366 | are shown to help debugging the tests. | |
367 | ||
368 | ||
b5500d16 ÆAB |
369 | Skipping tests |
370 | -------------- | |
371 | ||
681186ae | 372 | If you need to skip tests you should do so by using the three-arg form |
99d9050d ÆAB |
373 | of the test_* functions (see the "Test harness library" section |
374 | below), e.g.: | |
375 | ||
ad78585e JH |
376 | test_expect_success PERL 'I need Perl' ' |
377 | "$PERL_PATH" -e "hlagh() if unf_unf()" | |
378 | ' | |
99d9050d ÆAB |
379 | |
380 | The advantage of skipping tests like this is that platforms that don't | |
381 | have the PERL and other optional dependencies get an indication of how | |
382 | many tests they're missing. | |
383 | ||
384 | If the test code is too hairy for that (i.e. does a lot of setup work | |
385 | outside test assertions) you can also skip all remaining tests by | |
386 | setting skip_all and immediately call test_done: | |
b5500d16 ÆAB |
387 | |
388 | if ! test_have_prereq PERL | |
389 | then | |
390 | skip_all='skipping perl interface tests, perl not available' | |
391 | test_done | |
392 | fi | |
14cd1ff3 | 393 | |
99d9050d ÆAB |
394 | The string you give to skip_all will be used as an explanation for why |
395 | the test was skipped. | |
396 | ||
986aa7f1 JH |
397 | End with test_done |
398 | ------------------ | |
399 | ||
400 | Your script will be a sequence of tests, using helper functions | |
401 | from the test harness library. At the end of the script, call | |
402 | 'test_done'. | |
403 | ||
404 | ||
405 | Test harness library | |
406 | -------------------- | |
407 | ||
408 | There are a handful helper functions defined in the test harness | |
409 | library for your script to use. | |
410 | ||
9a897893 | 411 | - test_expect_success [<prereq>] <message> <script> |
986aa7f1 | 412 | |
72942a61 | 413 | Usually takes two strings as parameters, and evaluates the |
986aa7f1 JH |
414 | <script>. If it yields success, test is considered |
415 | successful. <message> should state what it is testing. | |
416 | ||
417 | Example: | |
418 | ||
419 | test_expect_success \ | |
420 | 'git-write-tree should be able to write an empty tree.' \ | |
421 | 'tree=$(git-write-tree)' | |
422 | ||
9a897893 | 423 | If you supply three parameters the first will be taken to be a |
72942a61 | 424 | prerequisite; see the test_set_prereq and test_have_prereq |
9a897893 ÆAB |
425 | documentation below: |
426 | ||
427 | test_expect_success TTY 'git --paginate rev-list uses a pager' \ | |
428 | ' ... ' | |
429 | ||
93a57246 ÆAB |
430 | You can also supply a comma-separated list of prerequisites, in the |
431 | rare case where your test depends on more than one: | |
432 | ||
433 | test_expect_success PERL,PYTHON 'yo dawg' \ | |
434 | ' test $(perl -E 'print eval "1 +" . qx[python -c "print 2"]') == "4" ' | |
435 | ||
9a897893 | 436 | - test_expect_failure [<prereq>] <message> <script> |
986aa7f1 | 437 | |
41ac414e JH |
438 | This is NOT the opposite of test_expect_success, but is used |
439 | to mark a test that demonstrates a known breakage. Unlike | |
440 | the usual test_expect_success tests, which say "ok" on | |
441 | success and "FAIL" on failure, this will say "FIXED" on | |
442 | success and "still broken" on failure. Failures from these | |
443 | tests won't cause -i (immediate) to stop. | |
986aa7f1 | 444 | |
9a897893 ÆAB |
445 | Like test_expect_success this function can optionally use a three |
446 | argument invocation with a prerequisite as the first argument. | |
447 | ||
986aa7f1 JH |
448 | - test_debug <script> |
449 | ||
450 | This takes a single argument, <script>, and evaluates it only | |
451 | when the test script is started with --debug command line | |
452 | argument. This is primarily meant for use during the | |
453 | development of a new test script. | |
454 | ||
455 | - test_done | |
456 | ||
457 | Your test script must have test_done at the end. Its purpose | |
458 | is to summarize successes and failures in the test script and | |
459 | exit with an appropriate error code. | |
460 | ||
00884968 JS |
461 | - test_tick |
462 | ||
463 | Make commit and tag names consistent by setting the author and | |
63d32945 | 464 | committer times to defined state. Subsequent calls will |
00884968 JS |
465 | advance the times by a fixed amount. |
466 | ||
467 | - test_commit <message> [<filename> [<contents>]] | |
468 | ||
469 | Creates a commit with the given message, committing the given | |
470 | file with the given contents (default for both is to reuse the | |
471 | message string), and adds a tag (again reusing the message | |
472 | string as name). Calls test_tick to make the SHA-1s | |
473 | reproducible. | |
474 | ||
475 | - test_merge <message> <commit-or-tag> | |
476 | ||
477 | Merges the given rev using the given message. Like test_commit, | |
478 | creates a tag and calls test_tick before committing. | |
986aa7f1 | 479 | |
72942a61 | 480 | - test_set_prereq <prereq> |
9a897893 ÆAB |
481 | |
482 | Set a test prerequisite to be used later with test_have_prereq. The | |
be53deef ÆAB |
483 | test-lib will set some prerequisites for you, see the |
484 | "Prerequisites" section below for a full list of these. | |
485 | ||
486 | Others you can set yourself and use later with either | |
487 | test_have_prereq directly, or the three argument invocation of | |
488 | test_expect_success and test_expect_failure. | |
9a897893 | 489 | |
72942a61 | 490 | - test_have_prereq <prereq> |
9a897893 ÆAB |
491 | |
492 | Check if we have a prerequisite previously set with | |
493 | test_set_prereq. The most common use of this directly is to skip | |
494 | all the tests if we don't have some essential prerequisite: | |
495 | ||
496 | if ! test_have_prereq PERL | |
497 | then | |
498 | skip_all='skipping perl interface tests, perl not available' | |
499 | test_done | |
500 | fi | |
501 | ||
2fac6a4b ÆAB |
502 | - test_external [<prereq>] <message> <external> <script> |
503 | ||
504 | Execute a <script> with an <external> interpreter (like perl). This | |
505 | was added for tests like t9700-perl-git.sh which do most of their | |
506 | work in an external test script. | |
507 | ||
508 | test_external \ | |
509 | 'GitwebCache::*FileCache*' \ | |
510 | "$PERL_PATH" "$TEST_DIRECTORY"/t9503/test_cache_interface.pl | |
511 | ||
512 | If the test is outputting its own TAP you should set the | |
513 | test_external_has_tap variable somewhere before calling the first | |
514 | test_external* function. See t9700-perl-git.sh for an example. | |
515 | ||
516 | # The external test will outputs its own plan | |
517 | test_external_has_tap=1 | |
518 | ||
519 | - test_external_without_stderr [<prereq>] <message> <external> <script> | |
520 | ||
521 | Like test_external but fail if there's any output on stderr, | |
522 | instead of checking the exit code. | |
523 | ||
524 | test_external_without_stderr \ | |
525 | 'Perl API' \ | |
526 | "$PERL_PATH" "$TEST_DIRECTORY"/t9700/test.pl | |
527 | ||
892e6f7e ÆAB |
528 | - test_expect_code <exit-code> <command> |
529 | ||
530 | Run a command and ensure that it exits with the given exit code. | |
531 | For example: | |
532 | ||
533 | test_expect_success 'Merge with d/f conflicts' ' | |
534 | test_expect_code 1 git merge "merge msg" B master | |
535 | ' | |
536 | ||
c9667456 JN |
537 | - test_must_fail <git-command> |
538 | ||
539 | Run a git command and ensure it fails in a controlled way. Use | |
971ecbd1 BC |
540 | this instead of "! <git-command>". When git-command dies due to a |
541 | segfault, test_must_fail diagnoses it as an error; "! <git-command>" | |
542 | treats it as just another expected failure, which would let such a | |
543 | bug go unnoticed. | |
c9667456 JN |
544 | |
545 | - test_might_fail <git-command> | |
546 | ||
547 | Similar to test_must_fail, but tolerate success, too. Use this | |
548 | instead of "<git-command> || :" to catch failures due to segv. | |
549 | ||
550 | - test_cmp <expected> <actual> | |
551 | ||
552 | Check whether the content of the <actual> file matches the | |
553 | <expected> file. This behaves like "cmp" but produces more | |
554 | helpful output when the test is run with "-v" option. | |
555 | ||
fb3340a6 JN |
556 | - test_line_count (= | -lt | -ge | ...) <length> <file> |
557 | ||
558 | Check whether a file has the length it is expected to. | |
559 | ||
72942a61 ML |
560 | - test_path_is_file <path> [<diagnosis>] |
561 | test_path_is_dir <path> [<diagnosis>] | |
2caf20c5 MM |
562 | test_path_is_missing <path> [<diagnosis>] |
563 | ||
72942a61 ML |
564 | Check if the named path is a file, if the named path is a |
565 | directory, or if the named path does not exist, respectively, | |
566 | and fail otherwise, showing the <diagnosis> text. | |
2caf20c5 | 567 | |
c9667456 JN |
568 | - test_when_finished <script> |
569 | ||
570 | Prepend <script> to a list of commands to run to clean up | |
571 | at the end of the current test. If some clean-up command | |
572 | fails, the test will not pass. | |
573 | ||
574 | Example: | |
575 | ||
576 | test_expect_success 'branch pointing to non-commit' ' | |
577 | git rev-parse HEAD^{tree} >.git/refs/heads/invalid && | |
578 | test_when_finished "git update-ref -d refs/heads/invalid" && | |
579 | ... | |
580 | ' | |
581 | ||
c4d2539a JL |
582 | - test_pause |
583 | ||
584 | This command is useful for writing and debugging tests and must be | |
585 | removed before submitting. It halts the execution of the test and | |
586 | spawns a shell in the trash directory. Exit the shell to continue | |
587 | the test. Example: | |
588 | ||
589 | test_expect_success 'test' ' | |
590 | git do-something >actual && | |
591 | test_pause && | |
592 | test_cmp expected actual | |
593 | ' | |
594 | ||
be53deef ÆAB |
595 | Prerequisites |
596 | ------------- | |
597 | ||
598 | These are the prerequisites that the test library predefines with | |
599 | test_have_prereq. | |
600 | ||
601 | See the prereq argument to the test_* functions in the "Test harness | |
602 | library" section above and the "test_have_prereq" function for how to | |
603 | use these, and "test_set_prereq" for how to define your own. | |
604 | ||
605 | - PERL & PYTHON | |
606 | ||
607 | Git wasn't compiled with NO_PERL=YesPlease or | |
608 | NO_PYTHON=YesPlease. Wrap any tests that need Perl or Python in | |
609 | these. | |
610 | ||
611 | - POSIXPERM | |
612 | ||
613 | The filesystem supports POSIX style permission bits. | |
614 | ||
615 | - BSLASHPSPEC | |
616 | ||
617 | Backslashes in pathspec are not directory separators. This is not | |
618 | set on Windows. See 6fd1106a for details. | |
619 | ||
620 | - EXECKEEPSPID | |
621 | ||
622 | The process retains the same pid across exec(2). See fb9a2bea for | |
623 | details. | |
624 | ||
20073274 AS |
625 | - PIPE |
626 | ||
627 | The filesystem we're on supports creation of FIFOs (named pipes) | |
628 | via mkfifo(1). | |
629 | ||
be53deef ÆAB |
630 | - SYMLINKS |
631 | ||
632 | The filesystem we're on supports symbolic links. E.g. a FAT | |
633 | filesystem doesn't support these. See 704a3143 for details. | |
2fac6a4b | 634 | |
c91cfd19 ÆAB |
635 | - SANITY |
636 | ||
637 | Test is not run by root user, and an attempt to write to an | |
638 | unwritable file is expected to fail correctly. | |
2fac6a4b | 639 | |
8f852ce6 MK |
640 | - LIBPCRE |
641 | ||
642 | Git was compiled with USE_LIBPCRE=YesPlease. Wrap any tests | |
643 | that use git-grep --perl-regexp or git-grep -P in these. | |
644 | ||
ac39aa61 MG |
645 | - CASE_INSENSITIVE_FS |
646 | ||
647 | Test is run on a case insensitive file system. | |
648 | ||
5b0b5dd4 MG |
649 | - UTF8_NFD_TO_NFC |
650 | ||
651 | Test is run on a filesystem which converts decomposed utf-8 (nfd) | |
652 | to precomposed utf-8 (nfc). | |
653 | ||
986aa7f1 JH |
654 | Tips for Writing Tests |
655 | ---------------------- | |
656 | ||
657 | As with any programming projects, existing programs are the best | |
658 | source of the information. However, do _not_ emulate | |
659 | t0000-basic.sh when writing your tests. The test is special in | |
660 | that it tries to validate the very core of GIT. For example, it | |
661 | knows that there will be 256 subdirectories under .git/objects/, | |
662 | and it knows that the object ID of an empty tree is a certain | |
663 | 40-byte string. This is deliberately done so in t0000-basic.sh | |
664 | because the things the very basic core test tries to achieve is | |
665 | to serve as a basis for people who are changing the GIT internal | |
666 | drastically. For these people, after making certain changes, | |
667 | not seeing failures from the basic test _is_ a failure. And | |
668 | such drastic changes to the core GIT that even changes these | |
669 | otherwise supposedly stable object IDs should be accompanied by | |
670 | an update to t0000-basic.sh. | |
671 | ||
672 | However, other tests that simply rely on basic parts of the core | |
673 | GIT working properly should not have that level of intimate | |
674 | knowledge of the core GIT internals. If all the test scripts | |
675 | hardcoded the object IDs like t0000-basic.sh does, that defeats | |
676 | the purpose of t0000-basic.sh, which is to isolate that level of | |
677 | validation in one place. Your test also ends up needing | |
678 | updating when such a change to the internal happens, so do _not_ | |
679 | do it and leave the low level of validation to t0000-basic.sh. | |
d15e9ebc | 680 | |
0c357544 ÆAB |
681 | Test coverage |
682 | ------------- | |
683 | ||
684 | You can use the coverage tests to find code paths that are not being | |
685 | used or properly exercised yet. | |
686 | ||
687 | To do that, run the coverage target at the top-level (not in the t/ | |
688 | directory): | |
689 | ||
690 | make coverage | |
691 | ||
692 | That'll compile Git with GCC's coverage arguments, and generate a test | |
693 | report with gcov after the tests finish. Running the coverage tests | |
694 | can take a while, since running the tests in parallel is incompatible | |
695 | with GCC's coverage mode. | |
696 | ||
697 | After the tests have run you can generate a list of untested | |
698 | functions: | |
699 | ||
700 | make coverage-untested-functions | |
701 | ||
702 | You can also generate a detailed per-file HTML report using the | |
703 | Devel::Cover module. To install it do: | |
704 | ||
705 | # On Debian or Ubuntu: | |
706 | sudo aptitude install libdevel-cover-perl | |
707 | ||
708 | # From the CPAN with cpanminus | |
709 | curl -L http://cpanmin.us | perl - --sudo --self-upgrade | |
710 | cpanm --sudo Devel::Cover | |
711 | ||
712 | Then, at the top-level: | |
713 | ||
714 | make cover_db_html | |
715 | ||
716 | That'll generate a detailed cover report in the "cover_db_html" | |
717 | directory, which you can then copy to a webserver, or inspect locally | |
718 | in a browser. |