2 new revisions:
Revision: 45a0da6aa951
Author: Pekka Klärck
Date: Wed Jun 15 05:32:35 2011
Log: Removed output splitting related documentation from User Guide...
http://code.google.com/p/robotframework/source/detail?r=45a0da6aa951
Revision: e20ce402c8f0
Author: Pekka Klärck
Date: Wed Jun 15 05:32:48 2011
Log: Automated merge with https://robotframework.googlecode.com/hg/
http://code.google.com/p/robotframework/source/detail?r=e20ce402c8f0
==============================================================================
Revision: 45a0da6aa951
Author: Pekka Klärck
Date: Wed Jun 15 05:32:35 2011
Log: Removed output splitting related documentation from User Guide
otherwise but explained that the functionality was removed in 2.6.
Update issue 861
Status: Done
Removal is now documented also in User Guide.
http://code.google.com/p/robotframework/source/detail?r=45a0da6aa951
Modified:
/doc/userguide/src/Appendices/CommandLineOptions.txt
/doc/userguide/src/CreatingTestData/Variables.txt
/doc/userguide/src/ExecutingTestCases/BasicUsage.txt
/doc/userguide/src/ExecutingTestCases/OutputFiles.txt
/doc/userguide/src/ExtendingRobotFramework/ListenerInterface.txt
=======================================
--- /doc/userguide/src/Appendices/CommandLineOptions.txt Tue Jun 14
09:27:02 2011
+++ /doc/userguide/src/Appendices/CommandLineOptions.txt Wed Jun 15
05:32:35 2011
@@ -34,10 +34,11 @@
-x, --xunitfile <file> Sets the path to the generated `XUnit compatible
result file`_.
-b, --debugfile <file> A `debug file`_ that is written during execution.
-T, --timestampoutputs `Adds a timestamp`_ to all output files.
- --splitoutputs <level> `Splits output and log`_ files.
+ --splitoutputs <level> `Splitting outputs`_ is not supported in
+ Robot Framework 2.6 or newer.
--logtitle <title> `Sets a title`_ for the generated test log.
--reporttitle <title> `Sets a title`_ for the generated test report.
- --reportbackground <colors> `Sets background colors`_ for the
generated report and summary.
+ --reportbackground <colors> `Sets background colors`_ for the generated
report and summary.
--summarytitle <title> `Sets a title`_ for the generated summary report.
-L, --loglevel <level> `Sets the threshold level`_ for logging.
--suitestatlevel <level> Defines how many `levels to show`_ in
the :name:`Statistics
@@ -47,8 +48,8 @@
--tagstatexclude <tag> `Excludes these tags`_ from
the :name:`Statistics by Tag` and
:name:`Test Details by Tag` tables in outputs.
--tagstatcombine <tags:title> Creates `combined statistics based on
tags`_.
- --tagdoc <pattern:doc> Adds `documentation to the specified tags`_.
- --tagstatlink <pattern:link:title> Adds `external links`_ to
the :name:`Statistics by
+ --tagdoc <pattern:doc> Adds `documentation to the specified tags`_.
+ --tagstatlink <pattern:link:title> Adds `external links`_ to
the :name:`Statistics by
Tag` table in outputs.
--listener <name:args> `Sets a listener`_ for monitoring test execution.
--warnonskippedfiles Show a warning when `an invalid file is
skipped`_.
@@ -87,10 +88,11 @@
-S, --summary <file> Sets the path to the generated `summary file`_.
-x, --xunitfile <file> Sets the path to the generated `XUnit compatible
result file`_.
-T, --timestampoutputs `Adds a timestamp`_ to all output files.
- --splitoutputs <level> `Splits output and log`_ files.
- --logtitle <title> `Sets a title`_ for the generated test log.
- --reporttitle <title> `Sets a title`_ for the generated test report.
- --reportbackground <colors> `Sets background colors`_ for the
generated report and summary.
+ --splitoutputs <level> `Splitting outputs`_ is not supported in
+ Robot Framework 2.6 or newer.
+ --logtitle <title> `Sets a title`_ for the generated test log.
+ --reporttitle <title> `Sets a title`_ for the generated test report.
+ --reportbackground <colors> `Sets background colors`_ for the generated
report and summary.
--summarytitle <title> `Sets a title`_ for the generated summary report.
-L, --loglevel <level> `Sets the threshold level`_ to select log
messages.
--suitestatlevel <level> Defines how many `levels to show`_ in
the :name:`Statistics by Suite`
@@ -133,7 +135,6 @@
.. _create output files: `Output directory`_
.. _Adds a timestamp: `Timestamping output files`_
-.. _Splits output and log: `Splitting outputs`_
.. _Sets a title: `Setting titles`_
.. _Sets background colors: `Setting background colors`_
=======================================
--- /doc/userguide/src/CreatingTestData/Variables.txt Tue May 24 06:26:59
2011
+++ /doc/userguide/src/CreatingTestData/Variables.txt Wed Jun 15 05:32:35
2011
@@ -721,13 +721,10 @@
| ${SUITE MESSAGE} | The full message of the current test suite,
including | Suite teardown |
| |
statistics. | |
+-----------------------+-------------------------------------------------------+----------------+
- | ${OUTPUT FILE} | An absolute path to the current `output
file`_. Has | Everywhere |
- | | different values during execution
when | |
- | | `outputs are
split`_. | |
+ | ${OUTPUT FILE} | An absolute path to the `output
file`_. | Everywhere |
+-----------------------+-------------------------------------------------------+----------------+
- | ${LOG FILE} | An absolute path to the current `log file`_
or string | Everywhere |
- | | NONE when no log file is created. Has
different values| |
- | | during execution when `outputs are
split`_. | |
+ | ${LOG FILE} | An absolute path to the `log file`_ or string
NONE | Everywhere |
+ | | when no log file is
created. | |
+-----------------------+-------------------------------------------------------+----------------+
| ${REPORT FILE} | An absolute path to the `report file`_ or
string NONE | Everywhere |
| | when no report is
created. | |
=======================================
--- /doc/userguide/src/ExecutingTestCases/BasicUsage.txt Tue Apr 19
03:36:38 2011
+++ /doc/userguide/src/ExecutingTestCases/BasicUsage.txt Wed Jun 15
05:32:35 2011
@@ -432,7 +432,7 @@
#!/bin/bash
pybot --variable BROWSER:Firefox --name Firefox --log none --report
none --output out/fx.xml login
pybot --variable BROWSER:IE --name IE --log none --report none --output
out/ie.xml login
- rebot --name Login --splitoutputs 1 --outputdir out --output login.xml
out/fx.xml out/ie.xml
+ rebot --name Login --outputdir out --output login.xml out/fx.xml
out/ie.xml
Implementing the above example with Windows batch files is not very
complicated, either. The most important thing to remember is that
@@ -446,7 +446,7 @@
@echo off
call pybot --variable BROWSER:Firefox --name Firefox --log none
--report none --output out\fx.xml login
call pybot --variable BROWSER:IE --name IE --log none --report none
--output out\ie.xml login
- call rebot --name Login --splitoutputs 1 --outputdir out --output
login.xml out\fx.xml out\ie.xml
+ call rebot --name Login --outputdir out --output login.xml out\fx.xml
out\ie.xml
In the next examples, JAR files under the :path:`lib` directory are
put into CLASSPATH before starting the test execution. In these
@@ -465,7 +465,7 @@
done
export CLASSPATH=$cp
- jybot --ouputdir /tmp/logs --splitoutputs 2 $*
+ jybot --ouputdir /tmp/logs --suitestatlevel 2 $*
Implementing this using Windows batch files is slightly more complicated.
The
difficult part is setting the variable containing the needed JARs inside a
For
@@ -482,7 +482,7 @@
)
set CLASSPATH=%CP%
- jybot --ouputdir c:\temp\logs --splitoutputs 2 %*
+ jybot --ouputdir c:\temp\logs --suitestatlevel 2 %*
goto :eof
=======================================
--- /doc/userguide/src/ExecutingTestCases/OutputFiles.txt Fri May 20
00:00:22 2011
+++ /doc/userguide/src/ExecutingTestCases/OutputFiles.txt Wed Jun 15
05:32:35 2011
@@ -43,9 +43,7 @@
The command line option :opt:`--output (-o)` determines the path where
the output file is created relative to the `output directory`_. The default
-name for the output file, when tests are run, is :path:`output.xml`. If
-`outputs are split`__ to several output files, they are named by
-postfixing the name of the first output file with sequence numbers.
+name for the output file, when tests are run, is :path:`output.xml`.
When post-processing outputs, new output files are not created unless
:opt:`--output (-o)` option is explicitly used.
@@ -56,8 +54,6 @@
__ `Post-processing outputs`_
-__ `Splitting outputs`_
-
Log file
''''''''
@@ -283,167 +279,12 @@
Splitting outputs
~~~~~~~~~~~~~~~~~
-Benefits
-''''''''
-
-When executing a large number of test cases, the size of log files can
-increase to the extent that opening them into a browser is
-slow. Additionally, since log files can be created only after output
-files are ready, they are available only after the test
-execution. This is not a problem if the test execution time is short,
-but with long-running tests it is better to be able to investigate
-the first failures while the rest of the tests are still running.
-
-Splitting outputs provides a solution for both of these
-problems. First of all, splitting logs means that individual log files
-are smaller and thus faster to open. If outputs are split while
-executing test cases, the lower-level log files are also created
-immediately when the equivalent output files are ready. Notifications
-about created files can be received through the `listener
-interface`_, and `automatic variables`_ :var:`${LOG_FILE}` and
-:var:`${OUTPUT_FILE}` always contain the path to the current file.
-
-Specifying a split level
-''''''''''''''''''''''''
-
-Outputs are split from a certain test suite level. Suites below this
-level will get their own outputs, and everything above the level will
-be in an index file, which has links to lower-level files. Only
-`output files`_ and `log files`_ are split, and they are always split
-from the same level. Splitting outputs gives the best results when test
-cases are organized into a relatively balanced hierarchical structure.
-
-Splitting can be activated with the command line option
-:opt:`--splitoutputs`, which takes the split level as an
-argument. Index files have the same name as the output and log would have
-without splitting, and lower-level files get a running counter between
-the basename and extension.
-
-Examples
-''''''''
-
-Explaining how splitting outputs actually works is easiest with
-examples, and it is also a good idea to experiment with real test data.
-In these examples we assume that test cases are organized into test
-suites hierarchically in the following way::
-
- project
- |-- component_a
- | |-- feature_a1
- | | |-- a11.html
- | | `-- a12.html
- | `-- feature_a2
- | `-- a21.html
- |-- component_b
- | `-- feature_b1
- | |-- b11.html
- | `-- b21.html
- `-- component_c
- |-- c1.html
- |-- c2.html
- `-- c3.html
-
-In the first example these test cases are executed so that they are
-split right below the top-level test suite. The command line to use is
-as follows, and the following table lists all the created output files::
-
- pybot --splitoutputs 1 project
-
-.. table:: All output files created in the first example
- :class: tabular
-
-
+---------------+-------------------------------------------------------+
- | Created File | Contents
|
-
+===============+=======================================================+
- | output.xml | Information about the :name:`Project` test suite,
|
- | | excluding its child test suites. Lower-level output
|
- | | files are referenced.
|
-
+---------------+-------------------------------------------------------+
- | output-001.xml| Information about the whole :name:`Component A`
suite.|
-
+---------------+-------------------------------------------------------+
- | output-002.xml| Information about the whole :name:`Component B`
suite.|
-
+---------------+-------------------------------------------------------+
- | output-003.xml| Information about the whole :name:`Component C`
suite.|
-
+---------------+-------------------------------------------------------+
- | log.html | A log file created from :path:`output.xml`,
|
- | | lower-level log files are linked.
|
-
+---------------+-------------------------------------------------------+
- | log-001.html | A log file created from :path:`output-001.xml`.
|
-
+---------------+-------------------------------------------------------+
- | log-002.html | A log file created from :path:`output-002.xml`.
|
-
+---------------+-------------------------------------------------------+
- | log-003.html | A log file created from :path:`output-003.xml`.
|
-
+---------------+-------------------------------------------------------+
- | report.html | A normal report file.
|
-
+---------------+-------------------------------------------------------+
-
-The fact that output files are split is transparent when
-post-processing outputs afterwards, and it is enough to point
-:prog:`rebot` to the index file. Splitting works with :prog:`rebot`
-regardless of whether outputs are split earlier or not. Outputs created by
the
-first example could thus by re-split, for example, as::
-
- rebot --splitoutputs 2 output.xml
-
-In this example, splitting is done from the second level. The table below
-again lists created the files, and because :prog:`rebot` does not create
new
-output files by default, they are not listed in the table.
-
-.. table:: All output files created in the second example
- :class: tabular
-
-
+---------------+-------------------------------------------------------+
- | Created File | Contents
|
-
+===============+=======================================================+
- | log.html | Information about the :name:`Project` and all the
|
- | | :name:`Component ?` suites, but not their child
|
- | | suites. Lower-level log files are linked.
|
-
+---------------+-------------------------------------------------------+
- | log-001.html | The whole :name:`Feature A1` test suite.
|
-
+---------------+-------------------------------------------------------+
- | log-002.html | The whole :name:`Feature A2` test suite.
|
-
+---------------+-------------------------------------------------------+
- | log-003.html | The whole :name:`Feature B1` test suite.
|
-
+---------------+-------------------------------------------------------+
- | log-004.html | The whole :name:`C1` test suite.
|
-
+---------------+-------------------------------------------------------+
- | log-005.html | The whole :name:`C2` test suite.
|
-
+---------------+-------------------------------------------------------+
- | log-006.html | The whole :name:`C3` test suite.
|
-
+---------------+-------------------------------------------------------+
- | report.html | A normal report file.
|
-
+---------------+-------------------------------------------------------+
-
-The last example splits outputs from the third level. It also shows
-how to configure output file names when splitting::
-
- rebot --splitoutputs 3 --log mylog.html --report none output.xml
-
-.. table:: All output files created in the third example
- :class: tabular
-
-
+---------------+-------------------------------------------------------+
- | Created File | Contents
|
-
+===============+=======================================================+
- | mylog.html | Information about the :name:`Project` test suite all
|
- | | the way to its second-level child suites. This
|
- | | includes test cases in the :name:`C?` suites.
|
- | | Lower-level logs are linked.
|
-
+---------------+-------------------------------------------------------+
- | mylog-001.html| The whole :name:`A11` test suite.
|
-
+---------------+-------------------------------------------------------+
- | mylog-002.html| The whole :name:`A12` test suite.
|
-
+---------------+-------------------------------------------------------+
- | mylog-003.html| The whole :name:`A21` test suite.
|
-
+---------------+-------------------------------------------------------+
- | mylog-004.html| The whole :name:`B11` test suite.
|
-
+---------------+-------------------------------------------------------+
- | mylog-005.html| The whole :name:`B12` test suite.
|
-
+---------------+-------------------------------------------------------+
-
-If a split level higher than three is used with this test data, all the
-information ends up to index files. The end result is thus exactly the
-same as if outputs were not split at all.
+Splitting outputs functionality has been removed in Robot Framework 2.6.
+Log files are nowadays loaded into browsers dynamically and memory
+consumption should stay reasonable also with larger data sets.
+For more information about this change see `issue 861`__ in the issue
tracker.
+
+__ http://code.google.com/p/robotframework/issues/detail?id=861
Configuring statistics
~~~~~~~~~~~~~~~~~~~~~~
=======================================
--- /doc/userguide/src/ExtendingRobotFramework/ListenerInterface.txt Mon
Jun 13 03:55:56 2011
+++ /doc/userguide/src/ExtendingRobotFramework/ListenerInterface.txt Wed
Jun 15 05:32:35 2011
@@ -180,13 +180,11 @@
+---------------+------------------+--------------------------------------------------+
| output_file | path | Called when writing to an output
file is |
| | | finished. The path is an absolute
path to the |
- | | | file. When `outputs are split`_,
called for each |
- | | | finished
file. |
+ | | |
file. |
+---------------+------------------+--------------------------------------------------+
| log_file | path | Called when writing to a log file
is |
| | | finished. The path is an absolute
path to the |
- | | | file. When `outputs are split`_,
called for each |
- | | | finished
file. |
+ | | |
file. |
+---------------+------------------+--------------------------------------------------+
| report_file | path | Called when writing to a report
file is |
| | | finished. The path is an absolute
path to the |
@@ -204,8 +202,6 @@
| | | them, have been
executed. |
+---------------+------------------+--------------------------------------------------+
-.. _outputs are split: `Splitting outputs`_
-
The available methods and their arguments are also shown in a formal Java
interface specification below. Contents of the :code:`java.util.Map
attributes` are
as in the table above. It should be remembered that a listener *does not*
need
==============================================================================
Revision: e20ce402c8f0
Author: Pekka Klärck
Date: Wed Jun 15 05:32:48 2011
Log: Automated merge with https://robotframework.googlecode.com/hg/
http://code.google.com/p/robotframework/source/detail?r=e20ce402c8f0
