Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 61 lines (43 sloc) 1.994 kb
2fe3d9d @sitaramc minor fixups
authored
1 % testing gitolite
b90a077 @sitaramc initial version
authored
2
82e3298 @sitaramc all mkds
authored
3 # testing gitolite
4
5 include sidebar-toc
b90a077 @sitaramc initial version
authored
6
ef33ef2 @sitaramc misc fixups
authored
7 <font color="red">**WARNING: this will clobber [these files and
82e3298 @sitaramc all mkds
authored
8 directories][clobber] in your `$HOME`. Ideally, you should use a throwaway
ef33ef2 @sitaramc misc fixups
authored
9 userid**.</font>
b90a077 @sitaramc initial version
authored
10
82e3298 @sitaramc all mkds
authored
11 Running gitolite's test suite is really just a superset of [trying it out
9090d1a @sitaramc misc
authored
12 safely][trying].
3641d1b @sitaramc added two "documentation map" pictures!
authored
13
82e3298 @sitaramc all mkds
authored
14 To run the full test suite, create a **throw-away userid**, log in to it, then
15 run these commands:
3641d1b @sitaramc added two "documentation map" pictures!
authored
16
b90a077 @sitaramc initial version
authored
17 git clone git://github.com/sitaramc/gitolite
18 cd gitolite
82e3298 @sitaramc all mkds
authored
19 prove
3641d1b @sitaramc added two "documentation map" pictures!
authored
20
21 You will get an error that forces you to read `t/README` and set an env var
22 before the test can proceed. This is intentional; I've had people who don't
23 pay attention to the "data loss" warning, and then complain that it was not
82e3298 @sitaramc all mkds
authored
24 prominent enough. Forcing them to read a much smaller page appears to focus
25 their attention better!
3641d1b @sitaramc added two "documentation map" pictures!
authored
26
27 The test suite should run fine on most recent Linuxes and Unixes. Although
28 gitolite itself should work fine with any git after 1.6.6 or so, the test
82e3298 @sitaramc all mkds
authored
29 suite generally requires a more recent git.
b90a077 @sitaramc initial version
authored
30
31 Make sure:
32
33 * `$HOME/bin` is in `$PATH`
34 * sshd allows incoming ssh to this userid, at least from localhost
35
36 Gitolite's test suite is mostly written using [tsh][] -- the "testing shell".
37 Take a look at some of the scripts and you will see what it looks like. It
3641d1b @sitaramc added two "documentation map" pictures!
authored
38 has a few quirks and nuances, but it's fine for what I need here.
b90a077 @sitaramc initial version
authored
39
40 [tsh]: http://github.com/sitaramc/tsh
41
42 The tests also use a somewhat convoluted system of environment variables in
43 order to run *entirely* as a local user, without going through ssh at all.
82e3298 @sitaramc all mkds
authored
44 This lets a complete test suite run in about a lot less time than it would
45 otherwise take.
b90a077 @sitaramc initial version
authored
46
47 If you think that defeats the purpose of the testing, you haven't read
48 [this][auth] yet.
ef33ef2 @sitaramc misc fixups
authored
49
82e3298 @sitaramc all mkds
authored
50 # appendix 1 -- the clobber list {#clobber}
ef33ef2 @sitaramc misc fixups
authored
51
82e3298 @sitaramc all mkds
authored
52 When you [try out gitolite][trying] or run the test suite, the following files
53 and directories in your \$HOME are potentially clobbered.
ef33ef2 @sitaramc misc fixups
authored
54
55 .gitconfig
56 .gitolite/
57 .gitolite.rc
58 projects.list
59 repositories/
60 .ssh/
Something went wrong with that request. Please try again.