[tests] Implementation of the new testing plugin (backward-compatible) [part 2]

CHANGES.rst

@@ -13,6 +13,11 @@ Deprecated
 * #11693: Support for old-style :file:`Makefile` and :file:`make.bat` output
  in :program:`sphinx-quickstart`, and the associated options :option:`!-M`,
  :option:`!-m`, :option:`!--no-use-make-mode`, and :option:`!--use-make-mode`.
+* #11285: Direct access to :attr:`!sphinx.testing.util.SphinxTestApp._status`
+ or :attr:`!sphinx.testing.util.SphinxTestApp._warning` is deprecated. Use
+ the public properties :attr:`!sphinx.testing.util.SphinxTestApp.status`
+ and :attr:`!sphinx.testing.util.SphinxTestApp.warning` instead.
+ Patch by Bénédikt Tran.
 
 Features added
 --------------
@@ -99,6 +104,19 @@ Bugs fixed
 
 Testing
 -------
+* #11285: :func:`!pytest.mark.sphinx` requires keyword arguments, except for
+ the builder name which can still be given as the first positional argument.
+ Patch by Bénédikt Tran.
+* #11285: :func:`!pytest.mark.sphinx` accepts *warningiserror*, *keep_going*
+ and *verbosity* as additional keyword arguments.
+ Patch by Bénédikt Tran.
+* #11285: :class:`!sphinx.testing.util.SphinxTestApp` *srcdir* argument is
+ now mandatory (previously, this was checked with an assertion).
+ Patch by Bénédikt Tran.
+* #11285: :class:`!sphinx.testing.util.SphinxTestApp` *status* and *warning*
+ arguments are checked to be :class:`io.StringIO` objects (the public API
+ incorrectly assumed this without checking it).
+ Patch by Bénédikt Tran.
 
 Release 7.2.6 (released Sep 13, 2023)
 =====================================

pyproject.toml

@@ -91,6 +91,7 @@ lint = [
 ]
 test = [
  "pytest>=6.0",
+ "pytest-xdist==3.5.0",
  "html5lib",
  "cython>=3.0",
  "setuptools>=67.0", # for Cython compilation
@@ -216,6 +217,7 @@ disallow_any_generics = false
 minversion = 6.0
 addopts = [
  "-ra",
+ "-p no:xdist", # disable xdist for now
  "--import-mode=prepend",
 # "--pythonwarnings=error",
  "--strict-config",

sphinx/testing/_xdist_hooks.py

@@ -0,0 +1,30 @@
+"""Hooks to register when the ``xdist`` plugin is active.
+
+Wen ``xdist`` is active, the controller node automatically loads
+this module through :func:`sphinx.testing.plugin.pytest_addhooks`.
+"""
+
+from __future__ import annotations
+
+__all__ = ()
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+ import pytest
+ from xdist.workermanage import NodeManager, WorkerController
+
+
+def pytest_configure_node(node: WorkerController) -> None:
+ node_config: pytest.Config = node.config
+ # the node's config is not the same as the controller's config
+ assert node_config.pluginmanager.has_plugin('xdist'), 'xdist is not loaded'
+
+ manager: NodeManager = node.nodemanager
+ config: pytest.Config = manager.config
+ assert config.pluginmanager.has_plugin('xdist'), 'xdist is not loaded'
+
+ # worker nodes do not inherit the 'config.option.dist' value
+ # when used by pytester, so we simply copy it from the main
+ # controller to the worker node
+ node.workerinput['sphinx_xdist_policy'] = config.option.dist