Revision: 3885
Author: jussi.ao.malinen
Date: Tue Aug 24 04:55:40 2010
Log: explained SkipTeardownOnExit-runmode and fixed and refactored old
runmode documentation
http://code.google.com/p/robotframework/source/detail?r=3885
Modified:
/trunk/doc/userguide/src/Appendices/CommandLineOptions.txt
/trunk/doc/userguide/src/ExecutingTestCases/ConfiguringExecution.txt
/trunk/doc/userguide/src/ExecutingTestCases/TestExecution.txt
=======================================
--- /trunk/doc/userguide/src/Appendices/CommandLineOptions.txt Mon Aug 23
07:16:42 2010
+++ /trunk/doc/userguide/src/Appendices/CommandLineOptions.txt Tue Aug 24
04:55:40 2010
@@ -24,9 +24,10 @@
-e, --exclude <tag> `Selects the test cases`_ by tag.
-c, --critical <tag> Tests that have the given tag are `considered
critical`_.
-n, --noncritical <tag> Tests that have the given tag are `not
critical`_.
- --runmode <mode> Sets the `execution mode`_ for this test run.
- Valid modes are :opt:`ContinueOnFailure`,
- :opt:`DryRun`, and :opt:`Random:<what>`.
+ --runmode <mode> Sets the execution mode for this test run.
+ Valid modes are `ContinueOnFailure`_,
+ `ExitOnFailure`_, `SkipTeardownOnExit`_,
+ `DryRun`_, and `Random`_:<what>.
-v, --variable <name:value> Sets `individual variables`_.
-V, --variablefile <path:args> Sets variables using `variable files`_.
-d, --outputdir <dir> Defines where to `create output files`_.
@@ -115,7 +116,11 @@
.. _Selects the test cases: `By tag names`_
.. _considered critical: `Setting criticality`_
.. _not critical: `considered critical`_
-.. _execution mode: `Setting execution mode`_
+.. _ContinueOnFailure: `Continue on failure`_
+.. _ExitOnFailure: `Exit on failure`_
+.. _SkipTeardownOnExit: `Handling Teardowns`_
+.. _DryRun: `Dry run`_
+.. _Random: `Randomizing execution order`_
.. _individual variables: `Setting variables in command line`_
.. _create output files: `Output directory`_
=======================================
--- /trunk/doc/userguide/src/ExecutingTestCases/ConfiguringExecution.txt
Wed May 26 06:40:54 2010
+++ /trunk/doc/userguide/src/ExecutingTestCases/ConfiguringExecution.txt
Tue Aug 24 04:55:40 2010
@@ -286,25 +286,8 @@
__ `Setting variables in command line`_
-Setting execution mode
-~~~~~~~~~~~~~~~~~~~~~~
-
-Exit on failure
-'''''''''''''''
-
-It is possible to exit the execution prematurely without running all
-the tests. This can be achieved by using the option :opt:`--runmode` with
value
-:opt:`ExitOnFailure` (case-insensitive), in which case test execution is
-stopped immediately if a `critical test`_ fails. In this case the
-remaining tests are marked failed with the message :msg:`Critical failure
-occurred and ExitOnFailure option is in use`.
-
-There are also other ways to `stop test execution gracefully`__.
-
-__ `Stopping test execution gracefully`_
-
Dry run
-'''''''
+~~~~~~~
Robot Framework supports so called *dry run* mode where the tests are
run normally otherwise, but the keywords coming from test libraries
@@ -326,7 +309,7 @@
__ `Errors and warnings during execution`_
Randomizing execution order
-'''''''''''''''''''''''''''
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
The :opt:`--runmode` option can also be used to randomize the test
execution order. This is done using the different values explained
=======================================
--- /trunk/doc/userguide/src/ExecutingTestCases/TestExecution.txt Tue Jun
8 21:52:24 2010
+++ /trunk/doc/userguide/src/ExecutingTestCases/TestExecution.txt Tue Aug
24 04:55:40 2010
@@ -122,7 +122,7 @@
It is also possible to `randomize the execution order`__ using
the :opt:`--runmode` option.
-__ `Setting execution mode`_
+__ `Randomizing execution order`_
Continue on failure
~~~~~~~~~~~~~~~~~~~
@@ -201,15 +201,26 @@
Before Robot Framework 2.5 the only way to stop the test execution
gracefully so that reports and logs are generated was using the
-:opt:`--runmode ExitOnFailure` `command line option`__. This is a
-pretty limited mechanism, and Robot Framework 2.5 added the following
-new capabilities.
+:opt:`--runmode ExitOnFailure` command line option. This is a
+pretty limited mechanism, and Robot Framework 2.5 added a number of
+new capabilities explained below.
Regardless the way how tests are stopped, the tests that have not yet
been executed will be marked failed with a message :msg:`Test
execution was stopped due to a fatal error`.
-__ `Exit on failure`_
+Exit on failure
+'''''''''''''''
+
+It is possible to exit the execution prematurely without running all
+the tests. This can be achieved by using the option :opt:`--runmode` with
value
+:opt:`ExitOnFailure` (case-insensitive), in which case test execution is
+stopped immediately if a `critical test`_ fails. In this case the
+remaining tests are marked failed with the message :msg:`Critical failure
+occurred and ExitOnFailure option is in use`.
+
+This option has been available on Robot Framework since version 1.8.7. The
+following next three methods are new in Robot Framework version 2.5.
Pressing :code:`Ctrl-C`
'''''''''''''''''''''''
@@ -241,3 +252,10 @@
custom keywords can use `fatal exceptions`__ when they fail.
__ `Stopping test execution`_
+
+Handling Teardowns
+''''''''''''''''''
+
+Teardowns for tests and suites that have been started are run always, even
if tests are stopped using one of the methods above. This allows test and
suite cleanup to be run even if tests failed.
+
+Starting from Robot Framework version 2.5.2 teardowns can be skipped on
graceful exit with :opt:`--runmode SkipTeardownOnExit` command line option.
