man pages section 1: User Commands

Exit Print View

Updated: July 2014
 
 

ct_run (1)

Name

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

Synopsis

Please see following description for synopsis

Description




User Commands                                           ct_run(1)



NAME
     ct_run - 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 informa-
     tion). 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 pro-
     gram,  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  applica-
     tions, 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  indi-
     cates  a  successful  test  result,  1 indicates one or more
     failed or auto-skipped test  cases,  and  2  indicates  test



Ericsson AB       Last change: common_test 1.6.3                1






User Commands                                           ct_run(1)



     execution failure.

     If ct_run is called with option:

     -help

     it prints all valid start flags to stdout.

RUN TESTS FROM COMMAND LINE
          ct_run [-dir TestDir1 TestDir2 .. TestDirN] |
          [[-dir TestDir] -suite Suite1 Suite2 .. SuiteN
           [[-group Groups1 Groups2 .. GroupsN] [-case Case1 Case2 .. CaseN]]]
          [-step [config | keep_inactive]]
          [-config ConfigFile1 ConfigFile2 .. ConfigFileN]
          [-userconfig CallbackModule1 ConfigString1 and CallbackModule2
           ConfigString2 and .. CallbackModuleN ConfigStringN]
          [-decrypt_key Key] | [-decrypt_file KeyFile]
          [-label Label]
          [-logdir LogDir]
          [-logopts LogOpts]
          [-verbosity GenVLevel | [Category1 VLevel1 and
           Category2 VLevel2 and .. CategoryN VLevelN]]
          [-silent_connections [ConnType1 ConnType2 .. ConnTypeN]]
          [-stylesheet CSSFile]
          [-cover CoverCfgFile]
          [-event_handler EvHandler1 EvHandler2 .. EvHandlerN] |
             [-event_handler_init EvHandler1 InitArg1 and
           EvHandler2 InitArg2 and .. EvHandlerN InitArgN]
          [-include InclDir1 InclDir2 .. InclDirN]
          [-no_auto_compile]
          [-muliply_timetraps Multiplier]
          [-scale_timetraps]
          [-create_priv_dir auto_per_run | auto_per_tc | manual_per_tc]
             [-repeat N [-force_stop]] |
             [-duration HHMMSS [-force_stop]] |
             [-until [YYMoMoDD]HHMMSS [-force_stop]]
          [-basic_html]
          [-ct_hooks CTHModule1 CTHOpts1 and CTHModule2 CTHOpts2 and ..
           CTHModuleN CTHOptsN]
          [-exit_status ignore_config]


RUN TESTS USING TEST SPECIFICATION
          ct_run -spec TestSpec1 TestSpec2 .. TestSpecN
          [-config ConfigFile1 ConfigFile2 .. ConfigFileN]
          [-userconfig CallbackModule1 ConfigString1 and CallbackModule2
              ConfigString2 and .. and CallbackModuleN ConfigStringN]
          [-decrypt_key Key] | [-decrypt_file KeyFile]
          [-label Label]
          [-logdir LogDir]
          [-logopts LogOpts]
          [-verbosity GenVLevel | [Category1 VLevel1 and



Ericsson AB       Last change: common_test 1.6.3                2






User Commands                                           ct_run(1)



           Category2 VLevel2 and .. CategoryN VLevelN]]
          [-allow_user_terms]
          [-silent_connections [ConnType1 ConnType2 .. ConnTypeN]]
          [-stylesheet CSSFile]
          [-cover CoverCfgFile]
          [-event_handler EvHandler1 EvHandler2 .. EvHandlerN] |
             [-event_handler_init EvHandler1 InitArg1 and
           EvHandler2 InitArg2 and .. EvHandlerN InitArgN]
          [-include InclDir1 InclDir2 .. InclDirN]
          [-no_auto_compile]
          [-muliply_timetraps Multiplier]
          [-scale_timetraps]
          [-create_priv_dir auto_per_run | auto_per_tc | manual_per_tc]
             [-repeat N [-force_stop]] |
             [-duration HHMMSS [-force_stop]] |
             [-until [YYMoMoDD]HHMMSS [-force_stop]]
          [-basic_html]
          [-ct_hooks CTHModule1 CTHOpts1 and CTHModule2 CTHOpts2 and ..
           CTHModuleN CTHOptsN]
          [-exit_status ignore_config]


RUN TESTS IN WEB BASED GUI
             ct_run -vts [-browser Browser]
             [-dir TestDir1 TestDir2 .. TestDirN] |
             [[dir TestDir] -suite Suite [[-group Group] [-case Case]]]
          [-config ConfigFile1 ConfigFile2 .. ConfigFileN]
          [-userconfig CallbackModule1 ConfigString1 and CallbackModule2
              ConfigString2 and .. and CallbackModuleN ConfigStringN]
          [-logopts LogOpts]
          [-verbosity GenVLevel | [Category1 VLevel1 and
           Category2 VLevel2 and .. CategoryN VLevelN]]
          [-decrypt_key Key] | [-decrypt_file KeyFile]
          [-include InclDir1 InclDir2 .. InclDirN]
          [-no_auto_compile]
          [-muliply_timetraps Multiplier]
          [-scale_timetraps]
          [-create_priv_dir auto_per_run | auto_per_tc | manual_per_tc]
          [-basic_html]

REFRESH THE HTML INDEX FILES
          ct_run -refresh_logs [-logdir LogDir] [-basic_html]

RUN CT IN INTERACTIVE MODE
          ct_run -shell
          [-config ConfigFile1 ConfigFile2 ... ConfigFileN]
          [-userconfig CallbackModule1 ConfigString1 and CallbackModule2
              ConfigString2 and .. and CallbackModuleN ConfigStringN]
          [-decrypt_key Key] | [-decrypt_file KeyFile]

START A COMMON TEST MASTER NODE




Ericsson AB       Last change: common_test 1.6.3                3






User Commands                                           ct_run(1)



          ct_run -ctmaster


ATTRIBUTES
     See   attributes(5)   for   descriptions  of  the  following
     attributes:

     +---------------+------------------+
     |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
     +---------------+------------------+
     |Availability   | runtime/erlang   |
     +---------------+------------------+
     |Stability      | Uncommitted      |
     +---------------+------------------+
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.


NOTES
     This  software  was   built   from   source   available   at
     https://java.net/projects/solaris-userland.    The  original
     community       source       was       downloaded       from
     http://www.erlang.org/download/otp_src_R15B03-1.tar.gz

     Further  information about this software can be found on the
     open source community website at http://www.erlang.org/.



























Ericsson AB       Last change: common_test 1.6.3                4