From 789f7e808a56c216728ee6843434691fd22f9581 Mon Sep 17 00:00:00 2001 From: Siri Hansen Date: Thu, 28 Mar 2013 12:18:39 +0100 Subject: [common_test] Document '-force_stop skip_rest' option to ct_run --- lib/common_test/doc/src/ct_run.xml | 12 +++++------ lib/common_test/doc/src/run_test_chapter.xml | 31 +++++++++++++++++++++------- 2 files changed, 30 insertions(+), 13 deletions(-) (limited to 'lib/common_test/doc') diff --git a/lib/common_test/doc/src/ct_run.xml b/lib/common_test/doc/src/ct_run.xml index d871908952..c87c765ae7 100644 --- a/lib/common_test/doc/src/ct_run.xml +++ b/lib/common_test/doc/src/ct_run.xml @@ -113,9 +113,9 @@ [-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]] + [-repeat N] | + [-duration HHMMSS [-force_stop [skip_rest]]] | + [-until [YYMoMoDD]HHMMSS [-force_stop [skip_rest]]] [-basic_html] [-ct_hooks CTHModule1 CTHOpts1 and CTHModule2 CTHOpts2 and .. CTHModuleN CTHOptsN] @@ -149,9 +149,9 @@ [-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]] + [-repeat N] | + [-duration HHMMSS [-force_stop [skip_rest]]] | + [-until [YYMoMoDD]HHMMSS [-force_stop [skip_rest]]] [-basic_html] [-ct_hooks CTHModule1 CTHOpts1 and CTHModule2 CTHOpts2 and .. CTHModuleN CTHOptsN] diff --git a/lib/common_test/doc/src/run_test_chapter.xml b/lib/common_test/doc/src/run_test_chapter.xml index 35f89153d3..afaed29626 100644 --- a/lib/common_test/doc/src/run_test_chapter.xml +++ b/lib/common_test/doc/src/run_test_chapter.xml @@ -174,7 +174,7 @@ ]]>, tells Common Test to repeat the tests n times (see below). ]]>, tells Common Test to repeat the tests for duration of time (see below). ]]>, tells Common Test to repeat the tests until stop_time (see below). - -force_stop, on timeout, the test run will be aborted when current test job is finished (see below). + -force_stop [skip_rest], on timeout, the test run will be aborted when current test job is finished. If skip_rest is provided the rest of the test cases in the current test job will be skipped (see below). ]]>, provides a decryption key for encrypted configuration files. ]]>, points out a file containing a decryption key for @@ -1273,6 +1273,7 @@ -duration DurTime ({duration,DurTime}), where DurTime is the duration, see below. -until StopTime ({until,StopTime}), where StopTime is finish time, see below. -force_stop ({force_stop,true}) + -force_stop skip_rest ({force_stop,skip_rest})

The duration time, DurTime, is specified as HHMMSS. Example: -duration 012030 or {duration,"012030"}, means the tests will @@ -1283,12 +1284,16 @@ Example: -until 071001120000 or {until,"071001120000"}, which means the tests will be executed and (if time allows) repeated, until 12 o'clock on the 1st of Oct 2007.

-

When timeout occurs, Common Test will never abort the test run immediately, since +

When timeout occurs, Common Test will never abort the ongoing test case, since this might leave the system under test in an undefined, and possibly bad, state. - Instead Common Test will finish the current test job, or the complete test - run, before stopping. The latter is the default behaviour. The force_stop - flag/option tells Common Test to stop as soon as the current test job is finished. - Note that since Common Test always finishes off the current test job or test session, + Instead Common Test will by default finish the current test + run before stopping. If the force_stop flag is + given, Common Test will stop as soon as the current test job + is finished, and if the force_stop flag is given with + skip_rest Common Test will only complete the current + test case and skip the rest of the tests in the test job. + Note that since Common Test always finishes off at least the + current test case, the time specified with duration or until is never definitive!

Log files from every single repeated test run is saved in normal Common Test fashion (see above). @@ -1311,6 +1316,18 @@ aborted after the to1 test and before the to2 test.

Example 2:

+ 
+          $ ct_run -dir $TEST_ROOT/to1 $TEST_ROOT/to2 -duration 001000 -forces_stop skip_rest
+

Here the same test run as in Example 1, but with the + force_stop flag set to skip_rest. If the timeout + occurs while executing tests in directory to1, the rest of the + test cases in to1 will be skipped and then the test will be + aborted without running the tests in to2 another time. If the + timeout occurs while executing tests in directory to2, then the + rest of the test cases in to2 will be skipped and then the test + will be aborted.

+ +

Example 3:

           $ date
 	  Fri Sep 28 15:00:00 MEST 2007
@@ -1321,7 +1338,7 @@
 	  Common Test will finish the entire test run before stopping (i.e. the to1 and to2 test
 	  will always both be executed in the same test run).

        
-       
Example 3:

+       
Example 4:

        
           $ ct_run -dir $TEST_ROOT/to1 $TEST_ROOT/to2 -repeat 5

        
Here the test run, including both the to1 and the to2 test, will be repeated 5 times.

-- 
cgit v1.2.3