Revision: 8c22260e26d3
Branch: default
Author: Robot Framework Developers (robotframew...@gmail.com)
Date: Wed Sep 4 15:10:49 2013 UTC
Log: Documentation enhancements to --RemoteKeywords NAME:<pattern>
Update issue 1480
Enhancements to --help and UG docs.
http://code.google.com/p/robotframework/source/detail?r=8c22260e26d3
Modified:
/doc/userguide/src/Appendices/CommandLineOptions.rst
/doc/userguide/src/ExecutingTestCases/OutputFiles.rst
/src/robot/rebot.py
/src/robot/result/keywordremover.py
/src/robot/run.py
=======================================
--- /doc/userguide/src/Appendices/CommandLineOptions.rst Wed Jun 26
14:12:59 2013 UTC
+++ /doc/userguide/src/Appendices/CommandLineOptions.rst Wed Sep 4
15:10:49 2013 UTC
@@ -54,7 +54,7 @@
--tagdoc <pattern:doc> Adds `documentation to the specified tags`_.
--tagstatlink <pattern:link:title> Adds `external links`_ to
the :name:`Statistics by
Tag` table.
- --removekeywords <all|passed|for|wuks|name:pattern> `Removes keyword
data`_ from the
+ --removekeywords <all|passed|name:pattern|for|wuks> `Removes keyword
data`_ from the
generated log file.
--listener <name:args> `Sets a listener`_ for monitoring test execution.
--warnonskippedfiles Show a warning when `an invalid file is
skipped`_.
=======================================
--- /doc/userguide/src/ExecutingTestCases/OutputFiles.rst Wed Jun 26
14:12:59 2013 UTC
+++ /doc/userguide/src/ExecutingTestCases/OutputFiles.rst Wed Sep 4
15:10:49 2013 UTC
@@ -456,17 +456,18 @@
Removing keywords from outputs
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Most of the content of `output files`_ comes from keywords and especially
their
+Most of the content of `output files`_ comes from keywords and their
log messages. When creating higher level reports, log files are not
necessarily
needed at all, and then keywords and their messages just take space
unnecessarily. Log files themselves can also grow overly large if they
contain
`for loops`_ or other constructs that repeat certain keywords multiple
times.
In these situations, the command line option :opt:`--removekeywords` can be
-used to dispose of unnecessary keywords. It can be used both when executing
-tests and with :prog:`rebot`, but in the former case keywords are not
removed
-from the output file. Keywords that contain warnings are not removed except
-in :opt:`ALL` mode.
+used to dispose of unnecessary keywords and messages. It can be used both
when
+executing tests and when post-processing outputs. Notice that when running
+tests, keywords are only removed from the log file, not from the XML output
+file. Keywords that contain warnings are not removed except in
the :opt:`ALL`
+mode.
The option has the following modes of operation:
@@ -475,33 +476,34 @@
:opt:`PASSED`
Remove keyword data from test cases that have passed and do not
- contain warnings_. In most cases, log files created after this contain
- enough information to investigate possible failures.
+ contain warnings_. In most cases, log files created when this option is
+ in use contain enough information to investigate possible failures.
+
+:opt:`NAME:<pattern>`
+ Remove data from all keywords matching the given pattern. The pattern is
+ matched against the full name of the keyword, prefixed with
+ the possible library or resource file name. The pattern is case, space,
and
+ underscore insensitive, and it may contain `*` and `?` as wildcards__.
:opt:`FOR`
- Remove passed iterations from `for loops`_. Starting from Robot
Framework
- 2.7.5, the last iteration is always kept.
+ Remove all passed iterations except the last one from `for loops`_.
:opt:`WUKS`
Remove all but last failing keyword inside BuiltIn_ keyword
:name:`Wait Until Keyword Succeeds`.
-:opt:`NAME:<pattern>`
- Remove all keywords matching the pattern. Pattern can be full name of
the
- keyword or utilize the `*` wildcard to match many keywords.
-
Examples::
rebot --removekeywords all output.xml
pybot --removekeywords passed --removekeywords for tests.txt
- pybot --removekeywords name:MyKeyword --removekeywords
name:MyResourceFile.* tests.txt
+ pybot --removekeywords name:HugeKeyword --removekeywords
name:resource.* tests.txt
.. Note::
The support for using :opt:`--removekeywords` when executing tests as
well
- as :opt:`FOR` and :opt:`WUKS` modes were added in Robot Framework 2.7.
+ as :opt:`FOR` and :opt:`WUKS` options were added in Robot Framework 2.7.
+ Option :opt:`NAME:<pattern>` was added in Robot Framework 2.8.2.
-.. Note::
- Option :opt:`NAME:<pattern>` was added in Robot Framework 2.8.2.
+__ `Option value as simple pattern`_
Setting start and end time of execution
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
=======================================
--- /src/robot/rebot.py Wed Jun 26 10:38:33 2013 UTC
+++ /src/robot/rebot.py Wed Sep 4 15:10:49 2013 UTC
@@ -187,17 +187,20 @@
--removekeywords all|passed|for|wuks|name:<pattern> * Remove keyword
data
from all generated outputs. Keywords containing
warnings are not removed except in `all` mode.
- all: remove data from all keywords
- passed: remove data only from keywords in
- passed test cases and suites
- for: remove passed iterations from for
- loops
- wuks: remove all but last failing
keyword
- from `Wait Until Keyword
Succeeds`
- name:<pattern>: remove those keywords that
matches
- pattern. Pattern can be the full
name
- of the keyword with spaces
removed
- or `*` wildcard.
+ all: remove data from all keywords
+ passed: remove data only from keywords in passed
+ test cases and suites
+ name:<pattern>: remove data from keywords that
match
+ the given pattern. The pattern is
matched
+ against the full name of the keyword
(e.g.
+ 'MyLib.Keyword', 'resource.Second
Keyword'),
+ is case, space, and underscore
insensitive,
+ and may contain `*` and `?` as
wildcards.
+ Examples: --removekeywords
name:Lib.HugeKw
+ --removekeywords
name:myresource.*
+ for: remove passed iterations from for loops
+ wuks: remove all but the last failing keyword
+ from `BuiltIn.Wait Until Keyword
Succeeds`
--starttime timestamp Set starting time of test execution when
creating
reports. Timestamp must be given in format
`2007-10-01 15:12:42.268` where all separators
are
=======================================
--- /src/robot/result/keywordremover.py Wed Jun 26 10:38:33 2013 UTC
+++ /src/robot/result/keywordremover.py Wed Sep 4 15:10:49 2013 UTC
@@ -26,7 +26,7 @@
'FOR': ForLoopItemsRemover,
'ALL': AllKeywordsRemover,
'WUKS': WaitUntilKeywordSucceedsRemover,
- }.get(how.upper(), SkipAllVisitor)()
+ }.get(how.upper(), SkipAllVisitor)() # TODO: Should fail, not skip
class _KeywordRemover(SuiteVisitor):
=======================================
--- /src/robot/run.py Wed Jun 26 10:38:33 2013 UTC
+++ /src/robot/run.py Wed Sep 4 15:10:49 2013 UTC
@@ -226,17 +226,20 @@
--removekeywords all|passed|for|wuks|name:<pattern> * Remove keyword
data
from the generated log file. Keywords containing
warnings are not removed except in `all` mode.
- all: remove data from all keywords
- passed: remove data only from keywords in
- passed test cases and suites
- for: remove passed iterations from for
- loops
- wuks: remove all but last failing
keyword
- from `Wait Until Keyword
Succeeds`
- name:<pattern>: remove those keywords that
matches
- pattern. Pattern can be the full
name
- of the keyword with spaces
removed or
- `*` wildcard.
+ all: remove data from all keywords
+ passed: remove data only from keywords in passed
+ test cases and suites
+ name:<pattern>: remove data from keywords that
match
+ the given pattern. The pattern is
matched
+ against the full name of the keyword
(e.g.
+ 'MyLib.Keyword', 'resource.Second
Keyword'),
+ is case, space, and underscore
insensitive,
+ and may contain `*` and `?` as
wildcards.
+ Examples: --removekeywords
name:Lib.HugeKw
+ --removekeywords
name:myresource.*
+ for: remove passed iterations from for loops
+ wuks: remove all but the last failing keyword
+ from `BuiltIn.Wait Until Keyword
Succeeds`
--listener class * A class for monitoring test execution. Gets
notifications e.g. when a test case starts and
ends.
Arguments to listener class can be given after
class
--
---
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.
