Adding upstream version 5.3.0.upstream/5.3.0upstream

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

1 files changed, 143 insertions, 0 deletions

diff --git a/tests/test_build.py b/tests/test_build.py
new file mode 100644
index 0000000..fd123e2
--- /dev/null
+++ b/tests/test_build.py
@@ -0,0 +1,143 @@
+"""Test all builders."""
+
+import sys
+from textwrap import dedent
+from unittest import mock
+
+import pytest
+from docutils import nodes
+
+from sphinx.errors import SphinxError
+
+
+def request_session_head(url, **kwargs):
+    response = mock.Mock()
+    response.status_code = 200
+    response.url = url
+    return response
+
+
+@pytest.fixture
+def nonascii_srcdir(request, rootdir, sphinx_test_tempdir):
+    # If supported, build in a non-ASCII source dir
+    test_name = '\u65e5\u672c\u8a9e'
+    basedir = sphinx_test_tempdir / request.node.originalname
+    try:
+        srcdir = basedir / test_name
+        if not srcdir.exists():
+            (rootdir / 'test-root').copytree(srcdir)
+    except UnicodeEncodeError:
+        # Now Python 3.7+ follows PEP-540 and uses utf-8 encoding for filesystem by default.
+        # So this error handling will be no longer used (after dropping python 3.6 support).
+        srcdir = basedir / 'all'
+        if not srcdir.exists():
+            (rootdir / 'test-root').copytree(srcdir)
+    else:
+        # add a doc with a non-ASCII file name to the source dir
+        (srcdir / (test_name + '.txt')).write_text(dedent("""
+            nonascii file name page
+            =======================
+            """), encoding='utf8')
+
+        root_doc = srcdir / 'index.txt'
+        root_doc.write_text(root_doc.read_text(encoding='utf8') + dedent("""
+                            .. toctree::
+
+                               %(test_name)s/%(test_name)s
+                            """ % {'test_name': test_name}), encoding='utf8')
+    return srcdir
+
+
+# note: this test skips building docs for some builders because they have independent testcase.
+#       (html, changes, epub, latex, texinfo and manpage)
+@pytest.mark.parametrize(
+    "buildername",
+    ['dirhtml', 'singlehtml', 'text', 'xml', 'pseudoxml', 'linkcheck'],
+)
+@mock.patch('sphinx.builders.linkcheck.requests.head',
+            side_effect=request_session_head)
+@pytest.mark.xfail(sys.platform == 'win32', reason="Not working on windows")
+def test_build_all(requests_head, make_app, nonascii_srcdir, buildername):
+    app = make_app(buildername, srcdir=nonascii_srcdir)
+    app.build()
+
+
+def test_root_doc_not_found(tempdir, make_app):
+    (tempdir / 'conf.py').write_text('', encoding='utf8')
+    assert tempdir.listdir() == ['conf.py']
+
+    app = make_app('dummy', srcdir=tempdir)
+    with pytest.raises(SphinxError):
+        app.builder.build_all()  # no index.rst
+
+
+@pytest.mark.sphinx(buildername='text', testroot='circular')
+def test_circular_toctree(app, status, warning):
+    app.builder.build_all()
+    warnings = warning.getvalue()
+    assert (
+        'circular toctree references detected, ignoring: '
+        'sub <- index <- sub') in warnings
+    assert (
+        'circular toctree references detected, ignoring: '
+        'index <- sub <- index') in warnings
+
+
+@pytest.mark.sphinx(buildername='text', testroot='numbered-circular')
+def test_numbered_circular_toctree(app, status, warning):
+    app.builder.build_all()
+    warnings = warning.getvalue()
+    assert (
+        'circular toctree references detected, ignoring: '
+        'sub <- index <- sub') in warnings
+    assert (
+        'circular toctree references detected, ignoring: '
+        'index <- sub <- index') in warnings
+
+
+@pytest.mark.sphinx(buildername='dummy', testroot='images')
+def test_image_glob(app, status, warning):
+    app.builder.build_all()
+
+    # index.rst
+    doctree = app.env.get_doctree('index')
+
+    assert isinstance(doctree[0][1], nodes.image)
+    assert doctree[0][1]['candidates'] == {'*': 'rimg.png'}
+    assert doctree[0][1]['uri'] == 'rimg.png'
+
+    assert isinstance(doctree[0][2], nodes.figure)
+    assert isinstance(doctree[0][2][0], nodes.image)
+    assert doctree[0][2][0]['candidates'] == {'*': 'rimg.png'}
+    assert doctree[0][2][0]['uri'] == 'rimg.png'
+
+    assert isinstance(doctree[0][3], nodes.image)
+    assert doctree[0][3]['candidates'] == {'application/pdf': 'img.pdf',
+                                           'image/gif': 'img.gif',
+                                           'image/png': 'img.png'}
+    assert doctree[0][3]['uri'] == 'img.*'
+
+    assert isinstance(doctree[0][4], nodes.figure)
+    assert isinstance(doctree[0][4][0], nodes.image)
+    assert doctree[0][4][0]['candidates'] == {'application/pdf': 'img.pdf',
+                                              'image/gif': 'img.gif',
+                                              'image/png': 'img.png'}
+    assert doctree[0][4][0]['uri'] == 'img.*'
+
+    # subdir/index.rst
+    doctree = app.env.get_doctree('subdir/index')
+
+    assert isinstance(doctree[0][1], nodes.image)
+    assert doctree[0][1]['candidates'] == {'*': 'subdir/rimg.png'}
+    assert doctree[0][1]['uri'] == 'subdir/rimg.png'
+
+    assert isinstance(doctree[0][2], nodes.image)
+    assert doctree[0][2]['candidates'] == {'application/pdf': 'subdir/svgimg.pdf',
+                                           'image/svg+xml': 'subdir/svgimg.svg'}
+    assert doctree[0][2]['uri'] == 'subdir/svgimg.*'
+
+    assert isinstance(doctree[0][3], nodes.figure)
+    assert isinstance(doctree[0][3][0], nodes.image)
+    assert doctree[0][3][0]['candidates'] == {'application/pdf': 'subdir/svgimg.pdf',
+                                              'image/svg+xml': 'subdir/svgimg.svg'}
+    assert doctree[0][3][0]['uri'] == 'subdir/svgimg.*'