Mark tests as expected failures on Docutils 0.22.0rc2 (#13547)

Author: AA-Turner

tests/test_directives/test_directive_only.py

@@ -5,13 +5,20 @@
 import re
 from typing import TYPE_CHECKING
 
+import docutils
 import pytest
 from docutils import nodes
 
 if TYPE_CHECKING:
     from sphinx.testing.util import SphinxTestApp
 
+xfail_du_22 = pytest.mark.xfail(
+    docutils.__version_info__ >= (0, 22, 0, 'alpha', 0),
+    reason='expected failure on Docutils 0.22+',
+)
 
+
+@xfail_du_22
 @pytest.mark.sphinx('text', testroot='directive-only')
 def test_sectioning(app: SphinxTestApp) -> None:
     def getsects(section):

tests/test_environment/test_environment_toctree.py

@@ -4,6 +4,7 @@
 
 from typing import TYPE_CHECKING
 
+import docutils
 import pytest
 from docutils import nodes
 from docutils.nodes import bullet_list, list_item, literal, reference, title
@@ -17,7 +18,13 @@
 if TYPE_CHECKING:
     from sphinx.testing.util import SphinxTestApp
 
+xfail_du_22 = pytest.mark.xfail(
+    docutils.__version_info__ >= (0, 22, 0, 'alpha', 0),
+    reason='expected failure on Docutils 0.22+',
+)
 
+
+@xfail_du_22
 @pytest.mark.sphinx('xml', testroot='toctree')
 @pytest.mark.test_params(shared_result='test_environment_toctree_basic')
 def test_process_doc(app):
@@ -464,6 +471,7 @@ def test_domain_objects_document_scoping(app: SphinxTestApp) -> None:
     )
 
 
+@xfail_du_22
 @pytest.mark.sphinx('xml', testroot='toctree')
 @pytest.mark.test_params(shared_result='test_environment_toctree_basic')
 def test_document_toc(app):
@@ -521,6 +529,7 @@ def test_document_toc(app):
     assert_node(toctree[2][0], [compact_paragraph, reference, 'Indices and tables'])
 
 
+@xfail_du_22
 @pytest.mark.sphinx('xml', testroot='toctree')
 @pytest.mark.test_params(shared_result='test_environment_toctree_basic')
 def test_document_toc_only(app):

tests/test_util/test_util_docutils_sphinx_directive.py

@@ -2,6 +2,8 @@
 
 from types import SimpleNamespace
 
+import docutils
+import pytest
 from docutils import nodes
 from docutils.parsers.rst.languages import en as english  # type: ignore[attr-defined]
 from docutils.parsers.rst.states import (
@@ -14,6 +16,11 @@
 
 from sphinx.util.docutils import SphinxDirective, new_document
 
+xfail_du_22 = pytest.mark.xfail(
+    docutils.__version_info__ >= (0, 22, 0, 'alpha', 0),
+    reason='expected failure on Docutils 0.22+',
+)
+
 
 def make_directive(
     *, env: SimpleNamespace, input_lines: StringList | None = None
@@ -104,6 +111,7 @@ def test_sphinx_directive_get_location() -> None:
     assert directive.get_location() == '<source>:1'
 
 
+@xfail_du_22
 def test_sphinx_directive_parse_content_to_nodes() -> None:
     directive = make_directive(env=SimpleNamespace())
     content = 'spam\n====\n\nEggs! *Lobster thermidor.*'
@@ -120,6 +128,7 @@ def test_sphinx_directive_parse_content_to_nodes() -> None:
     assert node.children[1].astext() == 'Eggs! Lobster thermidor.'
 
 
+@xfail_du_22
 def test_sphinx_directive_parse_text_to_nodes() -> None:
     directive = make_directive(env=SimpleNamespace())
     content = 'spam\n====\n\nEggs! *Lobster thermidor.*'