]>
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 | 73 | |
5e3b4fce | 74 | -v:: |
986aa7f1 JH |
75 | --verbose:: |
76 | This makes the test more verbose. Specifically, the | |
77 | command being run and their output if any are also | |
78 | output. | |
79 | ||
ff09af3f TR |
80 | --verbose-only=<pattern>:: |
81 | Like --verbose, but the effect is limited to tests with | |
82 | numbers matching <pattern>. The number matched against is | |
83 | simply the running count of the test within the file. | |
84 | ||
a136f6d8 JK |
85 | -x:: |
86 | Turn on shell tracing (i.e., `set -x`) during the tests | |
d88785e4 JK |
87 | themselves. Implies `--verbose`. Note that in non-bash shells, |
88 | this can cause failures in some tests which redirect and test | |
89 | the output of shell functions. Use with caution. | |
a136f6d8 | 90 | |
5e3b4fce | 91 | -d:: |
986aa7f1 JH |
92 | --debug:: |
93 | This may help the person who is developing a new test. | |
94 | It causes the command defined with test_debug to run. | |
0986de94 PK |
95 | The "trash" directory (used to store all temporary data |
96 | during testing) is not deleted even if there are no | |
97 | failed tests so that you can inspect its contents after | |
98 | the test finished. | |
986aa7f1 | 99 | |
5e3b4fce | 100 | -i:: |
986aa7f1 JH |
101 | --immediate:: |
102 | This causes the test to immediately exit upon the first | |
13cb3bb7 SR |
103 | failed test. Cleanup commands requested with |
104 | test_when_finished are not executed if the test failed, | |
105 | in order to keep the state for inspection by the tester | |
106 | to diagnose the bug. | |
986aa7f1 | 107 | |
5e3b4fce | 108 | -l:: |
5e2c08c6 LW |
109 | --long-tests:: |
110 | This causes additional long-running tests to be run (where | |
111 | available), for more exhaustive testing. | |
112 | ||
0445e6f0 IB |
113 | -r:: |
114 | --run=<test-selector>:: | |
115 | Run only the subset of tests indicated by | |
116 | <test-selector>. See section "Skipping Tests" below for | |
117 | <test-selector> syntax. | |
118 | ||
952af351 TR |
119 | --valgrind=<tool>:: |
120 | Execute all Git binaries under valgrind tool <tool> and exit | |
121 | with status 126 on errors (just like regular tests, this will | |
122 | only stop the test script when running under -i). | |
986aa7f1 | 123 | |
3da93652 JS |
124 | Since it makes no sense to run the tests with --valgrind and |
125 | not see any output, this option implies --verbose. For | |
126 | convenience, it also implies --tee. | |
127 | ||
952af351 TR |
128 | <tool> defaults to 'memcheck', just like valgrind itself. |
129 | Other particularly useful choices include 'helgrind' and | |
130 | 'drd', but you may use any tool recognized by your valgrind | |
131 | installation. | |
132 | ||
95d9d5ec TR |
133 | As a special case, <tool> can be 'memcheck-fast', which uses |
134 | memcheck but disables --track-origins. Use this if you are | |
135 | running tests in bulk, to see if there are _any_ memory | |
136 | issues. | |
137 | ||
952af351 | 138 | Note that memcheck is run with the option --leak-check=no, |
9aec68d3 CMN |
139 | as the git process is short-lived and some errors are not |
140 | interesting. In order to run a single command under the same | |
141 | conditions manually, you should set GIT_VALGRIND to point to | |
142 | the 't/valgrind/' directory and use the commands under | |
143 | 't/valgrind/bin/'. | |
144 | ||
5dfc368f TR |
145 | --valgrind-only=<pattern>:: |
146 | Like --valgrind, but the effect is limited to tests with | |
147 | numbers matching <pattern>. The number matched against is | |
148 | simply the running count of the test within the file. | |
149 | ||
44138559 JS |
150 | --tee:: |
151 | In addition to printing the test output to the terminal, | |
152 | write it to files named 't/test-results/$TEST_NAME.out'. | |
153 | As the names depend on the tests' file names, it is safe to | |
154 | run the tests with this option in parallel. | |
155 | ||
452320f1 JK |
156 | --verbose-log:: |
157 | Write verbose output to the same logfile as `--tee`, but do | |
158 | _not_ write it to stdout. Unlike `--tee --verbose`, this option | |
159 | is safe to use when stdout is being consumed by a TAP parser | |
160 | like `prove`. Implies `--tee` and `--verbose`. | |
161 | ||
e4597aae MO |
162 | --with-dashes:: |
163 | By default tests are run without dashed forms of | |
164 | commands (like git-commit) in the PATH (it only uses | |
165 | wrappers from ../bin-wrappers). Use this option to include | |
166 | the build directory (..) in the PATH, which contains all | |
167 | the dashed forms of commands. This option is currently | |
168 | implied by other options like --valgrind and | |
169 | GIT_TEST_INSTALLED. | |
170 | ||
0d4dbcd3 TR |
171 | --root=<directory>:: |
172 | Create "trash" directories used to store all temporary data during | |
173 | testing under <directory>, instead of the t/ directory. | |
174 | Using this option with a RAM-based filesystem (such as tmpfs) | |
175 | can massively speed up the test suite. | |
176 | ||
bb79af9d JK |
177 | --chain-lint:: |
178 | --no-chain-lint:: | |
179 | If --chain-lint is enabled, the test harness will check each | |
180 | test to make sure that it properly "&&-chains" all commands (so | |
181 | that a failure in the middle does not go unnoticed by the final | |
182 | exit code of the test). This check is performed in addition to | |
183 | running the tests themselves. You may also enable or disable | |
184 | this feature by setting the GIT_TEST_CHAIN_LINT environment | |
185 | variable to "1" or "0", respectively. | |
186 | ||
e160da7f MO |
187 | You can also set the GIT_TEST_INSTALLED environment variable to |
188 | the bindir of an existing git installation to test that installation. | |
189 | You still need to have built this git sandbox, from which various | |
190 | test-* support programs, templates, and perl libraries are used. | |
191 | If your installed git is incomplete, it will silently test parts of | |
192 | your built version instead. | |
193 | ||
194 | When using GIT_TEST_INSTALLED, you can also set GIT_TEST_EXEC_PATH to | |
195 | override the location of the dashed-form subcommands (what | |
196 | GIT_EXEC_PATH would be used for during normal operation). | |
197 | GIT_TEST_EXEC_PATH defaults to `$GIT_TEST_INSTALLED/git --exec-path`. | |
198 | ||
199 | ||
fbd458a3 JN |
200 | Skipping Tests |
201 | -------------- | |
202 | ||
203 | In some environments, certain tests have no way of succeeding | |
204 | due to platform limitation, such as lack of 'unzip' program, or | |
205 | filesystem that do not allow arbitrary sequence of non-NUL bytes | |
206 | as pathnames. | |
207 | ||
208 | You should be able to say something like | |
209 | ||
210 | $ GIT_SKIP_TESTS=t9200.8 sh ./t9200-git-cvsexport-commit.sh | |
211 | ||
212 | and even: | |
213 | ||
214 | $ GIT_SKIP_TESTS='t[0-4]??? t91?? t9200.8' make | |
215 | ||
216 | to omit such tests. The value of the environment variable is a | |
217 | SP separated list of patterns that tells which tests to skip, | |
218 | and either can match the "t[0-9]{4}" part to skip the whole | |
219 | test, or t[0-9]{4} followed by ".$number" to say which | |
220 | particular test to skip. | |
221 | ||
0445e6f0 IB |
222 | For an individual test suite --run could be used to specify that |
223 | only some tests should be run or that some tests should be | |
224 | excluded from a run. | |
225 | ||
226 | The argument for --run is a list of individual test numbers or | |
227 | ranges with an optional negation prefix that define what tests in | |
228 | a test suite to include in the run. A range is two numbers | |
229 | separated with a dash and matches a range of tests with both ends | |
230 | been included. You may omit the first or the second number to | |
231 | mean "from the first test" or "up to the very last test" | |
232 | respectively. | |
233 | ||
234 | Optional prefix of '!' means that the test or a range of tests | |
235 | should be excluded from the run. | |
236 | ||
237 | If --run starts with an unprefixed number or range the initial | |
238 | set of tests to run is empty. If the first item starts with '!' | |
239 | all the tests are added to the initial set. After initial set is | |
240 | determined every test number or range is added or excluded from | |
241 | the set one by one, from left to right. | |
242 | ||
243 | Individual numbers or ranges could be separated either by a space | |
244 | or a comma. | |
245 | ||
246 | For example, to run only tests up to a specific test (21), one | |
247 | could do this: | |
248 | ||
249 | $ sh ./t9200-git-cvsexport-commit.sh --run='1-21' | |
250 | ||
251 | or this: | |
252 | ||
253 | $ sh ./t9200-git-cvsexport-commit.sh --run='-21' | |
254 | ||
255 | Common case is to run several setup tests (1, 2, 3) and then a | |
256 | specific test (21) that relies on that setup: | |
257 | ||
258 | $ sh ./t9200-git-cvsexport-commit.sh --run='1 2 3 21' | |
259 | ||
260 | or: | |
261 | ||
262 | $ sh ./t9200-git-cvsexport-commit.sh --run=1,2,3,21 | |
263 | ||
264 | or: | |
265 | ||
266 | $ sh ./t9200-git-cvsexport-commit.sh --run='-3 21' | |
267 | ||
01e4be6c KS |
268 | As noted above, the test set is built by going through the items |
269 | from left to right, so this: | |
0445e6f0 IB |
270 | |
271 | $ sh ./t9200-git-cvsexport-commit.sh --run='1-4 !3' | |
272 | ||
01e4be6c | 273 | will run tests 1, 2, and 4. Items that come later have higher |
2e3a16b2 | 274 | precedence. It means that this: |
0445e6f0 IB |
275 | |
276 | $ sh ./t9200-git-cvsexport-commit.sh --run='!3 1-4' | |
277 | ||
278 | would just run tests from 1 to 4, including 3. | |
279 | ||
280 | You may use negation with ranges. The following will run all | |
281 | test in the test suite except from 7 up to 11: | |
282 | ||
283 | $ sh ./t9200-git-cvsexport-commit.sh --run='!7-11' | |
284 | ||
285 | Some tests in a test suite rely on the previous tests performing | |
286 | certain actions, specifically some tests are designated as | |
287 | "setup" test, so you cannot _arbitrarily_ disable one test and | |
288 | expect the rest to function correctly. | |
289 | ||
290 | --run is mostly useful when you want to focus on a specific test | |
291 | and know what setup is needed for it. Or when you want to run | |
292 | everything up to a certain test. | |
fbd458a3 JN |
293 | |
294 | ||
f50c9f76 PB |
295 | Naming Tests |
296 | ------------ | |
297 | ||
298 | The test files are named as: | |
299 | ||
300 | tNNNN-commandname-details.sh | |
301 | ||
302 | where N is a decimal digit. | |
303 | ||
304 | First digit tells the family: | |
305 | ||
306 | 0 - the absolute basics and global stuff | |
307 | 1 - the basic commands concerning database | |
308 | 2 - the basic commands concerning the working tree | |
309 | 3 - the other basic commands (e.g. ls-files) | |
310 | 4 - the diff commands | |
311 | 5 - the pull and exporting commands | |
312 | 6 - the revision tree commands (even e.g. merge-base) | |
8f4a9b62 | 313 | 7 - the porcelainish commands concerning the working tree |
8757749e JN |
314 | 8 - the porcelainish commands concerning forensics |
315 | 9 - the git tools | |
f50c9f76 PB |
316 | |
317 | Second digit tells the particular command we are testing. | |
318 | ||
319 | Third digit (optionally) tells the particular switch or group of switches | |
320 | we are testing. | |
321 | ||
77656600 JH |
322 | If you create files under t/ directory (i.e. here) that is not |
323 | the top-level test script, never name the file to match the above | |
324 | pattern. The Makefile here considers all such files as the | |
63d32945 | 325 | top-level test script and tries to run all of them. Care is |
77656600 JH |
326 | especially needed if you are creating a common test library |
327 | file, similar to test-lib.sh, because such a library file may | |
328 | not be suitable for standalone execution. | |
329 | ||
f50c9f76 | 330 | |
986aa7f1 JH |
331 | Writing Tests |
332 | ------------- | |
333 | ||
334 | The test script is written as a shell script. It should start | |
335 | with the standard "#!/bin/sh" with copyright notices, and an | |
336 | assignment to variable 'test_description', like this: | |
337 | ||
338 | #!/bin/sh | |
339 | # | |
340 | # Copyright (c) 2005 Junio C Hamano | |
341 | # | |
342 | ||
14cd1ff3 | 343 | test_description='xxx test (option --frotz) |
986aa7f1 JH |
344 | |
345 | This test registers the following structure in the cache | |
346 | and tries to run git-ls-files with option --frotz.' | |
347 | ||
f50c9f76 | 348 | |
986aa7f1 JH |
349 | Source 'test-lib.sh' |
350 | -------------------- | |
351 | ||
352 | After assigning test_description, the test script should source | |
353 | test-lib.sh like this: | |
354 | ||
355 | . ./test-lib.sh | |
356 | ||
357 | This test harness library does the following things: | |
358 | ||
359 | - If the script is invoked with command line argument --help | |
360 | (or -h), it shows the test_description and exits. | |
361 | ||
e1ca1c9d ÆAB |
362 | - Creates an empty test directory with an empty .git/objects database |
363 | and chdir(2) into it. This directory is 't/trash | |
364 | directory.$test_name_without_dotsh', with t/ subject to change by | |
365 | the --root option documented above. | |
986aa7f1 JH |
366 | |
367 | - Defines standard test helper functions for your scripts to | |
368 | use. These functions are designed to make all scripts behave | |
369 | consistently when command line arguments --verbose (or -v), | |
370 | --debug (or -d), and --immediate (or -i) is given. | |
371 | ||
20873f45 ÆAB |
372 | Do's, don'ts & things to keep in mind |
373 | ------------------------------------- | |
374 | ||
6fd45295 | 375 | Here are a few examples of things you probably should and shouldn't do |
20873f45 ÆAB |
376 | when writing tests. |
377 | ||
378 | Do: | |
379 | ||
6fd45295 | 380 | - Put all code inside test_expect_success and other assertions. |
20873f45 ÆAB |
381 | |
382 | Even code that isn't a test per se, but merely some setup code | |
6fd45295 | 383 | should be inside a test assertion. |
20873f45 ÆAB |
384 | |
385 | - Chain your test assertions | |
386 | ||
387 | Write test code like this: | |
388 | ||
389 | git merge foo && | |
390 | git push bar && | |
391 | test ... | |
392 | ||
393 | Instead of: | |
394 | ||
395 | git merge hla | |
396 | git push gh | |
397 | test ... | |
398 | ||
399 | That way all of the commands in your tests will succeed or fail. If | |
00648ba0 EN |
400 | you must ignore the return value of something, consider using a |
401 | helper function (e.g. use sane_unset instead of unset, in order | |
402 | to avoid unportable return value for unsetting a variable that was | |
403 | already unset), or prepending the command with test_might_fail or | |
404 | test_must_fail. | |
20873f45 | 405 | |
0c357544 ÆAB |
406 | - Check the test coverage for your tests. See the "Test coverage" |
407 | below. | |
408 | ||
63d32945 MW |
409 | Don't blindly follow test coverage metrics; if a new function you added |
410 | doesn't have any coverage, then you're probably doing something wrong, | |
e8b55f5c ÆAB |
411 | but having 100% coverage doesn't necessarily mean that you tested |
412 | everything. | |
413 | ||
414 | Tests that are likely to smoke out future regressions are better | |
415 | than tests that just inflate the coverage metrics. | |
416 | ||
95b104c8 JS |
417 | - When a test checks for an absolute path that a git command generated, |
418 | construct the expected value using $(pwd) rather than $PWD, | |
419 | $TEST_DIRECTORY, or $TRASH_DIRECTORY. It makes a difference on | |
420 | Windows, where the shell (MSYS bash) mangles absolute path names. | |
421 | For details, see the commit message of 4114156ae9. | |
422 | ||
20873f45 ÆAB |
423 | Don't: |
424 | ||
425 | - exit() within a <script> part. | |
426 | ||
427 | The harness will catch this as a programming error of the test. | |
428 | Use test_done instead if you need to stop the tests early (see | |
429 | "Skipping tests" below). | |
430 | ||
ad78585e JH |
431 | - use '! git cmd' when you want to make sure the git command exits |
432 | with failure in a controlled way by calling "die()". Instead, | |
433 | use 'test_must_fail git cmd'. This will signal a failure if git | |
434 | dies in an unexpected way (e.g. segfault). | |
435 | ||
f445500e | 436 | On the other hand, don't use test_must_fail for running regular |
53de7424 JH |
437 | platform commands; just use '! cmd'. We are not in the business |
438 | of verifying that the world given to us sanely works. | |
f445500e | 439 | |
ad78585e JH |
440 | - use perl without spelling it as "$PERL_PATH". This is to help our |
441 | friends on Windows where the platform Perl often adds CR before | |
442 | the end of line, and they bundle Git with a version of Perl that | |
a0e0ec9f JK |
443 | does not do so, whose path is specified with $PERL_PATH. Note that we |
444 | provide a "perl" function which uses $PERL_PATH under the hood, so | |
445 | you do not need to worry when simply running perl in the test scripts | |
446 | (but you do, for example, on a shebang line or in a sub script | |
447 | created via "write_script"). | |
ad78585e JH |
448 | |
449 | - use sh without spelling it as "$SHELL_PATH", when the script can | |
450 | be misinterpreted by broken platform shell (e.g. Solaris). | |
451 | ||
452 | - chdir around in tests. It is not sufficient to chdir to | |
453 | somewhere and then chdir back to the original location later in | |
454 | the test, as any intermediate step can fail and abort the test, | |
455 | causing the next test to start in an unexpected directory. Do so | |
456 | inside a subshell if necessary. | |
457 | ||
20873f45 ÆAB |
458 | - Break the TAP output |
459 | ||
6fd45295 JH |
460 | The raw output from your test may be interpreted by a TAP harness. TAP |
461 | harnesses will ignore everything they don't know about, but don't step | |
462 | on their toes in these areas: | |
20873f45 ÆAB |
463 | |
464 | - Don't print lines like "$x..$y" where $x and $y are integers. | |
465 | ||
466 | - Don't print lines that begin with "ok" or "not ok". | |
467 | ||
6fd45295 | 468 | TAP harnesses expect a line that begins with either "ok" and "not |
20873f45 ÆAB |
469 | ok" to signal a test passed or failed (and our harness already |
470 | produces such lines), so your script shouldn't emit such lines to | |
471 | their output. | |
472 | ||
473 | You can glean some further possible issues from the TAP grammar | |
c1d44cee | 474 | (see https://metacpan.org/pod/TAP::Parser::Grammar#TAP-GRAMMAR) |
20873f45 ÆAB |
475 | but the best indication is to just run the tests with prove(1), |
476 | it'll complain if anything is amiss. | |
477 | ||
478 | Keep in mind: | |
479 | ||
57f82f4f | 480 | - Inside the <script> part, the standard output and standard error |
20873f45 ÆAB |
481 | streams are discarded, and the test harness only reports "ok" or |
482 | "not ok" to the end user running the tests. Under --verbose, they | |
483 | are shown to help debugging the tests. | |
484 | ||
485 | ||
b5500d16 ÆAB |
486 | Skipping tests |
487 | -------------- | |
488 | ||
681186ae | 489 | If you need to skip tests you should do so by using the three-arg form |
99d9050d ÆAB |
490 | of the test_* functions (see the "Test harness library" section |
491 | below), e.g.: | |
492 | ||
ad78585e | 493 | test_expect_success PERL 'I need Perl' ' |
a0e0ec9f | 494 | perl -e "hlagh() if unf_unf()" |
ad78585e | 495 | ' |
99d9050d ÆAB |
496 | |
497 | The advantage of skipping tests like this is that platforms that don't | |
498 | have the PERL and other optional dependencies get an indication of how | |
499 | many tests they're missing. | |
500 | ||
501 | If the test code is too hairy for that (i.e. does a lot of setup work | |
502 | outside test assertions) you can also skip all remaining tests by | |
503 | setting skip_all and immediately call test_done: | |
b5500d16 ÆAB |
504 | |
505 | if ! test_have_prereq PERL | |
506 | then | |
507 | skip_all='skipping perl interface tests, perl not available' | |
508 | test_done | |
509 | fi | |
14cd1ff3 | 510 | |
99d9050d ÆAB |
511 | The string you give to skip_all will be used as an explanation for why |
512 | the test was skipped. | |
513 | ||
986aa7f1 JH |
514 | End with test_done |
515 | ------------------ | |
516 | ||
517 | Your script will be a sequence of tests, using helper functions | |
518 | from the test harness library. At the end of the script, call | |
519 | 'test_done'. | |
520 | ||
521 | ||
522 | Test harness library | |
523 | -------------------- | |
524 | ||
525 | There are a handful helper functions defined in the test harness | |
526 | library for your script to use. | |
527 | ||
9a897893 | 528 | - test_expect_success [<prereq>] <message> <script> |
986aa7f1 | 529 | |
72942a61 | 530 | Usually takes two strings as parameters, and evaluates the |
986aa7f1 JH |
531 | <script>. If it yields success, test is considered |
532 | successful. <message> should state what it is testing. | |
533 | ||
534 | Example: | |
535 | ||
536 | test_expect_success \ | |
537 | 'git-write-tree should be able to write an empty tree.' \ | |
538 | 'tree=$(git-write-tree)' | |
539 | ||
9a897893 | 540 | If you supply three parameters the first will be taken to be a |
72942a61 | 541 | prerequisite; see the test_set_prereq and test_have_prereq |
9a897893 ÆAB |
542 | documentation below: |
543 | ||
544 | test_expect_success TTY 'git --paginate rev-list uses a pager' \ | |
545 | ' ... ' | |
546 | ||
93a57246 ÆAB |
547 | You can also supply a comma-separated list of prerequisites, in the |
548 | rare case where your test depends on more than one: | |
549 | ||
550 | test_expect_success PERL,PYTHON 'yo dawg' \ | |
551 | ' test $(perl -E 'print eval "1 +" . qx[python -c "print 2"]') == "4" ' | |
552 | ||
9a897893 | 553 | - test_expect_failure [<prereq>] <message> <script> |
986aa7f1 | 554 | |
41ac414e JH |
555 | This is NOT the opposite of test_expect_success, but is used |
556 | to mark a test that demonstrates a known breakage. Unlike | |
557 | the usual test_expect_success tests, which say "ok" on | |
558 | success and "FAIL" on failure, this will say "FIXED" on | |
559 | success and "still broken" on failure. Failures from these | |
560 | tests won't cause -i (immediate) to stop. | |
986aa7f1 | 561 | |
9a897893 ÆAB |
562 | Like test_expect_success this function can optionally use a three |
563 | argument invocation with a prerequisite as the first argument. | |
564 | ||
986aa7f1 JH |
565 | - test_debug <script> |
566 | ||
567 | This takes a single argument, <script>, and evaluates it only | |
568 | when the test script is started with --debug command line | |
569 | argument. This is primarily meant for use during the | |
570 | development of a new test script. | |
571 | ||
6a94088c JS |
572 | - debug <git-command> |
573 | ||
574 | Run a git command inside a debugger. This is primarily meant for | |
575 | use when debugging a failing test script. | |
576 | ||
986aa7f1 JH |
577 | - test_done |
578 | ||
579 | Your test script must have test_done at the end. Its purpose | |
580 | is to summarize successes and failures in the test script and | |
581 | exit with an appropriate error code. | |
582 | ||
00884968 JS |
583 | - test_tick |
584 | ||
585 | Make commit and tag names consistent by setting the author and | |
63d32945 | 586 | committer times to defined state. Subsequent calls will |
00884968 JS |
587 | advance the times by a fixed amount. |
588 | ||
589 | - test_commit <message> [<filename> [<contents>]] | |
590 | ||
591 | Creates a commit with the given message, committing the given | |
592 | file with the given contents (default for both is to reuse the | |
593 | message string), and adds a tag (again reusing the message | |
594 | string as name). Calls test_tick to make the SHA-1s | |
595 | reproducible. | |
596 | ||
597 | - test_merge <message> <commit-or-tag> | |
598 | ||
599 | Merges the given rev using the given message. Like test_commit, | |
600 | creates a tag and calls test_tick before committing. | |
986aa7f1 | 601 | |
72942a61 | 602 | - test_set_prereq <prereq> |
9a897893 ÆAB |
603 | |
604 | Set a test prerequisite to be used later with test_have_prereq. The | |
be53deef ÆAB |
605 | test-lib will set some prerequisites for you, see the |
606 | "Prerequisites" section below for a full list of these. | |
607 | ||
608 | Others you can set yourself and use later with either | |
609 | test_have_prereq directly, or the three argument invocation of | |
610 | test_expect_success and test_expect_failure. | |
9a897893 | 611 | |
72942a61 | 612 | - test_have_prereq <prereq> |
9a897893 | 613 | |
4473060b ÆAB |
614 | Check if we have a prerequisite previously set with test_set_prereq. |
615 | The most common way to use this explicitly (as opposed to the | |
616 | implicit use when an argument is passed to test_expect_*) is to skip | |
617 | all the tests at the start of the test script if we don't have some | |
618 | essential prerequisite: | |
9a897893 ÆAB |
619 | |
620 | if ! test_have_prereq PERL | |
621 | then | |
622 | skip_all='skipping perl interface tests, perl not available' | |
623 | test_done | |
624 | fi | |
625 | ||
2fac6a4b ÆAB |
626 | - test_external [<prereq>] <message> <external> <script> |
627 | ||
628 | Execute a <script> with an <external> interpreter (like perl). This | |
629 | was added for tests like t9700-perl-git.sh which do most of their | |
630 | work in an external test script. | |
631 | ||
632 | test_external \ | |
633 | 'GitwebCache::*FileCache*' \ | |
a0e0ec9f | 634 | perl "$TEST_DIRECTORY"/t9503/test_cache_interface.pl |
2fac6a4b ÆAB |
635 | |
636 | If the test is outputting its own TAP you should set the | |
637 | test_external_has_tap variable somewhere before calling the first | |
638 | test_external* function. See t9700-perl-git.sh for an example. | |
639 | ||
640 | # The external test will outputs its own plan | |
641 | test_external_has_tap=1 | |
642 | ||
643 | - test_external_without_stderr [<prereq>] <message> <external> <script> | |
644 | ||
645 | Like test_external but fail if there's any output on stderr, | |
646 | instead of checking the exit code. | |
647 | ||
648 | test_external_without_stderr \ | |
649 | 'Perl API' \ | |
a0e0ec9f | 650 | perl "$TEST_DIRECTORY"/t9700/test.pl |
2fac6a4b | 651 | |
892e6f7e ÆAB |
652 | - test_expect_code <exit-code> <command> |
653 | ||
654 | Run a command and ensure that it exits with the given exit code. | |
655 | For example: | |
656 | ||
657 | test_expect_success 'Merge with d/f conflicts' ' | |
658 | test_expect_code 1 git merge "merge msg" B master | |
659 | ' | |
660 | ||
c9667456 JN |
661 | - test_must_fail <git-command> |
662 | ||
663 | Run a git command and ensure it fails in a controlled way. Use | |
971ecbd1 BC |
664 | this instead of "! <git-command>". When git-command dies due to a |
665 | segfault, test_must_fail diagnoses it as an error; "! <git-command>" | |
666 | treats it as just another expected failure, which would let such a | |
667 | bug go unnoticed. | |
c9667456 JN |
668 | |
669 | - test_might_fail <git-command> | |
670 | ||
671 | Similar to test_must_fail, but tolerate success, too. Use this | |
672 | instead of "<git-command> || :" to catch failures due to segv. | |
673 | ||
674 | - test_cmp <expected> <actual> | |
675 | ||
676 | Check whether the content of the <actual> file matches the | |
677 | <expected> file. This behaves like "cmp" but produces more | |
678 | helpful output when the test is run with "-v" option. | |
679 | ||
fb3340a6 JN |
680 | - test_line_count (= | -lt | -ge | ...) <length> <file> |
681 | ||
682 | Check whether a file has the length it is expected to. | |
683 | ||
72942a61 ML |
684 | - test_path_is_file <path> [<diagnosis>] |
685 | test_path_is_dir <path> [<diagnosis>] | |
2caf20c5 MM |
686 | test_path_is_missing <path> [<diagnosis>] |
687 | ||
72942a61 ML |
688 | Check if the named path is a file, if the named path is a |
689 | directory, or if the named path does not exist, respectively, | |
690 | and fail otherwise, showing the <diagnosis> text. | |
2caf20c5 | 691 | |
c9667456 JN |
692 | - test_when_finished <script> |
693 | ||
694 | Prepend <script> to a list of commands to run to clean up | |
695 | at the end of the current test. If some clean-up command | |
696 | fails, the test will not pass. | |
697 | ||
698 | Example: | |
699 | ||
700 | test_expect_success 'branch pointing to non-commit' ' | |
701 | git rev-parse HEAD^{tree} >.git/refs/heads/invalid && | |
702 | test_when_finished "git update-ref -d refs/heads/invalid" && | |
703 | ... | |
704 | ' | |
705 | ||
bb98b01e | 706 | - test_write_lines <lines> |
ac9afcc3 | 707 | |
bb98b01e | 708 | Write <lines> on standard output, one line per argument. |
ac9afcc3 MT |
709 | Useful to prepare multi-line files in a compact form. |
710 | ||
711 | Example: | |
712 | ||
bb98b01e | 713 | test_write_lines a b c d e f g >foo |
ac9afcc3 MT |
714 | |
715 | Is a more compact equivalent of: | |
716 | cat >foo <<-EOF | |
717 | a | |
718 | b | |
719 | c | |
720 | d | |
721 | e | |
722 | f | |
723 | g | |
724 | EOF | |
725 | ||
726 | ||
c4d2539a JL |
727 | - test_pause |
728 | ||
729 | This command is useful for writing and debugging tests and must be | |
730 | removed before submitting. It halts the execution of the test and | |
731 | spawns a shell in the trash directory. Exit the shell to continue | |
732 | the test. Example: | |
733 | ||
734 | test_expect_success 'test' ' | |
735 | git do-something >actual && | |
736 | test_pause && | |
737 | test_cmp expected actual | |
738 | ' | |
739 | ||
9ce415d9 JS |
740 | - test_ln_s_add <path1> <path2> |
741 | ||
742 | This function helps systems whose filesystem does not support symbolic | |
743 | links. Use it to add a symbolic link entry to the index when it is not | |
744 | important that the file system entry is a symbolic link, i.e., instead | |
745 | of the sequence | |
746 | ||
747 | ln -s foo bar && | |
748 | git add bar | |
749 | ||
750 | Sometimes it is possible to split a test in a part that does not need | |
751 | the symbolic link in the file system and a part that does; then only | |
752 | the latter part need be protected by a SYMLINKS prerequisite (see below). | |
753 | ||
be53deef ÆAB |
754 | Prerequisites |
755 | ------------- | |
756 | ||
757 | These are the prerequisites that the test library predefines with | |
758 | test_have_prereq. | |
759 | ||
760 | See the prereq argument to the test_* functions in the "Test harness | |
761 | library" section above and the "test_have_prereq" function for how to | |
762 | use these, and "test_set_prereq" for how to define your own. | |
763 | ||
f8fc0ee3 | 764 | - PYTHON |
be53deef | 765 | |
f8fc0ee3 JN |
766 | Git wasn't compiled with NO_PYTHON=YesPlease. Wrap any tests that |
767 | need Python with this. | |
768 | ||
769 | - PERL | |
770 | ||
771 | Git wasn't compiled with NO_PERL=YesPlease. | |
772 | ||
773 | Even without the PERL prerequisite, tests can assume there is a | |
774 | usable perl interpreter at $PERL_PATH, though it need not be | |
775 | particularly modern. | |
be53deef ÆAB |
776 | |
777 | - POSIXPERM | |
778 | ||
779 | The filesystem supports POSIX style permission bits. | |
780 | ||
781 | - BSLASHPSPEC | |
782 | ||
783 | Backslashes in pathspec are not directory separators. This is not | |
784 | set on Windows. See 6fd1106a for details. | |
785 | ||
786 | - EXECKEEPSPID | |
787 | ||
788 | The process retains the same pid across exec(2). See fb9a2bea for | |
789 | details. | |
790 | ||
20073274 AS |
791 | - PIPE |
792 | ||
793 | The filesystem we're on supports creation of FIFOs (named pipes) | |
794 | via mkfifo(1). | |
795 | ||
be53deef ÆAB |
796 | - SYMLINKS |
797 | ||
798 | The filesystem we're on supports symbolic links. E.g. a FAT | |
799 | filesystem doesn't support these. See 704a3143 for details. | |
2fac6a4b | 800 | |
c91cfd19 ÆAB |
801 | - SANITY |
802 | ||
803 | Test is not run by root user, and an attempt to write to an | |
804 | unwritable file is expected to fail correctly. | |
2fac6a4b | 805 | |
3eb585c1 | 806 | - PCRE |
8f852ce6 | 807 | |
3eb585c1 | 808 | Git was compiled with support for PCRE. Wrap any tests |
8f852ce6 MK |
809 | that use git-grep --perl-regexp or git-grep -P in these. |
810 | ||
ac39aa61 MG |
811 | - CASE_INSENSITIVE_FS |
812 | ||
813 | Test is run on a case insensitive file system. | |
814 | ||
5b0b5dd4 MG |
815 | - UTF8_NFD_TO_NFC |
816 | ||
817 | Test is run on a filesystem which converts decomposed utf-8 (nfd) | |
818 | to precomposed utf-8 (nfc). | |
819 | ||
68c7d276 ÆAB |
820 | - PTHREADS |
821 | ||
822 | Git wasn't compiled with NO_PTHREADS=YesPlease. | |
823 | ||
986aa7f1 JH |
824 | Tips for Writing Tests |
825 | ---------------------- | |
826 | ||
827 | As with any programming projects, existing programs are the best | |
828 | source of the information. However, do _not_ emulate | |
829 | t0000-basic.sh when writing your tests. The test is special in | |
830 | that it tries to validate the very core of GIT. For example, it | |
831 | knows that there will be 256 subdirectories under .git/objects/, | |
832 | and it knows that the object ID of an empty tree is a certain | |
833 | 40-byte string. This is deliberately done so in t0000-basic.sh | |
834 | because the things the very basic core test tries to achieve is | |
835 | to serve as a basis for people who are changing the GIT internal | |
836 | drastically. For these people, after making certain changes, | |
837 | not seeing failures from the basic test _is_ a failure. And | |
838 | such drastic changes to the core GIT that even changes these | |
839 | otherwise supposedly stable object IDs should be accompanied by | |
840 | an update to t0000-basic.sh. | |
841 | ||
842 | However, other tests that simply rely on basic parts of the core | |
843 | GIT working properly should not have that level of intimate | |
844 | knowledge of the core GIT internals. If all the test scripts | |
845 | hardcoded the object IDs like t0000-basic.sh does, that defeats | |
846 | the purpose of t0000-basic.sh, which is to isolate that level of | |
847 | validation in one place. Your test also ends up needing | |
848 | updating when such a change to the internal happens, so do _not_ | |
849 | do it and leave the low level of validation to t0000-basic.sh. | |
d15e9ebc | 850 | |
0c357544 ÆAB |
851 | Test coverage |
852 | ------------- | |
853 | ||
854 | You can use the coverage tests to find code paths that are not being | |
855 | used or properly exercised yet. | |
856 | ||
857 | To do that, run the coverage target at the top-level (not in the t/ | |
858 | directory): | |
859 | ||
860 | make coverage | |
861 | ||
862 | That'll compile Git with GCC's coverage arguments, and generate a test | |
863 | report with gcov after the tests finish. Running the coverage tests | |
864 | can take a while, since running the tests in parallel is incompatible | |
865 | with GCC's coverage mode. | |
866 | ||
867 | After the tests have run you can generate a list of untested | |
868 | functions: | |
869 | ||
870 | make coverage-untested-functions | |
871 | ||
872 | You can also generate a detailed per-file HTML report using the | |
873 | Devel::Cover module. To install it do: | |
874 | ||
875 | # On Debian or Ubuntu: | |
876 | sudo aptitude install libdevel-cover-perl | |
877 | ||
878 | # From the CPAN with cpanminus | |
879 | curl -L http://cpanmin.us | perl - --sudo --self-upgrade | |
880 | cpanm --sudo Devel::Cover | |
881 | ||
882 | Then, at the top-level: | |
883 | ||
884 | make cover_db_html | |
885 | ||
886 | That'll generate a detailed cover report in the "cover_db_html" | |
887 | directory, which you can then copy to a webserver, or inspect locally | |
888 | in a browser. |