Index: docs/megatest.html ================================================================== --- docs/megatest.html +++ docs/megatest.html @@ -2,11 +2,11 @@ - + Megatest
@@ -28,154 +28,199 @@
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 -
-
-Subsubsection 0.2.2.3: Create the tests directory and your first test -
-
-Subsubsection 0.2.2.4: Create the testconfig file for your test -
-
-Subsubsection 0.2.2.5: Create your test running script, main.sh -
-
-Subsubsection 0.2.2.6: Run megatest and watch your run progress -
-
-
-
-Section 0.3: Reference -
-
-
-Subsection 0.3.1: Configuration files -
-
-
-Subsubsection 0.3.1.1: Sections -
-
-Subsubsection 0.3.1.2: Variables -
-
-Subsubsection 0.3.1.3: Includes -
-
-Subsubsection 0.3.1.4: Setting a variable by running a command -
-
-Subsubsection 0.3.1.5: Notes -
-
-
-Subsection 0.3.2: Environment variables -
-
-Subsection 0.3.3: Configuration files -
-
-
-Subsubsection 0.3.3.1: megatest.config -
-
-Subsubsection 0.3.3.2: runconfigs.config file -
-
-
-Subsection 0.3.4: Writing tests -
-
-
-Subsubsection 0.3.4.1: testconfig file -
-
-
-Subsection 0.3.5: Command line -
-
-
-
- -
-

-0.1 About Megatest -

-

-0.1.1 Megatest design philosophy -

-
-Megatest is intended to provide the minimum needed resources to make writing a suite of tests for software, design engineering or process control (via owlfs for example) without being specialized for any specific problem space. Megatest in of itself does not know what constitutes a PASS or FAIL of a test. In most cases megatest is best used in conjunction with logpro or a similar tool to parse, analyze and decide on the test outcome. A call to megatest can then be made to record the result. -
-

-0.1.2 Megatest architecture -

-
-All data to specify the tests and configure the system is stored in plain text files. All system state is stored in an sqlite3 database. Tests are launched using the launching system available for the distributed compute platform in use. A template script is provided which can launch jobs on local and remote Linux hosts. Currently megatest uses the network filesystem to “call home” to your master sqlite3 database. -
-

-0.2 Installation -

-

-0.2.1 Compilation -

-

-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 dependencies on Linux. -
-

-0.2.1.2 Build and install -

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

-0.2.2 Setup -

-

-0.2.2.1 Create megatest.config -

+
+Chapter 1: About Megatest +
+
+
+Section 1.1: Megatest design philosophy +
+
+Section 1.2: Megatest architecture +
+
+
+Chapter 2: Installation +
+
+
+Section 2.1: Compilation +
+
+
+Subsection 2.1.1: Dependencies +
+
+Subsection 2.1.2: Build and install +
+
+
+Section 2.2: Setup +
+
+
+Subsection 2.2.1: Create megatest.config +
+
+Subsection 2.2.2: Create runconfigs.config +
+
+Subsection 2.2.3: Create the tests directory and your first test +
+
+Subsection 2.2.4: Create the testconfig file for your test +
+
+Subsection 2.2.5: Create your test running script, main.sh +
+
+Subsection 2.2.6: Run megatest and watch your run progress +
+
+
+
+Chapter 3: How to Write Tests +
+
+
+Section 3.1: A Simple Test with one Step +
+
+
+Subsection 3.1.1: Create your test directory. The directory name will be the name of the test +
+
+Subsection 3.1.2: Create your testconfig file. This file contains various specifications for your test. For our example the test author has chosen to write the test using csh scripting. +
+
+Subsection 3.1.3: Create your main.csh script +
+
+
+Section 3.2: Simple Test with Multiple Steps +
+
+Section 3.3: Simple Test, Multiple Steps, Some in Parallel +
+
+
+Subsection 3.3.1: The Makefile +
+
+Subsection 3.3.2: The main.csh file +
+
+
+Section 3.4: Simple Test with Iteration +
+
+
+Subsection 3.4.1: Update you testconfig file for iteration +
+
+Subsection 3.4.2: Rewrite your main.csh for iteration +
+
+
+Section 3.5: Tests with Inter-test dependencies +
+
+
+Chapter 4: Reference +
+
+
+Section 4.1: Configuration file Syntax +
+
+
+Subsection 4.1.1: Sections +
+
+Subsection 4.1.2: Variables +
+
+Subsection 4.1.3: Includes +
+
+Subsection 4.1.4: Setting a variable by running a command +
+
+Subsection 4.1.5: Notes +
+
+
+Section 4.2: Environment variables +
+
+Section 4.3: Configuration files +
+
+
+Subsection 4.3.1: megatest.config +
+
+Subsection 4.3.2: runconfigs.config file +
+
+
+Section 4.4: Writing tests +
+
+
+Subsection 4.4.1: testconfig file +
+
+Subsection 4.4.2: Command line +
+
+
+
+ + +

