-6.5 Rolling up Runs +7.5 Rolling up Runs
To roll up a number of tests in a sequence of runs to a single run use the -rollup command.
@@ -642,32 +669,32 @@
All keys must be specified and the runname is the name of the run that will be created. All paths are kept original inside the database. When -remove-runs is used to delete runs the data is not deleted if there are rollups that refer to the data.
-7 Dashboard +8 Dashboard
> dashboard &
-
+
+
Pushing one of the buttons on the main dashboard will bring up the test specific dashboard. Values are updated in semi-real time as the test runs.
-
+
+
-8 Generating an OpenDocument Spreadsheet from the Database +9 Generating an OpenDocument Spreadsheet from the Database
And OpenDocument multi-paned spreadsheet can be generated from the megatest.db file by running -extract-ods
@@ -679,17 +706,82 @@
You can optionally specify the keys for your database to limit further the runs to extract into the spreadsheet. The first sheet contains all the run data and subsequent sheets contain data rolled up for the individual tests.
-9 Reference +10 Flows +
+
+A flow specifies the tests to run, the order and dependencies and is managed by a running megatest process.
+
++11 Flow Specification and Running (Not released yet) +
++11.1 Write your flow file +
+
+flows/<flowname>.config
+
+
+
+
+
+
+# Flow: <flowname> +[flowconfig] +# turn on item level dependencies +itemdeps on + +[flowsteps] +# <testname>[,<predecessor>] + +# Run the test "copydata" +copydata + +# Run the test "setup" after copydata completes with PASS, WARN or WAIVE +setup,copydata + +# once the test "setup" completes successfully run sim1, sim2 and sim3 +sim1,setup +sim2,setup +sim3,setup ++
+11.2 Run the flow +
+
+
+
+
+
+megatest -runflow <flowname> :FIELD1 val1 :FIELD2 val2 :runname wk32.4 ++
+12 Monitor based running +
++12.1 Monitor logic +
+
+Note: The monitor is usable but incomplete as of Megatest v1.31. Click on the “Monitor” button on the dashboard to start the monitor and give it a try.
+
+
+
+
+
+
+
++13 Reference
-9.1 Configuration file Syntax +13.1 Configuration file Syntax
+
+Note: whitespace is preserved including at the end of line. Ensure your entries only have whitespace at the end of line when needed to avoid problems.
+
-9.1.1 Sections +13.1.1 Sections
[section name]@@ -698,11 +790,11 @@
This creates a section named “section name”
-9.1.2 Variables +13.1.2 Variables
VARX has this value@@ -711,11 +803,11 @@
The variable “VARX” will have the value “has this value”
-9.1.3 Includes +13.1.3 Includes
[include filename]@@ -724,11 +816,11 @@
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).
-9.1.4 Setting a variable by running a command +13.1.4 Setting a variable by running a command
VARNAME [system ls /tmp]@@ -737,11 +829,11 @@
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.
-9.1.5 Notes +13.1.5 Notes
- Some variables are infered as lists. Each token on the line separated by whitespace will be member of the list. @@ -749,325 +841,343 @@ Comments (lines starting with #) and blank lines are ignored.
-9.2 Environment variables +13.2 Environment variables
| + | Variable | -+ | Purpose |
| + | MT_CMDINFO | -+ | Conveys test variables to the megatest test runner. |
| + | MT_TEST_RUN_DIR | -+ | Directory assigned by megatest for the test to run. |
| + | 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) |
-9.3 megatest.config +13.3 megatest.config
| + | section | -+ | variable | -+ | value | -+ | required | -+ | comment |
| + | [setup] | -+ | max_concurrent_jobs | -+ | if variable is not defined no limit on jobs | -+ | no | -+ | |
| + | - | + | executable | -+ | full path to megatest binary | -+ | 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 | -+ | full path to where the link tree to all runs will be created | -+ | 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 | -+ | string of letters, numbers and underscore | -+ | at least one | -+ | |
| + | [jobtools] | -+ | launcher | -+ | command line used to launch jobs - the job command (megatest -execute) will be appended to this | -+ | no | -+ | |
| + | - | + | workhosts | -+ | list of hostnames to run jobs on NOT SUPPORTED RIGHT NOW | -+ | n/a | -+ | + + |
| +[jobgroups] + | ++string of letters, numbers and underscore + | ++number + | ++no + | ++Control number of jobs allowed to concurrently run in categories. See [jobgroup] in testconfig + | |||||
| + | [env-override] | -+ | string of letters, numbers and underscore | -+ | any string | -+ | 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 | -+ | a valid path writable by the test launching process and by the test process | -+ | yes | -+ | The disk usage balancing algorithm is to choose the disk with the least space for each test run. |
-9.4 runconfigs.config file +13.4 runconfigs.config file
| + | section | -+ | variable | -+ | value | -+ | required? | -+ | comment | |||||||||||||||||||||||
| + | [default] | -+ | string of letters, numbers and underscore | -+ | any | -+ | 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 | -+ | any | -+ | no | -+ | the values in this section will be set for any run where field1 is field1value, field2 is field2value and fieldN is fieldNvalue. |
| + | section | -+ | variable | -+ | value | -+ | required? | -+ | comments |
| + | [setup] | -+ | runscript | -+ | name of script to execute for this test | -+ | 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 | -+ | list of valid test names | -+ | no | -+ | This test will not run until the named tests are state completed and status PASS |
| + | + + | ++jobgroup + | ++ + | ++ + | ++ + | + +||||
| [items] | -+ | any valid | -+ | list of values | -+ | +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 + | + +||
| +[eztests] + | ++any valid + | ++stepname command + | +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 + | +Use in addition to or instead of runscript for easy implementation of steps. If <stepname>.logpro exists it will be applied to the <stepname>.log and resulting exit code will be used to determine PASS/FAIL/WARN |
-9.5.2 Command line +13.5.2 Command line
| @@ -1208,11 +1354,11 @@ switch or param | parameter | -+ | purpose | comments | @@ -1223,11 +1369,11 @@ -h- | + | brief help | @@ -1238,11 +1384,11 @@ -runall | - | + | run all tests | @@ -1253,11 +1399,11 @@ -runtests | test1,test2,... | -+ | run one or more tests | @@ -1268,11 +1414,11 @@ -step | stepname | -+ | record a step | requires :state and :status | @@ -1283,11 +1429,11 @@ -test-status- | + | record the test status | requires :state and :status | @@ -1298,11 +1444,11 @@ -setloglogfilename | -+ | set the logfile name for a test | path is assumed to be relative to the test run directory | @@ -1313,11 +1459,11 @@ -set-toploglogfilename | -+ | set the logfile name for the top test in an iterated test run | each sub test can have its own logfile set | @@ -1326,13 +1472,13 @@
| -m | -“comment” +“comment” | -+ | sets a comment for the step, test or run | @@ -1343,11 +1489,11 @@ :runname | [a-zA-Z0-9_-]+ | -+ | directory in which this run will be stored in the test run area | @@ -1358,15 +1504,15 @@ :state | any value | -+ | Set the step or test state, this is stored in the state field in the steps or tests table respectively | -For tests Megatest recognises “INCOMPLETE”, “COMPLETE” +For tests Megatest recognises “INCOMPLETE”, “COMPLETE” | ||||||||||||||||||||
| @@ -1373,15 +1519,15 @@ :status | any value | -+ | Set the step or test status, this is stored in the status field in the steps or tests table respectively | -For tests Megatest recognises “PASS”, “FAIL”, and “CHECK” +For tests Megatest recognises “PASS”, “FAIL”, and “CHECK” | ||||||||||||||||||||||||||||
| @@ -1388,11 +1534,11 @@ -list-runs | any value, % is wildcard | -+ | Respects -itempatt and -testpatt for filters | @@ -1403,11 +1549,11 @@ -testpatt | any value, % is wildcard | -+ | @@ -1418,11 +1564,11 @@ -itempatt | any value, % is wildcard | -+ | @@ -1433,11 +1579,11 @@ -showkeys | - | + | Print the keys being used for this database | @@ -1448,15 +1594,15 @@ -force | - | -Test will not re-run if in the “PASS”, “CHECK” or “KILLED”, using -force will force the run to be launched. + | +Test will not re-run if in the “PASS”, “CHECK” or “KILLED”, using -force will force the run to be launched. | -WARNING: The -force switch will bypass any “waiton” dependencies. +WARNING: The -force switch will bypass any “waiton” dependencies. | ||||||||||||||
| @@ -1463,11 +1609,11 @@ -xterm | - | + | Launch an xterm instead of run the test. The xterm will have the environment that the test would see. | @@ -1478,11 +1624,11 @@ -remove-runs | - | + | Remove a run, test or subtest from the database and the disk. Cannot be undone. Requires -testpatt, -itempatt, :runname and all keys be specified. | @@ -1493,11 +1639,11 @@ Test helpers | - | + | @@ -1508,11 +1654,11 @@ -runstep | - | + | Used inside a test to run a step, record the start and end of the step and optionally analyze the output using logpro. | @@ -1523,12 +1669,12 @@ -logpro | - | -If using logpro to asses the PASS/FAIL status of the step you specify the logpro file with this parameter. + | +If using logpro to acess the PASS/FAIL status of the step you specify the logpro file with this parameter. | @@ -1536,18 +1682,18 @@ |
-A Data +A Data
-B References +B References
ADDED docs/html/monitor-state-diagram.png Index: docs/html/monitor-state-diagram.png ================================================================== --- /dev/null +++ docs/html/monitor-state-diagram.png cannot compute difference between binary files