#!/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
import io
import logging, logging.config
import xml.sax, xml.sax.handler
from hashlib import md5
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):
def __init__ (self, parser):
xml.sax.handler.ContentHandler.__init__ (self)
self.ourParser = parser
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 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 getDigest (self):
return self.digest.hexdigest()
CHECKSUMPARSER = xml.sax.make_parser()
CHECKSUMHANDLER = XMLChecksumHandler(CHECKSUMPARSER)
CHECKSUMPARSER.setContentHandler (CHECKSUMHANDLER)
CHECKSUMPARSER.setDTDHandler (CHECKSUMHANDLER)
CHECKSUMPARSER.setErrorHandler (CHECKSUMHANDLER)
def getXMLChecksum (doc):
CHECKSUMPARSER.parse (io.StringIO (doc))
return CHECKSUMHANDLER.getDigest()
class TALSingletonTests (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 _runBasicTest_ (self, text, result, errMsg = "Error"):
""" Runs a basic test - i.e. does full string compare rather than
checksum.
"""
template = simpleTAL.compileXMLTemplate (text)
file = io.StringIO ()
template.expand (self.context, file, outputEncoding="iso-8859-1")
realResult = file.getvalue().encode ('iso-8859-1')
self.assertTrue (result == realResult, "%s - \npassed in: %s \ngot back %s \nexpected %s\n\nTemplate: %s" % (errMsg, text, realResult, result, template))
def _runTest_ (self, txt, result, errMsg="Error"):
template = simpleTAL.compileXMLTemplate (txt)
file = io.StringIO ()
template.expand (self.context, file, outputEncoding="iso-8859-1")
realResult = file.getvalue()
try:
expectedChecksum = getXMLChecksum (result)
except Exception as e:
self.fail ("Exception (%s) thrown parsing XML expected result: %s" % (str (e), 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 _runMacroTest_ (self, macros, page, result, errMsg="Error"):
macroTemplate = simpleTAL.compileXMLTemplate (macros)
pageTemplate = simpleTAL.compileXMLTemplate (page)
self.context.addGlobal ("site", macroTemplate)
self.context.addGlobal ("here", pageTemplate)
file = io.StringIO ()
pageTemplate.expand (self.context, file)
realResult = file.getvalue()
try:
expectedChecksum = getXMLChecksum (result)
except Exception as e:
self.fail ("Exception (%s) thrown parsing XML expected result: %s" % (str (e), result))
try:
realChecksum = getXMLChecksum (realResult)
except Exception as e:
self.fail ("Exception (%s) thrown parsing XML actual result: %s\nPage Template: %s\nMacro Template: %s" % (str (e), realResult, str (pageTemplate), str (macroTemplate)))
self.assertTrue (expectedChecksum == realChecksum, "%s - \npassed in macro: %s \n and page: %s\ngot back %s \nexpected %s\n\nPage Template: %s" % (errMsg, macros,page, realResult, result, pageTemplate))
def testBasicPassThrough (self):
self._runBasicTest_ ("""
Hello
""".encode ("iso-8859-1")
,"""\n
Hello
""".encode ('iso-8859-1')
,"""Local define followed by attributes and global tes""")
def testDefineAttributes (self):
self._runTest_ ("""
"""
,"""
"""
,"""Local define followed by attributes and global test failed.""")
def testConditionDefine (self):
self._runTest_ ("""
![]()
"""
,"""
"""
,"""Global define and condition failed""")
def testRepeatAttributes (self):
self._runTest_ ("""
"""
,"""
"""
,"""Repeat and attributes failed.""")
def testContentRepeat (self):
self._runTest_ ("""
"""
,"""
1
Two
3"""
,"""Content with Repeat failed.""")
def testReplaceRepeat (self):
self._runTest_ ("""
"""
,"""1Two3"""
,"""Replace with Repeat failed.""")
def testReplaceRepeatAttributes (self):
self._runTest_ ("""
"""
,"""1Two3"""
,"""Replace with Repeat failed.""")
def testContentRepeatAttributes (self):
self._runTest_ ("""
"""
,"""
1
Two
3"""
,"""Content with Repeat and Attributes failed.""")
def testOmitTagContentRepeatAttributes (self):
self._runTest_ ("""
"""
,"""1Two3"""
,"""OmitTag with Content and Repeat and Attributes failed.""")
def testDefineMacroSlots (self):
self._runMacroTest_ ("""
"""
,""""""
,"""Hello
"""
,"""METAL with define-slot on singleton failed.""")
def testDefineMacro (self):
self._runMacroTest_ (""" """
,"""