Skip to main content

Distributed tests planner plugin for pytest testing framework.

Project description

Distributed tests planner plugin for pytest testing framework Documentation Status

Install pytest-cloud

pip install pytest-cloud

# install GNU parallel utility
# for MacOS, you can use:
brew install parallel


The plugin provides an easy way of running tests among several test nodes (workers). Uses the great pytest-xdist plugin for actual distributed run. When used, it will automatically detect capabilites of given node(s) and run only the number of test processes it is able to handle. If will also filter out offline nodes or nodes which were failed to respond to the capabilities acquisition call.

Supports automatic codebase propagation to the test nodes, so you don’t have to install python dependencies for your project on remote test nodes globally - just make sure that your virtualenv folder is inside your project folder - that’s a requirement. It will also detect a root folder of the test environment (project root), and will rsync it to all test nodes.

NOTE: > pytest-cloud uses virtualenv instead of built-in venv package.

ATM only ssh transport is supported. So ensure that you have at least public key auth enabled to your test nodes from the master node (where py.test is executed).

Command-line options

  • –cloud-node

    Node hostname (or user@hostname) to run tests on. Multiple allowed.

  • –cloud-nodes

    Space-separated list of node hostname (or user@hostname) to run tests on. Multiple allowed.

  • –cloud-python

    Optional python executable name to be used on the remote test nodes. Default is the executable name used for the test run on the master.

  • –cloud-chdir

    Optional relative path to be used on the remote test nodes as target folder for syncing file and run tests. Default is pytest_<username>_<current_folder_name>.

  • –cloud-virtualenv-path

    Optional relative path to the virtualenv to be used on the remote test nodes. By default it will try to detect whether current test process is using virtualenv and if it’s located inside of the current directory. If that’s the case, it will use it for rsync on the remote node(s).

  • –cloud-mem-per-process

    Optional amount of memory roughly needed for test process, in megabytes. Will be used to calculate amount of test processes per node, getting the free memory, dividing it for the memory per process needed, and getting the minimum of that value and the number of CPU cores of the test node.

  • –cloud-max-processes

    Optional maximum number of processes per test node. Overrides from above the calculated number of processes using memory and number of CPU cores.

  • –cloud-rsync-bandwidth-limit

    Optional bandwidth limit per rsync process, in kilobytes per second. 5000 by default.

  • –cloud-rsync-max-processes

    Optional process count limit for rsync processes. By default there’s no limit so rsyncing will be in parallel for all test nodes.

  • –cloud-rsync-cipher

    Optional ssh cipher selection for rsync processes. by default. Default cipher is chosen to have the least possible network overhead. Network overhead is system, compilation and CPU architecture dependent, however chosen cipher is showing good results in majority of use cases.

Ini file options

  • cloud_develop_eggs

    Optional list of python package paths to install in development mode on remote side. Required to be inside of the project root directory.


py.test tests/ --cloud-node=10.0.120.{1..40} --cloud-mem-per-process=1000 --rsyncdir=.

Or if you pass list of nodes as space-separated list:

py.test tests/ --cloud-nodes='' --cloud-mem-per-process=1000 --rsyncdir=.


If you have questions, bug reports, suggestions, etc. please create an issue on the GitHub project page.


This software is licensed under the MIT license

See License file

© 2015 Anatoly Bubenkov and others.


Anatoly Bubenkov

original idea and implementation, new features and improvements

Oleg Pidsadnyi

bugfixes and further improvements

These people have contributed to pytest-cloud, in alphabetical order:



  • Fixes issue #21 (dasm)

  • Fully dropped python2 support (dasm)

  • Added explicit requirement for virtualenv (dasm)


  • Remove python2 support (bubenkoff)


  • Correctly handle default venv location (bubenkoff)


  • Compatible with pytest-xdist >= 1.26.0 including 2.0.0+ (Zac-HD)


  • Add config option to select cipher for ssh connection (dasm)

  • Fix deprecation warnings for pytest (dasm)

  • Support pytest-xdist >= 1.26.0 (dasm)

  • Support pytest >= 3.6.1 (dasm)

  • Remove support for Python 3.0, 3.1, 3.2, 3.3 (consistent with pytest-xdist) (dasm)


  • support python 3.7 (bubenkoff)


  • support pytest-xdist >=1.22.1 (bubenkoff)


  • pytest fixed version number is removed from the requirements (olegpidsadnyi)

  • removed pytest-cache dependency (olegpidsadnyi)


  • Add verbosity to rsync progress (bubenkoff)


  • Add develop eggs setting to install packages on remote side in development mode (bubenkoff)


  • Correctly handle python path on remote side (bubenkoff)


  • Add rsync progress to the output, change default bandwidth limit (bubenkoff)


  • Fast native rsync instead of python based one (bubenkoff)


  • Avoid unnecessary multiple ssh connections to the same node (bubenkoff)


  • Correct virtualenv execution (bubenkoff)


  • Ensure plugin command line hook is executed first (bubenkoff)

  • Correct free memory calculation (bubenkoff)


  • Add pyc files cleanup (bubenkoff)


  • Automatic discovery of the virtualenv (bubenkoff)

  • Fixes to rsyncing (bubenkoff)

  • Safer node id generation (bubenkoff)

  • Guarantee uniqueness of provided nodes (bubenkoff)


  • Delete orphan files when rsyncing (bubenkoff)


  • Add possibility to pass node list as space separated (bubenkoff)


  • Initial public release

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pytest-cloud-5.0.3.tar.gz (14.2 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page