3 new revisions:
Revision: 21a783aabcff
Author: Janne Härkönen <j...@reaktor.fi>
Date: Mon Apr 18 21:38:20 2011
Log: nostatusrctest: use OUTDIR for outputs
http://code.google.com/p/robotframework/source/detail?r=21a783aabcff
Revision: 0934c0acf7b6
Author: Janne Härkönen <j...@reaktor.fi>
Date: Mon Apr 18 21:50:21 2011
Log: ug: documented --NoStatusRc, whitespace
http://code.google.com/p/robotframework/source/detail?r=0934c0acf7b6
Revision: 438a9c165079
Author: Janne Härkönen <j...@reaktor.fi>
Date: Mon Apr 18 21:50:38 2011
Log: regen
http://code.google.com/p/robotframework/source/detail?r=438a9c165079
==============================================================================
Revision: 21a783aabcff
Author: Janne Härkönen <j...@reaktor.fi>
Date: Mon Apr 18 21:38:20 2011
Log: nostatusrctest: use OUTDIR for outputs
http://code.google.com/p/robotframework/source/detail?r=21a783aabcff
Modified:
/atest/robot/cli/rebot/nostatusrc.txt
=======================================
--- /atest/robot/cli/rebot/nostatusrc.txt Mon Apr 18 08:01:01 2011
+++ /atest/robot/cli/rebot/nostatusrc.txt Mon Apr 18 21:38:20 2011
@@ -19,6 +19,6 @@
Return code can be forced to zero from commandline
[Arguments] ${datasource}
Run Tests Without Processing Output ${EMPTY} ${datasource}
- ${rc}= Run And Return Rc ${REBOT} --nostatusrc ${OUTFILE}
+ ${rc}= Run And Return Rc ${REBOT} --nostatusrc --outputdir ${OUTDIR}
${OUTFILE}
Should Be Equal As Integers ${rc} 0
==============================================================================
Revision: 0934c0acf7b6
Author: Janne Härkönen <j...@reaktor.fi>
Date: Mon Apr 18 21:50:21 2011
Log: ug: documented --NoStatusRc, whitespace
http://code.google.com/p/robotframework/source/detail?r=0934c0acf7b6
Modified:
/doc/userguide/src/Appendices/CommandLineOptions.txt
/doc/userguide/src/ExecutingTestCases/BasicUsage.txt
=======================================
--- /doc/userguide/src/Appendices/CommandLineOptions.txt Wed Mar 23
04:41:21 2011
+++ /doc/userguide/src/Appendices/CommandLineOptions.txt Mon Apr 18
21:50:21 2011
@@ -2,7 +2,7 @@
------------------------
This appendix lists all the command line options that are available
-when `executing test cases`__ with :prog:`pybot` or :prog:`jybot`, and when
+when `executing test cases`__ with :prog:`pybot` or :prog:`jybot`, and when
`post-processing outputs`_ with :prog:`rebot`.
__ `Starting test execution`_
@@ -16,70 +16,72 @@
-N, --name <name> `Sets the name`_ of the top-level test suite.
-D, --doc <document> `Sets the documentation`_ of the top-level test
suite.
- -M, --metadata <name:value> `Sets free metadata`_ for the top level
test suite.
- -G, --settag <tag> `Sets the tag(s)`_ to all executed test cases.
+ -M, --metadata <name:value> `Sets free metadata`_ for the top level
test suite.
+ -G, --settag <tag> `Sets the tag(s)`_ to all executed test cases.
-t, --test <name> `Selects the test cases by name`_.
- -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.
- -c, --critical <tag> Tests that have the given tag are `considered
critical`_.
- -n, --noncritical <tag> Tests that have the given tag are `not
critical`_.
+ -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.
+ -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 `ExitOnFailure`_,
`SkipTeardownOnExit`_,
+ Valid modes are `ExitOnFailure`_,
`SkipTeardownOnExit`_,
`DryRun`_, and `Random`_:<what>.
-v, --variable <name:value> Sets `individual variables`_.
- -V, --variablefile <path:args> Sets variables using `variable files`_.
+ -V, --variablefile <path:args> Sets variables using `variable files`_.
-d, --outputdir <dir> Defines where to `create output files`_.
-o, --output <file> Sets the path to the generated `output file`_.
- -l, --log <file> Sets the path to the generated `log file`_.
- -r, --report <file> Sets the path to the generated `report file`_.
- -S, --summary <file> Sets the path to the generated `summary file`_.
+ -l, --log <file> Sets the path to the generated `log file`_.
+ -r, --report <file> Sets the path to the generated `report file`_.
+ -S, --summary <file> Sets the path to the generated `summary file`_.
-x, --xunitfile <file> Sets the path to the generated `XUnit compatible
result file`_.
New in Robot Framework 2.5.5.
- -b, --debugfile <file> A `debug file`_ that is written during execution.
+ -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.
- --logtitle <title> `Sets a title`_ for the generated test log.
+ --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.
--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
- by Suite` table in outputs.
+ -L, --loglevel <level> `Sets the threshold level`_ for logging.
+ --suitestatlevel <level> Defines how many `levels to show`_ in
the :name:`Statistics
+ by Suite` table in outputs.
--tagstatinclude <tag> `Includes only these tags`_ in
the :name:`Statistics by Tag` and
- :name:`Test Details by Tag` tables in outputs.
+ :name:`Test Details by Tag` tables in outputs.
--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.
+ --listener <name:args> `Sets a listener`_ for monitoring test execution.
--warnonskippedfiles Show a warning when `an invalid file is
skipped`_.
- -W, --monitorwidth <chars> `Sets the width`_ of the console output.
+ --nostatusrc Sets the `return code`_ to zero regardless of
failures
+ in test cases. Error codes are returned normally.
+ -W, --monitorwidth <chars> `Sets the width`_ of the console output.
-C, --monitorcolors <on|off|force> `Specifies are colors`_ used in the
console.
-P, --pythonpath <path> Additional locations where to `search test
libraries`_ from when they are imported.
-E, --escape <what:with> `Escapes characters`_ that are problematic in
the console.
- -A, --argumentfile <path> A text file to `read more arguments`_ from.
+ -A, --argumentfile <path> A text file to `read more arguments`_ from.
-h, --help Prints `usage instructions`_.
--version Prints the `version information`_.
Command line options for post-processing outputs
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- -N, --name <name> `Sets the name`_ of the top level test suite.
+ -N, --name <name> `Sets the name`_ of the top level test suite.
-D, --doc <document> `Sets the documentation`_ of the top-level test
suite.
-M, --metadata <name:value> `Sets free metadata`_ for the top-level
test suite.
- -G, --settag <tag> `Sets the tag(s)`_ to all processed test cases.
- -t, --test <name> `Selects the test cases by name`_.
+ -G, --settag <tag> `Sets the tag(s)`_ to all processed test cases.
+ -t, --test <name> `Selects the test cases by name`_.
-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.
- -c, --critical <tag> Tests that have the given tag are `considered
critical`_.
+ -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`_.
-o, --output <file> Sets the path to the generated `output file`_.
- -l, --log <file> Sets the path to the generated `log file`_.
+ -l, --log <file> Sets the path to the generated `log file`_.
-r, --report <file> Sets the path to the generated `report file`_.
-S, --summary <file> Sets the path to the generated `summary file`_.
-x, --xunitfile <file> Sets the path to the generated `XUnit compatible
result file`_.
@@ -99,12 +101,14 @@
: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`_ into
the :name:`Statistics by Tag`
+ --tagstatlink <pattern:link:title> Adds `external links`_ into
the :name:`Statistics by Tag`
table in outputs.
- --removekeywords <all|passed> `Removes keyword data`_ from the
generated outputs.
+ --removekeywords <all|passed> `Removes keyword data`_ from the
generated outputs.
--starttime <timestamp> Sets the `starting time`_ of test execution
when creating
reports.
--endtime <timestamp> Sets the `ending time`_ of test execution when
creating reports.
+ --nostatusrc Sets the `return code`_ to zero regardless of
failures
+ in test cases. Error codes are returned normally.
-E, --escape <what:with> `Escapes characters`_ that are problematic in
the console.
-A, --argumentfile <path> A text file to `read more arguments`_ from.
-h, --help Prints `usage instructions`_.
=======================================
--- /doc/userguide/src/ExecutingTestCases/BasicUsage.txt Fri Feb 4
16:36:17 2011
+++ /doc/userguide/src/ExecutingTestCases/BasicUsage.txt Mon Apr 18
21:50:21 2011
@@ -82,7 +82,7 @@
pybot test_cases.html
pybot path/to/my_tests/
pybot c:\robot\tests.txt
-
+
It is also possible to give paths to several test case files or
directories at once, separated with spaces. In this case, Robot
Framework creates the top-level test suite automatically, and
@@ -91,8 +91,8 @@
catenating them together with an ampersand (&) and spaces. For example,
the name of the top-level suite in the first example below is
:name:`My Tests & Your Tests`. These automatically created names are
-often quite long and complicated. In most cases, it is thus better to
-use the :opt:`--name` option for overriding it, as in the second
+often quite long and complicated. In most cases, it is thus better to
+use the :opt:`--name` option for overriding it, as in the second
example below::
pybot my_tests.html your_tests.html
@@ -103,7 +103,7 @@
Robot Framework provides a number of command line options that can be
used to control how test cases are executed and what outputs are
-generated. This section explains the option syntax, and what
+generated. This section explains the option syntax, and what
options actually exist. How they can be used is discussed elsewhere
in this chapter.
@@ -203,7 +203,7 @@
''''''''''''
Runner scripts communicate the overall test execution status to the
-system running them using return codes. When the execution starts
+system running them using return codes. When the execution starts
successfully and no `critical test`_ fail, the return code is zero.
All possible return codes are explained in the table below.
@@ -213,7 +213,7 @@
======== ==========================================
RC Explanation
======== ==========================================
- 0 All critical tests passed.
+ 0 All critical tests passed.
1-249 Returned number of critical tests failed.
250 250 or more critical failures.
251 Help or version information printed.
@@ -229,6 +229,13 @@
variable. If you use some external tool for running tests, consult its
documentation for how to get the return code.
+Starting from Robot Framework 2.5.7, the return code can be set to 0 even
if
+there are critical failures using the :opt:`--NoStatusRC` command line
option.
+This might be useful in e.g. continuous integration servers where
+post-processing of results is needed before the overall status of test
+exectuion can be determined.
+
+
Errors and warnings during execution
''''''''''''''''''''''''''''''''''''
@@ -303,7 +310,7 @@
! exclam [ square1
> gt ] square2
# hash \* star
- < lt \ \
+ < lt \ \
========= ============= ========= =============
The following examples make the syntax more clear. In the
@@ -323,9 +330,9 @@
Problematic characters can often be handled easily using *argument files*.
These files can contain both command line options and paths
-to the test data, one per line. They are taken into use with
+to the test data, one per line. They are taken into use with
:opt:`--argumentfile` option (short option :opt:`-A`) along with possible
other
-command line options. Argument files can contain any
+command line options. Argument files can contain any
characters without escaping, but spaces in the beginning and end
of lines are ignored. Additionally, empty lines and lines starting with
a hash mark (#) are ignored::
==============================================================================
Revision: 438a9c165079
Author: Janne Härkönen <j...@reaktor.fi>
Date: Mon Apr 18 21:50:38 2011
Log: regen
http://code.google.com/p/robotframework/source/detail?r=438a9c165079
Modified:
/doc/userguide/RobotFrameworkUserGuide.html
=======================================
--- /doc/userguide/RobotFrameworkUserGuide.html Wed Mar 23 04:41:33 2011
+++ /doc/userguide/RobotFrameworkUserGuide.html Mon Apr 18 21:50:38 2011
@@ -8596,6 +8596,11 @@
variable <span class="code">$?</span>, and in Windows it is in <span
class="code">%ERRORLEVEL%</span>
variable. If you use some external tool for running tests, consult its
documentation for how to get the return code.</p>
+<p>Starting from Robot Framework 2.5.7, the return code can be set to 0
even if
+there are critical failures using the <span
class="opt">--NoStatusRC</span> command line option.
+This might be useful in e.g. continuous integration servers where
+post-processing of results is needed before the overall status of test
+exectuion can be determined.</p>
</div>
<div class="section" id="errors-and-warnings-during-execution">
<h4><a class="toc-backref" href="#id436">Errors and warnings during
execution</a></h4>
@@ -13348,6 +13353,10 @@
<kbd><span class="option">--warnonskippedfiles</span></kbd></td>
</tr>
<tr><td> </td><td>Show a warning when <a class="reference internal"
href="#warning-on-invalid-files">an invalid file is skipped</a>.</td></tr>
+<tr><td class="option-group">
+<kbd><span class="option">--nostatusrc</span></kbd></td>
+<td>Sets the <a class="reference internal" href="#return-codes">return
code</a> to zero regardless of failures
+in test cases. Error codes are returned normally.</td></tr>
<tr><td class="option-group" colspan="2">
<kbd><span class="option">-W</span>, <span class="option">--monitorwidth
<var><chars></var></span></kbd></td>
</tr>
@@ -13519,6 +13528,10 @@
<kbd><span class="option">--endtime
<var><timestamp></var></span></kbd></td>
</tr>
<tr><td> </td><td>Sets the <a class="reference internal"
href="#setting-start-and-end-time-of-execution">ending time</a> of test
execution when creating reports.</td></tr>
+<tr><td class="option-group">
+<kbd><span class="option">--nostatusrc</span></kbd></td>
+<td>Sets the <a class="reference internal" href="#return-codes">return
code</a> to zero regardless of failures
+in test cases. Error codes are returned normally.</td></tr>
<tr><td class="option-group" colspan="2">
<kbd><span class="option">-E</span>, <span class="option">--escape
<var><what:with></var></span></kbd></td>
</tr>
@@ -13868,7 +13881,7 @@
<div class="footer">
<hr class="footer" />
<p>Generated by <a class="reference external"
href="http://docutils.sourceforge.net/rst.html";>reStructuredText</a>.
Syntax highlighting by <a class="reference external"
href="http://pygments.org/";>Pygments</a>.</p>
-<p>Generated on: 2011-03-23 11:37 UTC.
+<p>Generated on: 2011-04-19 04:50 UTC.
</p>
</div>
