summaryrefslogtreecommitdiff
path: root/tests/test_config.py
diff options
context:
space:
mode:
Diffstat (limited to 'tests/test_config.py')
-rw-r--r--tests/test_config.py75
1 files changed, 58 insertions, 17 deletions
diff --git a/tests/test_config.py b/tests/test_config.py
index 1e00091d..db5a9560 100644
--- a/tests/test_config.py
+++ b/tests/test_config.py
@@ -9,18 +9,18 @@
:copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
-import sys
+from six import PY2, PY3, StringIO
-from util import TestApp, with_app, with_tempdir, raises, raises_msg, write_file
+from util import TestApp, with_app, with_tempdir, raises, raises_msg
from sphinx.config import Config
from sphinx.errors import ExtensionError, ConfigError, VersionRequirementError
-from sphinx.util.pycompat import b
@with_app(confoverrides={'master_doc': 'master', 'nonexisting_value': 'True',
- 'latex_elements.docclass': 'scrartcl'})
-def test_core_config(app):
+ 'latex_elements.docclass': 'scrartcl',
+ 'modindex_common_prefix': 'path1,path2'})
+def test_core_config(app, status, warning):
cfg = app.config
# simple values
@@ -31,11 +31,12 @@ def test_core_config(app):
# overrides
assert cfg.master_doc == 'master'
assert cfg.latex_elements['docclass'] == 'scrartcl'
+ assert cfg.modindex_common_prefix == ['path1', 'path2']
# simple default values
assert 'locale_dirs' not in cfg.__dict__
assert cfg.locale_dirs == []
- assert cfg.trim_footnote_reference_space == False
+ assert cfg.trim_footnote_reference_space is False
# complex default values
assert 'html_title' not in cfg.__dict__
@@ -67,7 +68,7 @@ def test_core_config(app):
@with_app()
-def test_extension_values(app):
+def test_extension_values(app, status, warning):
cfg = app.config
# default value
@@ -85,23 +86,24 @@ def test_extension_values(app):
@with_tempdir
def test_errors_warnings(dir):
# test the error for syntax errors in the config file
- write_file(dir / 'conf.py', u'project = \n', 'ascii')
+ (dir / 'conf.py').write_text(u'project = \n', encoding='ascii')
raises_msg(ConfigError, 'conf.py', Config, dir, 'conf.py', {}, None)
# test the automatic conversion of 2.x only code in configs
- write_file(dir / 'conf.py', u'# -*- coding: utf-8\n\n'
- u'project = u"Jägermeister"\n', 'utf-8')
+ (dir / 'conf.py').write_text(
+ u'# -*- coding: utf-8\n\nproject = u"Jägermeister"\n',
+ encoding='utf-8')
cfg = Config(dir, 'conf.py', {}, None)
- cfg.init_values()
+ cfg.init_values(lambda warning: 1/0)
assert cfg.project == u'Jägermeister'
# test the warning for bytestrings with non-ascii content
# bytestrings with non-ascii content are a syntax error in python3 so we
# skip the test there
- if sys.version_info >= (3, 0):
+ if PY3:
return
- write_file(dir / 'conf.py', u'# -*- coding: latin-1\nproject = "fooä"\n',
- 'latin-1')
+ (dir / 'conf.py').write_text(
+ u'# -*- coding: latin-1\nproject = "fooä"\n', encoding='latin-1')
cfg = Config(dir, 'conf.py', {}, None)
warned = [False]
def warn(msg):
@@ -126,8 +128,47 @@ def test_needs_sphinx():
def test_config_eol(tmpdir):
# test config file's eol patterns: LF, CRLF
configfile = tmpdir / 'conf.py'
- for eol in ('\n', '\r\n'):
- configfile.write_bytes(b('project = "spam"' + eol))
+ for eol in (b'\n', b'\r\n'):
+ configfile.write_bytes(b'project = "spam"' + eol)
cfg = Config(tmpdir, 'conf.py', {}, None)
- cfg.init_values()
+ cfg.init_values(lambda warning: 1/0)
assert cfg.project == u'spam'
+
+
+TYPECHECK_OVERRIDES = [
+ # configuration key, override value, should warn, default type
+ ('master_doc', 123, True, str),
+ ('man_pages', 123, True, list), # lambda
+ ('man_pages', [], False, list),
+ ('epub_tocdepth', True, True, int), # child type
+ ('nitpicky', 3, False, bool), # parent type
+ ('templates_path', (), True, list), # other sequence, also raises
+]
+if PY2:
+ # Run a check for proper sibling detection in Python 2. Under py3k, the
+ # default types do not have any siblings.
+ TYPECHECK_OVERRIDES.append(
+ ('html_add_permalinks', 'bar', False, unicode))
+
+def test_gen_check_types():
+ for key, value, should, deftype in TYPECHECK_OVERRIDES:
+ warning = StringIO()
+ try:
+ app = TestApp(confoverrides={key: value}, warning=warning)
+ except:
+ pass
+ else:
+ app.cleanup()
+
+ real = type(value).__name__
+ msg = ("WARNING: the config value %r has type `%s',"
+ " defaults to `%s.'\n" % (key, real, deftype.__name__))
+ def test():
+ warning_list = warning.getvalue()
+ assert (msg in warning_list) == should, \
+ "Setting %s to %r should%s raise: %s" % \
+ (key, value, " not" if should else "", msg)
+ test.description = "test_check_type_%s_on_%s" % \
+ (real, type(Config.config_values[key][0]).__name__)
+
+ yield test