Revision: 3246
Author: pekka.klarck
Date: Mon May 10 03:34:45 2010
Log: moved post processing to own higher level section (i.e. file)
http://code.google.com/p/robotframework/source/detail?r=3246
Added:
/trunk/doc/userguide/src/ExecutingTestCases/PostProcessing.txt
Modified:
/trunk/doc/userguide/src/ExecutingTestCases/BasicUsage.txt
/trunk/doc/userguide/src/RobotFrameworkUserGuide.txt
=======================================
--- /dev/null
+++ /trunk/doc/userguide/src/ExecutingTestCases/PostProcessing.txt Mon May
10 03:34:45 2010
@@ -0,0 +1,82 @@
+Post-processing outputs
+-----------------------
+
+`XML output files`_ that are generated during the test execution can be
+post-processed afterwards by the :prog:`rebot` tool, which is an integral
+part of Robot Framework. It is used automatically when test
+reports and logs are generated during the test execution, but there
+are also good grounds for using it separately after the execution.
+
+.. contents::
+ :depth: 2
+ :local:
+
+Using :prog:`rebot` tool
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+The basic syntax for using :prog:`rebot` is exactly the same as when
+`starting test execution`_, `return codes`_ are the same, and also
+most of the command line options are identical. The main difference is
+that arguments to :prog:`rebot` are XML output files instead of test
+data files or directories.
+
+
+Creating different reports and logs
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+You can use :prog:`rebot` for creating the same reports and logs that
+are created automatically during the test execution. Of course, it is
+not sensible to create the exactly same files, but, for example,
+having one report with all test cases and another with only some
+subset of tests can be useful. Another common usage is creating only
+the output file when running tests (log and report generation can be
+disabled with options :opt:`--log NONE` and :opt:`--report NONE`) and
+generating logs and reports later. Tests can, for example, be executed
+on different environments, output files collected to a central place,
+and reports and logs created there. If generating reports and logs
+takes a lot of time when running tests on Jython, it is a good idea to
+try if using :prog:`rebot`, which always runs on Python, is any
+faster.
+
+::
+
+ rebot output.xml
+ rebot path/to/output_file.xml
+ rebot --include smoke --name Smoke_Tests c:\results\output.xml
+
+.. Note:: When running tests with Jython, the default JVM maximum
+ memory size may not be enough for creating reports and logs
+ if output files are very large. If that happens, you can
+ either `increase the JVM's maximum memory`__, or disable
+ creating reports and logs when tests are executed and use
+ :prog:`rebot` to generate them afterwards.
+
+__ `Modifying Java startup parameters`_
+
+Combining outputs
+~~~~~~~~~~~~~~~~~
+
+The most important feature of :prog:`rebot` is its ability to combine
+outputs from different test execution rounds. This capability allows,
+for example, running the same test cases on different environments and
+generating an overall report from all outputs. Combining outputs is
+extremely easy, all that needs to be done is giving several output
+files as arguments::
+
+ rebot output1.xml output2.xml
+ rebot outputs/*.xml
+
+When outputs are combined, a new top-level test suite is created so
+that test suites in the given output files are its child suites. This
+works the same way when `multiple test data files or directories are
+executed`__, and also in this case the name of the top-level test
+suite is created by joining child suite names with an ampersand (&)
+and spaces. These automatically generated names are not that good, and
+it is often a good idea to use :opt:`--name` to give a more
+meaningful name::
+
+ rebot --name Browser_Compatibility firefox.xml opera.xml safari.xml
ie.xml
+ rebot --include smoke --name Smoke_Tests c:\results\*.xml
+
+__ `Specifying test data to be executed`_
+
=======================================
--- /trunk/doc/userguide/src/ExecutingTestCases/BasicUsage.txt Mon May 10
03:29:01 2010
+++ /trunk/doc/userguide/src/ExecutingTestCases/BasicUsage.txt Mon May 10
03:34:45 2010
@@ -247,81 +247,6 @@
__ `Deprecating keywords`_
__ `Logging information`_
-Post-processing outputs
-~~~~~~~~~~~~~~~~~~~~~~~
-
-`XML output files`_ that are generated during the test execution can be
-post-processed afterwards by the :prog:`rebot` tool, which is an integral
-part of Robot Framework. It is used automatically when test
-reports and logs are generated during the test execution, but there
-are also good grounds for using it separately after the execution.
-
-The basic syntax for using :prog:`rebot` is exactly the same as when
-`starting test execution`_, `return codes`_ are the same, and also
-most of the command line options are identical. The main difference is
-that arguments to :prog:`rebot` are XML output files instead of test
-data files or directories.
-
-Creating different reports and logs
-'''''''''''''''''''''''''''''''''''
-
-You can use :prog:`rebot` for creating the same reports and logs that
-are created automatically during the test execution. Of course, it is
-not sensible to create the exactly same files, but, for example,
-having one report with all test cases and another with only some
-subset of tests can be useful. Another common usage is creating only
-the output file when running tests (log and report generation can be
-disabled with options :opt:`--log NONE` and :opt:`--report NONE`) and
-generating logs and reports later. Tests can, for example, be executed
-on different environments, output files collected to a central place,
-and reports and logs created there. If generating reports and logs
-takes a lot of time when running tests on Jython, it is a good idea to
-try if using :prog:`rebot`, which always runs on Python, is any
-faster.
-
-::
-
- rebot output.xml
- rebot path/to/output_file.xml
- rebot --include smoke --name Smoke_Tests c:\results\output.xml
-
-.. Note:: When running tests with Jython, the default JVM maximum
- memory size may not be enough for creating reports and logs
- if output files are very large. If that happens, you can
- either `increase the JVM's maximum memory`__, or disable
- creating reports and logs when tests are executed and use
- :prog:`rebot` to generate them afterwards.
-
-__ `Modifying Java startup parameters`_
-
-Combining outputs
-'''''''''''''''''
-
-The most important feature of :prog:`rebot` is its ability to combine
-outputs from different test execution rounds. This capability allows,
-for example, running the same test cases on different environments and
-generating an overall report from all outputs. Combining outputs is
-extremely easy, all that needs to be done is giving several output
-files as arguments::
-
- rebot output1.xml output2.xml
- rebot outputs/*.xml
-
-When outputs are combined, a new top-level test suite is created so
-that test suites in the given output files are its child suites. This
-works the same way when `multiple test data files or directories are
-executed`__, and also in this case the name of the top-level test
-suite is created by joining child suite names with an ampersand (&)
-and spaces. These automatically generated names are not that good, and
-it is often a good idea to use :opt:`--name` to give a more
-meaningful name::
-
- rebot --name Browser_Compatibility firefox.xml opera.xml safari.xml
ie.xml
- rebot --include smoke --name Smoke_Tests c:\results\*.xml
-
-__ `Specifying test data to be executed`_
-
-
Getting help on the command line
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
=======================================
--- /trunk/doc/userguide/src/RobotFrameworkUserGuide.txt Mon May 10
03:29:01 2010
+++ /trunk/doc/userguide/src/RobotFrameworkUserGuide.txt Mon May 10
03:34:45 2010
@@ -58,6 +58,7 @@
.. include:: ExecutingTestCases/BasicUsage.txt
.. include:: ExecutingTestCases/TestExecution.txt
+.. include:: ExecutingTestCases/PostProcessing.txt
.. include:: ExecutingTestCases/ConfiguringExecution.txt
.. include:: ExecutingTestCases/OutputFiles.txt
