Revision: 61c4fce120e1
Branch:   default
Author:   Pekka Klärck
Date:     Thu Jan 30 10:56:18 2014 UTC
Log:      UG: Documented --rerunmerge

Update issue 1615
Status: Review
Documented --rerunmerge in the User Guide.

Code, tests, and docs ready for review.
http://code.google.com/p/robotframework/source/detail?r=61c4fce120e1

Modified:
 /doc/userguide/src/Appendices/CommandLineOptions.rst
 /doc/userguide/src/ExecutingTestCases/ConfiguringExecution.rst
 /doc/userguide/src/ExecutingTestCases/PostProcessing.rst

=======================================
--- /doc/userguide/src/Appendices/CommandLineOptions.rst Thu Jan 30 10:07:17 2014 UTC +++ /doc/userguide/src/Appendices/CommandLineOptions.rst Thu Jan 30 10:56:18 2014 UTC
@@ -94,7 +94,7 @@
   -s, --suite <name>      `Selects the test suites`_ by name.
   -i, --include <tag>     `Selects the test cases`_ by tag.
   -e, --exclude <tag>     `Selects the test cases`_ by tag.
-  -R, --rerunmerge        TODO
+ -R, --rerunmerge `Merges together`_ re-execution results and original results. -c, --critical <tag> Tests that have the given tag are `considered critical`_. -n, --noncritical <tag> Tests that have the given tag are `not critical`_.
   -d, --outputdir <dir>   Defines where to `create output files`_.
@@ -182,6 +182,7 @@
 .. _usage instructions: `Getting help and version information`_
 .. _version information: `usage instructions`_

+.. _Merges together: `Merging re-executed output`_
 .. _Removes keyword data: `Removing and flattening keywords`_
 .. _Flattens keywords: `Removes keyword data`_
 .. _starting time: `Setting start and end time of execution`_
=======================================
--- /doc/userguide/src/ExecutingTestCases/ConfiguringExecution.rst Thu Jan 30 09:43:51 2014 UTC +++ /doc/userguide/src/ExecutingTestCases/ConfiguringExecution.rst Thu Jan 30 10:56:18 2014 UTC
@@ -134,10 +134,15 @@
 contains no failed tests. Using a special value :opt:`NONE` as the output
 is same as not specifying this option at all.

+.. tip:: Re-execution results and original results can be `merged together`__
+         using the :opt:`--rerunmerge` command line option.
+
.. note:: Re-executing failed tests is a new feature in Robot Framework 2.8. Prior Robot Framework 2.8.4 the option was named :opt:`--runfailed`.
           The old name still works, but it will be removed in the future.

+__ `Merging re-executed output`_
+
 When no tests match selection
 '''''''''''''''''''''''''''''

=======================================
--- /doc/userguide/src/ExecutingTestCases/PostProcessing.rst Thu Jan 30 10:07:17 2014 UTC +++ /doc/userguide/src/ExecutingTestCases/PostProcessing.rst Thu Jan 30 10:56:18 2014 UTC
@@ -99,3 +99,36 @@

 Merging re-executed output
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+There is often a need to re-execute a subset of tests, for example, after
+fixing a bug in the system under test or in the tests themselves. This can be
+accomplished by `selecting test cases`_ by names (:opt:`--test` and
+:opt:`--suite` options), tags (:opt:`--include` and :opt:`--exclude`), or
+by previous status (:opt:`--rerunfailed`).
+
+Combining re-execution results with the original results using the default
+`combining outputs`_ approach does not work too well. The main problem is
+that you get separate test suites and possibly already fixed failures are
+also shown. In this situation it is often better to use :opt:`--rerunmerge (-R)`
+option to tell :prog:`rebot` to merge the results instead. In practice this
+means that tests from the latter test runs replace tests in the original.
+The usage is best illustrated by a practical example using :opt:`--rerunfailed`
+and :opt:`--rerunmerge` together::
+
+ pybot --output original.xml tests # first execute all tests + pybot --rerunfailed original.xml --output rerun.xml tests # then re-execute failing + rebot --rerunmerge original.xml rerun.xml # finally merge results
+
+It is also possible to merge together more than two results, and all other
+command line options work normally::
+
+ rebot --rerunmerge --name Merged --critical regression original.xml rerun1.xml rerun2.xml
+
+The message of the merged tests contains a note that results have been
+replaced. The message also shows the old status and message of the test.
+
+Merging results requires that the original result contains all same suites
+and tests as the merged results. Suites and tests tests not found from the
+original are ignored and an error printed to the console.
+
+.. note:: Merging re-executed results is a new feature in Robot Framework 2.8.4.

--

--- You received this message because you are subscribed to the Google Groups "robotframework-commit" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to robotframework-commit+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/groups/opt_out.

Reply via email to