Allow $RSYNC_TEST_TMP to indicate a good tmp dir for our tests.
[rsync/rsync.git] / testsuite / README.testsuite
1 automatic testsuite for rsync                   -*- text -*-
2
3 We're trying to develop some more substantial tests to prevent rsync
4 regressions.  Ideally, all code changes or bug reports would come with
5 an appropriate test suite.
6
7 You can run these tests by typing "make check" in the build directory.
8 The tests will run using the rsync binary in the build directory, so
9 you do not need to do "make install" first.  Indeed, you probably
10 should not install rsync before running the tests.
11
12 If you instead type "make installcheck" then the suite will test the
13 rsync binary from its installed location (e.g. /usr/local/bin/rsync).
14 You can use this to test a distribution build, or perhaps to run a new
15 test suite against an old version of rsync.  Note that in accordance
16 with the GNU Standards, installcheck does not look for rsync on the
17 path.
18
19 If the tests pass, you should see a report to that effect.  Some tests
20 require being root or some other precondition, and so will normally not
21 be checked -- look at the test scripts for more information.
22
23 If the tests fail, you will see rather more output.  The scratch
24 directory will remain in the build directory.  It would be useful if
25 you could include the log messages when reporting a failure.
26
27 These tests also run automatically on the build farm, and you can see
28 the results on http://build.samba.org/.
29
30