PyTest action is a test framework for Python applications and libraries.
Pytest
Working Folder
The working directory for the pip command line. Leave blank to default to the workspace folder.
Tests
Path to files or directories containing tests to run. Run specific tests within a module by specifying its node id. One path per line.
Root Directory
Install packages from the given requirements files. One file path per line. [--requirement]
Output Directory
The path to the root directory for tests. [--rootdir]
Report File
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".
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 "PyTest".
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.
Pip
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
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
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]
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
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]
Source Distribution
Select whether to use PEP 517 for building source distributions or force legacy behaviour. [--use-pep517 | --no-use-pep517]
Don't install package dependencies.
If this is ticked, package dependencies are not installed. [--no-deps]
Disable isolation when building a modern source distribution.
If this is ticked, isolation is disabled when building a modern source distribution. [--no-build-isolation]
Don't clean up build directories.
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.
Index URL
Visible only if the checkbox 'No Index' is NOT ticked.
The base URL of Python Package Index. Default is https://pypi.org/simple. This should point to a repository compliant with PEP 503 (the simple repository API) or a local directory laid out in the same format. [--index-url]
Extra Index URLs
Visible only if the checkbox 'No Index' is NOT ticked.
The extra URLs of package indexes to use in addition to --index-url. Should follow the same rules as --index-url. [--extra-index-url]
Find Links
Visible only if the checkbox 'No Index' is ticked.
If a URL or path to a HTML file is specified, then it is parsed for links to archives. If a local path or file:// URL that’s a directory is specified, then the directory listing will be searched for archives. [--find-links]
Extra Arguments
Global Options
Extra global options to be supplied to the setup.py call before the install command. One per line. [--global-option]
Options
Verbosity
The amount of information detail to display in the build log. [-qqq | -qq | -q | -v]
Log File
The path to a verbose appending log file. [--log]
Disable the cache.
If this is ticked, the cache is disabled. [--no-cache-dir]
Cache Directory
The path to a directory to store the cache data. [--cache-dir]
Run pip in an isolated mode, ignoring environment variables and user configuration.
If this ticked, pip is run in an isolated mode, ignoring environment variables and user configuration. [--isolated]
Exists Action
Specify what to do if path already exists. [--exists-action]
- Switch - Only relevant to VCS checkout. Attempt to switch the checkout to the appropriate URL and/or revision.
- Ignore - Abort current operation (e.g. don’t copy file, don’t create archive, don’t modify a checkout).
- Wipe - Delete the file or VCS checkout before trying to create, download, or checkout a new one.
- Backup - Rename the file or checkout to
{name}{'.bak' * n}, where n is some number of.bakextensions, such that the file didn’t exist at some point. So the most recent backup will be the one with the largest number after.bak. - Abort - Abort pip and return non-zero exit status.
Timeout (in seconds)
How many seconds to wait for the action to finish before timing out. The default is 86400 seconds (24 hours).
Treat failure as warning
Tick to continue build on failure marking the action with a warning status.
Ignore warnings
If this is ticked, any warnings logged will not mark the action with a warning status.
Environment
Environment Variables
Multiple environment variables can be defined - one per line. These are set before the command line is run.
Log environment variables
If this is ticked, environment variable values are written to the build log.
Generate system environment variables
Tick this checkbox to set up a list of new environment variables prefixed with 'ContinuaCI.' for all current system expression objects and variables.
Mask sensitive variable values in system environment variables
This checkbox is visible only if the 'Generate system environment variables' checkbox is ticked.
If this is ticked, the values of any variables marked as sensitive will be masked with **** when setting system environment variables. Clear this to expose the values.