1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
|
#!/usr/bin/python
""" Copyright (c) 2009 Colin Stewart (http://www.owlfish.com/)
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
3. The name of the author may not be used to endorse or promote products
derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
If you make any bug fixes or feature enhancements please let me know!
Unit test cases.
"""
import unittest, os, sys
import io
import logging, logging.config
import xml.sax, xml.sax.handler
from hashlib import md5
try:
# check to see if pyxml is installed
from xml.sax.saxlib import LexicalHandler
use_lexical_handler = 1
except ImportError:
use_lexical_handler = 0
class LexicalHandler:
pass
from simpletal import simpleTAL, simpleTALES
if (os.path.exists ("logging.ini")):
logging.config.fileConfig ("logging.ini")
else:
logging.basicConfig()
class stringHasher:
def __init__ (self, encoding = 'utf-8'):
self.encoding = encoding
self.hasher = md5()
def update (self, avalue):
if (isinstance (avalue, str)):
self.hasher.update(avalue.encode ('utf-8'))
else:
self.hasher.update (avalue)
def digest (self):
return self.hasher.digest()
def hexdigest (self):
return self.hasher.hexdigest()
class XMLChecksumHandler (xml.sax.handler.ContentHandler, xml.sax.handler.DTDHandler, xml.sax.handler.ErrorHandler, LexicalHandler):
def __init__ (self, parser):
xml.sax.handler.ContentHandler.__init__ (self)
self.ourParser = parser
def getDigest (self):
return self.digest.hexdigest()
def startDocument (self):
self.digest = stringHasher()
def startPrefixMapping (self, prefix, uri):
self.digest.update (prefix)
self.digest.update (uri)
def endPrefixMapping (self, prefix):
self.digest.update (prefix)
def startElement (self, name, atts):
self.digest.update (name)
allAtts = atts.getNames()
allAtts.sort()
for att in allAtts:
self.digest.update (att)
self.digest.update (atts [att])
def endElement (self, name):
self.digest.update (name)
def characters (self, data):
self.digest.update (data)
def processingInstruction (self, target, data):
self.digest.update (target)
self.digest.update (data)
def comment (self, data):
self.digest.update (data)
def skippedEntity (self, name):
self.digest.update (name)
# DTD Handler
def notationDecl(self, name, publicId, systemId):
self.digest.update (name)
self.digest.update (publicId)
self.digest.update (systemId)
def unparsedEntityDecl(name, publicId, systemId, ndata):
self.digest.update (name)
self.digest.update (publicId)
self.digest.update (systemId)
self.digest.update (ndata)
def error (self, excpt):
print("Error: %s" % str (excpt))
def warning (self, excpt):
print("Warning: %s" % str (excpt))
def startDTD(self, name, publicId, systemId):
self.digest.update (name)
self.digest.update (publicId)
self.digest.update (systemId)
CHECKSUMPARSER = xml.sax.make_parser()
CHECKSUMHANDLER = XMLChecksumHandler(CHECKSUMPARSER)
CHECKSUMPARSER.setContentHandler (CHECKSUMHANDLER)
CHECKSUMPARSER.setDTDHandler (CHECKSUMHANDLER)
CHECKSUMPARSER.setErrorHandler (CHECKSUMHANDLER)
try:
CHECKSUMPARSER.setFeature (xml.sax.handler.feature_external_ges, 0)
except:
pass
if use_lexical_handler:
CHECKSUMPARSER.setProperty(xml.sax.handler.property_lexical_handler, CHECKSUMHANDLER)
def getXMLChecksum (doc):
CHECKSUMPARSER.parse (io.StringIO (doc))
return CHECKSUMHANDLER.getDigest()
class TALHandlerTestCases (unittest.TestCase):
def setUp (self):
self.context = simpleTALES.Context()
self.context.addGlobal ('test', 'testing')
self.context.addGlobal ('one', [1])
self.context.addGlobal ('two', ["one", "two"])
self.context.addGlobal ('three', [1,"Two",3])
def _runTest_ (self, txt, result, errMsg="Error"):
template = simpleTAL.compileXMLTemplate (txt)
fh = io.StringIO ()
template.expand (self.context, fh, outputEncoding="iso-8859-1")
realResult = fh.getvalue()
expectedChecksum = getXMLChecksum (result)
try:
realChecksum = getXMLChecksum (realResult)
except Exception as e:
self.fail ("Exception (%s) thrown parsing XML actual result: %s\nPage Template: %s" % (str (e), realResult, str (template)))
self.assertTrue (expectedChecksum == realChecksum, "%s - \npassed in: %s \ngot back %s \nexpected %s\n\nTemplate: %s" % (errMsg, txt, realResult, result, template))
def testSingleEmptyElement (self):
self._runTest_ ("<single/>", '<?xml version="1.0" encoding="iso-8859-1"?>\n<single/>')
def testSingleElement (self):
self._runTest_ ("<single>start</single>", '<?xml version="1.0" encoding="iso-8859-1"?>\n<single>start</single>')
def testSingleElementSpaces (self):
self._runTest_ ('<html><br/><br /><br /></html>', '<?xml version="1.0" encoding="iso-8859-1"?>\n<html><br/><br/><br/></html>')
def testSingleElementNewLines (self):
self._runTest_ ('<html><br\n/><br /><br \n /></html>', '<?xml version="1.0" encoding="iso-8859-1"?>\n<html><br/><br/><br/></html>')
def testSingleElementEasyAttributes (self):
self._runTest_ ('<html><br class="test"/></html>', '<?xml version="1.0" encoding="iso-8859-1"?>\n<html><br class="test"/></html>')
def testSingleElementHardAttributes (self):
self._runTest_ ("""<html><br this="this" /><br other="that" that="this"/><br test="/>difficult" bad="Hard />"/></html>""", """<?xml version="1.0" encoding="iso-8859-1"?>\n<html><br this="this"/><br other="that" that="this"/><br test="/>difficult" bad="Hard />"/></html>""")
def testSingleElementHarderAttributes (self):
self._runTest_ ("""<html gold:define-macro="m1"><br gold:define-slot="sl1"/></html>"""
,"""<html gold:define-macro="m1"><br gold:define-slot="sl1"/></html>""")
def testCDATASection (self):
self._runTest_ ("<single><![CDATA[Here's some <escaped> CDATA section stuff & things.]]></single>"
,"""<?xml version="1.0" encoding="iso-8859-1"?>\n<single>Here's some <escaped> CDATA section stuff & things.</single>"""
,"CDATA section was not re-encoded correctly.")
def testNameSpaces (self):
self._runTest_ ("""<?xml version="1.0" encoding="iso-8859-1"?>\n<test1:html xmlns:test2="http://test2" xmlns:test1="http://test1"><test2:p>Testing</test2:p></test1:html>"""
,"""<?xml version="1.0" encoding="iso-8859-1"?>\n<test1:html xmlns:test2="http://test2" xmlns:test1="http://test1"><test2:p>Testing</test2:p></test1:html>"""
,"""Namespaces not preserved.""")
def testProcessingInstructions (self):
self._runTest_ ("""<?xml version="1.0" encoding="iso-8859-1"?>\n<p>Some<?test testInstruction="yes" doNothing="yes"?><i>markup</i></p>"""
,"""<?xml version="1.0" encoding="iso-8859-1"?>\n<p>Some<?test testInstruction="yes" doNothing="yes"?><i>markup</i></p>"""
,"""Processing instructions not preserved.""")
def testCommentHandling (self):
if (not use_lexical_handler):
return
self._runTest_ ("""<?xml version="1.0" encoding="iso-8859-1"?>\n<p><!-- This is a <b>test -->Here</p>"""
,"""<?xml version="1.0" encoding="iso-8859-1"?>\n<p><!-- This is a <b>test -->Here</p>"""
,"Comments not preserved.")
def testDocumentTypeDeclaration (self):
txt = """<?xml version="1.0" encoding="iso-8859-1"?>\n<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">\n<html><p>Test</p></html>"""
template = simpleTAL.compileXMLTemplate (txt)
fh = io.StringIO ()
template.expand (self.context, fh, docType="""<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3c.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">""", outputEncoding="iso-8859-1")
realResult = fh.getvalue()
expectedResult = """<?xml version="1.0" encoding="iso-8859-1"?>\n<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3c.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">\n<html><p>Test</p></html>"""
self.assertTrue (realResult == expectedResult, "Doctype failed - \npassed in: %s \ngot back %s \nexpected %s\n\nTemplate: %s" % (txt, realResult, expectedResult, str(template)))
def testXMLDeclarationSuppressionWithDocType (self):
txt = """<?xml version="1.0" encoding="iso-8859-1"?>\n<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">\n<html><p>Test</p></html>"""
template = simpleTAL.compileXMLTemplate (txt)
fh = io.StringIO ()
template.expand (self.context, fh, docType="""<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3c.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">""", suppressXMLDeclaration=1)
realResult = fh.getvalue()
expectedResult = """<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3c.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">\n<html><p>Test</p></html>"""
self.assertTrue (realResult == expectedResult, "Doctype failed - \npassed in: %s \ngot back %s \nexpected %s\n\nTemplate: %s" % (txt, realResult, expectedResult, str(template)))
def testNBSPparsing (self):
txt = """<?xml version="1.0" encoding="iso-8859-1"?>\n<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">\n<html><p>Test Space</p></html>""".encode ("iso-8859-1")
template = simpleTAL.compileXMLTemplate (txt)
fh = io.BytesIO ()
template.expand (self.context, fh)
realResult = fh.getvalue()
if not use_lexical_handler:
expectedResult = """<?xml version="1.0"?>\n<html><p>Test\xa0Space</p></html>""".encode ("utf-8")
else:
expectedResult = """<?xml version="1.0"?>\n<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">\n<html><p>Test\xa0Space</p></html>""".encode ("utf-8")
self.assertTrue (realResult == expectedResult, "NBSP expansion failed - \npassed in: %s \ngot back %s \nexpected %s\n\nTemplate: %s" % (txt, realResult, expectedResult, template))
def testXMLDeclarationSuppressionWithNoDocType (self):
txt = """<?xml version="1.0" encoding="iso-8859-1"?>\n<html><p>Test</p></html>"""
template = simpleTAL.compileXMLTemplate (txt)
fh = io.StringIO ()
template.expand (self.context, fh, suppressXMLDeclaration=1)
realResult = fh.getvalue()
expectedResult = """<html><p>Test</p></html>"""
self.assertTrue (realResult == expectedResult, "Doctype failed - \npassed in: %s \ngot back %s \nexpected %s\n\nTemplate: %s" % (txt, realResult, expectedResult, str(template)))
def testDTDPassthru (self):
if not use_lexical_handler:
return
self._runTest_ ("""<?xml version="1.0" encoding="iso-8859-1"?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"><html><head><title>Hi</title></head><body></body></html>""",
"""<?xml version="1.0" encoding="iso-8859-1"?>\n<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\n<html><head><title>Hi</title></head><body></body></html>""")
def testSampleXHTML11Doc (self):
"""
Cut and pasted right out of the xhtml 1.1 spec
"""
if not use_lexical_handler:
return
self._runTest_ ("""\
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" >
<head>
<title>Virtual Library</title>
</head>
<body>
<p>Moved to <a href="http://vlib.org/">vlib.org</a>.</p>
</body>
</html>
""","""\
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" >
<head>
<title>Virtual Library</title>
</head>
<body>
<p>Moved to <a href="http://vlib.org/">vlib.org</a>.</p>
</body>
</html>
""")
if __name__ == '__main__':
unittest.main()
|
