Merge pull request #827 from nicoddemus/deprecate-looponfail

Deprecate looponfail plugin

Author: nicoddemus

changelog/826.deprecation.rst

@@ -19,7 +19,12 @@ template = "changelog/_template.rst"
 
   [[tool.towncrier.type]]
   directory = "removal"
-  name = "Deprecations and Removals"
+  name = "Removals"
+  showcontent = true
+
+  [[tool.towncrier.type]]
+  directory = "deprecation"
+  name = "Deprecations"
   showcontent = true
 
   [[tool.towncrier.type]]

pyproject.toml

@@ -46,7 +46,10 @@ def pytest_cmdline_main(config):
 
 def looponfail_main(config: pytest.Config) -> None:
     remotecontrol = RemoteControl(config)
-    rootdirs = [Path(root) for root in 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:

src/xdist/looponfail.py

@@ -1,7 +1,6 @@
 import os
 import uuid
 import sys
-from pathlib import Path
 
 import pytest
 
@@ -158,8 +157,7 @@ def pytest_addoption(parser):
     parser.addini(
         "looponfailroots",
         type="paths" if PYTEST_GTE_7 else "pathlist",
-        help="directories to check for changes",
-        default=[Path.cwd()],
+        help="directories to check for changes. Default: current directory.",
     )
 
 
@@ -191,6 +189,13 @@ def pytest_configure(config):
         if tr:
             tr.showfspath = False
 
+    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)
+
     config_line = (
         "xdist_group: specify group for tests should run in same session."
         "in relation to one another. " + "Provided by pytest-xdist."

src/xdist/plugin.py

@@ -740,7 +740,7 @@ def test_ok():
             pass
     """
     )
-    result = pytester.runpytest(p1, "-n1", "-p", "no:%s" % plugin)
+    result = pytester.runpytest(p1, "-n1", "-p", f"no:{plugin}")
     assert result.ret == 0
     result.stdout.fnmatch_lines("*1 passed*")