testexecfw/stf/stfui/stf/doc/help.txt
changeset 2 8bb370ba6d1d
equal deleted inserted replaced
1:bbd31066657e 2:8bb370ba6d1d
       
     1 Help document for STF console based execution UI.
       
     2 file version: 1.0
       
     3 release date: 2009-12-03
       
     4 ============================================================
       
     5 
       
     6 
       
     7 
       
     8 Usage: stf [-option value] [--parameter value] [casename]
       
     9 
       
    10 where options include:
       
    11 
       
    12 -m <module name>
       
    13 -s <script file path> if use this parameter, system will use "testsripter" to call the script file.
       
    14 -i <engine initialization file path> Setting engine initialization file, if this option missed, STF will check the file under: "c:\testframework\testframework.ini"
       
    15 
       
    16 -c <module initialization file path> Setting module initialization file.
       
    17 
       
    18 --<configuration item> <value> 
       
    19          Setting configuration parameter, this setting will override settings in initialization file.
       
    20          The setting item could be:
       
    21          TestReportMode             # Possible values are: 'Empty', 'Summary', 'Environment', 'TestCases' or 'FullReport'
       
    22          CreateTestReport           # Possible values: YES or NO
       
    23          TestReportFilePath
       
    24          TestReportFileName
       
    25          TestReportFormat           # Possible values: TXT, HTML or XML
       
    26          TestReportOutput           # Possible values: FILE or RDEBUG
       
    27          TestReportFileCreationMode # Possible values: OVERWRITE or APPEND    
       
    28 
       
    29 -p <item> <value> 
       
    30          transfer name&value parameter into test module.
       
    31 
       
    32 -v       display version information
       
    33 -?/-h    display this help information.
       
    34 
       
    35 
       
    36 
       
    37 For example:
       
    38 1, stf -m demomodule 3
       
    39         STF will execute 3rd case in "demomodule".
       
    40         
       
    41 2, stf -m demomodule -i c:\test\test.ini -p input ETrue -p expected 0 case1
       
    42         STF will execute "case1" under "demomodule", 
       
    43         take initialization setting from "test.ini", 
       
    44         transfer two paramters "input" and "expected" into test module.
       
    45 
       
    46 3, stf -s c:\test\mytest.cfg --TestReportMode Summary
       
    47         STF will execute cases definied in "mytest.cfg" via testscripter, 
       
    48         take initialization setting from "c:\testframework\testframework.ini", and take "TestReportMode" parameter as "summary"