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