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
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.
17 The easiest way to run tests is to say "make". This runs all
20 *** t0000-basic.sh ***
21 * ok 1: .git/objects should be empty after git-init in an empty repo.
22 * ok 2: .git/objects should have 256 subdirectories.
23 * ok 3: git-update-index without --add should fail adding.
25 * ok 23: no diff after checkout and git-update-index --refresh.
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.
32 Or you can run each test individually from command line, like
35 $ sh ./t3001-ls-files-killed.sh
36 * ok 1: git-update-index --add to add various paths.
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)
41 You can pass --verbose (or -v), --debug (or -d), and --immediate
42 (or -i) command line argument to the test, or by setting GIT_TEST_OPTS
43 appropriately before running "make".
46 This makes the test more verbose. Specifically, the
47 command being run and their output if any are also
51 This may help the person who is developing a new test.
52 It causes the command defined with test_debug to run.
55 This causes the test to immediately exit upon the first
59 This causes additional long-running tests to be run (where
60 available), for more exhaustive testing.
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.
71 In some environments, certain tests have no way of succeeding
72 due to platform limitation, such as lack of 'unzip' program, or
73 filesystem that do not allow arbitrary sequence of non-NUL bytes
76 You should be able to say something like
78 $ GIT_SKIP_TESTS=t9200.8 sh ./t9200-git-cvsexport-commit.sh
82 $ GIT_SKIP_TESTS='t[0-4]??? t91?? t9200.8' make
84 to omit such tests. The value of the environment variable is a
85 SP separated list of patterns that tells which tests to skip,
86 and either can match the "t[0-9]{4}" part to skip the whole
87 test, or t[0-9]{4} followed by ".$number" to say which
88 particular test to skip.
90 Note that some tests in the existing test suite rely on previous
91 test item, so you cannot arbitrarily disable one and expect the
92 remainder of test to check what the test originally was intended
99 The test files are named as:
101 tNNNN-commandname-details.sh
103 where N is a decimal digit.
105 First digit tells the family:
107 0 - the absolute basics and global stuff
108 1 - the basic commands concerning database
109 2 - the basic commands concerning the working tree
110 3 - the other basic commands (e.g. ls-files)
111 4 - the diff commands
112 5 - the pull and exporting commands
113 6 - the revision tree commands (even e.g. merge-base)
114 7 - the porcelainish commands concerning the working tree
115 8 - the porcelainish commands concerning forensics
118 Second digit tells the particular command we are testing.
120 Third digit (optionally) tells the particular switch or group of switches
123 If you create files under t/ directory (i.e. here) that is not
124 the top-level test script, never name the file to match the above
125 pattern. The Makefile here considers all such files as the
126 top-level test script and tries to run all of them. A care is
127 especially needed if you are creating a common test library
128 file, similar to test-lib.sh, because such a library file may
129 not be suitable for standalone execution.
135 The test script is written as a shell script. It should start
136 with the standard "#!/bin/sh" with copyright notices, and an
137 assignment to variable 'test_description', like this:
141 # Copyright (c) 2005 Junio C Hamano
144 test_description='xxx test (option --frotz)
146 This test registers the following structure in the cache
147 and tries to run git-ls-files with option --frotz.'
153 After assigning test_description, the test script should source
154 test-lib.sh like this:
158 This test harness library does the following things:
160 - If the script is invoked with command line argument --help
161 (or -h), it shows the test_description and exits.
163 - Creates an empty test directory with an empty .git/objects
164 database and chdir(2) into it. This directory is 't/trash directory'
165 if you must know, but I do not think you care.
167 - Defines standard test helper functions for your scripts to
168 use. These functions are designed to make all scripts behave
169 consistently when command line arguments --verbose (or -v),
170 --debug (or -d), and --immediate (or -i) is given.
176 Your script will be a sequence of tests, using helper functions
177 from the test harness library. At the end of the script, call
184 There are a handful helper functions defined in the test harness
185 library for your script to use.
187 - test_expect_success <message> <script>
189 This takes two strings as parameter, and evaluates the
190 <script>. If it yields success, test is considered
191 successful. <message> should state what it is testing.
195 test_expect_success \
196 'git-write-tree should be able to write an empty tree.' \
197 'tree=$(git-write-tree)'
199 - test_expect_failure <message> <script>
201 This is NOT the opposite of test_expect_success, but is used
202 to mark a test that demonstrates a known breakage. Unlike
203 the usual test_expect_success tests, which say "ok" on
204 success and "FAIL" on failure, this will say "FIXED" on
205 success and "still broken" on failure. Failures from these
206 tests won't cause -i (immediate) to stop.
208 - test_debug <script>
210 This takes a single argument, <script>, and evaluates it only
211 when the test script is started with --debug command line
212 argument. This is primarily meant for use during the
213 development of a new test script.
217 Your test script must have test_done at the end. Its purpose
218 is to summarize successes and failures in the test script and
219 exit with an appropriate error code.
223 Make commit and tag names consistent by setting the author and
224 committer times to defined stated. Subsequent calls will
225 advance the times by a fixed amount.
227 - test_commit <message> [<filename> [<contents>]]
229 Creates a commit with the given message, committing the given
230 file with the given contents (default for both is to reuse the
231 message string), and adds a tag (again reusing the message
232 string as name). Calls test_tick to make the SHA-1s
235 - test_merge <message> <commit-or-tag>
237 Merges the given rev using the given message. Like test_commit,
238 creates a tag and calls test_tick before committing.
240 Tips for Writing Tests
241 ----------------------
243 As with any programming projects, existing programs are the best
244 source of the information. However, do _not_ emulate
245 t0000-basic.sh when writing your tests. The test is special in
246 that it tries to validate the very core of GIT. For example, it
247 knows that there will be 256 subdirectories under .git/objects/,
248 and it knows that the object ID of an empty tree is a certain
249 40-byte string. This is deliberately done so in t0000-basic.sh
250 because the things the very basic core test tries to achieve is
251 to serve as a basis for people who are changing the GIT internal
252 drastically. For these people, after making certain changes,
253 not seeing failures from the basic test _is_ a failure. And
254 such drastic changes to the core GIT that even changes these
255 otherwise supposedly stable object IDs should be accompanied by
256 an update to t0000-basic.sh.
258 However, other tests that simply rely on basic parts of the core
259 GIT working properly should not have that level of intimate
260 knowledge of the core GIT internals. If all the test scripts
261 hardcoded the object IDs like t0000-basic.sh does, that defeats
262 the purpose of t0000-basic.sh, which is to isolate that level of
263 validation in one place. Your test also ends up needing
264 updating when such a change to the internal happens, so do _not_
265 do it and leave the low level of validation to t0000-basic.sh.