#!/usr/bin/env python
# Copyright 2008-2009 Nokia Siemens Networks Oyj
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Robot Framework -- A keyword-driven test automation framework
Version:
Usage: pybot [options] data_sources
or: jybot [options] data_sources
or: interpreter /path/robot/runner.py [options] data_sources
or: python -m robot.runner [options] data_sources
Robot Framework is a Python-based keyword-driven test automation framework for
acceptance level testing and acceptance test-driven development (ATDD). It has
an easy-to-use tabular syntax for creating test cases and its testing
capabilities can be extended by test libraries implemented either with Python
or Java. Users can also create new keywords from existing ones using the same
simple syntax that is used for creating test cases.
Robot Framework has two start-up scripts, 'pybot' and 'jybot', which run it on
Python and Jython interpreters, respectively. Alternatively it is possible to
directly call 'robot/runner.py' script using a selected interpreter.
Data sources given to Robot Framework are either test case files or directories
containing them and/or other directories. Single test case file creates a test
suite containing all the test cases in it and a directory containing test case
files creates a higher level test suite with test case files or other
directories as sub test suites. If multiple data sources are given, a virtual
test suite containing suites generated from given data sources is created.
By default Robot Framework creates an XML output file and a log and a report in
HTML format, but this can be configured using various options listed below.
Outputs in HTML format are for human consumption and XML output for integration
with other systems. XML outputs can also be combined and otherwise further
processed with Rebot tool. Run 'rebot --help' for more information.
Robot Framework is open source software released under Apache License 2.0.
Its copyrights are owned and development supported by Nokia Siemens Networks.
For more information about the framework see
Options:
-N --name name Set the name of the top level test suite. Name is
automatically capitalized and underscores converted
to spaces. Default name is created from the name of
the executed data source.
-D --doc document Set the document of the top level test suite.
Underscores in the document are turned into spaces
and it may also contain simple HTML formatting (e.g.
*bold* and ).
-M --metadata name:value * Set metadata of the top level test suite. Name is
automatically capitalized and underscores converted
to spaces. Value can contain same HTML formatting as
--doc. Example: '--metadata version:1.2'
-G --settag tag * Sets given tag(s) to all executed test cases.
-t --test name * Select test cases to run by name. Name is case and
space insensitive and it can also be a simple pattern
where '*' matches anything and '?' matches any char.
If using '*' and '?' in the console is problematic
see --escape and --argumentfile.
-s --suite name * Select test suites to run by name. When this option
is used with --test, --include or --exclude, only
test cases in matching suites and also matching other
filtering criteria are selected. Name can be a simple
pattern similarly as with --test and it can contain
parent name separated with a dot. For example
'-s X.Y' selects suite 'Y' only if its parent is 'X'.
-i --include tag * Select test cases to run by tag. Similarly as name in
--test, tag is case and space insensitive and it
can also be a simple pattern. To include only tests
which have more than one tag use '&' or 'AND' between
tag names. For example '--include tag1&tag2' includes
only those tests that have both 'tag1' and 'tag2'.
-e --exclude tag * Select test cases not to run by tag. These tests are
not run even if they are included with --include. Tag
names are handled similarly as in --include and
excluding only tests containing multiple tags works
the same way using '&' or 'AND'.
-c --critical tag * Tests having given tag are considered critical. If no
critical tags are set, all tags are critical. Tags
can be given as a pattern like e.g. with --test.
-n --noncritical tag * Tests with given tag are not critical even if they
have a tag set with --critical. Tag can be a pattern.
--runmode mode Possible values are 'random:test', 'random:suite',
'random:all' and 'exitonfailure'. Any other value is
ignored. First three change the execution order of
suites or tests (or both). 'exitonfailure' causes the
execution of tests to be stopped if a critical test
fails.
-v --variable name:value * Set variables in the test data. Only scalar
variables are supported and name is given without
'${}'. See --escape for how to use special characters
and --variablefile for a more powerful variable
setting mechanism that allows also list variables.
Examples:
--variable str:Hello => ${str} = 'Hello'
-v str:Hi_World -E space:_ => ${str} = 'Hi World'
-v x: -v y:42 => ${x} = '', ${y} = '42'
-V --variablefile path * File to read variables from (e.g. 'path/vars.py').
Example file:
| import random
| __all__ = ['scalar','LIST__var','integer']
| scalar = 'Hello world!'
| LIST__var = ['Hello','list','world']
| integer = random.randint(1,10)
=>
${scalar} = 'Hello world!'
@{var} = ['Hello','list','world']
${integer} =
-d --outputdir dir Where to create output files. The default is the
directory where tests are run from and the given path
is considered relative to that unless it is absolute.
-o --output file XML output file. Given path, similarly as paths given
to --log, --report, --summary and --debugfile, is
relative to --outputdir unless given as an absolute
path. Other output files are created from XML output
file after the test execution and XML output can also
be further processed with Rebot tool (e.g. combined
with other XML output files). Default: output.xml
-l --log file HTML log file. Can be disabled by giving a special
name 'NONE'. Default: log.html
Examples: '--log mylog.html', '-l NONE'
-r --report file HTML report file. Can be disabled with 'NONE'
similarly as --log. Default: report.html
-S --summary file HTML summary report. Not created unless this option
is specified. Example: '--summary summary.html'
-b --debugfile file Debug file written during execution. Not created
unless this option is specified.
--transform ignored This option is ignored. Please use '--log' and
'--report' to control what outputs to generate.
-T --timestampoutputs When this option is used, timestamp in a format
'YYYYMMDD-hhmmss' is added to all generated output
files between their basename and extension. For
example '-T -o output.xml -r report.html -l none'
creates files like 'output-20070503-154410.xml' and
'report-20070503-154410.html'.
--splitoutputs level Split output and log files from specified suite
level. This makes generated files smaller and lower
level files available immediately when a respective
test suite is executed. Top level files have links to
lower level files for easy navigation.
--logtitle title Title for the generated test log. The default title
is ' Test Log'. Underscores in
the title are converted into spaces in all titles.
--reporttitle title Title for the generated test report. The default
title is ' Test Report'.
--summarytitle title Title for the generated summary report. The default
title is ' Summary Report'.
-L --loglevel level Threshold level for logging. Available levels:
TRACE, DEBUG, INFO (default), WARN, NONE (no logging)
--suitestatlevel level How many levels to show in 'Statistics by Suite'
table in outputs. By default all suite levels are
shown. If zero (0) is given the whole table is
removed. Example: '--SuiteStatLevel 3'
--tagstatinclude tag * Include only these tags in 'Statistics by Tag' and
and 'Test Details by Tag' tables in outputs. By
default all tags set in test cases are shown. Given
'tag' can also be a simple pattern (see e.g. --test).
--tagstatexclude tag * Exclude these tags from 'Statistics by Tag' and
'Test Details by Tag' tables in outputs. This option
can be used with --tagstatinclude similarly as
--exclude is used with --include.
--tagstatcombine tags:name * Create combined statistics based on tags.
These statistics are added into 'Statistics by Tag'
table and matching tests into 'Test Details by Tag'
table. Unless the optional 'name' is used, name of
the added combined tag is got from specified tags.
There are three ways to give tags to combine:
1) One tag as a simple pattern. Tests having a tag
matching the pattern are included. Example: 'it-*'
2) Two or more tags (or patterns) separated by '&' or
'AND'. Only tests having all these tags are included.
Examples: 'tag1&tag2', 'smokeANDowner-*ANDit-10'
3) Two or more tags (or patterns) separated by 'NOT'.
Tests having the first tag but not any of the latter
ones are included. Example: 'it-10NOTsmoke'
--tagdoc pattern:doc * Add documentation to tags matching given pattern.
Documentation is shown in 'Test Details by Tag'
table and also as a tooltip in 'Statistics by Tag'
table. Pattern can contain characters '*' (matches
anything) and '?' (matches any char). In case of
multiple matches, documentations are catenated with
spaces. Documentation can contain formatting as with
--doc option.
Examples:
--tagdoc mytag:My_documentation
--tagdoc regression:*See*_
--tagdoc owner-*:Original_author
--tagstatlink pattern:link:title * Add external links into 'Statistics by
Tag' table in outputs. Pattern can contain characters
'*' (matches anything) and '?' (matches any char).
Character(s) matching to wildcard expression(s) can
be used in the resulting link with syntax %N, where N
is the index of the match (starting from 1). In title
underscores are automatically converted to spaces.
Examples:
--tagstatlink mytag:
--tagstatlink bug-*:%1:Bug_Tracker
--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
name, using colon as separator. For example:
--listener MyListenerClass:arg1:arg2
-W --monitorwidth chars Width of the monitor output. Default is 78.
-C --monitorcolors on|off|force Using ANSI colors in console. Normally colors
work in unixes but not in Windows. Default is 'on'.
'on' - use colors in unixes but not in Windows
'off' - never use colors
'force' - always use colors (also in Windows)
--colormonitor param Deprecated. Use --monitorcolors instead.
-P --pythonpath path * Additional locations (directories, ZIPs, JARs) where
to search test libraries from when they are imported.
Multiple paths can be given by separating them with a
colon (':') or using this option several times. Given
path can also be a glob pattern matching multiple
paths but then it normally must be escaped or quoted.
Examples:
--pythonpath libs/
--pythonpath /opt/testlibs:mylibs.zip:yourlibs
-E star:STAR -P lib/STAR.jar -P mylib.jar
-E --escape what:with * Escape characters which are problematic in console.
'what' is the name of the character to escape and
'with' is the string to escape it with. Note that
all given arguments, incl. data sources, are escaped
so escape characters ought to be selected carefully.
<--------------------ESCAPES------------------------>
Examples:
--escape space:_ --metadata X:Value_with_spaces
-E space:SP -E quot:Q -v var:QhelloSPworldQ
-A --argumentfile path * Text file to read more arguments from. File can have
both options and data sources one per line. Contents
do not need to be escaped but spaces in the beginning
and end of lines are removed. Empty lines and lines
starting with a hash character (#) are ignored.
Example file:
| --include regression
| --name Regression Tests
| # This is a comment line
| my_tests.html
| path/to/test/directory/
-h -? --help Print usage instructions.
--version Print version information.
Options that are marked with an asterisk (*) can be specified multiple times.
For example '--test first --test third' selects test cases with name 'first'
and 'third'. If other options are given multiple times, the last value is used.
Long option format is case-insensitive. For example --SuiteStatLevel is
equivalent to, but easier to read than, --suitestatlevel. Long options can
also be shortened as long as they are unique. For example '--logle DEBUG' works
while '--lo log.html' does not because the former matches only --loglevel but
latter matches --log, --logtitle and --loglevel.
Environment Variables:
ROBOT_SYSLOG_FILE Path to the syslog file. If not specified, or set to
special value 'NONE', writing to syslog file is
disabled. Path must be absolute.
ROBOT_SYSLOG_LEVEL Log level to use when writing to the syslog file.
Available levels are the same as for --loglevel
option and the default is INFO.
Examples:
# Simple test run with 'pybot' without options.
$ pybot tests.html
# Using options and running with 'jybot'.
$ jybot --include smoke --name Smoke_Tests /path/to/tests.html
# Running 'robot/runner.py' directly and using test data in TSV format.
$ python /path/to/robot/runner.py tests.tsv
# Using custom start-up script, giving multiple options and executing a dir.
$ runtests.sh --test test1 --test test2 testdir/
# Executing multiple data sources and using case-insensitive long options.
$ pybot --SplitOutputs 1 /my/tests/*.html /your/tests.html
# Setting syslog file before running tests.
$ export ROBOT_SYSLOG_FILE=/tmp/syslog.txt
$ pybot tests.html
"""
import sys
try:
import pythonpathsetter
except ImportError:
# Get here when run as 'python -m robot.runner' and then importing robot
# works without this and pythonpathsetter is imported again later.
pass
import robot
robot.run_from_cli(sys.argv[1:], __doc__)
文件路径：C:\Python26\lib\site-packages\robot\runner.py
首先导入路径设置模块3:pythonpathsetter
再导入robot包
最后调用robot包中初始化文件中的run_from_cli函数处理命令行参数
阅读(19638) | 评论(0) | 转发(0) |
