Adding upstream version 0.18.1.upstream/0.18.1upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 127 insertions, 0 deletions

diff --git a/tests/test_sphinx/conftest.py b/tests/test_sphinx/conftest.py
new file mode 100644
index 0000000..4165a31
--- /dev/null
+++ b/tests/test_sphinx/conftest.py
@@ -0,0 +1,127 @@
+"""
+Uses sphinx's pytest fixture to run builds
+
+usage:
+
+.. code-block:: python
+
+    @pytest.mark.sphinx(
+        buildername='html',
+        srcdir='path/to/source')
+    def test_basic(app, status, warning, get_sphinx_app_output):
+
+        app.build()
+
+        assert 'build succeeded' in status.getvalue()  # Build succeeded
+        warnings = warning.getvalue().strip()
+        assert warnings == ""
+
+        output = get_sphinx_app_output(app, buildername='html')
+
+parameters available to parse to ``@pytest.mark.sphinx``:
+
+- buildername='html'
+- srcdir=None
+- testroot='root' (only used if srcdir not set)
+- freshenv=False
+- confoverrides=None
+- status=None
+- warning=None
+- tags=None
+- docutilsconf=None
+
+"""
+import os
+import pathlib
+import shutil
+
+import pytest
+from bs4 import BeautifulSoup
+from sphinx.testing.path import path
+
+from myst_parser._compat import findall
+
+SOURCE_DIR = os.path.abspath(os.path.join(os.path.dirname(__file__), "sourcedirs"))
+
+
+@pytest.fixture(scope="session", autouse=True)
+def remove_sphinx_builds():
+    """remove all build directories from the test folder"""
+    yield
+    srcdirs = pathlib.Path(SOURCE_DIR)
+    for entry in srcdirs.iterdir():  # type: pathlib.Path
+        if entry.is_dir() and entry.joinpath("_build").exists():
+            shutil.rmtree(str(entry.joinpath("_build")))
+
+
+@pytest.fixture
+def get_sphinx_app_output(file_regression):
+    def read(
+        app,
+        buildername="html",
+        filename="index.html",
+        encoding="utf-8",
+        regress_html=False,
+        regress_ext=".html",
+        replace=None,
+    ):
+
+        outpath = path(os.path.join(str(app.srcdir), "_build", buildername, filename))
+        if not outpath.exists():
+            raise OSError(f"no output file exists: {outpath}")
+
+        try:
+            # introduced in sphinx 3.0
+            content = outpath.read_text(encoding=encoding)
+        except AttributeError:
+            content = outpath.text(encoding=encoding)
+
+        if regress_html:
+            # only regress the inner body, since other sections are non-deterministic
+            soup = BeautifulSoup(content, "html.parser")
+            doc_div = soup.findAll("div", {"class": "documentwrapper"})[0]
+            # pygments 2.11.0 introduces a whitespace tag
+            for pygment_whitespace in doc_div.select("pre > span.w"):
+                pygment_whitespace.replace_with(pygment_whitespace.text)
+            text = doc_div.prettify()
+            for find, rep in (replace or {}).items():
+                text = text.replace(find, rep)
+            file_regression.check(text, extension=regress_ext, encoding="utf8")
+
+        return content
+
+    return read
+
+
+@pytest.fixture
+def get_sphinx_app_doctree(file_regression):
+    def read(
+        app,
+        docname="index",
+        resolve=False,
+        regress=False,
+        replace=None,
+        regress_ext=".xml",
+    ):
+        if resolve:
+            doctree = app.env.get_and_resolve_doctree(docname, app.builder)
+            extension = f".resolved{regress_ext}"
+        else:
+            doctree = app.env.get_doctree(docname)
+            extension = regress_ext
+
+        # convert absolute filenames
+        for node in findall(doctree)(
+            lambda n: "source" in n and not isinstance(n, str)
+        ):
+            node["source"] = pathlib.Path(node["source"]).name
+
+        if regress:
+            text = doctree.pformat()  # type: str
+            for find, rep in (replace or {}).items():
+                text = text.replace(find, rep)
+            file_regression.check(text, extension=extension)
+
+        return doctree
+
+    return read