Compare commits
246 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
38dcf52ae6 | ||
|
|
f2633f1b37 | ||
|
|
192193197b | ||
|
|
0f58a14def | ||
|
|
bd23c2460f | ||
|
|
794f28bcf4 | ||
|
|
31e80c8c6a | ||
|
|
1e9f6a7c3c | ||
|
|
ed65e888cf | ||
|
|
c168706fbe | ||
|
|
ab95a4b45d | ||
|
|
8b0856a986 | ||
|
|
f2064873fd | ||
|
|
1fbf49909f | ||
|
|
1471164197 | ||
|
|
80130d59ea | ||
|
|
a1785b539c | ||
|
|
25cc1a4119 | ||
|
|
f04cd22fd6 | ||
|
|
42024f374a | ||
|
|
e407a3377e | ||
|
|
6169d494a4 | ||
|
|
d137384315 | ||
|
|
23992d874e | ||
|
|
2ec4f407f5 | ||
|
|
9236f11757 | ||
|
|
61132777f8 | ||
|
|
8616ff368c | ||
|
|
1a5e680e91 | ||
|
|
9d69c1a7da | ||
|
|
8a417f4545 | ||
|
|
44cbd7fdc5 | ||
|
|
37c06dae24 | ||
|
|
2220ccecb1 | ||
|
|
7743e14fd4 | ||
|
|
8652ef91e6 | ||
|
|
e526c38311 | ||
|
|
8723495e9b | ||
|
|
48a213b47c | ||
|
|
eca7f202b6 | ||
|
|
3fc253f192 | ||
|
|
6fca8686f5 | ||
|
|
9c7b5f4831 | ||
|
|
2fefa36db6 | ||
|
|
1102b82795 | ||
|
|
a685a04bd1 | ||
|
|
41a4d439c8 | ||
|
|
24f331ccf0 | ||
|
|
34f63600ee | ||
|
|
28688962e1 | ||
|
|
7f04ce35c9 | ||
|
|
ad5468b6e7 | ||
|
|
797867f23d | ||
|
|
e3c1a3de67 | ||
|
|
14e1d80f10 | ||
|
|
29c4cce1d4 | ||
|
|
d79ef915a2 | ||
|
|
290b322a5d | ||
|
|
8fcf927c44 | ||
|
|
8cd10225df | ||
|
|
1a5ad8ac20 | ||
|
|
dd61dce892 | ||
|
|
2aeb5d51f5 | ||
|
|
a1a6c77028 | ||
|
|
628a04de8e | ||
|
|
5749a347b9 | ||
|
|
c4e0d39f21 | ||
|
|
d709e4cda0 | ||
|
|
1c7fc1a812 | ||
|
|
6b02b353d2 | ||
|
|
18143275c6 | ||
|
|
d21f59fea7 | ||
|
|
82ecdea0c2 | ||
|
|
f9f8a765ba | ||
|
|
13f39349c6 | ||
|
|
c76d5622f1 | ||
|
|
5f78c7155e | ||
|
|
c8bbc03e49 | ||
|
|
8dbf3677dc | ||
|
|
a25c14bef5 | ||
|
|
110c114025 | ||
|
|
83bdbf4b95 | ||
|
|
630c1eb6f2 | ||
|
|
62e50d0097 | ||
|
|
1b5d6b6db7 | ||
|
|
52a395888f | ||
|
|
6d83034bb8 | ||
|
|
408eb1cfec | ||
|
|
1e150204e0 | ||
|
|
e2a9381036 | ||
|
|
982de538c0 | ||
|
|
2bac85562b | ||
|
|
b2586c3f48 | ||
|
|
b85b71cd22 | ||
|
|
89a3df3e20 | ||
|
|
39eec49ddf | ||
|
|
bf9606c672 | ||
|
|
18cd9b900c | ||
|
|
10d8198d88 | ||
|
|
475d7c4c2a | ||
|
|
0fac79b29c | ||
|
|
827909b4e1 | ||
|
|
ae58690f3e | ||
|
|
d794b27e72 | ||
|
|
787b8d9c14 | ||
|
|
9ddb274f23 | ||
|
|
5672d85809 | ||
|
|
999923ba97 | ||
|
|
f51289582e | ||
|
|
130dcdef76 | ||
|
|
f8a434e349 | ||
|
|
b2f3d08106 | ||
|
|
4d902461f9 | ||
|
|
15b411e94b | ||
|
|
3fa5431a53 | ||
|
|
640c85a70a | ||
|
|
c0ce0c0171 | ||
|
|
9943887304 | ||
|
|
c7c7f9ef5b | ||
|
|
56275d4418 | ||
|
|
4097c343c2 | ||
|
|
4b487ed5e1 | ||
|
|
ecf4d3be31 | ||
|
|
87d89795e3 | ||
|
|
b4544c8849 | ||
|
|
66dc3904b4 | ||
|
|
e0ce1b7418 | ||
|
|
ed47f0e01a | ||
|
|
1c8178abc5 | ||
|
|
9807064f66 | ||
|
|
766e67ce52 | ||
|
|
305aeeacec | ||
|
|
90fc616906 | ||
|
|
5f4d6ea0e6 | ||
|
|
a0ad5cf041 | ||
|
|
5e0b40cea2 | ||
|
|
513e203ee1 | ||
|
|
a5c65dd1e4 | ||
|
|
ccb14f24fc | ||
|
|
76dbde0475 | ||
|
|
1167e1609c | ||
|
|
348a956724 | ||
|
|
dba716ba91 | ||
|
|
e7c42f0b3b | ||
|
|
fe57b39563 | ||
|
|
26e7d953f4 | ||
|
|
b02a6db771 | ||
|
|
b0722675e0 | ||
|
|
881cc48271 | ||
|
|
958679e9a7 | ||
|
|
7f07d50808 | ||
|
|
fb518def55 | ||
|
|
0b14d92894 | ||
|
|
02f971d45f | ||
|
|
56e631b4bb | ||
|
|
7f2426b11d | ||
|
|
0c84201b40 | ||
|
|
08d8a62040 | ||
|
|
f36ee80e8c | ||
|
|
f75479f7f3 | ||
|
|
10ec3af8a0 | ||
|
|
577e24b5bd | ||
|
|
e37039ee41 | ||
|
|
cc828ddbfc | ||
|
|
4f459aa119 | ||
|
|
3a7604bdb7 | ||
|
|
d4d01bba2e | ||
|
|
4d27110beb | ||
|
|
260211603e | ||
|
|
f861f1667d | ||
|
|
f5665436e9 | ||
|
|
8b35945d54 | ||
|
|
3fe2094197 | ||
|
|
04dde88996 | ||
|
|
9785a316ae | ||
|
|
1dc019709c | ||
|
|
d909dcc61f | ||
|
|
f02aa70c95 | ||
|
|
1637dc18d0 | ||
|
|
f5342962ab | ||
|
|
1189ae4b91 | ||
|
|
89c86af894 | ||
|
|
b239199061 | ||
|
|
9e4e8b74e0 | ||
|
|
166bdb4103 | ||
|
|
e4bcbbee78 | ||
|
|
f6308cad01 | ||
|
|
aa89c42ad7 | ||
|
|
40fa7b091d | ||
|
|
ad99d943de | ||
|
|
0d2480f7e3 | ||
|
|
8f90fb73db | ||
|
|
c5fadcd734 | ||
|
|
16d636391b | ||
|
|
948f13730d | ||
|
|
db896a9d33 | ||
|
|
cf45eab977 | ||
|
|
00b0464d4b | ||
|
|
b3a1bf3c2e | ||
|
|
3fb369c8ac | ||
|
|
16694a978d | ||
|
|
2dcb40799f | ||
|
|
14bafa6dd5 | ||
|
|
b51286aaa2 | ||
|
|
03ddee6620 | ||
|
|
e03566b7d6 | ||
|
|
46cf204c64 | ||
|
|
5b7eeab7dc | ||
|
|
9fd3b66292 | ||
|
|
fe48256f1a | ||
|
|
607d8288d4 | ||
|
|
e469fc7b80 | ||
|
|
7caf7437e3 | ||
|
|
457386f837 | ||
|
|
1d08799c82 | ||
|
|
ac5b9956bb | ||
|
|
995b34aadc | ||
|
|
43dad454c6 | ||
|
|
c211d247a7 | ||
|
|
2b8b8408bd | ||
|
|
30606257fc | ||
|
|
d153e0a4c4 | ||
|
|
ba8398478e | ||
|
|
abc1ae0e02 | ||
|
|
047816f33a | ||
|
|
56a852665d | ||
|
|
55838a126d | ||
|
|
bcfbf9f94b | ||
|
|
94bdd18a03 | ||
|
|
fe459ba716 | ||
|
|
2f014c39df | ||
|
|
e5cdb771f7 | ||
|
|
bdf66f2c8e | ||
|
|
62bc333e3e | ||
|
|
dddac7c7e9 | ||
|
|
9decca0023 | ||
|
|
22ae7ff7af | ||
|
|
6f315356be | ||
|
|
de3e54fd27 | ||
|
|
f23c717a36 | ||
|
|
0094b29a14 | ||
|
|
e528a42ddc | ||
|
|
c6255faad4 | ||
|
|
3312dcde61 | ||
|
|
1c85f1817a | ||
|
|
77e5fdfef9 |
@@ -1,21 +0,0 @@
|
||||
environment:
|
||||
matrix:
|
||||
- TOXENV: "py27-pytestlatest"
|
||||
- TOXENV: "py35-pytestlatest"
|
||||
- TOXENV: "py36-pytestlatest"
|
||||
- TOXENV: "py37-pytestlatest"
|
||||
- TOXENV: "py38-pytestlatest"
|
||||
- TOXENV: "py38-pytestmaster"
|
||||
|
||||
install:
|
||||
- C:\Python38\python -m pip install -U pip setuptools virtualenv
|
||||
- C:\Python38\python -m pip install -U tox setuptools_scm
|
||||
|
||||
build: false # Not a C# project, build stuff at the test step instead.
|
||||
|
||||
test_script:
|
||||
- C:\Python38\python -m tox
|
||||
|
||||
# We don't deploy anything on tags with AppVeyor, we use Travis instead, so we
|
||||
# might as well save resources
|
||||
skip_tags: true
|
||||
87
.github/workflows/main.yml
vendored
Normal file
87
.github/workflows/main.yml
vendored
Normal file
@@ -0,0 +1,87 @@
|
||||
name: build
|
||||
|
||||
on: [push, pull_request]
|
||||
|
||||
jobs:
|
||||
build:
|
||||
|
||||
runs-on: ${{ matrix.os }}
|
||||
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
tox_env:
|
||||
- "py36-pytestlatest"
|
||||
- "py37-pytestlatest"
|
||||
- "py38-pytestlatest"
|
||||
- "py39-pytestlatest"
|
||||
- "py310-pytestlatest"
|
||||
- "py38-pytestmain"
|
||||
- "py38-psutil"
|
||||
- "py38-setproctitle"
|
||||
|
||||
os: [ubuntu-latest, windows-latest]
|
||||
include:
|
||||
- tox_env: "py36-pytestlatest"
|
||||
python: "3.6"
|
||||
- tox_env: "py37-pytestlatest"
|
||||
python: "3.7"
|
||||
- tox_env: "py38-pytestlatest"
|
||||
python: "3.8"
|
||||
- tox_env: "py39-pytestlatest"
|
||||
python: "3.9"
|
||||
- tox_env: "py310-pytestlatest"
|
||||
python: "3.10-dev"
|
||||
- tox_env: "py38-pytestmain"
|
||||
python: "3.8"
|
||||
- tox_env: "py38-psutil"
|
||||
python: "3.8"
|
||||
- tox_env: "py38-setproctitle"
|
||||
python: "3.8"
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
with:
|
||||
# Needed to fetch tags, which are required by setuptools-scm.
|
||||
fetch-depth: 0
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v2
|
||||
with:
|
||||
python-version: ${{ matrix.python }}
|
||||
- name: Install tox
|
||||
run: |
|
||||
python -m pip install --upgrade pip
|
||||
pip install tox
|
||||
- name: Test
|
||||
run: |
|
||||
tox -e ${{ matrix.tox_env }}
|
||||
|
||||
deploy:
|
||||
|
||||
if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags')
|
||||
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
needs: build
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
with:
|
||||
# Needed to fetch tags, which are required by setuptools-scm.
|
||||
fetch-depth: 0
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v2
|
||||
with:
|
||||
python-version: "3.7"
|
||||
- name: Install wheel
|
||||
run: |
|
||||
python -m pip install --upgrade pip
|
||||
pip install wheel
|
||||
- name: Build package
|
||||
run: |
|
||||
python setup.py sdist bdist_wheel
|
||||
- name: Publish package to PyPI
|
||||
uses: pypa/gh-action-pypi-publish@master
|
||||
with:
|
||||
user: __token__
|
||||
password: ${{ secrets.pypi_token }}
|
||||
@@ -1,18 +1,35 @@
|
||||
repos:
|
||||
- repo: https://github.com/ambv/black
|
||||
rev: 19.10b0
|
||||
- repo: https://github.com/PyCQA/autoflake
|
||||
rev: v1.7.6
|
||||
hooks:
|
||||
- id: autoflake
|
||||
args: ["--in-place", "--remove-unused-variables", "--remove-all-unused-imports"]
|
||||
- repo: https://github.com/psf/black
|
||||
rev: 22.3.0
|
||||
hooks:
|
||||
- id: black
|
||||
args: [--safe, --quiet]
|
||||
language_version: python3.7
|
||||
args: [--safe, --quiet, --target-version, py35]
|
||||
- repo: https://github.com/asottile/blacken-docs
|
||||
rev: v1.12.1
|
||||
hooks:
|
||||
- id: blacken-docs
|
||||
additional_dependencies: [black==20.8b1]
|
||||
- repo: https://github.com/pre-commit/pre-commit-hooks
|
||||
rev: v2.4.0
|
||||
rev: v4.2.0
|
||||
hooks:
|
||||
- id: trailing-whitespace
|
||||
- id: end-of-file-fixer
|
||||
- id: check-yaml
|
||||
- id: debug-statements
|
||||
- repo: https://github.com/PyCQA/flake8
|
||||
rev: 4.0.1
|
||||
hooks:
|
||||
- id: flake8
|
||||
- repo: https://github.com/asottile/pyupgrade
|
||||
rev: v2.32.1
|
||||
hooks:
|
||||
- id: pyupgrade
|
||||
args: [--py3-plus]
|
||||
- repo: local
|
||||
hooks:
|
||||
- id: rst
|
||||
@@ -21,4 +38,12 @@ repos:
|
||||
files: ^(CHANGELOG.rst|HOWTORELEASE.rst|README.rst|changelog/.*)$
|
||||
language: python
|
||||
additional_dependencies: [pygments, restructuredtext_lint]
|
||||
language_version: python3.7
|
||||
- repo: https://github.com/pre-commit/mirrors-mypy
|
||||
rev: v0.960
|
||||
hooks:
|
||||
- id: mypy
|
||||
files: ^(src/|testing/)
|
||||
args: []
|
||||
additional_dependencies:
|
||||
- pytest>=6.2.0
|
||||
- py>=1.10.0
|
||||
|
||||
62
.travis.yml
62
.travis.yml
@@ -1,62 +0,0 @@
|
||||
dist: xenial
|
||||
language: python
|
||||
|
||||
notifications:
|
||||
irc:
|
||||
channels:
|
||||
- 'chat.freenode.net#pytest'
|
||||
on_success: change
|
||||
on_failure: change
|
||||
skip_join: true
|
||||
email:
|
||||
- pytest-commit@python.org
|
||||
|
||||
install:
|
||||
- pip install -U pip setuptools
|
||||
- pip install tox setuptools_scm
|
||||
script: tox
|
||||
|
||||
stages:
|
||||
- baseline
|
||||
- test
|
||||
- name: deploy
|
||||
if: repo = pytest-dev/pytest-xdist AND tag IS present
|
||||
|
||||
jobs:
|
||||
include:
|
||||
- stage: baseline
|
||||
python: '3.7'
|
||||
env: TOXENV=linting
|
||||
cache:
|
||||
directories:
|
||||
- $HOME/.cache/pre-commit
|
||||
- python: '3.8'
|
||||
env: TOXENV=py38-pytestlatest
|
||||
- python: '2.7'
|
||||
env: TOXENV=py27-pytestlatest
|
||||
|
||||
- stage: test
|
||||
python: "3.5"
|
||||
env: TOXENV=py35-pytestlatest
|
||||
- python: "3.6"
|
||||
env: TOXENV=py36-pytestlatest
|
||||
- python: "3.7"
|
||||
env: TOXENV=py37-pytestlatest
|
||||
- python: "3.8"
|
||||
env: TOXENV=py38-pytestmaster
|
||||
|
||||
- stage: deploy
|
||||
python: '3.8'
|
||||
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
|
||||
230
CHANGELOG.rst
230
CHANGELOG.rst
@@ -1,3 +1,233 @@
|
||||
pytest-xdist 3.0.1 (2022-10-25)
|
||||
===============================
|
||||
|
||||
Trivial Changes
|
||||
---------------
|
||||
|
||||
- `#830 <https://github.com/pytest-dev/pytest-xdist/issues/830>`_: Fixed failed deploy of ``3.0.0`` release.
|
||||
|
||||
|
||||
pytest-xdist 3.0.0 (2022-10-24)
|
||||
===============================
|
||||
|
||||
Bug Fixes
|
||||
---------
|
||||
|
||||
- `#813 <https://github.com/pytest-dev/pytest-xdist/issues/813>`_: Cancel shutdown when a crashed worker is restarted.
|
||||
|
||||
|
||||
Deprecations
|
||||
------------
|
||||
|
||||
- `#825 <https://github.com/pytest-dev/pytest-xdist/issues/825>`_: The ``--rsyncdir`` command line argument and ``rsyncdirs`` config variable are deprecated.
|
||||
|
||||
The rsync feature will be removed in pytest-xdist 4.0.
|
||||
|
||||
- `#826 <https://github.com/pytest-dev/pytest-xdist/issues/826>`_: The ``--looponfail`` command line argument and ``looponfailroots`` config variable are deprecated.
|
||||
|
||||
The loop-on-fail feature will be removed in pytest-xdist 4.0.
|
||||
|
||||
|
||||
Improved Documentation
|
||||
----------------------
|
||||
|
||||
- `#791 <https://github.com/pytest-dev/pytest-xdist/issues/791>`_: Document the ``pytest_xdist_auto_num_workers`` hook.
|
||||
|
||||
- `#796 <https://github.com/pytest-dev/pytest-xdist/issues/796>`_: Added known limitations section to documentation.
|
||||
|
||||
- `#829 <https://github.com/pytest-dev/pytest-xdist/issues/829>`_: Document the ``-n logical`` option.
|
||||
|
||||
|
||||
Features
|
||||
--------
|
||||
|
||||
- `#792 <https://github.com/pytest-dev/pytest-xdist/issues/792>`_: The environment variable ``PYTEST_XDIST_AUTO_NUM_WORKERS`` can now be used to
|
||||
specify the default for ``-n auto`` and ``-n logical``.
|
||||
|
||||
- `#812 <https://github.com/pytest-dev/pytest-xdist/issues/812>`_: Partially restore old initial batch distribution algorithm in ``LoadScheduling``.
|
||||
|
||||
pytest orders tests for optimal sequential execution - i. e. avoiding
|
||||
unnecessary setup and teardown of fixtures. So executing tests in consecutive
|
||||
chunks is important for optimal performance.
|
||||
|
||||
In v1.14, initial test distribution in ``LoadScheduling`` was changed to
|
||||
round-robin, optimized for the corner case, when the number of tests is less
|
||||
than ``2 * number of nodes``. At the same time, it became worse for all other
|
||||
cases.
|
||||
|
||||
For example: if some tests use some "heavy" fixture, and these tests fit into
|
||||
the initial batch, with round-robin distribution the fixture will be created
|
||||
``min(n_tests, n_workers)`` times, no matter how many other tests there are.
|
||||
|
||||
With the old algorithm (before v1.14), if there are enough tests not using
|
||||
the fixture, the fixture was created only once.
|
||||
|
||||
So restore the old behavior for typical cases where the number of tests is
|
||||
much greater than the number of workers (or, strictly speaking, when there
|
||||
are at least 2 tests for every node).
|
||||
|
||||
|
||||
Removals
|
||||
--------
|
||||
|
||||
- `#468 <https://github.com/pytest-dev/pytest-xdist/issues/468>`_: The ``--boxed`` command-line option has been removed. If you still need this functionality, install `pytest-forked <https://pypi.org/project/pytest-forked>`__ separately.
|
||||
|
||||
|
||||
Trivial Changes
|
||||
---------------
|
||||
|
||||
- `#468 <https://github.com/pytest-dev/pytest-xdist/issues/468>`_: The ``py`` dependency has been dropped.
|
||||
|
||||
- `#822 <https://github.com/pytest-dev/pytest-xdist/issues/822>`_: Replace internal usage of ``py.log`` with a custom solution (but with the same interface).
|
||||
|
||||
- `#823 <https://github.com/pytest-dev/pytest-xdist/issues/823>`_: Remove usage of ``py._pydir`` as an rsync candidate.
|
||||
|
||||
- `#824 <https://github.com/pytest-dev/pytest-xdist/issues/824>`_: Replace internal usages of ``py.path.local`` by ``pathlib.Path``.
|
||||
|
||||
|
||||
pytest-xdist 2.5.0 (2021-12-10)
|
||||
===============================
|
||||
|
||||
Deprecations and Removals
|
||||
-------------------------
|
||||
|
||||
- `#468 <https://github.com/pytest-dev/pytest-xdist/issues/468>`_: The ``--boxed`` command line argument is deprecated. Install `pytest-forked <https://pypi.org/project/pytest-forked>`__ and use ``--forked`` instead. pytest-xdist 3.0.0 will remove the ``--boxed`` argument and ``pytest-forked`` dependency.
|
||||
|
||||
|
||||
Features
|
||||
--------
|
||||
|
||||
- `#722 <https://github.com/pytest-dev/pytest-xdist/issues/722>`_: Full compatibility with pytest 7 - no deprecation warnings or use of legacy features.
|
||||
|
||||
- `#733 <https://github.com/pytest-dev/pytest-xdist/issues/733>`_: New ``--dist=loadgroup`` option, which ensures all tests marked with ``@pytest.mark.xdist_group`` run in the same session/worker. Other tests run distributed as in ``--dist=load``.
|
||||
|
||||
|
||||
Trivial Changes
|
||||
---------------
|
||||
|
||||
- `#708 <https://github.com/pytest-dev/pytest-xdist/issues/708>`_: Use ``@pytest.hookspec`` decorator to declare hook options in ``newhooks.py`` to avoid warnings in ``pytest 7.0``.
|
||||
|
||||
- `#719 <https://github.com/pytest-dev/pytest-xdist/issues/719>`_: Use up-to-date ``setup.cfg``/``pyproject.toml`` packaging setup.
|
||||
|
||||
- `#720 <https://github.com/pytest-dev/pytest-xdist/issues/720>`_: Require pytest>=6.2.0.
|
||||
|
||||
- `#721 <https://github.com/pytest-dev/pytest-xdist/issues/721>`_: Started using type annotations and mypy checking internally. The types are incomplete and not published.
|
||||
|
||||
|
||||
pytest-xdist 2.4.0 (2021-09-20)
|
||||
===============================
|
||||
|
||||
Features
|
||||
--------
|
||||
|
||||
- `#696 <https://github.com/pytest-dev/pytest-xdist/issues/696>`_: On Linux, the process title now changes to indicate the current worker state (running/idle).
|
||||
|
||||
Depends on the `setproctitle <https://pypi.org/project/setproctitle/>`__ package, which can be installed with ``pip install pytest-xdist[setproctitle]``.
|
||||
|
||||
- `#704 <https://github.com/pytest-dev/pytest-xdist/issues/704>`_: Add support for Python 3.10.
|
||||
|
||||
|
||||
pytest-xdist 2.3.0 (2021-06-16)
|
||||
===============================
|
||||
|
||||
Deprecations and Removals
|
||||
-------------------------
|
||||
|
||||
- `#654 <https://github.com/pytest-dev/pytest-xdist/issues/654>`_: Python 3.5 is no longer supported.
|
||||
|
||||
|
||||
Features
|
||||
--------
|
||||
|
||||
- `#646 <https://github.com/pytest-dev/pytest-xdist/issues/646>`_: Add ``--numprocesses=logical`` flag, which automatically uses the number of logical CPUs available, instead of physical CPUs with ``auto``.
|
||||
|
||||
This is very useful for test suites which are not CPU-bound.
|
||||
|
||||
- `#650 <https://github.com/pytest-dev/pytest-xdist/issues/650>`_: Added new ``pytest_handlecrashitem`` hook to allow handling and rescheduling crashed items.
|
||||
|
||||
|
||||
Bug Fixes
|
||||
---------
|
||||
|
||||
- `#421 <https://github.com/pytest-dev/pytest-xdist/issues/421>`_: Copy the parent process sys.path into local workers, to work around execnet's python -c adding the current directory to sys.path.
|
||||
|
||||
- `#638 <https://github.com/pytest-dev/pytest-xdist/issues/638>`_: Fix issue caused by changing the branch name of the pytest repository.
|
||||
|
||||
|
||||
Trivial Changes
|
||||
---------------
|
||||
|
||||
- `#592 <https://github.com/pytest-dev/pytest-xdist/issues/592>`_: Replace master with controller where ever possible.
|
||||
|
||||
- `#643 <https://github.com/pytest-dev/pytest-xdist/issues/643>`_: Use 'main' to refer to pytest default branch in tox env names.
|
||||
|
||||
|
||||
pytest-xdist 2.2.1 (2021-02-09)
|
||||
===============================
|
||||
|
||||
Bug Fixes
|
||||
---------
|
||||
|
||||
- `#623 <https://github.com/pytest-dev/pytest-xdist/issues/623>`_: Gracefully handle the pending deprecation of Node.fspath by using config.rootpath for topdir.
|
||||
|
||||
|
||||
pytest-xdist 2.2.0 (2020-12-14)
|
||||
===============================
|
||||
|
||||
Features
|
||||
--------
|
||||
|
||||
- `#608 <https://github.com/pytest-dev/pytest-xdist/issues/608>`_: Internal errors in workers are now propagated to the master node.
|
||||
|
||||
|
||||
pytest-xdist 2.1.0 (2020-08-25)
|
||||
===============================
|
||||
|
||||
Features
|
||||
--------
|
||||
|
||||
- `#585 <https://github.com/pytest-dev/pytest-xdist/issues/585>`_: New ``pytest_xdist_auto_num_workers`` hook can be implemented by plugins or ``conftest.py`` files to control the number of workers when ``--numprocesses=auto`` is given in the command-line.
|
||||
|
||||
|
||||
Trivial Changes
|
||||
---------------
|
||||
|
||||
- `#585 <https://github.com/pytest-dev/pytest-xdist/issues/585>`_: ``psutil`` has proven to make ``pytest-xdist`` installation in certain platforms and containers problematic, so to use it for automatic number of CPUs detection users need to install the ``psutil`` extra::
|
||||
|
||||
pip install pytest-xdist[psutil]
|
||||
|
||||
|
||||
pytest-xdist 2.0.0 (2020-08-12)
|
||||
===============================
|
||||
|
||||
Deprecations and Removals
|
||||
-------------------------
|
||||
|
||||
- `#541 <https://github.com/pytest-dev/pytest-xdist/issues/541>`_: Drop backward-compatibility "slave" aliases related to worker nodes. We deliberately moved away from this terminology years ago, and it seems like the right time to finish the deprecation and removal process.
|
||||
|
||||
- `#569 <https://github.com/pytest-dev/pytest-xdist/issues/569>`_: ``pytest-xdist`` no longer supports Python 2.7.
|
||||
|
||||
|
||||
Features
|
||||
--------
|
||||
|
||||
- `#504 <https://github.com/pytest-dev/pytest-xdist/issues/504>`_: New functions ``xdist.is_xdist_worker``, ``xdist.is_xdist_master``, ``xdist.get_xdist_worker_id``, to easily identify the current node.
|
||||
|
||||
|
||||
Bug Fixes
|
||||
---------
|
||||
|
||||
- `#471 <https://github.com/pytest-dev/pytest-xdist/issues/471>`_: Fix issue with Rsync reporting in quiet mode.
|
||||
|
||||
- `#553 <https://github.com/pytest-dev/pytest-xdist/issues/553>`_: When using ``-n auto``, count the number of physical CPU cores instead of logical ones.
|
||||
|
||||
|
||||
Trivial Changes
|
||||
---------------
|
||||
|
||||
- `#541 <https://github.com/pytest-dev/pytest-xdist/issues/541>`_: ``pytest-xdist`` now requires ``pytest>=6.0``.
|
||||
|
||||
|
||||
pytest-xdist 1.34.0 (2020-07-27)
|
||||
================================
|
||||
|
||||
|
||||
31
ISSUES.txt
31
ISSUES.txt
@@ -1,31 +0,0 @@
|
||||
next release critical
|
||||
-----------------------------------------------
|
||||
tag: bug
|
||||
|
||||
miserably fails: --dist=each --tx popen --tx socket=...
|
||||
|
||||
|
||||
rename / hooks
|
||||
-----------------------------------------------
|
||||
tag: bug
|
||||
|
||||
node -> slave
|
||||
transition for hooks?
|
||||
configure_node -> configure_slave
|
||||
|
||||
allow to remotely run xdist tests with xdist
|
||||
-----------------------------------------------
|
||||
tag: feature
|
||||
|
||||
allow to run xdist own tests using its own mechanism.
|
||||
currently this doesn't work because the remote side
|
||||
has no pytest plugin. How to configure/do
|
||||
register "xdist.plugin" on the remote side?
|
||||
|
||||
see to avoid any "from _pytest" internal imports
|
||||
-----------------------------------------------
|
||||
tag: feature
|
||||
|
||||
currently tests and even xdist core code imports
|
||||
names from the internal _pytest namespace.
|
||||
See to avoid it.
|
||||
76
OVERVIEW.md
76
OVERVIEW.md
@@ -1,76 +0,0 @@
|
||||
# Overview #
|
||||
|
||||
`xdist` works by spawning one or more **workers**, which are controlled
|
||||
by the **master**. Each **worker** is responsible for performing
|
||||
a full test collection and afterwards running tests as dictated by the **master**.
|
||||
|
||||
The execution flow is:
|
||||
|
||||
1. **master** spawns one or more **workers** at the beginning of
|
||||
the test session. The communication between **master** and **worker** nodes makes use of
|
||||
[execnet](http://codespeak.net/execnet/) and its [gateways](http://codespeak.net/execnet/basics.html#gateways-bootstrapping-python-interpreters).
|
||||
The actual interpreters executing the code for the **workers** might
|
||||
be remote or local.
|
||||
|
||||
1. Each **worker** itself is a mini pytest runner. **workers** at this
|
||||
point perform a full test collection, sending back the collected
|
||||
test-ids back to the **master** which does not
|
||||
perform any collection itself.
|
||||
|
||||
1. The **master** receives the result of the collection from all nodes.
|
||||
At this point the **master** performs some sanity check to ensure that
|
||||
all **workers** collected the same tests (including order), bailing out otherwise.
|
||||
If all is well, it converts the list of test-ids into a list of simple
|
||||
indexes, where each index corresponds to the position of that test in the
|
||||
original collection list. This works because all nodes have the same
|
||||
collection list, and saves bandwidth because the **master** can now tell
|
||||
one of the workers to just *execute test index 3* index of passing the
|
||||
full test id.
|
||||
|
||||
1. If **dist-mode** is **each**: the **master** just sends the full list
|
||||
of test indexes to each node at this moment.
|
||||
|
||||
1. If **dist-mode** is **load**: the **master** takes around 25% of the
|
||||
tests and sends them one by one to each **worker** in a round robin
|
||||
fashion. The rest of the tests will be distributed later as **workers**
|
||||
finish tests (see below).
|
||||
|
||||
1. Note that `pytest_xdist_make_scheduler` hook can be used to implement custom tests distribution logic.
|
||||
|
||||
1. **workers** re-implement `pytest_runtestloop`: pytest's default implementation
|
||||
basically loops over all collected items in the `session` object and executes
|
||||
the `pytest_runtest_protocol` for each test item, but in xdist **workers** sit idly
|
||||
waiting for **master** to send tests for execution. As tests are
|
||||
received by **workers**, `pytest_runtest_protocol` is executed for each test.
|
||||
Here it worth noting an implementation detail: **workers** always must keep at
|
||||
least one test item on their queue due to how the `pytest_runtest_protocol(item, nextitem)`
|
||||
hook is defined: in order to pass the `nextitem` to the hook, the worker must wait for more
|
||||
instructions from master before executing that remaining test. If it receives more tests,
|
||||
then it can safely call `pytest_runtest_protocol` because it knows what the `nextitem` parameter will be.
|
||||
If it receives a "shutdown" signal, then it can execute the hook passing `nextitem` as `None`.
|
||||
|
||||
1. As tests are started and completed at the **workers**, the results are sent
|
||||
back to the **master**, which then just forwards the results to
|
||||
the appropriate pytest hooks: `pytest_runtest_logstart` and
|
||||
`pytest_runtest_logreport`. This way other plugins (for example `junitxml`)
|
||||
can work normally. The **master** (when in dist-mode **load**)
|
||||
decides to send more tests to a node when a test completes, using
|
||||
some heuristics such as test durations and how many tests each **worker**
|
||||
still has to run.
|
||||
|
||||
1. When the **master** has no more pending tests it will
|
||||
send a "shutdown" signal to all **workers**, which will then run their
|
||||
remaining tests to completion and shut down. At this point the
|
||||
**master** will sit waiting for **workers** to shut down, still
|
||||
processing events such as `pytest_runtest_logreport`.
|
||||
|
||||
## FAQ ##
|
||||
|
||||
> Why does each worker do its own collection, as opposed to having
|
||||
the master collect once and distribute from that collection to the workers?
|
||||
|
||||
If collection was performed by master then it would have to
|
||||
serialize collected items to send them through the wire, as workers live in another process.
|
||||
The problem is that test items are not easily (impossible?) to serialize, as they contain references to
|
||||
the test functions, fixture managers, config objects, etc. Even if one manages to serialize it,
|
||||
it seems it would be very hard to get it right and easy to break by any small change in pytest.
|
||||
358
README.rst
358
README.rst
@@ -1,4 +1,6 @@
|
||||
|
||||
============
|
||||
pytest-xdist
|
||||
============
|
||||
|
||||
.. image:: http://img.shields.io/pypi/v/pytest-xdist.svg
|
||||
:alt: PyPI version
|
||||
@@ -11,355 +13,21 @@
|
||||
:alt: Python versions
|
||||
:target: https://pypi.python.org/pypi/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
|
||||
.. image:: https://github.com/pytest-dev/pytest-xdist/workflows/build/badge.svg
|
||||
:target: https://github.com/pytest-dev/pytest-xdist/actions
|
||||
|
||||
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
|
||||
:target: https://github.com/ambv/black
|
||||
|
||||
xdist: pytest distributed testing plugin
|
||||
========================================
|
||||
The `pytest-xdist`_ plugin extends pytest with new test execution modes, the most used being distributing
|
||||
tests across multiple CPUs to speed up test execution::
|
||||
|
||||
The `pytest-xdist`_ plugin extends pytest with some unique
|
||||
test execution modes:
|
||||
pytest -n auto
|
||||
|
||||
* test run parallelization_: if you have multiple CPUs or hosts you can use
|
||||
those for a combined test run. This allows to speed up
|
||||
development or to use special resources of `remote machines`_.
|
||||
With this call, pytest will spawn a number of workers processes equal to the number of available CPUs, and distribute
|
||||
the tests randomly across them.
|
||||
|
||||
Documentation
|
||||
=============
|
||||
|
||||
* ``--looponfail``: run your tests repeatedly in a subprocess. After each run
|
||||
pytest waits until a file in your project changes and then re-runs
|
||||
the previously failing tests. This is repeated until all tests pass
|
||||
after which again a full run is performed.
|
||||
|
||||
* `Multi-Platform`_ coverage: you can specify different Python interpreters
|
||||
or different platforms and run tests in parallel on all of them.
|
||||
|
||||
Before running tests remotely, ``pytest`` efficiently "rsyncs" your
|
||||
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::
|
||||
|
||||
pip install pytest-xdist
|
||||
|
||||
or use the package in develop/in-place mode with
|
||||
a checkout of the `pytest-xdist repository`_ ::
|
||||
|
||||
pip install --editable .
|
||||
|
||||
.. _parallelization:
|
||||
|
||||
Speed up test runs by sending tests to multiple CPUs
|
||||
----------------------------------------------------
|
||||
|
||||
To send tests to multiple CPUs, use the ``-n`` (or ``-numprocesses``) option::
|
||||
|
||||
pytest -n NUMCPUS
|
||||
|
||||
Pass ``-n auto`` to use as many processes as your computer has CPU cores. This
|
||||
can lead to considerable speed ups, especially if your test suite takes a
|
||||
noticeable amount of time.
|
||||
|
||||
If a test crashes a worker, pytest-xdist will automatically restart that worker
|
||||
and report the test’s failure. You can use the ``--max-worker-restart`` option
|
||||
to limit the number of worker restarts that are allowed, or disable restarting
|
||||
altogether using ``--max-worker-restart 0``.
|
||||
|
||||
By default, using ``--numprocesses`` will send pending tests to any worker that
|
||||
is available, without any guaranteed order. You can change the test
|
||||
distribution algorithm this with the ``--dist`` option. It takes these values:
|
||||
|
||||
* ``--dist no``: The default algorithm, distributing one test at a time.
|
||||
|
||||
* ``--dist loadscope``: Tests are grouped by **module** for *test functions*
|
||||
and by **class** for *test methods*. Groups are distributed to available
|
||||
workers as whole units. This guarantees 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. Grouping by class takes priority over grouping by
|
||||
module.
|
||||
|
||||
* ``--dist loadfile``: Tests are grouped by their containing file. Groups are
|
||||
distributed to available workers as whole units. This guarantees that all
|
||||
tests in a file run in the same worker.
|
||||
|
||||
Making session-scoped fixtures execute only once
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
``pytest-xdist`` is designed so that each worker process will perform its own collection and execute
|
||||
a subset of all tests. This means that tests in different processes requesting a high-level
|
||||
scoped fixture (for example ``session``) will execute the fixture code more than once, which
|
||||
breaks expectations and might be undesired in certain situations.
|
||||
|
||||
While ``pytest-xdist`` does not have a builtin support for ensuring a session-scoped fixture is
|
||||
executed exactly once, this can be achieved by using a lock file for inter-process communication.
|
||||
|
||||
The example below needs to execute the fixture ``session_data`` only once (because it is
|
||||
resource intensive, or needs to execute only once to define configuration options, etc), so it makes
|
||||
use of a `FileLock <https://pypi.org/project/filelock/>`_ to produce the fixture data only once
|
||||
when the first process requests the fixture, while the other processes will then read
|
||||
the data from a file.
|
||||
|
||||
Here is the code:
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
import json
|
||||
|
||||
import pytest
|
||||
from filelock import FileLock
|
||||
|
||||
|
||||
@pytest.fixture(scope="session")
|
||||
def session_data(tmp_path_factory, worker_id):
|
||||
if not worker_id:
|
||||
# not executing in with multiple workers, just produce the data and let
|
||||
# pytest's fixture caching do its job
|
||||
return produce_expensive_data()
|
||||
|
||||
# get the temp directory shared by all workers
|
||||
root_tmp_dir = tmp_path_factory.getbasetemp().parent
|
||||
|
||||
fn = root_tmp_dir / "data.json"
|
||||
with FileLock(str(fn) + ".lock"):
|
||||
if fn.is_file():
|
||||
data = json.loads(fn.read_text())
|
||||
else:
|
||||
data = produce_expensive_data()
|
||||
fn.write_text(json.dumps(data))
|
||||
return data
|
||||
|
||||
|
||||
The example above can also be use in cases a fixture needs to execute exactly once per test session, like
|
||||
initializing a database service and populating initial tables.
|
||||
|
||||
This technique might not work for every case, but should be a starting point for many situations
|
||||
where executing a high-scope fixture exactly once is important.
|
||||
|
||||
Running tests in a Python subprocess
|
||||
------------------------------------
|
||||
|
||||
To instantiate a python3.5 subprocess and send tests to it, you may type::
|
||||
|
||||
pytest -d --tx popen//python=python3.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=python3.5
|
||||
|
||||
then three subprocesses would be created and tests
|
||||
will be load-balanced across these three processes.
|
||||
|
||||
.. _boxed:
|
||||
|
||||
Running tests in a boxed subprocess
|
||||
-----------------------------------
|
||||
|
||||
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
|
||||
have a ssh-reachable machine ``myhost``. Then
|
||||
you can ad-hoc distribute your tests by typing::
|
||||
|
||||
pytest -d --tx ssh=myhostpopen --rsyncdir mypkg mypkg
|
||||
|
||||
This will synchronize your :code:`mypkg` package directory
|
||||
to a remote ssh account and then locally collect tests
|
||||
and send them to remote places for execution.
|
||||
|
||||
You can specify multiple :code:`--rsyncdir` directories
|
||||
to be sent to the remote side.
|
||||
|
||||
.. note::
|
||||
|
||||
For pytest to collect and send tests correctly
|
||||
you not only need to make sure all code and tests
|
||||
directories are rsynced, but that any test (sub) directory
|
||||
also has an :code:`__init__.py` file because internally
|
||||
pytest references tests as a fully qualified python
|
||||
module path. **You will otherwise get strange errors**
|
||||
during setup of the remote side.
|
||||
|
||||
|
||||
You can specify multiple :code:`--rsyncignore` glob patterns
|
||||
to be ignored when file are sent to the remote side.
|
||||
There are also internal ignores: :code:`.*, *.pyc, *.pyo, *~`
|
||||
Those you cannot override using rsyncignore command-line or
|
||||
ini-file option(s).
|
||||
|
||||
|
||||
Sending tests to remote Socket Servers
|
||||
--------------------------------------
|
||||
|
||||
Download the single-module `socketserver.py`_ Python program
|
||||
and run it like this::
|
||||
|
||||
python socketserver.py
|
||||
|
||||
It will tell you that it starts listening on the default
|
||||
port. You can now on your home machine specify this
|
||||
new socket host with something like this::
|
||||
|
||||
pytest -d --tx socket=192.168.1.102:8888 --rsyncdir mypkg mypkg
|
||||
|
||||
|
||||
.. _`atonce`:
|
||||
.. _`Multi-Platform`:
|
||||
|
||||
|
||||
Running tests on many platforms at once
|
||||
---------------------------------------
|
||||
|
||||
The basic command to run tests on multiple platforms is::
|
||||
|
||||
pytest --dist=each --tx=spec1 --tx=spec2
|
||||
|
||||
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`_.
|
||||
|
||||
.. _`xspec syntax`: http://codespeak.net/execnet/basics.html#xspec
|
||||
|
||||
.. _`socketserver.py`: http://bitbucket.org/hpk42/execnet/raw/2af991418160/execnet/script/socketserver.py
|
||||
|
||||
.. _`execnet`: http://codespeak.net/execnet
|
||||
|
||||
Identifying the worker process during a test
|
||||
--------------------------------------------
|
||||
|
||||
*New in version 1.15.*
|
||||
|
||||
If you need to determine the identity of a worker process in
|
||||
a test or fixture, you may use the ``worker_id`` fixture to do so:
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
@pytest.fixture()
|
||||
def user_account(worker_id):
|
||||
""" use a different account in each xdist worker """
|
||||
return "account_%s" % worker_id
|
||||
|
||||
When ``xdist`` is disabled (running with ``-n0`` for example), then
|
||||
``worker_id`` will return ``"master"``.
|
||||
|
||||
Additionally, worker processes have the following environment variables
|
||||
defined:
|
||||
|
||||
* ``PYTEST_XDIST_WORKER``: the name of the worker, e.g., ``"gw2"``.
|
||||
* ``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 the ``worker_id`` attribute.
|
||||
|
||||
|
||||
Uniquely identifying the current test run
|
||||
-----------------------------------------
|
||||
|
||||
*New in version 1.32.*
|
||||
|
||||
If you need to globally distinguish one test run from others in your
|
||||
workers, you can use the ``testrun_uid`` fixture. For instance, let's say you
|
||||
wanted to create a separate database for each test run:
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
import pytest
|
||||
from posix_ipc import Semaphore, O_CREAT
|
||||
|
||||
@pytest.fixture(scope="session", autouse=True)
|
||||
def create_unique_database(testrun_uid):
|
||||
""" create a unique database for this particular test run """
|
||||
database_url = f"psql://myapp-{testrun_uid}"
|
||||
|
||||
with Semaphore(f"/{testrun_uid}-lock", flags=O_CREAT, initial_value=1):
|
||||
if not database_exists(database_url):
|
||||
create_database(database_url)
|
||||
|
||||
@pytest.fixture()
|
||||
def db(testrun_uid):
|
||||
""" retrieve unique database """
|
||||
database_url = f"psql://myapp-{testrun_uid}"
|
||||
return database_get_instance(database_url)
|
||||
|
||||
|
||||
Additionally, during a test run, the following environment variable is defined:
|
||||
|
||||
* ``PYTEST_XDIST_TESTRUNUID``: the unique id of the test run.
|
||||
|
||||
Accessing ``sys.argv`` from the master node in workers
|
||||
------------------------------------------------------
|
||||
|
||||
To access the ``sys.argv`` passed to the command-line of the master node, use
|
||||
``request.config.workerinput["mainargv"]``.
|
||||
|
||||
|
||||
Specifying test exec environments in an ini file
|
||||
------------------------------------------------
|
||||
|
||||
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
|
||||
|
||||
[pytest]
|
||||
addopts = -n3
|
||||
|
||||
You can also add default environments like this:
|
||||
|
||||
.. code-block:: ini
|
||||
|
||||
[pytest]
|
||||
addopts = --tx ssh=myhost//python=python3.5 --tx ssh=myhost//python=python3.6
|
||||
|
||||
and then just type::
|
||||
|
||||
pytest --dist=each
|
||||
|
||||
to run tests in each of the environments.
|
||||
|
||||
|
||||
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:
|
||||
|
||||
.. code-block:: ini
|
||||
|
||||
[pytest]
|
||||
rsyncdirs = . mypkg helperpkg
|
||||
rsyncignore = .hg
|
||||
|
||||
These directory specifications are relative to the directory
|
||||
where the configuration file was found.
|
||||
|
||||
.. _`pytest-xdist`: http://pypi.python.org/pypi/pytest-xdist
|
||||
.. _`pytest-xdist repository`: https://github.com/pytest-dev/pytest-xdist
|
||||
.. _`pytest`: http://pytest.org
|
||||
Documentation is available at `Read The Docs <https://pytest-xdist.readthedocs.io>`__.
|
||||
|
||||
@@ -41,3 +41,5 @@ To publish a new release ``X.Y.Z``, the steps are as follows:
|
||||
$ git push git@github.com:pytest-dev/pytest-xdist.git v$VERSION
|
||||
|
||||
That will build the package and publish it on ``PyPI`` automatically.
|
||||
|
||||
#. Merge the release PR to `master`.
|
||||
1
docs/.gitignore
vendored
Normal file
1
docs/.gitignore
vendored
Normal file
@@ -0,0 +1 @@
|
||||
_build/
|
||||
5
docs/changelog.rst
Normal file
5
docs/changelog.rst
Normal file
@@ -0,0 +1,5 @@
|
||||
=========
|
||||
Changelog
|
||||
=========
|
||||
|
||||
.. include:: ../CHANGELOG.rst
|
||||
55
docs/conf.py
Normal file
55
docs/conf.py
Normal file
@@ -0,0 +1,55 @@
|
||||
# Configuration file for the Sphinx documentation builder.
|
||||
#
|
||||
# This file only contains a selection of the most common options. For a full
|
||||
# list see the documentation:
|
||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
||||
|
||||
# -- Path setup --------------------------------------------------------------
|
||||
|
||||
# If extensions (or modules to document with autodoc) are in another directory,
|
||||
# add these directories to sys.path here. If the directory is relative to the
|
||||
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||
#
|
||||
# import os
|
||||
# import sys
|
||||
# sys.path.insert(0, os.path.abspath('.'))
|
||||
|
||||
|
||||
# -- Project information -----------------------------------------------------
|
||||
|
||||
project = "pytest-xdist"
|
||||
copyright = "2022, holger krekel and contributors"
|
||||
author = "holger krekel and contributors"
|
||||
|
||||
master_doc = "index"
|
||||
|
||||
# -- General configuration ---------------------------------------------------
|
||||
|
||||
# Add any Sphinx extension module names here, as strings. They can be
|
||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||
# ones.
|
||||
extensions = [
|
||||
"sphinx_rtd_theme",
|
||||
"sphinx.ext.autodoc",
|
||||
]
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ["_templates"]
|
||||
|
||||
# List of patterns, relative to source directory, that match files and
|
||||
# directories to ignore when looking for source files.
|
||||
# This pattern also affects html_static_path and html_extra_path.
|
||||
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
|
||||
|
||||
|
||||
# -- Options for HTML output -------------------------------------------------
|
||||
|
||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
# a list of builtin themes.
|
||||
#
|
||||
html_theme = "sphinx_rtd_theme"
|
||||
|
||||
# Add any paths that contain custom static files (such as style sheets) here,
|
||||
# relative to this directory. They are copied after the builtin static files,
|
||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||
# html_static_path = ['_static']
|
||||
7
docs/crash.rst
Normal file
7
docs/crash.rst
Normal file
@@ -0,0 +1,7 @@
|
||||
When tests crash
|
||||
================
|
||||
|
||||
If a test crashes a worker, pytest-xdist will automatically restart that worker
|
||||
and report the test’s failure. You can use the ``--max-worker-restart`` option
|
||||
to limit the number of worker restarts that are allowed, or disable restarting
|
||||
altogether using ``--max-worker-restart 0``.
|
||||
85
docs/distribution.rst
Normal file
85
docs/distribution.rst
Normal file
@@ -0,0 +1,85 @@
|
||||
.. _parallelization:
|
||||
|
||||
Running tests across multiple CPUs
|
||||
==================================
|
||||
|
||||
To send tests to multiple CPUs, use the ``-n`` (or ``--numprocesses``) option::
|
||||
|
||||
pytest -n auto
|
||||
|
||||
This can lead to considerable speed ups, especially if your test suite takes a
|
||||
noticeable amount of time.
|
||||
|
||||
With ``-n auto``, pytest-xdist will use as many processes as your computer
|
||||
has CPU cores.
|
||||
|
||||
Use ``-n logical`` to use the number of *logical* CPU cores rather than
|
||||
physical ones. This currently requires the ``psutils`` package to be installed;
|
||||
if it is not, pytest-xdist will fall back to ``-n auto`` behavior.
|
||||
|
||||
Pass a number, e.g. ``-n 8``, to specify the number of processes explicitly.
|
||||
|
||||
To specify a different meaning for ``-n auto`` and ``-n logical`` for your
|
||||
tests, you can:
|
||||
|
||||
* Set the environment variable ``PYTEST_XDIST_AUTO_NUM_WORKERS`` to the
|
||||
desired number of processes.
|
||||
|
||||
* Implement the ``pytest_xdist_auto_num_workers``
|
||||
`pytest hook <https://docs.pytest.org/en/latest/how-to/writing_plugins.html>`__
|
||||
(a ``pytest_xdist_auto_num_workers(config)`` function in e.g. ``conftest.py``)
|
||||
that returns the number of processes to use.
|
||||
The hook can use ``config.option.numprocesses`` to determine if the user
|
||||
asked for ``"auto"`` or ``"logical"``, and it can return ``None`` to fall
|
||||
back to the default.
|
||||
|
||||
If both the hook and environment variable are specified, the hook takes
|
||||
priority.
|
||||
|
||||
|
||||
Parallelization can be configured further with these options:
|
||||
|
||||
* ``--maxprocesses=maxprocesses``: limit the maximum number of workers to
|
||||
process the tests.
|
||||
|
||||
* ``--max-worker-restart``: maximum number of workers that can be restarted
|
||||
when crashed (set to zero to disable this feature).
|
||||
|
||||
The test distribution algorithm is configured with the ``--dist`` command-line option:
|
||||
|
||||
.. _distribution modes:
|
||||
|
||||
* ``--dist load`` **(default)**: Sends pending tests to any worker that is
|
||||
available, without any guaranteed order.
|
||||
|
||||
* ``--dist loadscope``: Tests are grouped by **module** for *test functions*
|
||||
and by **class** for *test methods*. Groups are distributed to available
|
||||
workers as whole units. This guarantees 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. Grouping by class takes priority over grouping by
|
||||
module.
|
||||
|
||||
* ``--dist loadfile``: Tests are grouped by their containing file. Groups are
|
||||
distributed to available workers as whole units. This guarantees that all
|
||||
tests in a file run in the same worker.
|
||||
|
||||
* ``--dist loadgroup``: Tests are grouped by the ``xdist_group`` mark. Groups are
|
||||
distributed to available workers as whole units. This guarantees that all
|
||||
tests with same ``xdist_group`` name run in the same worker.
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
@pytest.mark.xdist_group(name="group1")
|
||||
def test1():
|
||||
pass
|
||||
|
||||
|
||||
class TestA:
|
||||
@pytest.mark.xdist_group("group1")
|
||||
def test2():
|
||||
pass
|
||||
|
||||
This will make sure ``test1`` and ``TestA::test2`` will run in the same worker.
|
||||
Tests without the ``xdist_group`` mark are distributed normally as in the ``--dist=load`` mode.
|
||||
|
||||
* ``--dist no``: The normal pytest execution mode, runs one test at a time (no distribution at all).
|
||||
90
docs/how-it-works.rst
Normal file
90
docs/how-it-works.rst
Normal file
@@ -0,0 +1,90 @@
|
||||
How it works?
|
||||
=============
|
||||
|
||||
``xdist`` works by spawning one or more **workers**, which are
|
||||
controlled by the **controller**. Each **worker** is responsible for
|
||||
performing a full test collection and afterwards running tests as
|
||||
dictated by the **controller**.
|
||||
|
||||
The execution flow is:
|
||||
|
||||
1. **controller** spawns one or more **workers** at the beginning of the
|
||||
test session. The communication between **controller** and **worker**
|
||||
nodes makes use of `execnet <https://codespeak.net/execnet/>`__ and
|
||||
its
|
||||
`gateways <https://codespeak.net/execnet/basics.html#gateways-bootstrapping-python-interpreters>`__.
|
||||
The actual interpreters executing the code for the **workers** might
|
||||
be remote or local.
|
||||
|
||||
2. Each **worker** itself is a mini pytest runner. **workers** at this
|
||||
point perform a full test collection, sending back the collected
|
||||
test-ids back to the **controller** which does not perform any
|
||||
collection itself.
|
||||
|
||||
3. The **controller** receives the result of the collection from all
|
||||
nodes. At this point the **controller** performs some sanity check to
|
||||
ensure that all **workers** collected the same tests (including
|
||||
order), bailing out otherwise. If all is well, it converts the list
|
||||
of test-ids into a list of simple indexes, where each index
|
||||
corresponds to the position of that test in the original collection
|
||||
list. This works because all nodes have the same collection list, and
|
||||
saves bandwidth because the **controller** can now tell one of the
|
||||
workers to just *execute test index 3* index of passing the full test
|
||||
id.
|
||||
|
||||
4. If **dist-mode** is **each**: the **controller** just sends the full
|
||||
list of test indexes to each node at this moment.
|
||||
|
||||
5. If **dist-mode** is **load**: the **controller** takes around 25% of
|
||||
the tests and sends them one by one to each **worker** in a round
|
||||
robin fashion. The rest of the tests will be distributed later as
|
||||
**workers** finish tests (see below).
|
||||
|
||||
6. Note that ``pytest_xdist_make_scheduler`` hook can be used to
|
||||
implement custom tests distribution logic.
|
||||
|
||||
7. **workers** re-implement ``pytest_runtestloop``: pytest’s default
|
||||
implementation basically loops over all collected items in the
|
||||
``session`` object and executes the ``pytest_runtest_protocol`` for
|
||||
each test item, but in xdist **workers** sit idly waiting for
|
||||
**controller** to send tests for execution. As tests are received by
|
||||
**workers**, ``pytest_runtest_protocol`` is executed for each test.
|
||||
Here it worth noting an implementation detail: **workers** always
|
||||
must keep at least one test item on their queue due to how the
|
||||
``pytest_runtest_protocol(item, nextitem)`` hook is defined: in order
|
||||
to pass the ``nextitem`` to the hook, the worker must wait for more
|
||||
instructions from controller before executing that remaining test. If
|
||||
it receives more tests, then it can safely call
|
||||
``pytest_runtest_protocol`` because it knows what the ``nextitem``
|
||||
parameter will be. If it receives a “shutdown” signal, then it can
|
||||
execute the hook passing ``nextitem`` as ``None``.
|
||||
|
||||
8. As tests are started and completed at the **workers**, the results
|
||||
are sent back to the **controller**, which then just forwards the
|
||||
results to the appropriate pytest hooks: ``pytest_runtest_logstart``
|
||||
and ``pytest_runtest_logreport``. This way other plugins (for example
|
||||
``junitxml``) can work normally. The **controller** (when in
|
||||
dist-mode **load**) decides to send more tests to a node when a test
|
||||
completes, using some heuristics such as test durations and how many
|
||||
tests each **worker** still has to run.
|
||||
|
||||
9. When the **controller** has no more pending tests it will send a
|
||||
“shutdown” signal to all **workers**, which will then run their
|
||||
remaining tests to completion and shut down. At this point the
|
||||
**controller** will sit waiting for **workers** to shut down, still
|
||||
processing events such as ``pytest_runtest_logreport``.
|
||||
|
||||
FAQ
|
||||
---
|
||||
|
||||
**Question**: Why does each worker do its own collection, as opposed to having the
|
||||
controller collect once and distribute from that collection to the
|
||||
workers?
|
||||
|
||||
If collection was performed by controller then it would have to
|
||||
serialize collected items to send them through the wire, as workers live
|
||||
in another process. The problem is that test items are not easily
|
||||
(impossible?) to serialize, as they contain references to the test
|
||||
functions, fixture managers, config objects, etc. Even if one manages to
|
||||
serialize it, it seems it would be very hard to get it right and easy to
|
||||
break by any small change in pytest.
|
||||
233
docs/how-to.rst
Normal file
233
docs/how-to.rst
Normal file
@@ -0,0 +1,233 @@
|
||||
How-tos
|
||||
-------
|
||||
|
||||
This section show cases how to accomplish some specialized tasks with ``pytest-xdist``.
|
||||
|
||||
Identifying the worker process during a test
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
*New in version 1.15.*
|
||||
|
||||
If you need to determine the identity of a worker process in
|
||||
a test or fixture, you may use the ``worker_id`` fixture to do so:
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
@pytest.fixture()
|
||||
def user_account(worker_id):
|
||||
""" use a different account in each xdist worker """
|
||||
return "account_%s" % worker_id
|
||||
|
||||
When ``xdist`` is disabled (running with ``-n0`` for example), then
|
||||
``worker_id`` will return ``"master"``.
|
||||
|
||||
Worker processes also have the following environment variables
|
||||
defined:
|
||||
|
||||
.. envvar:: PYTEST_XDIST_WORKER
|
||||
|
||||
The name of the worker, e.g., ``"gw2"``.
|
||||
|
||||
.. envvar:: 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 the ``worker_id`` attribute.
|
||||
|
||||
Since version 2.0, the following functions are also available in the ``xdist`` module:
|
||||
|
||||
|
||||
.. autofunction:: xdist.is_xdist_worker
|
||||
.. autofunction:: xdist.is_xdist_controller
|
||||
.. autofunction:: xdist.is_xdist_master
|
||||
.. autofunction:: xdist.get_xdist_worker_id
|
||||
|
||||
Identifying workers from the system environment
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
*New in version 2.4*
|
||||
|
||||
If the `setproctitle`_ package is installed, ``pytest-xdist`` will use it to
|
||||
update the process title (command line) on its workers to show their current
|
||||
state. The titles used are ``[pytest-xdist running] file.py/node::id`` and
|
||||
``[pytest-xdist idle]``, visible in standard tools like ``ps`` and ``top`` on
|
||||
Linux, Mac OS X and BSD systems. For Windows, please follow `setproctitle`_'s
|
||||
pointer regarding the Process Explorer tool.
|
||||
|
||||
This is intended purely as an UX enhancement, e.g. to track down issues with
|
||||
long-running or CPU intensive tests. Errors in changing the title are ignored
|
||||
silently. Please try not to rely on the title format or title changes in
|
||||
external scripts.
|
||||
|
||||
.. _`setproctitle`: https://pypi.org/project/setproctitle/
|
||||
|
||||
|
||||
Uniquely identifying the current test run
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
*New in version 1.32.*
|
||||
|
||||
If you need to globally distinguish one test run from others in your
|
||||
workers, you can use the ``testrun_uid`` fixture. For instance, let's say you
|
||||
wanted to create a separate database for each test run:
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
import pytest
|
||||
from posix_ipc import Semaphore, O_CREAT
|
||||
|
||||
|
||||
@pytest.fixture(scope="session", autouse=True)
|
||||
def create_unique_database(testrun_uid):
|
||||
""" create a unique database for this particular test run """
|
||||
database_url = f"psql://myapp-{testrun_uid}"
|
||||
|
||||
with Semaphore(f"/{testrun_uid}-lock", flags=O_CREAT, initial_value=1):
|
||||
if not database_exists(database_url):
|
||||
create_database(database_url)
|
||||
|
||||
|
||||
@pytest.fixture()
|
||||
def db(testrun_uid):
|
||||
""" retrieve unique database """
|
||||
database_url = f"psql://myapp-{testrun_uid}"
|
||||
return database_get_instance(database_url)
|
||||
|
||||
|
||||
Additionally, during a test run, the following environment variable is defined:
|
||||
|
||||
.. envvar:: PYTEST_XDIST_TESTRUNUID
|
||||
|
||||
The unique id of the test run.
|
||||
|
||||
Accessing ``sys.argv`` from the controller node in workers
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
To access the ``sys.argv`` passed to the command-line of the controller node, use
|
||||
``request.config.workerinput["mainargv"]``.
|
||||
|
||||
|
||||
Specifying test exec environments in an ini file
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
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
|
||||
|
||||
[pytest]
|
||||
addopts = -n3
|
||||
|
||||
You can also add default environments like this:
|
||||
|
||||
.. code-block:: ini
|
||||
|
||||
[pytest]
|
||||
addopts = --tx ssh=myhost//python=python3.9 --tx ssh=myhost//python=python3.6
|
||||
|
||||
and then just type::
|
||||
|
||||
pytest --dist=each
|
||||
|
||||
to run tests in each of the environments.
|
||||
|
||||
|
||||
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:
|
||||
|
||||
.. code-block:: ini
|
||||
|
||||
[pytest]
|
||||
rsyncdirs = . mypkg helperpkg
|
||||
rsyncignore = .hg
|
||||
|
||||
These directory specifications are relative to the directory
|
||||
where the configuration file was found.
|
||||
|
||||
.. _`pytest-xdist`: http://pypi.python.org/pypi/pytest-xdist
|
||||
.. _`pytest-xdist repository`: https://github.com/pytest-dev/pytest-xdist
|
||||
.. _`pytest`: http://pytest.org
|
||||
|
||||
|
||||
Making session-scoped fixtures execute only once
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
``pytest-xdist`` is designed so that each worker process will perform its own collection and execute
|
||||
a subset of all tests. This means that tests in different processes requesting a high-level
|
||||
scoped fixture (for example ``session``) will execute the fixture code more than once, which
|
||||
breaks expectations and might be undesired in certain situations.
|
||||
|
||||
While ``pytest-xdist`` does not have a builtin support for ensuring a session-scoped fixture is
|
||||
executed exactly once, this can be achieved by using a lock file for inter-process communication.
|
||||
|
||||
The example below needs to execute the fixture ``session_data`` only once (because it is
|
||||
resource intensive, or needs to execute only once to define configuration options, etc), so it makes
|
||||
use of a `FileLock <https://pypi.org/project/filelock/>`_ to produce the fixture data only once
|
||||
when the first process requests the fixture, while the other processes will then read
|
||||
the data from a file.
|
||||
|
||||
Here is the code:
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
import json
|
||||
|
||||
import pytest
|
||||
from filelock import FileLock
|
||||
|
||||
|
||||
@pytest.fixture(scope="session")
|
||||
def session_data(tmp_path_factory, worker_id):
|
||||
if worker_id == "master":
|
||||
# not executing in with multiple workers, just produce the data and let
|
||||
# pytest's fixture caching do its job
|
||||
return produce_expensive_data()
|
||||
|
||||
# get the temp directory shared by all workers
|
||||
root_tmp_dir = tmp_path_factory.getbasetemp().parent
|
||||
|
||||
fn = root_tmp_dir / "data.json"
|
||||
with FileLock(str(fn) + ".lock"):
|
||||
if fn.is_file():
|
||||
data = json.loads(fn.read_text())
|
||||
else:
|
||||
data = produce_expensive_data()
|
||||
fn.write_text(json.dumps(data))
|
||||
return data
|
||||
|
||||
|
||||
The example above can also be use in cases a fixture needs to execute exactly once per test session, like
|
||||
initializing a database service and populating initial tables.
|
||||
|
||||
This technique might not work for every case, but should be a starting point for many situations
|
||||
where executing a high-scope fixture exactly once is important.
|
||||
|
||||
|
||||
Creating one log file for each worker
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
To create one log file for each worker with ``pytest-xdist``, you can leverage :envvar:`PYTEST_XDIST_WORKER`
|
||||
to generate a unique filename for each worker.
|
||||
|
||||
Example:
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
# content of conftest.py
|
||||
def pytest_configure(config):
|
||||
worker_id = os.environ.get("PYTEST_XDIST_WORKER")
|
||||
if worker_id is not None:
|
||||
log_file = config.getini("worker_log_file")
|
||||
logging.basicConfig(
|
||||
format=config.getini("log_file_format"),
|
||||
filename=f"tests_{worker_id}.log",
|
||||
level=config.getini("log_file_level"),
|
||||
)
|
||||
|
||||
|
||||
When running the tests with ``-n3``, for example, three files will be created in the current directory:
|
||||
``tests_gw0.log``, ``tests_gw1.log`` and ``tests_gw2.log``.
|
||||
63
docs/index.rst
Normal file
63
docs/index.rst
Normal file
@@ -0,0 +1,63 @@
|
||||
pytest-xdist
|
||||
============
|
||||
|
||||
The `pytest-xdist`_ plugin extends pytest with new test execution modes, the most used being distributing
|
||||
tests across multiple CPUs to speed up test execution::
|
||||
|
||||
pytest -n auto
|
||||
|
||||
With this call, pytest will spawn a number of workers processes equal to the number of available CPUs, and distribute
|
||||
the tests randomly across them.
|
||||
|
||||
.. note::
|
||||
Due to how pytest-xdist is implemented, the ``-s/--capture=no`` option does not work.
|
||||
|
||||
|
||||
Installation
|
||||
------------
|
||||
|
||||
Install the plugin with::
|
||||
|
||||
pip install pytest-xdist
|
||||
|
||||
|
||||
To use ``psutil`` for detection of the number of CPUs available, install the ``psutil`` extra::
|
||||
|
||||
pip install pytest-xdist[psutil]
|
||||
|
||||
Features
|
||||
--------
|
||||
|
||||
* Test run :ref:`parallelization`: tests can be executed across multiple CPUs or hosts.
|
||||
This allows to speed up development or to use special resources of :ref:`remote machines`.
|
||||
|
||||
* ``--looponfail``: run your tests repeatedly in a subprocess. After each run
|
||||
pytest waits until a file in your project changes and then re-runs
|
||||
the previously failing tests. This is repeated until all tests pass
|
||||
after which again a full run is performed (DEPRECATED).
|
||||
|
||||
* :ref:`Multi-Platform` coverage: you can specify different Python interpreters
|
||||
or different platforms and run tests in parallel on all of them.
|
||||
|
||||
Before running tests remotely, ``pytest`` efficiently "rsyncs" your
|
||||
program source code to the remote place.
|
||||
You may specify different Python versions and interpreters. It does not
|
||||
installs/synchronize dependencies however.
|
||||
|
||||
**Note**: this mode exists mostly for backward compatibility, as modern development
|
||||
relies on continuous integration for multi-platform testing.
|
||||
|
||||
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:caption: Contents:
|
||||
|
||||
distribution
|
||||
subprocess
|
||||
remote
|
||||
crash
|
||||
how-to
|
||||
how-it-works
|
||||
known-limitations
|
||||
changelog
|
||||
64
docs/known-limitations.rst
Normal file
64
docs/known-limitations.rst
Normal file
@@ -0,0 +1,64 @@
|
||||
Known limitations
|
||||
=================
|
||||
|
||||
pytest-xdist has some limitations that may be supported in pytest but can't be supported in pytest-xdist.
|
||||
|
||||
Order and amount of test must be consistent
|
||||
-------------------------------------------
|
||||
|
||||
Is is not possible to have tests that differ in order or their amount across workers.
|
||||
|
||||
This is especially true with ``pytest.mark.parametrize``, when values are produced with sets or other unordered iterables/generators.
|
||||
|
||||
|
||||
Example:
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
import pytest
|
||||
|
||||
|
||||
@pytest.mark.parametrize("param", {"a", "b"})
|
||||
def test_pytest_parametrize_unordered(param):
|
||||
pass
|
||||
|
||||
In the example above, the fact that ``set`` are not necessarily ordered can cause different workers
|
||||
to collect tests in different order, which will throw an error.
|
||||
|
||||
Workarounds
|
||||
~~~~~~~~~~~
|
||||
|
||||
A solution to this is to guarantee that the parametrized values have the same order.
|
||||
|
||||
Some solutions:
|
||||
|
||||
* Convert your sequence to a ``list``.
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
import pytest
|
||||
|
||||
|
||||
@pytest.mark.parametrize("param", ["a", "b"])
|
||||
def test_pytest_parametrize_unordered(param):
|
||||
pass
|
||||
|
||||
* Sort your sequence, guaranteeing order.
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
import pytest
|
||||
|
||||
|
||||
@pytest.mark.parametrize("param", sorted({"a", "b"}))
|
||||
def test_pytest_parametrize_unordered(param):
|
||||
pass
|
||||
|
||||
Output (stdout and stderr) from workers
|
||||
---------------------------------------
|
||||
|
||||
The ``-s``/``--capture=no`` option is meant to disable pytest capture, so users can then see stdout and stderr output in the terminal from tests and application code in real time.
|
||||
|
||||
However this option does not work with ``pytest-xdist`` because `execnet <https://github.com/pytest-dev/execnet>`__ the underlying library used for communication between master and workers, does not support transferring stdout/stderr from workers.
|
||||
|
||||
Currenlty there are no plans ot support this in ``pytest-xdist``.
|
||||
83
docs/remote.rst
Normal file
83
docs/remote.rst
Normal file
@@ -0,0 +1,83 @@
|
||||
|
||||
.. _`Multi-Platform`:
|
||||
.. _`remote machines`:
|
||||
|
||||
Sending tests to remote SSH accounts
|
||||
====================================
|
||||
|
||||
.. deprecated:: 3.0
|
||||
|
||||
.. warning::
|
||||
|
||||
This feature is deprecated because the support for ``rsync`` is faulty
|
||||
in terms of reproducing the development environment in the remote
|
||||
worker, and there is no clear solution moving forward.
|
||||
|
||||
This feature is scheduled to be removed in release 4.0, to let the team
|
||||
focus on a smaller set of features.
|
||||
|
||||
Suppose you have a package ``mypkg`` which contains some
|
||||
tests that you can successfully run locally. And you
|
||||
have a ssh-reachable machine ``myhost``. Then
|
||||
you can ad-hoc distribute your tests by typing::
|
||||
|
||||
pytest -d --rsyncdir mypkg --tx ssh=myhostpopen mypkg/tests/unit/test_something.py
|
||||
|
||||
This will synchronize your :code:`mypkg` package directory
|
||||
to a remote ssh account and then locally collect tests
|
||||
and send them to remote places for execution.
|
||||
|
||||
You can specify multiple :code:`--rsyncdir` directories
|
||||
to be sent to the remote side.
|
||||
|
||||
.. note::
|
||||
|
||||
For pytest to collect and send tests correctly
|
||||
you not only need to make sure all code and tests
|
||||
directories are rsynced, but that any test (sub) directory
|
||||
also has an :code:`__init__.py` file because internally
|
||||
pytest references tests as a fully qualified python
|
||||
module path. **You will otherwise get strange errors**
|
||||
during setup of the remote side.
|
||||
|
||||
|
||||
You can specify multiple :code:`--rsyncignore` glob patterns
|
||||
to be ignored when file are sent to the remote side.
|
||||
There are also internal ignores: :code:`.*, *.pyc, *.pyo, *~`
|
||||
Those you cannot override using rsyncignore command-line or
|
||||
ini-file option(s).
|
||||
|
||||
|
||||
Sending tests to remote Socket Servers
|
||||
--------------------------------------
|
||||
|
||||
Download the single-module `socketserver.py`_ Python program
|
||||
and run it like this::
|
||||
|
||||
python socketserver.py
|
||||
|
||||
It will tell you that it starts listening on the default
|
||||
port. You can now on your home machine specify this
|
||||
new socket host with something like this::
|
||||
|
||||
pytest -d --tx socket=192.168.1.102:8888 --rsyncdir mypkg
|
||||
|
||||
|
||||
|
||||
Running tests on many platforms at once
|
||||
---------------------------------------
|
||||
|
||||
The basic command to run tests on multiple platforms is::
|
||||
|
||||
pytest --dist=each --tx=spec1 --tx=spec2
|
||||
|
||||
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`_.
|
||||
|
||||
.. _`xspec syntax`: https://codespeak.net/execnet/basics.html#xspec
|
||||
|
||||
.. _`execnet`: https://codespeak.net/execnet
|
||||
|
||||
.. _`socketserver.py`: https://raw.githubusercontent.com/pytest-dev/execnet/master/execnet/script/socketserver.py
|
||||
16
docs/subprocess.rst
Normal file
16
docs/subprocess.rst
Normal file
@@ -0,0 +1,16 @@
|
||||
Running tests in a Python subprocess
|
||||
====================================
|
||||
|
||||
To instantiate a ``python3.9`` subprocess and send tests to it, you may type::
|
||||
|
||||
pytest -d --tx popen//python=python3.9
|
||||
|
||||
This will start a subprocess which is run with the ``python3.9``
|
||||
Python interpreter, found in your system binary lookup path.
|
||||
|
||||
If you prefix the --tx option value like this::
|
||||
|
||||
--tx 3*popen//python=python3.9
|
||||
|
||||
then three subprocesses would be created and tests
|
||||
will be load-balanced across these three processes.
|
||||
@@ -1,9 +1,9 @@
|
||||
.. note::
|
||||
.. warning::
|
||||
|
||||
Since 1.19.0, the actual implementation of the ``--boxed`` option has been moved to a
|
||||
separate plugin, `pytest-forked <https://github.com/pytest-dev/pytest-forked>`_
|
||||
which can be installed independently. The ``--boxed`` command-line options remains
|
||||
for backward compatibility reasons.
|
||||
which can be installed independently. The ``--boxed`` command-line option is deprecated
|
||||
and will be removed in pytest-xdist 3.0.0; use ``--forked`` from pytest-forked instead.
|
||||
|
||||
|
||||
If your testing involves C or C++ libraries you might have to deal
|
||||
|
||||
@@ -1,3 +1,15 @@
|
||||
[build-system]
|
||||
requires = [
|
||||
# sync with setup.py until we discard non-pep-517/518
|
||||
"setuptools>=45.0",
|
||||
"setuptools-scm[toml]>=6.2.3",
|
||||
"wheel",
|
||||
]
|
||||
build-backend = "setuptools.build_meta"
|
||||
|
||||
[tool.setuptools_scm]
|
||||
write_to = "src/xdist/_version.py"
|
||||
|
||||
[tool.towncrier]
|
||||
package = "xdist"
|
||||
filename = "CHANGELOG.rst"
|
||||
@@ -5,32 +17,23 @@ directory = "changelog/"
|
||||
title_format = "pytest-xdist {version} ({project_date})"
|
||||
template = "changelog/_template.rst"
|
||||
|
||||
[[tool.towncrier.type]]
|
||||
directory = "removal"
|
||||
name = "Deprecations and Removals"
|
||||
showcontent = true
|
||||
[tool.towncrier.fragment.removal]
|
||||
name = "Removals"
|
||||
|
||||
[[tool.towncrier.type]]
|
||||
directory = "feature"
|
||||
name = "Features"
|
||||
showcontent = true
|
||||
[tool.towncrier.fragment.deprecation]
|
||||
name = "Deprecations"
|
||||
|
||||
[[tool.towncrier.type]]
|
||||
directory = "bugfix"
|
||||
name = "Bug Fixes"
|
||||
showcontent = true
|
||||
[tool.towncrier.fragment.feature]
|
||||
name = "Features"
|
||||
|
||||
[[tool.towncrier.type]]
|
||||
directory = "vendor"
|
||||
name = "Vendored Libraries"
|
||||
showcontent = true
|
||||
[tool.towncrier.fragment.bugfix]
|
||||
name = "Bug Fixes"
|
||||
|
||||
[[tool.towncrier.type]]
|
||||
directory = "doc"
|
||||
name = "Improved Documentation"
|
||||
showcontent = true
|
||||
[tool.towncrier.fragment.vendor]
|
||||
name = "Vendored Libraries"
|
||||
|
||||
[[tool.towncrier.type]]
|
||||
directory = "trivial"
|
||||
name = "Trivial Changes"
|
||||
showcontent = true
|
||||
[tool.towncrier.fragment.doc]
|
||||
name = "Improved Documentation"
|
||||
|
||||
[tool.towncrier.fragment.trivial]
|
||||
name = "Trivial Changes"
|
||||
|
||||
78
setup.cfg
78
setup.cfg
@@ -1,8 +1,80 @@
|
||||
[bdist_wheel]
|
||||
universal = 1
|
||||
|
||||
[metadata]
|
||||
name = pytest-xdist
|
||||
description = pytest xdist plugin for distributed testing and loop-on-failing modes
|
||||
long_description = file: README.rst
|
||||
license = MIT
|
||||
author = holger krekel and contributors
|
||||
author_email = pytest-dev@python.org,holger@merlinux.eu
|
||||
url = https://github.com/pytest-dev/pytest-xdist
|
||||
platforms =
|
||||
linux
|
||||
osx
|
||||
win32
|
||||
classifiers =
|
||||
Development Status :: 5 - Production/Stable
|
||||
Framework :: Pytest
|
||||
Intended Audience :: Developers
|
||||
License :: OSI Approved :: MIT License
|
||||
Operating System :: POSIX
|
||||
Operating System :: Microsoft :: Windows
|
||||
Operating System :: MacOS :: MacOS X
|
||||
Topic :: Software Development :: Testing
|
||||
Topic :: Software Development :: Quality Assurance
|
||||
Topic :: Utilities
|
||||
Programming Language :: Python
|
||||
Programming Language :: Python :: 3
|
||||
Programming Language :: Python :: 3 :: Only
|
||||
Programming Language :: Python :: 3.6
|
||||
Programming Language :: Python :: 3.7
|
||||
Programming Language :: Python :: 3.8
|
||||
Programming Language :: Python :: 3.9
|
||||
Programming Language :: Python :: 3.10
|
||||
license_file = LICENSE
|
||||
project_urls =
|
||||
Documentation=https://pytest-xdist.readthedocs.io/en/latest
|
||||
Changelog=https://pytest-xdist.readthedocs.io/en/latest/changelog.html
|
||||
Source=https://github.com/pytest-dev/pytest-xdist
|
||||
Tracker=https://github.com/pytest-dev/pytest-xdist/issues
|
||||
|
||||
[options]
|
||||
packages = find:
|
||||
package_dir = =src
|
||||
zip_safe = False
|
||||
python_requires = >=3.6
|
||||
install_requires =
|
||||
execnet>=1.1
|
||||
pytest>=6.2.0
|
||||
setup_requires = # left empty, enforce using isolated build system
|
||||
|
||||
[options.packages.find]
|
||||
where = src
|
||||
|
||||
[options.entry_points]
|
||||
pytest11 =
|
||||
xdist = xdist.plugin
|
||||
xdist.looponfail = xdist.looponfail
|
||||
|
||||
[options.extras_require]
|
||||
testing =
|
||||
filelock
|
||||
psutil = psutil>=3.0
|
||||
setproctitle = setproctitle
|
||||
|
||||
[flake8]
|
||||
max-line-length = 100
|
||||
|
||||
[mypy]
|
||||
mypy_path = src
|
||||
# TODO: Enable this & fix errors.
|
||||
# check_untyped_defs = True
|
||||
disallow_any_generics = True
|
||||
ignore_missing_imports = True
|
||||
no_implicit_optional = True
|
||||
show_error_codes = True
|
||||
strict_equality = True
|
||||
warn_redundant_casts = True
|
||||
warn_return_any = True
|
||||
warn_unreachable = True
|
||||
warn_unused_configs = True
|
||||
# TODO: Enable this & fix errors.
|
||||
# no_implicit_reexport = True
|
||||
|
||||
52
setup.py
52
setup.py
@@ -1,50 +1,4 @@
|
||||
from setuptools import setup, find_packages
|
||||
from setuptools import setup
|
||||
|
||||
install_requires = ["execnet>=1.1", "pytest>=4.4.0", "pytest-forked", "six"]
|
||||
|
||||
|
||||
with open("README.rst") as f:
|
||||
long_description = f.read()
|
||||
|
||||
setup(
|
||||
name="pytest-xdist",
|
||||
use_scm_version={"write_to": "src/xdist/_version.py"},
|
||||
description="pytest xdist plugin for distributed testing"
|
||||
" and loop-on-failing modes",
|
||||
long_description=long_description,
|
||||
license="MIT",
|
||||
author="holger krekel and contributors",
|
||||
author_email="pytest-dev@python.org,holger@merlinux.eu",
|
||||
url="https://github.com/pytest-dev/pytest-xdist",
|
||||
platforms=["linux", "osx", "win32"],
|
||||
packages=find_packages(where="src"),
|
||||
package_dir={"": "src"},
|
||||
extras_require={"testing": ["filelock"]},
|
||||
entry_points={
|
||||
"pytest11": ["xdist = xdist.plugin", "xdist.looponfail = xdist.looponfail"]
|
||||
},
|
||||
zip_safe=False,
|
||||
python_requires=">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*",
|
||||
install_requires=install_requires,
|
||||
setup_requires=["setuptools_scm"],
|
||||
classifiers=[
|
||||
"Development Status :: 5 - Production/Stable",
|
||||
"Framework :: Pytest",
|
||||
"Intended Audience :: Developers",
|
||||
"License :: OSI Approved :: MIT License",
|
||||
"Operating System :: POSIX",
|
||||
"Operating System :: Microsoft :: Windows",
|
||||
"Operating System :: MacOS :: MacOS X",
|
||||
"Topic :: Software Development :: Testing",
|
||||
"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.5",
|
||||
"Programming Language :: Python :: 3.6",
|
||||
"Programming Language :: Python :: 3.7",
|
||||
"Programming Language :: Python :: 3.8",
|
||||
],
|
||||
)
|
||||
if __name__ == "__main__":
|
||||
setup()
|
||||
|
||||
@@ -1,3 +1,15 @@
|
||||
from xdist.plugin import (
|
||||
is_xdist_worker,
|
||||
is_xdist_master,
|
||||
get_xdist_worker_id,
|
||||
is_xdist_controller,
|
||||
)
|
||||
from xdist._version import version as __version__
|
||||
|
||||
__all__ = ["__version__"]
|
||||
__all__ = [
|
||||
"__version__",
|
||||
"is_xdist_worker",
|
||||
"is_xdist_master",
|
||||
"is_xdist_controller",
|
||||
"get_xdist_worker_id",
|
||||
]
|
||||
|
||||
19
src/xdist/_path.py
Normal file
19
src/xdist/_path.py
Normal file
@@ -0,0 +1,19 @@
|
||||
import os
|
||||
from itertools import chain
|
||||
from pathlib import Path
|
||||
from typing import Callable, Iterator
|
||||
|
||||
|
||||
def visit_path(
|
||||
path: Path, *, filter: Callable[[Path], bool], recurse: Callable[[Path], bool]
|
||||
) -> Iterator[Path]:
|
||||
"""
|
||||
Implements the interface of ``py.path.local.visit()`` for Path objects,
|
||||
to simplify porting the code over from ``py.path.local``.
|
||||
"""
|
||||
for dirpath, dirnames, filenames in os.walk(path):
|
||||
dirnames[:] = [x for x in dirnames if recurse(Path(dirpath, x))]
|
||||
for name in chain(dirnames, filenames):
|
||||
p = Path(dirpath, name)
|
||||
if filter(p):
|
||||
yield p
|
||||
@@ -1,23 +1,24 @@
|
||||
import py
|
||||
import pytest
|
||||
|
||||
from xdist.remote import Producer
|
||||
from xdist.workermanage import NodeManager
|
||||
from xdist.scheduler import (
|
||||
EachScheduling,
|
||||
LoadScheduling,
|
||||
LoadScopeScheduling,
|
||||
LoadFileScheduling,
|
||||
LoadGroupScheduling,
|
||||
)
|
||||
|
||||
|
||||
from six.moves.queue import Empty, Queue
|
||||
from queue import Empty, Queue
|
||||
|
||||
|
||||
class Interrupted(KeyboardInterrupt):
|
||||
""" signals an immediate interruption. """
|
||||
"""signals an immediate interruption."""
|
||||
|
||||
|
||||
class DSession(object):
|
||||
class DSession:
|
||||
"""A pytest plugin which runs a distributed test session
|
||||
|
||||
At the beginning of the test session this creates a NodeManager
|
||||
@@ -33,9 +34,7 @@ class DSession(object):
|
||||
|
||||
def __init__(self, config):
|
||||
self.config = config
|
||||
self.log = py.log.Producer("dsession")
|
||||
if not config.option.debug:
|
||||
py.log.setconsumer(self.log._keywords, None)
|
||||
self.log = Producer("dsession", enabled=config.option.debug)
|
||||
self.nodemanager = None
|
||||
self.sched = None
|
||||
self.shuttingdown = False
|
||||
@@ -67,7 +66,7 @@ class DSession(object):
|
||||
if self.terminal and self.config.option.verbose >= 0:
|
||||
self.terminal.write_line(line)
|
||||
|
||||
@pytest.mark.trylast
|
||||
@pytest.hookimpl(trylast=True)
|
||||
def pytest_sessionstart(self, session):
|
||||
"""Creates and starts the nodes.
|
||||
|
||||
@@ -79,6 +78,7 @@ class DSession(object):
|
||||
self._active_nodes.update(nodes)
|
||||
self._session = session
|
||||
|
||||
@pytest.hookimpl
|
||||
def pytest_sessionfinish(self, session):
|
||||
"""Shutdown all nodes."""
|
||||
nm = getattr(self, "nodemanager", None) # if not fully initialized
|
||||
@@ -86,11 +86,12 @@ class DSession(object):
|
||||
nm.teardown_nodes()
|
||||
self._session = None
|
||||
|
||||
@pytest.hookimpl
|
||||
def pytest_collection(self):
|
||||
# prohibit collection of test items in master process
|
||||
# prohibit collection of test items in controller process
|
||||
return True
|
||||
|
||||
@pytest.mark.trylast
|
||||
@pytest.hookimpl(trylast=True)
|
||||
def pytest_xdist_make_scheduler(self, config, log):
|
||||
dist = config.getvalue("dist")
|
||||
schedulers = {
|
||||
@@ -98,9 +99,11 @@ class DSession(object):
|
||||
"load": LoadScheduling,
|
||||
"loadscope": LoadScopeScheduling,
|
||||
"loadfile": LoadFileScheduling,
|
||||
"loadgroup": LoadGroupScheduling,
|
||||
}
|
||||
return schedulers[dist](config, log)
|
||||
|
||||
@pytest.hookimpl
|
||||
def pytest_runtestloop(self):
|
||||
self.sched = self.config.hook.pytest_xdist_make_scheduler(
|
||||
config=self.config, log=self.log
|
||||
@@ -150,9 +153,6 @@ class DSession(object):
|
||||
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()
|
||||
@@ -177,6 +177,24 @@ class DSession(object):
|
||||
assert not crashitem, (crashitem, node)
|
||||
self._active_nodes.remove(node)
|
||||
|
||||
def worker_internal_error(self, node, formatted_error):
|
||||
"""
|
||||
pytest_internalerror() was called on the worker.
|
||||
|
||||
pytest_internalerror() arguments are an excinfo and an excrepr, which can't
|
||||
be serialized, so we go with a poor man's solution of raising an exception
|
||||
here ourselves using the formatted message.
|
||||
"""
|
||||
self._active_nodes.remove(node)
|
||||
try:
|
||||
assert False, formatted_error
|
||||
except AssertionError:
|
||||
from _pytest._code import ExceptionInfo
|
||||
|
||||
excinfo = ExceptionInfo.from_current()
|
||||
excrepr = excinfo.getrepr()
|
||||
self.config.hook.pytest_internalerror(excrepr=excrepr, excinfo=excinfo)
|
||||
|
||||
def worker_errordown(self, node, error):
|
||||
"""Emitted by the WorkerController when a node dies."""
|
||||
self.config.hook.pytest_testnodedown(node=node, error=error)
|
||||
@@ -205,9 +223,11 @@ class DSession(object):
|
||||
self.triggershutdown()
|
||||
else:
|
||||
self.report_line("\nreplacing crashed worker %s" % node.gateway.id)
|
||||
self.shuttingdown = False
|
||||
self._clone_node(node)
|
||||
self._active_nodes.remove(node)
|
||||
|
||||
@pytest.hookimpl
|
||||
def pytest_terminal_summary(self, terminalreporter):
|
||||
if self.config.option.verbose >= 0 and self._summary_report:
|
||||
terminalreporter.write_sep("=", "xdist: {}".format(self._summary_report))
|
||||
@@ -225,7 +245,7 @@ class DSession(object):
|
||||
return
|
||||
self.config.hook.pytest_xdist_node_collection_finished(node=node, ids=ids)
|
||||
# tell session which items were effectively collected otherwise
|
||||
# the master node will finish the session with EXIT_NOTESTSCOLLECTED
|
||||
# the controller node will finish the session with EXIT_NOTESTSCOLLECTED
|
||||
self._session.testscollected = len(ids)
|
||||
self.sched.add_node_collection(node, ids)
|
||||
if self.terminal:
|
||||
@@ -271,13 +291,10 @@ class DSession(object):
|
||||
assert not rep.passed
|
||||
self._failed_worker_collectreport(node, rep)
|
||||
|
||||
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)
|
||||
|
||||
def worker_warning_captured(self, warning_message, when, item):
|
||||
"""Emitted when a node calls the pytest_warning_captured hook (deprecated in 6.0)."""
|
||||
# This hook as been removed in pytest 7.1, and we can remove support once we only
|
||||
# support pytest >=7.1.
|
||||
kwargs = dict(warning_message=warning_message, when=when, item=item)
|
||||
self.config.hook.pytest_warning_captured.call_historic(kwargs=kwargs)
|
||||
|
||||
@@ -333,10 +350,16 @@ class DSession(object):
|
||||
nodeid, (fspath, None, fspath), (), "failed", msg, "???"
|
||||
)
|
||||
rep.node = worker
|
||||
|
||||
self.config.hook.pytest_handlecrashitem(
|
||||
crashitem=nodeid,
|
||||
report=rep,
|
||||
sched=self.sched,
|
||||
)
|
||||
self.config.hook.pytest_runtest_logreport(report=rep)
|
||||
|
||||
|
||||
class TerminalDistReporter(object):
|
||||
class TerminalDistReporter:
|
||||
def __init__(self, config):
|
||||
self.config = config
|
||||
self.tr = config.pluginmanager.getplugin("terminalreporter")
|
||||
@@ -374,6 +397,7 @@ class TerminalDistReporter(object):
|
||||
self._lastlen = len(line)
|
||||
self.tr.rewrite(pline, bold=True)
|
||||
|
||||
@pytest.hookimpl
|
||||
def pytest_xdist_setupnodes(self, specs):
|
||||
self._specs = specs
|
||||
for spec in specs:
|
||||
@@ -381,6 +405,7 @@ class TerminalDistReporter(object):
|
||||
self.setstatus(spec, "I", show=True)
|
||||
self.ensure_show_status()
|
||||
|
||||
@pytest.hookimpl
|
||||
def pytest_xdist_newgateway(self, gateway):
|
||||
if self.config.option.verbose > 0:
|
||||
rinfo = gateway._rinfo()
|
||||
@@ -392,6 +417,7 @@ class TerminalDistReporter(object):
|
||||
)
|
||||
self.setstatus(gateway.spec, "C")
|
||||
|
||||
@pytest.hookimpl
|
||||
def pytest_testnodeready(self, node):
|
||||
if self.config.option.verbose > 0:
|
||||
d = node.workerinfo
|
||||
@@ -401,6 +427,7 @@ class TerminalDistReporter(object):
|
||||
self.rewrite(infoline, newline=True)
|
||||
self.setstatus(node.gateway.spec, "ok")
|
||||
|
||||
@pytest.hookimpl
|
||||
def pytest_testnodedown(self, node, error):
|
||||
if not error:
|
||||
return
|
||||
|
||||
@@ -6,14 +6,20 @@
|
||||
processes) otherwise changes to source code can crash
|
||||
the controlling process which should best never happen.
|
||||
"""
|
||||
from __future__ import print_function
|
||||
import py
|
||||
import os
|
||||
from pathlib import Path
|
||||
from typing import Dict, Sequence
|
||||
|
||||
import pytest
|
||||
import sys
|
||||
import time
|
||||
import execnet
|
||||
from _pytest._io import TerminalWriter
|
||||
|
||||
from xdist._path import visit_path
|
||||
|
||||
|
||||
@pytest.hookimpl
|
||||
def pytest_addoption(parser):
|
||||
group = parser.getgroup("xdist", "distributed and subprocess testing")
|
||||
group._addoption(
|
||||
@@ -27,6 +33,7 @@ def pytest_addoption(parser):
|
||||
)
|
||||
|
||||
|
||||
@pytest.hookimpl
|
||||
def pytest_cmdline_main(config):
|
||||
|
||||
if config.getoption("looponfail"):
|
||||
@@ -37,9 +44,12 @@ def pytest_cmdline_main(config):
|
||||
return 2 # looponfail only can get stop with ctrl-C anyway
|
||||
|
||||
|
||||
def looponfail_main(config):
|
||||
def looponfail_main(config: "pytest.Config") -> None:
|
||||
remotecontrol = RemoteControl(config)
|
||||
rootdirs = config.getini("looponfailroots")
|
||||
config_roots = config.getini("looponfailroots")
|
||||
if not config_roots:
|
||||
config_roots = [Path.cwd()]
|
||||
rootdirs = [Path(root) for root in config_roots]
|
||||
statrecorder = StatRecorder(rootdirs)
|
||||
try:
|
||||
while 1:
|
||||
@@ -55,14 +65,14 @@ def looponfail_main(config):
|
||||
print()
|
||||
|
||||
|
||||
class RemoteControl(object):
|
||||
class RemoteControl:
|
||||
def __init__(self, config):
|
||||
self.config = config
|
||||
self.failures = []
|
||||
|
||||
def trace(self, *args):
|
||||
if self.config.option.debug:
|
||||
msg = " ".join([str(x) for x in args])
|
||||
msg = " ".join(str(x) for x in args)
|
||||
print("RemoteControl:", msg)
|
||||
|
||||
def initgateway(self):
|
||||
@@ -70,7 +80,7 @@ class RemoteControl(object):
|
||||
|
||||
def setup(self, out=None):
|
||||
if out is None:
|
||||
out = py.io.TerminalWriter()
|
||||
out = TerminalWriter()
|
||||
if hasattr(self, "gateway"):
|
||||
raise ValueError("already have gateway %r" % self.gateway)
|
||||
self.trace("setting up worker session")
|
||||
@@ -128,7 +138,7 @@ class RemoteControl(object):
|
||||
|
||||
|
||||
def repr_pytest_looponfailinfo(failreports, rootdirs):
|
||||
tr = py.io.TerminalWriter()
|
||||
tr = TerminalWriter()
|
||||
if failreports:
|
||||
tr.sep("#", "LOOPONFAILING", bold=True)
|
||||
for report in failreports:
|
||||
@@ -165,7 +175,7 @@ def init_worker_session(channel, args, option_dict):
|
||||
WorkerFailSession(config, channel).main()
|
||||
|
||||
|
||||
class WorkerFailSession(object):
|
||||
class WorkerFailSession:
|
||||
def __init__(self, config, channel):
|
||||
self.config = config
|
||||
self.channel = channel
|
||||
@@ -179,6 +189,7 @@ class WorkerFailSession(object):
|
||||
if self.config.option.debug:
|
||||
print(" ".join(map(str, args)))
|
||||
|
||||
@pytest.hookimpl
|
||||
def pytest_collection(self, session):
|
||||
self.session = session
|
||||
self.trails = self.current_command
|
||||
@@ -193,10 +204,12 @@ class WorkerFailSession(object):
|
||||
hook.pytest_collection_finish(session=session)
|
||||
return True
|
||||
|
||||
@pytest.hookimpl
|
||||
def pytest_runtest_logreport(self, report):
|
||||
if report.failed:
|
||||
self.recorded_failures.append(report)
|
||||
|
||||
@pytest.hookimpl
|
||||
def pytest_collectreport(self, report):
|
||||
if report.failed:
|
||||
self.recorded_failures.append(report)
|
||||
@@ -220,17 +233,17 @@ class WorkerFailSession(object):
|
||||
self.channel.send((trails, failreports, self.collection_failed))
|
||||
|
||||
|
||||
class StatRecorder(object):
|
||||
def __init__(self, rootdirlist):
|
||||
class StatRecorder:
|
||||
def __init__(self, rootdirlist: Sequence[Path]) -> None:
|
||||
self.rootdirlist = rootdirlist
|
||||
self.statcache = {}
|
||||
self.statcache: Dict[Path, os.stat_result] = {}
|
||||
self.check() # snapshot state
|
||||
|
||||
def fil(self, p):
|
||||
return p.check(file=1, dotfile=0) and p.ext != ".pyc"
|
||||
def fil(self, p: Path) -> bool:
|
||||
return p.is_file() and not p.name.startswith(".") and p.suffix != ".pyc"
|
||||
|
||||
def rec(self, p):
|
||||
return p.check(dotfile=0)
|
||||
def rec(self, p: Path) -> bool:
|
||||
return not p.name.startswith(".") and p.exists()
|
||||
|
||||
def waitonchange(self, checkinterval=1.0):
|
||||
while 1:
|
||||
@@ -239,34 +252,34 @@ class StatRecorder(object):
|
||||
return
|
||||
time.sleep(checkinterval)
|
||||
|
||||
def check(self, removepycfiles=True): # noqa, too complex
|
||||
def check(self, removepycfiles: bool = True) -> bool: # noqa, too complex
|
||||
changed = False
|
||||
statcache = self.statcache
|
||||
newstat = {}
|
||||
newstat: Dict[Path, os.stat_result] = {}
|
||||
for rootdir in self.rootdirlist:
|
||||
for path in rootdir.visit(self.fil, self.rec):
|
||||
oldstat = statcache.pop(path, None)
|
||||
for path in visit_path(rootdir, filter=self.fil, recurse=self.rec):
|
||||
oldstat = self.statcache.pop(path, None)
|
||||
try:
|
||||
newstat[path] = curstat = path.stat()
|
||||
except py.error.ENOENT:
|
||||
curstat = path.stat()
|
||||
except OSError:
|
||||
if oldstat:
|
||||
changed = True
|
||||
else:
|
||||
if oldstat:
|
||||
newstat[path] = curstat
|
||||
if oldstat is not None:
|
||||
if (
|
||||
oldstat.mtime != curstat.mtime
|
||||
or oldstat.size != curstat.size
|
||||
oldstat.st_mtime != curstat.st_mtime
|
||||
or oldstat.st_size != curstat.st_size
|
||||
):
|
||||
changed = True
|
||||
print("# MODIFIED", path)
|
||||
if removepycfiles and path.ext == ".py":
|
||||
pycfile = path + "c"
|
||||
if pycfile.check():
|
||||
pycfile.remove()
|
||||
if removepycfiles and path.suffix == ".py":
|
||||
pycfile = path.with_suffix(".pyc")
|
||||
if pycfile.is_file():
|
||||
os.unlink(pycfile)
|
||||
|
||||
else:
|
||||
changed = True
|
||||
if statcache:
|
||||
if self.statcache:
|
||||
changed = True
|
||||
self.statcache = newstat
|
||||
return changed
|
||||
|
||||
@@ -14,44 +14,82 @@ must be taken in plugins in case ``xdist`` is not installed. Please see:
|
||||
import pytest
|
||||
|
||||
|
||||
@pytest.hookspec()
|
||||
def pytest_xdist_setupnodes(config, specs):
|
||||
""" called before any remote node is set up. """
|
||||
"""called before any remote node is set up."""
|
||||
|
||||
|
||||
@pytest.hookspec()
|
||||
def pytest_xdist_newgateway(gateway):
|
||||
""" called on new raw gateway creation. """
|
||||
"""called on new raw gateway creation."""
|
||||
|
||||
|
||||
@pytest.hookspec(
|
||||
warn_on_impl="rsync feature is deprecated and will be removed in pytest-xdist 4.0"
|
||||
)
|
||||
def pytest_xdist_rsyncstart(source, gateways):
|
||||
""" called before rsyncing a directory to remote gateways takes place. """
|
||||
"""called before rsyncing a directory to remote gateways takes place."""
|
||||
|
||||
|
||||
@pytest.hookspec(
|
||||
warn_on_impl="rsync feature is deprecated and will be removed in pytest-xdist 4.0"
|
||||
)
|
||||
def pytest_xdist_rsyncfinish(source, gateways):
|
||||
""" called after rsyncing a directory to remote gateways takes place. """
|
||||
"""called after rsyncing a directory to remote gateways takes place."""
|
||||
|
||||
|
||||
@pytest.mark.firstresult
|
||||
@pytest.hookspec(firstresult=True)
|
||||
def pytest_xdist_getremotemodule():
|
||||
""" called when creating remote node"""
|
||||
"""called when creating remote node"""
|
||||
|
||||
|
||||
@pytest.hookspec()
|
||||
def pytest_configure_node(node):
|
||||
""" configure node information before it gets instantiated. """
|
||||
"""configure node information before it gets instantiated."""
|
||||
|
||||
|
||||
@pytest.hookspec()
|
||||
def pytest_testnodeready(node):
|
||||
""" Test Node is ready to operate. """
|
||||
"""Test Node is ready to operate."""
|
||||
|
||||
|
||||
@pytest.hookspec()
|
||||
def pytest_testnodedown(node, error):
|
||||
""" Test Node is down. """
|
||||
"""Test Node is down."""
|
||||
|
||||
|
||||
@pytest.hookspec()
|
||||
def pytest_xdist_node_collection_finished(node, ids):
|
||||
"""called by the master node when a node finishes collecting.
|
||||
"""called by the controller node when a worker node finishes collecting."""
|
||||
|
||||
|
||||
@pytest.hookspec(firstresult=True)
|
||||
def pytest_xdist_make_scheduler(config, log):
|
||||
"""return a node scheduler implementation"""
|
||||
|
||||
|
||||
@pytest.hookspec(firstresult=True)
|
||||
def pytest_xdist_auto_num_workers(config):
|
||||
"""
|
||||
Return the number of workers to spawn when ``--numprocesses=auto`` is given in the
|
||||
command-line.
|
||||
|
||||
.. versionadded:: 2.1
|
||||
"""
|
||||
|
||||
|
||||
@pytest.mark.firstresult
|
||||
def pytest_xdist_make_scheduler(config, log):
|
||||
""" return a node scheduler implementation """
|
||||
@pytest.hookspec(firstresult=True)
|
||||
def pytest_handlecrashitem(crashitem, report, sched):
|
||||
"""
|
||||
Handle a crashitem, modifying the report if necessary.
|
||||
|
||||
The scheduler is provided as a parameter to reschedule the test if desired with
|
||||
`sched.mark_test_pending`.
|
||||
|
||||
def pytest_handlecrashitem(crashitem, report, sched):
|
||||
if should_rerun(crashitem):
|
||||
sched.mark_test_pending(crashitem)
|
||||
report.outcome = "rerun"
|
||||
|
||||
.. versionadded:: 2.2.1
|
||||
"""
|
||||
|
||||
@@ -1,13 +1,40 @@
|
||||
import os
|
||||
import uuid
|
||||
import sys
|
||||
import warnings
|
||||
|
||||
import py
|
||||
import pytest
|
||||
|
||||
|
||||
def auto_detect_cpus():
|
||||
PYTEST_GTE_7 = hasattr(pytest, "version_tuple") and pytest.version_tuple >= (7, 0) # type: ignore[attr-defined]
|
||||
|
||||
_sys_path = list(sys.path) # freeze a copy of sys.path at interpreter startup
|
||||
|
||||
|
||||
@pytest.hookimpl
|
||||
def pytest_xdist_auto_num_workers(config):
|
||||
env_var = os.environ.get("PYTEST_XDIST_AUTO_NUM_WORKERS")
|
||||
if env_var:
|
||||
try:
|
||||
return int(env_var)
|
||||
except ValueError:
|
||||
warnings.warn("PYTEST_XDIST_AUTO_NUM_WORKERS is not a number: {env_var!r}. Ignoring it.")
|
||||
|
||||
try:
|
||||
import psutil
|
||||
except ImportError:
|
||||
pass
|
||||
else:
|
||||
use_logical = config.option.numprocesses == "logical"
|
||||
count = psutil.cpu_count(logical=use_logical) or psutil.cpu_count()
|
||||
if count:
|
||||
return count
|
||||
try:
|
||||
from os import sched_getaffinity
|
||||
|
||||
def cpu_count():
|
||||
return len(sched_getaffinity(0))
|
||||
|
||||
except ImportError:
|
||||
if os.environ.get("TRAVIS") == "true":
|
||||
# workaround https://bitbucket.org/pypy/pypy/issues/2375
|
||||
@@ -16,11 +43,6 @@ def auto_detect_cpus():
|
||||
from os import cpu_count
|
||||
except ImportError:
|
||||
from multiprocessing import cpu_count
|
||||
else:
|
||||
|
||||
def cpu_count():
|
||||
return len(sched_getaffinity(0))
|
||||
|
||||
try:
|
||||
n = cpu_count()
|
||||
except NotImplementedError:
|
||||
@@ -28,17 +50,14 @@ def auto_detect_cpus():
|
||||
return n if n else 1
|
||||
|
||||
|
||||
class AutoInt(int):
|
||||
"""Mark value as auto-detected."""
|
||||
|
||||
|
||||
def parse_numprocesses(s):
|
||||
if s == "auto":
|
||||
return AutoInt(auto_detect_cpus())
|
||||
if s in ("auto", "logical"):
|
||||
return s
|
||||
elif s is not None:
|
||||
return int(s)
|
||||
|
||||
|
||||
@pytest.hookimpl
|
||||
def pytest_addoption(parser):
|
||||
group = parser.getgroup("xdist", "distributed and subprocess testing")
|
||||
group._addoption(
|
||||
@@ -48,9 +67,10 @@ def pytest_addoption(parser):
|
||||
metavar="numprocesses",
|
||||
action="store",
|
||||
type=parse_numprocesses,
|
||||
help="shortcut for '--dist=load --tx=NUM*popen', "
|
||||
"you can use 'auto' here for auto detection CPUs number on "
|
||||
"host system and it will be 0 when used with --pdb",
|
||||
help="Shortcut for '--dist=load --tx=NUM*popen'. With 'auto', attempt "
|
||||
"to detect physical CPU count. With 'logical', detect logical CPU "
|
||||
"count. If physical CPU count cannot be found, falls back to logical "
|
||||
"count. This will be 0 when used with --pdb.",
|
||||
)
|
||||
group.addoption(
|
||||
"--maxprocesses",
|
||||
@@ -62,20 +82,17 @@ def pytest_addoption(parser):
|
||||
)
|
||||
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",
|
||||
"when crashed (set to zero to disable this feature)",
|
||||
)
|
||||
group.addoption(
|
||||
"--dist",
|
||||
metavar="distmode",
|
||||
action="store",
|
||||
choices=["each", "load", "loadscope", "loadfile", "no"],
|
||||
choices=["each", "load", "loadscope", "loadfile", "loadgroup", "no"],
|
||||
dest="dist",
|
||||
default="no",
|
||||
help=(
|
||||
@@ -87,6 +104,7 @@ def pytest_addoption(parser):
|
||||
" the same scope to any available environment.\n\n"
|
||||
"loadfile: load balance by sending test grouped by file"
|
||||
" to any available environment.\n\n"
|
||||
"loadgroup: like load, but sends tests marked with 'xdist_group' to the same worker.\n\n"
|
||||
"(default) no: run tests inprocess, don't distribute."
|
||||
),
|
||||
)
|
||||
@@ -123,11 +141,6 @@ def pytest_addoption(parser):
|
||||
metavar="GLOB",
|
||||
help="add expression for ignores when rsyncing to remote tx nodes.",
|
||||
)
|
||||
group.addoption(
|
||||
"--boxed",
|
||||
action="store_true",
|
||||
help="backward compatibility alias for pytest-forked --forked",
|
||||
)
|
||||
group.addoption(
|
||||
"--testrunuid",
|
||||
action="store",
|
||||
@@ -142,18 +155,17 @@ def pytest_addoption(parser):
|
||||
parser.addini(
|
||||
"rsyncdirs",
|
||||
"list of (relative) paths to be rsynced for remote distributed testing.",
|
||||
type="pathlist",
|
||||
type="paths" if PYTEST_GTE_7 else "pathlist",
|
||||
)
|
||||
parser.addini(
|
||||
"rsyncignore",
|
||||
"list of (relative) glob-style paths to be ignored for rsyncing.",
|
||||
type="pathlist",
|
||||
type="paths" if PYTEST_GTE_7 else "pathlist",
|
||||
)
|
||||
parser.addini(
|
||||
"looponfailroots",
|
||||
type="pathlist",
|
||||
help="directories to check for changes",
|
||||
default=[py.path.local()],
|
||||
type="paths" if PYTEST_GTE_7 else "pathlist",
|
||||
help="directories to check for changes. Default: current directory.",
|
||||
)
|
||||
|
||||
|
||||
@@ -162,6 +174,7 @@ def pytest_addoption(parser):
|
||||
# -------------------------------------------------------------------------
|
||||
|
||||
|
||||
@pytest.hookimpl
|
||||
def pytest_addhooks(pluginmanager):
|
||||
from xdist import newhooks
|
||||
|
||||
@@ -173,7 +186,7 @@ def pytest_addhooks(pluginmanager):
|
||||
# -------------------------------------------------------------------------
|
||||
|
||||
|
||||
@pytest.mark.trylast
|
||||
@pytest.hookimpl(trylast=True)
|
||||
def pytest_configure(config):
|
||||
if config.getoption("dist") != "no" and not config.getvalue("collectonly"):
|
||||
from xdist.dsession import DSession
|
||||
@@ -183,19 +196,38 @@ def pytest_configure(config):
|
||||
tr = config.pluginmanager.getplugin("terminalreporter")
|
||||
if tr:
|
||||
tr.showfspath = False
|
||||
if config.getoption("boxed"):
|
||||
config.option.forked = True
|
||||
|
||||
if config.getoption("looponfail", None) or config.getini("looponfailroots"):
|
||||
warning = DeprecationWarning(
|
||||
"The --looponfail command line argument and looponfailroots config variable are deprecated.\n"
|
||||
"The loop-on-fail feature will be removed in pytest-xdist 4.0."
|
||||
)
|
||||
config.issue_config_time_warning(warning, 2)
|
||||
|
||||
if config.getoption("rsyncdir", None) or config.getini("rsyncdirs"):
|
||||
warning = DeprecationWarning(
|
||||
"The --rsyncdir command line argument and rsyncdirs config variable are deprecated.\n"
|
||||
"The rsync feature will be removed in pytest-xdist 4.0."
|
||||
)
|
||||
config.issue_config_time_warning(warning, 2)
|
||||
|
||||
config_line = (
|
||||
"xdist_group: specify group for tests should run in same session."
|
||||
"in relation to one another. " + "Provided by pytest-xdist."
|
||||
)
|
||||
config.addinivalue_line("markers", config_line)
|
||||
|
||||
|
||||
@pytest.mark.tryfirst
|
||||
@pytest.hookimpl(tryfirst=True)
|
||||
def pytest_cmdline_main(config):
|
||||
usepdb = config.getoption("usepdb", False) # a core option
|
||||
if isinstance(config.option.numprocesses, AutoInt):
|
||||
if config.option.numprocesses in ("auto", "logical"):
|
||||
if usepdb:
|
||||
config.option.numprocesses = 0
|
||||
config.option.dist = "no"
|
||||
else:
|
||||
config.option.numprocesses = int(config.option.numprocesses)
|
||||
auto_num_cpus = config.hook.pytest_xdist_auto_num_workers(config=config)
|
||||
config.option.numprocesses = auto_num_cpus
|
||||
|
||||
if config.option.numprocesses:
|
||||
if config.option.dist == "no":
|
||||
@@ -214,19 +246,59 @@ def pytest_cmdline_main(config):
|
||||
|
||||
|
||||
# -------------------------------------------------------------------------
|
||||
# fixtures
|
||||
# fixtures and API to easily know the role of current node
|
||||
# -------------------------------------------------------------------------
|
||||
|
||||
|
||||
def is_xdist_worker(request_or_session) -> bool:
|
||||
"""Return `True` if this is an xdist worker, `False` otherwise
|
||||
|
||||
:param request_or_session: the `pytest` `request` or `session` object
|
||||
"""
|
||||
return hasattr(request_or_session.config, "workerinput")
|
||||
|
||||
|
||||
def is_xdist_controller(request_or_session) -> bool:
|
||||
"""Return `True` if this is the xdist controller, `False` otherwise
|
||||
|
||||
Note: this method also returns `False` when distribution has not been
|
||||
activated at all.
|
||||
|
||||
:param request_or_session: the `pytest` `request` or `session` object
|
||||
"""
|
||||
return (
|
||||
not is_xdist_worker(request_or_session)
|
||||
and request_or_session.config.option.dist != "no"
|
||||
)
|
||||
|
||||
|
||||
# ALIAS: TODO, deprecate (#592)
|
||||
is_xdist_master = is_xdist_controller
|
||||
|
||||
|
||||
def get_xdist_worker_id(request_or_session):
|
||||
"""Return the id of the current worker ('gw0', 'gw1', etc) or 'master'
|
||||
if running on the controller node.
|
||||
|
||||
If not distributing tests (for example passing `-n0` or not passing `-n` at all)
|
||||
also return 'master'.
|
||||
|
||||
:param request_or_session: the `pytest` `request` or `session` object
|
||||
"""
|
||||
if hasattr(request_or_session.config, "workerinput"):
|
||||
return request_or_session.config.workerinput["workerid"]
|
||||
else:
|
||||
# TODO: remove "master", ideally for a None
|
||||
return "master"
|
||||
|
||||
|
||||
@pytest.fixture(scope="session")
|
||||
def worker_id(request):
|
||||
"""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"
|
||||
# TODO: remove "master", ideally for a None
|
||||
return get_xdist_worker_id(request)
|
||||
|
||||
|
||||
@pytest.fixture(scope="session")
|
||||
|
||||
@@ -9,23 +9,58 @@
|
||||
import sys
|
||||
import os
|
||||
import time
|
||||
from typing import Any
|
||||
|
||||
import py
|
||||
import _pytest.hookspec
|
||||
import pytest
|
||||
from execnet.gateway_base import dumps, DumpError
|
||||
|
||||
from _pytest.config import _prepareconfig, Config
|
||||
|
||||
try:
|
||||
from setproctitle import setproctitle
|
||||
except ImportError:
|
||||
|
||||
class WorkerInteractor(object):
|
||||
def setproctitle(title):
|
||||
pass
|
||||
|
||||
|
||||
class Producer:
|
||||
"""
|
||||
Simplified implementation of the same interface as py.log, for backward compatibility
|
||||
since we dropped the dependency on pylib.
|
||||
Note: this is defined here because this module can't depend on xdist, so we need
|
||||
to have the other way around.
|
||||
"""
|
||||
|
||||
def __init__(self, name: str, *, enabled: bool = True):
|
||||
self.name = name
|
||||
self.enabled = enabled
|
||||
|
||||
def __repr__(self) -> str:
|
||||
return f"{type(self).__name__}({self.name!r}, enabled={self.enabled})"
|
||||
|
||||
def __call__(self, *a: Any, **k: Any) -> None:
|
||||
if self.enabled:
|
||||
print(f"[{self.name}]", *a, **k, file=sys.stderr)
|
||||
|
||||
def __getattr__(self, name: str) -> "Producer":
|
||||
return type(self)(name, enabled=self.enabled)
|
||||
|
||||
|
||||
def worker_title(title):
|
||||
try:
|
||||
setproctitle(title)
|
||||
except Exception:
|
||||
# changing the process name is very optional, no errors please
|
||||
pass
|
||||
|
||||
|
||||
class WorkerInteractor:
|
||||
def __init__(self, config, channel):
|
||||
self.config = config
|
||||
self.workerid = config.workerinput.get("workerid", "?")
|
||||
self.testrunuid = config.workerinput["testrunuid"]
|
||||
self.log = py.log.Producer("worker-%s" % self.workerid)
|
||||
if not config.option.debug:
|
||||
py.log.setconsumer(self.log._keywords, None)
|
||||
self.log = Producer(f"worker-{self.workerid}", enabled=config.option.debug)
|
||||
self.channel = channel
|
||||
config.pluginmanager.register(self)
|
||||
|
||||
@@ -33,10 +68,14 @@ class WorkerInteractor(object):
|
||||
self.log("sending", name, kwargs)
|
||||
self.channel.send((name, kwargs))
|
||||
|
||||
@pytest.hookimpl
|
||||
def pytest_internalerror(self, excrepr):
|
||||
for line in str(excrepr).split("\n"):
|
||||
formatted_error = str(excrepr)
|
||||
for line in formatted_error.split("\n"):
|
||||
self.log("IERROR>", line)
|
||||
interactor.sendevent("internal_error", formatted_error=formatted_error)
|
||||
|
||||
@pytest.hookimpl
|
||||
def pytest_sessionstart(self, session):
|
||||
self.session = session
|
||||
workerinfo = getinfodict()
|
||||
@@ -49,9 +88,11 @@ class WorkerInteractor(object):
|
||||
yield
|
||||
self.sendevent("workerfinished", workeroutput=self.config.workeroutput)
|
||||
|
||||
@pytest.hookimpl
|
||||
def pytest_collection(self, session):
|
||||
self.sendevent("collectionstart")
|
||||
|
||||
@pytest.hookimpl
|
||||
def pytest_runtestloop(self, session):
|
||||
self.log("entering main loop")
|
||||
torun = []
|
||||
@@ -84,29 +125,54 @@ class WorkerInteractor(object):
|
||||
else:
|
||||
nextitem = None
|
||||
|
||||
worker_title("[pytest-xdist running] %s" % item.nodeid)
|
||||
|
||||
start = time.time()
|
||||
self.config.hook.pytest_runtest_protocol(item=item, nextitem=nextitem)
|
||||
duration = time.time() - start
|
||||
|
||||
worker_title("[pytest-xdist idle]")
|
||||
|
||||
self.sendevent(
|
||||
"runtest_protocol_complete", item_index=self.item_index, duration=duration
|
||||
)
|
||||
|
||||
def pytest_collection_modifyitems(self, session, config, items):
|
||||
# add the group name to nodeid as suffix if --dist=loadgroup
|
||||
if config.getvalue("loadgroup"):
|
||||
for item in items:
|
||||
mark = item.get_closest_marker("xdist_group")
|
||||
if not mark:
|
||||
continue
|
||||
gname = (
|
||||
mark.args[0]
|
||||
if len(mark.args) > 0
|
||||
else mark.kwargs.get("name", "default")
|
||||
)
|
||||
item._nodeid = "{}@{}".format(item.nodeid, gname)
|
||||
|
||||
@pytest.hookimpl
|
||||
def pytest_collection_finish(self, session):
|
||||
try:
|
||||
topdir = str(self.config.rootpath)
|
||||
except AttributeError: # pytest <= 6.1.0
|
||||
topdir = str(self.config.rootdir)
|
||||
|
||||
self.sendevent(
|
||||
"collectionfinish",
|
||||
topdir=str(session.fspath),
|
||||
topdir=topdir,
|
||||
ids=[item.nodeid for item in session.items],
|
||||
)
|
||||
|
||||
@pytest.hookimpl
|
||||
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"):
|
||||
|
||||
@pytest.hookimpl
|
||||
def pytest_runtest_logfinish(self, nodeid, location):
|
||||
self.sendevent("logfinish", nodeid=nodeid, location=location)
|
||||
|
||||
@pytest.hookimpl
|
||||
def pytest_runtest_logreport(self, report):
|
||||
data = self.config.hook.pytest_report_to_serializable(
|
||||
config=self.config, report=report
|
||||
@@ -117,31 +183,16 @@ class WorkerInteractor(object):
|
||||
assert self.session.items[self.item_index].nodeid == report.nodeid
|
||||
self.sendevent("testreport", data=data)
|
||||
|
||||
@pytest.hookimpl
|
||||
def pytest_collectreport(self, report):
|
||||
# send only reports that have not passed to master as optimization (#330)
|
||||
# send only reports that have not passed to controller as optimization (#330)
|
||||
if not report.passed:
|
||||
data = self.config.hook.pytest_report_to_serializable(
|
||||
config=self.config, report=report
|
||||
)
|
||||
self.sendevent("collectreport", data=data)
|
||||
|
||||
# the pytest_logwarning hook was deprecated since pytest 4.0
|
||||
if hasattr(
|
||||
_pytest.hookspec, "pytest_logwarning"
|
||||
) and not _pytest.hookspec.pytest_logwarning.pytest_spec.get("warn_on_impl"):
|
||||
|
||||
def pytest_logwarning(self, message, code, nodeid, fslocation):
|
||||
self.sendevent(
|
||||
"logwarning",
|
||||
message=message,
|
||||
code=code,
|
||||
nodeid=nodeid,
|
||||
fslocation=str(fslocation),
|
||||
)
|
||||
|
||||
# the pytest_warning_recorded hook was introduced in pytest 6.0
|
||||
if hasattr(_pytest.hookspec, "pytest_warning_recorded"):
|
||||
|
||||
@pytest.hookimpl
|
||||
def pytest_warning_recorded(self, warning_message, when, nodeid, location):
|
||||
self.sendevent(
|
||||
"warning_recorded",
|
||||
@@ -151,18 +202,6 @@ class WorkerInteractor(object):
|
||||
location=location,
|
||||
)
|
||||
|
||||
# the pytest_warning_captured hook was introduced in pytest 3.8
|
||||
elif hasattr(_pytest.hookspec, "pytest_warning_captured"):
|
||||
|
||||
def pytest_warning_captured(self, warning_message, when, item):
|
||||
self.sendevent(
|
||||
"warning_captured",
|
||||
warning_message_data=serialize_warning_message(warning_message),
|
||||
when=when,
|
||||
# item cannot be serialized and will always be None when used with xdist
|
||||
item=None,
|
||||
)
|
||||
|
||||
|
||||
def serialize_warning_message(warning_message):
|
||||
if isinstance(warning_message.message, Warning):
|
||||
@@ -170,7 +209,7 @@ def serialize_warning_message(warning_message):
|
||||
message_class_name = type(warning_message.message).__name__
|
||||
message_str = str(warning_message.message)
|
||||
# check now if we can serialize the warning arguments (#349)
|
||||
# if not, we will just use the exception message on the master node
|
||||
# if not, we will just use the exception message on the controller node
|
||||
try:
|
||||
dumps(warning_message.message.args)
|
||||
except DumpError:
|
||||
@@ -232,6 +271,7 @@ def remote_initconfig(option_dict, args):
|
||||
|
||||
|
||||
def setup_config(config, basetemp):
|
||||
config.option.loadgroup = config.getvalue("dist") == "loadgroup"
|
||||
config.option.looponfail = False
|
||||
config.option.usepdb = False
|
||||
config.option.dist = "no"
|
||||
@@ -242,15 +282,17 @@ def setup_config(config, basetemp):
|
||||
|
||||
|
||||
if __name__ == "__channelexec__":
|
||||
channel = channel # noqa
|
||||
workerinput, args, option_dict, change_sys_path = channel.receive()
|
||||
channel = channel # type: ignore[name-defined] # noqa: F821
|
||||
workerinput, args, option_dict, change_sys_path = channel.receive() # type: ignore[name-defined]
|
||||
|
||||
if change_sys_path:
|
||||
if change_sys_path is None:
|
||||
importpath = os.getcwd()
|
||||
sys.path.insert(0, importpath)
|
||||
os.environ["PYTHONPATH"] = (
|
||||
importpath + os.pathsep + os.environ.get("PYTHONPATH", "")
|
||||
)
|
||||
else:
|
||||
sys.path = change_sys_path
|
||||
|
||||
os.environ["PYTEST_XDIST_TESTRUNUID"] = workerinput["testrunuid"]
|
||||
os.environ["PYTEST_XDIST_WORKER"] = workerinput["workerid"]
|
||||
@@ -264,10 +306,7 @@ if __name__ == "__channelexec__":
|
||||
|
||||
setup_config(config, option_dict.get("basetemp"))
|
||||
config._parser.prog = os.path.basename(workerinput["mainargv"][0])
|
||||
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.workerinput = workerinput # type: ignore[attr-defined]
|
||||
config.workeroutput = {} # type: ignore[attr-defined]
|
||||
interactor = WorkerInteractor(config, channel) # type: ignore[name-defined]
|
||||
config.hook.pytest_cmdline_main(config=config)
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
from __future__ import print_function
|
||||
from difflib import unified_diff
|
||||
|
||||
|
||||
@@ -13,9 +12,10 @@ def report_collection_diff(from_collection, to_collection, from_id, to_id):
|
||||
|
||||
diff = unified_diff(from_collection, to_collection, fromfile=from_id, tofile=to_id)
|
||||
error_message = (
|
||||
u"Different tests were collected between {from_id} and {to_id}. "
|
||||
u"The difference is:\n"
|
||||
u"{diff}"
|
||||
"Different tests were collected between {from_id} and {to_id}. "
|
||||
"The difference is:\n"
|
||||
"{diff}\n"
|
||||
"To see why this happens see Known limitations in documentation"
|
||||
).format(from_id=from_id, to_id=to_id, diff="\n".join(diff))
|
||||
msg = "\n".join([x.rstrip() for x in error_message.split("\n")])
|
||||
msg = "\n".join(x.rstrip() for x in error_message.split("\n"))
|
||||
return msg
|
||||
|
||||
@@ -2,3 +2,4 @@ from xdist.scheduler.each import EachScheduling # noqa
|
||||
from xdist.scheduler.load import LoadScheduling # noqa
|
||||
from xdist.scheduler.loadfile import LoadFileScheduling # noqa
|
||||
from xdist.scheduler.loadscope import LoadScopeScheduling # noqa
|
||||
from xdist.scheduler.loadgroup import LoadGroupScheduling # noqa
|
||||
|
||||
@@ -1,10 +1,9 @@
|
||||
from py.log import Producer
|
||||
|
||||
from xdist.remote import Producer
|
||||
from xdist.workermanage import parse_spec_config
|
||||
from xdist.report import report_collection_diff
|
||||
|
||||
|
||||
class EachScheduling(object):
|
||||
class EachScheduling:
|
||||
"""Implement scheduling of test items on all nodes
|
||||
|
||||
If a node gets added after the test run is started then it is
|
||||
@@ -101,6 +100,14 @@ class EachScheduling(object):
|
||||
def mark_test_complete(self, node, item_index, duration=0):
|
||||
self.node2pending[node].remove(item_index)
|
||||
|
||||
def mark_test_pending(self, item):
|
||||
self.pending.insert(
|
||||
0,
|
||||
self.collection.index(item),
|
||||
)
|
||||
for node in self.node2pending:
|
||||
self.check_schedule(node)
|
||||
|
||||
def remove_node(self, node):
|
||||
# KeyError if we didn't get an add_node() yet
|
||||
pending = self.node2pending.pop(node)
|
||||
|
||||
@@ -1,13 +1,13 @@
|
||||
from itertools import cycle
|
||||
|
||||
from py.log import Producer
|
||||
from _pytest.runner import CollectReport
|
||||
|
||||
from xdist.remote import Producer
|
||||
from xdist.workermanage import parse_spec_config
|
||||
from xdist.report import report_collection_diff
|
||||
|
||||
|
||||
class LoadScheduling(object):
|
||||
class LoadScheduling:
|
||||
"""Implement load scheduling across nodes.
|
||||
|
||||
This distributes the tests collected across all nodes so each test
|
||||
@@ -151,6 +151,14 @@ class LoadScheduling(object):
|
||||
self.node2pending[node].remove(item_index)
|
||||
self.check_schedule(node, duration=duration)
|
||||
|
||||
def mark_test_pending(self, item):
|
||||
self.pending.insert(
|
||||
0,
|
||||
self.collection.index(item),
|
||||
)
|
||||
for node in self.node2pending:
|
||||
self.check_schedule(node)
|
||||
|
||||
def check_schedule(self, node, duration=0):
|
||||
"""Maybe schedule new items on the node
|
||||
|
||||
@@ -240,13 +248,27 @@ class LoadScheduling(object):
|
||||
# Send a batch of tests to run. If we don't have at least two
|
||||
# tests per node, we have to send them all so that we can send
|
||||
# shutdown signals and get all nodes working.
|
||||
initial_batch = max(len(self.pending) // 4, 2 * len(self.nodes))
|
||||
|
||||
# distribute tests round-robin up to the batch size
|
||||
# (or until we run out)
|
||||
if len(self.pending) < 2 * len(self.nodes):
|
||||
# Distribute tests round-robin. Try to load all nodes if there are
|
||||
# enough tests. The other branch tries sends at least 2 tests
|
||||
# to each node - which is suboptimal when you have less than
|
||||
# 2 * len(nodes) tests.
|
||||
nodes = cycle(self.nodes)
|
||||
for i in range(initial_batch):
|
||||
for i in range(len(self.pending)):
|
||||
self._send_tests(next(nodes), 1)
|
||||
else:
|
||||
# Send batches of consecutive tests. By default, pytest sorts tests
|
||||
# in order for optimal single-threaded execution, minimizing the
|
||||
# number of necessary fixture setup/teardown. Try to keep that
|
||||
# optimal order for every worker.
|
||||
|
||||
# how many items per node do we have about?
|
||||
items_per_node = len(self.collection) // len(self.node2pending)
|
||||
# take a fraction of tests for initial distribution
|
||||
node_chunksize = max(items_per_node // 4, 2)
|
||||
# and initialize each node with a chunk of tests
|
||||
for node in self.nodes:
|
||||
self._send_tests(node, node_chunksize)
|
||||
|
||||
if not self.pending:
|
||||
# initial distribution sent all tests, start node shutdown
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
from .loadscope import LoadScopeScheduling
|
||||
from py.log import Producer
|
||||
from xdist.remote import Producer
|
||||
|
||||
|
||||
class LoadFileScheduling(LoadScopeScheduling):
|
||||
@@ -21,7 +21,7 @@ class LoadFileScheduling(LoadScopeScheduling):
|
||||
"""
|
||||
|
||||
def __init__(self, config, log=None):
|
||||
super(LoadFileScheduling, self).__init__(config, log)
|
||||
super().__init__(config, log)
|
||||
if log is None:
|
||||
self.log = Producer("loadfilesched")
|
||||
else:
|
||||
|
||||
54
src/xdist/scheduler/loadgroup.py
Normal file
54
src/xdist/scheduler/loadgroup.py
Normal file
@@ -0,0 +1,54 @@
|
||||
from .loadscope import LoadScopeScheduling
|
||||
from xdist.remote import Producer
|
||||
|
||||
|
||||
class LoadGroupScheduling(LoadScopeScheduling):
|
||||
"""Implement load scheduling across nodes, but grouping test by xdist_group mark.
|
||||
|
||||
This class behaves very much like LoadScopeScheduling, but it groups tests by xdist_group mark
|
||||
instead of the module or class to which they belong to.
|
||||
"""
|
||||
|
||||
def __init__(self, config, log=None):
|
||||
super().__init__(config, log)
|
||||
if log is None:
|
||||
self.log = Producer("loadgroupsched")
|
||||
else:
|
||||
self.log = log.loadgroupsched
|
||||
|
||||
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.
|
||||
|
||||
With loadgroup, two cases are added::
|
||||
|
||||
example/loadsuite/test/test_beta.py::test_beta0
|
||||
example/loadsuite/test/test_delta.py::Delta1::test_delta0
|
||||
example/loadsuite/epsilon/__init__.py::epsilon.epsilon
|
||||
example/loadsuite/test/test_gamma.py::test_beta0@gname
|
||||
example/loadsuite/test/test_delta.py::Gamma1::test_gamma0@gname
|
||||
|
||||
This function will group tests with the scope determined by splitting the first ``@``
|
||||
from the right. That is, test will be grouped in a single work unit when they have
|
||||
same group name. In the above example, scopes will be::
|
||||
|
||||
example/loadsuite/test/test_beta.py::test_beta0
|
||||
example/loadsuite/test/test_delta.py::Delta1::test_delta0
|
||||
example/loadsuite/epsilon/__init__.py::epsilon.epsilon
|
||||
gname
|
||||
gname
|
||||
"""
|
||||
if nodeid.rfind("@") > nodeid.rfind("]"):
|
||||
# check the index of ']' to avoid the case: parametrize mark value has '@'
|
||||
return nodeid.split("@")[-1]
|
||||
else:
|
||||
return nodeid
|
||||
@@ -1,12 +1,12 @@
|
||||
from collections import OrderedDict
|
||||
|
||||
from _pytest.runner import CollectReport
|
||||
from py.log import Producer
|
||||
from xdist.remote import Producer
|
||||
from xdist.report import report_collection_diff
|
||||
from xdist.workermanage import parse_spec_config
|
||||
|
||||
|
||||
class LoadScopeScheduling(object):
|
||||
class LoadScopeScheduling:
|
||||
"""Implement load scheduling across nodes, but grouping test by scope.
|
||||
|
||||
This distributes the tests collected across all nodes so each test is run
|
||||
@@ -243,6 +243,9 @@ class LoadScopeScheduling(object):
|
||||
self.assigned_work[node][scope][nodeid] = True
|
||||
self._reschedule(node)
|
||||
|
||||
def mark_test_pending(self, item):
|
||||
raise NotImplementedError()
|
||||
|
||||
def _assign_work_unit(self, node):
|
||||
"""Assign a work unit to a node."""
|
||||
assert self.workqueue
|
||||
@@ -358,12 +361,12 @@ class LoadScopeScheduling(object):
|
||||
extra_nodes = len(self.nodes) - len(self.workqueue)
|
||||
|
||||
if extra_nodes > 0:
|
||||
self.log("Shuting down {} nodes".format(extra_nodes))
|
||||
self.log("Shutting down {} 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("Shutting down unused node {}".format(unused_node))
|
||||
unused_node.shutdown()
|
||||
|
||||
# Assign initial workload
|
||||
|
||||
@@ -1,15 +1,17 @@
|
||||
from __future__ import print_function
|
||||
import fnmatch
|
||||
import os
|
||||
import re
|
||||
import sys
|
||||
import uuid
|
||||
from pathlib import Path
|
||||
from typing import List, Union, Sequence, Optional, Any, Tuple, Set
|
||||
|
||||
import py
|
||||
import pytest
|
||||
import execnet
|
||||
|
||||
import xdist.remote
|
||||
from xdist.remote import Producer
|
||||
from xdist.plugin import _sys_path
|
||||
|
||||
|
||||
def parse_spec_config(config):
|
||||
@@ -29,11 +31,11 @@ def parse_spec_config(config):
|
||||
return xspeclist
|
||||
|
||||
|
||||
class NodeManager(object):
|
||||
class NodeManager:
|
||||
EXIT_TIMEOUT = 10
|
||||
DEFAULT_IGNORES = [".*", "*.pyc", "*.pyo", "*~"]
|
||||
|
||||
def __init__(self, config, specs=None, defaultchdir="pyexecnetcache"):
|
||||
def __init__(self, config, specs=None, defaultchdir="pyexecnetcache") -> None:
|
||||
self.config = config
|
||||
self.trace = self.config.trace.get("nodemanager")
|
||||
self.testrunuid = self.config.getoption("testrunuid")
|
||||
@@ -52,7 +54,7 @@ class NodeManager(object):
|
||||
self.specs.append(spec)
|
||||
self.roots = self._getrsyncdirs()
|
||||
self.rsyncoptions = self._getrsyncoptions()
|
||||
self._rsynced_specs = set()
|
||||
self._rsynced_specs: Set[Tuple[Any, Any]] = set()
|
||||
|
||||
def rsync_roots(self, gateway):
|
||||
"""Rsync the set of roots to the node's gateway cwd."""
|
||||
@@ -81,7 +83,7 @@ class NodeManager(object):
|
||||
def _getxspecs(self):
|
||||
return [execnet.XSpec(x) for x in parse_spec_config(self.config)]
|
||||
|
||||
def _getrsyncdirs(self):
|
||||
def _getrsyncdirs(self) -> List[Path]:
|
||||
for spec in self.specs:
|
||||
if not spec.popen or spec.chdir:
|
||||
break
|
||||
@@ -101,15 +103,15 @@ class NodeManager(object):
|
||||
pytestpath = get_dir(pytest.__file__)
|
||||
pytestdir = get_dir(_pytest.__file__)
|
||||
config = self.config
|
||||
candidates = [py._pydir, pytestpath, pytestdir]
|
||||
candidates = [pytestpath, pytestdir]
|
||||
candidates += config.option.rsyncdir
|
||||
rsyncroots = config.getini("rsyncdirs")
|
||||
if rsyncroots:
|
||||
candidates.extend(rsyncroots)
|
||||
roots = []
|
||||
for root in candidates:
|
||||
root = py.path.local(root).realpath()
|
||||
if not root.check():
|
||||
root = Path(root).resolve()
|
||||
if not root.exists():
|
||||
raise pytest.UsageError("rsyncdir doesn't exist: {!r}".format(root))
|
||||
if root not in roots:
|
||||
roots.append(root)
|
||||
@@ -118,12 +120,12 @@ class NodeManager(object):
|
||||
def _getrsyncoptions(self):
|
||||
"""Get options to be passed for rsync."""
|
||||
ignores = list(self.DEFAULT_IGNORES)
|
||||
ignores += self.config.option.rsyncignore
|
||||
ignores += self.config.getini("rsyncignore")
|
||||
ignores += [str(path) for path in self.config.option.rsyncignore]
|
||||
ignores += [str(path) for path in self.config.getini("rsyncignore")]
|
||||
|
||||
return {
|
||||
"ignores": ignores,
|
||||
"verbose": getattr(self.config.option, "verbose", False),
|
||||
"verbose": getattr(self.config.option, "verbose", 0),
|
||||
}
|
||||
|
||||
def rsync(self, gateway, source, notify=None, verbose=False, ignores=None):
|
||||
@@ -158,52 +160,63 @@ class NodeManager(object):
|
||||
|
||||
|
||||
class HostRSync(execnet.RSync):
|
||||
""" RSyncer that filters out common files
|
||||
"""
|
||||
"""RSyncer that filters out common files"""
|
||||
|
||||
def __init__(self, sourcedir, *args, **kwargs):
|
||||
self._synced = {}
|
||||
ignores = kwargs.pop("ignores", None) or []
|
||||
self._ignores = [
|
||||
re.compile(fnmatch.translate(getattr(x, "strpath", x))) for x in ignores
|
||||
]
|
||||
super(HostRSync, self).__init__(sourcedir=sourcedir, **kwargs)
|
||||
PathLike = Union[str, "os.PathLike[str]"]
|
||||
|
||||
def filter(self, path):
|
||||
path = py.path.local(path)
|
||||
def __init__(
|
||||
self,
|
||||
sourcedir: PathLike,
|
||||
*,
|
||||
ignores: Optional[Sequence[PathLike]] = None,
|
||||
**kwargs: object
|
||||
) -> None:
|
||||
if ignores is None:
|
||||
ignores = []
|
||||
self._ignores = [re.compile(fnmatch.translate(os.fspath(x))) for x in ignores]
|
||||
super().__init__(sourcedir=Path(sourcedir), **kwargs)
|
||||
|
||||
def filter(self, path: PathLike) -> bool:
|
||||
path = Path(path)
|
||||
for cre in self._ignores:
|
||||
if cre.match(path.basename) or cre.match(path.strpath):
|
||||
if cre.match(path.name) or cre.match(str(path)):
|
||||
return False
|
||||
else:
|
||||
return True
|
||||
|
||||
def add_target_host(self, gateway, finished=None):
|
||||
remotepath = os.path.basename(self._sourcedir)
|
||||
super(HostRSync, self).add_target(
|
||||
gateway, remotepath, finishedcallback=finished, delete=True
|
||||
)
|
||||
super().add_target(gateway, remotepath, finishedcallback=finished, delete=True)
|
||||
|
||||
def _report_send_file(self, gateway, modified_rel_path):
|
||||
if self._verbose:
|
||||
if self._verbose > 0:
|
||||
path = os.path.basename(self._sourcedir) + "/" + modified_rel_path
|
||||
remotepath = gateway.spec.chdir
|
||||
print("{}:{} <= {}".format(gateway.spec, remotepath, path))
|
||||
|
||||
|
||||
def make_reltoroot(roots, args):
|
||||
def make_reltoroot(roots: Sequence[Path], args: List[str]) -> List[str]:
|
||||
# XXX introduce/use public API for splitting pytest args
|
||||
splitcode = "::"
|
||||
result = []
|
||||
for arg in args:
|
||||
parts = arg.split(splitcode)
|
||||
fspath = py.path.local(parts[0])
|
||||
if not fspath.exists():
|
||||
fspath = Path(parts[0])
|
||||
try:
|
||||
exists = fspath.exists()
|
||||
except OSError:
|
||||
exists = False
|
||||
if not exists:
|
||||
result.append(arg)
|
||||
continue
|
||||
for root in roots:
|
||||
x = fspath.relto(root)
|
||||
x: Optional[Path]
|
||||
try:
|
||||
x = fspath.relative_to(root)
|
||||
except ValueError:
|
||||
x = None
|
||||
if x or fspath == root:
|
||||
parts[0] = root.basename + "/" + x
|
||||
parts[0] = root.name + "/" + str(x)
|
||||
break
|
||||
else:
|
||||
raise ValueError("arg {} not relative to an rsync root".format(arg))
|
||||
@@ -211,11 +224,11 @@ def make_reltoroot(roots, args):
|
||||
return result
|
||||
|
||||
|
||||
class WorkerController(object):
|
||||
class WorkerController:
|
||||
ENDMARK = -1
|
||||
|
||||
class RemoteHook:
|
||||
@pytest.mark.trylast
|
||||
@pytest.hookimpl(trylast=True)
|
||||
def pytest_xdist_getremotemodule(self):
|
||||
return xdist.remote
|
||||
|
||||
@@ -228,18 +241,12 @@ class WorkerController(object):
|
||||
self.workerinput = {
|
||||
"workerid": gateway.id,
|
||||
"workercount": len(nodemanager.specs),
|
||||
"slaveid": gateway.id,
|
||||
"slavecount": len(nodemanager.specs),
|
||||
"testrunuid": nodemanager.testrunuid,
|
||||
"mainargv": sys.argv,
|
||||
}
|
||||
# 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("workerctl-%s" % gateway.id)
|
||||
if not self.config.option.debug:
|
||||
py.log.setconsumer(self.log._keywords, None)
|
||||
self.log = Producer(f"workerctl-{gateway.id}", enabled=config.option.debug)
|
||||
|
||||
def __repr__(self):
|
||||
return "<{} {}>".format(self.__class__.__name__, self.gateway.id)
|
||||
@@ -261,15 +268,16 @@ class WorkerController(object):
|
||||
args = make_reltoroot(self.nodemanager.roots, args)
|
||||
if spec.popen:
|
||||
name = "popen-%s" % self.gateway.id
|
||||
if hasattr(self.config, "_tmpdirhandler"):
|
||||
basetemp = self.config._tmpdirhandler.getbasetemp()
|
||||
option_dict["basetemp"] = str(basetemp.join(name))
|
||||
if hasattr(self.config, "_tmp_path_factory"):
|
||||
basetemp = self.config._tmp_path_factory.getbasetemp()
|
||||
option_dict["basetemp"] = str(basetemp / name)
|
||||
self.config.hook.pytest_configure_node(node=self)
|
||||
|
||||
remote_module = self.config.hook.pytest_xdist_getremotemodule()
|
||||
self.channel = self.gateway.remote_exec(remote_module)
|
||||
# change sys.path only for remote workers
|
||||
change_sys_path = not self.gateway.spec.popen
|
||||
# restore sys.path from a frozen copy for local workers
|
||||
change_sys_path = _sys_path if self.gateway.spec.popen else None
|
||||
self.channel.send((self.workerinput, args, option_dict, change_sys_path))
|
||||
|
||||
if self.putevent:
|
||||
@@ -296,12 +304,12 @@ class WorkerController(object):
|
||||
if not self._down:
|
||||
try:
|
||||
self.sendcommand("shutdown")
|
||||
except (IOError, OSError):
|
||||
except OSError:
|
||||
pass
|
||||
self._shutdown_sent = True
|
||||
|
||||
def sendcommand(self, name, **kwargs):
|
||||
""" send a named parametrized command to the other side. """
|
||||
"""send a named parametrized command to the other side."""
|
||||
self.log("sending command {}(**{})".format(name, kwargs))
|
||||
self.channel.send((name, kwargs))
|
||||
|
||||
@@ -310,7 +318,7 @@ class WorkerController(object):
|
||||
self.putevent((eventname, kwargs))
|
||||
|
||||
def process_from_remote(self, eventcall): # noqa too complex
|
||||
""" this gets called for each object we receive from
|
||||
"""this gets called for each object we receive from
|
||||
the other side and if the channel closes.
|
||||
|
||||
Note that channel callbacks run in the receiver
|
||||
@@ -331,9 +339,11 @@ class WorkerController(object):
|
||||
self.log("ignoring {}({})".format(eventname, kwargs))
|
||||
elif eventname == "workerready":
|
||||
self.notify_inproc(eventname, node=self, **kwargs)
|
||||
elif eventname == "internal_error":
|
||||
self.notify_inproc(eventname, node=self, **kwargs)
|
||||
elif eventname == "workerfinished":
|
||||
self._down = True
|
||||
self.workeroutput = self.slaveoutput = kwargs["workeroutput"]
|
||||
self.workeroutput = kwargs["workeroutput"]
|
||||
self.notify_inproc("workerfinished", node=self)
|
||||
elif eventname in ("logstart", "logfinish"):
|
||||
self.notify_inproc(eventname, node=self, **kwargs)
|
||||
@@ -386,11 +396,7 @@ class WorkerController(object):
|
||||
except: # noqa
|
||||
from _pytest._code import ExceptionInfo
|
||||
|
||||
# ExceptionInfo API changed in pytest 4.1
|
||||
if hasattr(ExceptionInfo, "from_current"):
|
||||
excinfo = ExceptionInfo.from_current()
|
||||
else:
|
||||
excinfo = ExceptionInfo()
|
||||
print("!" * 20, excinfo)
|
||||
self.config.notify_exception(excinfo)
|
||||
self.shutdown()
|
||||
@@ -431,9 +437,9 @@ def unserialize_warning_message(data):
|
||||
|
||||
kwargs = {"message": message, "category": category}
|
||||
# access private _WARNING_DETAILS because the attributes vary between Python versions
|
||||
for attr_name in warnings.WarningMessage._WARNING_DETAILS:
|
||||
for attr_name in warnings.WarningMessage._WARNING_DETAILS: # type: ignore[attr-defined]
|
||||
if attr_name in ("message", "category"):
|
||||
continue
|
||||
kwargs[attr_name] = data[attr_name]
|
||||
|
||||
return warnings.WarningMessage(**kwargs)
|
||||
return warnings.WarningMessage(**kwargs) # type: ignore[arg-type]
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,23 +1,13 @@
|
||||
import six
|
||||
import py
|
||||
import pytest
|
||||
import execnet
|
||||
import pytest
|
||||
import shutil
|
||||
from typing import List
|
||||
|
||||
pytest_plugins = "pytester"
|
||||
|
||||
if six.PY2:
|
||||
|
||||
@pytest.fixture(scope="session", autouse=True)
|
||||
def _ensure_imports():
|
||||
# we import some modules because pytest-2.8's testdir fixture
|
||||
# will unload all modules after each test and this cause
|
||||
# (unknown) problems with execnet.Group()
|
||||
execnet.Group
|
||||
execnet.makegateway
|
||||
|
||||
|
||||
@pytest.fixture(autouse=True)
|
||||
def _divert_atexit(request, monkeypatch):
|
||||
def _divert_atexit(request, monkeypatch: pytest.MonkeyPatch):
|
||||
import atexit
|
||||
|
||||
finalizers = []
|
||||
@@ -34,7 +24,7 @@ def _divert_atexit(request, monkeypatch):
|
||||
func(*args, **kwargs)
|
||||
|
||||
|
||||
def pytest_addoption(parser):
|
||||
def pytest_addoption(parser) -> None:
|
||||
parser.addoption(
|
||||
"--gx",
|
||||
action="append",
|
||||
@@ -44,28 +34,28 @@ def pytest_addoption(parser):
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def specssh(request):
|
||||
def specssh(request) -> str:
|
||||
return getspecssh(request.config)
|
||||
|
||||
|
||||
# configuration information for tests
|
||||
def getgspecs(config):
|
||||
def getgspecs(config) -> List[execnet.XSpec]:
|
||||
return [execnet.XSpec(spec) for spec in config.getvalueorskip("gspecs")]
|
||||
|
||||
|
||||
def getspecssh(config):
|
||||
def getspecssh(config) -> str: # type: ignore[return]
|
||||
xspecs = getgspecs(config)
|
||||
for spec in xspecs:
|
||||
if spec.ssh:
|
||||
if not py.path.local.sysfind("ssh"):
|
||||
py.test.skip("command not found: ssh")
|
||||
if not shutil.which("ssh"):
|
||||
pytest.skip("command not found: ssh")
|
||||
return str(spec)
|
||||
py.test.skip("need '--gx ssh=...'")
|
||||
pytest.skip("need '--gx ssh=...'")
|
||||
|
||||
|
||||
def getsocketspec(config):
|
||||
def getsocketspec(config) -> execnet.XSpec:
|
||||
xspecs = getgspecs(config)
|
||||
for spec in xspecs:
|
||||
if spec.socket:
|
||||
return spec
|
||||
py.test.skip("need '--gx socket=...'")
|
||||
pytest.skip("need '--gx socket=...'")
|
||||
|
||||
@@ -1,59 +1,44 @@
|
||||
from xdist.dsession import DSession, get_default_max_worker_restart
|
||||
from xdist.report import report_collection_diff
|
||||
from xdist.scheduler import EachScheduling, LoadScheduling
|
||||
from typing import Optional
|
||||
|
||||
import py
|
||||
import pytest
|
||||
import execnet
|
||||
|
||||
XSpec = execnet.XSpec
|
||||
|
||||
|
||||
def run(item, node, excinfo=None):
|
||||
runner = item.config.pluginmanager.getplugin("runner")
|
||||
rep = runner.ItemTestReport(item=item, excinfo=excinfo, when="call")
|
||||
rep.node = node
|
||||
return rep
|
||||
|
||||
|
||||
class MockGateway:
|
||||
_count = 0
|
||||
|
||||
def __init__(self):
|
||||
def __init__(self) -> None:
|
||||
self._count = 0
|
||||
self.id = str(self._count)
|
||||
self._count += 1
|
||||
|
||||
|
||||
class MockNode:
|
||||
def __init__(self):
|
||||
self.sent = []
|
||||
def __init__(self) -> None:
|
||||
self.sent = [] # type: ignore[var-annotated]
|
||||
self.gateway = MockGateway()
|
||||
self._shutdown = False
|
||||
|
||||
def send_runtest_some(self, indices):
|
||||
def send_runtest_some(self, indices) -> None:
|
||||
self.sent.extend(indices)
|
||||
|
||||
def send_runtest_all(self):
|
||||
def send_runtest_all(self) -> None:
|
||||
self.sent.append("ALL")
|
||||
|
||||
def shutdown(self):
|
||||
def shutdown(self) -> None:
|
||||
self._shutdown = True
|
||||
|
||||
@property
|
||||
def shutting_down(self):
|
||||
def shutting_down(self) -> bool:
|
||||
return self._shutdown
|
||||
|
||||
|
||||
def dumpqueue(queue):
|
||||
while queue.qsize():
|
||||
print(queue.get())
|
||||
|
||||
|
||||
class TestEachScheduling:
|
||||
def test_schedule_load_simple(self, testdir):
|
||||
def test_schedule_load_simple(self, pytester: pytest.Pytester) -> None:
|
||||
node1 = MockNode()
|
||||
node2 = MockNode()
|
||||
config = testdir.parseconfig("--tx=2*popen")
|
||||
config = pytester.parseconfig("--tx=2*popen")
|
||||
sched = EachScheduling(config)
|
||||
sched.add_node(node1)
|
||||
sched.add_node(node2)
|
||||
@@ -74,9 +59,9 @@ class TestEachScheduling:
|
||||
sched.mark_test_complete(node2, 0)
|
||||
assert sched.tests_finished
|
||||
|
||||
def test_schedule_remove_node(self, testdir):
|
||||
def test_schedule_remove_node(self, pytester: pytest.Pytester) -> None:
|
||||
node1 = MockNode()
|
||||
config = testdir.parseconfig("--tx=popen")
|
||||
config = pytester.parseconfig("--tx=popen")
|
||||
sched = EachScheduling(config)
|
||||
sched.add_node(node1)
|
||||
collection = ["a.py::test_1"]
|
||||
@@ -93,8 +78,8 @@ class TestEachScheduling:
|
||||
|
||||
|
||||
class TestLoadScheduling:
|
||||
def test_schedule_load_simple(self, testdir):
|
||||
config = testdir.parseconfig("--tx=2*popen")
|
||||
def test_schedule_load_simple(self, pytester: pytest.Pytester) -> None:
|
||||
config = pytester.parseconfig("--tx=2*popen")
|
||||
sched = LoadScheduling(config)
|
||||
sched.add_node(MockNode())
|
||||
sched.add_node(MockNode())
|
||||
@@ -117,8 +102,8 @@ class TestLoadScheduling:
|
||||
sched.mark_test_complete(node1, node1.sent[0])
|
||||
assert sched.tests_finished
|
||||
|
||||
def test_schedule_batch_size(self, testdir):
|
||||
config = testdir.parseconfig("--tx=2*popen")
|
||||
def test_schedule_batch_size(self, pytester: pytest.Pytester) -> None:
|
||||
config = pytester.parseconfig("--tx=2*popen")
|
||||
sched = LoadScheduling(config)
|
||||
sched.add_node(MockNode())
|
||||
sched.add_node(MockNode())
|
||||
@@ -130,22 +115,22 @@ class TestLoadScheduling:
|
||||
# assert not sched.tests_finished
|
||||
sent1 = node1.sent
|
||||
sent2 = node2.sent
|
||||
assert sent1 == [0, 2]
|
||||
assert sent2 == [1, 3]
|
||||
assert sent1 == [0, 1]
|
||||
assert sent2 == [2, 3]
|
||||
assert sched.pending == [4, 5]
|
||||
assert sched.node2pending[node1] == sent1
|
||||
assert sched.node2pending[node2] == sent2
|
||||
assert len(sched.pending) == 2
|
||||
sched.mark_test_complete(node1, 0)
|
||||
assert node1.sent == [0, 2, 4]
|
||||
assert node1.sent == [0, 1, 4]
|
||||
assert sched.pending == [5]
|
||||
assert node2.sent == [1, 3]
|
||||
sched.mark_test_complete(node1, 2)
|
||||
assert node1.sent == [0, 2, 4, 5]
|
||||
assert node2.sent == [2, 3]
|
||||
sched.mark_test_complete(node1, 1)
|
||||
assert node1.sent == [0, 1, 4, 5]
|
||||
assert not sched.pending
|
||||
|
||||
def test_schedule_fewer_tests_than_nodes(self, testdir):
|
||||
config = testdir.parseconfig("--tx=2*popen")
|
||||
def test_schedule_fewer_tests_than_nodes(self, pytester: pytest.Pytester) -> None:
|
||||
config = pytester.parseconfig("--tx=2*popen")
|
||||
sched = LoadScheduling(config)
|
||||
sched.add_node(MockNode())
|
||||
sched.add_node(MockNode())
|
||||
@@ -164,8 +149,10 @@ class TestLoadScheduling:
|
||||
assert sent3 == []
|
||||
assert not sched.pending
|
||||
|
||||
def test_schedule_fewer_than_two_tests_per_node(self, testdir):
|
||||
config = testdir.parseconfig("--tx=2*popen")
|
||||
def test_schedule_fewer_than_two_tests_per_node(
|
||||
self, pytester: pytest.Pytester
|
||||
) -> None:
|
||||
config = pytester.parseconfig("--tx=2*popen")
|
||||
sched = LoadScheduling(config)
|
||||
sched.add_node(MockNode())
|
||||
sched.add_node(MockNode())
|
||||
@@ -184,9 +171,9 @@ class TestLoadScheduling:
|
||||
assert sent3 == [2]
|
||||
assert not sched.pending
|
||||
|
||||
def test_add_remove_node(self, testdir):
|
||||
def test_add_remove_node(self, pytester: pytest.Pytester) -> None:
|
||||
node = MockNode()
|
||||
config = testdir.parseconfig("--tx=popen")
|
||||
config = pytester.parseconfig("--tx=popen")
|
||||
sched = LoadScheduling(config)
|
||||
sched.add_node(node)
|
||||
collection = ["test_file.py::test_func"]
|
||||
@@ -197,13 +184,13 @@ class TestLoadScheduling:
|
||||
crashitem = sched.remove_node(node)
|
||||
assert crashitem == collection[0]
|
||||
|
||||
def test_different_tests_collected(self, testdir):
|
||||
def test_different_tests_collected(self, pytester: pytest.Pytester) -> None:
|
||||
"""
|
||||
Test that LoadScheduling is reporting collection errors when
|
||||
different test ids are collected by workers.
|
||||
"""
|
||||
|
||||
class CollectHook(object):
|
||||
class CollectHook:
|
||||
"""
|
||||
Dummy hook that stores collection reports.
|
||||
"""
|
||||
@@ -215,7 +202,7 @@ class TestLoadScheduling:
|
||||
self.reports.append(report)
|
||||
|
||||
collect_hook = CollectHook()
|
||||
config = testdir.parseconfig("--tx=2*popen")
|
||||
config = pytester.parseconfig("--tx=2*popen")
|
||||
config.pluginmanager.register(collect_hook, "collect_hook")
|
||||
node1 = MockNode()
|
||||
node2 = MockNode()
|
||||
@@ -231,9 +218,9 @@ class TestLoadScheduling:
|
||||
|
||||
|
||||
class TestDistReporter:
|
||||
@py.test.mark.xfail
|
||||
def test_rsync_printing(self, testdir, linecomp):
|
||||
config = testdir.parseconfig()
|
||||
@pytest.mark.xfail
|
||||
def test_rsync_printing(self, pytester: pytest.Pytester, linecomp) -> None:
|
||||
config = pytester.parseconfig()
|
||||
from _pytest.pytest_terminal import TerminalReporter
|
||||
|
||||
rep = TerminalReporter(config, file=linecomp.stringio)
|
||||
@@ -258,21 +245,21 @@ class TestDistReporter:
|
||||
# linecomp.assert_contains_lines([
|
||||
# "*X1*popen*xyz*2.5*"
|
||||
# ])
|
||||
dsession.pytest_xdist_rsyncstart(source="hello", gateways=[gw1, gw2])
|
||||
dsession.pytest_xdist_rsyncstart(source="hello", gateways=[gw1, gw2]) # type: ignore[attr-defined]
|
||||
linecomp.assert_contains_lines(["[X1,X2] rsyncing: hello"])
|
||||
|
||||
|
||||
def test_report_collection_diff_equal():
|
||||
def test_report_collection_diff_equal() -> None:
|
||||
"""Test reporting of equal collections."""
|
||||
from_collection = to_collection = ["aaa", "bbb", "ccc"]
|
||||
assert report_collection_diff(from_collection, to_collection, 1, 2) is None
|
||||
|
||||
|
||||
def test_default_max_worker_restart():
|
||||
def test_default_max_worker_restart() -> None:
|
||||
class config:
|
||||
class option:
|
||||
maxworkerrestart = None
|
||||
numprocesses = 0
|
||||
maxworkerrestart: Optional[str] = None
|
||||
numprocesses: int = 0
|
||||
|
||||
assert get_default_max_worker_restart(config) is None
|
||||
|
||||
@@ -286,7 +273,7 @@ def test_default_max_worker_restart():
|
||||
assert get_default_max_worker_restart(config) == 0
|
||||
|
||||
|
||||
def test_report_collection_diff_different():
|
||||
def test_report_collection_diff_different() -> None:
|
||||
"""Test reporting of different collections."""
|
||||
from_collection = ["aaa", "bbb", "ccc", "YYY"]
|
||||
to_collection = ["aZa", "bbb", "XXX", "ccc"]
|
||||
@@ -303,7 +290,8 @@ def test_report_collection_diff_different():
|
||||
" bbb\n"
|
||||
"+XXX\n"
|
||||
" ccc\n"
|
||||
"-YYY"
|
||||
"-YYY\n"
|
||||
"To see why this happens see Known limitations in documentation"
|
||||
)
|
||||
|
||||
msg = report_collection_diff(from_collection, to_collection, "1", "2")
|
||||
@@ -311,8 +299,8 @@ def test_report_collection_diff_different():
|
||||
|
||||
|
||||
@pytest.mark.xfail(reason="duplicate test ids not supported yet")
|
||||
def test_pytest_issue419(testdir):
|
||||
testdir.makepyfile(
|
||||
def test_pytest_issue419(pytester: pytest.Pytester) -> None:
|
||||
pytester.makepyfile(
|
||||
"""
|
||||
import pytest
|
||||
|
||||
@@ -321,6 +309,6 @@ def test_pytest_issue419(testdir):
|
||||
pass
|
||||
"""
|
||||
)
|
||||
reprec = testdir.inline_run("-n1")
|
||||
reprec = pytester.inline_run("-n1")
|
||||
reprec.assertoutcome(passed=2)
|
||||
assert 0
|
||||
|
||||
@@ -1,89 +1,108 @@
|
||||
import py
|
||||
import unittest.mock
|
||||
from typing import List
|
||||
|
||||
import pytest
|
||||
from pkg_resources import parse_version
|
||||
import shutil
|
||||
import textwrap
|
||||
from pathlib import Path
|
||||
|
||||
from xdist.looponfail import RemoteControl
|
||||
from xdist.looponfail import StatRecorder
|
||||
|
||||
|
||||
PYTEST_GTE_7 = hasattr(pytest, "version_tuple") and pytest.version_tuple >= (7, 0) # type: ignore[attr-defined]
|
||||
|
||||
|
||||
class TestStatRecorder:
|
||||
def test_filechange(self, tmpdir):
|
||||
tmp = tmpdir
|
||||
hello = tmp.ensure("hello.py")
|
||||
def test_filechange(self, tmp_path: Path) -> None:
|
||||
tmp = tmp_path
|
||||
hello = tmp / "hello.py"
|
||||
hello.touch()
|
||||
sd = StatRecorder([tmp])
|
||||
changed = sd.check()
|
||||
assert not changed
|
||||
|
||||
hello.write("world")
|
||||
hello.write_text("world")
|
||||
changed = sd.check()
|
||||
assert changed
|
||||
|
||||
(hello + "c").write("hello")
|
||||
hello.with_suffix(".pyc").write_text("hello")
|
||||
changed = sd.check()
|
||||
assert not changed
|
||||
|
||||
p = tmp.ensure("new.py")
|
||||
p = tmp / "new.py"
|
||||
p.touch()
|
||||
changed = sd.check()
|
||||
assert changed
|
||||
|
||||
p.remove()
|
||||
p.unlink()
|
||||
changed = sd.check()
|
||||
assert changed
|
||||
|
||||
tmp.join("a", "b", "c.py").ensure()
|
||||
tmp.joinpath("a", "b").mkdir(parents=True)
|
||||
tmp.joinpath("a", "b", "c.py").touch()
|
||||
changed = sd.check()
|
||||
assert changed
|
||||
|
||||
tmp.join("a", "c.txt").ensure()
|
||||
tmp.joinpath("a", "c.txt").touch()
|
||||
changed = sd.check()
|
||||
assert changed
|
||||
changed = sd.check()
|
||||
assert not changed
|
||||
|
||||
tmp.join("a").remove()
|
||||
shutil.rmtree(str(tmp.joinpath("a")))
|
||||
changed = sd.check()
|
||||
assert changed
|
||||
|
||||
def test_dirchange(self, tmpdir):
|
||||
tmp = tmpdir
|
||||
tmp.ensure("dir", "hello.py")
|
||||
def test_dirchange(self, tmp_path: Path) -> None:
|
||||
tmp = tmp_path
|
||||
tmp.joinpath("dir").mkdir()
|
||||
tmp.joinpath("dir", "hello.py").touch()
|
||||
sd = StatRecorder([tmp])
|
||||
assert not sd.fil(tmp.join("dir"))
|
||||
assert not sd.fil(tmp / "dir")
|
||||
|
||||
def test_filechange_deletion_race(self, tmpdir, monkeypatch):
|
||||
tmp = tmpdir
|
||||
def test_filechange_deletion_race(self, tmp_path: Path) -> None:
|
||||
tmp = tmp_path
|
||||
sd = StatRecorder([tmp])
|
||||
changed = sd.check()
|
||||
assert not changed
|
||||
|
||||
p = tmp.ensure("new.py")
|
||||
p = tmp.joinpath("new.py")
|
||||
p.touch()
|
||||
changed = sd.check()
|
||||
assert changed
|
||||
|
||||
p.remove()
|
||||
p.unlink()
|
||||
# make check()'s visit() call return our just removed
|
||||
# path as if we were in a race condition
|
||||
monkeypatch.setattr(tmp, "visit", lambda *args: [p])
|
||||
|
||||
dirname = str(tmp)
|
||||
dirnames: List[str] = []
|
||||
filenames = [str(p)]
|
||||
with unittest.mock.patch(
|
||||
"os.walk", return_value=[(dirname, dirnames, filenames)], autospec=True
|
||||
):
|
||||
changed = sd.check()
|
||||
assert changed
|
||||
|
||||
def test_pycremoval(self, tmpdir):
|
||||
tmp = tmpdir
|
||||
hello = tmp.ensure("hello.py")
|
||||
def test_pycremoval(self, tmp_path: Path) -> None:
|
||||
tmp = tmp_path
|
||||
hello = tmp / "hello.py"
|
||||
hello.touch()
|
||||
sd = StatRecorder([tmp])
|
||||
changed = sd.check()
|
||||
assert not changed
|
||||
|
||||
pycfile = hello + "c"
|
||||
pycfile.ensure()
|
||||
hello.write("world")
|
||||
pycfile = hello.with_suffix(".pyc")
|
||||
pycfile.touch()
|
||||
hello.write_text("world")
|
||||
changed = sd.check()
|
||||
assert changed
|
||||
assert not pycfile.check()
|
||||
assert not pycfile.exists()
|
||||
|
||||
def test_waitonchange(self, tmpdir, monkeypatch):
|
||||
tmp = tmpdir
|
||||
def test_waitonchange(
|
||||
self, tmp_path: Path, monkeypatch: pytest.MonkeyPatch
|
||||
) -> None:
|
||||
tmp = tmp_path
|
||||
sd = StatRecorder([tmp])
|
||||
|
||||
ret_values = [True, False]
|
||||
@@ -93,37 +112,45 @@ class TestStatRecorder:
|
||||
|
||||
|
||||
class TestRemoteControl:
|
||||
def test_nofailures(self, testdir):
|
||||
item = testdir.getitem("def test_func(): pass\n")
|
||||
def test_nofailures(self, pytester: pytest.Pytester) -> None:
|
||||
item = pytester.getitem("def test_func(): pass\n")
|
||||
control = RemoteControl(item.config)
|
||||
control.setup()
|
||||
topdir, failures = control.runsession()[:2]
|
||||
assert not failures
|
||||
|
||||
def test_failures_somewhere(self, testdir):
|
||||
item = testdir.getitem("def test_func():\n assert 0\n")
|
||||
def test_failures_somewhere(self, pytester: pytest.Pytester) -> None:
|
||||
item = pytester.getitem("def test_func():\n assert 0\n")
|
||||
control = RemoteControl(item.config)
|
||||
control.setup()
|
||||
failures = control.runsession()
|
||||
assert failures
|
||||
control.setup()
|
||||
item.fspath.write("def test_func():\n assert 1\n")
|
||||
removepyc(item.fspath)
|
||||
item_path = item.path if PYTEST_GTE_7 else Path(str(item.fspath)) # type: ignore[attr-defined]
|
||||
item_path.write_text("def test_func():\n assert 1\n")
|
||||
removepyc(item_path)
|
||||
topdir, failures = control.runsession()[:2]
|
||||
assert not failures
|
||||
|
||||
def test_failure_change(self, testdir):
|
||||
modcol = testdir.getitem(
|
||||
def test_failure_change(self, pytester: pytest.Pytester) -> None:
|
||||
modcol = pytester.getitem(
|
||||
textwrap.dedent(
|
||||
"""
|
||||
def test_func():
|
||||
assert 0
|
||||
"""
|
||||
)
|
||||
)
|
||||
control = RemoteControl(modcol.config)
|
||||
control.loop_once()
|
||||
assert control.failures
|
||||
modcol.fspath.write(
|
||||
py.code.Source(
|
||||
if PYTEST_GTE_7:
|
||||
modcol_path = modcol.path # type:ignore[attr-defined]
|
||||
else:
|
||||
modcol_path = Path(str(modcol.fspath))
|
||||
|
||||
modcol_path.write_text(
|
||||
textwrap.dedent(
|
||||
"""
|
||||
def test_func():
|
||||
assert 1
|
||||
@@ -132,24 +159,31 @@ class TestRemoteControl:
|
||||
"""
|
||||
)
|
||||
)
|
||||
removepyc(modcol.fspath)
|
||||
removepyc(modcol_path)
|
||||
control.loop_once()
|
||||
assert not control.failures
|
||||
control.loop_once()
|
||||
assert control.failures
|
||||
assert str(control.failures).find("test_new") != -1
|
||||
|
||||
def test_failure_subdir_no_init(self, testdir):
|
||||
modcol = testdir.getitem(
|
||||
def test_failure_subdir_no_init(
|
||||
self, pytester: pytest.Pytester, monkeypatch: pytest.MonkeyPatch
|
||||
) -> None:
|
||||
modcol = pytester.getitem(
|
||||
textwrap.dedent(
|
||||
"""
|
||||
def test_func():
|
||||
assert 0
|
||||
"""
|
||||
)
|
||||
parent = modcol.fspath.dirpath().dirpath()
|
||||
parent.chdir()
|
||||
)
|
||||
if PYTEST_GTE_7:
|
||||
parent = modcol.path.parent.parent # type: ignore[attr-defined]
|
||||
else:
|
||||
parent = Path(modcol.fspath.dirpath().dirpath())
|
||||
monkeypatch.chdir(parent)
|
||||
modcol.config.args = [
|
||||
py.path.local(x).relto(parent) for x in modcol.config.args
|
||||
str(Path(x).relative_to(parent)) for x in modcol.config.args
|
||||
]
|
||||
control = RemoteControl(modcol.config)
|
||||
control.loop_once()
|
||||
@@ -159,8 +193,9 @@ class TestRemoteControl:
|
||||
|
||||
|
||||
class TestLooponFailing:
|
||||
def test_looponfail_from_fail_to_ok(self, testdir):
|
||||
modcol = testdir.getmodulecol(
|
||||
def test_looponfail_from_fail_to_ok(self, pytester: pytest.Pytester) -> None:
|
||||
modcol = pytester.getmodulecol(
|
||||
textwrap.dedent(
|
||||
"""
|
||||
def test_one():
|
||||
x = 0
|
||||
@@ -169,12 +204,14 @@ class TestLooponFailing:
|
||||
assert 1
|
||||
"""
|
||||
)
|
||||
)
|
||||
remotecontrol = RemoteControl(modcol.config)
|
||||
remotecontrol.loop_once()
|
||||
assert len(remotecontrol.failures) == 1
|
||||
|
||||
modcol.fspath.write(
|
||||
py.code.Source(
|
||||
modcol_path = modcol.path if PYTEST_GTE_7 else Path(modcol.fspath)
|
||||
modcol_path.write_text(
|
||||
textwrap.dedent(
|
||||
"""
|
||||
def test_one():
|
||||
assert 1
|
||||
@@ -183,24 +220,27 @@ class TestLooponFailing:
|
||||
"""
|
||||
)
|
||||
)
|
||||
removepyc(modcol.fspath)
|
||||
removepyc(modcol_path)
|
||||
remotecontrol.loop_once()
|
||||
assert not remotecontrol.failures
|
||||
|
||||
def test_looponfail_from_one_to_two_tests(self, testdir):
|
||||
modcol = testdir.getmodulecol(
|
||||
def test_looponfail_from_one_to_two_tests(self, pytester: pytest.Pytester) -> None:
|
||||
modcol = pytester.getmodulecol(
|
||||
textwrap.dedent(
|
||||
"""
|
||||
def test_one():
|
||||
assert 0
|
||||
"""
|
||||
)
|
||||
)
|
||||
remotecontrol = RemoteControl(modcol.config)
|
||||
remotecontrol.loop_once()
|
||||
assert len(remotecontrol.failures) == 1
|
||||
assert "test_one" in remotecontrol.failures[0]
|
||||
|
||||
modcol.fspath.write(
|
||||
py.code.Source(
|
||||
modcol_path = modcol.path if PYTEST_GTE_7 else Path(modcol.fspath)
|
||||
modcol_path.write_text(
|
||||
textwrap.dedent(
|
||||
"""
|
||||
def test_one():
|
||||
assert 1 # passes now
|
||||
@@ -209,7 +249,7 @@ class TestLooponFailing:
|
||||
"""
|
||||
)
|
||||
)
|
||||
removepyc(modcol.fspath)
|
||||
removepyc(modcol_path)
|
||||
remotecontrol.loop_once()
|
||||
assert len(remotecontrol.failures) == 0
|
||||
remotecontrol.loop_once()
|
||||
@@ -217,13 +257,10 @@ class TestLooponFailing:
|
||||
assert "test_one" not in remotecontrol.failures[0]
|
||||
assert "test_two" in remotecontrol.failures[0]
|
||||
|
||||
@pytest.mark.xfail(
|
||||
parse_version(pytest.__version__) >= parse_version("3.1"),
|
||||
reason="broken by pytest 3.1+",
|
||||
strict=True,
|
||||
)
|
||||
def test_looponfail_removed_test(self, testdir):
|
||||
modcol = testdir.getmodulecol(
|
||||
@pytest.mark.xfail(reason="broken by pytest 3.1+", strict=True)
|
||||
def test_looponfail_removed_test(self, pytester: pytest.Pytester) -> None:
|
||||
modcol = pytester.getmodulecol(
|
||||
textwrap.dedent(
|
||||
"""
|
||||
def test_one():
|
||||
assert 0
|
||||
@@ -231,12 +268,13 @@ class TestLooponFailing:
|
||||
assert 0
|
||||
"""
|
||||
)
|
||||
)
|
||||
remotecontrol = RemoteControl(modcol.config)
|
||||
remotecontrol.loop_once()
|
||||
assert len(remotecontrol.failures) == 2
|
||||
|
||||
modcol.fspath.write(
|
||||
py.code.Source(
|
||||
modcol.path.write_text(
|
||||
textwrap.dedent(
|
||||
"""
|
||||
def test_xxx(): # renamed test
|
||||
assert 0
|
||||
@@ -245,20 +283,24 @@ class TestLooponFailing:
|
||||
"""
|
||||
)
|
||||
)
|
||||
removepyc(modcol.fspath)
|
||||
removepyc(modcol.path)
|
||||
remotecontrol.loop_once()
|
||||
assert len(remotecontrol.failures) == 0
|
||||
|
||||
remotecontrol.loop_once()
|
||||
assert len(remotecontrol.failures) == 1
|
||||
|
||||
def test_looponfail_multiple_errors(self, testdir, monkeypatch):
|
||||
modcol = testdir.getmodulecol(
|
||||
def test_looponfail_multiple_errors(
|
||||
self, pytester: pytest.Pytester, monkeypatch: pytest.MonkeyPatch
|
||||
) -> None:
|
||||
modcol = pytester.getmodulecol(
|
||||
textwrap.dedent(
|
||||
"""
|
||||
def test_one():
|
||||
assert 0
|
||||
"""
|
||||
)
|
||||
)
|
||||
remotecontrol = RemoteControl(modcol.config)
|
||||
orig_runsession = remotecontrol.runsession
|
||||
|
||||
@@ -274,55 +316,59 @@ class TestLooponFailing:
|
||||
|
||||
|
||||
class TestFunctional:
|
||||
def test_fail_to_ok(self, testdir):
|
||||
p = testdir.makepyfile(
|
||||
def test_fail_to_ok(self, pytester: pytest.Pytester) -> None:
|
||||
p = pytester.makepyfile(
|
||||
textwrap.dedent(
|
||||
"""
|
||||
def test_one():
|
||||
x = 0
|
||||
assert x == 1
|
||||
"""
|
||||
)
|
||||
# p = testdir.mkdir("sub").join(p1.basename)
|
||||
)
|
||||
# p = pytester.mkdir("sub").join(p1.basename)
|
||||
# p1.move(p)
|
||||
child = testdir.spawn_pytest("-f %s --traceconfig" % p, expect_timeout=30.0)
|
||||
child = pytester.spawn_pytest("-f %s --traceconfig" % p, expect_timeout=30.0)
|
||||
child.expect("def test_one")
|
||||
child.expect("x == 1")
|
||||
child.expect("1 failed")
|
||||
child.expect("### LOOPONFAILING ####")
|
||||
child.expect("waiting for changes")
|
||||
p.write(
|
||||
py.code.Source(
|
||||
p.write_text(
|
||||
textwrap.dedent(
|
||||
"""
|
||||
def test_one():
|
||||
x = 1
|
||||
assert x == 1
|
||||
"""
|
||||
)
|
||||
),
|
||||
)
|
||||
child.expect(".*1 passed.*")
|
||||
child.kill(15)
|
||||
|
||||
def test_xfail_passes(self, testdir):
|
||||
p = testdir.makepyfile(
|
||||
def test_xfail_passes(self, pytester: pytest.Pytester) -> None:
|
||||
p = pytester.makepyfile(
|
||||
textwrap.dedent(
|
||||
"""
|
||||
import py
|
||||
@py.test.mark.xfail
|
||||
import pytest
|
||||
@pytest.mark.xfail
|
||||
def test_one():
|
||||
pass
|
||||
"""
|
||||
)
|
||||
child = testdir.spawn_pytest("-f %s" % p, expect_timeout=30.0)
|
||||
)
|
||||
child = pytester.spawn_pytest("-f %s" % p, expect_timeout=30.0)
|
||||
child.expect("1 xpass")
|
||||
# child.expect("### LOOPONFAILING ####")
|
||||
child.expect("waiting for changes")
|
||||
child.kill(15)
|
||||
|
||||
|
||||
def removepyc(path):
|
||||
def removepyc(path: Path) -> None:
|
||||
# XXX damn those pyc files
|
||||
pyc = path + "c"
|
||||
if pyc.check():
|
||||
pyc.remove()
|
||||
c = path.dirpath("__pycache__")
|
||||
if c.check():
|
||||
c.remove()
|
||||
pyc = path.with_suffix(".pyc")
|
||||
if pyc.exists():
|
||||
pyc.unlink()
|
||||
c = path.parent / "__pycache__"
|
||||
if c.exists():
|
||||
shutil.rmtree(c)
|
||||
|
||||
@@ -3,8 +3,8 @@ import pytest
|
||||
|
||||
class TestHooks:
|
||||
@pytest.fixture(autouse=True)
|
||||
def create_test_file(self, testdir):
|
||||
testdir.makepyfile(
|
||||
def create_test_file(self, pytester: pytest.Pytester) -> None:
|
||||
pytester.makepyfile(
|
||||
"""
|
||||
import os
|
||||
def test_a(): pass
|
||||
@@ -13,11 +13,11 @@ class TestHooks:
|
||||
"""
|
||||
)
|
||||
|
||||
def test_runtest_logreport(self, testdir):
|
||||
def test_runtest_logreport(self, pytester: pytest.Pytester) -> None:
|
||||
"""Test that log reports from pytest_runtest_logreport when running
|
||||
with xdist contain "node", "nodeid", "worker_id", and "testrun_uid" attributes. (#8)
|
||||
"""
|
||||
testdir.makeconftest(
|
||||
pytester.makeconftest(
|
||||
"""
|
||||
def pytest_runtest_logreport(report):
|
||||
if hasattr(report, 'node'):
|
||||
@@ -35,7 +35,7 @@ class TestHooks:
|
||||
% (report.nodeid, report.worker_id, report.testrun_uid))
|
||||
"""
|
||||
)
|
||||
res = testdir.runpytest("-n1", "-s")
|
||||
res = pytester.runpytest("-n1", "-s")
|
||||
res.stdout.fnmatch_lines(
|
||||
[
|
||||
"*HOOK: test_runtest_logreport.py::test_a gw0 *",
|
||||
@@ -45,10 +45,9 @@ class TestHooks:
|
||||
]
|
||||
)
|
||||
|
||||
def test_node_collection_finished(self, testdir):
|
||||
"""Test pytest_xdist_node_collection_finished hook (#8).
|
||||
"""
|
||||
testdir.makeconftest(
|
||||
def test_node_collection_finished(self, pytester: pytest.Pytester) -> None:
|
||||
"""Test pytest_xdist_node_collection_finished hook (#8)."""
|
||||
pytester.makeconftest(
|
||||
"""
|
||||
def pytest_xdist_node_collection_finished(node, ids):
|
||||
workerid = node.workerinput['workerid']
|
||||
@@ -56,8 +55,67 @@ class TestHooks:
|
||||
print("HOOK: %s %s" % (workerid, ', '.join(stripped_ids)))
|
||||
"""
|
||||
)
|
||||
res = testdir.runpytest("-n2", "-s")
|
||||
res = pytester.runpytest("-n2", "-s")
|
||||
res.stdout.fnmatch_lines_random(
|
||||
["*HOOK: gw0 test_a, test_b, test_c", "*HOOK: gw1 test_a, test_b, test_c"]
|
||||
)
|
||||
res.stdout.fnmatch_lines(["*3 passed*"])
|
||||
|
||||
|
||||
class TestCrashItem:
|
||||
@pytest.fixture(autouse=True)
|
||||
def create_test_file(self, pytester: pytest.Pytester) -> None:
|
||||
pytester.makepyfile(
|
||||
"""
|
||||
import os
|
||||
def test_a(): pass
|
||||
def test_b(): os._exit(1)
|
||||
def test_c(): pass
|
||||
def test_d(): pass
|
||||
"""
|
||||
)
|
||||
|
||||
def test_handlecrashitem(self, pytester: pytest.Pytester) -> None:
|
||||
"""Test pytest_handlecrashitem hook."""
|
||||
pytester.makeconftest(
|
||||
"""
|
||||
test_runs = 0
|
||||
|
||||
def pytest_handlecrashitem(crashitem, report, sched):
|
||||
global test_runs
|
||||
|
||||
if test_runs == 0:
|
||||
sched.mark_test_pending(crashitem)
|
||||
test_runs = 1
|
||||
else:
|
||||
print("HOOK: pytest_handlecrashitem")
|
||||
"""
|
||||
)
|
||||
res = pytester.runpytest("-n2", "-s")
|
||||
res.stdout.fnmatch_lines_random(["*HOOK: pytest_handlecrashitem"])
|
||||
res.stdout.fnmatch_lines(["*3 passed*"])
|
||||
|
||||
def test_handlecrashitem_one(self, pytester: pytest.Pytester) -> None:
|
||||
"""Test pytest_handlecrashitem hook with just one test."""
|
||||
pytester.makeconftest(
|
||||
"""
|
||||
test_runs = 0
|
||||
|
||||
def pytest_handlecrashitem(crashitem, report, sched):
|
||||
global test_runs
|
||||
|
||||
if test_runs == 0:
|
||||
sched.mark_test_pending(crashitem)
|
||||
test_runs = 1
|
||||
else:
|
||||
print("HOOK: pytest_handlecrashitem")
|
||||
"""
|
||||
)
|
||||
res = pytester.runpytest("-n1", "-s", "-k", "test_b")
|
||||
res.stdout.fnmatch_lines_random(["*HOOK: pytest_handlecrashitem"])
|
||||
res.stdout.fnmatch_lines(
|
||||
[
|
||||
"FAILED test_handlecrashitem_one.py::test_b",
|
||||
"FAILED test_handlecrashitem_one.py::test_b",
|
||||
]
|
||||
)
|
||||
|
||||
@@ -1,43 +1,63 @@
|
||||
import py
|
||||
from contextlib import suppress
|
||||
from pathlib import Path
|
||||
import sys
|
||||
import os
|
||||
|
||||
import execnet
|
||||
from xdist.workermanage import NodeManager
|
||||
|
||||
import pytest
|
||||
|
||||
def test_dist_incompatibility_messages(testdir):
|
||||
result = testdir.runpytest("--pdb", "--looponfail")
|
||||
|
||||
@pytest.fixture
|
||||
def monkeypatch_3_cpus(monkeypatch: pytest.MonkeyPatch):
|
||||
"""Make pytest-xdist believe the system has 3 CPUs"""
|
||||
monkeypatch.setitem(sys.modules, "psutil", None) # block import
|
||||
monkeypatch.delattr(os, "sched_getaffinity", raising=False)
|
||||
monkeypatch.setattr(os, "cpu_count", lambda: 3)
|
||||
|
||||
|
||||
def test_dist_incompatibility_messages(pytester: pytest.Pytester) -> None:
|
||||
result = pytester.runpytest("--pdb", "--looponfail")
|
||||
assert result.ret != 0
|
||||
result = testdir.runpytest("--pdb", "-n", "3")
|
||||
result = pytester.runpytest("--pdb", "-n", "3")
|
||||
assert result.ret != 0
|
||||
assert "incompatible" in result.stderr.str()
|
||||
result = testdir.runpytest("--pdb", "-d", "--tx", "popen")
|
||||
result = pytester.runpytest("--pdb", "-d", "--tx", "popen")
|
||||
assert result.ret != 0
|
||||
assert "incompatible" in result.stderr.str()
|
||||
|
||||
|
||||
def test_dist_options(testdir):
|
||||
def test_dist_options(pytester: pytest.Pytester) -> None:
|
||||
from xdist.plugin import pytest_cmdline_main as check_options
|
||||
|
||||
config = testdir.parseconfigure("-n 2")
|
||||
config = pytester.parseconfigure("-n 2")
|
||||
check_options(config)
|
||||
assert config.option.dist == "load"
|
||||
assert config.option.tx == ["popen"] * 2
|
||||
config = testdir.parseconfigure("--numprocesses", "2")
|
||||
config = pytester.parseconfigure("--numprocesses", "2")
|
||||
check_options(config)
|
||||
assert config.option.dist == "load"
|
||||
assert config.option.tx == ["popen"] * 2
|
||||
config = testdir.parseconfigure("--numprocesses", "3", "--maxprocesses", "2")
|
||||
config = pytester.parseconfigure("--numprocesses", "3", "--maxprocesses", "2")
|
||||
check_options(config)
|
||||
assert config.option.dist == "load"
|
||||
assert config.option.tx == ["popen"] * 2
|
||||
config = testdir.parseconfigure("-d")
|
||||
config = pytester.parseconfigure("-d")
|
||||
check_options(config)
|
||||
assert config.option.dist == "load"
|
||||
|
||||
|
||||
def test_auto_detect_cpus(testdir, monkeypatch):
|
||||
import os
|
||||
def test_auto_detect_cpus(
|
||||
pytester: pytest.Pytester, monkeypatch: pytest.MonkeyPatch
|
||||
) -> None:
|
||||
from xdist.plugin import pytest_cmdline_main as check_options
|
||||
|
||||
with suppress(ImportError):
|
||||
import psutil
|
||||
|
||||
monkeypatch.setattr(psutil, "cpu_count", lambda logical=True: None)
|
||||
|
||||
if hasattr(os, "sched_getaffinity"):
|
||||
monkeypatch.setattr(os, "sched_getaffinity", lambda _pid: set(range(99)))
|
||||
elif hasattr(os, "cpu_count"):
|
||||
@@ -47,13 +67,20 @@ def test_auto_detect_cpus(testdir, monkeypatch):
|
||||
|
||||
monkeypatch.setattr(multiprocessing, "cpu_count", lambda: 99)
|
||||
|
||||
config = testdir.parseconfigure("-n2")
|
||||
config = pytester.parseconfigure("-n2")
|
||||
assert config.getoption("numprocesses") == 2
|
||||
|
||||
config = testdir.parseconfigure("-nauto")
|
||||
config = pytester.parseconfigure("-nauto")
|
||||
check_options(config)
|
||||
assert config.getoption("numprocesses") == 99
|
||||
|
||||
config = testdir.parseconfigure("-nauto", "--pdb")
|
||||
config = pytester.parseconfigure("-nauto", "--pdb")
|
||||
check_options(config)
|
||||
assert config.getoption("usepdb")
|
||||
assert config.getoption("numprocesses") == 0
|
||||
assert config.getoption("dist") == "no"
|
||||
|
||||
config = pytester.parseconfigure("-nlogical", "--pdb")
|
||||
check_options(config)
|
||||
assert config.getoption("usepdb")
|
||||
assert config.getoption("numprocesses") == 0
|
||||
@@ -61,56 +88,192 @@ def test_auto_detect_cpus(testdir, monkeypatch):
|
||||
|
||||
monkeypatch.delattr(os, "sched_getaffinity", raising=False)
|
||||
monkeypatch.setenv("TRAVIS", "true")
|
||||
config = testdir.parseconfigure("-nauto")
|
||||
config = pytester.parseconfigure("-nauto")
|
||||
check_options(config)
|
||||
assert config.getoption("numprocesses") == 2
|
||||
|
||||
|
||||
def test_boxed_with_collect_only(testdir):
|
||||
def test_auto_detect_cpus_psutil(
|
||||
pytester: pytest.Pytester, monkeypatch: pytest.MonkeyPatch
|
||||
) -> None:
|
||||
from xdist.plugin import pytest_cmdline_main as check_options
|
||||
|
||||
config = testdir.parseconfigure("-n1", "--boxed")
|
||||
psutil = pytest.importorskip("psutil")
|
||||
|
||||
monkeypatch.setattr(psutil, "cpu_count", lambda logical=True: 84 if logical else 42)
|
||||
|
||||
config = pytester.parseconfigure("-nauto")
|
||||
check_options(config)
|
||||
assert config.option.forked
|
||||
assert config.getoption("numprocesses") == 42
|
||||
|
||||
config = testdir.parseconfigure("-n1", "--collect-only")
|
||||
config = pytester.parseconfigure("-nlogical")
|
||||
check_options(config)
|
||||
assert not config.option.forked
|
||||
assert config.getoption("numprocesses") == 84
|
||||
|
||||
config = testdir.parseconfigure("-n1", "--boxed", "--collect-only")
|
||||
|
||||
def test_auto_detect_cpus_os(
|
||||
pytester: pytest.Pytester, monkeypatch: pytest.MonkeyPatch, monkeypatch_3_cpus
|
||||
) -> None:
|
||||
from xdist.plugin import pytest_cmdline_main as check_options
|
||||
|
||||
config = pytester.parseconfigure("-nauto")
|
||||
check_options(config)
|
||||
assert config.option.forked
|
||||
assert config.getoption("numprocesses") == 3
|
||||
|
||||
config = pytester.parseconfigure("-nlogical")
|
||||
check_options(config)
|
||||
assert config.getoption("numprocesses") == 3
|
||||
|
||||
|
||||
def test_dsession_with_collect_only(testdir):
|
||||
def test_hook_auto_num_workers(
|
||||
pytester: pytest.Pytester, monkeypatch: pytest.MonkeyPatch
|
||||
) -> None:
|
||||
from xdist.plugin import pytest_cmdline_main as check_options
|
||||
|
||||
pytester.makeconftest(
|
||||
"""
|
||||
def pytest_xdist_auto_num_workers():
|
||||
return 42
|
||||
"""
|
||||
)
|
||||
config = pytester.parseconfigure("-nauto")
|
||||
check_options(config)
|
||||
assert config.getoption("numprocesses") == 42
|
||||
|
||||
config = pytester.parseconfigure("-nlogical")
|
||||
check_options(config)
|
||||
assert config.getoption("numprocesses") == 42
|
||||
|
||||
|
||||
def test_hook_auto_num_workers_arg(
|
||||
pytester: pytest.Pytester, monkeypatch: pytest.MonkeyPatch
|
||||
) -> None:
|
||||
# config.option.numprocesses is a pytest feature,
|
||||
# but we document it so let's test it.
|
||||
from xdist.plugin import pytest_cmdline_main as check_options
|
||||
|
||||
pytester.makeconftest(
|
||||
"""
|
||||
def pytest_xdist_auto_num_workers(config):
|
||||
if config.option.numprocesses == 'auto':
|
||||
return 42
|
||||
if config.option.numprocesses == 'logical':
|
||||
return 8
|
||||
"""
|
||||
)
|
||||
config = pytester.parseconfigure("-nauto")
|
||||
check_options(config)
|
||||
assert config.getoption("numprocesses") == 42
|
||||
|
||||
config = pytester.parseconfigure("-nlogical")
|
||||
check_options(config)
|
||||
assert config.getoption("numprocesses") == 8
|
||||
|
||||
|
||||
def test_hook_auto_num_workers_none(
|
||||
pytester: pytest.Pytester, monkeypatch: pytest.MonkeyPatch, monkeypatch_3_cpus
|
||||
) -> None:
|
||||
# Returning None from a hook to skip it is pytest behavior,
|
||||
# but we document it so let's test it.
|
||||
from xdist.plugin import pytest_cmdline_main as check_options
|
||||
|
||||
pytester.makeconftest(
|
||||
"""
|
||||
def pytest_xdist_auto_num_workers():
|
||||
return None
|
||||
"""
|
||||
)
|
||||
config = pytester.parseconfigure("-nauto")
|
||||
check_options(config)
|
||||
assert config.getoption("numprocesses") == 3
|
||||
|
||||
monkeypatch.setenv("PYTEST_XDIST_AUTO_NUM_WORKERS", "5")
|
||||
|
||||
config = pytester.parseconfigure("-nauto")
|
||||
check_options(config)
|
||||
assert config.getoption("numprocesses") == 5
|
||||
|
||||
|
||||
def test_envvar_auto_num_workers(
|
||||
pytester: pytest.Pytester, monkeypatch: pytest.MonkeyPatch
|
||||
) -> None:
|
||||
from xdist.plugin import pytest_cmdline_main as check_options
|
||||
|
||||
monkeypatch.setenv("PYTEST_XDIST_AUTO_NUM_WORKERS", "7")
|
||||
|
||||
config = pytester.parseconfigure("-nauto")
|
||||
check_options(config)
|
||||
assert config.getoption("numprocesses") == 7
|
||||
|
||||
config = pytester.parseconfigure("-nlogical")
|
||||
check_options(config)
|
||||
assert config.getoption("numprocesses") == 7
|
||||
|
||||
|
||||
def test_envvar_auto_num_workers_warn(
|
||||
pytester: pytest.Pytester, monkeypatch: pytest.MonkeyPatch, monkeypatch_3_cpus
|
||||
) -> None:
|
||||
from xdist.plugin import pytest_cmdline_main as check_options
|
||||
|
||||
monkeypatch.setenv("PYTEST_XDIST_AUTO_NUM_WORKERS", "fourscore")
|
||||
|
||||
config = pytester.parseconfigure("-nauto")
|
||||
with pytest.warns(UserWarning):
|
||||
check_options(config)
|
||||
assert config.getoption("numprocesses") == 3
|
||||
|
||||
|
||||
def test_auto_num_workers_hook_overrides_envvar(
|
||||
pytester: pytest.Pytester, monkeypatch: pytest.MonkeyPatch, monkeypatch_3_cpus
|
||||
) -> None:
|
||||
from xdist.plugin import pytest_cmdline_main as check_options
|
||||
|
||||
monkeypatch.setenv("PYTEST_XDIST_AUTO_NUM_WORKERS", "987")
|
||||
pytester.makeconftest(
|
||||
"""
|
||||
def pytest_xdist_auto_num_workers():
|
||||
return 2
|
||||
"""
|
||||
)
|
||||
config = pytester.parseconfigure("-nauto")
|
||||
check_options(config)
|
||||
assert config.getoption("numprocesses") == 2
|
||||
|
||||
config = pytester.parseconfigure("-nauto")
|
||||
check_options(config)
|
||||
assert config.getoption("numprocesses") == 2
|
||||
|
||||
|
||||
def test_dsession_with_collect_only(pytester: pytest.Pytester) -> None:
|
||||
from xdist.plugin import pytest_cmdline_main as check_options
|
||||
from xdist.plugin import pytest_configure as configure
|
||||
|
||||
config = testdir.parseconfigure("-n1")
|
||||
config = pytester.parseconfigure("-n1")
|
||||
check_options(config)
|
||||
configure(config)
|
||||
assert config.pluginmanager.hasplugin("dsession")
|
||||
|
||||
config = testdir.parseconfigure("-n1", "--collect-only")
|
||||
config = pytester.parseconfigure("-n1", "--collect-only")
|
||||
check_options(config)
|
||||
configure(config)
|
||||
assert not config.pluginmanager.hasplugin("dsession")
|
||||
|
||||
|
||||
def test_testrunuid_provided(testdir):
|
||||
config = testdir.parseconfigure("--testrunuid", "test123", "--tx=popen")
|
||||
def test_testrunuid_provided(pytester: pytest.Pytester) -> None:
|
||||
config = pytester.parseconfigure("--testrunuid", "test123", "--tx=popen")
|
||||
nm = NodeManager(config)
|
||||
assert nm.testrunuid == "test123"
|
||||
|
||||
|
||||
def test_testrunuid_generated(testdir):
|
||||
config = testdir.parseconfigure("--tx=popen")
|
||||
def test_testrunuid_generated(pytester: pytest.Pytester) -> None:
|
||||
config = pytester.parseconfigure("--tx=popen")
|
||||
nm = NodeManager(config)
|
||||
assert len(nm.testrunuid) == 32
|
||||
|
||||
|
||||
class TestDistOptions:
|
||||
def test_getxspecs(self, testdir):
|
||||
config = testdir.parseconfigure("--tx=popen", "--tx", "ssh=xyz")
|
||||
def test_getxspecs(self, pytester: pytest.Pytester) -> None:
|
||||
config = pytester.parseconfigure("--tx=popen", "--tx", "ssh=xyz")
|
||||
nodemanager = NodeManager(config)
|
||||
xspecs = nodemanager._getxspecs()
|
||||
assert len(xspecs) == 2
|
||||
@@ -118,39 +281,39 @@ class TestDistOptions:
|
||||
assert xspecs[0].popen
|
||||
assert xspecs[1].ssh == "xyz"
|
||||
|
||||
def test_xspecs_multiplied(self, testdir):
|
||||
config = testdir.parseconfigure("--tx=3*popen")
|
||||
def test_xspecs_multiplied(self, pytester: pytest.Pytester) -> None:
|
||||
config = pytester.parseconfigure("--tx=3*popen")
|
||||
xspecs = NodeManager(config)._getxspecs()
|
||||
assert len(xspecs) == 3
|
||||
assert xspecs[1].popen
|
||||
|
||||
def test_getrsyncdirs(self, testdir):
|
||||
config = testdir.parseconfigure("--rsyncdir=" + str(testdir.tmpdir))
|
||||
def test_getrsyncdirs(self, pytester: pytest.Pytester) -> None:
|
||||
config = pytester.parseconfigure("--rsyncdir=" + str(pytester.path))
|
||||
nm = NodeManager(config, specs=[execnet.XSpec("popen")])
|
||||
assert not nm._getrsyncdirs()
|
||||
nm = NodeManager(config, specs=[execnet.XSpec("popen//chdir=qwe")])
|
||||
assert nm.roots
|
||||
assert testdir.tmpdir in nm.roots
|
||||
assert pytester.path in nm.roots
|
||||
|
||||
def test_getrsyncignore(self, testdir):
|
||||
config = testdir.parseconfigure("--rsyncignore=fo*")
|
||||
def test_getrsyncignore(self, pytester: pytest.Pytester) -> None:
|
||||
config = pytester.parseconfigure("--rsyncignore=fo*")
|
||||
nm = NodeManager(config, specs=[execnet.XSpec("popen//chdir=qwe")])
|
||||
assert "fo*" in nm.rsyncoptions["ignores"]
|
||||
|
||||
def test_getrsyncdirs_with_conftest(self, testdir):
|
||||
p = py.path.local()
|
||||
for bn in "x y z".split():
|
||||
p.mkdir(bn)
|
||||
testdir.makeini(
|
||||
def test_getrsyncdirs_with_conftest(self, pytester: pytest.Pytester) -> None:
|
||||
p = Path.cwd()
|
||||
for bn in ("x", "y", "z"):
|
||||
p.joinpath(bn).mkdir()
|
||||
pytester.makeini(
|
||||
"""
|
||||
[pytest]
|
||||
rsyncdirs= x
|
||||
"""
|
||||
)
|
||||
config = testdir.parseconfigure(testdir.tmpdir, "--rsyncdir=y", "--rsyncdir=z")
|
||||
config = pytester.parseconfigure(pytester.path, "--rsyncdir=y", "--rsyncdir=z")
|
||||
nm = NodeManager(config, specs=[execnet.XSpec("popen//chdir=xyz")])
|
||||
roots = nm._getrsyncdirs()
|
||||
# assert len(roots) == 3 + 1 # pylib
|
||||
assert py.path.local("y") in roots
|
||||
assert py.path.local("z") in roots
|
||||
assert testdir.tmpdir.join("x") in roots
|
||||
assert Path("y").resolve() in roots
|
||||
assert Path("z").resolve() in roots
|
||||
assert pytester.path.joinpath("x") in roots
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
import py
|
||||
import pprint
|
||||
import pytest
|
||||
import sys
|
||||
@@ -8,7 +7,7 @@ from xdist.workermanage import WorkerController
|
||||
import execnet
|
||||
import marshal
|
||||
|
||||
from six.moves.queue import Queue
|
||||
from queue import Queue
|
||||
|
||||
WAIT_TIMEOUT = 10.0
|
||||
|
||||
@@ -32,16 +31,16 @@ class EventCall:
|
||||
class WorkerSetup:
|
||||
use_callback = False
|
||||
|
||||
def __init__(self, request, testdir):
|
||||
def __init__(self, request, pytester: pytest.Pytester) -> None:
|
||||
self.request = request
|
||||
self.testdir = testdir
|
||||
self.events = Queue()
|
||||
self.pytester = pytester
|
||||
self.events = Queue() # type: ignore[var-annotated]
|
||||
|
||||
def setup(self,):
|
||||
self.testdir.chdir()
|
||||
def setup(self) -> None:
|
||||
self.pytester.chdir()
|
||||
# import os ; os.environ['EXECNET_DEBUG'] = "2"
|
||||
self.gateway = execnet.makegateway()
|
||||
self.config = config = self.testdir.parseconfigure()
|
||||
self.config = config = self.pytester.parseconfigure()
|
||||
putevent = self.use_callback and self.events.put or None
|
||||
|
||||
class DummyMananger:
|
||||
@@ -68,15 +67,15 @@ class WorkerSetup:
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def worker(request, testdir):
|
||||
return WorkerSetup(request, testdir)
|
||||
def worker(request, pytester: pytest.Pytester) -> WorkerSetup:
|
||||
return WorkerSetup(request, pytester)
|
||||
|
||||
|
||||
@pytest.mark.xfail(reason="#59")
|
||||
def test_remoteinitconfig(testdir):
|
||||
def test_remoteinitconfig(pytester: pytest.Pytester) -> None:
|
||||
from xdist.remote import remote_initconfig
|
||||
|
||||
config1 = testdir.parseconfig()
|
||||
config1 = pytester.parseconfig()
|
||||
config2 = remote_initconfig(config1.option.__dict__, config1.args)
|
||||
assert config2.option.__dict__ == config1.option.__dict__
|
||||
assert config2.pluginmanager.getplugin("terminal") in (-1, None)
|
||||
@@ -92,8 +91,10 @@ class TestWorkerInteractor:
|
||||
|
||||
return unserialize
|
||||
|
||||
def test_basic_collect_and_runtests(self, worker, unserialize_report):
|
||||
worker.testdir.makepyfile(
|
||||
def test_basic_collect_and_runtests(
|
||||
self, worker: WorkerSetup, unserialize_report
|
||||
) -> None:
|
||||
worker.pytester.makepyfile(
|
||||
"""
|
||||
def test_func():
|
||||
pass
|
||||
@@ -106,7 +107,7 @@ class TestWorkerInteractor:
|
||||
assert ev.name == "collectionstart"
|
||||
assert not ev.kwargs
|
||||
ev = worker.popevent("collectionfinish")
|
||||
assert ev.kwargs["topdir"] == worker.testdir.tmpdir
|
||||
assert ev.kwargs["topdir"] == str(worker.pytester.path)
|
||||
ids = ev.kwargs["ids"]
|
||||
assert len(ids) == 1
|
||||
worker.sendcommand("runtests", indices=list(range(len(ids))))
|
||||
@@ -124,8 +125,8 @@ class TestWorkerInteractor:
|
||||
ev = worker.popevent("workerfinished")
|
||||
assert "workeroutput" in ev.kwargs
|
||||
|
||||
def test_remote_collect_skip(self, worker, unserialize_report):
|
||||
worker.testdir.makepyfile(
|
||||
def test_remote_collect_skip(self, worker: WorkerSetup, unserialize_report) -> None:
|
||||
worker.pytester.makepyfile(
|
||||
"""
|
||||
import pytest
|
||||
pytest.skip("hello", allow_module_level=True)
|
||||
@@ -142,8 +143,8 @@ class TestWorkerInteractor:
|
||||
ev = worker.popevent("collectionfinish")
|
||||
assert not ev.kwargs["ids"]
|
||||
|
||||
def test_remote_collect_fail(self, worker, unserialize_report):
|
||||
worker.testdir.makepyfile("""aasd qwe""")
|
||||
def test_remote_collect_fail(self, worker: WorkerSetup, unserialize_report) -> None:
|
||||
worker.pytester.makepyfile("""aasd qwe""")
|
||||
worker.setup()
|
||||
ev = worker.popevent("collectionstart")
|
||||
assert not ev.kwargs
|
||||
@@ -154,8 +155,8 @@ class TestWorkerInteractor:
|
||||
ev = worker.popevent("collectionfinish")
|
||||
assert not ev.kwargs["ids"]
|
||||
|
||||
def test_runtests_all(self, worker, unserialize_report):
|
||||
worker.testdir.makepyfile(
|
||||
def test_runtests_all(self, worker: WorkerSetup, unserialize_report) -> None:
|
||||
worker.pytester.makepyfile(
|
||||
"""
|
||||
def test_func(): pass
|
||||
def test_func2(): pass
|
||||
@@ -181,17 +182,19 @@ class TestWorkerInteractor:
|
||||
ev = worker.popevent("workerfinished")
|
||||
assert "workeroutput" in ev.kwargs
|
||||
|
||||
def test_happy_run_events_converted(self, testdir, worker):
|
||||
py.test.xfail("implement a simple test for event production")
|
||||
assert not worker.use_callback
|
||||
worker.testdir.makepyfile(
|
||||
def test_happy_run_events_converted(
|
||||
self, pytester: pytest.Pytester, worker: WorkerSetup
|
||||
) -> None:
|
||||
pytest.xfail("implement a simple test for event production")
|
||||
assert not worker.use_callback # type: ignore[unreachable]
|
||||
worker.pytester.makepyfile(
|
||||
"""
|
||||
def test_func():
|
||||
pass
|
||||
"""
|
||||
)
|
||||
worker.setup()
|
||||
hookrec = testdir.getreportrecorder(worker.config)
|
||||
hookrec = pytester.getreportrecorder(worker.config)
|
||||
for data in worker.slp.channel:
|
||||
worker.slp.process_from_remote(data)
|
||||
worker.slp.process_from_remote(worker.slp.ENDMARK)
|
||||
@@ -207,7 +210,9 @@ class TestWorkerInteractor:
|
||||
]
|
||||
)
|
||||
|
||||
def test_process_from_remote_error_handling(self, worker, capsys):
|
||||
def test_process_from_remote_error_handling(
|
||||
self, worker: WorkerSetup, capsys: pytest.CaptureFixture[str]
|
||||
) -> None:
|
||||
worker.use_callback = True
|
||||
worker.setup()
|
||||
worker.slp.process_from_remote(("<nonono>", ()))
|
||||
@@ -217,8 +222,8 @@ class TestWorkerInteractor:
|
||||
assert ev.name == "errordown"
|
||||
|
||||
|
||||
def test_remote_env_vars(testdir):
|
||||
testdir.makepyfile(
|
||||
def test_remote_env_vars(pytester: pytest.Pytester) -> None:
|
||||
pytester.makepyfile(
|
||||
"""
|
||||
import os
|
||||
def test():
|
||||
@@ -227,13 +232,13 @@ def test_remote_env_vars(testdir):
|
||||
assert os.environ['PYTEST_XDIST_WORKER_COUNT'] == '2'
|
||||
"""
|
||||
)
|
||||
result = testdir.runpytest("-n2", "--max-worker-restart=0")
|
||||
result = pytester.runpytest("-n2", "--max-worker-restart=0")
|
||||
assert result.ret == 0
|
||||
|
||||
|
||||
def test_remote_inner_argv(testdir):
|
||||
def test_remote_inner_argv(pytester: pytest.Pytester) -> None:
|
||||
"""Test/document the behavior due to execnet using `python -c`."""
|
||||
testdir.makepyfile(
|
||||
pytester.makepyfile(
|
||||
"""
|
||||
import sys
|
||||
|
||||
@@ -241,14 +246,14 @@ def test_remote_inner_argv(testdir):
|
||||
assert sys.argv == ["-c"]
|
||||
"""
|
||||
)
|
||||
result = testdir.runpytest("-n1")
|
||||
result = pytester.runpytest("-n1")
|
||||
assert result.ret == 0
|
||||
|
||||
|
||||
def test_remote_mainargv(testdir):
|
||||
def test_remote_mainargv(pytester: pytest.Pytester) -> None:
|
||||
outer_argv = sys.argv
|
||||
|
||||
testdir.makepyfile(
|
||||
pytester.makepyfile(
|
||||
"""
|
||||
def test_mainargv(request):
|
||||
assert request.config.workerinput["mainargv"] == {!r}
|
||||
@@ -256,14 +261,14 @@ def test_remote_mainargv(testdir):
|
||||
outer_argv
|
||||
)
|
||||
)
|
||||
result = testdir.runpytest("-n1")
|
||||
result = pytester.runpytest("-n1")
|
||||
assert result.ret == 0
|
||||
|
||||
|
||||
def test_remote_usage_prog(testdir, request):
|
||||
def test_remote_usage_prog(pytester: pytest.Pytester, request) -> None:
|
||||
if not hasattr(request.config._parser, "prog"):
|
||||
pytest.skip("prog not available in config parser")
|
||||
testdir.makeconftest(
|
||||
pytester.makeconftest(
|
||||
"""
|
||||
import pytest
|
||||
|
||||
@@ -278,7 +283,7 @@ def test_remote_usage_prog(testdir, request):
|
||||
config_parser = config._parser
|
||||
"""
|
||||
)
|
||||
testdir.makepyfile(
|
||||
pytester.makepyfile(
|
||||
"""
|
||||
import sys
|
||||
|
||||
@@ -287,6 +292,20 @@ def test_remote_usage_prog(testdir, request):
|
||||
"""
|
||||
)
|
||||
|
||||
result = testdir.runpytest_subprocess("-n1")
|
||||
result = pytester.runpytest_subprocess("-n1")
|
||||
assert result.ret == 1
|
||||
result.stdout.fnmatch_lines(["*usage: *", "*error: my_usage_error"])
|
||||
|
||||
|
||||
def test_remote_sys_path(pytester: pytest.Pytester) -> None:
|
||||
"""Work around sys.path differences due to execnet using `python -c`."""
|
||||
pytester.makepyfile(
|
||||
"""
|
||||
import sys
|
||||
|
||||
def test_sys_path():
|
||||
assert "" not in sys.path
|
||||
"""
|
||||
)
|
||||
result = pytester.runpytest("-n1")
|
||||
assert result.ret == 0
|
||||
|
||||
@@ -1,273 +0,0 @@
|
||||
from __future__ import print_function
|
||||
import py
|
||||
import pytest
|
||||
import textwrap
|
||||
import execnet
|
||||
from _pytest.pytester import HookRecorder
|
||||
from xdist import workermanage, newhooks
|
||||
from xdist.workermanage import HostRSync, NodeManager
|
||||
|
||||
pytest_plugins = "pytester"
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def hookrecorder(request, config):
|
||||
hookrecorder = HookRecorder(config.pluginmanager)
|
||||
if hasattr(hookrecorder, "start_recording"):
|
||||
hookrecorder.start_recording(newhooks)
|
||||
request.addfinalizer(hookrecorder.finish_recording)
|
||||
return hookrecorder
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def config(testdir):
|
||||
return testdir.parseconfig()
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def mysetup(tmpdir):
|
||||
class mysetup:
|
||||
source = tmpdir.mkdir("source")
|
||||
dest = tmpdir.mkdir("dest")
|
||||
|
||||
return mysetup()
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def workercontroller(monkeypatch):
|
||||
class MockController(object):
|
||||
def __init__(self, *args):
|
||||
pass
|
||||
|
||||
def setup(self):
|
||||
pass
|
||||
|
||||
monkeypatch.setattr(workermanage, "WorkerController", MockController)
|
||||
return MockController
|
||||
|
||||
|
||||
class TestNodeManagerPopen:
|
||||
def test_popen_no_default_chdir(self, config):
|
||||
gm = NodeManager(config, ["popen"])
|
||||
assert gm.specs[0].chdir is None
|
||||
|
||||
def test_default_chdir(self, config):
|
||||
specs = ["ssh=noco", "socket=xyz"]
|
||||
for spec in NodeManager(config, specs).specs:
|
||||
assert spec.chdir == "pyexecnetcache"
|
||||
for spec in NodeManager(config, specs, defaultchdir="abc").specs:
|
||||
assert spec.chdir == "abc"
|
||||
|
||||
def test_popen_makegateway_events(self, config, hookrecorder, workercontroller):
|
||||
hm = NodeManager(config, ["popen"] * 2)
|
||||
hm.setup_nodes(None)
|
||||
call = hookrecorder.popcall("pytest_xdist_setupnodes")
|
||||
assert len(call.specs) == 2
|
||||
|
||||
call = hookrecorder.popcall("pytest_xdist_newgateway")
|
||||
assert call.gateway.spec == execnet.XSpec("popen")
|
||||
assert call.gateway.id == "gw0"
|
||||
call = hookrecorder.popcall("pytest_xdist_newgateway")
|
||||
assert call.gateway.id == "gw1"
|
||||
assert len(hm.group) == 2
|
||||
hm.teardown_nodes()
|
||||
assert not len(hm.group)
|
||||
|
||||
def test_popens_rsync(self, config, mysetup, workercontroller):
|
||||
source = mysetup.source
|
||||
hm = NodeManager(config, ["popen"] * 2)
|
||||
hm.setup_nodes(None)
|
||||
assert len(hm.group) == 2
|
||||
for gw in hm.group:
|
||||
|
||||
class pseudoexec:
|
||||
args = []
|
||||
|
||||
def __init__(self, *args):
|
||||
self.args.extend(args)
|
||||
|
||||
def waitclose(self):
|
||||
pass
|
||||
|
||||
gw.remote_exec = pseudoexec
|
||||
notifications = []
|
||||
for gw in hm.group:
|
||||
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, workercontroller):
|
||||
source, dest = mysetup.source, mysetup.dest
|
||||
hm = NodeManager(config, ["popen//chdir=%s" % dest] * 1)
|
||||
hm.setup_nodes(None)
|
||||
source.ensure("dir1", "dir2", "hello")
|
||||
notifications = []
|
||||
for gw in hm.group:
|
||||
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()
|
||||
assert dest.join("dir1", "dir2").check()
|
||||
assert dest.join("dir1", "dir2", "hello").check()
|
||||
|
||||
def test_rsync_same_popen_twice(
|
||||
self, config, mysetup, hookrecorder, workercontroller
|
||||
):
|
||||
source, dest = mysetup.source, mysetup.dest
|
||||
hm = NodeManager(config, ["popen//chdir=%s" % dest] * 2)
|
||||
hm.roots = []
|
||||
hm.setup_nodes(None)
|
||||
source.ensure("dir1", "dir2", "hello")
|
||||
gw = hm.group[0]
|
||||
hm.rsync(gw, source)
|
||||
call = hookrecorder.popcall("pytest_xdist_rsyncstart")
|
||||
assert call.source == source
|
||||
assert len(call.gateways) == 1
|
||||
assert call.gateways[0] in hm.group
|
||||
call = hookrecorder.popcall("pytest_xdist_rsyncfinish")
|
||||
|
||||
|
||||
class TestHRSync:
|
||||
def test_hrsync_filter(self, mysetup):
|
||||
source, _ = mysetup.source, mysetup.dest # noqa
|
||||
source.ensure("dir", "file.txt")
|
||||
source.ensure(".svn", "entries")
|
||||
source.ensure(".somedotfile", "moreentries")
|
||||
source.ensure("somedir", "editfile~")
|
||||
syncer = HostRSync(source, ignores=NodeManager.DEFAULT_IGNORES)
|
||||
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
|
||||
|
||||
def test_hrsync_one_host(self, mysetup):
|
||||
source, dest = mysetup.source, mysetup.dest
|
||||
gw = execnet.makegateway("popen//chdir=%s" % dest)
|
||||
finished = []
|
||||
rsync = HostRSync(source)
|
||||
rsync.add_target_host(gw, finished=lambda: finished.append(1))
|
||||
source.join("hello.py").write("world")
|
||||
rsync.send()
|
||||
gw.exit()
|
||||
assert dest.join(source.basename, "hello.py").check()
|
||||
assert len(finished) == 1
|
||||
|
||||
|
||||
class TestNodeManager:
|
||||
@py.test.mark.xfail(run=False)
|
||||
def test_rsync_roots_no_roots(self, testdir, mysetup):
|
||||
mysetup.source.ensure("dir1", "file1").write("hello")
|
||||
config = testdir.parseconfig(mysetup.source)
|
||||
nodemanager = NodeManager(config, ["popen//chdir=%s" % mysetup.dest])
|
||||
# assert nodemanager.config.topdir == source == config.topdir
|
||||
nodemanager.makegateways()
|
||||
nodemanager.rsync_roots()
|
||||
(p,) = nodemanager.gwmanager.multi_exec(
|
||||
"import os ; channel.send(os.getcwd())"
|
||||
).receive_each()
|
||||
p = py.path.local(p)
|
||||
print("remote curdir", p)
|
||||
assert p == mysetup.dest.join(config.topdir.basename)
|
||||
assert p.join("dir1").check()
|
||||
assert p.join("dir1", "file1").check()
|
||||
|
||||
def test_popen_rsync_subdir(self, testdir, mysetup, workercontroller):
|
||||
source, dest = mysetup.source, mysetup.dest
|
||||
dir1 = mysetup.source.mkdir("dir1")
|
||||
dir2 = dir1.mkdir("dir2")
|
||||
dir2.ensure("hello")
|
||||
for rsyncroot in (dir1, source):
|
||||
dest.remove()
|
||||
nodemanager = NodeManager(
|
||||
testdir.parseconfig(
|
||||
"--tx", "popen//chdir=%s" % dest, "--rsyncdir", rsyncroot, source
|
||||
)
|
||||
)
|
||||
nodemanager.setup_nodes(None) # calls .rsync_roots()
|
||||
if rsyncroot == source:
|
||||
dest = dest.join("source")
|
||||
assert dest.join("dir1").check()
|
||||
assert dest.join("dir1", "dir2").check()
|
||||
assert dest.join("dir1", "dir2", "hello").check()
|
||||
nodemanager.teardown_nodes()
|
||||
|
||||
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)
|
||||
dir2.ensure("hello")
|
||||
source.ensure("bogusdir", "file")
|
||||
source.join("tox.ini").write(
|
||||
textwrap.dedent(
|
||||
"""
|
||||
[pytest]
|
||||
rsyncdirs=dir1/dir2
|
||||
"""
|
||||
)
|
||||
)
|
||||
config = testdir.parseconfig(source)
|
||||
nodemanager = NodeManager(config, ["popen//chdir=%s" % dest])
|
||||
nodemanager.setup_nodes(None) # calls .rsync_roots()
|
||||
assert dest.join("dir2").check()
|
||||
assert not dest.join("dir1").check()
|
||||
assert not dest.join("bogus").check()
|
||||
|
||||
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")
|
||||
source.ensure("dir5", "file")
|
||||
dir2.ensure("hello")
|
||||
source.ensure("foo", "bar")
|
||||
source.ensure("bar", "foo")
|
||||
source.join("tox.ini").write(
|
||||
textwrap.dedent(
|
||||
"""
|
||||
[pytest]
|
||||
rsyncdirs = dir1 dir5
|
||||
rsyncignore = dir1/dir2 dir5/dir6 foo*
|
||||
"""
|
||||
)
|
||||
)
|
||||
config = testdir.parseconfig(source)
|
||||
config.option.rsyncignore = ["bar"]
|
||||
nodemanager = NodeManager(config, ["popen//chdir=%s" % dest])
|
||||
nodemanager.setup_nodes(None) # calls .rsync_roots()
|
||||
assert dest.join("dir1").check()
|
||||
assert not dest.join("dir1", "dir2").check()
|
||||
assert dest.join("dir5", "file").check()
|
||||
assert not dest.join("dir6").check()
|
||||
assert not dest.join("foo").check()
|
||||
assert not dest.join("bar").check()
|
||||
|
||||
def test_optimise_popen(self, testdir, mysetup, workercontroller):
|
||||
source = mysetup.source
|
||||
specs = ["popen"] * 3
|
||||
source.join("conftest.py").write("rsyncdirs = ['a']")
|
||||
source.ensure("a", dir=1)
|
||||
config = testdir.parseconfig(source)
|
||||
nodemanager = NodeManager(config, specs)
|
||||
nodemanager.setup_nodes(None) # calls .rysnc_roots()
|
||||
for gwspec in nodemanager.specs:
|
||||
assert gwspec._samefilesystem()
|
||||
assert not gwspec.chdir
|
||||
|
||||
def test_ssh_setup_nodes(self, specssh, testdir):
|
||||
testdir.makepyfile(
|
||||
__init__="",
|
||||
test_x="""
|
||||
def test_one():
|
||||
pass
|
||||
""",
|
||||
)
|
||||
reprec = testdir.inline_run(
|
||||
"-d", "--rsyncdir=%s" % testdir.tmpdir, "--tx", specssh, testdir.tmpdir
|
||||
)
|
||||
(rep,) = reprec.getreports("pytest_runtest_logreport")
|
||||
assert rep.passed
|
||||
405
testing/test_workermanage.py
Normal file
405
testing/test_workermanage.py
Normal file
@@ -0,0 +1,405 @@
|
||||
import execnet
|
||||
import pytest
|
||||
import shutil
|
||||
import textwrap
|
||||
import warnings
|
||||
from pathlib import Path
|
||||
from util import generate_warning
|
||||
from xdist import workermanage
|
||||
from xdist._path import visit_path
|
||||
from xdist.remote import serialize_warning_message
|
||||
from xdist.workermanage import HostRSync, NodeManager, unserialize_warning_message
|
||||
|
||||
pytest_plugins = "pytester"
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def hookrecorder(request, config, pytester: pytest.Pytester):
|
||||
hookrecorder = pytester.make_hook_recorder(config.pluginmanager)
|
||||
return hookrecorder
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def config(pytester: pytest.Pytester):
|
||||
return pytester.parseconfig()
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def source(tmp_path: Path) -> Path:
|
||||
source = tmp_path / "source"
|
||||
source.mkdir()
|
||||
return source
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def dest(tmp_path: Path) -> Path:
|
||||
dest = tmp_path / "dest"
|
||||
dest.mkdir()
|
||||
return dest
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def workercontroller(monkeypatch: pytest.MonkeyPatch):
|
||||
class MockController:
|
||||
def __init__(self, *args):
|
||||
pass
|
||||
|
||||
def setup(self):
|
||||
pass
|
||||
|
||||
monkeypatch.setattr(workermanage, "WorkerController", MockController)
|
||||
return MockController
|
||||
|
||||
|
||||
class TestNodeManagerPopen:
|
||||
def test_popen_no_default_chdir(self, config) -> None:
|
||||
gm = NodeManager(config, ["popen"])
|
||||
assert gm.specs[0].chdir is None
|
||||
|
||||
def test_default_chdir(self, config) -> None:
|
||||
specs = ["ssh=noco", "socket=xyz"]
|
||||
for spec in NodeManager(config, specs).specs:
|
||||
assert spec.chdir == "pyexecnetcache"
|
||||
for spec in NodeManager(config, specs, defaultchdir="abc").specs:
|
||||
assert spec.chdir == "abc"
|
||||
|
||||
def test_popen_makegateway_events(
|
||||
self, config, hookrecorder, workercontroller
|
||||
) -> None:
|
||||
hm = NodeManager(config, ["popen"] * 2)
|
||||
hm.setup_nodes(None)
|
||||
call = hookrecorder.popcall("pytest_xdist_setupnodes")
|
||||
assert len(call.specs) == 2
|
||||
|
||||
call = hookrecorder.popcall("pytest_xdist_newgateway")
|
||||
assert call.gateway.spec == execnet.XSpec("popen")
|
||||
assert call.gateway.id == "gw0"
|
||||
call = hookrecorder.popcall("pytest_xdist_newgateway")
|
||||
assert call.gateway.id == "gw1"
|
||||
assert len(hm.group) == 2
|
||||
hm.teardown_nodes()
|
||||
assert not len(hm.group)
|
||||
|
||||
def test_popens_rsync(
|
||||
self, config, source: Path, dest: Path, workercontroller
|
||||
) -> None:
|
||||
hm = NodeManager(config, ["popen"] * 2)
|
||||
hm.setup_nodes(None)
|
||||
assert len(hm.group) == 2
|
||||
for gw in hm.group:
|
||||
|
||||
class pseudoexec:
|
||||
args = [] # type: ignore[var-annotated]
|
||||
|
||||
def __init__(self, *args):
|
||||
self.args.extend(args)
|
||||
|
||||
def waitclose(self):
|
||||
pass
|
||||
|
||||
gw.remote_exec = pseudoexec
|
||||
notifications = []
|
||||
for gw in hm.group:
|
||||
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, source: Path, dest: Path, workercontroller
|
||||
) -> None:
|
||||
hm = NodeManager(config, ["popen//chdir=%s" % dest] * 1)
|
||||
hm.setup_nodes(None)
|
||||
source.joinpath("dir1", "dir2").mkdir(parents=True)
|
||||
source.joinpath("dir1", "dir2", "hello").touch()
|
||||
notifications = []
|
||||
for gw in hm.group:
|
||||
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.joinpath(source.name)
|
||||
assert dest.joinpath("dir1").exists()
|
||||
assert dest.joinpath("dir1", "dir2").exists()
|
||||
assert dest.joinpath("dir1", "dir2", "hello").exists()
|
||||
|
||||
def test_rsync_same_popen_twice(
|
||||
self,
|
||||
config,
|
||||
source: Path,
|
||||
dest: Path,
|
||||
hookrecorder,
|
||||
workercontroller,
|
||||
) -> None:
|
||||
hm = NodeManager(config, ["popen//chdir=%s" % dest] * 2)
|
||||
hm.roots = []
|
||||
hm.setup_nodes(None)
|
||||
source.joinpath("dir1", "dir2").mkdir(parents=True)
|
||||
source.joinpath("dir1", "dir2", "hello").touch()
|
||||
gw = hm.group[0]
|
||||
hm.rsync(gw, source)
|
||||
call = hookrecorder.popcall("pytest_xdist_rsyncstart")
|
||||
assert call.source == source
|
||||
assert len(call.gateways) == 1
|
||||
assert call.gateways[0] in hm.group
|
||||
call = hookrecorder.popcall("pytest_xdist_rsyncfinish")
|
||||
|
||||
|
||||
class TestHRSync:
|
||||
def test_hrsync_filter(self, source: Path, dest: Path) -> None:
|
||||
source.joinpath("dir").mkdir()
|
||||
source.joinpath("dir", "file.txt").touch()
|
||||
source.joinpath(".svn").mkdir()
|
||||
source.joinpath(".svn", "entries").touch()
|
||||
source.joinpath(".somedotfile").mkdir()
|
||||
source.joinpath(".somedotfile", "moreentries").touch()
|
||||
source.joinpath("somedir").mkdir()
|
||||
source.joinpath("somedir", "editfile~").touch()
|
||||
syncer = HostRSync(source, ignores=NodeManager.DEFAULT_IGNORES)
|
||||
files = list(visit_path(source, recurse=syncer.filter, filter=syncer.filter))
|
||||
names = {x.name for x in files}
|
||||
assert names == {"dir", "file.txt", "somedir"}
|
||||
|
||||
def test_hrsync_one_host(self, source: Path, dest: Path) -> None:
|
||||
gw = execnet.makegateway("popen//chdir=%s" % dest)
|
||||
finished = []
|
||||
rsync = HostRSync(source)
|
||||
rsync.add_target_host(gw, finished=lambda: finished.append(1))
|
||||
source.joinpath("hello.py").write_text("world")
|
||||
rsync.send()
|
||||
gw.exit()
|
||||
assert dest.joinpath(source.name, "hello.py").exists()
|
||||
assert len(finished) == 1
|
||||
|
||||
|
||||
class TestNodeManager:
|
||||
@pytest.mark.xfail(run=False)
|
||||
def test_rsync_roots_no_roots(
|
||||
self, pytester: pytest.Pytester, source: Path, dest: Path
|
||||
) -> None:
|
||||
source.joinpath("dir1").mkdir()
|
||||
source.joinpath("dir1", "file1").write_text("hello")
|
||||
config = pytester.parseconfig(source)
|
||||
nodemanager = NodeManager(config, ["popen//chdir=%s" % dest])
|
||||
# assert nodemanager.config.topdir == source == config.topdir
|
||||
nodemanager.makegateways() # type: ignore[attr-defined]
|
||||
nodemanager.rsync_roots() # type: ignore[call-arg]
|
||||
(p,) = nodemanager.gwmanager.multi_exec( # type: ignore[attr-defined]
|
||||
"import os ; channel.send(os.getcwd())"
|
||||
).receive_each()
|
||||
p = Path(p)
|
||||
print("remote curdir", p)
|
||||
assert p == dest.joinpath(config.rootpath.name)
|
||||
assert p.joinpath("dir1").check()
|
||||
assert p.joinpath("dir1", "file1").check()
|
||||
|
||||
def test_popen_rsync_subdir(
|
||||
self, pytester: pytest.Pytester, source: Path, dest: Path, workercontroller
|
||||
) -> None:
|
||||
dir1 = source / "dir1"
|
||||
dir1.mkdir()
|
||||
dir2 = dir1 / "dir2"
|
||||
dir2.mkdir()
|
||||
dir2.joinpath("hello").touch()
|
||||
for rsyncroot in (dir1, source):
|
||||
shutil.rmtree(str(dest), ignore_errors=True)
|
||||
nodemanager = NodeManager(
|
||||
pytester.parseconfig(
|
||||
"--tx", "popen//chdir=%s" % dest, "--rsyncdir", rsyncroot, source
|
||||
)
|
||||
)
|
||||
nodemanager.setup_nodes(None) # calls .rsync_roots()
|
||||
if rsyncroot == source:
|
||||
dest = dest.joinpath("source")
|
||||
assert dest.joinpath("dir1").exists()
|
||||
assert dest.joinpath("dir1", "dir2").exists()
|
||||
assert dest.joinpath("dir1", "dir2", "hello").exists()
|
||||
nodemanager.teardown_nodes()
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"flag, expects_report", [("-q", False), ("", False), ("-v", True)]
|
||||
)
|
||||
def test_rsync_report(
|
||||
self,
|
||||
pytester: pytest.Pytester,
|
||||
source: Path,
|
||||
dest: Path,
|
||||
workercontroller,
|
||||
capsys: pytest.CaptureFixture[str],
|
||||
flag: str,
|
||||
expects_report: bool,
|
||||
) -> None:
|
||||
dir1 = source / "dir1"
|
||||
dir1.mkdir()
|
||||
args = ["--tx", "popen//chdir=%s" % dest, "--rsyncdir", str(dir1), str(source)]
|
||||
if flag:
|
||||
args.append(flag)
|
||||
nodemanager = NodeManager(pytester.parseconfig(*args))
|
||||
nodemanager.setup_nodes(None) # calls .rsync_roots()
|
||||
out, _ = capsys.readouterr()
|
||||
if expects_report:
|
||||
assert "<= pytest/__init__.py" in out
|
||||
else:
|
||||
assert "<= pytest/__init__.py" not in out
|
||||
|
||||
def test_init_rsync_roots(
|
||||
self, pytester: pytest.Pytester, source: Path, dest: Path, workercontroller
|
||||
) -> None:
|
||||
dir2 = source.joinpath("dir1", "dir2")
|
||||
dir2.mkdir(parents=True)
|
||||
source.joinpath("dir1", "somefile").mkdir()
|
||||
dir2.joinpath("hello").touch()
|
||||
source.joinpath("bogusdir").mkdir()
|
||||
source.joinpath("bogusdir", "file").touch()
|
||||
source.joinpath("tox.ini").write_text(
|
||||
textwrap.dedent(
|
||||
"""
|
||||
[pytest]
|
||||
rsyncdirs=dir1/dir2
|
||||
"""
|
||||
)
|
||||
)
|
||||
config = pytester.parseconfig(source)
|
||||
nodemanager = NodeManager(config, ["popen//chdir=%s" % dest])
|
||||
nodemanager.setup_nodes(None) # calls .rsync_roots()
|
||||
assert dest.joinpath("dir2").exists()
|
||||
assert not dest.joinpath("dir1").exists()
|
||||
assert not dest.joinpath("bogus").exists()
|
||||
|
||||
def test_rsyncignore(
|
||||
self, pytester: pytest.Pytester, source: Path, dest: Path, workercontroller
|
||||
) -> None:
|
||||
dir2 = source.joinpath("dir1", "dir2")
|
||||
dir2.mkdir(parents=True)
|
||||
source.joinpath("dir5", "dir6").mkdir(parents=True)
|
||||
source.joinpath("dir5", "dir6", "bogus").touch()
|
||||
source.joinpath("dir5", "file").touch()
|
||||
dir2.joinpath("hello").touch()
|
||||
source.joinpath("foo").mkdir()
|
||||
source.joinpath("foo", "bar").touch()
|
||||
source.joinpath("bar").mkdir()
|
||||
source.joinpath("bar", "foo").touch()
|
||||
source.joinpath("tox.ini").write_text(
|
||||
textwrap.dedent(
|
||||
"""
|
||||
[pytest]
|
||||
rsyncdirs = dir1 dir5
|
||||
rsyncignore = dir1/dir2 dir5/dir6 foo*
|
||||
"""
|
||||
)
|
||||
)
|
||||
config = pytester.parseconfig(source)
|
||||
config.option.rsyncignore = ["bar"]
|
||||
nodemanager = NodeManager(config, ["popen//chdir=%s" % dest])
|
||||
nodemanager.setup_nodes(None) # calls .rsync_roots()
|
||||
assert dest.joinpath("dir1").exists()
|
||||
assert not dest.joinpath("dir1", "dir2").exists()
|
||||
assert dest.joinpath("dir5", "file").exists()
|
||||
assert not dest.joinpath("dir6").exists()
|
||||
assert not dest.joinpath("foo").exists()
|
||||
assert not dest.joinpath("bar").exists()
|
||||
|
||||
def test_optimise_popen(
|
||||
self, pytester: pytest.Pytester, source: Path, dest: Path, workercontroller
|
||||
) -> None:
|
||||
specs = ["popen"] * 3
|
||||
source.joinpath("conftest.py").write_text("rsyncdirs = ['a']")
|
||||
source.joinpath("a").mkdir()
|
||||
config = pytester.parseconfig(source)
|
||||
nodemanager = NodeManager(config, specs)
|
||||
nodemanager.setup_nodes(None) # calls .rysnc_roots()
|
||||
for gwspec in nodemanager.specs:
|
||||
assert gwspec._samefilesystem()
|
||||
assert not gwspec.chdir
|
||||
|
||||
def test_ssh_setup_nodes(self, specssh: str, pytester: pytest.Pytester) -> None:
|
||||
pytester.makepyfile(
|
||||
__init__="",
|
||||
test_x="""
|
||||
def test_one():
|
||||
pass
|
||||
""",
|
||||
)
|
||||
reprec = pytester.inline_run(
|
||||
"-d", "--rsyncdir=%s" % pytester.path, "--tx", specssh, pytester.path
|
||||
)
|
||||
(rep,) = reprec.getreports("pytest_runtest_logreport")
|
||||
assert rep.passed
|
||||
|
||||
|
||||
class MyWarning(UserWarning):
|
||||
pass
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"w_cls",
|
||||
[
|
||||
UserWarning,
|
||||
MyWarning,
|
||||
"Imported",
|
||||
pytest.param(
|
||||
"Nested",
|
||||
marks=pytest.mark.xfail(reason="Nested warning classes are not supported."),
|
||||
),
|
||||
],
|
||||
)
|
||||
def test_unserialize_warning_msg(w_cls):
|
||||
"""Test that warning serialization process works well"""
|
||||
|
||||
# Create a test warning message
|
||||
with pytest.warns(UserWarning) as w:
|
||||
if not isinstance(w_cls, str):
|
||||
warnings.warn("hello", w_cls)
|
||||
elif w_cls == "Imported":
|
||||
generate_warning()
|
||||
elif w_cls == "Nested":
|
||||
# dynamic creation
|
||||
class MyWarning2(UserWarning):
|
||||
pass
|
||||
|
||||
warnings.warn("hello", MyWarning2)
|
||||
|
||||
# Unpack
|
||||
assert len(w) == 1
|
||||
w_msg = w[0]
|
||||
|
||||
# Serialize and deserialize
|
||||
data = serialize_warning_message(w_msg)
|
||||
w_msg2 = unserialize_warning_message(data)
|
||||
|
||||
# Compare the two objects
|
||||
all_keys = set(vars(w_msg).keys()).union(set(vars(w_msg2).keys()))
|
||||
for k in all_keys:
|
||||
v1 = getattr(w_msg, k)
|
||||
v2 = getattr(w_msg2, k)
|
||||
if k == "message":
|
||||
assert type(v1) == type(v2)
|
||||
assert v1.args == v2.args
|
||||
else:
|
||||
assert v1 == v2
|
||||
|
||||
|
||||
class MyWarningUnknown(UserWarning):
|
||||
# Changing the __module__ attribute is only safe if class can be imported
|
||||
# from there
|
||||
__module__ = "unknown"
|
||||
|
||||
|
||||
def test_warning_serialization_tweaked_module():
|
||||
"""Test for GH#404"""
|
||||
|
||||
# Create a test warning message
|
||||
with pytest.warns(UserWarning) as w:
|
||||
warnings.warn("hello", MyWarningUnknown)
|
||||
|
||||
# Unpack
|
||||
assert len(w) == 1
|
||||
w_msg = w[0]
|
||||
|
||||
# Serialize and deserialize
|
||||
data = serialize_warning_message(w_msg)
|
||||
|
||||
# __module__ cannot be found!
|
||||
with pytest.raises(ModuleNotFoundError):
|
||||
unserialize_warning_message(data)
|
||||
9
testing/util.py
Normal file
9
testing/util.py
Normal file
@@ -0,0 +1,9 @@
|
||||
import warnings
|
||||
|
||||
|
||||
class MyWarning2(UserWarning):
|
||||
pass
|
||||
|
||||
|
||||
def generate_warning():
|
||||
warnings.warn(MyWarning2("hello"))
|
||||
46
tox.ini
46
tox.ini
@@ -1,28 +1,45 @@
|
||||
[tox]
|
||||
envlist=
|
||||
linting
|
||||
py{27,35,36,37,38}-pytestlatest
|
||||
py38-pytestmaster
|
||||
|
||||
py{36,37,38,39,310}-pytestlatest
|
||||
py38-pytestmain
|
||||
py38-psutil
|
||||
py38-setproctitle
|
||||
isolated_build = true
|
||||
[testenv]
|
||||
passenv = USER USERNAME
|
||||
extras = testing
|
||||
deps =
|
||||
pytestlatest: pytest
|
||||
pytestmaster: git+https://github.com/pytest-dev/pytest.git@master
|
||||
pytestmain: git+https://github.com/pytest-dev/pytest.git
|
||||
commands=
|
||||
pytest {posargs}
|
||||
|
||||
[testenv:py38-psutil]
|
||||
extras =
|
||||
testing
|
||||
psutil
|
||||
commands =
|
||||
pytest {posargs:-k psutil}
|
||||
|
||||
[testenv:py38-setproctitle]
|
||||
extras =
|
||||
testing
|
||||
setproctitle
|
||||
deps = pytest
|
||||
commands =
|
||||
pytest {posargs}
|
||||
|
||||
[testenv:linting]
|
||||
skipsdist = True
|
||||
skip_install = True
|
||||
usedevelop = True
|
||||
passenv = PRE_COMMIT_HOME
|
||||
deps =
|
||||
pre-commit
|
||||
commands = pre-commit run --all-files --show-diff-on-failure
|
||||
|
||||
[testenv:release]
|
||||
changedir=
|
||||
decription = do a release, required posarg of the version number
|
||||
description = do a release, required posarg of the version number
|
||||
basepython = python3.7
|
||||
skipsdist = True
|
||||
usedevelop = True
|
||||
@@ -30,10 +47,21 @@ passenv = *
|
||||
deps =
|
||||
towncrier
|
||||
commands =
|
||||
towncrier --version {posargs} --yes
|
||||
towncrier build --version {posargs} --yes
|
||||
|
||||
[testenv:docs]
|
||||
basepython = python3
|
||||
usedevelop = True
|
||||
deps =
|
||||
sphinx
|
||||
sphinx_rtd_theme
|
||||
commands =
|
||||
sphinx-build -W --keep-going -b html docs docs/_build/html {posargs:}
|
||||
|
||||
[pytest]
|
||||
addopts = -ra
|
||||
# pytest-services also defines a worker_id fixture, disable
|
||||
# it so they don't conflict with each other (#611).
|
||||
addopts = -ra -p no:pytest-services
|
||||
testpaths = testing
|
||||
|
||||
[flake8]
|
||||
|
||||
Reference in New Issue
Block a user