From: Todd Lyons <tlyons@ivenue.com>
Date: Mon, 21 Oct 2013 23:12:07 +0000 (-0700)
Subject: Better test commands for initial testing
X-Git-Url: https://git.exim.org/buildfarm-client-wiki.git/commitdiff_plain/254277015f9e6211fce177f6f6b910378e0452fa

Better test commands for initial testing
---

diff --git a/Installation.md b/Installation.md
index 192036d..badd982 100644
--- a/Installation.md
+++ b/Installation.md
@@ -19,9 +19,13 @@ This will create the repo checkout in the directory *~/code/*.
 `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 build process by running `./run_build.pl --test --verbose=2`. If there are build errors, make adjustments, install additional packages, etc, and repeat the test.  You can repeat this as many times as you want because test mode does not store the status of the git repo or the status of each stage of the build.
-13. The official process can be kicked off by running `/home/farm/code/run_cron.sh`.  This will run the default build configuration and upload the results to the server.
-14. 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.
+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,build_docs`.  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`.  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.
 
 ## Overview