Mercurial > bitten > bitten-test

comparison README.txt @ 319:cd95e1c6e648

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added note about enabling the Bitten plugin.
author cmlenz
date Wed, 30 Nov 2005 07:26:35 +0000
parents 7429be6b5720
children f116a5068e4e
comparison
equal deleted inserted replaced
318:c042e2c7048c 319:cd95e1c6e648
5 coordinates builds across multiple machines, but also collects software 5 coordinates builds across multiple machines, but also collects software
6 metrics generated by builds, to enable feedback and reporting about 6 metrics generated by builds, to enable feedback and reporting about
7 the progress of a software project. 7 the progress of a software project.
8 8
9 The Bitten software consists of three separate parts: 9 The Bitten software consists of three separate parts:
10 * The build slave, which executes build on behalf of a local or remote 10 * The build slave, which executes builds on behalf of a local or remote
11 build master 11 build master
12 * The build master, which orchestrate builds for a project across all 12 * The build master, which orchestrates builds for a project across all
13 connected slaves, and stores the build status and results to the 13 connected slaves, and stores the build status and results to the
14 database 14 database
15 * The web interface, which is implemented as an add-on to Trac 15 * The web interface, which is implemented as an add-on to Trac
16 (http://trac.edgewall.com/) and provides a build management interface 16 (http://trac.edgewall.com/) and provides a build management interface
17 as well as presentation of build results. 17 as well as presentation of build results.
18 18
19 Both the build master and the web interface depend on Trac 0.9 beta 1, and 19 Both the build master and the web interface depend on Trac 0.9, and need
20 need to be installed on the same machine, together with the Subversion 20 to be installed on the same machine, together with the Subversion
21 repository. The build slave only requires Python (>= 2.3) as well as the 21 repository. The build slave only requires Python (>= 2.3), setuptools
22 tools required by the build process itself. A build slave may be run on 22 (>= 0.6a2), as well as any tools required by the build process itself. A
23 any machine that can connect to the server running the Bitten build master. 23 build slave may be run on any machine that can connect to the server
24 running the Bitten build master.
24 25
25 26
26 Installation 27 Installation
27 ------------ 28 ------------
28 29
36 37
37 $ python setup.py install 38 $ python setup.py install
38 39
39 from the top of the directory where you unpacked (or checked out) the Bitten 40 from the top of the directory where you unpacked (or checked out) the Bitten
40 code. Note that you may need administrator/root privileges for this step, as 41 code. Note that you may need administrator/root privileges for this step, as
41 it will attempt to install Bitten to the Python site-packages directory on 42 it will by default attempt to install Bitten to the Python site-packages
42 your system. 43 directory on your system.
43 44
44 It's also a good idea to run the unit tests at this point, to make sure that 45 It's also a good idea to run the unit tests at this point, to make sure that
45 the code works as expected on your platform: 46 the code works as expected on your platform:
46 47
47 $ python setup.py test 48 $ python setup.py test
50 What's left to do now depends on whether you want to use the build master and 51 What's left to do now depends on whether you want to use the build master and
51 web interface, or just the build slave. In the latter case, you're already 52 web interface, or just the build slave. In the latter case, you're already
52 done. You might need to install software that the build of your project 53 done. You might need to install software that the build of your project
53 requires, but the Bitten build slave itself doesn't require anything extra. 54 requires, but the Bitten build slave itself doesn't require anything extra.
54 55
55 For the build master and web interface, you'll need to install Trac 0.9 56 For the build master and web interface, you'll need to install Trac 0.9. Please
56 beta 2. Please refer to the Trac documentation for information on how it is 57 refer to the Trac documentation for information on how it is installed.
57 installed.
58 58
59 59
60 Build Master Configuration 60 Build Master Configuration
61 -------------------------- 61 --------------------------
62 62
63 Once both Bitten and Trac are installed and working, you'll have to introduce 63 Once both Bitten and Trac are installed and working, you'll have to introduce
64 Bitten to your Trac project environment. If you don't have a Trac project 64 Bitten to your Trac project environment. If you don't have a Trac project
65 set up yet, you'll need to do so in order to use Bitten. 65 set up yet, you'll need to do so in order to use Bitten.
66 66
67 If you already have a Trac project environment, the Trac web interface 67 If you already have a Trac project environment, the Bitten plugin needs to be
68 will inform you with an error message that the environment needs to be 68 explicitly enabled in the Trac configuration. This is done by adding it to the
69 upgraded. To do this, run: 69 [components] section in /path/to/projenv/conf/trac.ini:
70
71 [components]
72 bitten.* = enabled
73
74 The Trac web interface should now inform you with an error message that the
75 environment needs to be upgraded. To do this, run:
70 76
71 $ trac-admin /path/to/projenv upgrade 77 $ trac-admin /path/to/projenv upgrade
72 78
73 This will create the database tables and directories that Bitten requires. 79 This will create the database tables and directories that Bitten requires.
74 You probably also want to grant permissions to someone (such as yourself) 80 You probably also want to grant permissions to someone (such as yourself)
76 status and results of builds: 82 status and results of builds:
77 83
78 $ trac-admin /path/to/projenv permission add anonymous BUILD_VIEW 84 $ trac-admin /path/to/projenv permission add anonymous BUILD_VIEW
79 $ trac-admin /path/to/projenv permission add [yourname] BUILD_ADMIN 85 $ trac-admin /path/to/projenv permission add [yourname] BUILD_ADMIN
80 86
81 You should now see an additional tab labelled "Build Status" in the Trac 87 You should now see an additional tab labeled "Build Status" in the Trac
82 navigation bar. This link will take you to the list of build configurations, 88 navigation bar. This link will take you to the list of build configurations,
83 which at this point is of course empty. If you've set up permissions 89 which at this point is of course empty. If you've set up permissions
84 correctly as described previously, you should see a button for adding new 90 correctly as described previously, you should see a button for adding new
85 build configurations. Click that button and fill out the form. Also, add 91 build configurations. Click that button and fill out the form. Also, add
86 at least one target platform after saving the configuration. Last but not 92 at least one target platform after saving the configuration. Last but not
Copyright (C) 2012-2017 Edgewall Software