Skip to content

Commit

Permalink
Let users configure dist mode in the configuration file
Browse files Browse the repository at this point in the history
  • Loading branch information
nicoddemus committed Nov 30, 2022
1 parent c6bcd20 commit 7a0bc4c
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 7 deletions.
6 changes: 6 additions & 0 deletions changelog/789.feature.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Users can now set a default distribution mode in their configuration file:

.. code-block:: ini
[pytest]
addopts = --dist loadscope
21 changes: 14 additions & 7 deletions src/xdist/plugin.py
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,19 @@ def pytest_addhooks(pluginmanager):

@pytest.hookimpl(trylast=True)
def pytest_configure(config):
if config.getoption("dist") != "no" and not config.getvalue("collectonly"):
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)

# Skip this plugin entirely when only doing collection.
if config.getvalue("collectonly"):
return

# Create the distributed session in case we have a valid distribution
# mode and test environments.
if config.getoption("dist") != "no" and config.getoption("tx"):
from xdist.dsession import DSession

session = DSession(config)
Expand All @@ -199,6 +211,7 @@ def pytest_configure(config):
if tr:
tr.showfspath = False

# Deprecation warnings for deprecated command-line/configuration options.
if config.getoption("looponfail", None) or config.getini("looponfailroots"):
warning = DeprecationWarning(
"The --looponfail command line argument and looponfailroots config variable are deprecated.\n"
Expand All @@ -213,12 +226,6 @@ def pytest_configure(config):
)
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.hookimpl(tryfirst=True)
def pytest_cmdline_main(config):
Expand Down
18 changes: 18 additions & 0 deletions testing/acceptance_test.py
Original file line number Diff line number Diff line change
Expand Up @@ -1561,3 +1561,21 @@ def test_collection_crash(testdir):
"*= 1 error in *",
]
)


def test_dist_in_addopts(testdir):
"""Users can set a default distribution in the configuration file (#789)."""
testdir.makepyfile(
"""
def test():
pass
"""
)
testdir.makeini(
"""
[pytest]
addopts = --dist loadscope
"""
)
result = testdir.runpytest()
assert result.ret == 0

0 comments on commit 7a0bc4c

Please sign in to comment.