ct_run

COMMAND

ct_run

COMMAND SUMMARY

Program used for starting Common Test from the
OS command line.

DESCRIPTION

The ct_run program is automatically installed with Erlang/OTP
and Common Test (please see the Installation chapter in the Common
Test User's Guide for more information). The program accepts a number
of different start flags. Some flags trigger ct_run
to start the Common Test application and pass on data to it. Some
flags start an Erlang node prepared for running Common Test in a
particular mode.

There is an interface function that corresponds to this program,
called ct:run_test/1, for starting Common Test from the Erlang
shell (or an Erlang program). Please see the ct man page for
details.

ct_run also accepts Erlang emulator flags. These are used
when ct_run calls erl to start the Erlang node
(making it possible to e.g. add directories to the code server path,
change the cookie on the node, start additional applications, etc).

With the optional flag:

-erl_args

it's possible to divide the options on the ct_run command line into
two groups, one that Common Test should process (those preceding -erl_args),
and one it should completely ignore and pass on directly to the emulator
(those following -erl_args). Options preceding -erl_args that Common Test
doesn't recognize, also get passed on to the emulator untouched.
By means of -erl_args the user may specify flags with the same name, but
with different destinations, on the ct_run command line.

If -pa or -pz flags are specified in the Common Test group of options
(preceding -erl_args), relative directories will be converted to
absolute and re-inserted into the code path by Common Test (to avoid
problems loading user modules when Common Test changes working directory
during test runs). Common Test will however ignore -pa and -pz flags
following -erl_args on the command line. These directories are added
to the code path normally (i.e. on specified form)

Exit status is set before the program ends. Value 0 indicates a successful
test result, 1 indicates one or more failed or auto-skipped test cases, and
2 indicates test execution failure.