sphinx-exercise/tests/conftest.py at 4a711c577262c4d67a90fdf5ed0bc0c51574550c · executablebooks/sphinx-exercise · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
import shutil
import pytest
import packaging.version
import sphinx
import re

from pathlib import Path

pytest_plugins = "sphinx.testing.fixtures"


if packaging.version.Version(sphinx.__version__) < packaging.version.Version("7.2.0"):

    @pytest.fixture
    def rootdir(tmpdir):
        from sphinx.testing.path import path

        # In Sphinx 6, path objects don't have .absolute() method, but they are already absolute
        src = path(__file__).parent / "books"
        dst = tmpdir.join("books")
        shutil.copytree(src, dst)
        yield path(dst)
        shutil.rmtree(dst)

else:

    @pytest.fixture
    def rootdir(tmp_path):
        src = Path(__file__).parent.absolute() / "books"
        dst = tmp_path / "books"
        shutil.copytree(src, dst)
        yield dst
        shutil.rmtree(dst)


@pytest.fixture
def warnings():
    def read(app):
        return app._warning.getvalue().strip()

    return read


@pytest.fixture
def get_sphinx_app_doctree(file_regression):
    def read(
        app,
        docname="index",
        resolve=False,
        regress=False,
        flatten_outdir=False,
        sphinx_version=False,
    ):
        if resolve:
            doctree = app.env.get_and_resolve_doctree(docname, app.builder)
            extension = ".resolved.xml"
        else:
            doctree = app.env.get_doctree(docname)
            extension = ".xml"

        if sphinx_version:
            extension = sphinx_version + extension

        # convert absolute filenames
        findall = getattr(doctree, "findall", doctree.traverse)
        for node in findall(lambda n: "source" in n):
            node["source"] = Path(node["source"]).name

        if flatten_outdir:
            docname = docname.split("/")[-1]

        if regress:
            file_regression.check(
                doctree.pformat(), basename=docname, extension=extension
            )

        return doctree

    return read


# comparison files will need updating
# alternatively the resolution of https://github.com/ESSS/pytest-regressions/issues/32
@pytest.fixture()
def file_regression(file_regression):
    return FileRegression(file_regression)


class FileRegression:
    ignores = ()
    changes = (
        # TODO: Remove when support for Sphinx<=6 is dropped,
        (re.escape(" translation_progress=\"{'total': 0, 'translated': 0}\""), ""),
        # TODO: Remove when support for Sphinx<7.2 is dropped,
        (r"original_uri=\"[^\"]*\"\s", ""),
        # TODO: Remove when support for Sphinx<7.2 is dropped
        ("Link to", "Permalink to"),
        # Strip ipykernel process IDs (temporary directory paths)
        (r"ipykernel_\d+", "ipykernel_XXXXX"),
        # Normalize matplotlib image hashes (platform/version dependent)
        (r"[a-f0-9]{64}\.png", "IMAGEHASH.png"),
    )

    def __init__(self, file_regression):
        self.file_regression = file_regression

    def check(self, data, **kwargs):
        return self.file_regression.check(self._strip_ignores(data), **kwargs)

    def _strip_ignores(self, data):
        for src, dst in self.changes:
            data = re.sub(src, dst, data)
        return data