mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
bade33c7e4
In Python 3, the default encoding of source files is utf-8. The encoding cookie is now unnecessary and redundant so remove it. For more details, see the docs: https://docs.python.org/3/howto/unicode.html#the-string-type > The default encoding for Python source code is UTF-8, so you can > simply include a Unicode character in a string literal ... Includes a fix for the flake8 header checks to stop expecting an encoding cookie.
146 lines
4.3 KiB
Python
146 lines
4.3 KiB
Python
"""
|
|
test_setup_command
|
|
~~~~~~~~~~~~~~~~~~~
|
|
|
|
Test setup_command for distutils.
|
|
|
|
:copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
|
|
:license: BSD, see LICENSE for details.
|
|
"""
|
|
|
|
import os
|
|
import subprocess
|
|
import sys
|
|
from collections import namedtuple
|
|
from textwrap import dedent
|
|
|
|
import pytest
|
|
|
|
import sphinx
|
|
from sphinx.util.osutil import cd
|
|
|
|
|
|
@pytest.fixture
|
|
def setup_command(request, tempdir, rootdir):
|
|
"""
|
|
Run `setup.py build_sphinx` with args and kwargs,
|
|
pass it to the test and clean up properly.
|
|
"""
|
|
if hasattr(request.node, 'get_closest_marker'): # pytest-3.6.0 or newer
|
|
marker = request.node.get_closest_marker('setup_command')
|
|
else:
|
|
marker = request.node.get_marker('setup_command')
|
|
args = marker.args if marker else []
|
|
|
|
pkgrootdir = tempdir / 'test-setup'
|
|
(rootdir / 'test-setup').copytree(pkgrootdir)
|
|
|
|
with cd(pkgrootdir):
|
|
pythonpath = os.path.dirname(os.path.dirname(sphinx.__file__))
|
|
if os.getenv('PYTHONPATH'):
|
|
pythonpath = os.getenv('PYTHONPATH') + os.pathsep + pythonpath
|
|
command = [sys.executable, 'setup.py', 'build_sphinx']
|
|
command.extend(args)
|
|
|
|
proc = subprocess.Popen(
|
|
command,
|
|
env=dict(os.environ, PYTHONPATH=pythonpath),
|
|
stdout=subprocess.PIPE,
|
|
stderr=subprocess.PIPE)
|
|
yield namedtuple('setup', 'pkgroot,proc')(pkgrootdir, proc)
|
|
|
|
|
|
def test_build_sphinx(setup_command):
|
|
proc = setup_command.proc
|
|
out, err = proc.communicate()
|
|
print(out.decode())
|
|
print(err.decode())
|
|
assert proc.returncode == 0
|
|
|
|
|
|
@pytest.mark.setup_command('-b', 'html,man')
|
|
def test_build_sphinx_multiple_builders(setup_command):
|
|
proc = setup_command.proc
|
|
out, err = proc.communicate()
|
|
print(out.decode())
|
|
print(err.decode())
|
|
assert proc.returncode == 0
|
|
|
|
|
|
@pytest.mark.setup_command('-b', 'html,bar')
|
|
def test_build_sphinx_multiple_invalid_builders(setup_command):
|
|
proc = setup_command.proc
|
|
out, err = proc.communicate()
|
|
print(out.decode())
|
|
print(err.decode())
|
|
assert proc.returncode == 1
|
|
|
|
|
|
@pytest.fixture
|
|
def nonascii_srcdir(request, setup_command):
|
|
mb_name = '\u65e5\u672c\u8a9e'
|
|
srcdir = (setup_command.pkgroot / 'doc')
|
|
try:
|
|
(srcdir / mb_name).makedirs()
|
|
except UnicodeEncodeError:
|
|
from sphinx.testing.path import FILESYSTEMENCODING
|
|
pytest.skip(
|
|
'non-ASCII filename not supported on this filesystem encoding: '
|
|
'%s' % FILESYSTEMENCODING)
|
|
|
|
(srcdir / mb_name / (mb_name + '.txt')).write_text(dedent("""
|
|
multi byte file name page
|
|
==========================
|
|
"""))
|
|
|
|
master_doc = srcdir / 'index.txt'
|
|
master_doc.write_bytes((master_doc.text() + dedent("""
|
|
.. toctree::
|
|
|
|
%(mb_name)s/%(mb_name)s
|
|
""" % locals())).encode())
|
|
|
|
|
|
@pytest.mark.usefixtures('nonascii_srcdir')
|
|
def test_build_sphinx_with_nonascii_path(setup_command):
|
|
proc = setup_command.proc
|
|
out, err = proc.communicate()
|
|
print(out.decode())
|
|
print(err.decode())
|
|
assert proc.returncode == 0
|
|
|
|
|
|
@pytest.mark.setup_command('-b', 'linkcheck')
|
|
def test_build_sphinx_return_nonzero_status(setup_command):
|
|
srcdir = (setup_command.pkgroot / 'doc')
|
|
(srcdir / 'contents.txt').write_text(
|
|
'http://localhost.unexistentdomain/index.html')
|
|
proc = setup_command.proc
|
|
out, err = proc.communicate()
|
|
print(out.decode())
|
|
print(err.decode())
|
|
assert proc.returncode != 0, 'expect non-zero status for setup.py'
|
|
|
|
|
|
def test_build_sphinx_warning_return_zero_status(setup_command):
|
|
srcdir = (setup_command.pkgroot / 'doc')
|
|
(srcdir / 'contents.txt').write_text(
|
|
'See :ref:`unexisting-reference-label`')
|
|
proc = setup_command.proc
|
|
out, err = proc.communicate()
|
|
print(out.decode())
|
|
print(err.decode())
|
|
assert proc.returncode == 0
|
|
|
|
|
|
@pytest.mark.setup_command('--warning-is-error')
|
|
def test_build_sphinx_warning_is_error_return_nonzero_status(setup_command):
|
|
srcdir = (setup_command.pkgroot / 'doc')
|
|
(srcdir / 'contents.txt').write_text(
|
|
'See :ref:`unexisting-reference-label`')
|
|
proc = setup_command.proc
|
|
out, err = proc.communicate()
|
|
print(out.decode())
|
|
print(err.decode())
|
|
assert proc.returncode != 0, 'expect non-zero status for setup.py'
|