mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
129 lines
4.3 KiB
Python
129 lines
4.3 KiB
Python
# -*- coding: utf-8 -*-
|
|
"""
|
|
test_env
|
|
~~~~~~~~
|
|
|
|
Test the BuildEnvironment class.
|
|
|
|
:copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
|
|
:license: BSD, see LICENSE for details.
|
|
"""
|
|
import pytest
|
|
|
|
from sphinx.testing.util import SphinxTestApp, path
|
|
from sphinx.builders.html import StandaloneHTMLBuilder
|
|
from sphinx.builders.latex import LaTeXBuilder
|
|
|
|
app = env = None
|
|
|
|
|
|
@pytest.fixture(scope='module', autouse=True)
|
|
def setup_module(rootdir, sphinx_test_tempdir):
|
|
global app, env
|
|
srcdir = sphinx_test_tempdir / 'root-envtest'
|
|
if not srcdir.exists():
|
|
(rootdir / 'test-root').copytree(srcdir)
|
|
app = SphinxTestApp(srcdir=srcdir)
|
|
env = app.env
|
|
yield
|
|
app.cleanup()
|
|
|
|
|
|
# Tests are run in the order they appear in the file, therefore we can
|
|
# afford to not run update() in the setup but in its own test
|
|
|
|
def test_first_update():
|
|
updated = env.update(app.config, app.srcdir, app.doctreedir)
|
|
assert set(updated) == env.found_docs == set(env.all_docs)
|
|
# test if exclude_patterns works ok
|
|
assert 'subdir/excluded' not in env.found_docs
|
|
|
|
|
|
def test_images():
|
|
assert ('image file not readable: foo.png'
|
|
in app._warning.getvalue())
|
|
|
|
tree = env.get_doctree('images')
|
|
htmlbuilder = StandaloneHTMLBuilder(app)
|
|
htmlbuilder.set_environment(app.env)
|
|
htmlbuilder.init()
|
|
htmlbuilder.imgpath = 'dummy'
|
|
htmlbuilder.post_process_images(tree)
|
|
assert set(htmlbuilder.images.keys()) == \
|
|
set(['subdir/img.png', 'img.png', 'subdir/simg.png', 'svgimg.svg',
|
|
'img.foo.png'])
|
|
assert set(htmlbuilder.images.values()) == \
|
|
set(['img.png', 'img1.png', 'simg.png', 'svgimg.svg', 'img.foo.png'])
|
|
|
|
latexbuilder = LaTeXBuilder(app)
|
|
latexbuilder.set_environment(app.env)
|
|
latexbuilder.init()
|
|
latexbuilder.post_process_images(tree)
|
|
assert set(latexbuilder.images.keys()) == \
|
|
set(['subdir/img.png', 'subdir/simg.png', 'img.png', 'img.pdf',
|
|
'svgimg.pdf', 'img.foo.png'])
|
|
assert set(latexbuilder.images.values()) == \
|
|
set(['img.pdf', 'img.png', 'img1.png', 'simg.png',
|
|
'svgimg.pdf', 'img.foo.png'])
|
|
|
|
|
|
def test_second_update():
|
|
# delete, add and "edit" (change saved mtime) some files and update again
|
|
env.all_docs['contents'] = 0
|
|
root = path(app.srcdir)
|
|
# important: using "autodoc" because it is the last one to be included in
|
|
# the contents.txt toctree; otherwise section numbers would shift
|
|
(root / 'autodoc.txt').unlink()
|
|
(root / 'new.txt').write_text('New file\n========\n')
|
|
updated = env.update(app.config, app.srcdir, app.doctreedir)
|
|
# "includes" and "images" are in there because they contain references
|
|
# to nonexisting downloadable or image files, which are given another
|
|
# chance to exist
|
|
assert set(updated) == set(['contents', 'new', 'includes', 'images'])
|
|
assert 'autodoc' not in env.all_docs
|
|
assert 'autodoc' not in env.found_docs
|
|
|
|
|
|
def test_env_read_docs():
|
|
"""By default, docnames are read in alphanumeric order"""
|
|
def on_env_read_docs_1(app, env, docnames):
|
|
pass
|
|
|
|
app.connect('env-before-read-docs', on_env_read_docs_1)
|
|
|
|
read_docnames = env.update(app.config, app.srcdir, app.doctreedir)
|
|
assert len(read_docnames) > 2 and read_docnames == sorted(read_docnames)
|
|
|
|
def on_env_read_docs_2(app, env, docnames):
|
|
docnames.remove('images')
|
|
|
|
app.connect('env-before-read-docs', on_env_read_docs_2)
|
|
|
|
read_docnames = env.update(app.config, app.srcdir, app.doctreedir)
|
|
assert len(read_docnames) == 2
|
|
|
|
|
|
def test_object_inventory():
|
|
refs = env.domaindata['py']['objects']
|
|
|
|
assert 'func_without_module' in refs
|
|
assert refs['func_without_module'] == ('objects', 'function')
|
|
assert 'func_without_module2' in refs
|
|
assert 'mod.func_in_module' in refs
|
|
assert 'mod.Cls' in refs
|
|
assert 'mod.Cls.meth1' in refs
|
|
assert 'mod.Cls.meth2' in refs
|
|
assert 'mod.Cls.meths' in refs
|
|
|
|
assert 'mod.Error' not in refs
|
|
assert 'errmod.Error' in refs
|
|
|
|
assert 'func_in_module' not in refs
|
|
assert 'func_noindex' not in refs
|
|
|
|
assert env.domaindata['py']['modules']['mod'] == \
|
|
('objects', 'Module synopsis.', 'UNIX', False)
|
|
|
|
assert env.domains['py'].data is env.domaindata['py']
|
|
assert env.domains['c'].data is env.domaindata['c']
|