# Copyright (c) Twisted Matrix Laboratories.
# See LICENSE for details.
"""
Tests for L{twisted.words.xish.domish}, a DOM-like library for XMPP.
"""
from twisted.trial import unittest
from twisted.words.xish import domish
class DomishTestCase(unittest.TestCase):
def testEscaping(self):
s = "&<>'\""
self.assertEqual(domish.escapeToXml(s), "&<>'\"")
self.assertEqual(domish.escapeToXml(s, 1), "&<>'"")
def testNamespaceObject(self):
ns = domish.Namespace("testns")
self.assertEqual(ns.foo, ("testns", "foo"))
def testElementInit(self):
e = domish.Element((None, "foo"))
self.assertEqual(e.name, "foo")
self.assertEqual(e.uri, None)
self.assertEqual(e.defaultUri, None)
self.assertEqual(e.parent, None)
e = domish.Element(("", "foo"))
self.assertEqual(e.name, "foo")
self.assertEqual(e.uri, "")
self.assertEqual(e.defaultUri, "")
self.assertEqual(e.parent, None)
e = domish.Element(("testns", "foo"))
self.assertEqual(e.name, "foo")
self.assertEqual(e.uri, "testns")
self.assertEqual(e.defaultUri, "testns")
self.assertEqual(e.parent, None)
e = domish.Element(("testns", "foo"), "test2ns")
self.assertEqual(e.name, "foo")
self.assertEqual(e.uri, "testns")
self.assertEqual(e.defaultUri, "test2ns")
def testChildOps(self):
e = domish.Element(("testns", "foo"))
e.addContent("somecontent")
b2 = e.addElement(("testns2", "bar2"))
e["attrib1"] = "value1"
e[("testns2", "attrib2")] = "value2"
e.addElement("bar")
e.addElement("bar")
e.addContent("abc")
e.addContent("123")
# Check content merging
self.assertEqual(e.children[-1], "abc123")
# Check str()/content extraction
self.assertEqual(str(e), "somecontent")
# Check direct child accessor
self.assertEqual(e.bar2, b2)
e.bar2.addContent("subcontent")
e.bar2["bar2value"] = "somevalue"
# Check child ops
self.assertEqual(e.children[1], e.bar2)
self.assertEqual(e.children[2], e.bar)
# Check attribute ops
self.assertEqual(e["attrib1"], "value1")
del e["attrib1"]
self.assertEqual(e.hasAttribute("attrib1"), 0)
self.assertEqual(e.hasAttribute("attrib2"), 0)
self.assertEqual(e[("testns2", "attrib2")], "value2")
def test_elements(self):
"""
Calling C{elements} without arguments on a L{domish.Element} returns
all child elements, whatever the qualfied name.
"""
e = domish.Element((u"testns", u"foo"))
c1 = e.addElement(u"name")
c2 = e.addElement((u"testns2", u"baz"))
c3 = e.addElement(u"quux")
c4 = e.addElement((u"testns", u"name"))
elts = list(e.elements())
self.assertIn(c1, elts)
self.assertIn(c2, elts)
self.assertIn(c3, elts)
self.assertIn(c4, elts)
def test_elementsWithQN(self):
"""
Calling C{elements} with a namespace and local name on a
L{domish.Element} returns all child elements with that qualified name.
"""
e = domish.Element((u"testns", u"foo"))
c1 = e.addElement(u"name")
c2 = e.addElement((u"testns2", u"baz"))
c3 = e.addElement(u"quux")
c4 = e.addElement((u"testns", u"name"))
elts = list(e.elements(u"testns", u"name"))
self.assertIn(c1, elts)
self.assertNotIn(c2, elts)
self.assertNotIn(c3, elts)
self.assertIn(c4, elts)
class DomishStreamTestsMixin:
"""
Mixin defining tests for different stream implementations.
@ivar streamClass: A no-argument callable which will be used to create an
XML parser which can produce a stream of elements from incremental
input.
"""
def setUp(self):
self.doc_started = False
self.doc_ended = False
self.root = None
self.elements = []
self.stream = self.streamClass()
self.stream.DocumentStartEvent = self._docStarted
self.stream.ElementEvent = self.elements.append
self.stream.DocumentEndEvent = self._docEnded
def _docStarted(self, root):
self.root = root
self.doc_started = True
def _docEnded(self):
self.doc_ended = True
def doTest(self, xml):
self.stream.parse(xml)
def testHarness(self):
xml = ""
self.stream.parse(xml)
self.assertEqual(self.doc_started, True)
self.assertEqual(self.root.name, 'root')
self.assertEqual(self.elements[0].name, 'child')
self.assertEqual(self.elements[1].name, 'child2')
self.assertEqual(self.doc_ended, True)
def testBasic(self):
xml = "\n" + \
" " + \
" some&data>" + \
" " + \
""
self.stream.parse(xml)
self.assertEqual(self.root.name, 'stream')
self.assertEqual(self.root.uri, 'etherx')
self.assertEqual(self.elements[0].name, 'message')
self.assertEqual(self.elements[0].uri, 'jabber')
self.assertEqual(self.elements[0]['to'], 'bar')
self.assertEqual(self.elements[0].x.uri, 'xdelay')
self.assertEqual(unicode(self.elements[0].x), 'some&data>')
def testNoRootNS(self):
xml = ""
self.stream.parse(xml)
self.assertEqual(self.root.uri, '')
self.assertEqual(self.elements[0].uri, 'etherx')
def testNoDefaultNS(self):
xml = """"
self.stream.parse(xml)
self.assertEqual(self.root.uri, 'etherx')
self.assertEqual(self.root.defaultUri, '')
self.assertEqual(self.elements[0].uri, '')
self.assertEqual(self.elements[0].defaultUri, '')
def testChildDefaultNS(self):
xml = ""
self.stream.parse(xml)
self.assertEqual(self.root.uri, 'testns')
self.assertEqual(self.elements[0].uri, 'testns')
def testEmptyChildNS(self):
xml = ""
self.stream.parse(xml)
self.assertEqual(self.elements[0].child2.uri, '')
def test_namespaceWithWhitespace(self):
"""
Whitespace in an xmlns value is preserved in the resulting node's C{uri}
attribute.
"""
xml = ""
self.stream.parse(xml)
self.assertEqual(self.elements[0].uri, " bar baz ")
self.assertEqual(
self.elements[0].attributes, {(" bar baz ", "baz"): "quux"})
def testChildPrefix(self):
xml = ""
self.stream.parse(xml)
self.assertEqual(self.root.localPrefixes['foo'], 'testns2')
self.assertEqual(self.elements[0].uri, 'testns2')
def testUnclosedElement(self):
self.assertRaises(domish.ParserError, self.stream.parse,
"")
def test_namespaceReuse(self):
"""
Test that reuse of namespaces does affect an element's serialization.
When one element uses a prefix for a certain namespace, this is
stored in the C{localPrefixes} attribute of the element. We want
to make sure that elements created after such use, won't have this
prefix end up in their C{localPrefixes} attribute, too.
"""
xml = """
"""
self.stream.parse(xml)
self.assertEqual('child1', self.elements[0].name)
self.assertEqual('testns', self.elements[0].uri)
self.assertEqual('', self.elements[0].defaultUri)
self.assertEqual({'foo': 'testns'}, self.elements[0].localPrefixes)
self.assertEqual('child2', self.elements[1].name)
self.assertEqual('testns', self.elements[1].uri)
self.assertEqual('testns', self.elements[1].defaultUri)
self.assertEqual({}, self.elements[1].localPrefixes)
class DomishExpatStreamTestCase(DomishStreamTestsMixin, unittest.TestCase):
"""
Tests for L{domish.ExpatElementStream}, the expat-based element stream
implementation.
"""
streamClass = domish.ExpatElementStream
try:
import pyexpat
except ImportError:
skip = "pyexpat is required for ExpatElementStream tests."
class DomishSuxStreamTestCase(DomishStreamTestsMixin, unittest.TestCase):
"""
Tests for L{domish.SuxElementStream}, the L{twisted.web.sux}-based element
stream implementation.
"""
streamClass = domish.SuxElementStream
if domish.SuxElementStream is None:
skip = "twisted.web is required for SuxElementStream tests."
class SerializerTests(unittest.TestCase):
def testNoNamespace(self):
e = domish.Element((None, "foo"))
self.assertEqual(e.toXml(), "")
self.assertEqual(e.toXml(closeElement = 0), "")
def testDefaultNamespace(self):
e = domish.Element(("testns", "foo"))
self.assertEqual(e.toXml(), "")
def testOtherNamespace(self):
e = domish.Element(("testns", "foo"), "testns2")
self.assertEqual(e.toXml({'testns': 'bar'}),
"")
def testChildDefaultNamespace(self):
e = domish.Element(("testns", "foo"))
e.addElement("bar")
self.assertEqual(e.toXml(), "")
def testChildSameNamespace(self):
e = domish.Element(("testns", "foo"))
e.addElement(("testns", "bar"))
self.assertEqual(e.toXml(), "")
def testChildSameDefaultNamespace(self):
e = domish.Element(("testns", "foo"))
e.addElement("bar", "testns")
self.assertEqual(e.toXml(), "")
def testChildOtherDefaultNamespace(self):
e = domish.Element(("testns", "foo"))
e.addElement(("testns2", "bar"), 'testns2')
self.assertEqual(e.toXml(), "")
def testOnlyChildDefaultNamespace(self):
e = domish.Element((None, "foo"))
e.addElement(("ns2", "bar"), 'ns2')
self.assertEqual(e.toXml(), "")
def testOnlyChildDefaultNamespace2(self):
e = domish.Element((None, "foo"))
e.addElement("bar")
self.assertEqual(e.toXml(), "")
def testChildInDefaultNamespace(self):
e = domish.Element(("testns", "foo"), "testns2")
e.addElement(("testns2", "bar"))
self.assertEqual(e.toXml(), "")
def testQualifiedAttribute(self):
e = domish.Element((None, "foo"),
attribs = {("testns2", "bar"): "baz"})
self.assertEqual(e.toXml(), "")
def testQualifiedAttributeDefaultNS(self):
e = domish.Element(("testns", "foo"),
attribs = {("testns", "bar"): "baz"})
self.assertEqual(e.toXml(), "")
def testTwoChilds(self):
e = domish.Element(('', "foo"))
child1 = e.addElement(("testns", "bar"), "testns2")
child1.addElement(('testns2', 'quux'))
child2 = e.addElement(("testns3", "baz"), "testns4")
child2.addElement(('testns', 'quux'))
self.assertEqual(e.toXml(), "")
def testXMLNamespace(self):
e = domish.Element((None, "foo"),
attribs = {("http://www.w3.org/XML/1998/namespace",
"lang"): "en_US"})
self.assertEqual(e.toXml(), "")
def testQualifiedAttributeGivenListOfPrefixes(self):
e = domish.Element((None, "foo"),
attribs = {("testns2", "bar"): "baz"})
self.assertEqual(e.toXml({"testns2": "qux"}),
"")
def testNSPrefix(self):
e = domish.Element((None, "foo"),
attribs = {("testns2", "bar"): "baz"})
c = e.addElement(("testns2", "qux"))
c[("testns2", "bar")] = "quux"
self.assertEqual(e.toXml(), "")
def testDefaultNSPrefix(self):
e = domish.Element((None, "foo"),
attribs = {("testns2", "bar"): "baz"})
c = e.addElement(("testns2", "qux"))
c[("testns2", "bar")] = "quux"
c.addElement('foo')
self.assertEqual(e.toXml(), "")
def testPrefixScope(self):
e = domish.Element(('testns', 'foo'))
self.assertEqual(e.toXml(prefixes={'testns': 'bar'},
prefixesInScope=['bar']),
"")
def testLocalPrefixes(self):
e = domish.Element(('testns', 'foo'), localPrefixes={'bar': 'testns'})
self.assertEqual(e.toXml(), "")
def testLocalPrefixesWithChild(self):
e = domish.Element(('testns', 'foo'), localPrefixes={'bar': 'testns'})
e.addElement('baz')
self.assertIdentical(e.baz.defaultUri, None)
self.assertEqual(e.toXml(), "")
def test_prefixesReuse(self):
"""
Test that prefixes passed to serialization are not modified.
This test makes sure that passing a dictionary of prefixes repeatedly
to C{toXml} of elements does not cause serialization errors. A
previous implementation changed the passed in dictionary internally,
causing havoc later on.
"""
prefixes = {'testns': 'foo'}
# test passing of dictionary
s = domish.SerializerClass(prefixes=prefixes)
self.assertNotIdentical(prefixes, s.prefixes)
# test proper serialization on prefixes reuse
e = domish.Element(('testns2', 'foo'),
localPrefixes={'quux': 'testns2'})
self.assertEqual("",
e.toXml(prefixes=prefixes))
e = domish.Element(('testns2', 'foo'))
self.assertEqual("",
e.toXml(prefixes=prefixes))
def testRawXMLSerialization(self):
e = domish.Element((None, "foo"))
e.addRawXml("")
# The testcase below should NOT generate valid XML -- that's
# the whole point of using the raw XML call -- it's the callers
# responsiblity to ensure that the data inserted is valid
self.assertEqual(e.toXml(), "")
def testRawXMLWithUnicodeSerialization(self):
e = domish.Element((None, "foo"))
e.addRawXml(u"\u00B0")
self.assertEqual(e.toXml(), u"\u00B0")
def testUnicodeSerialization(self):
e = domish.Element((None, "foo"))
e["test"] = u"my value\u0221e"
e.addContent(u"A degree symbol...\u00B0")
self.assertEqual(e.toXml(),
u"A degree symbol...\u00B0")