Fix tests that use sphinx-build

twmr · twmr · commit 3daa5c1a682e · 2025-11-28T23:39:43.000+01:00
diff --git a/pyproject.toml b/pyproject.toml
@@ -50,3 +50,8 @@ homepage = "https://github.com/thisch/pytest-sphinx"
 [build-system]
 requires = ["setuptools"]
 build-backend = "setuptools.build_meta"
+
+[dependency-groups]
+dev = [
+    "sphinx>=8.1.3",
+]
diff --git a/tests/test_sphinx_doctest.py b/tests/test_sphinx_doctest.py
@@ -3,6 +3,7 @@
 import logging
 import os
 import subprocess
+import sys
 import textwrap
 from pathlib import Path
 from typing import Iterator
@@ -15,6 +16,13 @@
 logger = logging.getLogger(__name__)
 
 
+def assert_1_item_passed(output):
+    if sys.version_info >= (3, 13):
+        assert "1 item passed all tests" in output
+    else:
+        assert "1 items passed all tests" in output
+
+
 class SphinxDoctestRunner:
     def __init__(self, tmp_path: Path) -> None:
         self.tmp_path: Path = tmp_path
@@ -105,7 +113,7 @@ def test_simple_doctest_success(sphinx_tester: SphinxDoctestRunner) -> None:
         6
         """
     )
-    assert "1 items passed all tests" in output
+    assert_1_item_passed(output)
 
 
 class TestDirectives:
@@ -123,7 +131,7 @@ def test_testcode(
             """
 
         sphinx_output = sphinx_tester(code)
-        assert "1 items passed all tests" in sphinx_output
+        assert_1_item_passed(sphinx_output)
 
         plugin_result = testdir.runpytest("--doctest-glob=index.rst").stdout
         plugin_result.fnmatch_lines(["*=== 1 passed in *"])
@@ -139,7 +147,7 @@ def test_doctest(
             """
 
         sphinx_output = sphinx_tester(code)
-        assert "1 items passed all tests" in sphinx_output
+        assert_1_item_passed(sphinx_output)
 
         plugin_result = testdir.runpytest("--doctest-glob=index.rst").stdout
         plugin_result.fnmatch_lines(["*=== 1 passed in *"])
@@ -170,7 +178,7 @@ def test_doctest_multiple(
             """
 
         sphinx_output = sphinx_tester(code)
-        assert "1 items passed all tests" in sphinx_output
+        assert_1_item_passed(sphinx_output)
 
         plugin_result = testdir.runpytest("--doctest-glob=index.rst").stdout
         plugin_result.fnmatch_lines(["*=== 1 passed in *"])
@@ -201,7 +209,7 @@ def test_skipif_true(
             assert "1 failure in tests" in sphinx_output
             plugin_output.fnmatch_lines(["*=== 1 failed in *"])
         else:
-            assert "1 items passed all tests" in sphinx_output
+            assert_1_item_passed(sphinx_output)
             plugin_output.fnmatch_lines(["*=== 1 passed in *"])
 
     @pytest.mark.parametrize(
@@ -230,7 +238,7 @@ def test_skipif_false(
             assert "1 failure in tests" in sphinx_output
             plugin_output.fnmatch_lines(["*=== 1 failed in *"])
         else:
-            assert "1 items passed all tests" in sphinx_output
+            assert_1_item_passed(sphinx_output)
             plugin_output.fnmatch_lines(["*=== 1 passed in *"])
 
     @pytest.mark.parametrize("wrong_output_assertion", [True, False])
@@ -272,7 +280,7 @@ def test_skipif_multiple_testoutput(
             assert "1 failure in tests" in sphinx_output
             plugin_output.fnmatch_lines(["*=== 1 failed in *"])
         else:
-            assert "1 items passed all tests" in sphinx_output
+            assert_1_item_passed(sphinx_output)
             plugin_output.fnmatch_lines(["*=== 1 passed in *"])
 
     @pytest.mark.parametrize("testcode", ["raise RuntimeError", "pass", "print(1234)"])