+1 About Megatest +

+

+1.1 Megatest design philosophy +

+
+Megatest is intended to provide the minimum needed resources to make writing a suite of tests for software, design engineering or process control (via owlfs for example) without being specialized for any specific problem space. Megatest in of itself does not know what constitutes a PASS or FAIL of a test. In most cases megatest is best used in conjunction with logpro or a similar tool to parse, analyze and decide on the test outcome. A call to megatest can then be made to record the result. +
+

+1.2 Megatest architecture +

+
+All data to specify the tests and configure the system is stored in plain text files. All system state is stored in an sqlite3 database. Tests are launched using the launching system available for the distributed compute platform in use. A template script is provided which can launch jobs on local and remote Linux hosts. Currently megatest uses the network filesystem to “call home” to your master sqlite3 database. +
+

+2 Installation +

+

+2.1 Compilation +

+

+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 dependencies on Linux. +
+

+2.1.2 Build and install +

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

+2.2 Setup +

+

+2.2.1 Create megatest.config +

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 organized @@ -232,133 +277,301 @@ [disks]
1 /tmp
-

-0.2.2.2 Create runconfigs.config -

+

+2.2.2 Create runconfigs.config +

-This file is used to set environment variables that are run specific. You can simply create an empty file to start. +This file is used to set environment variables that are run specific. You can simply create an empty file to start.
+
# runconfigs.config
+​
+
-

-0.2.2.3 Create the tests directory and your first test -

+ +
+

+2.2.3 Create the tests directory and your first test +

The structure should look like this:
-
-../tests -
-
-├── megatest.config -
-
-├── runconfigs.config -
-
-└── tests -
-
-    └── mytest -
-
- ├── main.sh -
-
-    └── testconfig -
-

-0.2.2.4 Create the testconfig file for your test -

-
-[setup] -
-
+
+
+
../tests
+  ├── megatest.config
+  ├── runconfigs.config
+  └── tests
+     └── mytest
+           ├── main.sh
+           └── testconfig
+
+
+ +
+

+2.2.4 Create the testconfig file for your test +

+
+
+
[setup]
 runscript main.sh
-
-

-0.2.2.5 Create your test running script, main.sh -

-
-#!/bin/bash -
-
+ +
-
+

+2.2.5 Create your test running script, main.sh +

+
+
+
#!/bin/bash
+​
 megatest -runstep mystep1 "sleep 20;echo Done" -m "mystep1 is done"
-
-
-megatest -test-status :state COMPLETED :status PASS -m "This is a test level comment" -
-

-0.2.2.6 Run megatest and watch your run progress -

-
-megatest :field1 abc :field2 def :runname 2011week08.4a -runall -
-
+​ +megatest -test-status :state COMPLETED :status PASS -m "This is a comment" + +
+ +
+

+2.2.6 Run megatest and watch your run progress +

