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 The User's Manual is in docs/buildbot.info, and the Installation chapter is
  47 the best guide to use for setup instructions. The .texinfo source can also be
  48 turned into printed documentation. An HTML representation is available on the
  49 Buildbot home page.
  50
  51 REQUIREMENTS:
  52
  53  Python: http://www.python.org
  54
  55    Buildbot requires python-2.3 or later, and is primarily developed against
  56    python-2.4 . It has *not* yet been tested against python-2.5 .
  57
  58  Twisted: http://twistedmatrix.com
  59
  60    Both the buildmaster and the buildslaves require Twisted-2.0.x or later.
  61    As always, the most recent version is recommended. It has been tested
  62    against Twisted-2.4.0 and Twisted SVN as of the date of release.
  63
  64    Twisted is delivered as a collection of subpackages. You'll need at least
  65    "Twisted" (the core package), and you'll also want TwistedMail,
  66    TwistedWeb, and TwistedWords (for sending email, serving a web status
  67    page, and delivering build status via IRC, respectively). You might also
  68    want TwistedConch (for the encrypted Manhole debug port). Note that
  69    Twisted requires ZopeInterface to be installed as well.
  70
  71 ACCESSORIES:
  72
  73  CVSToys: http://purl.net/net/CVSToys
  74
  75    If your buildmaster uses FreshCVSSource to receive change notification
  76    from a cvstoys daemon, it will require CVSToys be installed (tested with
  77    CVSToys-1.0.10). If the it doesn't use that source (i.e. if you only use
  78    a mail-parsing change source, or the SVN notification script), you will
  79    not need CVSToys.
  80
  81 INSTALLATION:
  82
  83 Please read the User's Manual in docs/buildbot.info or docs/buildbot.html for
  84 complete instructions. This file only contains a brief summary.
  85
  86  RUNNING THE UNIT TESTS
  87
  88 If you would like to run the unit test suite, use a command like this:
  89
  90  PYTHONPATH=. trial buildbot.test
  91
  92 This should run up to 221 tests, depending upon what VC tools you have
  93 installed. On my desktop machine it takes about six minutes to complete.
  94 Nothing should fail (at least under unix), a few might be skipped. If any of
  95 the tests fail, you should stop and investigate the cause before continuing
  96 the installation process, as it will probably be easier to track down the bug
  97 early. There are a few known failures under windows and OS-X, but please
  98 report these to the mailing list so we can isolate and resolve them.
  99
 100 Neither CVS nor SVN support file based repositories on network filesystem
 101 (or network drives in Windows parlance). Therefore it is recommended to run
 102 all unit tests on local hard disks.
 103
 104  INSTALLING THE LIBRARIES:
 105
 106 The first step is to install the python libraries. This package uses the
 107 standard 'distutils' module, so installing them is usually a matter of
 108 doing something like:
 109
 110  python ./setup.py install
 111
 112 To test this, shift to a different directory (like /tmp), and run:
 113
 114  buildbot --version
 115
 116 If it announces the versions of Buildbot and Twisted, the install went ok.
 117
 118
 119  SETTING UP A BUILD SLAVE:
 120
 121 If you want to run a build slave, you need to obtain the following pieces of
 122 information from the administrator of the buildmaster you intend to connect
 123 to:
 124
 125  your buildslave's name
 126  the password assigned to your buildslave
 127  the hostname and port number of the buildmaster, i.e. example.com:8007
 128
 129 You also need to pick a working directory for the buildslave. All commands
 130 will be run inside this directory.
 131
 132 Now run the 'buildbot' command as follows:
 133
 134  buildbot create-slave WORKDIR MASTERHOST:PORT SLAVENAME PASSWORD
 135
 136 This will create a file called "buildbot.tac", which bundles up all the state
 137 needed by the build slave application. Twisted has a tool called "twistd"
 138 which knows how to load these saved applications and start running them.
 139 twistd takes care of logging and daemonization (running the program in the
 140 background). /usr/bin/buildbot is a front end which runs twistd for you.
 141
 142 Once you've set up the directory with the .tac file, you start it running
 143 like this:
 144
 145  buildbot start WORKDIR
 146
 147 This will start the build slave in the background and finish, so you don't
 148 need to put it in the background yourself with "&". The process ID of the
 149 background task is written to a file called "twistd.pid", and all output from
 150 the program is written to a log file named "twistd.log". Look in twistd.log
 151 to make sure the buildslave has started.
 152
 153 To shut down the build slave, use:
 154
 155  buildbot stop WORKDIR
 156
 157
 158  RUNNING BEHIND A NAT BOX:
 159
 160 Some network environments will not properly maintain a TCP connection that
 161 appears to be idle. NAT boxes which do some form of connection tracking may
 162 drop the port mapping if it looks like the TCP session has been idle for too
 163 long. The buildslave attempts to turn on TCP "keepalives" (supported by
 164 Twisted 1.0.6 and later), and if these cannot be activated, it uses
 165 application level keepalives (which send a dummy message to the build master
 166 on a periodic basis). The TCP keepalive is typically sent at intervals of
 167 about 2 hours, and is configurable through the kernel. The application-level
 168 keepalive defaults to running once every 10 minutes.
 169
 170 To manually turn on application-level keepalives, or to set them to use some
 171 other interval, add "--keepalive NNN" to the 'buildbot slave' command line.
 172 NNN is the number of seconds between keepalives. Use as large a value as your
 173 NAT box allows to reduce the amount of unnecessary traffic on the wire. 600
 174 seconds (10 minutes) is a reasonable value.
 175
 176
 177  SETTING UP A BUILD MASTER:
 178
 179 Please read the user's manual for instructions. The short form is that you
 180 use 'buildbot create-master MASTERDIR' to create the base directory, then you
 181 edit the 'master.cfg' file to configure the buildmaster. Once this is ready,
 182 you use 'buildbot START MASTERDIR' to launch it.
 183
 184 A sample configuration file will be created for you in WORKDIR/master.cfg .
 185 There are more examples in docs/examples/, and plenty of documentation in the
 186 user's manual. Everything is controlled by the config file.
 187
 188
 189 SUPPORT:
 190
 191  Please send questions, bugs, patches, etc, to the buildbot-devel mailing
 192  list reachable through http://buildbot.sourceforge.net/, so that everyone
 193  can see them.