behave - Man Page
Run a number of feature tests with behave.
Description
usage: behave [options] [DIRECTORY|FILE|FILE:LINE|AT_FILE]*
Run a number of feature tests with behave.
Examples
behave features/ behave features/one.feature features/two.feature behave features/one.feature:10 behave @features.txt
positional arguments
- paths
Feature directory, file or file-location (FILE:LINE).
options
- -h, --help
show this help message and exit
- -C, --no-color
Disable colored mode.
- --color [{auto,on,off,always,never}]
Use colored mode or not (default: auto).
- -d, --dry-run
Invokes formatters without executing the steps.
- -D, --define NAME=VALUE
Define user-specific data for the config.userdata dictionary. Example: -D foo=bar to store it in config.userdata["foo"].
- -e, --exclude PATTERN
Don't run feature files matching regular expression PATTERN.
- -i, --include PATTERN
Only run feature files matching regular expression PATTERN.
- --no-junit
Don't output JUnit-compatible reports.
- --junit
Output JUnit-compatible reports. When junit is enabled, all stdout and stderr will be redirected and dumped to the junit report, regardless of the "-- capture" and "--no-capture" options.
- --junit-directory PATH
Directory in which to store JUnit reports.
- -j, --jobs, --parallel NUMBER
Number of concurrent jobs to use (default: 1). Only supported by test runners that support parallel execution.
- -f, --format FORMATTER
Specify a formatter. If none is specified the default formatter is used. Pass "--format help" to get a list of available formatters.
- --steps-catalog
Show a catalog of all available step definitions. SAME AS: "--format=steps.catalog --dry-run --no-summary -q".
- --no-skipped
Don't print skipped steps (due to tags).
- --show-skipped
Print skipped steps. This is the default behaviour. This switch is used to override a configuration file setting.
- --no-snippets
Don't print snippets for unimplemented steps.
- --snippets
Print snippets for unimplemented steps. This is the default behaviour. This switch is used to override a configuration file setting.
- --no-multiline
Don't print multiline strings and tables under steps.
- --multiline
Print multiline strings and tables under steps. This is the default behaviour. This switch is used to override a configuration file setting.
- -n, --name NAME_PATTERN
Select feature elements (scenarios, ...) to run which match part of the given name (regex pattern). If this option is given more than once, it will match against all the given names.
- --capture
Enable capture mode (stdout/stderr/log-output). Any capture output will be printed on a failure/error.
- --no-capture
Disable capture mode (stdout/stderr/log-output).
- --capture-stdout
Enable capture of stdout.
- --no-capture-stdout
Disable capture of stdout.
- --capture-stderr
Enable capture of stderr.
- --no-capture-stderr
Disable capture of stderr.
- --capture-log, --logcapture
Enable capture of logging output.
- --no-capture-log, --no-logcapture
Disable capture of logging output.
- --capture-hooks
Enable capture of hooks (except: before_all).
- --no-capture-hooks
Disable capture of hooks.
- --logging-level LOG_LEVEL
Specify a level to capture logging at. The default is INFO - capturing everything.
- --logging-format LOG_FORMAT
Specify custom format to print statements. Uses the same format as used by standard logging handlers. The default is "%(levelname)s:%(name)s:%(message)s".
- --logging-datefmt LOG_DATE_FORMAT
Specify custom date/time format to print statements. Uses the same format as used by standard logging handlers.
- --logging-filter LOG_FILTER
Specify which statements to filter in/out. By default, everything is captured. If the output is too verbose, use this option to filter out needless output. Example: --logging-filter=foo will capture statements issued ONLY to foo or foo.what.ever.sub but not foobar or other logger. Specify multiple loggers with comma: filter=foo,bar,baz. If any logger name is prefixed with a minus, eg filter=-foo, it will be excluded rather than included.
- --logging-clear-handlers
Clear existing logging handlers (during capture-log).
- --no-logging-clear-handlers
Keep existing logging handlers (during capture-log).
- --no-summary
Don't display the summary at the end of the run.
- --summary
Display the summary at the end of the run.
- -o, --outfile FILENAME
Write formatter output to output-file (default: stdout).
- -q, --quiet
Alias for --no-snippets --no-source.
- -r, --runner RUNNER_CLASS
Use own runner class, like: "behave.runner:Runner"
- --no-source
Don't print the file and line of the step definition with the steps.
- --show-source
Print the file and line of the step definition with the steps. This is the default behaviour. This switch is used to override a configuration file setting.
- --stage STAGE
Defines the current test stage. The test stage name is used as name prefix for the environment file and the steps directory (instead of default path names).
- --stop
Stop running tests at the first failure.
- -t, --tags TAG_EXPRESSION
Only execute features or scenarios with tags matching TAG_EXPRESSION. Use :option:`--tags-help` option for more information.
- -T, --no-timings
Don't print the time taken for each step.
- --show-timings
Print the time taken, in seconds, of each step after the step has completed. This is the default behaviour. This switch is used to override a configuration file setting.
- -v, --verbose
Show the files and features loaded.
- -w, --wip
Only run scenarios tagged with "wip". Additionally: use the "plain" formatter, do not capture stdout or logging output and stop at the first failure.
- --lang LANG
Use keywords for a language other than English.
- --lang-list
List the languages available for --lang.
- --lang-help LANG
List the translations accepted for one language.
- --tags-help
Show help for tag expressions.
- --version
Show version.