UnitTest command line parameters

Contents

This page documents the command line parameters of UnitTest.

List of all command line parameters

                  -g, --group                   string Select test group(s) to run
                   -h, --help                          Display one-liner help on all command-line arguments
                 -H, --helpkw                   string Display verbose help on a single keyword
                -L, --license                          Show license information
             -q, --quiescence                          Enable quiescence detection
                 -O, --screen                   string Specify the screen output file
                  -S, --state                          Enable verbose chare state screen output
                  -t, --trace                          Disable call and stack trace
                -v, --verbose                          Select verbose screen output
                -V, --version                          Show version information

Detailed description of command line parameters

Keyword -g, --group

Select test group(s) to run

This option can be used to select one or more test groups to run by specifying the full or a partial name of a test group. All tests of a selected group will be executed. If this option is not given, all test groups are executed by default. Examples: '--group make_list' - run only the 'make_list' test group, '--group Parser' - run the test groups that have the string 'Parser' in their name, e.g., groups 'Control/FileParser' and 'Control/StringParser'.

Expected type: string

Keyword -h, --help

Display one-liner help on all command-line arguments

Get a short one-liner help on all command-line arguments from an executable. It also triggers the help from the Charm++ runtime system and in addition to that of the executable, it also lists command-line arguments from Converse Machine, Tracing, Load Balancer, Record/Replay, and Charm++ command-line parameters.

Keyword -H, --helpkw

Display verbose help on a single keyword

This keyword can be used to get a verbose help on a single command-line argument or control-file keyword (i.e., help on keyword) from an executable.

Expected type: string

Keyword -L, --license

Show license information

This keyword is used to display license information for the executable/tool on the standard output and exit successfully.

Keyword -q, --quiescence

Enable quiescence detection

This keyword is used to enable the quiescence detection feature of Charm++, used to catch logic errors in the asynchronous control flow, resulting in deadlocks. This is useful for automated testing and debugging and does have some overhead, so it is off by default.

Keyword -O, --screen

Specify the screen output file

This option is used to set the screen output file name. The default is "\<executable\>_screen.log".

Expected type: string

Keyword -S, --state

Enable verbose chare state screen output

This keyword is used to enable verbose Charm++ chare state collection and screen output. The chare state is displayed after a run is finished and the data collected is grouped by chare id (thisIndex), and within groups data is ordered by the time-stamp when a given chare member function is called. See src/Base/ChareState.hpp for details on what is collected. Note that to collect chare state, the given chare must be instrumented. Note that if quescence detection is enabled, chare state collection is also automatically enabled, but the chare state is only output if quiescence is detected (which also triggers an error).

Keyword -t, --trace

Disable call and stack trace

This keyword can be used to disable the on-screen call trace and stack trace after an exception is thrown. Trace output is on by default and in some cases, the call and stack trace can be huge and not very helpful, hence this command line option.

Keyword -v, --verbose

Select verbose screen output

This keyword is used to select verbose screen-output as opposed to the default quiet output. With quiet output only the most important messages are echoed to screen.

Keyword -V, --version

Show version information

This keyword is used to display version information for the executable/tool on the standard output and exit successfully.