mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
235 lines
8.4 KiB
Python
235 lines
8.4 KiB
Python
# -*- coding: utf-8 -*-
|
|
"""
|
|
test_build_html
|
|
~~~~~~~~~~~~~~~
|
|
|
|
Test the HTML builder and check output against XPath.
|
|
|
|
:copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
|
|
:license: BSD, see LICENSE for details.
|
|
"""
|
|
|
|
import os
|
|
import re
|
|
import sys
|
|
import difflib
|
|
import htmlentitydefs
|
|
from StringIO import StringIO
|
|
|
|
try:
|
|
import pygments
|
|
except ImportError:
|
|
pygments = None
|
|
|
|
from sphinx.builders.html import StandaloneHTMLBuilder
|
|
|
|
from util import *
|
|
from test_build import ENV_WARNINGS
|
|
from etree13 import ElementTree as ET
|
|
|
|
|
|
def teardown_module():
|
|
(test_root / '_build').rmtree(True)
|
|
|
|
|
|
html_warnfile = StringIO()
|
|
|
|
HTML_WARNINGS = ENV_WARNINGS + """\
|
|
%(root)s/images.txt:20: WARNING: no matching candidate for image URI u'foo.*'
|
|
%(root)s/markup.txt:: WARNING: invalid index entry u''
|
|
%(root)s/markup.txt:: WARNING: invalid pair index entry u''
|
|
%(root)s/markup.txt:: WARNING: invalid pair index entry u'keyword; '
|
|
"""
|
|
|
|
HTML_XPATH = {
|
|
'images.html': {
|
|
".//img[@src='_images/img.png']": '',
|
|
".//img[@src='_images/img1.png']": '',
|
|
".//img[@src='_images/simg.png']": '',
|
|
".//object[@data='_images/svgimg.svg']": '',
|
|
".//embed[@src='_images/svgimg.svg']": '',
|
|
},
|
|
'subdir/images.html': {
|
|
".//img[@src='../_images/img1.png']": '',
|
|
".//img[@src='../_images/rimg.png']": '',
|
|
},
|
|
'subdir/includes.html': {
|
|
".//a[@href='../_downloads/img.png']": '',
|
|
},
|
|
'includes.html': {
|
|
".//pre": u'Max Strauß',
|
|
".//a[@href='_downloads/img.png']": '',
|
|
".//a[@href='_downloads/img1.png']": '',
|
|
},
|
|
'autodoc.html': {
|
|
".//dt[@id='test_autodoc.Class']": '',
|
|
".//dt[@id='test_autodoc.function']/em": r'\*\*kwds',
|
|
".//dd": r'Return spam\.',
|
|
},
|
|
'markup.html': {
|
|
".//title": 'set by title directive',
|
|
".//p/em": 'Section author: Georg Brandl',
|
|
".//p/em": 'Module author: Georg Brandl',
|
|
# created by the meta directive
|
|
".//meta[@name='author'][@content='Me']": '',
|
|
".//meta[@name='keywords'][@content='docs, sphinx']": '',
|
|
# a label created by ``.. _label:``
|
|
".//div[@id='label']": '',
|
|
# code with standard code blocks
|
|
".//pre": '^some code$',
|
|
# an option list
|
|
".//span[@class='option']": '--help',
|
|
# admonitions
|
|
".//p[@class='first admonition-title']": 'My Admonition',
|
|
".//p[@class='last']": 'Note text.',
|
|
".//p[@class='last']": 'Warning text.',
|
|
# inline markup
|
|
".//li/strong": '^command$',
|
|
".//li/strong": '^program$',
|
|
".//li/em": '^dfn$',
|
|
".//li/tt/span[@class='pre']": '^kbd$',
|
|
".//li/em": u'File \N{TRIANGULAR BULLET} Close',
|
|
".//li/tt/span[@class='pre']": '^a/$',
|
|
".//li/tt/em/span[@class='pre']": '^varpart$',
|
|
".//li/tt/em/span[@class='pre']": '^i$',
|
|
".//a[@href='http://www.python.org/dev/peps/pep-0008']/strong": 'PEP 8',
|
|
".//a[@href='http://tools.ietf.org/html/rfc1.html']/strong": 'RFC 1',
|
|
".//a[@href='objects.html#envvar-HOME']/tt/span[@class='pre']": 'HOME',
|
|
".//a[@href='#with']/tt/span[@class='pre']": '^with$',
|
|
".//a[@href='#grammar-token-try_stmt']/tt/span": '^statement$',
|
|
".//a[@href='subdir/includes.html']/em": 'Including in subdir',
|
|
".//a[@href='objects.html#cmdoption-python-c']/em": 'Python -c option',
|
|
# abbreviations
|
|
".//abbr[@title='abbreviation']": '^abbr$',
|
|
# version stuff
|
|
".//span[@class='versionmodified']": 'New in version 0.6',
|
|
# footnote reference
|
|
".//a[@class='footnote-reference']": r'\[1\]',
|
|
# created by reference lookup
|
|
".//a[@href='contents.html#ref1']": '',
|
|
# ``seealso`` directive
|
|
".//div/p[@class='first admonition-title']": 'See also',
|
|
# a ``hlist`` directive
|
|
".//table[@class='hlist']/tr/td/ul/li": '^This$',
|
|
# a ``centered`` directive
|
|
".//p[@class='centered']/strong": 'LICENSE',
|
|
# a glossary
|
|
".//dl/dt[@id='term-boson']": 'boson',
|
|
# a production list
|
|
".//pre/strong": 'try_stmt',
|
|
".//pre/a[@href='#grammar-token-try1_stmt']/tt/span": 'try1_stmt',
|
|
# tests for ``only`` directive
|
|
".//p": 'A global substitution.',
|
|
".//p": 'In HTML.',
|
|
".//p": 'In both.',
|
|
".//p": 'Always present',
|
|
},
|
|
'objects.html': {
|
|
".//dt[@id='mod.Cls.meth1']": '',
|
|
".//dt[@id='errmod.Error']": '',
|
|
".//a[@href='#mod.Cls']": '',
|
|
".//dl[@class='userdesc']": '',
|
|
".//dt[@id='userdesc-myobj']": '',
|
|
".//a[@href='#userdesc-myobj']": '',
|
|
# C references
|
|
".//span[@class='pre']": 'CFunction()',
|
|
".//a[@href='#Sphinx_DoSomething']": '',
|
|
".//a[@href='#SphinxStruct.member']": '',
|
|
".//a[@href='#SPHINX_USE_PYTHON']": '',
|
|
".//a[@href='#SphinxType']": '',
|
|
".//a[@href='#sphinx_global']": '',
|
|
},
|
|
'contents.html': {
|
|
".//meta[@name='hc'][@content='hcval']": '',
|
|
".//meta[@name='testopt'][@content='testoverride']": '',
|
|
#".//td[@class='label']": r'\[Ref1\]', # docutils 0.5 only
|
|
".//td[@class='label']": '',
|
|
".//li[@class='toctree-l1']/a": 'Testing various markup',
|
|
".//li[@class='toctree-l2']/a": 'Inline markup',
|
|
".//title": 'Sphinx <Tests>',
|
|
".//div[@class='footer']": 'Georg Brandl & Team',
|
|
".//a[@href='http://python.org/']": '',
|
|
".//li/a[@href='genindex.html']/em": 'Index',
|
|
".//li/a[@href='modindex.html']/em": 'Module Index',
|
|
".//li/a[@href='search.html']/em": 'Search Page',
|
|
},
|
|
'bom.html': {
|
|
".//title": " File with UTF-8 BOM",
|
|
},
|
|
'_static/statictmpl.html': {
|
|
".//project": 'Sphinx <Tests>',
|
|
},
|
|
}
|
|
|
|
if pygments:
|
|
HTML_XPATH['includes.html'].update({
|
|
".//pre/span[@class='s']": u'üöä',
|
|
".//div[@class='inc-pyobj1 highlight-text']/div/pre":
|
|
r'^class Foo:\n pass\n\s*$',
|
|
".//div[@class='inc-pyobj2 highlight-text']/div/pre":
|
|
r'^ def baz\(\):\n pass\n\s*$',
|
|
".//div[@class='inc-lines highlight-text']/div/pre":
|
|
r'^class Foo:\n pass\nclass Bar:\n$',
|
|
".//div[@class='inc-startend highlight-text']/div/pre":
|
|
ur'^foo = u"Including Unicode characters: üöä"\n$',
|
|
".//div[@class='inc-preappend highlight-text']/div/pre":
|
|
r'(?m)^START CODE$',
|
|
".//div[@class='inc-pyobj-dedent highlight-python']/div/pre/span":
|
|
r'def',
|
|
})
|
|
HTML_XPATH['subdir/includes.html'].update({
|
|
".//pre/span": 'line 1',
|
|
".//pre/span": 'line 2',
|
|
})
|
|
|
|
class NslessParser(ET.XMLParser):
|
|
"""XMLParser that throws away namespaces in tag names."""
|
|
|
|
def _fixname(self, key):
|
|
try:
|
|
return self._names[key]
|
|
except KeyError:
|
|
name = key
|
|
br = name.find('}')
|
|
if br > 0:
|
|
name = name[br+1:]
|
|
self._names[key] = name = self._fixtext(name)
|
|
return name
|
|
|
|
|
|
def check_xpath(etree, fname, path, check):
|
|
nodes = list(etree.findall(path))
|
|
assert nodes != [], ('did not find any node matching xpath '
|
|
'%r in file %s' % (path, fname))
|
|
if hasattr(check, '__call__'):
|
|
check(nodes)
|
|
elif not check:
|
|
# only check for node presence
|
|
pass
|
|
else:
|
|
rex = re.compile(check)
|
|
for node in nodes:
|
|
if node.text and rex.search(node.text):
|
|
break
|
|
else:
|
|
assert False, ('%r not found in any node matching '
|
|
'path %s in %s: %r' % (check, path, fname,
|
|
[node.text for node in nodes]))
|
|
|
|
@gen_with_app(buildername='html', warning=html_warnfile, cleanenv=True,
|
|
tags=['testtag'])
|
|
def test_html(app):
|
|
app.builder.build_all()
|
|
html_warnings = html_warnfile.getvalue().replace(os.sep, '/')
|
|
html_warnings_exp = HTML_WARNINGS % {'root': app.srcdir}
|
|
assert html_warnings == html_warnings_exp, 'Warnings don\'t match:\n' + \
|
|
'\n'.join(difflib.ndiff(html_warnings_exp.splitlines(),
|
|
html_warnings.splitlines()))
|
|
|
|
for fname, paths in HTML_XPATH.iteritems():
|
|
parser = NslessParser()
|
|
parser.entity.update(htmlentitydefs.entitydefs)
|
|
etree = ET.parse(os.path.join(app.outdir, fname), parser)
|
|
for path, check in paths.iteritems():
|
|
yield check_xpath, etree, fname, path, check
|