README

   1
   2 BuildBot: build/test automation
   3   http://buildbot.sourceforge.net/
   4   Brian Warner <warner-buildbot @ lothar . com>
   5
   6
   7 Abstract:
   8
   9 The BuildBot is a system to automate the compile/test cycle required by most
  10 software projects to validate code changes. By automatically rebuilding and
  11 testing the tree each time something has changed, build problems are
  12 pinpointed quickly, before other developers are inconvenienced by the
  13 failure. The guilty developer can be identified and harassed without human
  14 intervention. By running the builds on a variety of platforms, developers
  15 who do not have the facilities to test their changes everywhere before
  16 checkin will at least know shortly afterwards whether they have broken the
  17 build or not. Warning counts, lint checks, image size, compile time, and
  18 other build parameters can be tracked over time, are more visible, and
  19 are therefore easier to improve.
  20
  21 The overall goal is to reduce tree breakage and provide a platform to run
  22 tests or code-quality checks that are too annoying or pedantic for any human
  23 to waste their time with. Developers get immediate (and potentially public)
  24 feedback about their changes, encouraging them to be more careful about
  25 testing before checkin.
  26
  27
  28 Features:
  29
  30  * run builds on a variety of slave platforms
  31  * arbitrary build process: handles projects using C, Python, whatever
  32  * minimal host requirements: python and Twisted
  33  * slaves can be behind a firewall if they can still do checkout
  34  * status delivery through web page, email, IRC, other protocols
  35  * track builds in progress, provide estimated completion time
  36  * flexible configuration by subclassing generic build process classes
  37  * debug tools to force a new build, submit fake Changes, query slave status
  38  * released under the GPL
  39
  40
  41 DOCUMENTATION:
  42
  43 The PyCon paper has a good description of the overall architecture. It is
  44 available in HTML form in docs/PyCon-2003/buildbot.html, or on the web page.
  45
  46 docs/buildbot.info contains the beginnings of the User's Manual, and the
  47 Installation chapter is the best guide to use for setup instructions. The
  48 .texinfo source can also be turned into printed documentation.
  49
  50 REQUIREMENTS:
  51
  52  Python: http://www.python.org
  53
  54    Buildbot requires python-2.2 or later, and is primarily developed against
  55    python-2.3. Specifically, it requires generators, and a version of Twisted
  56    which only works with python-2.2 or later. Certain features (like the
  57    inclusion of build logs in status emails) require python-2.2.2 or later,
  58    while the IRC 'force' command requires python-2.3 . It has been tested
  59    against python-2.4 .
  60
  61  Twisted: http://twistedmatrix.com
  62
  63    Both the buildmaster and the buildslaves require Twisted-2.0.x or later.
  64    As always, the most recent version is recommended. It has been tested
  65    against Twisted-2.4.0 and Twisted SVN as of the date of release.
  66
  67    When using the split subpackages of Twisted-2.x.x, you'll need at least
  68    "Twisted" (the core package), and you'll also want TwistedMail,
  69    TwistedWeb, and TwistedWords (for sending email, serving a web status
  70    page, and delivering build status via IRC, respectively). You might also
  71    want TwistedConch (for the encrypted Manhole debug port). Note that recent
  72    Twisteds require ZopeInterface to be installed as well.
  73
  74 ACCESSORIES:
  75
  76  CVSToys: http://purl.net/net/CVSToys
  77
  78    If your buildmaster uses FreshCVSSource to receive change notification
  79    from a cvstoys daemon, it will require CVSToys be installed (tested with
  80    CVSToys-1.0.10). If the it doesn't use that source (i.e. if you only use
  81    a mail-parsing change source, or the SVN notification script), you will
  82    not need CVSToys.
  83
  84 INSTALLATION:
  85
  86 Please read the User's Manual in docs/buildbot.info or docs/buildbot.html for
  87 complete instructions. This file only contains a brief summary.
  88
  89  RUNNING THE UNIT TESTS
  90
  91 If you would like to run the unit test suite, use a command like this:
  92
  93  PYTHONPATH=. trial buildbot.test
  94
  95 This should run up to 221 tests, depending upon what VC tools you have
  96 installed. On my desktop machine it takes about six minutes to complete.
  97 Nothing should fail (at least under unix), a few might be skipped. If any of
  98 the tests fail, you should stop and investigate the cause before continuing
  99 the installation process, as it will probably be easier to track down the bug
 100 early.
 101
 102 Neither CVS nor SVN support file based repositories on network filesystem
 103 (or network drives in Windows parlance). Therefore it is recommended to run
 104 all unit tests on local hard disks.
 105
 106  INSTALLING THE LIBRARIES:
 107
 108 The first step is to install the python libraries. This package uses the
 109 standard 'distutils' module, so installing them is usually a matter of
 110 doing something like:
 111
 112  python ./setup.py install
 113
 114 To test this, shift to a different directory (like /tmp), and run:
 115
 116  buildbot --version
 117
 118 If it announces the versions of Buildbot and Twisted, the install went ok.
 119
 120
 121  SETTING UP A BUILD SLAVE:
 122
 123 If you want to run a build slave, you need to obtain the following pieces of
 124 information from the administrator of the buildmaster you intend to connect
 125 to:
 126
 127  your buildslave's name
 128  the password assigned to your buildslave
 129  the hostname and port number of the buildmaster, i.e. example.com:8007
 130
 131 You also need to pick a working directory for the buildslave. All commands
 132 will be run inside this directory.
 133
 134 Now run the 'buildbot' command as follows:
 135
 136  buildbot create-slave WORKDIR MASTERHOST:PORT SLAVENAME PASSWORD
 137
 138 This will create a file called "buildbot.tac", which bundles up all the state
 139 needed by the build slave application. Twisted has a tool called "twistd"
 140 which knows how to load these saved applications and start running them.
 141 twistd takes care of logging and daemonization (running the program in the
 142 background). /usr/bin/buildbot is a front end which runs twistd for you.
 143
 144 Once you've set up the directory with the .tac file, you start it running
 145 like this:
 146
 147  buildbot start WORKDIR
 148
 149 This will start the build slave in the background and finish, so you don't
 150 need to put it in the background yourself with "&". The process ID of the
 151 background task is written to a file called "twistd.pid", and all output from
 152 the program is written to a log file named "twistd.log". Look in twistd.log
 153 to make sure the buildslave has started.
 154
 155 To shut down the build slave, use:
 156
 157  buildbot stop WORKDIR
 158
 159
 160  RUNNING BEHIND A NAT BOX:
 161
 162 Some network environments will not properly maintain a TCP connection that
 163 appears to be idle. NAT boxes which do some form of connection tracking may
 164 drop the port mapping if it looks like the TCP session has been idle for too
 165 long. The buildslave attempts to turn on TCP "keepalives" (supported by
 166 Twisted 1.0.6 and later), and if these cannot be activated, it uses
 167 application level keepalives (which send a dummy message to the build master
 168 on a periodic basis). The TCP keepalive is typically sent at intervals of
 169 about 2 hours, and is configurable through the kernel. The application-level
 170 keepalive defaults to running once every 10 minutes.
 171
 172 To manually turn on application-level keepalives, or to set them to use some
 173 other interval, add "--keepalive NNN" to the 'buildbot slave' command line.
 174 NNN is the number of seconds between keepalives. Use as large a value as your
 175 NAT box allows to reduce the amount of unnecessary traffic on the wire. 600
 176 seconds (10 minutes) is a reasonable value.
 177
 178
 179  SETTING UP A BUILD MASTER:
 180
 181 Please read the user's manual for instructions. The short form is that you
 182 use 'buildbot create-master MASTERDIR' to create the base directory, then you
 183 edit the 'master.cfg' file to configure the buildmaster. Once this is ready,
 184 you use 'buildbot START MASTERDIR' to launch it.
 185
 186 A sample configuration file will be created for you in WORKDIR/master.cfg .
 187 There are more examples in docs/examples/, and plenty of documentation in the
 188 user's manual. Everything is controlled by the config file.
 189
 190
 191 SUPPORT:
 192
 193  Please send questions, bugs, patches, etc, to the buildbot-devel mailing
 194  list reachable through http://buildbot.sourceforge.net/, so that everyone
 195  can see them.