+
+
+
megatest :field1 abc :field2 def :runname 2011week08.4a -runall
+​
 watch megatest -list-runs %
+​
+# OR use the dashboard
+​
+dashboard &
+
+
+ +
+
+ +
+

+3 How to Write Tests +

+

+3.1 A Simple Test with one Step +

+

+3.1.1 Create your test directory. The directory name will be the name of the test +

+
+
+
mkdir simpletest
+cd simpletest
+
+
+ +
+

+3.1.2 Create your testconfig file. This file contains various specifications for your test. For our example the test author has chosen to write the test using csh scripting. +

+
+
+
# testconfig
+​
+[setup]
+runscript main.csh
+
+
+ +
+

+3.1.3 Create your main.csh script +

+
+
+
#!/bin/tcsh -x
+​
+# run the cpu1 simulation.
+#   The step name is "run_simulation"
+#   The commandline being run for this step is "runsim cpu1"
+#   The logpro file to validate the output from the run is "runsim.logpro"
+​
+$MEGATEST -runstep run_simulation -logpro runsim.logpro "runsim cpu1"
+
+
+ +
+
+You can now run megatest and the created test directory will contain the new files “run_simulation.html” and “run_simulation.log”. If you are using the dashboard you can click on the run and then push the “View log” button to view the log file in firefox. +
+

+3.2 Simple Test with Multiple Steps +

+
+To run multiple steps simply add them to the main.csh file. Here we add a step to test “cpu2”. The second step that tests cpu2 will only run after the step that tested “cpu1” completes. +
+
+
+
#!/bin/tcsh -x
+​
+# run the cpu1 simulation.
+#   The step name is "run_simulation"
+#   The commandline being run for this step is "runsim cpu1"
+#   The logpro file to validate the output from the run is "runsim.logpro"
+​
+$MEGATEST -runstep run_simulation_cpu1 -logpro runsim.logpro "runsim cpu1"
+$MEGATEST -runstep run_simulation_cpu2 -logpro runsim.logpro "runsim cpu2"
+
+
+ +
+

+3.3 Simple Test, Multiple Steps, Some in Parallel +

+

+3.3.1 The Makefile +

+
+A good way to run steps in parallel within a single test, especially when there are following steps, is to use the Unix Make utility. Writing Makefiles is beyond the scope of this document but here is a minimal example that will run “runsim cpu1” and “runsim cpu2” in parallel. For more information on make try “info make” at the Linux command prompt. +
+
+
+
# Example Makefile to run two steps in parallel
+​
+RTLDIR=/path/to/rtl
+CPUS = cpu1 cpu2
+​
+run_simulation_$(CPUS).html : $(RTLDIR)/$(CPUS)
+	$(MEGATEST) -runstep run_simulation_$(CPUS) -logpro runsim.logpro "runsim $(CPUS)
+
+
+ +
+

+3.3.2 The main.csh file +

+
+
+
#!/bin/tcsh -x
+​
+# run the cpu1 and cpu2 simulations in parallel. 
+# The -j parameter tells make how many jobs it may run in parallel
+​
+make -j 2 
+​
+
+
+ +
+

+3.4 Simple Test with Iteration +

+
+Since no jobs run after the cpu1 and cpu2 simulations inside the test there it is possible to run this test in iterated mode. +
+

+3.4.1 Update you testconfig file for iteration +

+
+
+
[setup]
+runscript main.csh
+​
+[items]
+CPU cpu1 cpu2
+
+
+ +
+

+3.4.2 Rewrite your main.csh for iteration +

+
+
+
#!/bin/tcsh -x
+​
+# run the cpu simulation but now use the environment variable $CPU
+# to select what cpu to run the simulation against
+​
+$MEGATEST -runstep run_simulation -logpro runsim.logpro "runsim $CPU"
+
+
+ +
+

+3.5 Tests with Inter-test dependencies +

