Erlang logo
User's Guide
Reference Manual
Release Notes
PDF
Top

Common Test
Reference Manual
Version 1.4.6


Expand All
Contract All

Table of Contents

run_test

COMMAND

run_test

COMMAND SUMMARY

Shell script used for starting Common Test from the Unix command line.

DESCRIPTION

The run_test script is automatically generated as Common Test is installed (please see the Installation chapter in the Common Test User's Guide for more information). The script accepts a number of different start flags. Some flags trigger run_test 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.

run_test also accepts Erlang emulator flags. These are used when run_test 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).

If run_test is called without parameters, it prints all valid start flags to stdout.

Run tests from command line

    	run_test [-dir TestDir1 TestDir2 .. TestDirN] |	
	[-suite Suite1 Suite2 .. SuiteN 
	 [[-group Group1 Group2 .. GroupN] [-case Case1 Case2 .. CaseN]]]
	[-step [config | keep_inactive]]
	[-config ConfigFile1 ConfigFile2 .. ConfigFileN]
	[-decrypt_key Key] | [-decrypt_file KeyFile]
	[-logdir LogDir]
	[-silent_connections [ConnType1 ConnType2 .. ConnTypeN]]
	[-stylesheet CSSFile]
	[-cover CoverCfgFile]
	[-event_handler EvHandler1 EvHandler2 .. EvHandlerN]
	[-include InclDir1 InclDir2 .. InclDirN]
	[-no_auto_compile]
        [-repeat N [-force_stop]] |
        [-duration HHMMSS [-force_stop]] |
        [-until [YYMoMoDD]HHMMSS [-force_stop]]
	[-basic_html]

Run tests using test specification

	run_test -spec TestSpec1 TestSpec2 .. TestSpecN
	[-config ConfigFile1 ConfigFile2 .. ConfigFileN]
	[-decrypt_key Key] | [-decrypt_file KeyFile]
	[-logdir LogDir]
	[-allow_user_terms]
	[-silent_connections [ConnType1 ConnType2 .. ConnTypeN]]
	[-stylesheet CSSFile]
	[-cover CoverCfgFile]
	[-event_handler EvHandler1 EvHandler2 .. EvHandlerN]
	[-include InclDir1 InclDir2 .. InclDirN]
	[-no_auto_compile]
        [-repeat N [-force_stop]] |
        [-duration HHMMSS [-force_stop]] |
        [-until [YYMoMoDD]HHMMSS [-force_stop]]
	[-basic_html]

Run tests in web based GUI

        run_test -vts [-browser Browser]
	[-config ConfigFile1 ConfigFile2 .. ConfigFileN]
	[-decrypt_key Key] | [-decrypt_file KeyFile]
        [-dir TestDir1 TestDir2 .. TestDirN] |
        [-suite Suite [[-group Group] [-case Case]]]
	[-include InclDir1 InclDir2 .. InclDirN]
	[-no_auto_compile]
	[-basic_html]

Refresh the HTML index files

	run_test -refresh_logs [-logdir LogDir] [-basic_html]

Run CT in interactive mode

	run_test -shell 
	[-config ConfigFile1 ConfigFile2 ... ConfigFileN]
	[-decrypt_key Key] | [-decrypt_file KeyFile]

Start an Erlang node with a given name

	run_test -ctname NodeName

Start a Common Test Master node

	run_test -ctmaster

See also

Please read the Running Test Suites chapter in the Common Test User's Guide for information about the meaning of the different start flags.