Automatic Build System - Revision history

Tom Sgouros: /* The cron Job */

2014-05-05T19:28:53Z

The cron Job

← Older revision		Revision as of 19:28, 5 May 2014
Line 16:		Line 16:
	;systest-link		;systest-link
	:Add a link to the '''/systest/bin''' directory. If it links to something executable, the system will run it every night. The script will run as the user (and group) of the file owner.		:Add a link to the '''/systest/bin''' directory. If it links to something executable, the system will run it every night. The script will run as the user (and group) of the file owner.
	:Use it like this:		:Use it like this: ''/systest/bin/systest-link /systest/projects/vrl/vrl_critical.sh /systest/bin/vrl_crit''

	''/systest/bin/systest-link /systest/projects/vrl/vrl_critical.sh /systest/bin/vrl_crit''

	;systest-rem		;systest-rem

Tom Sgouros: /* The cron Job */

2014-05-05T19:28:34Z

The cron Job

← Older revision		Revision as of 19:28, 5 May 2014
Line 18:		Line 18:
	:Use it like this:		:Use it like this:

	~~<code>~~/systest/bin/systest-link /systest/projects/vrl/vrl_critical.sh /systest/bin/vrl_crit~~</code>~~		''/systest/bin/systest-link /systest/projects/vrl/vrl_critical.sh /systest/bin/vrl_crit''

	;systest-rem		;systest-rem

Tom Sgouros: /* The cron Job */

2014-05-05T15:05:59Z

The cron Job

← Older revision		Revision as of 15:05, 5 May 2014
Line 19:		Line 19:

	<code>/systest/bin/systest-link /systest/projects/vrl/vrl_critical.sh /systest/bin/vrl_crit</code>		<code>/systest/bin/systest-link /systest/projects/vrl/vrl_critical.sh /systest/bin/vrl_crit</code>

	;systest-rem		;systest-rem
	:Remove a link in the '''/systest/bin''' directory.		:Remove a link in the '''/systest/bin''' directory.

Tom Sgouros: /* The cron Job */

2014-05-05T15:05:22Z

The cron Job

← Older revision		Revision as of 15:05, 5 May 2014
Line 16:		Line 16:
	;systest-link		;systest-link
	:Add a link to the '''/systest/bin''' directory. If it links to something executable, the system will run it every night. The script will run as the user (and group) of the file owner.		:Add a link to the '''/systest/bin''' directory. If it links to something executable, the system will run it every night. The script will run as the user (and group) of the file owner.
	:Use it like this: <code>/systest/bin/systest-link /systest/projects/vrl/vrl_critical.sh /systest/bin/vrl_crit</code>		:Use it like this:

			<code>/systest/bin/systest-link /systest/projects/vrl/vrl_critical.sh /systest/bin/vrl_crit</code>
	;systest-rem		;systest-rem
	:Remove a link in the '''/systest/bin''' directory.		:Remove a link in the '''/systest/bin''' directory.

Tom Sgouros: added documentation about systest tools.

2014-05-05T14:50:11Z

added documentation about systest tools.

← Older revision		Revision as of 14:50, 5 May 2014
Line 11:		Line 11:

	Any scripts found in the '''/systest/bin''' directory that end in '''.weekly''' will only be run on Sundays.		Any scripts found in the '''/systest/bin''' directory that end in '''.weekly''' will only be run on Sundays.

			To add more tests to the nightly run, use the systest tools, found in '''/systest/bin''':

			;systest-link
			:Add a link to the '''/systest/bin''' directory. If it links to something executable, the system will run it every night. The script will run as the user (and group) of the file owner.
			:Use it like this: <code>/systest/bin/systest-link /systest/projects/vrl/vrl_critical.sh /systest/bin/vrl_crit</code>
			;systest-rem
			:Remove a link in the '''/systest/bin''' directory.

			There is also a '''systest-req''' which stores metadata (i.e. documentation) about each of the links in '''/systest/bin''' and a '''systest-info''' which regurgitates it.

	=The Test Script (test.platform.py)=		=The Test Script (test.platform.py)=

