mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
3204f83dc7
svn+ssh://pythondev@svn.python.org/doctools/branches/0.4.x ........ r65556 | georg.brandl | 2008-08-06 15:12:43 +0000 (Wed, 06 Aug 2008) | 2 lines Run latex over the latex builder's output. ........
138 lines
4.2 KiB
Python
138 lines
4.2 KiB
Python
# -*- coding: utf-8 -*-
|
|
"""
|
|
test_build
|
|
~~~~~~~~~~
|
|
|
|
Test the entire build process with the test root.
|
|
|
|
:copyright: 2008 by Georg Brandl.
|
|
:license: BSD.
|
|
"""
|
|
|
|
import os
|
|
import difflib
|
|
import htmlentitydefs
|
|
from StringIO import StringIO
|
|
from subprocess import Popen, PIPE
|
|
|
|
from util import *
|
|
from etree13 import ElementTree as ET
|
|
|
|
from sphinx.builder import StandaloneHTMLBuilder, LaTeXBuilder
|
|
from sphinx.latexwriter import LaTeXTranslator
|
|
|
|
|
|
html_warnfile = StringIO()
|
|
latex_warnfile = StringIO()
|
|
|
|
ENV_WARNINGS = """\
|
|
WARNING: %(root)s/images.txt:9: Image file not readable: foo.png
|
|
WARNING: %(root)s/images.txt:20: Nonlocal image URI found: http://www.python.org/logo.png
|
|
WARNING: %(root)s/includes.txt:: (WARNING/2) Encoding 'utf-8' used for reading included file u'wrongenc.inc' seems to be wrong, try giving an :encoding: option
|
|
"""
|
|
|
|
HTML_WARNINGS = ENV_WARNINGS + """\
|
|
WARNING: %(root)s/images.txt:: no matching candidate for image URI u'foo.*'
|
|
"""
|
|
|
|
LATEX_WARNINGS = ENV_WARNINGS + """\
|
|
WARNING: None:: no matching candidate for image URI u'foo.*'
|
|
"""
|
|
|
|
HTML_XPATH = {
|
|
'images.html': {
|
|
".//img[@src='_images/img.png']": '',
|
|
".//img[@src='_images/img1.png']": '',
|
|
},
|
|
'includes.html': {
|
|
".//pre/span[@class='s']": u'üöä',
|
|
".//pre": u'Max Strauß',
|
|
},
|
|
}
|
|
|
|
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
|
|
|
|
|
|
@with_testapp(buildername='html', warning=html_warnfile)
|
|
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()))
|
|
|
|
if not ET:
|
|
return
|
|
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, text in paths.iteritems():
|
|
nodes = list(etree.findall(path))
|
|
assert nodes != []
|
|
if not text:
|
|
# only check for node presence
|
|
continue
|
|
for node in nodes:
|
|
if node.text and text in node.text:
|
|
break
|
|
else:
|
|
assert False, ('%r not found in any node matching '
|
|
'path %s in %s' % (text, path, fname))
|
|
|
|
|
|
@with_testapp(buildername='latex', warning=latex_warnfile)
|
|
def test_latex(app):
|
|
LaTeXTranslator.ignore_missing_images = True
|
|
app.builder.build_all()
|
|
latex_warnings = latex_warnfile.getvalue().replace(os.sep, '/')
|
|
latex_warnings_exp = LATEX_WARNINGS % {'root': app.srcdir}
|
|
assert latex_warnings == latex_warnings_exp, 'Warnings don\'t match:\n' + \
|
|
'\n'.join(difflib.ndiff(latex_warnings_exp.splitlines(),
|
|
latex_warnings.splitlines()))
|
|
|
|
# now, try to run latex over it
|
|
cwd = os.getcwd()
|
|
os.chdir(app.outdir)
|
|
try:
|
|
try:
|
|
p = Popen(['pdflatex', '--interaction=nonstopmode', 'SphinxTests.tex'],
|
|
stdout=PIPE, stderr=PIPE)
|
|
except OSError, err:
|
|
pass # most likely pdflatex was not found
|
|
else:
|
|
stdout, stderr = p.communicate()
|
|
if p.returncode != 0:
|
|
print stdout
|
|
del app.cleanup_trees[:]
|
|
assert False, 'latex exited with error'
|
|
finally:
|
|
os.chdir(cwd)
|
|
|
|
# just let the remaining ones run for now
|
|
|
|
@with_testapp(buildername='linkcheck')
|
|
def test_linkcheck(app):
|
|
app.builder.build_all()
|
|
|
|
@with_testapp(buildername='text')
|
|
def test_text(app):
|
|
app.builder.build_all()
|
|
|
|
@with_testapp(buildername='changes', cleanenv=True)
|
|
def test_changes(app):
|
|
app.builder.build_all()
|