+
+Sometimes a test depends on the output from a previous test or it may not make sense to run a test is another test does not complete with status “PASS”. In either of these scenarios you can use the “waiton” keyword in your testconfig file to indicate that this test must wait on one or more tests to complete before being launched. In this example there is no point in running the “system” test if the “cpu” and “mem” tests either do not complete or complete but with status “FAIL”. +
+
+
+
# testconfig for the "system" test
+[setup]
+runscript main.csh
+waiton cpu mem
+
+
+
+

+4 Reference +

-0.3 Reference +4.1 Configuration file Syntax

-0.3.1 Configuration files +4.1.1 Sections

-

-0.3.1.1 Sections -

[section name]
-
+
This creates a section named “section name” -
-

-0.3.1.2 Variables -

+ +

+4.1.2 Variables +

VARX has this value
-
+
The variable “VARX” will have the value “has this value” -
-

-0.3.1.3 Includes -

+ +

+4.1.3 Includes +

[include filename]
The file named “filename” will be included as if part of the calling file. NOTE: This means no section can be named “include “ (with the whitespace).
-

-0.3.1.4 Setting a variable by running a command -

+

+4.1.4 Setting a variable by running a command +

VARNAME [system ls /tmp]
-
+
The variable “VARNAME” will get a value created by the Unix command “ls /tmp”. All lines of output from the command will be joined with a space. -
-

-0.3.1.5 Notes -

+ +

+4.1.5 Notes +

-

-0.3.2 Environment variables -

+

+4.2 Environment variables +

Variable @@ -469,16 +682,16 @@
+

+4.3 Configuration files +

-0.3.3 Configuration files +4.3.1 megatest.config

-

-0.3.3.1 megatest.config -

section @@ -643,13 +856,13 @@
-

-0.3.3.2 runconfigs.config file -

+

+4.3.2 runconfigs.config file +

section @@ -772,16 +985,16 @@ ENCRYPTION true
TESTPATH /nfs/testing/megacorp_runs
+

+4.4 Writing tests +

-0.3.4 Writing tests +4.4.1 testconfig file

-

-0.3.4.1 testconfig file -

section @@ -857,11 +1070,11 @@

-0.3.5 Command line +4.4.2 Command line

