Megatest

5/5/2011

Matt Welland

1 About Megatest

1.1 Megatest design philosophy

1.2 Megatest architecture

2 Installation

2.1 Compilation

2.1.1 Dependencies

2.1.2 Build and install

2.2 Setup

2.2.1 Create megatest.config

2.2.2 Create runconfigs.config

# runconfigs.config
​

2.2.3 Create the tests directory and your first test

../tests
  ├── megatest.config
  ├── runconfigs.config
  └── tests
     └── mytest
           ├── main.sh
           └── testconfig

2.2.4 Create the testconfig file for your test

[setup]
runscript main.sh

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 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"

3.2 Simple Test with Multiple Steps

#!/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

# 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

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

# testconfig for the "system" test
[setup]
runscript main.csh
waiton cpu mem

4 Reference

4.1 Configuration file Syntax

4.1.1 Sections

This creates a section named “section name”

4.1.2 Variables

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

4.1.3 Includes

4.1.4 Setting a variable by running a command

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.

4.1.5 Notes

• Some variables are infered as lists. Each token on the line separated by whitespace will be member of the list.
• Comments (lines starting with #) and blank lines are ignored.

4.2 Environment variables

4.3 Configuration files

4.3.1 megatest.config

4.3.2 runconfigs.config file

4.4 Writing tests

4.4.1 testconfig file

4.4.2 Command line