Index: docs/megatest.html ================================================================== --- docs/megatest.html +++ docs/megatest.html @@ -89,11 +89,19 @@ Section 0.3: Reference
Subsection 0.3.1: Environment variables +
+
+Subsection 0.3.2: megatest.config settings +
+ +
+Subsubsection 0.3.2.1: [setup]
+
@@ -120,17 +128,17 @@

0.2.1.1 Dependencies

-Chicken scheme and a number of eggs are required for building megatest. See the file utils/installall.sh for an automated way to install the dependancies on Linux. +Chicken scheme and a number of eggs are required for building megatest. See the file utils/installall.sh for an automated way to install the dependencies on Linux.

0.2.1.2 Build and install

-Run “make test” to create the megatest exectutable. You may wish to copy the executable to a centrally accessible location. +Run “make test” to create the megatest executable. You may wish to copy the executable to a centrally accessible location.

0.2.2 Setup

@@ -138,11 +146,11 @@

Create the file megatest.config using the megatest.config template from the tests directory. At a minimum you need the following:
-# Fields are the keys under which your test runs are organised +# Fields are the keys under which your test runs are organized
[fields]
@@ -368,14 +376,143 @@ Planning ahead your field names is important so as to avoid collisions with other environment variables
-
+

+0.3.2 megatest.config settings +

+

+0.3.2.1 [setup] +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+section + +variable + +value + +comment +
+[setup] + +max_concurrent_jobs + +if variable is not defined no limit on jobs + + +
+ + +executable + +full path to megatest binary + +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. +
+[fields] + +string of letters, numbers and underscore + +string of letters, numbers and underscore + + +
+[jobtools] + +launcher + +command line used to launch jobs - the job command (megatest -execute) will be appended to this + + +
+ + +workhosts + +list of hostnames to run jobs on NOT SUPPORTED RIGHT NOW + + +
+[env-override] + +string of letters, numbers and underscore + +any string + +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 + +a valid path writable by the test launching process and by the test process + +The disk usage balancing algorithm is to choose the disk with the least space for each test run. +

Copyright (C) 2011 Matt Welland

Index: docs/megatest.lyx ================================================================== --- docs/megatest.lyx +++ docs/megatest.lyx @@ -123,11 +123,11 @@ Dependencies \end_layout \begin_layout Standard Chicken scheme and a number of eggs are required for building megatest. - See the file utils/installall.sh for an automated way to install the dependancie + See the file utils/installall.sh for an automated way to install the dependencie s on Linux. \end_layout \begin_layout Subsubsection Build and install @@ -140,11 +140,11 @@ make test \begin_inset Quotes erd \end_inset - to create the megatest exectutable. + to create the megatest executable. You may wish to copy the executable to a centrally accessible location. \end_layout \begin_layout Subsection Setup @@ -159,11 +159,11 @@ tests directory. At a minimum you need the following: \end_layout \begin_layout Code -# Fields are the keys under which your test runs are organised +# Fields are the keys under which your test runs are organized \end_layout \begin_layout Code [fields] \end_layout @@ -592,11 +592,340 @@ \end_inset \end_layout -\begin_layout Code +\begin_layout Subsection +megatest.config settings +\end_layout + +\begin_layout Subsubsection +[setup] +\end_layout + +\begin_layout Standard +\begin_inset Tabular + + + + + + + + +\begin_inset Text + +\begin_layout Plain Layout +section +\end_layout + +\end_inset + + +\begin_inset Text + +\begin_layout Plain Layout +variable +\end_layout + +\end_inset + + +\begin_inset Text + +\begin_layout Plain Layout +value +\end_layout + +\end_inset + + +\begin_inset Text + +\begin_layout Plain Layout +comment +\end_layout + +\end_inset + + + + +\begin_inset Text + +\begin_layout Plain Layout +[setup] +\end_layout + +\end_inset + + +\begin_inset Text + +\begin_layout Plain Layout +max_concurrent_jobs +\end_layout + +\end_inset + + +\begin_inset Text + +\begin_layout Plain Layout +if variable is not defined no limit on jobs +\end_layout + +\end_inset + + +\begin_inset Text + +\begin_layout Plain Layout + +\end_layout + +\end_inset + + + + +\begin_inset Text + +\begin_layout Plain Layout + +\end_layout + +\end_inset + + +\begin_inset Text + +\begin_layout Plain Layout +executable +\end_layout + +\end_inset + + +\begin_inset Text + +\begin_layout Plain Layout +full path to megatest binary +\end_layout + +\end_inset + + +\begin_inset Text + +\begin_layout Plain Layout +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. +\end_layout + +\end_inset + + + + +\begin_inset Text + +\begin_layout Plain Layout +[fields] +\end_layout + +\end_inset + + +\begin_inset Text + +\begin_layout Plain Layout +string of letters, numbers and underscore +\end_layout + +\end_inset + + +\begin_inset Text + +\begin_layout Plain Layout +string of letters, numbers and underscore +\end_layout + +\end_inset + + +\begin_inset Text + +\begin_layout Plain Layout + +\end_layout + +\end_inset + + + + +\begin_inset Text + +\begin_layout Plain Layout +[jobtools] +\end_layout + +\end_inset + + +\begin_inset Text + +\begin_layout Plain Layout +launcher +\end_layout + +\end_inset + + +\begin_inset Text + +\begin_layout Plain Layout +command line used to launch jobs - the job command (megatest -execute) will + be appended to this +\end_layout + +\end_inset + + +\begin_inset Text + +\begin_layout Plain Layout + +\end_layout + +\end_inset + + + + +\begin_inset Text + +\begin_layout Plain Layout + +\end_layout + +\end_inset + + +\begin_inset Text + +\begin_layout Plain Layout +workhosts +\end_layout + +\end_inset + + +\begin_inset Text + +\begin_layout Plain Layout +list of hostnames to run jobs on NOT SUPPORTED RIGHT NOW +\end_layout + +\end_inset + + +\begin_inset Text + +\begin_layout Plain Layout + +\end_layout + +\end_inset + + + + +\begin_inset Text + +\begin_layout Plain Layout +[env-override] +\end_layout + +\end_inset + + +\begin_inset Text + +\begin_layout Plain Layout +string of letters, numbers and underscore +\end_layout + +\end_inset + + +\begin_inset Text + +\begin_layout Plain Layout +any string +\end_layout + +\end_inset + + +\begin_inset Text + +\begin_layout Plain Layout +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. +\end_layout + +\end_inset + + + + +\begin_inset Text + +\begin_layout Plain Layout +[disks] +\end_layout + +\end_inset + + +\begin_inset Text + +\begin_layout Plain Layout +string of letters, numbers and underscore +\end_layout + +\end_inset + + +\begin_inset Text + +\begin_layout Plain Layout +a valid path writable by the test launching process and by the test process +\end_layout + +\end_inset + + +\begin_inset Text + +\begin_layout Plain Layout +The disk usage balancing algorithm is to choose the disk with the least + space for each test run. + +\end_layout + +\end_inset + + + + +\end_inset + \end_layout \end_body \end_document