Megatest

5/5/2011 @@ -19,54 +18,51 @@

Matt Welland

Abstract -

Megatest is a minimalistic tool to help automate and manage the running of a suite of regression tests or other processes and to roll up the results for display on a web page or dashboard. +

+Megatest is a minimalistic tool to help automate and manage the running of a suite of regression tests or other processes and to roll up the results for display on a web page or dashboard.

Table of Contents -

- +

Section 0.1: About Megatest -

- +

Subsection 0.1.1: Megatest design philosophy

Subsection 0.1.2: Megatest architecture -

- +

Section 0.2: Installation -

- +

Subsection 0.2.1: Compilation -

- +

Subsubsection 0.2.1.1: Dependencies

Subsubsection 0.2.1.2: Build and install -

- +

Subsection 0.2.2: Setup -

- +

Subsubsection 0.2.2.1: Create megatest.config

Subsubsection 0.2.2.2: Create runconfigs.config @@ -80,43 +76,46 @@

Subsubsection 0.2.2.5: Create your test running script, main.sh

Subsubsection 0.2.2.6: Run megatest and watch your run progress -

- +

0.1 About Megatest

@@ -286,123 +285,132 @@

0.3.1 Environment variables

- - - + - + - + - + - + - + - + + + + + + + + +

Variable	Purpose	Default value/Comment
MT_CMDINFO	Conveys test variables to the megatest test runner.	Not for use by the end user
MT_TEST_RUN_DIR	Directory assigned by megatest for the test to run.	Tests can consider this their “home” directory
MT_TEST_NAME	Name of the test, corrosponds to the directory name under tests.
MT_ITEM_INFO	Iterated tests will set this to a sequence of key/values ((KEY val) ...)
MT_RUN_AREA_HOME	Directory where megatest was launched from and where the tests code can be found
MT_RUNNAME	Name of this run as set by the :runname parameter
+MT_MEGATEST +	+Path/Filename to megatest executable. Found either from called path or but using the “exectuable” keyword in the [setup] section. +	+
<field1> ....	The field values as set on the megatest -runall command line (e.g. :field1 abc)	Planning ahead your field names is important so as to avoid collisions with other environment variables

0.3.2 Configuration files

0.3.2.1 megatest.config

- - - + - + - + - + - + - + - + - + - + +

section	variable @@ -414,13 +422,13 @@ required	comment
[setup]	max_concurrent_jobs @@ -432,13 +440,13 @@ no
	executable @@ -450,13 +458,13 @@ no	Use only if necessary, megatest will extract the location from where it used to launch and add append that to the PATH for test runs.
	runsdir @@ -468,13 +476,13 @@ no	Because your runs may be spread out over several disk partitions a central link tree is created to make finding all the runs easy.
[fields]	string of letters, numbers and underscore @@ -486,13 +494,13 @@ at least one
[jobtools]	launcher @@ -504,13 +512,13 @@ no
	workhosts @@ -522,13 +530,13 @@ n/a
[env-override]	string of letters, numbers and underscore @@ -540,13 +548,13 @@ no	These are set on the test launching machine, not the test running machine. Typical usage is to control the host or run queue for launching tests. These values will not be seen by the test when it runs.
[disks]	string of letters, numbers and underscore @@ -558,22 +566,22 @@ yes	The disk usage balancing algorithm is to choose the disk with the least space for each test run.

0.3.2.2 runconfigs.config file

- - - + - + - + +

section	variable @@ -585,13 +593,13 @@ required?	comment
[default]	string of letters, numbers and underscore @@ -603,13 +611,13 @@ no	variables set in this section will be available for all runs, defining the same variable in another section will override the value from the default section
[field1value/field2value...]	string of letters, numbers and underscore @@ -621,12 +629,15 @@ no	the values in this section will be set for any run where field1 is field1value, field2 is field2value and fieldN is fieldNvalue.

@@ -664,17 +675,17 @@

TESTPATH /nfs/testing/megacorp_runs

megatest :CUSTOMER megacorp :LOCATION new_zealand :runname week12_2011_run1 -runall

@@ -685,15 +696,12 @@

0.3.3.1 testconfig file

- - - + - + - + - + + + +

section	variable @@ -705,13 +713,13 @@ required?	comments
[setup]	runscript @@ -723,13 +731,13 @@ yes	The script must be executable and either provide the full path or put a copy at the top of your test directory
[requirements]	waiton @@ -741,13 +749,13 @@ no	This test will not run until the named tests are state completed and status PASS
[items]	any valid @@ -759,14 +767,358 @@ no	The test will be repeated once for each item with the variable name set to the value. If there is more than one variable then the test will be run against all unique combinations of the values

+ +

+0.3.4 Command line +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+switch or param +	+parameter +	+purpose +	+comments +
+-h +	+ +	+brief help +	+ +
+-runall +	+ +	+run all tests +	+ +
+-runtests +	+test1,test2,... +	+run one or more tests +	+ +
+-step +	+stepname +	+record a step +	+requires :state and :status +
+-test-status +	+ +	+record the test status +	+requires :state and :status +
+-setlog +	+logfilename +	+set the logfile name for a test +	+path is assumed to be relative to the test run directory +
+-set-toplog +	+logfilename +	+set the logfile name for the top test in an iterated test run +	+each sub test can have its own logfile set +
+-m +	+“comment” +	+sets a comment for the step, test or run +	+ +
+:runname +	+ +	+ +	+ +
+:state +	+ +	+ +	+ +
+:status +	+ +	+ +	+ +
+-list-runs +	+ +	+ +	+ +
+-testpatt +	+ +	+ +	+ +
+-itempatt +	+ +	+ +	+ +
+-showkeys +	+ +	+ +	+ +
+-force +	+ +	+ +	+ +
+-xterm +	+ +	+ +	+ +
+-remove-runs +	+ +	+ +	+ +
+Test helpers +	+ +	+ +	+ +
+-runstep +	+ +	+ +	+ +
+-logpro +	+ +	+ +	+ +

+ +