mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
222 lines
7.0 KiB
Python
222 lines
7.0 KiB
Python
"""Test the BuildEnvironment class."""
|
|
|
|
import shutil
|
|
from pathlib import Path
|
|
|
|
import pytest
|
|
|
|
from sphinx.builders.html import StandaloneHTMLBuilder
|
|
from sphinx.builders.latex import LaTeXBuilder
|
|
from sphinx.config import Config
|
|
from sphinx.environment import (
|
|
CONFIG_CHANGED,
|
|
CONFIG_EXTENSIONS_CHANGED,
|
|
CONFIG_NEW,
|
|
CONFIG_OK,
|
|
_differing_config_keys,
|
|
)
|
|
from sphinx.util.console import strip_colors
|
|
|
|
|
|
@pytest.mark.sphinx('dummy', testroot='basic')
|
|
def test_config_status(make_app, app_params):
|
|
args, kwargs = app_params
|
|
|
|
# clean build
|
|
app1 = make_app(*args, freshenv=True, **kwargs)
|
|
assert app1.env.config_status == CONFIG_NEW
|
|
app1.build()
|
|
output = strip_colors(app1.status.getvalue())
|
|
# assert 'The configuration has changed' not in output
|
|
assert '[new config] 1 added' in output
|
|
|
|
# incremental build (no config changed)
|
|
app2 = make_app(*args, **kwargs)
|
|
assert app2.env.config_status == CONFIG_OK
|
|
app2.build()
|
|
output = strip_colors(app2.status.getvalue())
|
|
assert 'The configuration has changed' not in output
|
|
assert '0 added, 0 changed, 0 removed' in output
|
|
|
|
# incremental build (config entry changed)
|
|
app3 = make_app(*args, confoverrides={'root_doc': 'indexx'}, **kwargs)
|
|
fname = app3.srcdir / 'index.rst'
|
|
assert fname.is_file()
|
|
shutil.move(fname, fname[:-4] + 'x.rst')
|
|
assert app3.env.config_status == CONFIG_CHANGED
|
|
app3.build()
|
|
shutil.move(fname[:-4] + 'x.rst', fname)
|
|
output = strip_colors(app3.status.getvalue())
|
|
assert 'The configuration has changed' in output
|
|
assert "[config changed ('master_doc')] 1 added," in output
|
|
|
|
# incremental build (extension changed)
|
|
app4 = make_app(
|
|
*args, confoverrides={'extensions': ['sphinx.ext.autodoc']}, **kwargs
|
|
)
|
|
assert app4.env.config_status == CONFIG_EXTENSIONS_CHANGED
|
|
app4.build()
|
|
want_str = "[extensions changed ('sphinx.ext.autodoc')] 1 added"
|
|
output = strip_colors(app4.status.getvalue())
|
|
assert 'The configuration has changed' not in output
|
|
assert want_str in output
|
|
|
|
|
|
@pytest.mark.sphinx('dummy', testroot='root')
|
|
def test_images(app):
|
|
app.build()
|
|
|
|
tree = app.env.get_doctree('images')
|
|
htmlbuilder = StandaloneHTMLBuilder(app, app.env)
|
|
htmlbuilder.init()
|
|
htmlbuilder.imgpath = 'dummy'
|
|
htmlbuilder.post_process_images(tree)
|
|
assert set(htmlbuilder.images.keys()) == {
|
|
'subdir/img.png',
|
|
'img.png',
|
|
'subdir/simg.png',
|
|
'svgimg.svg',
|
|
'img.foo.png',
|
|
}
|
|
assert set(htmlbuilder.images.values()) == {
|
|
'img.png',
|
|
'img1.png',
|
|
'simg.png',
|
|
'svgimg.svg',
|
|
'img.foo.png',
|
|
}
|
|
|
|
latexbuilder = LaTeXBuilder(app, app.env)
|
|
latexbuilder.init()
|
|
latexbuilder.post_process_images(tree)
|
|
assert set(latexbuilder.images.keys()) == {
|
|
'subdir/img.png',
|
|
'subdir/simg.png',
|
|
'img.png',
|
|
'img.pdf',
|
|
'svgimg.pdf',
|
|
'img.foo.png',
|
|
}
|
|
assert set(latexbuilder.images.values()) == {
|
|
'img.pdf',
|
|
'img.png',
|
|
'img1.png',
|
|
'simg.png',
|
|
'svgimg.pdf',
|
|
'img.foo.png',
|
|
}
|
|
|
|
|
|
@pytest.mark.sphinx('dummy', testroot='root')
|
|
def test_object_inventory(app):
|
|
app.build()
|
|
refs = app.env.domaindata['py']['objects']
|
|
|
|
assert 'func_without_module' in refs
|
|
assert refs['func_without_module'] == (
|
|
'objects',
|
|
'func_without_module',
|
|
'function',
|
|
False,
|
|
)
|
|
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 app.env.domaindata['py']['modules']['mod'] == (
|
|
'objects',
|
|
'module-mod',
|
|
'Module synopsis.',
|
|
'UNIX',
|
|
False,
|
|
)
|
|
|
|
assert app.env.domains.python_domain.data is app.env.domaindata['py']
|
|
assert app.env.domains.c_domain.data is app.env.domaindata['c']
|
|
|
|
|
|
@pytest.mark.sphinx('dummy', testroot='basic')
|
|
def test_env_relfn2path(app):
|
|
# relative filename and root document
|
|
relfn, absfn = app.env.relfn2path('logo.jpg', 'index')
|
|
assert relfn == 'logo.jpg'
|
|
assert absfn == str(app.srcdir / 'logo.jpg')
|
|
|
|
# absolute filename and root document
|
|
relfn, absfn = app.env.relfn2path('/logo.jpg', 'index')
|
|
assert relfn == 'logo.jpg'
|
|
assert absfn == str(app.srcdir / 'logo.jpg')
|
|
|
|
# relative filename and a document in subdir
|
|
relfn, absfn = app.env.relfn2path('logo.jpg', 'subdir/index')
|
|
assert Path(relfn) == Path('subdir/logo.jpg')
|
|
assert absfn == str(app.srcdir / 'subdir' / 'logo.jpg')
|
|
|
|
# absolute filename and a document in subdir
|
|
relfn, absfn = app.env.relfn2path('/logo.jpg', 'subdir/index')
|
|
assert relfn == 'logo.jpg'
|
|
assert absfn == str(app.srcdir / 'logo.jpg')
|
|
|
|
# relative filename having subdir
|
|
relfn, absfn = app.env.relfn2path('images/logo.jpg', 'index')
|
|
assert relfn == 'images/logo.jpg'
|
|
assert absfn == str(app.srcdir / 'images' / 'logo.jpg')
|
|
|
|
# relative path traversal
|
|
relfn, absfn = app.env.relfn2path('../logo.jpg', 'index')
|
|
assert relfn == '../logo.jpg'
|
|
assert absfn == str(app.srcdir.parent / 'logo.jpg')
|
|
|
|
# relative path traversal
|
|
relfn, absfn = app.env.relfn2path('subdir/../logo.jpg', 'index')
|
|
assert relfn == 'logo.jpg'
|
|
assert absfn == str(app.srcdir / 'logo.jpg')
|
|
|
|
# omit docname (w/ current docname)
|
|
app.env.temp_data['docname'] = 'subdir/document'
|
|
relfn, absfn = app.env.relfn2path('images/logo.jpg')
|
|
assert Path(relfn) == Path('subdir/images/logo.jpg')
|
|
assert absfn == str(app.srcdir / 'subdir' / 'images' / 'logo.jpg')
|
|
|
|
# omit docname (w/o current docname)
|
|
app.env.temp_data.clear()
|
|
with pytest.raises(KeyError):
|
|
app.env.relfn2path('images/logo.jpg')
|
|
|
|
|
|
def test_differing_config_keys():
|
|
diff = _differing_config_keys
|
|
|
|
old = Config({'project': 'old'})
|
|
new = Config({'project': 'new'})
|
|
assert diff(old, new) == frozenset({'project'})
|
|
|
|
old = Config({'project': 'project', 'release': 'release'})
|
|
new = Config({'project': 'project', 'version': 'version'})
|
|
assert diff(old, new) == frozenset({'release', 'version'})
|
|
|
|
old = Config({'project': 'project', 'release': 'release'})
|
|
new = Config({'project': 'project'})
|
|
assert diff(old, new) == frozenset({'release'})
|
|
|
|
old = Config({'project': 'project'})
|
|
new = Config({'project': 'project', 'version': 'version'})
|
|
assert diff(old, new) == frozenset({'version'})
|
|
|
|
old = Config({'project': 'project', 'release': 'release', 'version': 'version'})
|
|
new = Config({'project': 'project', 'release': 'release', 'version': 'version'})
|
|
assert diff(old, new) == frozenset()
|
|
|
|
old = Config({'project': 'old', 'release': 'release'})
|
|
new = Config({'project': 'new', 'version': 'version'})
|
|
assert diff(old, new) == frozenset({'project', 'release', 'version'})
|