Compare commits

...

82 Commits

Author SHA1 Message Date
Bruno Oliveira
de993e1ee3 Prepare changelog for 1.22.1 2018-02-19 18:10:50 -03:00
Bruno Oliveira
af4409753a Show content for trivial changelog entries 2018-02-19 18:10:10 -03:00
Bruno Oliveira
c39cd10ae5 Small improvements to HOWTORELEASE 2018-02-19 18:07:13 -03:00
Ronny Pfannschmidt
11e3599785 Merge pull request #277 from lmtierney/single-loadscope
Ensure loadscope and loadfile work when the first scope has one work unit
2018-02-19 20:02:22 +01:00
Bruno Oliveira
1be8a463ff Add docstring to tests for #277 2018-02-16 20:14:47 -02:00
lmtierney
bd3c7dba8b Ensure loadscope and loadfile work when the first scope has one work unit 2018-02-08 19:51:42 -06:00
Ronny Pfannschmidt
d91ec5503e Merge pull request #262 from nicoddemus/titles-readme
Improve README to be more newcomer friendly
2018-02-08 07:49:08 +01:00
Bruno Oliveira
23ce4502f1 Merge pull request #268 from feuillemorte/234-master-worker-terminology
#234 use master/worker terminology
2018-02-06 07:27:31 -02:00
feuillemorte
6fb01801ac #234 Fix comments 2018-02-06 11:53:45 +03:00
Bruno Oliveira
ee2a1b4f4d Add an explicit test for backward compatibility with "config.slaveinput"
Related to #234
2018-01-30 19:13:14 -02:00
feuillemorte
b04703b6ba #234 Fix flake 8 and fix comments 2018-01-17 23:34:39 +03:00
feuillemorte
9a5a81962c Merge branch '234-master-worker-terminology' of github.com:feuillemorte/pytest-xdist into 234-master-worker-terminology 2018-01-17 23:07:45 +03:00
feuillemorte
40491279ef #234 Added master/worker terminology 2018-01-17 23:07:29 +03:00
Bruno Oliveira
9efe14946a Improve changelog formatting 2018-01-16 18:26:50 -02:00
feuillemorte
708256228b Add changelog entry 2018-01-16 21:49:54 +03:00
feuillemorte
f1e6dc4344 use master/worker terminology 2018-01-16 21:46:43 +03:00
Bruno Oliveira
3098f27731 Merge pull request #267 from nicoddemus/release-1.22.0
Prepare release 1.22.0
2018-01-11 18:13:41 -02:00
Bruno Oliveira
6c68478997 Prepare release 1.22.0 2018-01-11 17:45:31 -02:00
Ronny Pfannschmidt
0181829ba7 Merge pull request #266 from nicoddemus/pytest_runtest_logfinish
Add support for the new pytest_runtest_logfinish hook (pytest 3.4)
2018-01-11 10:47:31 +01:00
Bruno Oliveira
9b767a8dcb Add CHANGELOG entry for #266 2018-01-10 17:55:36 -02:00
Bruno Oliveira
449e6c2e00 Add support for the new pytest_runtest_logfinish hook (pytest 3.4) 2018-01-10 17:52:27 -02:00
Bruno Oliveira
4dc86a1dad Merge pull request #265 from nicoddemus/overview-readme
Add reference to OVERVIEW to README
2018-01-05 22:07:34 -02:00
Bruno Oliveira
c4c4dab53f Add reference to OVERVIEW to README 2018-01-05 13:58:19 -02:00
Bruno Oliveira
17978f3bea Merge pull request #263 from nicoddemus/release-1.21.0
Prepare release 1.21.0
2017-12-26 11:00:29 -02:00
Bruno Oliveira
9b2163f028 Update CHANGELOG with towncrier 2017-12-22 17:34:12 -02:00
Bruno Oliveira
e72eadb413 Fix linting 2017-12-22 17:30:47 -02:00
Bruno Oliveira
6cd1eb2f43 Use more modern python and reword part about pytest ini configuration 2017-12-22 16:53:18 -02:00
Bruno Oliveira
7c3a86a549 Mention pytest-forked instead of the help for --boxed 2017-12-22 16:49:14 -02:00
Bruno Oliveira
b2c63a1ba5 Reworded some sections to be more newbie friendly 2017-12-22 16:42:35 -02:00
Bruno Oliveira
3f545ee621 Change section titles so they are more prominent in the README 2017-12-22 16:29:10 -02:00
Bruno Oliveira
3f09e158be Merge pull request #242 from Corni/loadfilescope
Load-Distribute test cases by filename
2017-12-22 16:27:20 -02:00
Bruno Oliveira
0d19e7f22b Merge remote-tracking branch 'upstream/master' into Corni/loadfilescope 2017-12-22 16:07:51 -02:00
Bruno Oliveira
aedad85e35 Add --dist=loadfile doc to README 2017-12-22 16:07:33 -02:00
Bruno Oliveira
a020c9509d Small adjustment to CHANGELOG 2017-12-22 16:07:26 -02:00
Ronny Pfannschmidt
efce50fe6a Merge pull request #261 from nicoddemus/pytest33
Fix tests in pytest >= 3.3 and add it to build matrix
2017-12-22 18:51:02 +01:00
Bruno Oliveira
db1fb683cf Add pytest 3.3 to tox build matrix 2017-12-22 15:38:07 -02:00
Bruno Oliveira
28d60f94f3 Fix load scope tests in pytest 3.3
Fix #260
2017-12-22 15:35:24 -02:00
Bruno Oliveira
ed9f25a0d2 Merge pull request #259 from hugovk/rm-eol
Drop support for EOL Python 2.6
2017-12-22 15:24:07 -02:00
Hugo
cb8b161d36 Add towncrier changelog entry 2017-12-21 11:31:38 +02:00
Hugo
cec33cca8a Add Python versions badge and alts to other badges 2017-12-21 11:26:59 +02:00
Hugo
c6f2fdcc31 Remove redundant parentheses 2017-12-21 11:19:58 +02:00
Hugo
8b79d909ea Rewrite unnecessary list literals as set literals 2017-12-21 11:04:19 +02:00
Hugo
2b0dc3f83a Remove redundant Python 3.2 code 2017-12-21 10:59:52 +02:00
Hugo
ed2db3d03a Drop support for EOL Python 2.6 2017-12-21 10:55:57 +02:00
Hugo
d3229af3da Ignore IDE metadata 2017-12-21 10:43:24 +02:00
Cornelius Riemenschneider
fad312fdb7 Add scheduling by test file. 2017-12-14 16:18:46 +01:00
Cornelius Riemenschneider
d4f977f3b7 Add PyCharm files to .gitignore. 2017-12-14 16:08:40 +01:00
Ronny Pfannschmidt
5889e4c229 Merge pull request #248 from timyhou/issue_241
Issue #241 Make copy during serialization of reprtraceback and reprcr…
2017-11-28 14:59:08 +01:00
Bruno Oliveira
239065810e Merge remote-tracking branch 'upstream/master' into timyhou/issue_241 2017-11-22 21:29:32 -02:00
Bruno Oliveira
bf0645ad35 Merge pull request #249 from nicoddemus/flakes
Fix E741 and E722 flake errors
2017-11-22 21:28:52 -02:00
Bruno Oliveira
cf067a86d7 Update pip on AppVeyor
py26-pytest30 is failing due to a setuptools error. Try to update
pip to see if this fixes the issue.
2017-11-22 20:58:06 -02:00
Bruno Oliveira
58f7291a99 Fix E741 and E722 flake errors 2017-11-22 20:00:39 -02:00
thou
2eb1002781 Issue #241 Make copy during serialization of reprtraceback and reprcrash to avoid mutating. 2017-11-21 12:33:07 -06:00
Bruno Oliveira
635d3d02cb Merge pull request #239 from nicoddemus/release-1.20.1
Release 1.20.1
2017-10-05 17:22:48 -03:00
Bruno Oliveira
adaa10f285 Release 1.20.1 2017-10-05 16:55:45 -03:00
Ronny Pfannschmidt
1cd7001647 Merge pull request #233 from blueyed/improve-pdb-usage-error
Improve UsageError when used with --pdb
2017-10-05 13:19:25 +02:00
Bruno Oliveira
95b660e26a Merge pull request #232 from verdesmarald/master
Don't create DSession in collect-only mode
2017-10-05 07:35:36 -03:00
Ronny Pfannschmidt
7a5efcdb76 Merge pull request #238 from timj/u/timj/exit-when-all-dead
Stop looping if all workers have died
2017-10-05 08:03:12 +02:00
Tim Jenness
9e59d07947 Stop looping if all workers have died
If the workers are crashing and the restart limit has been met,
we need to stop listening for events and trigger an internal
error.
2017-10-04 17:59:36 -07:00
Daniel Hahler
3799caa4fc Improve UsageError when used with --pdb
It might not be clear that pytest-xdist is used at all, and this should
help users to make --pdb work.
2017-09-23 21:07:39 +02:00
verdesmarald
1e66af6389 Fix flake8 formatting errors 2017-09-07 16:40:32 +10:00
verdesmarald
7674f6b186 Add tests for interactions between boxed, dist and collect-only.
Re-enable parsing of the boxed option with collect-only
2017-09-07 16:09:06 +10:00
verdesmarald
c83f73e19c Add news file for bugfix 2017-09-04 14:32:19 +10:00
verdesmarald
c874872190 Don't create DSession in collect-only mode 2017-09-04 14:25:42 +10:00
Ronny Pfannschmidt
e4f36b18f3 Merge pull request #228 from nicoddemus/ci-pytest
Add test environments using pytest master and features branches
2017-09-02 18:33:54 +02:00
Bruno Oliveira
0cdef59428 Add test environments using pytest master and features branches 2017-09-01 18:51:49 -03:00
Bruno Oliveira
4bb06e3f74 Merge pull request #227 from EdwardBetts/spelling
correct spelling mistake
2017-09-01 17:22:12 -03:00
Edward Betts
2c9b0b8894 correct spelling mistake 2017-09-01 20:45:18 +01:00
Bruno Oliveira
b464335c83 Fix link in CHANGELOG 2017-08-19 06:11:32 -03:00
Ronny Pfannschmidt
24b478446a Merge pull request #225 from pytest-dev/Ronny-patch-1
fix up travis deploy config
2017-08-18 15:47:25 +02:00
Ronny Pfannschmidt
d4d52dc933 fix up travis deploy config
move distributions key to the right place
install setuptools_scm for deploy
2017-08-18 14:00:44 +02:00
Bruno Oliveira
e5c2347934 Merge pull request #224 from nicoddemus/release-1.20.0
Release 1.20.0
2017-08-18 08:47:10 -03:00
Bruno Oliveira
577418f28c Prepare release 1.20.0 2017-08-17 18:34:03 -03:00
Bruno Oliveira
5c46cdf62d Mention flaky in the changelog for #206 2017-08-17 18:33:50 -03:00
Ronny Pfannschmidt
493ba6cb1d Merge pull request #223 from nicoddemus/travis-stages
Change Travis configuration to use stages in CI
2017-08-17 09:39:16 +02:00
Bruno Oliveira
d9bb158085 Change Travis configuration to use stages in CI
Fix #221
2017-08-16 23:54:38 -03:00
Ronny Pfannschmidt
0175605c57 Merge pull request #219 from nicoddemus/worker-id-docstring
Add docstring for worker_id
2017-08-11 15:49:26 +02:00
Bruno Oliveira
3ed405f22f Add docstring for worker_id
Fix #190
2017-08-10 21:51:30 -03:00
Bruno Oliveira
7b9546b89b Merge pull request #218 from nicoddemus/teardown-crash
Identify correct test crashed during teardown and support multiple test logs from plugins
2017-08-10 21:33:08 -03:00
Bruno Oliveira
542111d272 Merge pull request #217 from nicoddemus/release-1.19.1
Prepare release 1.19.1
2017-08-10 12:50:53 -03:00
Bruno Oliveira
2adf810e5e Add acceptance test for plugins which log tests multiple times
Fix #206
2017-08-10 11:18:52 -03:00
Bruno Oliveira
f8e138b986 Fix tests incorrectly identified if worker crashes during teardown stage
Fix #124
2017-08-10 10:43:40 -03:00
27 changed files with 865 additions and 456 deletions

2
.gitignore vendored
View File

