[buildfarm-client-wiki.git] / Installation.md

# Installing Exim BuildFarm Client
So you want to give back to the Exim project but don't know how?  Being a member of the Exim BuildFarm is one way you can help.  If your distro and version is not on the list that is currently being built, or if your build configuration is drastically different than others with your distro and version, then please consider submitting a request to join the farm.  I would also like to point out that the Debian project has excellent Exim coverage on their Experimental [Build Farm](https://buildd.debian.org/status/package.php?p=exim4&suite=experimental).  We're not discouraging you from joining the Exim BuildFarm if you're Debian or Debian derivative, but merely want to acknowledge the excellent job the Debian project already does with it.

This Installation page works on the assumption that you have already submitted your [Exim BuildFarm Application](http://eximbuild.mrball.net/cgi-bin/register-form.pl) and the BuildFarm administration has sent you an email with your machine alias (aka _animal_) and secret password, which you will enter in step 9 below.  If you just want to run the build farm client and never submit the results, you call simply run everything with the --test option and it will still work.  If you ever run it without --test, it will still work, but the server will reject the feedback because it's from an unknown _animal_.

If you want to run more than one instance of the build farm to test multiple different configurations, such as one with OpenSSL and one with GnuTLS, simply start at step 9.  More details on the extra configuration required to keep it separate from the main build are at the end of this page.

## Install Steps
1. Make sure that all required packages for Exim to build successfully are installed. The minimal package requirements are the basic suite of compiler tools and basic libraries.  You will also need to install the ccache package.
2. Create the master exim user (i.e. the user that Exim changes uid to when it runs in normal operation).  I suggest the user **exim**.  If you already have the Exim package provided by your distro installed, chances are good that you already have a user named **exim** or **exim4**.  That user is fine.  This howto also assumes you use the groupname **exim**.
3. Create a user that will run the Build Farm.  I suggest the user **farm**.  Due to some assumptions that are made in the test suite, the group name must also be **farm**. It is ok if you make it a secondary group or the primary group.  You also must assign a geckos name, or some tests will fail.  I suggest "Exim BuildFarm".  An example command that should work for most distributions:
`useradd -m -c 'Exim BuildFarm' farm`
4. Add **exim** as a secondary group to the **farm** user.  (You should **NOT** add **farm** as a secondary group to the exim user; this will cause test errors.)
5. Configure sudo to allow user **farm** to elevate to root without a password.  Run `visudo` and add:
`farm    ALL=(ALL)       NOPASSWD: ALL`
6. Change to the **farm** user.
7. Checkout the client code:
`git clone https://github.com/mrballcb/exim-build-farm-client.git code`
This will create the repo checkout in the directory *~/code/*.
8. Change into the *~/code/* directory and copy the config template to the default filename:
`cp build-farm.conf.template build-farm.conf`
9. Edit the *build-farm.conf* file and adjust to your local configuration.  The only options that absolutely require changing are the _animal_ and _secret_ configuration settings.  Your machine's sysname alias must be assigned to *animal* and the secret key assigned to *secret*.  The rest of the default build configuration should work to build a basic Exim configuration with no added features/capabilities and it will run the test suite.
10. Whatever directory is set as the *build_root* must exist before anything will run.  If you didn't change it, this will be all that's needed:
`mkdir $HOME/buildfarm`
11. Directory permissions must be lax enough for the **exim** user running the test suite to be able to access the files that user farm has checked out.  Make the **farm** user's home directory be world readable and world searchable:
`chmod o+rx $HOME`
12. Test the configure process by running `./run_build.pl --test --verbose=2 --only-steps=configure`. If there are errors, you'll need to correct them until the process succeeds (ends with OK).  You can repeat this as many times as necessary because test mode does not store the status of the git repo or the status of each stage of the build.
13. Test the build process by running `./run_build.pl --test --verbose=2 --only-steps=configure,make`. If there are build errors, make adjustments, install additional packages, etc, and repeat the test.
14. Test the test suite by running `./run_build.pl --test --verbose=2 --only-steps=configure,make,test --override range_num_tests='1 2'`.  If there are build errors when building the test suite, or runtime errors trying to run the test suite, you may need to install additional packages (you shouldn't though).
15. If you enabled the documentation building process in the *build-farm.conf*, then you can try to build it with `./run_build.pl --test --verbose=2 --only-steps=configure,make-doc`.  For documentation generation to succeed, it will require extra packages to be installed to support xml, xslt, pdf, and a few other things.
16. If you can get past each of these steps, then your build farm system meets the minimum requirements.
17. The official process can be kicked off by running `/home/farm/code/run_cron.sh --run-all`.  This will run the default build configuration, keep track of the git repository status, and upload the build results to the server.
18. Once that command runs with no complaints, add it to the **farm** user crontab.  You can run it at whatever frequency you choose, I suggest 1 hour.  If a previous instantiation is still running, the script will detect the lockfile and exit so as not to step on each other.
19. I had a problem running the *run_cron.sh* script in that cron gives a highly sanitized path to the script when it runs it.  I made a second wrapper script to call the first one so I could put path elements in that were needed:
<pre><code>$ more /home/farm/bin/build_farm.sh
#!/bin/bash
export PATH="/usr/local/bin:/sbin:/usr/sbin:$PATH"
$HOME/code/run_cron.sh --run-all $@
</code></pre>
Then I make my cronjob call: `6 * * * * $HOME/bin/build_farm.sh`
20. My cronjob ran great for a couple weeks.  Then another problem popped up running the cron job in that the test portion suddenly started failing with an odd error:
<pre><code>** runtest error: Failed to open /dev/tty: No such device or address</code></pre>
This is not a sudo issue, this is because the cron daemon does not give a tty to the cronjob that it starts.  To fix this, I used an old ssh trick to start my *build_farm.sh* script:
<pre><code>6 * * * * ssh -tt farm@localhost $HOME/bin/build_farm.sh</code></pre>

## Multiple build clients on one machine
As mentioned above, you can start at step 9.  A second application must be filled out to put the appropriate data in the database because this is treated a separate BuildFarm client:

1. Make a second copy of the *build-farm.conf* with a different name, such as *build-farm-alias2.conf*.
2. Set the path for build_root and the CCACHE_DIR environment settings, each to a new subdirectory from the first configuration.
3. Create the new build_root directory.
4. When testing, pass this additional parameter to any build script you run: `--config /path/to/build-farm-machine2.conf`.
5. Add a new cron job for this second build farm client in the same way you chose to do the first one, just make sure to specify the --config option with it.

## Further documentation
* Details of options in [build-farm.conf](https://github.com/mrballcb/exim-build-farm-client/wiki/BuildConfigConf)
* Details of [potential testing commandlines](https://github.com/mrballcb/exim-build-farm-client/wiki/TestingBuilds)
* Details of [building documentation](https://github.com/mrballcb/exim-build-farm-client/wiki/BuildingDocs)