@@ -1198,10 +1411,10 @@
Index: docs/megatest.lyx ================================================================== --- docs/megatest.lyx +++ docs/megatest.lyx @@ -19,11 +19,11 @@ \font_sf_scale 100 \font_tt_scale 100 \graphics default \default_output_format default -\output_sync 0 +\output_sync 1 \bibtex_command default \index_command default \paperfontsize default \spacing single \use_hyperref false @@ -85,15 +85,15 @@ \end_inset \end_layout -\begin_layout Section +\begin_layout Chapter About Megatest \end_layout -\begin_layout Subsection +\begin_layout Section Megatest design philosophy \end_layout \begin_layout Standard Megatest is intended to provide the minimum needed resources to make writing @@ -105,11 +105,11 @@ tool to parse, analyze and decide on the test outcome. A call to megatest can then be made to record the result. \end_layout -\begin_layout Subsection +\begin_layout Section Megatest architecture \end_layout \begin_layout Standard All data to specify the tests and configure the system is stored in plain @@ -128,29 +128,29 @@ \end_inset to your master sqlite3 database. \end_layout -\begin_layout Section +\begin_layout Chapter Installation \end_layout -\begin_layout Subsection +\begin_layout Section Compilation \end_layout -\begin_layout Subsubsection +\begin_layout Subsection 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 dependencie s on Linux. \end_layout -\begin_layout Subsubsection +\begin_layout Subsection Build and install \end_layout \begin_layout Standard Run @@ -163,15 +163,15 @@ to create the megatest executable. You may wish to copy the executable to a centrally accessible location. \end_layout -\begin_layout Subsection +\begin_layout Section Setup \end_layout -\begin_layout Subsubsection +\begin_layout Subsection Create megatest.config \end_layout \begin_layout Standard Create the file megatest.config using the megatest.config template from the @@ -256,117 +256,759 @@ \begin_layout Code 1 /tmp \end_layout -\begin_layout Subsubsection +\begin_layout Subsection Create runconfigs.config \end_layout \begin_layout Standard This file is used to set environment variables that are run specific. You can simply create an empty file to start. +\begin_inset listings +inline false +status open + +\begin_layout Plain Layout + +# runconfigs.config \end_layout -\begin_layout Subsubsection +\begin_layout Plain Layout + +\end_layout + +\end_inset + + +\end_layout + +\begin_layout Subsection Create the tests directory and your first test \end_layout \begin_layout Standard The structure should look like this: \end_layout -\begin_layout Code +\begin_layout Standard +\begin_inset listings +inline false +status open + +\begin_layout Plain Layout + ../tests \end_layout -\begin_layout Code -├── megatest.config -\end_layout - -\begin_layout Code -├── runconfigs.config -\end_layout - -\begin_layout Code -└── tests -\end_layout - -\begin_layout Code -    └── mytest -\end_layout - -\begin_layout Code - ├── main.sh -\end_layout - -\begin_layout Code -    └── testconfig -\end_layout - -\begin_layout Subsubsection +\begin_layout Plain Layout + + ├── megatest.config +\end_layout + +\begin_layout Plain Layout + + ├── runconfigs.config +\end_layout + +\begin_layout Plain Layout + + └── tests +\end_layout + +\begin_layout Plain Layout + + └── mytest +\end_layout + +\begin_layout Plain Layout + + ├── main.sh +\end_layout + +\begin_layout Plain Layout + + └── testconfig +\end_layout + +\end_inset + + +\end_layout + +\begin_layout Subsection Create the testconfig file for your test \end_layout -\begin_layout Code +\begin_layout Standard +\begin_inset listings +inline false +status open + +\begin_layout Plain Layout + [setup] \end_layout -\begin_layout Code +\begin_layout Plain Layout + runscript main.sh \end_layout -\begin_layout Subsubsection +\end_inset + + +\end_layout + +\begin_layout Subsection Create your test running script, main.sh \end_layout -\begin_layout Code +\begin_layout Standard +\begin_inset listings +inline false +status open + +\begin_layout Plain Layout + #!/bin/bash \end_layout -\begin_layout Code +\begin_layout Plain Layout \end_layout -\begin_layout Code +\begin_layout Plain Layout + megatest -runstep mystep1 "sleep 20;echo Done" -m "mystep1 is done" \end_layout -\begin_layout Code -megatest -test-status :state COMPLETED :status PASS -m "This is a test level - comment" +\begin_layout Plain Layout + \end_layout -\begin_layout Subsubsection +\begin_layout Plain Layout + +megatest -test-status :state COMPLETED :status PASS -m "This is a comment" +\end_layout + +\end_inset + + +\end_layout + +\begin_layout Subsection Run megatest and watch your run progress \end_layout -\begin_layout Code +\begin_layout Standard +\begin_inset listings +inline false +status open + +\begin_layout Plain Layout + megatest :field1 abc :field2 def :runname 2011week08.4a -runall \end_layout -\begin_layout Code +\begin_layout Plain Layout + +\end_layout + +\begin_layout Plain Layout + watch megatest -list-runs % \end_layout + +\begin_layout Plain Layout + +\end_layout + +\begin_layout Plain Layout + +# OR use the dashboard +\end_layout + +\begin_layout Plain Layout + +\end_layout + +\begin_layout Plain Layout + +dashboard & +\end_layout + +\end_inset + + +\end_layout + +\begin_layout Code + +\end_layout + +\begin_layout Chapter +How to Write Tests +\end_layout + +\begin_layout Section +A Simple Test with one Step +\end_layout + +\begin_layout Subsection +Create your test directory. + The directory name will be the name of the test +\end_layout + +\begin_layout Standard +\begin_inset listings +inline false +status open + +\begin_layout Plain Layout + +mkdir simpletest +\end_layout + +\begin_layout Plain Layout + +cd simpletest +\end_layout + +\end_inset + + +\end_layout + +\begin_layout Subsection +Create your testconfig file. + This file contains various specifications for your test. + For our example the test author has chosen to write the test using csh + scripting. +\end_layout + +\begin_layout Standard +\begin_inset listings +inline false +status open + +\begin_layout Plain Layout + +# testconfig +\end_layout + +\begin_layout Plain Layout + +\end_layout + +\begin_layout Plain Layout + +[setup] +\end_layout + +\begin_layout Plain Layout + +runscript main.csh +\end_layout + +\end_inset + + +\end_layout + +\begin_layout Subsection +Create your main.csh script +\end_layout + +\begin_layout Standard +\begin_inset listings +inline false +status open + +\begin_layout Plain Layout + +#!/bin/tcsh -x +\end_layout + +\begin_layout Plain Layout + +\end_layout + +\begin_layout Plain Layout + +# run the cpu1 simulation. +\end_layout + +\begin_layout Plain Layout + +# The step name is "run_simulation" +\end_layout + +\begin_layout Plain Layout + +# The commandline being run for this step is "runsim cpu1" +\end_layout + +\begin_layout Plain Layout + +# The logpro file to validate the output from the run is "runsim.logpro" +\end_layout + +\begin_layout Plain Layout + +\end_layout + +\begin_layout Plain Layout + +$MEGATEST -runstep run_simulation -logpro runsim.logpro "runsim cpu1" +\end_layout + +\end_inset + + +\end_layout + +\begin_layout Standard +You can now run megatest and the created test directory will contain the + new files +\begin_inset Quotes eld +\end_inset + +run_simulation.html +\begin_inset Quotes erd +\end_inset + + and +\begin_inset Quotes eld +\end_inset + +run_simulation.log +\begin_inset Quotes erd +\end_inset + +. + If you are using the dashboard you can click on the run and then push the + +\begin_inset Quotes eld +\end_inset + +View log +\begin_inset Quotes erd +\end_inset + + button to view the log file in firefox. +\end_layout + +\begin_layout Section +Simple Test with Multiple Steps +\end_layout + +\begin_layout Standard +To run multiple steps simply add them to the main.csh file. + Here we add a step to test +\begin_inset Quotes eld +\end_inset + +cpu2 +\begin_inset Quotes erd +\end_inset + +. + The second step that tests cpu2 will only run after the step that tested + +\begin_inset Quotes eld +\end_inset + +cpu1 +\begin_inset Quotes erd +\end_inset + + completes. +\end_layout + +\begin_layout Standard +\begin_inset listings +inline false +status open + +\begin_layout Plain Layout + +#!/bin/tcsh -x +\end_layout + +\begin_layout Plain Layout + +\end_layout + +\begin_layout Plain Layout + +# run the cpu1 simulation. +\end_layout + +\begin_layout Plain Layout + +# The step name is "run_simulation" +\end_layout + +\begin_layout Plain Layout + +# The commandline being run for this step is "runsim cpu1" +\end_layout + +\begin_layout Plain Layout + +# The logpro file to validate the output from the run is "runsim.logpro" +\end_layout + +\begin_layout Plain Layout + +\end_layout + +\begin_layout Plain Layout + +$MEGATEST -runstep run_simulation_cpu1 -logpro runsim.logpro "runsim cpu1" +\end_layout + +\begin_layout Plain Layout + +$MEGATEST -runstep run_simulation_cpu2 -logpro runsim.logpro "runsim cpu2" +\end_layout + +\end_inset + + +\end_layout + +\begin_layout Section +Simple Test, Multiple Steps, Some in Parallel +\end_layout + +\begin_layout Subsection +The Makefile +\end_layout + +\begin_layout Standard +A good way to run steps in parallel within a single test, especially when + there are following steps, is to use the Unix Make utility. + Writing Makefiles is beyond the scope of this document but here is a minimal + example that will run +\begin_inset Quotes eld +\end_inset + +runsim cpu1 +\begin_inset Quotes erd +\end_inset + + and +\begin_inset Quotes eld +\end_inset + +runsim cpu2 +\begin_inset Quotes erd +\end_inset + + in parallel. + For more information on make try +\begin_inset Quotes eld +\end_inset + +info make +\begin_inset Quotes erd +\end_inset + + at the Linux command prompt. +\end_layout + +\begin_layout Standard +\begin_inset listings +inline false +status open + +\begin_layout Plain Layout + +# Example Makefile to run two steps in parallel +\end_layout + +\begin_layout Plain Layout + +\end_layout + +\begin_layout Plain Layout + +RTLDIR=/path/to/rtl +\end_layout + +\begin_layout Plain Layout + +CPUS = cpu1 cpu2 +\end_layout + +\begin_layout Plain Layout + +\end_layout + +\begin_layout Plain Layout + +run_simulation_$(CPUS).html : $(RTLDIR)/$(CPUS) +\end_layout + +\begin_layout Plain Layout + + $(MEGATEST) -runstep run_simulation_$(CPUS) -logpro runsim.logpro "runsim + $(CPUS) +\end_layout + +\end_inset + + +\end_layout + +\begin_layout Subsection +The main.csh file +\end_layout + +\begin_layout Standard +\begin_inset listings +inline false +status open + +\begin_layout Plain Layout + +#!/bin/tcsh -x +\end_layout + +\begin_layout Plain Layout + +\end_layout + +\begin_layout Plain Layout + +# run the cpu1 and cpu2 simulations in parallel. + +\end_layout + +\begin_layout Plain Layout + +# The -j parameter tells make how many jobs it may run in parallel +\end_layout + +\begin_layout Plain Layout + +\end_layout + +\begin_layout Plain Layout + +make -j 2 +\end_layout + +\begin_layout Plain Layout + +\end_layout + +\end_inset + + +\end_layout + +\begin_layout Section +Simple Test with Iteration +\end_layout + +\begin_layout Standard +Since no jobs run after the cpu1 and cpu2 simulations inside the test there + it is possible to run this test in iterated mode. +\end_layout + +\begin_layout Subsection +Update you testconfig file for iteration +\end_layout + +\begin_layout Standard +\begin_inset listings +inline false +status open + +\begin_layout Plain Layout + +[setup] +\end_layout + +\begin_layout Plain Layout + +runscript main.csh +\end_layout + +\begin_layout Plain Layout + +\end_layout + +\begin_layout Plain Layout + +[items] +\end_layout + +\begin_layout Plain Layout + +CPU cpu1 cpu2 +\end_layout + +\end_inset + + +\end_layout + +\begin_layout Subsection +Rewrite your main.csh for iteration +\end_layout + +\begin_layout Standard +\begin_inset listings +inline false +status open + +\begin_layout Plain Layout + +#!/bin/tcsh -x +\end_layout + +\begin_layout Plain Layout + +\end_layout + +\begin_layout Plain Layout + +# run the cpu simulation but now use the environment variable $CPU +\end_layout + +\begin_layout Plain Layout + +# to select what cpu to run the simulation against +\end_layout + +\begin_layout Plain Layout + +\end_layout + +\begin_layout Plain Layout + +$MEGATEST -runstep run_simulation -logpro runsim.logpro "runsim $CPU" +\end_layout + +\end_inset + + +\end_layout \begin_layout Section +Tests with Inter-test dependencies +\end_layout + +\begin_layout Standard +Sometimes a test depends on the output from a previous test or it may not + make sense to run a test is another test does not complete with status + +\begin_inset Quotes eld +\end_inset + +PASS +\begin_inset Quotes erd +\end_inset + +. + In either of these scenarios you can use the +\begin_inset Quotes eld +\end_inset + +waiton +\begin_inset Quotes erd +\end_inset + + keyword in your testconfig file to indicate that this test must wait on + one or more tests to complete before being launched. + In this example there is no point in running the +\begin_inset Quotes eld +\end_inset + +system +\begin_inset Quotes erd +\end_inset + + test if the +\begin_inset Quotes eld +\end_inset + +cpu +\begin_inset Quotes erd +\end_inset + + and +\begin_inset Quotes eld +\end_inset + +mem +\begin_inset Quotes erd +\end_inset + + tests either do not complete or complete but with status +\begin_inset Quotes eld +\end_inset + +FAIL +\begin_inset Quotes erd +\end_inset + +. +\end_layout + +\begin_layout Standard +\begin_inset listings +inline false +status open + +\begin_layout Plain Layout + +# testconfig for the "system" test +\end_layout + +\begin_layout Plain Layout + +[setup] +\end_layout + +\begin_layout Plain Layout + +runscript main.csh +\end_layout + +\begin_layout Plain Layout + +waiton cpu mem +\end_layout + +\end_inset + + +\end_layout + +\begin_layout Chapter Reference \end_layout -\begin_layout Subsection -Configuration files +\begin_layout Section +Configuration file Syntax \end_layout -\begin_layout Subsubsection +\begin_layout Subsection Sections \end_layout \begin_layout Standard [section name] \end_layout -\begin_layout Standard +\begin_layout Quotation This creates a section named \begin_inset Quotes eld \end_inset section name @@ -374,19 +1016,19 @@ \end_inset \end_layout -\begin_layout Subsubsection +\begin_layout Subsection Variables \end_layout \begin_layout Standard VARX has this value \end_layout -\begin_layout Standard +\begin_layout Quotation The variable \begin_inset Quotes eld \end_inset VARX @@ -402,11 +1044,11 @@ \end_inset \end_layout -\begin_layout Subsubsection +\begin_layout Subsection Includes \end_layout \begin_layout Standard [include filename] @@ -431,19 +1073,19 @@ \end_inset (with the whitespace). \end_layout -\begin_layout Subsubsection +\begin_layout Subsection Setting a variable by running a command \end_layout \begin_layout Standard VARNAME [system ls /tmp] \end_layout -\begin_layout Standard +\begin_layout Quotation The variable \begin_inset Quotes eld \end_inset VARNAME @@ -460,11 +1102,11 @@ . All lines of output from the command will be joined with a space. \end_layout -\begin_layout Subsubsection +\begin_layout Subsection Notes \end_layout \begin_layout Itemize Some variables are infered as lists. @@ -473,11 +1115,11 @@ \begin_layout Itemize Comments (lines starting with #) and blank lines are ignored. \end_layout -\begin_layout Subsection +\begin_layout Section Environment variables \end_layout \begin_layout Standard \begin_inset Tabular @@ -772,15 +1414,15 @@ \end_inset \end_layout -\begin_layout Subsection +\begin_layout Section Configuration files \end_layout -\begin_layout Subsubsection +\begin_layout Subsection megatest.config \end_layout \begin_layout Standard \begin_inset Tabular @@ -1226,11 +1868,11 @@ \end_inset \end_layout -\begin_layout Subsubsection +\begin_layout Subsection runconfigs.config file \end_layout \begin_layout Standard \begin_inset Tabular @@ -1485,15 +2127,15 @@ \begin_layout Code TESTPATH /nfs/testing/megacorp_runs \end_layout -\begin_layout Subsection +\begin_layout Section Writing tests \end_layout -\begin_layout Subsubsection +\begin_layout Subsection testconfig file \end_layout \begin_layout Standard \begin_inset Tabular