@@ -22,6 +22,7 @@ dist/
include/
lib/
bin/
env/
xdist/_version.py*
pytest_xdist.egg-info
issue/
@@ -30,3 +31,4 @@ pytestdebug.log
.tox/
.cache/
.eggs/
.idea/

View File

@@ -1,7 +1,17 @@
sudo: false
language: python
notifications:
irc:
channels:
- 'chat.freenode.net#pytest'
on_success: change
on_failure: change
skip_join: true
email:
- pytest-commit@python.org
python:
- '2.6'
- '2.7'
- '3.4'
- '3.5'
@@ -10,32 +20,40 @@ env:
- TOXENV=py-pytest30
- TOXENV=py-pytest31
- TOXENV=py-pytest32
install: pip install tox setuptools_scm
matrix:
include:
# note: please use "tox --listenvs" to populate the build matrix
- python: "3.6"
env: TOXENV=flakes
- python: "3.6"
env: TOXENV=readme
- TOXENV=py-pytest33
install: pip install tox setuptools_scm
script: tox
notifications:
irc:
channels:
- chat.freenode.net#pytest
on_success: change
on_failure: change
skip_join: true
email:
- pytest-commit@python.org
deploy:
provider: pypi
user: ronny
skip_upload_docs: true
password:
secure: cxmSDho5d+PYKEM4ZCg8ms1P4lzhYkrw6fEOm2HtTcsuCyY6aZMSgImWAnEYbJHSkdzgcxlXK9UKJ9B0YenXmBCkAr7UjdnpNXNmkySr0sYzlH/sfqt/dDATCHFaRKxnkOSOVywaDYhT9n8YudbXI77pXwD12i/CeSSJDbHhsu0JYUfAcb+D6YjRYoA2SEGCnzSzg+gDDfwXZx4ZiODCGLVwieNp1klCg88YROUE1BaYYNuUOONvfXX8+TWowbCF6ChH1WL/bZ49OStEYQNuYxZQZr4yClIqu9VJbchrU8j860K9ott2kkGTgfB/dDrQB/XncBubyIX9ikzCQAmmBXWAI3eyvWLPDk2Jz7kW2l2RT7syct80tCq3JhvQ1qdwr5ap7siocTLgnBW0tF4tkHSTFN3510fkc43npnp6FThebESQpnI24vqpwJ9hI/kW5mYi014Og2E/cpCXnz2XO8iZPDbqAMQpDsqEQoyhfGNgPTGp4K30TxRtwZBI5hHhDKnnR16fXtRgt1gYPvz/peUQvvpOm4JzIzGXPzluuutpnCBy75v5+oiwT3YRrLL/Meims9FtDDXL3qQubAE/ezIOOpm0N5XXV8DxIom8EN71yq5ab1tqhM+tBX7owRjy4FR4If2Q8feBdmTuh26DIQt/y+qSG8VkB9Sw/JCjc7c=
on:
tags: true
distributions: sdist bdist_wheel
repo: pytest-dev/pytest-xdist
jobs:
include:
- stage: test
# python x env above are already included into this stage
- python: "2.7"
env: TOXENV=py27-pytestmaster
- python: "2.7"
env: TOXENV=py27-pytestfeatures
- python: "3.6"
env: TOXENV=py36-pytestmaster
- python: "3.6"
env: TOXENV=py36-pytestfeatures
- python: "3.6"
env: TOXENV=flakes
- python: "3.6"
env: TOXENV=readme
- stage: deploy
python: '3.6'
env:
install: pip install -U setuptools setuptools_scm
script: skip
deploy:
provider: pypi
user: ronny
distributions: sdist bdist_wheel
skip_upload_docs: true
password:
secure: cxmSDho5d+PYKEM4ZCg8ms1P4lzhYkrw6fEOm2HtTcsuCyY6aZMSgImWAnEYbJHSkdzgcxlXK9UKJ9B0YenXmBCkAr7UjdnpNXNmkySr0sYzlH/sfqt/dDATCHFaRKxnkOSOVywaDYhT9n8YudbXI77pXwD12i/CeSSJDbHhsu0JYUfAcb+D6YjRYoA2SEGCnzSzg+gDDfwXZx4ZiODCGLVwieNp1klCg88YROUE1BaYYNuUOONvfXX8+TWowbCF6ChH1WL/bZ49OStEYQNuYxZQZr4yClIqu9VJbchrU8j860K9ott2kkGTgfB/dDrQB/XncBubyIX9ikzCQAmmBXWAI3eyvWLPDk2Jz7kW2l2RT7syct80tCq3JhvQ1qdwr5ap7siocTLgnBW0tF4tkHSTFN3510fkc43npnp6FThebESQpnI24vqpwJ9hI/kW5mYi014Og2E/cpCXnz2XO8iZPDbqAMQpDsqEQoyhfGNgPTGp4K30TxRtwZBI5hHhDKnnR16fXtRgt1gYPvz/peUQvvpOm4JzIzGXPzluuutpnCBy75v5+oiwT3YRrLL/Meims9FtDDXL3qQubAE/ezIOOpm0N5XXV8DxIom8EN71yq5ab1tqhM+tBX7owRjy4FR4If2Q8feBdmTuh26DIQt/y+qSG8VkB9Sw/JCjc7c=
on:
tags: true
repo: pytest-dev/pytest-xdist

View File

