Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The path to store JUnit-XML style report. [--junit-xml]

Use command line executable in virtual environment scripts folder if it exists.

If this is ticked and exists, the pytest executable in the virtual environment scripts folder will be used instead.

Install PyTest on agent using Pip

If this is ticked, PyTest is installed on the agent using Pip.

Using 

The Using drop down is populated by any property collector properties whose namespace matches the pattern defined by the PyTest action. The pattern for this action is ^PyTest\..*. The default property collector searches the environment path for "pytest.exe".

...

Alternatively, you can select the Custom option from the Using drop down list and specify a path in the resulting input field that will be displayed. Please read Why it's a good idea to use a property collector before using this option.


Pip

Image Modified

Use an alternate source to PyPI to install PyTest

If this is ticked, PyPI is not used as a source to install PyTest.

Package Source

The PyTest package source to use for the install.

Install project in editable mode

If this is ticked, the project is installed in editable mode.

Source Directory

Visible only if the checkbox 'Install project in editable mode' is ticked.

The irectory to check out editable projects into. The default in a virtualenv is “<venv path>\src”. The default for global installs is “<current dir>\src”.

Install pre-release or development package version

If this is ticked, pip will also find pre-release and development versions. By default, pip only finds stable versions. [--pre]

Disable cache

If this is ticked, the cache is disabled. [--no-cache-dir]

Pip Verbosity

The amount of information detail to display in the build log. [-qqq | -qq | -q | -v]

Use command line executable in virtual environment scripts folder if it exists.

If this is ticked and exists, the pip executable in the virtual environment scripts folder will be used instead.

Using Pip

The Using drop down is populated by any property collector properties whose namespace matches the pattern defined by the Pip Install action. The pattern for this action is ^Pip\..*. The default property collector searches the environment path for "pip.exe".

If you create a property collector for this action, make sure you select the Path Finder PlugIn type and give it a name that will match the pattern above in blue. Example names listed here, search the table's Plugin column for "Pip".

For more in-depth explanations on property collectors see Property Collectors.

Alternatively, you can select the Custom option from the Using drop down list and specify a path in the resulting input field that will be displayed. Please read Why it's a good idea to use a property collector before using this option.


Settings

Non-Binary Packages

Specify any packages for which binary packages should not be used. [--no-binary]

  • All - Disable all binary packages.
  • None - Empty the set of binary packages to be disabled.
  • Custom List - The custom set of binary packages to be disabled.

Note that some packages are tricky to compile and may fail to install when this option is used on them.

Non-Binary Package Names

Visible only if the option 'Custom List' is selected.

The names of the non-binary packages. One per line.

Binary Only Packages

Specify any packages for which only binary packages should not be used. [--only-binary]

  • All - Disable all source packages.
  • None - Empty the set of source packages to be disabled.
  • Custom List - The custom set of source packages to be disabled.

Note that packages without binary distributions will fail to install when this option is used on them.

Binary Only Package Names

Visible only if the option 'Custom List' is selected.

The names of the non-binary packages. One per line.

Constraints File(s)

Constrain versions using the given constraints files. One file path per line. [--constraint]

Prefer older binary packages over newer source packages.

If this is ticked, older binary packages will be used instead of newer source packages. [--prefer-binary]

Connection

Image Removed

Proxy

Specify a proxy in the form [user:passwd@]proxy.server:port. It is recommended to use a password type variable to store the password. [--proxy]

Trusted Host

Mark this host as trusted even if it does not have valid or any HTTPS. [--trusted-host]

...

Keyword Expression

Run tests which contain names that match the given string expression. [-k]

Mark Expression

Run tests which match the given mark expression. [-m]

Try to interpret all tests as python packages

This options allows you to specify package names for tests. If the package exists, its file system location will be used to find and run tests. [--pyargs]

Max Fails

Maximum number of errors or failures before exiting. Leave zero for continue on all errors and failures. [--maxfail]

JUnit Classname Prefix

Prefix to prepend to classnames in junit-xml output. [--junit-prefix]

Import Mode

Select whether to prepend or append to sys.path when importing test modules. Default is to 'prepend'. [--import-mode]

Base Temporary Directory

Base temporary directory for this test run. Note that this directory is removed if it exists. [--basetemp]


Configuration

Image Added

Configuration File

The path to the PyTest configuration or INI file. Path can be full or relative to working directory e.g. test\pytest.ini. [-c]

Override INI Options

Override or set INI options with 'option=value' style. One per line. [-o]

Markers not registered in the 'markers' section of the configuration file will raise errors. 

If this is ticked, markers not registered in the 'markers' section of the configuration file will raise errors.  [--strict-markers]

Plugin Loading

The path to the alternate CA bundle. [--cert–cert]

Client Certificate

The path to the SSL client certificate. A single file containing the private key and the certificate in PEM format. [--client-cert]

Timeout

Set the socket timeout in seconds. Leave zero to default to 15 seconds. [--timeout]

Retires

Maximum number of retries each connection should attempt. Leave zero to default to 5 times. [--retries]

Python

Image Removed

Platform

Only use wheels compatible with specified platform (e.g. 'win32', 'linux_i386', 'linux_x86_64'). Defaults to the platform of the running system. [–platform]

Implementation

Only use wheels compatible with specified Python implementation (e.g. ‘pp’, ‘jy’, ‘cp’, or ‘ip’). Defaults to the current interpreter implementation. Use ‘py’ to force implementation-agnostic wheels. [–implementation]

Python Version

Only use wheels compatible with specified Python interpreter version. If not specified, then the current system interpreter minor version is used. Either a major version (e.g. ‘3’) can be specified to match all minor revs of that major version or a minor version (e.g. ‘34’) can also be specified. [--python-version]

Python ABI

Only use wheels compatible with specified Python ABI (e.g. ‘pypy_41’). Defaults to the current interpreter ABI tag. Generally you will need to specify --implementation, --platform and --python-version when using this option. [--abi]

Require a hash to check against each requirement for repeatable installs. This is implied when any package in a requirements file has a --hash option. 

If this is ticked, a hash is required to check against each requirement for repeatable installs. This is implied when any package in a requirements file has a --hash option.  [--require-hashes]

Include pre-release and development versions. By default, pip only finds stable versions.

If this is ticked, pip will also find pre-release and development versions. By default, pip only finds stable versions. [--pre]

...

Don't load any conftest.py files

If this is ticked, no conftest.py files are loaded. [--noconftest]

Root Directory For Conftest Files

Visible only if the checkbox 'Don't load any conftest.py files' is NOT ticked.

Only load conftest.py's relative to specified directory. [–confcutdir]


Collection

Image Added

Ignore Paths

Specify paths to ignore during collection of tests to run. One path per line. [--ignore]

Ignore Path Patterns

Specify path patterns to ignore during collection of tests to run. Globbing patterns are allowed. One path per line. [--ignore-glob]

Deselect By Node Id

Specify items by node id to deselect during collection. One per line. [--deselect]

keep duplicate tests.

If this is ticked, tests are collected even if they are duplicates. [--keep-duplicates]

Don't ignore tests in a local virtualenv directory.

If this is ticked, tests in a local virtualenv directory are collected. [--collect-in-virtualenv]

Force test execution even if collection errors occur. 

If this is ticked, tests are executed even if collection errors occur. [--continue-collection-errors]


Doctests

Build

Directory to unpack packages into and build in. [--build]

...

If this is ticked, build directories are not cleaned. [--no-clean]

...


Logging

No Index

If this is ticked, the package index is ignored. Only look at find links URLs instead.

...