Tom Sgouros: /* Configuration File */

2014-05-02T18:56:18Z

Configuration File

← Older revision		Revision as of 18:56, 2 May 2014
Line 33:		Line 33:
	* '''scriptName''', '''outputDir''' The '''scriptName''' is executed in the '''outputDir''' directory. The script should contain the build and all the tests that need to be run. We encourage you to use a simple makefile, and to make the default target do a build and test.		* '''scriptName''', '''outputDir''' The '''scriptName''' is executed in the '''outputDir''' directory. The script should contain the build and all the tests that need to be run. We encourage you to use a simple makefile, and to make the default target do a build and test.

			The arguments are separated by spaces so there should be no spaces within the arguments.

	Blank lines are ignored and the '''#''' indicates a comment.		Blank lines are ignored and the '''#''' indicates a comment.

Tom Sgouros: /* Editing the Test Script */

2014-05-02T17:05:09Z

Editing the Test Script

← Older revision		Revision as of 17:05, 2 May 2014
Line 38:		Line 38:
	==Editing the Test Script==		==Editing the Test Script==

	The actual copy of the test script that runs is the one in '''/research/graphics/common/build/valid'''. Please don't edit this (or the configuration file) directly. Instead, edit the version that is in your sandbox and use CVS to check it in. Note that the first thing test.platform.py does is check stuff out from the main CVS archive and run that. If you edit this script, expect your changes to take effect the night after whatever runs tonight.		The actual copy of the test script that runs is the one in '''/research/graphics/common/build/valid'''. Please don't edit this (or the configuration file) directly. Instead, edit the version that is in your sandbox and use CVS to check it in. Note that the first thing test.platform.py does is check stuff out from the main CVS archive and run that. If you edit this script, expect your changes to take effect the night after whatever runs tonight because whatever you check in will be checked out into the appropriate place, but by that point, the build process is already running.

Tom Sgouros: /* Configuration File */ added config file element description

2014-05-02T14:37:46Z

Configuration File: added config file element description

← Older revision		Revision as of 14:37, 2 May 2014
Line 26:		Line 26:
	</pre>		</pre>

			Where:

			* '''testName''' is an arbitrary string used to label this test.
			* '''testList''' is a comma-separated list of email addresses who will hear about it if this test fails. Use '''none''' if nobody cares.
			* '''archList''' is a comma-separated list of architectures for which this test is designed. This is just a string to be compared with the $GARCH environment variable set in '''gfxtools-startup.sh''' (see above).
			* '''scriptName''', '''outputDir''' The '''scriptName''' is executed in the '''outputDir''' directory. The script should contain the build and all the tests that need to be run. We encourage you to use a simple makefile, and to make the default target do a build and test.


			Blank lines are ignored and the '''#''' indicates a comment.

	==Editing the Test Script==		==Editing the Test Script==

	The actual copy of the test script that runs is the one in '''/research/graphics/common/build/valid'''. Please don't edit this (or the configuration file) directly. Instead, edit the version that is in your sandbox and use CVS to check it in. Note that the first thing test.platform.py does is check stuff out from the main CVS archive and run that. If you edit this script, expect your changes to take effect the night after whatever runs tonight.		The actual copy of the test script that runs is the one in '''/research/graphics/common/build/valid'''. Please don't edit this (or the configuration file) directly. Instead, edit the version that is in your sandbox and use CVS to check it in. Note that the first thing test.platform.py does is check stuff out from the main CVS archive and run that. If you edit this script, expect your changes to take effect the night after whatever runs tonight.

Tom Sgouros: added detail

2014-05-02T14:19:45Z

added detail

← Older revision		Revision as of 14:19, 2 May 2014
Line 7:		Line 7:
	Most days, what it finds in that directory is a bunch of scripts tstaff uses to manage the process and a couple of scripts called '''vrl_fast''' and '''vrl_slow''' that actually do the work.		Most days, what it finds in that directory is a bunch of scripts tstaff uses to manage the process and a couple of scripts called '''vrl_fast''' and '''vrl_slow''' that actually do the work.

	* '''vrl_fast''' executes the script '''/research/graphics/tools/gfxtools-startup.sh''', and then executes '''$G/common/build/valid/test.platform.py'''.		* '''vrl_fast''' executes the script '''/research/graphics/tools/gfxtools-startup.sh''', and then executes '''$G/common/build/valid/test.platform.py'''.
	* '''vrl_slow''' does the same thing, but executes '''test.platform.py''' with the option '''-config $G/common/build/site/test.platform_slow.cfg'''.		* '''vrl_slow''' does the same thing, but executes '''test.platform.py''' with the option '''-config $G/common/build/site/test.platform_slow.cfg'''.

Line 13:		Line 13:

	=The Test Script (test.platform.py)=		=The Test Script (test.platform.py)=

			The test script is a python program at '''$G/common/build/valid/test.platform.py'''. It runs a series of tests and sends an email to people if they fail.

			==Configuration File==

			The tests run by the '''test.platform.py''' script are listed and configured in '''$G/common/build/site/test.platform.cfg''' (by default) and '''test.platform_slow.cfg'''.

			The configuration file has a line for the Developer and a line for the emails of whoever wants to receive the '''Summary''' email messages. Each line after looks like this:

			<pre>
			testName testList archList scriptName outputDir
			</pre>


	==Editing the Test Script==		==Editing the Test Script==

	The actual copy of the test script that runs is the one in '''/research/graphics/common/build/valid'''. Please don't edit this directly. Instead, edit the version that is in your sandbox and use CVS to check it in. Note that the first thing test.platform.py does is check stuff out from CVS. If you edit this script, expect your changes to take effect the night after whatever runs tonight.		The actual copy of the test script that runs is the one in '''/research/graphics/common/build/valid'''. Please don't edit this (or the configuration file) directly. Instead, edit the version that is in your sandbox and use CVS to check it in. Note that the first thing test.platform.py does is check stuff out from the main CVS archive and run that. If you edit this script, expect your changes to take effect the night after whatever runs tonight.

Tom Sgouros: added page for build system

2014-05-01T16:48:44Z

added page for build system

New page

Every night an automatic build system runs to compile and test the software in the VRL group. This page is for documenting that process. Unless you are working on the build process itself, you probably don't need to know or care about these details. However, they need to be recorded somewhere, and this is as good a place as any.

=The cron Job=

The machine called franklin has a cron job running that every day at 1am (see '''/etc/cron.d/regression_test'''), runs a perl script created by t-staff. The script ('''/tstaff/bin/regtest''') executes (as root) whatever it finds in '''/systest/bin'''.

Most days, what it finds in that directory is a bunch of scripts tstaff uses to manage the process and a couple of scripts called '''vrl_fast''' and '''vrl_slow''' that actually do the work.

* '''vrl_fast''' executes the script '''/research/graphics/tools/gfxtools-startup.sh''', and then executes '''$G/common/build/valid/test.platform.py'''.
* '''vrl_slow''' does the same thing, but executes '''test.platform.py''' with the option '''-config $G/common/build/site/test.platform_slow.cfg'''.

Any scripts found in the '''/systest/bin''' directory that end in '''.weekly''' will only be run on Sundays.

=The Test Script (test.platform.py)=

==Editing the Test Script==

The actual copy of the test script that runs is the one in '''/research/graphics/common/build/valid'''. Please don't edit this directly. Instead, edit the version that is in your sandbox and use CVS to check it in. Note that the first thing test.platform.py does is check stuff out from CVS. If you edit this script, expect your changes to take effect the night after whatever runs tonight.