@@ -1,3 +1,94 @@
pytest-xdist 1.22.1 (2018-02-19)
================================
Bug Fixes
---------
- Fix issue when using ``loadscope`` or ``loadfile`` where tests would fail to
start if the first scope had only one test. (`#257
<https://github.com/pytest-dev/pytest-xdist/issues/257>`_)
Trivial Changes
---------------
- Change terminology used by ``pytest-xdist`` to *master* and *worker* in
arguments and messages (for example ``--max-worker-reset``). (`#234
<https://github.com/pytest-dev/pytest-xdist/issues/234>`_)
pytest-xdist 1.22.0 (2018-01-11)
================================
Features
--------
- Add support for the ``pytest_runtest_logfinish`` hook which will be released
in pytest 3.4. (`#266
<https://github.com/pytest-dev/pytest-xdist/issues/266>`_)
pytest-xdist 1.21.0 (2017-12-22)
================================
Deprecations and Removals
-------------------------
- Drop support for EOL Python 2.6. (`#259
<https://github.com/pytest-dev/pytest-xdist/issues/259>`_)
Features
--------
- New ``--dist=loadfile`` option which load-distributes test to workers grouped
by the file the tests live in. (`#242
<https://github.com/pytest-dev/pytest-xdist/issues/242>`_)
Bug Fixes
---------
- Fix accidental mutation of test report during serialization causing longrepr
string-ification to break. (`#241
<https://github.com/pytest-dev/pytest-xdist/issues/241>`_)
pytest-xdist 1.20.1 (2017-10-05)
================================
Bug Fixes
---------
- Fix hang when all worker nodes crash and restart limit is reached (`#45
<https://github.com/pytest-dev/pytest-xdist/issues/45>`_)
- Fix issue where the -n option would still run distributed tests when pytest
was run with the --collect-only option (`#5
<https://github.com/pytest-dev/pytest-xdist/issues/5>`_)
pytest-xdist 1.20.0 (2017-08-17)
================================
Features
--------
- ``xdist`` now supports tests to log results multiple times, improving
integration with plugins which require it like `pytest-rerunfailures
<https://github.com/gocept/pytest-rerunfailures>`_ and `flaky
<https://pypi.python.org/pypi/flaky>`_. (`#206 <https://github.com/pytest-
dev/pytest-xdist/issues/206>`_)
Bug Fixes
---------
- Fix issue where tests were being incorrectly identified if a worker crashed
during the ``teardown`` stage of the test. (`#124 <https://github.com/pytest-
dev/pytest-xdist/issues/124>`_)
pytest-xdist 1.19.1 (2017-08-10)
================================
@@ -229,7 +320,7 @@ Improved Documentation
in master. Thanks Aron Curzon.
- fix pytest issue419 by sending/receiving indices into the test
collection instead of node ids (which are not neccessarily unique
collection instead of node ids (which are not necessarily unique
for functions parametrized with duplicate values)
- send multiple "to test" indices in one network message to a slave

View File

@@ -26,13 +26,11 @@ To publish a new release ``X.Y.Z``, the steps are as follows:
#. Install ``pytest-xdist`` and dev requirements in a virtualenv::
$ pip install -e . -r dev-requirements.txt
$ pip install -e . -U -r dev-requirements.txt
#. Update ``CHANGELOG.rst`` file by running::
$ towncrier --version X.Y.Z
It might ask for confirmation to remove news fragments; answer yes.
$ towncrier --version X.Y.Z --yes
#. Commit and push the branch for review.

View File

@@ -1,19 +1,27 @@
.. image:: http://img.shields.io/pypi/v/pytest-xdist.svg
:alt: PyPI version
:target: https://pypi.python.org/pypi/pytest-xdist
.. image:: https://img.shields.io/pypi/pyversions/pytest-xdist.svg
:alt: Python versions
:target: https://pypi.python.org/pypi/pytest-xdist
.. image:: https://anaconda.org/conda-forge/pytest-xdist/badges/version.svg
:alt: Anaconda version
:target: https://anaconda.org/conda-forge/pytest-xdist
.. image:: https://travis-ci.org/pytest-dev/pytest-xdist.svg?branch=master
:alt: Travis CI build status
:target: https://travis-ci.org/pytest-dev/pytest-xdist
.. image:: https://ci.appveyor.com/api/projects/status/56eq1a1avd4sdd7e/branch/master?svg=true
:alt: AppVeyor build status
:target: https://ci.appveyor.com/project/pytestbot/pytest-xdist
xdist: pytest distributed testing plugin
=========================================
========================================
The `pytest-xdist`_ plugin extends py.test with some unique
test execution modes:
@@ -36,9 +44,12 @@ program source code to the remote place. All test results
are reported back and displayed to your local terminal.
You may specify different Python versions and interpreters.
If you would like to know how pytest-xdist works under the covers, checkout
`OVERVIEW <https://github.com/pytest-dev/pytest-xdist/blob/master/OVERVIEW.md>`_.
Installation
-----------------------
------------
Install the plugin with::
@@ -47,43 +58,54 @@ Install the plugin with::
or use the package in develop/in-place mode with
a checkout of the `pytest-xdist repository`_ ::
python setup.py develop
Usage examples
---------------------
pip install --editable .
.. _parallelization:
Speed up test runs by sending tests to multiple CPUs
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
----------------------------------------------------
To send tests to multiple CPUs, type::
py.test -n NUM
Especially for longer running tests or tests requiring
a lot of IO this can lead to considerable speed ups. This option can
a lot of I/O this can lead to considerable speed ups. This option can
also be set to ``auto`` for automatic detection of the number of CPUs.
If a test crashes the interpreter, pytest-xdist will automatically restart
that slave and report the failure as usual. You can use the
``--max-slave-restart`` option to limit the number of slaves that can
be restarted, or disable restarting altogether using ``--max-slave-restart=0``.
that worker and report the failure as usual. You can use the
``--max-worker-restart`` option to limit the number of workers that can
be restarted, or disable restarting altogether using ``--max-worker-restart=0``.
By default, the ``-n`` option will send pending tests to any worker that is available, without
any guaranteed order, but you can control this with these options:
* ``--dist=loadscope``: tests will be grouped by **module** for *test functions* and
by **class** for *test methods*, then each group will be sent to an available worker,
guaranteeing that all tests in a group run in the same process. This can be useful if you have
expensive module-level or class-level fixtures. Currently the groupings can't be customized,
with grouping by class takes priority over grouping by module.
This feature was added in version ``1.19``.
* ``--dist=loadfile``: tests will be grouped by file name, and then will be sent to an available
worker, guaranteeing that all tests in a group run in the same worker. This feature was added
in version ``1.21``.
Running tests in a Python subprocess
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
------------------------------------
To instantiate a python2.5 sub process and send tests to it, you may type::
To instantiate a python3.5 subprocess and send tests to it, you may type::
py.test -d --tx popen//python=python2.5
py.test -d --tx popen//python=python3.5
This will start a subprocess which is run with the "python2.5"
This will start a subprocess which is run with the ``python3.5``
Python interpreter, found in your system binary lookup path.
If you prefix the --tx option value like this::
--tx 3*popen//python=python2.5
--tx 3*popen//python=python3.5
then three subprocesses would be created and tests
will be load-balanced across these three processes.
@@ -91,28 +113,16 @@ will be load-balanced across these three processes.
.. _boxed:
Running tests in a boxed subprocess
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
If you have tests involving C or C++ libraries you might have to deal
with tests crashing the process. For this case you may use the boxing
options::
py.test --boxed
which will run each test in a subprocess and will report if a test
crashed the process. You can also combine this option with
running multiple processes to speed up the test run and use your CPU cores::
py.test -n3 --boxed
this would run 3 testing subprocesses in parallel which each
create new boxed subprocesses for each test.
-----------------------------------
This functionality has been moved to the
`pytest-forked <https://github.com/pytest-dev/pytest-forked>`_ plugin, but the ``--boxed`` option
is still kept for backward compatibility.
.. _`remote machines`:
Sending tests to remote SSH accounts
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
------------------------------------
Suppose you have a package ``mypkg`` which contains some
tests that you can successfully run locally. And you
@@ -147,7 +157,7 @@ ini-file option(s).
Sending tests to remote Socket Servers
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
--------------------------------------
Download the single-module `socketserver.py`_ Python program
and run it like this::
@@ -166,7 +176,7 @@ new socket host with something like this::
Running tests on many platforms at once
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
---------------------------------------
The basic command to run tests on multiple platforms is::
@@ -175,7 +185,7 @@ The basic command to run tests on multiple platforms is::
If you specify a windows host, an OSX host and a Linux
environment this command will send each tests to all
platforms - and report back failures from all platforms
at once. The specifications strings use the `xspec syntax`_.
at once. The specifications strings use the `xspec syntax`_.
.. _`xspec syntax`: http://codespeak.net/execnet/basics.html#xspec
@@ -184,7 +194,7 @@ at once. The specifications strings use the `xspec syntax`_.
.. _`execnet`: http://codespeak.net/execnet
Identifying the worker process during a test
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
--------------------------------------------
*New in version 1.15.*
@@ -208,16 +218,15 @@ defined:
* ``PYTEST_XDIST_WORKER_COUNT``: the total number of workers in this session,
e.g., ``"4"`` when ``-n 4`` is given in the command-line.
The information about the worker_id in a test is stored in the TestReport as
well, under worker_id attribute.
The information about the worker_id in a test is stored in the ``TestReport`` as
well, under the ``worker_id`` attribute.
Specifying test exec environments in an ini file
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
------------------------------------------------
pytest (since version 2.0) supports ini-style cofiguration.
You can for example make running with three subprocesses
your default like this:
You can use pytest's ini file configuration to avoid typing common options.
You can for example make running with three subprocesses your default like this:
.. code-block:: ini
@@ -229,7 +238,7 @@ You can also add default environments like this:
.. code-block:: ini
[pytest]
addopts = --tx ssh=myhost//python=python2.5 --tx ssh=myhost//python=python2.6
addopts = --tx ssh=myhost//python=python3.5 --tx ssh=myhost//python=python3.6
and then just type::
@@ -238,84 +247,8 @@ and then just type::
to run tests in each of the environments.
Sending groups of related tests to the same worker
++++++++++++++++++++++++++++++++++++++++++++++++++
*New in version 1.19.*
.. note::
This is an **experimental** feature: the actual functionality will
likely stay the same, but the CLI might change slightly in future versions.
You can send groups of related tests to the same worker by using the
``--dist=loadscope`` option. Tests will be grouped by **module**
for *test functions* and by **class** for *test methods*.
For example, consider this two test files:
.. code-block:: python
# content of test_container.py
import pytest
def test_container_startup():
pass
def test_container_logging():
pass
@pytest.mark.parametrize('methods', ['ssh', 'http'])
def test_container_communication(methods):
pass
# content of test_io.py
class TestHDF:
def test_listing(self):
pass
def test_search(self):
pass
class TestXML:
def test_listing(self):
pass
def test_search(self):
pass
By executing ``pytest -v --dist=loadscope -n4`` you might get this output
(sorted by worker for readability)::
============================= test session starts =============================
<skip header>
gw0 [8] / gw1 [8] / gw2 [8] / gw3 [8]
scheduling tests via LoadScopeScheduling
[gw0] PASSED test_container.py::test_container_communication[http]
[gw0] PASSED test_container.py::test_container_communication[ssh]
[gw0] PASSED test_container.py::test_container_logging
[gw0] PASSED test_container.py::test_container_startup
[gw1] PASSED test_io.py::TestHDF::test_listing
[gw1] PASSED test_io.py::TestHDF::test_search
[gw2] PASSED test_io.py::TestXML::test_listing
[gw2] PASSED test_io.py::TestXML::test_search
========================== 8 passed in 0.56 seconds ===========================
As you can see, all test functions from ``test_container.py`` executed on
the same worker ``gw0``, while the test methods from classes ``TestHDF`` and
``TestXML`` executed in workers ``gw1`` and ``gw2`` respectively.
Currently the groupings can't be customized, with grouping by class takes
priority over grouping by module.
Specifying "rsync" dirs in an ini-file
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
--------------------------------------
In a ``tox.ini`` or ``setup.cfg`` file in your root project directory
you may specify directories to include or to exclude in synchronisation:

View File

@@ -1,18 +1,17 @@
environment:
matrix:
# note: please use "tox --listenvs" to populate the build matrix
- TOXENV: "py26-pytest30"
- TOXENV: "py27-pytest30"
- TOXENV: "py34-pytest30"
- TOXENV: "py35-pytest30"
- TOXENV: "py36-pytest30"
- TOXENV: "py27-pytest30-pexpect"
- TOXENV: "py35-pytest30-pexpect"
- TOXENV: "py27-pytest33"
- TOXENV: "py34-pytest33"
- TOXENV: "py35-pytest33"
- TOXENV: "py36-pytest33"
- TOXENV: "py27-pytest33-pexpect"
- TOXENV: "py36-pytest33-pexpect"
- TOXENV: "flakes"
- TOXENV: "readme"
install:
- C:\Python35\python -m pip install tox setuptools_scm
- C:\Python35\python -m pip install -U tox setuptools_scm pip
build: false # Not a C# project, build stuff at the test step instead.

View File

@@ -33,4 +33,4 @@ template = "changelog/_template.rst"
[[tool.towncrier.type]]
directory = "trivial"
name = "Trivial Changes"
showcontent = false
showcontent = true

View File

@@ -1,12 +1,7 @@
from sys import version_info
from setuptools import setup, find_packages
install_requires = ['execnet>=1.1', 'pytest>=3.0.0', 'pytest-forked']
if version_info < (2, 7):
install_requires.append('ordereddict')
setup(
name="pytest-xdist",
@@ -27,6 +22,7 @@ setup(
],
},
zip_safe=False,
python_requires='>=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*',
install_requires=install_requires,
setup_requires=['setuptools_scm'],
classifiers=[
@@ -41,6 +37,11 @@ setup(
'Topic :: Software Development :: Quality Assurance',
'Topic :: Utilities',
'Programming Language :: Python',
'Programming Language :: Python :: 2',
'Programming Language :: Python :: 2.7',
'Programming Language :: Python :: 3',
'Programming Language :: Python :: 3.4',
'Programming Language :: Python :: 3.5',
'Programming Language :: Python :: 3.6',
],
)

View File

@@ -192,27 +192,41 @@ class TestDistribution:
])
assert dest.join(subdir.basename).check(dir=1)
def test_backward_compatibility_worker_terminology(self, testdir):
"""Ensure that we still support "config.slaveinput" for backward compatibility (#234).
Keep in mind that removing this compatibility will break a ton of plugins and user code.
"""
testdir.makepyfile("""
def test(pytestconfig):
assert hasattr(pytestconfig, 'slaveinput')
assert hasattr(pytestconfig, 'workerinput')
""")
result = testdir.runpytest("-n1")
result.stdout.fnmatch_lines("*1 passed*")
assert result.ret == 0
def test_data_exchange(self, testdir):
testdir.makeconftest("""
# This hook only called on master.
def pytest_configure_node(node):
node.slaveinput['a'] = 42
node.slaveinput['b'] = 7
node.workerinput['a'] = 42
node.workerinput['b'] = 7
def pytest_configure(config):
# this attribute is only set on slaves
if hasattr(config, 'slaveinput'):
a = config.slaveinput['a']
b = config.slaveinput['b']
# this attribute is only set on workers
if hasattr(config, 'workerinput'):
a = config.workerinput['a']
b = config.workerinput['b']
r = a + b
config.slaveoutput['r'] = r
config.workeroutput['r'] = r
# This hook only called on master.
def pytest_testnodedown(node, error):
node.config.calc_result = node.slaveoutput['r']
node.config.calc_result = node.workeroutput['r']
def pytest_terminal_summary(terminalreporter):
if not hasattr(terminalreporter.config, 'slaveinput'):
if not hasattr(terminalreporter.config, 'workerinput'):
calc_result = terminalreporter.config.calc_result
terminalreporter._tw.sep('-',
'calculated result is %s' % calc_result)
@@ -232,12 +246,12 @@ class TestDistribution:
""")
testdir.makeconftest("""
def pytest_sessionfinish(session):
# on the slave
if hasattr(session.config, 'slaveoutput'):
session.config.slaveoutput['s2'] = 42
# on the worker
if hasattr(session.config, 'workeroutput'):
session.config.workeroutput['s2'] = 42
# on the master
def pytest_testnodedown(node, error):
assert node.slaveoutput['s2'] == 42
assert node.workeroutput['s2'] == 42
print ("s2call-finished")
""")
args = ["-n1", "--debug"]
@@ -262,6 +276,17 @@ class TestDistribution:
child.close()
# assert ret == 2
def test_dist_with_collectonly(self, testdir):
p1 = testdir.makepyfile("""
def test_ok():
pass
""")
result = testdir.runpytest(p1, "-n1", "--collect-only")
assert result.ret == 0
result.stdout.fnmatch_lines([
"*collected 1 item*",
])
class TestDistEach:
def test_simple(self, testdir):
@@ -364,6 +389,25 @@ class TestTerminalReporting:
"*1 passed, 1 warnings*",
])
def test_logfinish_hook(self, testdir):
"""Ensure the pytest_runtest_logfinish hook is being properly handled"""
from _pytest import hookspec
if not hasattr(hookspec, 'pytest_runtest_logfinish'):
pytest.skip('test requires pytest_runtest_logfinish hook in pytest (3.4+)')
testdir.makeconftest("""
def pytest_runtest_logfinish():
print('pytest_runtest_logfinish hook called')
""")
testdir.makepyfile("""
def test_func():
pass
""")
result = testdir.runpytest("-n1", "-s")
result.stdout.fnmatch_lines([
"*pytest_runtest_logfinish hook called*",
])
def test_teardownfails_one_function(testdir):
p = testdir.makepyfile("""
@@ -381,7 +425,7 @@ def test_teardownfails_one_function(testdir):
def test_terminate_on_hangingnode(testdir):
p = testdir.makeconftest("""
def pytest_sessionfinish(session):
if session.nodeid == "my": # running on slave
if session.nodeid == "my": # running on worker
import time
time.sleep(3)
""")
@@ -399,15 +443,15 @@ def test_session_hooks(testdir):
def pytest_sessionstart(session):
sys.pytestsessionhooks = session
def pytest_sessionfinish(session):
if hasattr(session.config, 'slaveinput'):
name = "slave"
if hasattr(session.config, 'workerinput'):
name = "worker"
else:
name = "master"
f = open(name, "w")
f.write("xy")
f.close()
# let's fail on the slave
if name == "slave":
# let's fail on the worker
if name == "worker":
raise ValueError(42)
""")
p = testdir.makepyfile("""
@@ -423,14 +467,14 @@ def test_session_hooks(testdir):
assert not result.ret
d = result.parseoutcomes()
assert d['passed'] == 1
assert testdir.tmpdir.join("slave").check()
assert testdir.tmpdir.join("worker").check()
assert testdir.tmpdir.join("master").check()
def test_session_testscollected(testdir):
"""
Make sure master node is updating the session object with the number
of tests collected from the slaves.
of tests collected from the workers.
"""
testdir.makepyfile(test_foo="""
import pytest
@@ -471,18 +515,60 @@ def test_funcarg_teardown_failure(testdir):
assert result.ret
def test_crashing_item(testdir):
@pytest.mark.parametrize('when', ['setup', 'call', 'teardown'])
def test_crashing_item(testdir, when):
"""Ensure crashing item is correctly reported during all testing stages"""
code = dict(setup='', call='', teardown='')
code[when] = 'py.process.kill(os.getpid())'
p = testdir.makepyfile("""
import py
import os
def test_crash():
py.process.kill(os.getpid())
def test_noncrash():
import py
import pytest
@pytest.fixture
def fix():
{setup}
yield
{teardown}
def test_crash(fix):
{call}
pass
""")
def test_ok():
pass
""".format(**code))
passes = 2 if when == 'teardown' else 1
result = testdir.runpytest("-n2", p)
result.stdout.fnmatch_lines([
"*crashed*test_crash*", "*1 failed*1 passed*"
"*crashed*test_crash*",
"*1 failed*%d passed*" % passes,
])
def test_multiple_log_reports(testdir):
"""
Ensure that pytest-xdist supports plugins that emit multiple logreports
(#206).
Inspired by pytest-rerunfailures.
"""
testdir.makeconftest("""
from _pytest.runner import runtestprotocol
def pytest_runtest_protocol(item, nextitem):
item.ihook.pytest_runtest_logstart(nodeid=item.nodeid,
location=item.location)
reports = runtestprotocol(item, nextitem=nextitem)
for report in reports:
item.ihook.pytest_runtest_logreport(report=report)
return True
""")
testdir.makepyfile("""
def test():
pass
""")
result = testdir.runpytest("-n1")
result.stdout.fnmatch_lines([
"*2 passed*",
])
@@ -595,8 +681,8 @@ class TestNodeFailure:
""")
res = testdir.runpytest(f, '-n1')
res.stdout.fnmatch_lines([
"*Replacing crashed slave*",
"*Slave*crashed while running*",
"*Replacing crashed worker*",
"*Worker*crashed while running*",
"*1 failed*1 passed*",
])
@@ -610,8 +696,8 @@ class TestNodeFailure:
""")
res = testdir.runpytest(f, '-n2')
res.stdout.fnmatch_lines([
"*Replacing crashed slave*",
"*Slave*crashed while running*",
"*Replacing crashed worker*",
"*Worker*crashed while running*",
"*1 failed*3 passed*",
])
@@ -623,8 +709,8 @@ class TestNodeFailure:
""")
res = testdir.runpytest(f, '--dist=each', '--tx=popen')
res.stdout.fnmatch_lines([
"*Replacing crashed slave*",
"*Slave*crashed while running*",
"*Replacing crashed worker*",
"*Worker*crashed while running*",
"*1 failed*1 passed*",
])
@@ -637,12 +723,12 @@ class TestNodeFailure:
""")
res = testdir.runpytest(f, '--dist=each', '--tx=2*popen')
res.stdout.fnmatch_lines([
"*Replacing crashed slave*",
"*Slave*crashed while running*",
"*Replacing crashed worker*",
"*Worker*crashed while running*",
"*2 failed*2 passed*",
])
def test_max_slave_restart(self, testdir):
def test_max_worker_restart(self, testdir):
f = testdir.makepyfile("""
import os
def test_a(): pass
@@ -650,15 +736,26 @@ class TestNodeFailure:
def test_c(): os._exit(1)
def test_d(): pass
""")
res = testdir.runpytest(f, '-n4', '--max-slave-restart=1')
res = testdir.runpytest(f, '-n4', '--max-worker-restart=1')
res.stdout.fnmatch_lines([
"*Replacing crashed slave*",
"*Maximum crashed slaves reached: 1*",
"*Slave*crashed while running*",
"*Slave*crashed while running*",
"*Replacing crashed worker*",
"*Maximum crashed workers reached: 1*",
"*Worker*crashed while running*",
"*Worker*crashed while running*",
"*2 failed*2 passed*",
])
def test_max_worker_restart_die(self, testdir):
f = testdir.makepyfile("""
import os
os._exit(1)
""")
res = testdir.runpytest(f, '-n4', '--max-worker-restart=0')
res.stdout.fnmatch_lines([
"*Unexpectedly no active workers*",
"*INTERNALERROR*"
])
def test_disable_restart(self, testdir):
f = testdir.makepyfile("""
import os
@@ -666,10 +763,10 @@ class TestNodeFailure:
def test_b(): os._exit(1)
def test_c(): pass
""")
res = testdir.runpytest(f, '-n4', '--max-slave-restart=0')
res = testdir.runpytest(f, '-n4', '--max-worker-restart=0')
res.stdout.fnmatch_lines([
"*Slave restarting disabled*",
"*Slave*crashed while running*",
"*Worker restarting disabled*",
"*Worker*crashed while running*",
"*1 failed*2 passed*",
])
@@ -691,9 +788,9 @@ def test_worker_id_fixture(testdir, n):
with open(fname) as f:
worker_ids.add(f.read().strip())
if n == 0:
assert worker_ids == set(['master'])
assert worker_ids == {'master'}
else:
assert worker_ids == set(['gw0', 'gw1'])
assert worker_ids == {'gw0', 'gw1'}
@pytest.mark.parametrize('tb',
@@ -791,12 +888,139 @@ class TestLoadScope:
assert get_workers_and_test_count_by_prefix(
'test_a.py::TestB', result.outlines) in ({'gw0': 10}, {'gw1': 10})
def test_module_single_start(self, testdir):
"""Fix test suite never finishing in case all workers start with a single test (#277)."""
test_file1 = """
import pytest
def test():
pass
"""
test_file2 = """
import pytest
def test_1():
pass
def test_2():
pass
"""
testdir.makepyfile(
test_a=test_file1,
test_b=test_file1,
test_c=test_file2
)
result = testdir.runpytest('-n2', '--dist=loadscope', '-v')
a = get_workers_and_test_count_by_prefix('test_a.py::test',
result.outlines)
b = get_workers_and_test_count_by_prefix('test_b.py::test',
result.outlines)
c1 = get_workers_and_test_count_by_prefix('test_c.py::test_1',
result.outlines)
c2 = get_workers_and_test_count_by_prefix('test_c.py::test_2',
result.outlines)
assert a in ({'gw0': 1}, {'gw1': 1})
assert b in ({'gw0': 1}, {'gw1': 1})
assert a.items() != b.items()
assert c1 == c2
class TestFileScope:
def test_by_module(self, testdir):
test_file = """
import pytest
class TestA:
@pytest.mark.parametrize('i', range(10))
def test(self, i):
pass
class TestB:
@pytest.mark.parametrize('i', range(10))
def test(self, i):
pass
"""
testdir.makepyfile(
test_a=test_file,
test_b=test_file,
)
result = testdir.runpytest('-n2', '--dist=loadfile', '-v')
test_a_workers_and_test_count = get_workers_and_test_count_by_prefix(
'test_a.py::TestA', result.outlines)
test_b_workers_and_test_count = get_workers_and_test_count_by_prefix(
'test_b.py::TestB', result.outlines)
assert test_a_workers_and_test_count in ({'gw0': 10}, {'gw1': 0}) or \
test_a_workers_and_test_count in ({'gw0': 0}, {'gw1': 10})
assert test_b_workers_and_test_count in ({'gw0': 10}, {'gw1': 0}) or \
test_b_workers_and_test_count in ({'gw0': 0}, {'gw1': 10})
def test_by_class(self, testdir):
testdir.makepyfile(test_a="""
import pytest
class TestA:
@pytest.mark.parametrize('i', range(10))
def test(self, i):
pass
class TestB:
@pytest.mark.parametrize('i', range(10))
def test(self, i):
pass
""")
result = testdir.runpytest('-n2', '--dist=loadfile', '-v')
test_a_workers_and_test_count = get_workers_and_test_count_by_prefix(
'test_a.py::TestA', result.outlines)
test_b_workers_and_test_count = get_workers_and_test_count_by_prefix(
'test_a.py::TestB', result.outlines)
assert test_a_workers_and_test_count in ({'gw0': 10}, {'gw1': 0}) or \
test_a_workers_and_test_count in ({'gw0': 0}, {'gw1': 10})
assert test_b_workers_and_test_count in ({'gw0': 10}, {'gw1': 0}) or \
test_b_workers_and_test_count in ({'gw0': 0}, {'gw1': 10})
def test_module_single_start(self, testdir):
"""Fix test suite never finishing in case all workers start with a single test (#277)."""
test_file1 = """
import pytest
def test():
pass
"""
test_file2 = """
import pytest
def test_1():
pass
def test_2():
pass
"""
testdir.makepyfile(
test_a=test_file1,
test_b=test_file1,
test_c=test_file2
)
result = testdir.runpytest('-n2', '--dist=loadfile', '-v')
a = get_workers_and_test_count_by_prefix('test_a.py::test',
result.outlines)
b = get_workers_and_test_count_by_prefix('test_b.py::test',
result.outlines)
c1 = get_workers_and_test_count_by_prefix('test_c.py::test_1',
result.outlines)
c2 = get_workers_and_test_count_by_prefix('test_c.py::test_2',
result.outlines)
assert a in ({'gw0': 1}, {'gw1': 1})
assert b in ({'gw0': 1}, {'gw1': 1})
assert a.items() != b.items()
assert c1 == c2
def parse_tests_and_workers_from_output(lines):
result = []
for line in lines:
# example match: "[gw0] PASSED test_a.py::test[7]"
m = re.match(r'\[(gw\d)\]\s(.*?)\s(.*::.*)', line.strip())
m = re.match(r'''
\[(gw\d)\] # worker
\s*
(?:\[\s*\d+%\])? # progress indicator (pytest >=3.3)
\s(.*?) # status string ("PASSED")
\s(.*::.*) # nodeid
''', line.strip(), re.VERBOSE)
if m:
worker, status, nodeid = m.groups()
result.append((worker, status, nodeid))

View File

@@ -20,13 +20,13 @@ pytest_plugins = "pytester"
@pytest.fixture(autouse=True)
def _divert_atexit(request, monkeypatch):
import atexit
l = []
finalizers = []
def finish():
while l:
l.pop()()
while finalizers:
finalizers.pop()()
monkeypatch.setattr(atexit, "register", l.append)
monkeypatch.setattr(atexit, "register", finalizers.append)
request.addfinalizer(finish)
@@ -34,7 +34,7 @@ def pytest_addoption(parser):
parser.addoption('--gx',
action="append",
dest="gspecs",
help=("add a global test environment, XSpec-syntax. "))
help="add a global test environment, XSpec-syntax. ")
@pytest.fixture

