Add a script to coalesce the valgrind outputs
[git/git.git] / t / README
CommitLineData
986aa7f1
JH
1Core GIT Tests
2==============
3
4This directory holds many test scripts for core GIT tools. The
5first part of this short document describes how to run the tests
6and read their output.
7
8When fixing the tools or adding enhancements, you are strongly
9encouraged to add tests in this directory to cover what you are
10trying to fix or enhance. The later part of this short document
11describes how your test scripts should be organized.
12
13
14Running Tests
15-------------
16
17The easiest way to run tests is to say "make". This runs all
18the tests.
19
20 *** t0000-basic.sh ***
5c94f87e 21 * ok 1: .git/objects should be empty after git-init in an empty repo.
986aa7f1 22 * ok 2: .git/objects should have 256 subdirectories.
215a7ad1 23 * ok 3: git-update-index without --add should fail adding.
986aa7f1 24 ...
215a7ad1 25 * ok 23: no diff after checkout and git-update-index --refresh.
986aa7f1
JH
26 * passed all 23 test(s)
27 *** t0100-environment-names.sh ***
28 * ok 1: using old names should issue warnings.
29 * ok 2: using old names but having new names should not issue warnings.
30 ...
31
32Or you can run each test individually from command line, like
33this:
34
14cd1ff3 35 $ sh ./t3001-ls-files-killed.sh
215a7ad1 36 * ok 1: git-update-index --add to add various paths.
986aa7f1
JH
37 * ok 2: git-ls-files -k to show killed files.
38 * ok 3: validate git-ls-files -k output.
39 * passed all 3 test(s)
40
41You can pass --verbose (or -v), --debug (or -d), and --immediate
4e1be63c
JS
42(or -i) command line argument to the test, or by setting GIT_TEST_OPTS
43appropriately before running "make".
986aa7f1
JH
44
45--verbose::
46 This makes the test more verbose. Specifically, the
47 command being run and their output if any are also
48 output.
49
50--debug::
51 This may help the person who is developing a new test.
52 It causes the command defined with test_debug to run.
53
54--immediate::
55 This causes the test to immediately exit upon the first
56 failed test.
57
5e2c08c6
LW
58--long-tests::
59 This causes additional long-running tests to be run (where
60 available), for more exhaustive testing.
61
4e1be63c
JS
62--valgrind::
63 Execute all Git binaries with valgrind and exit with status
64 126 on errors (just like regular tests, this will only stop
65 the test script when running under -i). Valgrind errors
66 go to stderr, so you might want to pass the -v option, too.
986aa7f1 67
44138559
JS
68--tee::
69 In addition to printing the test output to the terminal,
70 write it to files named 't/test-results/$TEST_NAME.out'.
71 As the names depend on the tests' file names, it is safe to
72 run the tests with this option in parallel.
73
fbd458a3
JN
74Skipping Tests
75--------------
76
77In some environments, certain tests have no way of succeeding
78due to platform limitation, such as lack of 'unzip' program, or
79filesystem that do not allow arbitrary sequence of non-NUL bytes
80as pathnames.
81
82You should be able to say something like
83
84 $ GIT_SKIP_TESTS=t9200.8 sh ./t9200-git-cvsexport-commit.sh
85
86and even:
87
88 $ GIT_SKIP_TESTS='t[0-4]??? t91?? t9200.8' make
89
90to omit such tests. The value of the environment variable is a
91SP separated list of patterns that tells which tests to skip,
92and either can match the "t[0-9]{4}" part to skip the whole
93test, or t[0-9]{4} followed by ".$number" to say which
94particular test to skip.
95
96Note that some tests in the existing test suite rely on previous
97test item, so you cannot arbitrarily disable one and expect the
98remainder of test to check what the test originally was intended
99to check.
100
101
f50c9f76
PB
102Naming Tests
103------------
104
105The test files are named as:
106
107 tNNNN-commandname-details.sh
108
109where N is a decimal digit.
110
111First digit tells the family:
112
113 0 - the absolute basics and global stuff
114 1 - the basic commands concerning database
115 2 - the basic commands concerning the working tree
116 3 - the other basic commands (e.g. ls-files)
117 4 - the diff commands
118 5 - the pull and exporting commands
119 6 - the revision tree commands (even e.g. merge-base)
8f4a9b62 120 7 - the porcelainish commands concerning the working tree
8757749e
JN
121 8 - the porcelainish commands concerning forensics
122 9 - the git tools
f50c9f76
PB
123
124Second digit tells the particular command we are testing.
125
126Third digit (optionally) tells the particular switch or group of switches
127we are testing.
128
77656600
JH
129If you create files under t/ directory (i.e. here) that is not
130the top-level test script, never name the file to match the above
131pattern. The Makefile here considers all such files as the
132top-level test script and tries to run all of them. A care is
133especially needed if you are creating a common test library
134file, similar to test-lib.sh, because such a library file may
135not be suitable for standalone execution.
136
f50c9f76 137
986aa7f1
JH
138Writing Tests
139-------------
140
141The test script is written as a shell script. It should start
142with the standard "#!/bin/sh" with copyright notices, and an
143assignment to variable 'test_description', like this:
144
145 #!/bin/sh
146 #
147 # Copyright (c) 2005 Junio C Hamano
148 #
149
14cd1ff3 150 test_description='xxx test (option --frotz)
986aa7f1
JH
151
152 This test registers the following structure in the cache
153 and tries to run git-ls-files with option --frotz.'
154
f50c9f76 155
986aa7f1
JH
156Source 'test-lib.sh'
157--------------------
158
159After assigning test_description, the test script should source
160test-lib.sh like this:
161
162 . ./test-lib.sh
163
164This test harness library does the following things:
165
166 - If the script is invoked with command line argument --help
167 (or -h), it shows the test_description and exits.
168
169 - Creates an empty test directory with an empty .git/objects
9231e3a9 170 database and chdir(2) into it. This directory is 't/trash directory'
986aa7f1
JH
171 if you must know, but I do not think you care.
172
173 - Defines standard test helper functions for your scripts to
174 use. These functions are designed to make all scripts behave
175 consistently when command line arguments --verbose (or -v),
176 --debug (or -d), and --immediate (or -i) is given.
177
14cd1ff3 178
986aa7f1
JH
179End with test_done
180------------------
181
182Your script will be a sequence of tests, using helper functions
183from the test harness library. At the end of the script, call
184'test_done'.
185
186
187Test harness library
188--------------------
189
190There are a handful helper functions defined in the test harness
191library for your script to use.
192
193 - test_expect_success <message> <script>
194
195 This takes two strings as parameter, and evaluates the
196 <script>. If it yields success, test is considered
197 successful. <message> should state what it is testing.
198
199 Example:
200
201 test_expect_success \
202 'git-write-tree should be able to write an empty tree.' \
203 'tree=$(git-write-tree)'
204
205 - test_expect_failure <message> <script>
206
41ac414e
JH
207 This is NOT the opposite of test_expect_success, but is used
208 to mark a test that demonstrates a known breakage. Unlike
209 the usual test_expect_success tests, which say "ok" on
210 success and "FAIL" on failure, this will say "FIXED" on
211 success and "still broken" on failure. Failures from these
212 tests won't cause -i (immediate) to stop.
986aa7f1
JH
213
214 - test_debug <script>
215
216 This takes a single argument, <script>, and evaluates it only
217 when the test script is started with --debug command line
218 argument. This is primarily meant for use during the
219 development of a new test script.
220
221 - test_done
222
223 Your test script must have test_done at the end. Its purpose
224 is to summarize successes and failures in the test script and
225 exit with an appropriate error code.
226
00884968
JS
227 - test_tick
228
229 Make commit and tag names consistent by setting the author and
230 committer times to defined stated. Subsequent calls will
231 advance the times by a fixed amount.
232
233 - test_commit <message> [<filename> [<contents>]]
234
235 Creates a commit with the given message, committing the given
236 file with the given contents (default for both is to reuse the
237 message string), and adds a tag (again reusing the message
238 string as name). Calls test_tick to make the SHA-1s
239 reproducible.
240
241 - test_merge <message> <commit-or-tag>
242
243 Merges the given rev using the given message. Like test_commit,
244 creates a tag and calls test_tick before committing.
986aa7f1
JH
245
246Tips for Writing Tests
247----------------------
248
249As with any programming projects, existing programs are the best
250source of the information. However, do _not_ emulate
251t0000-basic.sh when writing your tests. The test is special in
252that it tries to validate the very core of GIT. For example, it
253knows that there will be 256 subdirectories under .git/objects/,
254and it knows that the object ID of an empty tree is a certain
25540-byte string. This is deliberately done so in t0000-basic.sh
256because the things the very basic core test tries to achieve is
257to serve as a basis for people who are changing the GIT internal
258drastically. For these people, after making certain changes,
259not seeing failures from the basic test _is_ a failure. And
260such drastic changes to the core GIT that even changes these
261otherwise supposedly stable object IDs should be accompanied by
262an update to t0000-basic.sh.
263
264However, other tests that simply rely on basic parts of the core
265GIT working properly should not have that level of intimate
266knowledge of the core GIT internals. If all the test scripts
267hardcoded the object IDs like t0000-basic.sh does, that defeats
268the purpose of t0000-basic.sh, which is to isolate that level of
269validation in one place. Your test also ends up needing
270updating when such a change to the internal happens, so do _not_
271do it and leave the low level of validation to t0000-basic.sh.