View File

@@ -126,7 +126,7 @@ class TestLoadScheduling:
sched.add_node(MockNode())
sched.add_node(MockNode())
node1, node2 = sched.nodes
col = ["xyz"] * (6)
col = ["xyz"] * 6
sched.add_node_collection(node1, col)
sched.add_node_collection(node2, col)
sched.schedule()
@@ -203,7 +203,7 @@ class TestLoadScheduling:
def test_different_tests_collected(self, testdir):
"""
Test that LoadScheduling is reporting collection errors when
different test ids are collected by slaves.
different test ids are collected by workers.
"""
class CollectHook(object):

View File

@@ -83,10 +83,10 @@ class TestStatRecorder:
tmp = tmpdir
sd = StatRecorder([tmp])
l = [True, False]
monkeypatch.setattr(StatRecorder, 'check', lambda self: l.pop())
ret_values = [True, False]
monkeypatch.setattr(StatRecorder, 'check', lambda self: ret_values.pop())
sd.waitonchange(checkinterval=0.2)
assert not l
assert not ret_values
class TestRemoteControl:

View File

@@ -20,10 +20,10 @@ class TestHooks:
def pytest_runtest_logreport(report):
if hasattr(report, 'node'):
if report.when == "call":
slaveid = report.node.slaveinput['slaveid']
if slaveid != report.worker_id:
workerid = report.node.workerinput['workerid']
if workerid != report.worker_id:
print("HOOK: Worker id mismatch: %s %s"
% (slaveid, report.worker_id))
% (workerid, report.worker_id))
else:
print("HOOK: %s %s"
% (report.nodeid, report.worker_id))
@@ -41,9 +41,9 @@ class TestHooks:
"""
testdir.makeconftest("""
def pytest_xdist_node_collection_finished(node, ids):
slaveid = node.slaveinput['slaveid']
workerid = node.workerinput['workerid']
stripped_ids = [x.split('::')[1] for x in ids]
print("HOOK: %s %s" % (slaveid, ', '.join(stripped_ids)))
print("HOOK: %s %s" % (workerid, ', '.join(stripped_ids)))
""")
res = testdir.runpytest('-n2', '-s')
res.stdout.fnmatch_lines_random([

View File

@@ -1,6 +1,6 @@
import py
import execnet
from xdist.slavemanage import NodeManager
from xdist.workermanage import NodeManager
def test_dist_incompatibility_messages(testdir):
@@ -44,6 +44,36 @@ def test_auto_detect_cpus(testdir, monkeypatch):
assert config.getoption('numprocesses') == 99
def test_boxed_with_collect_only(testdir):
from xdist.plugin import pytest_cmdline_main as check_options
config = testdir.parseconfigure("-n1", "--boxed")
check_options(config)
assert config.option.forked
config = testdir.parseconfigure("-n1", "--collect-only")
check_options(config)
assert not config.option.forked
config = testdir.parseconfigure("-n1", "--boxed", "--collect-only")
check_options(config)
assert config.option.forked
def test_dsession_with_collect_only(testdir):
from xdist.plugin import pytest_cmdline_main as check_options
from xdist.plugin import pytest_configure as configure
config = testdir.parseconfigure("-n1")
check_options(config)
configure(config)
assert config.pluginmanager.hasplugin("dsession")
config = testdir.parseconfigure("-n1", "--collect-only")
check_options(config)
configure(config)
assert not config.pluginmanager.hasplugin("dsession")
class TestDistOptions:
def test_getxspecs(self, testdir):
config = testdir.parseconfigure("--tx=popen", "--tx", "ssh=xyz")

View File

@@ -1,6 +1,6 @@
import py
import pytest
from xdist.slavemanage import SlaveController, unserialize_report
from xdist.workermanage import WorkerController, unserialize_report
from xdist.remote import serialize_report
import execnet
import marshal
@@ -26,7 +26,7 @@ class EventCall:
return "<EventCall %s(**%s)>" % (self.name, self.kwargs)
class SlaveSetup:
class WorkerSetup:
use_callback = False
def __init__(self, request, testdir):
@@ -44,8 +44,8 @@ class SlaveSetup:
class DummyMananger:
specs = [0, 1]
self.slp = SlaveController(DummyMananger, self.gateway, config,
putevent)
self.slp = WorkerController(DummyMananger, self.gateway, config,
putevent)
self.request.addfinalizer(self.slp.ensure_teardown)
self.slp.setup()
@@ -65,8 +65,8 @@ class SlaveSetup:
@pytest.fixture
def slave(request, testdir):
return SlaveSetup(request, testdir)
def worker(request, testdir):
return WorkerSetup(request, testdir)
@pytest.mark.xfail(reason='#59')
@@ -79,6 +79,21 @@ def test_remoteinitconfig(testdir):
class TestReportSerialization:
def test_xdist_longrepr_to_str_issue_241(self, testdir):
testdir.makepyfile("""
import os
def test_a(): assert False
def test_b(): pass
""")
testdir.makeconftest("""
def pytest_runtest_logreport(report):
print(report.longrepr)
""")
res = testdir.runpytest('-n1', '-s')
res.stdout.fnmatch_lines([
'*1 failed, 1 passed *'
])
def test_xdist_report_longrepr_reprcrash_130(self, testdir):
reprec = testdir.inline_runsource("""
import py
@@ -107,8 +122,6 @@ class TestReportSerialization:
assert rep.longrepr.reprtraceback.style \
== a.longrepr.reprtraceback.style
assert rep.longrepr.sections == a.longrepr.sections
assert rep.longrepr.reprtraceback.reprentries \
== a.longrepr.reprtraceback.reprentries
# Missing section attribute PR171
assert added_section in a.longrepr.sections
@@ -127,14 +140,15 @@ class TestReportSerialization:
rep_entries = rep.longrepr.reprtraceback.reprentries
a_entries = a.longrepr.reprtraceback.reprentries
assert rep_entries == a_entries
for i in range(len(a_entries)):
assert isinstance(rep_entries[i], ReprEntry)
assert rep_entries[i].lines == a_entries[i].lines
assert rep_entries[i].localssep == a_entries[i].localssep
assert rep_entries[i].reprfileloc == a_entries[i].reprfileloc
assert rep_entries[i].reprfuncargs == a_entries[i].reprfuncargs
assert rep_entries[i].reprlocals == a_entries[i].reprlocals
assert rep_entries[i].reprfileloc.lineno == a_entries[i].reprfileloc.lineno
assert rep_entries[i].reprfileloc.message == a_entries[i].reprfileloc.message
assert rep_entries[i].reprfileloc.path == a_entries[i].reprfileloc.path
assert rep_entries[i].reprfuncargs.args == a_entries[i].reprfuncargs.args
assert rep_entries[i].reprlocals.lines == a_entries[i].reprlocals.lines
assert rep_entries[i].style == a_entries[i].style
def test_reprentries_serialization_196(self, testdir):
@@ -152,7 +166,6 @@ class TestReportSerialization:
rep_entries = rep.longrepr.reprtraceback.reprentries
a_entries = a.longrepr.reprtraceback.reprentries
assert rep_entries == a_entries
for i in range(len(a_entries)):
assert isinstance(rep_entries[i], ReprEntryNative)
assert rep_entries[i].lines == a_entries[i].lines
@@ -230,107 +243,107 @@ class TestReportSerialization:
assert newrep.longrepr == str(rep.longrepr)
class TestSlaveInteractor:
def test_basic_collect_and_runtests(self, slave):
slave.testdir.makepyfile("""
class TestWorkerInteractor:
def test_basic_collect_and_runtests(self, worker):
worker.testdir.makepyfile("""
def test_func():
pass
""")
slave.setup()
ev = slave.popevent()
assert ev.name == "slaveready"
ev = slave.popevent()
worker.setup()
ev = worker.popevent()
assert ev.name == "workerready"
ev = worker.popevent()
assert ev.name == "collectionstart"
assert not ev.kwargs
ev = slave.popevent("collectionfinish")
assert ev.kwargs['topdir'] == slave.testdir.tmpdir
ev = worker.popevent("collectionfinish")
assert ev.kwargs['topdir'] == worker.testdir.tmpdir
ids = ev.kwargs['ids']
assert len(ids) == 1
slave.sendcommand("runtests", indices=list(range(len(ids))))
slave.sendcommand("shutdown")
ev = slave.popevent("logstart")
worker.sendcommand("runtests", indices=list(range(len(ids))))
worker.sendcommand("shutdown")
ev = worker.popevent("logstart")
assert ev.kwargs["nodeid"].endswith("test_func")
assert len(ev.kwargs["location"]) == 3
ev = slave.popevent("testreport") # setup
ev = slave.popevent("testreport")
ev = worker.popevent("testreport") # setup
ev = worker.popevent("testreport")
assert ev.name == "testreport"
rep = unserialize_report(ev.name, ev.kwargs['data'])
assert rep.nodeid.endswith("::test_func")
assert rep.passed
assert rep.when == "call"
ev = slave.popevent("slavefinished")
assert 'slaveoutput' in ev.kwargs
ev = worker.popevent("workerfinished")
assert 'workeroutput' in ev.kwargs
@pytest.mark.skipif(pytest.__version__ >= '3.0',
reason='skip at module level illegal in pytest 3.0')
def test_remote_collect_skip(self, slave):
slave.testdir.makepyfile("""
def test_remote_collect_skip(self, worker):
worker.testdir.makepyfile("""
import py
py.test.skip("hello")
""")
slave.setup()
ev = slave.popevent("collectionstart")
worker.setup()
ev = worker.popevent("collectionstart")
assert not ev.kwargs
ev = slave.popevent()
ev = worker.popevent()
assert ev.name == "collectreport"
ev = slave.popevent()
ev = worker.popevent()
assert ev.name == "collectreport"
rep = unserialize_report(ev.name, ev.kwargs['data'])
assert rep.skipped
ev = slave.popevent("collectionfinish")
ev = worker.popevent("collectionfinish")
assert not ev.kwargs['ids']
def test_remote_collect_fail(self, slave):
slave.testdir.makepyfile("""aasd qwe""")
slave.setup()
ev = slave.popevent("collectionstart")
def test_remote_collect_fail(self, worker):
worker.testdir.makepyfile("""aasd qwe""")
worker.setup()
ev = worker.popevent("collectionstart")
assert not ev.kwargs
ev = slave.popevent()
ev = worker.popevent()
assert ev.name == "collectreport"
ev = slave.popevent()
ev = worker.popevent()
assert ev.name == "collectreport"
rep = unserialize_report(ev.name, ev.kwargs['data'])
assert rep.failed
ev = slave.popevent("collectionfinish")
ev = worker.popevent("collectionfinish")
assert not ev.kwargs['ids']
def test_runtests_all(self, slave):
slave.testdir.makepyfile("""
def test_runtests_all(self, worker):
worker.testdir.makepyfile("""
def test_func(): pass
def test_func2(): pass
""")
slave.setup()
ev = slave.popevent()
assert ev.name == "slaveready"
ev = slave.popevent()
worker.setup()
ev = worker.popevent()
assert ev.name == "workerready"
ev = worker.popevent()
assert ev.name == "collectionstart"
assert not ev.kwargs
ev = slave.popevent("collectionfinish")
ev = worker.popevent("collectionfinish")
ids = ev.kwargs['ids']
assert len(ids) == 2
slave.sendcommand("runtests_all", )
slave.sendcommand("shutdown", )
worker.sendcommand("runtests_all", )
worker.sendcommand("shutdown", )
for func in "::test_func", "::test_func2":
for i in range(3): # setup/call/teardown
ev = slave.popevent("testreport")
ev = worker.popevent("testreport")
assert ev.name == "testreport"
rep = unserialize_report(ev.name, ev.kwargs['data'])
assert rep.nodeid.endswith(func)
ev = slave.popevent("slavefinished")
assert 'slaveoutput' in ev.kwargs
ev = worker.popevent("workerfinished")
assert 'workeroutput' in ev.kwargs
def test_happy_run_events_converted(self, testdir, slave):
def test_happy_run_events_converted(self, testdir, worker):
py.test.xfail("implement a simple test for event production")
assert not slave.use_callback
slave.testdir.makepyfile("""
assert not worker.use_callback
worker.testdir.makepyfile("""
def test_func():
pass
""")
slave.setup()
hookrec = testdir.getreportrecorder(slave.config)
for data in slave.slp.channel:
slave.slp.process_from_remote(data)
slave.slp.process_from_remote(slave.slp.ENDMARK)
worker.setup()
hookrec = testdir.getreportrecorder(worker.config)
for data in worker.slp.channel:
worker.slp.process_from_remote(data)
worker.slp.process_from_remote(worker.slp.ENDMARK)
py.std.pprint.pprint(hookrec.hookrecorder.calls)
hookrec.hookrecorder.contains([
("pytest_collectstart", "collector.fspath == aaa"),
@@ -341,13 +354,13 @@ class TestSlaveInteractor:
("pytest_collectreport", "report.collector.fspath == bbb"),
])
def test_process_from_remote_error_handling(self, slave, capsys):
slave.use_callback = True
slave.setup()
slave.slp.process_from_remote(('<nonono>', ()))
def test_process_from_remote_error_handling(self, worker, capsys):
worker.use_callback = True
worker.setup()
worker.slp.process_from_remote(('<nonono>', ()))
out, err = capsys.readouterr()
assert 'INTERNALERROR> ValueError: unknown event: <nonono>' in out
ev = slave.popevent()
ev = worker.popevent()
assert ev.name == "errordown"
@@ -358,5 +371,5 @@ def test_remote_env_vars(testdir):
assert os.environ['PYTEST_XDIST_WORKER'] in ('gw0', 'gw1')
assert os.environ['PYTEST_XDIST_WORKER_COUNT'] == '2'
''')
result = testdir.runpytest('-n2', '--max-slave-restart=0')
result = testdir.runpytest('-n2', '--max-worker-restart=0')
assert result.ret == 0

View File

@@ -2,8 +2,8 @@ import py
import pytest
import execnet
from _pytest.pytester import HookRecorder
from xdist import slavemanage, newhooks
from xdist.slavemanage import HostRSync, NodeManager
from xdist import workermanage, newhooks
from xdist.workermanage import HostRSync, NodeManager
pytest_plugins = "pytester"
@@ -32,7 +32,7 @@ def mysetup(tmpdir):
@pytest.fixture
def slavecontroller(monkeypatch):
def workercontroller(monkeypatch):
class MockController(object):
def __init__(self, *args):
pass
@@ -40,7 +40,7 @@ def slavecontroller(monkeypatch):
def setup(self):
pass
monkeypatch.setattr(slavemanage, 'SlaveController', MockController)
monkeypatch.setattr(workermanage, 'WorkerController', MockController)
return MockController
@@ -50,14 +50,14 @@ class TestNodeManagerPopen:
assert gm.specs[0].chdir is None
def test_default_chdir(self, config):
l = ["ssh=noco", "socket=xyz"]
for spec in NodeManager(config, l).specs:
specs = ["ssh=noco", "socket=xyz"]
for spec in NodeManager(config, specs).specs:
assert spec.chdir == "pyexecnetcache"
for spec in NodeManager(config, l, defaultchdir="abc").specs:
for spec in NodeManager(config, specs, defaultchdir="abc").specs:
assert spec.chdir == "abc"
def test_popen_makegateway_events(self, config, hookrecorder,
slavecontroller):
workercontroller):
hm = NodeManager(config, ["popen"] * 2)
hm.setup_nodes(None)
call = hookrecorder.popcall("pytest_xdist_setupnodes")
@@ -72,7 +72,7 @@ class TestNodeManagerPopen:
hm.teardown_nodes()
assert not len(hm.group)
def test_popens_rsync(self, config, mysetup, slavecontroller):
def test_popens_rsync(self, config, mysetup, workercontroller):
source = mysetup.source
hm = NodeManager(config, ["popen"] * 2)
hm.setup_nodes(None)
@@ -89,24 +89,24 @@ class TestNodeManagerPopen:
pass
gw.remote_exec = pseudoexec
l = []
notifications = []
for gw in hm.group:
hm.rsync(gw, source, notify=lambda *args: l.append(args))
assert not l
hm.rsync(gw, source, notify=lambda *args: notifications.append(args))
assert not notifications
hm.teardown_nodes()
assert not len(hm.group)
assert "sys.path.insert" in gw.remote_exec.args[0]
def test_rsync_popen_with_path(self, config, mysetup, slavecontroller):
def test_rsync_popen_with_path(self, config, mysetup, workercontroller):
source, dest = mysetup.source, mysetup.dest
hm = NodeManager(config, ["popen//chdir=%s" % dest] * 1)
hm.setup_nodes(None)
source.ensure("dir1", "dir2", "hello")
l = []
notifications = []
for gw in hm.group:
hm.rsync(gw, source, notify=lambda *args: l.append(args))
assert len(l) == 1
assert l[0] == ("rsyncrootready", hm.group['gw0'].spec, source)
hm.rsync(gw, source, notify=lambda *args: notifications.append(args))
assert len(notifications) == 1
assert notifications[0] == ("rsyncrootready", hm.group['gw0'].spec, source)
hm.teardown_nodes()
dest = dest.join(source.basename)
assert dest.join("dir1").check()
@@ -114,7 +114,7 @@ class TestNodeManagerPopen:
assert dest.join("dir1", "dir2", 'hello').check()
def test_rsync_same_popen_twice(self, config, mysetup, hookrecorder,
slavecontroller):
workercontroller):
source, dest = mysetup.source, mysetup.dest
hm = NodeManager(config, ["popen//chdir=%s" % dest] * 2)
hm.roots = []
@@ -137,9 +137,9 @@ class TestHRSync:
source.ensure(".somedotfile", "moreentries")
source.ensure("somedir", "editfile~")
syncer = HostRSync(source, ignores=NodeManager.DEFAULT_IGNORES)
l = list(source.visit(rec=syncer.filter, fil=syncer.filter))
assert len(l) == 3
basenames = [x.basename for x in l]
files = list(source.visit(rec=syncer.filter, fil=syncer.filter))
assert len(files) == 3
basenames = [x.basename for x in files]
assert 'dir' in basenames
assert 'file.txt' in basenames
assert 'somedir' in basenames
@@ -174,7 +174,7 @@ class TestNodeManager:
assert p.join("dir1").check()
assert p.join("dir1", "file1").check()
def test_popen_rsync_subdir(self, testdir, mysetup, slavecontroller):
def test_popen_rsync_subdir(self, testdir, mysetup, workercontroller):
source, dest = mysetup.source, mysetup.dest
dir1 = mysetup.source.mkdir("dir1")
dir2 = dir1.mkdir("dir2")
@@ -192,7 +192,7 @@ class TestNodeManager:
assert dest.join("dir1", "dir2", 'hello').check()
nodemanager.teardown_nodes()
def test_init_rsync_roots(self, testdir, mysetup, slavecontroller):
def test_init_rsync_roots(self, testdir, mysetup, workercontroller):
source, dest = mysetup.source, mysetup.dest
dir2 = source.ensure("dir1", "dir2", dir=1)
source.ensure("dir1", "somefile", dir=1)
@@ -209,7 +209,7 @@ class TestNodeManager:
assert not dest.join("dir1").check()
assert not dest.join("bogus").check()
def test_rsyncignore(self, testdir, mysetup, slavecontroller):
def test_rsyncignore(self, testdir, mysetup, workercontroller):
source, dest = mysetup.source, mysetup.dest
dir2 = source.ensure("dir1", "dir2", dir=1)
source.ensure("dir5", "dir6", "bogus")
@@ -233,7 +233,7 @@ class TestNodeManager:
assert not dest.join('foo').check()
assert not dest.join('bar').check()
def test_optimise_popen(self, testdir, mysetup, slavecontroller):
def test_optimise_popen(self, testdir, mysetup, workercontroller):
source = mysetup.source
specs = ["popen"] * 3
source.join("conftest.py").write("rsyncdirs = ['a']")

View File

@@ -1,8 +1,9 @@
[tox]
# if you change the envlist, please update .travis.yml file as well
envlist=
py{26,27,34,35,36}-pytest{30,31,32}
py{27,36}-pytest{30,31,32}-pexpect
py{27,34,35,36}-pytest{30,31,32,33}
py{27,36}-pytest{30,31,32,33}-pexpect
py{27,36}-pytest{master,features}
flakes
readme
@@ -17,6 +18,9 @@ deps =
pytest30: pytest~=3.0.5
pytest31: pytest~=3.1.0
pytest32: pytest~=3.2.0
pytest33: pytest~=3.3.0
pytestmaster: git+https://github.com/pytest-dev/pytest.git@master
pytestfeatures: git+https://github.com/pytest-dev/pytest.git@features
pexpect: pexpect
platform=
pexpect: linux|darwin

View File

@@ -1,11 +1,12 @@
import py
import pytest
from xdist.slavemanage import NodeManager
from xdist.workermanage import NodeManager
from xdist.scheduler import (
EachScheduling,
LoadScheduling,
LoadScopeScheduling,
LoadFileScheduling,
)
@@ -21,7 +22,7 @@ class DSession:
At the beginning of the test session this creates a NodeManager
instance which creates and starts all nodes. Nodes then emit
events processed in the pytest_runtestloop hook using the slave_*
events processed in the pytest_runtestloop hook using the worker_*
methods.
Once a node is started it will automatically start running the
@@ -45,9 +46,9 @@ class DSession:
self._failed_collection_errors = {}
self._active_nodes = set()
self._failed_nodes_count = 0
self._max_slave_restart = self.config.getoption('max_slave_restart')
if self._max_slave_restart is not None:
self._max_slave_restart = int(self._max_slave_restart)
self._max_worker_restart = self.config.option.maxworkerrestart
if self._max_worker_restart is not None:
self._max_worker_restart = int(self._max_worker_restart)
try:
self.terminal = config.pluginmanager.getplugin("terminalreporter")
except KeyError:
@@ -74,7 +75,7 @@ class DSession:
"""Creates and starts the nodes.
The nodes are setup to put their events onto self.queue. As
soon as nodes start they will emit the slave_slaveready event.
soon as nodes start they will emit the worker_workerready event.
"""
self.nodemanager = NodeManager(self.config)
nodes = self.nodemanager.setup_nodes(putevent=self.queue.put)
@@ -99,6 +100,7 @@ class DSession:
'each': EachScheduling,
'load': LoadScheduling,
'loadscope': LoadScopeScheduling,
'loadfile': LoadFileScheduling,
}
return schedulers[dist](config, log)
@@ -118,8 +120,12 @@ class DSession:
return True
def loop_once(self):
"""Process one callback from one of the slaves."""
"""Process one callback from one of the workers."""
while 1:
if not self._active_nodes:
# If everything has died stop looping
self.triggershutdown()
raise RuntimeError("Unexpectedly no active workers available")
try:
eventcall = self.queue.get(timeout=2.0)
break
@@ -127,7 +133,7 @@ class DSession:
continue
callname, kwargs = eventcall
assert callname, kwargs
method = "slave_" + callname
method = "worker_" + callname
call = getattr(self, method)
self.log("calling method", method, kwargs)
call(**kwargs)
@@ -135,44 +141,48 @@ class DSession:
self.triggershutdown()
#
# callbacks for processing events from slaves
# callbacks for processing events from workers
#
def slave_slaveready(self, node, slaveinfo):
def worker_workerready(self, node, workerinfo):
"""Emitted when a node first starts up.
This adds the node to the scheduler, nodes continue with
collection without any further input.
"""
node.slaveinfo = slaveinfo
node.slaveinfo['id'] = node.gateway.id
node.slaveinfo['spec'] = node.gateway.spec
node.workerinfo = workerinfo
node.workerinfo['id'] = node.gateway.id
node.workerinfo['spec'] = node.gateway.spec
# TODO: (#234 task) needs this for pytest. Remove when refactor in pytest repo
node.slaveinfo = node.workerinfo
self.config.hook.pytest_testnodeready(node=node)
if self.shuttingdown:
node.shutdown()
else:
self.sched.add_node(node)
def slave_slavefinished(self, node):
def worker_workerfinished(self, node):
"""Emitted when node executes its pytest_sessionfinish hook.
Removes the node from the scheduler.
The node might not be in the scheduler if it had not emitted
slaveready before shutdown was triggered.
workerready before shutdown was triggered.
"""
self.config.hook.pytest_testnodedown(node=node, error=None)
if node.slaveoutput['exitstatus'] == 2: # keyboard-interrupt
if node.workeroutput['exitstatus'] == 2: # keyboard-interrupt
self.shouldstop = "%s received keyboard-interrupt" % (node,)
self.slave_errordown(node, "keyboard-interrupt")
self.worker_errordown(node, "keyboard-interrupt")
return
if node in self.sched.nodes:
crashitem = self.sched.remove_node(node)
assert not crashitem, (crashitem, node)
self._active_nodes.remove(node)
def slave_errordown(self, node, error):
"""Emitted by the SlaveController when a node dies."""
def worker_errordown(self, node, error):
"""Emitted by the WorkerController when a node dies."""
self.config.hook.pytest_testnodedown(node=node, error=error)
try:
crashitem = self.sched.remove_node(node)
@@ -183,22 +193,22 @@ class DSession:
self.handle_crashitem(crashitem, node)
self._failed_nodes_count += 1
maximum_reached = (self._max_slave_restart is not None and
self._failed_nodes_count > self._max_slave_restart)
maximum_reached = (self._max_worker_restart is not None and
self._failed_nodes_count > self._max_worker_restart)
if maximum_reached:
if self._max_slave_restart == 0:
msg = 'Slave restarting disabled'
if self._max_worker_restart == 0:
msg = 'Worker restarting disabled'
else:
msg = "Maximum crashed slaves reached: %d" % \
self._max_slave_restart
msg = "Maximum crashed workers reached: %d" % \
self._max_worker_restart
self.report_line(msg)
else:
self.report_line("Replacing crashed slave %s" % node.gateway.id)
self.report_line("Replacing crashed worker %s" % node.gateway.id)
self._clone_node(node)
self._active_nodes.remove(node)
def slave_collectionfinish(self, node, ids):
"""Slave has finished test collection.
def worker_collectionfinish(self, node, ids):
"""worker has finished test collection.
This adds the collection for this node to the scheduler. If
the scheduler indicates collection is finished (i.e. all
@@ -224,30 +234,36 @@ class DSession:
self.sched.__class__.__name__))
self.sched.schedule()
def slave_logstart(self, node, nodeid, location):
def worker_logstart(self, node, nodeid, location):
"""Emitted when a node calls the pytest_runtest_logstart hook."""
self.config.hook.pytest_runtest_logstart(
nodeid=nodeid, location=location)
def slave_testreport(self, node, rep):
"""Emitted when a node calls the pytest_runtest_logreport hook.
def worker_logfinish(self, node, nodeid, location):
"""Emitted when a node calls the pytest_runtest_logfinish hook."""
self.config.hook.pytest_runtest_logfinish(
nodeid=nodeid, location=location)
If the node indicates it is finished with a test item, remove
the item from the pending list in the scheduler.
"""
if rep.when == "call" or (rep.when == "setup" and not rep.passed):
self.sched.mark_test_complete(node, rep.item_index, rep.duration)
# self.report_line("testreport %s: %s" %(rep.id, rep.status))
def worker_testreport(self, node, rep):
"""Emitted when a node calls the pytest_runtest_logreport hook."""
rep.node = node
self.config.hook.pytest_runtest_logreport(report=rep)
self._handlefailures(rep)
def slave_collectreport(self, node, rep):
def worker_runtest_protocol_complete(self, node, item_index, duration):
"""
Emitted when a node fires the 'runtest_protocol_complete' event,
signalling that a test has completed the runtestprotocol and should be
removed from the pending list in the scheduler.
"""
self.sched.mark_test_complete(node, item_index, duration)
def worker_collectreport(self, node, rep):
"""Emitted when a node calls the pytest_collectreport hook."""
if rep.failed:
self._failed_slave_collectreport(node, rep)
self._failed_worker_collectreport(node, rep)
def slave_logwarning(self, message, code, nodeid, fslocation):
def worker_logwarning(self, message, code, nodeid, fslocation):
"""Emitted when a node calls the pytest_logwarning hook."""
kwargs = dict(message=message, code=code, nodeid=nodeid, fslocation=fslocation)
self.config.hook.pytest_logwarning.call_historic(kwargs=kwargs)
@@ -258,7 +274,7 @@ class DSession:
This is normally for when a node dies, this will copy the spec
of the existing node and create a new one with a new id. The
new node will have been setup so it will start calling the
"slave_*" hooks and do work soon.
"worker_*" hooks and do work soon.
"""
spec = node.gateway.spec
spec.id = None
@@ -267,9 +283,9 @@ class DSession:
self._active_nodes.add(node)
return node
def _failed_slave_collectreport(self, node, rep):
def _failed_worker_collectreport(self, node, rep):
# Check we haven't already seen this report (from
# another slave).
# another worker).
if rep.longrepr not in self._failed_collection_errors:
self._failed_collection_errors[rep.longrepr] = True
self.config.hook.pytest_collectreport(report=rep)
@@ -288,15 +304,15 @@ class DSession:
for node in self.sched.nodes:
node.shutdown()
def handle_crashitem(self, nodeid, slave):
def handle_crashitem(self, nodeid, worker):
# XXX get more reporting info by recording pytest_runtest_logstart?
# XXX count no of failures and retry N times
runner = self.config.pluginmanager.getplugin("runner")
fspath = nodeid.split("::")[0]
msg = "Slave %r crashed while running %r" % (slave.gateway.id, nodeid)
msg = "Worker %r crashed while running %r" % (worker.gateway.id, nodeid)
rep = runner.TestReport(nodeid, (fspath, None, fspath),
(), "failed", msg, "???")
rep.node = slave
rep.node = worker
self.config.hook.pytest_runtest_logreport(report=rep)
@@ -352,7 +368,7 @@ class TerminalDistReporter:
def pytest_testnodeready(self, node):
if self.config.option.verbose > 0:
d = node.slaveinfo
d = node.workerinfo
infoline = "[%s] Python %s" % (
d['id'],
d['version'].replace('\n', ' -- '),)

View File

@@ -69,10 +69,10 @@ class RemoteControl(object):
out = py.io.TerminalWriter()
if hasattr(self, 'gateway'):
raise ValueError("already have gateway %r" % self.gateway)
self.trace("setting up slave session")
self.trace("setting up worker session")
self.gateway = self.initgateway()
self.channel = channel = self.gateway.remote_exec(
init_slave_session,
init_worker_session,
args=self.config.args,
option_dict=vars(self.config.option),
)
@@ -134,7 +134,7 @@ def repr_pytest_looponfailinfo(failreports, rootdirs):
tr.line("### Watching: %s" % (rootdir,), bold=True)
def init_slave_session(channel, args, option_dict):
def init_worker_session(channel, args, option_dict):
import os
import sys
outchannel = channel.gateway.newchannel()
@@ -153,11 +153,11 @@ def init_slave_session(channel, args, option_dict):
from _pytest.config import Config
config = Config.fromdictargs(option_dict, list(args))
config.args = args
from xdist.looponfail import SlaveFailSession
SlaveFailSession(config, channel).main()
from xdist.looponfail import WorkerFailSession
WorkerFailSession(config, channel).main()
class SlaveFailSession:
class WorkerFailSession:
def __init__(self, config, channel):
self.config = config
self.channel = channel
@@ -194,11 +194,11 @@ class SlaveFailSession:
self.collection_failed = True
def main(self):
self.DEBUG("SLAVE: received configuration, waiting for command trails")
self.DEBUG("WORKER: received configuration, waiting for command trails")
try:
command = self.channel.receive()
except KeyboardInterrupt:
return # in the slave we can't do much about this
return # in the worker we can't do much about this
self.DEBUG("received", command)
self.current_command = command
self.config.hook.pytest_cmdline_main(config=self.config)

View File

@@ -26,12 +26,15 @@ def pytest_addoption(parser):
help="shortcut for '--dist=load --tx=NUM*popen', "
"you can use 'auto' here for auto detection CPUs number on "
"host system")
group.addoption('--max-slave-restart', action="store", default=None,
help="maximum number of slaves that can be restarted "
"when crashed (set to zero to disable this feature)")
group.addoption('--max-worker-restart', '--max-slave-restart', action="store", default=None,
dest="maxworkerrestart",
help="maximum number of workers that can be restarted "
"when crashed (set to zero to disable this feature)\n"
"'--max-slave-restart' option is deprecated and will be removed in "
"a future release")
group.addoption(
'--dist', metavar="distmode",
action="store", choices=['each', 'load', 'loadscope', 'no'],
action="store", choices=['each', 'load', 'loadscope', 'loadfile', 'no'],
dest="dist", default="no",
help=("set mode for distributing tests to exec environments.\n\n"
"each: send each test to all available environments.\n\n"
@@ -39,6 +42,8 @@ def pytest_addoption(parser):
" available environment.\n\n"
"loadscope: load balance by sending pending groups of tests in"
" the same scope to any available environment.\n\n"
"loadfile: load balance by sending test grouped by file"
" to any available environment.\n\n"
"(default) no: run tests inprocess, don't distribute."))
group.addoption(
'--tx', dest="tx", action="append", default=[],
@@ -91,7 +96,7 @@ def pytest_addhooks(pluginmanager):
@pytest.mark.trylast
def pytest_configure(config):
if config.getoption("dist") != "no":
if config.getoption("dist") != "no" and not config.getvalue("collectonly"):
from xdist.dsession import DSession
session = DSession(config)
config.pluginmanager.register(session, "dsession")
@@ -115,7 +120,7 @@ def pytest_cmdline_main(config):
if val("dist") != "no":
if usepdb:
raise pytest.UsageError(
"--pdb incompatible with distributing tests.")
"--pdb is incompatible with distributing tests; try using -n0.") # noqa: E501
# -------------------------------------------------------------------------
# fixtures
@@ -124,7 +129,10 @@ def pytest_cmdline_main(config):
@pytest.fixture(scope="session")
def worker_id(request):
if hasattr(request.config, 'slaveinput'):
return request.config.slaveinput['slaveid']
"""Return the id of the current worker ('gw0', 'gw1', etc) or 'master'
if running on the master node.
"""
if hasattr(request.config, 'workerinput'):
return request.config.workerinput['workerid']
else:
return 'master'

View File

@@ -8,14 +8,17 @@
import sys
import os
import time
import _pytest.hookspec
import pytest
class SlaveInteractor:
class WorkerInteractor:
def __init__(self, config, channel):
self.config = config
self.slaveid = config.slaveinput.get('slaveid', "?")
self.log = py.log.Producer("slave-%s" % self.slaveid)
self.workerid = config.workerinput.get('workerid', "?")
self.log = py.log.Producer("worker-%s" % self.workerid)
if not config.option.debug:
py.log.setconsumer(self.log._keywords, None)
self.channel = channel
@@ -31,14 +34,14 @@ class SlaveInteractor:
def pytest_sessionstart(self, session):
self.session = session
slaveinfo = getinfodict()
self.sendevent("slaveready", slaveinfo=slaveinfo)
workerinfo = getinfodict()
self.sendevent("workerready", workerinfo=workerinfo)
@pytest.hookimpl(hookwrapper=True)
def pytest_sessionfinish(self, exitstatus):
self.config.slaveoutput['exitstatus'] = exitstatus
self.config.workeroutput['exitstatus'] = exitstatus
yield
self.sendevent("slavefinished", slaveoutput=self.config.slaveoutput)
self.sendevent("workerfinished", workeroutput=self.config.workeroutput)
def pytest_collection(self, session):
self.sendevent("collectionstart")
@@ -59,23 +62,29 @@ class SlaveInteractor:
self.log("items to run:", torun)
# only run if we have an item and a next item
while len(torun) >= 2:
self.run_tests(torun)
self.run_one_test(torun)
if name == "shutdown":
if torun:
self.run_tests(torun)
self.run_one_test(torun)
break
return True
def run_tests(self, torun):
def run_one_test(self, torun):
items = self.session.items
self.item_index = torun.pop(0)
item = items[self.item_index]
if torun:
nextitem = items[torun[0]]
else:
nextitem = None
start = time.time()
self.config.hook.pytest_runtest_protocol(
item=items[self.item_index],
item=item,
nextitem=nextitem)
duration = time.time() - start
self.sendevent("runtest_protocol_complete", item_index=self.item_index,
duration=duration)
def pytest_collection_finish(self, session):
self.sendevent(
@@ -86,10 +95,15 @@ class SlaveInteractor:
def pytest_runtest_logstart(self, nodeid, location):
self.sendevent("logstart", nodeid=nodeid, location=location)
# the pytest_runtest_logfinish hook was introduced in pytest 3.4
if hasattr(_pytest.hookspec, 'pytest_runtest_logfinish'):
def pytest_runtest_logfinish(self, nodeid, location):
self.sendevent("logfinish", nodeid=nodeid, location=location)
def pytest_runtest_logreport(self, report):
data = serialize_report(report)
data["item_index"] = self.item_index
data["worker_id"] = self.slaveid
data["worker_id"] = self.workerid
assert self.session.items[self.item_index].nodeid == report.nodeid
self.sendevent("testreport", data=data)
@@ -104,18 +118,18 @@ class SlaveInteractor:
def serialize_report(rep):
def disassembled_report(rep):
reprtraceback = rep.longrepr.reprtraceback.__dict__
reprcrash = rep.longrepr.reprcrash.__dict__
reprtraceback = rep.longrepr.reprtraceback.__dict__.copy()
reprcrash = rep.longrepr.reprcrash.__dict__.copy()
new_entries = []
for entry in reprtraceback['reprentries']:
entry_data = {
'type': type(entry).__name__,
'data': entry.__dict__,
'data': entry.__dict__.copy(),
}
for key, value in entry_data['data'].items():
if hasattr(value, '__dict__'):
entry_data['data'][key] = value.__dict__
entry_data['data'][key] = value.__dict__.copy()
new_entries.append(entry_data)
reprtraceback['reprentries'] = new_entries
@@ -171,22 +185,21 @@ def remote_initconfig(option_dict, args):
if __name__ == '__channelexec__':
channel = channel # noqa
# python3.2 is not concurrent import safe, so let's play it safe
# https://bitbucket.org/hpk42/pytest/issue/347/pytest-xdist-and-python-32
if sys.version_info[:2] == (3, 2):
os.environ["PYTHONDONTWRITEBYTECODE"] = "1"
slaveinput, args, option_dict = channel.receive()
workerinput, args, option_dict = channel.receive()
importpath = os.getcwd()
sys.path.insert(0, importpath) # XXX only for remote situations
os.environ['PYTHONPATH'] = (
importpath + os.pathsep +
os.environ.get('PYTHONPATH', ''))
os.environ['PYTEST_XDIST_WORKER'] = slaveinput['slaveid']
os.environ['PYTEST_XDIST_WORKER_COUNT'] = str(slaveinput['slavecount'])
os.environ['PYTEST_XDIST_WORKER'] = workerinput['workerid']
os.environ['PYTEST_XDIST_WORKER_COUNT'] = str(workerinput['workercount'])
# os.environ['PYTHONPATH'] = importpath
import py
config = remote_initconfig(option_dict, args)
config.slaveinput = slaveinput
config.slaveoutput = {}
interactor = SlaveInteractor(config, channel)
config.workerinput = workerinput
config.workeroutput = {}
# TODO: deprecated name, backward compatibility only. Remove it in future
config.slaveinput = config.workerinput
config.slaveoutput = config.workeroutput
interactor = WorkerInteractor(config, channel)
config.hook.pytest_cmdline_main(config=config)

View File

@@ -1,3 +1,4 @@
from xdist.scheduler.each import EachScheduling # noqa
from xdist.scheduler.load import LoadScheduling # noqa
from xdist.scheduler.loadscope import LoadScopeScheduling # noqa
from xdist.scheduler.filescope import LoadFileScheduling # noqa

View File

@@ -1,6 +1,6 @@
from py.log import Producer
from xdist.slavemanage import parse_spec_config
from xdist.workermanage import parse_spec_config
from xdist.report import report_collection_diff

View File

@@ -0,0 +1,52 @@
from . import LoadScopeScheduling
from py.log import Producer
class LoadFileScheduling(LoadScopeScheduling):
"""Implement load scheduling across nodes, but grouping test test file.
This distributes the tests collected across all nodes so each test is run
just once. All nodes collect and submit the list of tests and when all
collections are received it is verified they are identical collections.
Then the collection gets divided up in work units, grouped by test file,
and those work units get submitted to nodes. Whenever a node finishes an
item, it calls ``.mark_test_complete()`` which will trigger the scheduler
to assign more work units if the number of pending tests for the node falls
below a low-watermark.
When created, ``numnodes`` defines how many nodes are expected to submit a
collection. This is used to know when all nodes have finished collection.
This class behaves very much like LoadScopeScheduling, but with a file-level scope.
"""
def __init(self, config, log=None):
super(LoadFileScheduling, self).__init__(config, log)
if log is None:
self.log = Producer('loadfilesched')
else:
self.log = log.loadfilesched
def _split_scope(self, nodeid):
"""Determine the scope (grouping) of a nodeid.
There are usually 3 cases for a nodeid::
example/loadsuite/test/test_beta.py::test_beta0
example/loadsuite/test/test_delta.py::Delta1::test_delta0
example/loadsuite/epsilon/__init__.py::epsilon.epsilon
#. Function in a test module.
#. Method of a class in a test module.
#. Doctest in a function in a package.
This function will group tests with the scope determined by splitting
the first ``::`` from the left. That is, test will be grouped in a
single work unit when they reside in the same file.
In the above example, scopes will be::
example/loadsuite/test/test_beta.py
example/loadsuite/test/test_delta.py
example/loadsuite/epsilon/__init__.py
"""
return nodeid.split('::', 1)[0]

View File

@@ -3,7 +3,7 @@ from itertools import cycle
from py.log import Producer
from _pytest.runner import CollectReport
from xdist.slavemanage import parse_spec_config
from xdist.workermanage import parse_spec_config
from xdist.report import report_collection_diff
@@ -113,7 +113,7 @@ class LoadScheduling:
From now on the node will be allocated chunks of tests to
execute.
Called by the ``DSession.slave_slaveready`` hook when it
Called by the ``DSession.worker_workerready`` hook when it
successfully bootstraps a new node.
"""
assert node not in self.node2pending
@@ -123,7 +123,7 @@ class LoadScheduling:
"""Add the collected test items from a node
The collection is stored in the ``.node2collection`` map.
Called by the ``DSession.slave_collectionfinish`` hook.
Called by the ``DSession.worker_collectionfinish`` hook.
"""
assert node in self.node2pending
if self.collection_is_completed:
@@ -147,7 +147,7 @@ class LoadScheduling:
The duration it took to execute the item is used as a hint to
the scheduler.
This is called by the ``DSession.slave_testreport`` hook.
This is called by the ``DSession.worker_testreport`` hook.
"""
self.node2pending[node].remove(item_index)
self.check_schedule(node, duration=duration)
@@ -187,8 +187,8 @@ class LoadScheduling:
This should be called either when the node crashed or at
shutdown time. In the former case any pending items assigned
to the node will be re-scheduled. Called by the
``DSession.slave_slavefinished`` and
``DSession.slave_errordown`` hooks.
``DSession.worker_workerfinished`` and
``DSession.worker_errordown`` hooks.
Return the item which was being executing while the node
crashed or None if the node has no more pending items.
@@ -213,7 +213,7 @@ class LoadScheduling:
``.check_schedule()`` on all nodes so that newly added nodes
will start to be used.
This is called by the ``DSession.slave_collectionfinish`` hook
This is called by the ``DSession.worker_collectionfinish`` hook
if ``.collection_is_completed`` is True.
"""
assert self.collection_is_completed

View File

@@ -1,14 +1,9 @@
try:
from collections import OrderedDict
except ImportError:
# Support for Python 2.6
from ordereddict import OrderedDict
from collections import OrderedDict
from py.log import Producer
from _pytest.runner import CollectReport
from xdist.slavemanage import parse_spec_config
from py.log import Producer
from xdist.report import report_collection_diff
from xdist.workermanage import parse_spec_config
class LoadScopeScheduling:
@@ -156,7 +151,7 @@ class LoadScopeScheduling:
From now on the node will be assigned work units to be executed.
Called by the ``DSession.slave_slaveready`` hook when it successfully
Called by the ``DSession.worker_workerready`` hook when it successfully
bootstraps a new node.
"""
assert node not in self.assigned_work
@@ -171,8 +166,8 @@ class LoadScopeScheduling:
Called by the hooks:
- ``DSession.slave_slavefinished``.
- ``DSession.slave_errordown``.
- ``DSession.worker_workerfinished``.
- ``DSession.worker_errordown``.
Return the item being executed while the node crashed or None if the
node has no more pending items.
@@ -211,7 +206,7 @@ class LoadScopeScheduling:
Called by the hook:
- ``DSession.slave_collectionfinish``.
- ``DSession.worker_collectionfinish``.
"""
# Check that add_node() was called on the node before
@@ -244,7 +239,7 @@ class LoadScopeScheduling:
Called by the hook:
- ``DSession.slave_testreport``.
- ``DSession.worker_testreport``.
"""
nodeid = self.registered_collections[node][item_index]
scope = self._split_scope(nodeid)
@@ -341,7 +336,7 @@ class LoadScopeScheduling:
If ``.collection_is_completed`` is True, this is called by the hook:
- ``DSession.slave_collectionfinish``.
- ``DSession.worker_collectionfinish``.
"""
assert self.collection_is_completed
@@ -373,18 +368,22 @@ class LoadScopeScheduling:
extra_nodes = len(self.nodes) - len(self.workqueue)
if extra_nodes > 0:
self.log('Shuting down {} nodes'.format(extra_nodes))
self.log('Shuting down {0} nodes'.format(extra_nodes))
for _ in range(extra_nodes):
unused_node, assigned = self.assigned_work.popitem(last=True)
self.log('Shuting down unused node {}'.format(unused_node))
self.log('Shuting down unused node {0}'.format(unused_node))
unused_node.shutdown()
# Assign initial workload
for node in self.nodes:
self._assign_work_unit(node)
# Ensure nodes start with at least two work units if possible (#277)
for node in self.nodes:
self._reschedule(node)
# Initial distribution sent all tests, start node shutdown
if not self.workqueue:
for node in self.nodes:

View File

@@ -68,7 +68,7 @@ class NodeManager(object):
gw = self.group.makegateway(spec)
self.config.hook.pytest_xdist_newgateway(gateway=gw)
self.rsync_roots(gw)
node = SlaveController(self, gw, self.config, putevent)
node = WorkerController(self, gw, self.config, putevent)
gw.node = node # keep the node alive
node.setup()
self.trace("started node %r" % node)
@@ -186,7 +186,7 @@ class HostRSync(execnet.RSync):
def make_reltoroot(roots, args):
# XXX introduce/use public API for splitting py.test args
splitcode = "::"
l = []
result = []
for arg in args:
parts = arg.split(splitcode)
fspath = py.path.local(parts[0])
@@ -197,11 +197,11 @@ def make_reltoroot(roots, args):
break
else:
raise ValueError("arg %s not relative to an rsync root" % (arg,))
l.append(splitcode.join(parts))
return l
result.append(splitcode.join(parts))
return result
class SlaveController(object):
class WorkerController(object):
ENDMARK = -1
def __init__(self, nodemanager, gateway, config, putevent):
@@ -209,11 +209,16 @@ class SlaveController(object):
self.putevent = putevent
self.gateway = gateway
self.config = config
self.slaveinput = {'slaveid': gateway.id,
'slavecount': len(nodemanager.specs)}
self.workerinput = {'workerid': gateway.id,
'workercount': len(nodemanager.specs),
'slaveid': gateway.id,
'slavecount': len(nodemanager.specs)
}
# TODO: deprecated name, backward compatibility only. Remove it in future
self.slaveinput = self.workerinput
self._down = False
self._shutdown_sent = False
self.log = py.log.Producer("slavectl-%s" % gateway.id)
self.log = py.log.Producer("workerctl-%s" % gateway.id)
if not self.config.option.debug:
py.log.setconsumer(self.log._keywords, None)
@@ -225,7 +230,7 @@ class SlaveController(object):
return self._down or self._shutdown_sent
def setup(self):
self.log("setting up slave session")
self.log("setting up worker session")
spec = self.gateway.spec
args = self.config.args
if not spec.popen or spec.chdir:
@@ -238,7 +243,7 @@ class SlaveController(object):
option_dict['basetemp'] = str(basetemp.join(name))
self.config.hook.pytest_configure_node(node=self)
self.channel = self.gateway.remote_exec(xdist.remote)
self.channel.send((self.slaveinput, args, option_dict))
self.channel.send((self.workerinput, args, option_dict))
if self.putevent:
self.channel.setcallback(
self.process_from_remote,
@@ -298,13 +303,13 @@ class SlaveController(object):
eventname, kwargs = eventcall
if eventname in ("collectionstart",):
self.log("ignoring %s(%s)" % (eventname, kwargs))
elif eventname == "slaveready":
elif eventname == "workerready":
self.notify_inproc(eventname, node=self, **kwargs)
elif eventname == "slavefinished":
elif eventname == "workerfinished":
self._down = True
self.slaveoutput = kwargs['slaveoutput']
self.notify_inproc("slavefinished", node=self)
elif eventname == "logstart":
self.workeroutput = kwargs['workeroutput']
self.notify_inproc("workerfinished", node=self)
elif eventname in ("logstart", "logfinish"):
self.notify_inproc(eventname, node=self, **kwargs)
elif eventname in (
"testreport", "collectreport", "teardownreport"):
@@ -315,6 +320,8 @@ class SlaveController(object):
self.notify_inproc(eventname, node=self, rep=rep)
elif eventname == "collectionfinish":
self.notify_inproc(eventname, node=self, ids=kwargs['ids'])
elif eventname == "runtest_protocol_complete":
self.notify_inproc(eventname, node=self, **kwargs)
elif eventname == "logwarning":
self.notify_inproc(eventname, message=kwargs['message'],
code=kwargs['code'], nodeid=kwargs['nodeid'],
@@ -324,7 +331,7 @@ class SlaveController(object):
except KeyboardInterrupt:
# should not land in receiver-thread
raise
except:
except: # noqa
excinfo = py.code.ExceptionInfo()
py.builtin.print_("!" * 20, excinfo)
self.config.notify_exception(excinfo)