Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 1 | # xml.etree test for cElementTree |
Serhiy Storchaka | d2a75c6 | 2018-12-18 22:29:14 +0200 | [diff] [blame] | 2 | import io |
Berker Peksag | 1e8ee9b | 2016-04-24 07:31:42 +0300 | [diff] [blame] | 3 | import struct |
Benjamin Peterson | ee8712c | 2008-05-20 21:35:26 +0000 | [diff] [blame] | 4 | from test import support |
Florent Xicluna | 6c3da6e | 2012-02-13 12:14:52 +0100 | [diff] [blame] | 5 | from test.support import import_fresh_module |
Eli Bendersky | e26fa1b | 2013-05-19 17:49:54 -0700 | [diff] [blame] | 6 | import types |
Victor Stinner | b3c9e07 | 2011-01-04 02:07:34 +0000 | [diff] [blame] | 7 | import unittest |
Fredrik Lundh | 9235ea4 | 2005-12-15 18:41:22 +0000 | [diff] [blame] | 8 | |
Eli Bendersky | 2368704 | 2013-02-26 05:53:23 -0800 | [diff] [blame] | 9 | cET = import_fresh_module('xml.etree.ElementTree', |
| 10 | fresh=['_elementtree']) |
| 11 | cET_alias = import_fresh_module('xml.etree.cElementTree', |
Serhiy Storchaka | 762ec97 | 2017-03-30 18:12:06 +0300 | [diff] [blame] | 12 | fresh=['_elementtree', 'xml.etree'], |
| 13 | deprecated=True) |
Fredrik Lundh | 8911ca3d | 2005-12-16 22:07:17 +0000 | [diff] [blame] | 14 | |
Fredrik Lundh | 9235ea4 | 2005-12-15 18:41:22 +0000 | [diff] [blame] | 15 | |
Serhiy Storchaka | 18f018c | 2016-12-21 12:32:56 +0200 | [diff] [blame] | 16 | @unittest.skipUnless(cET, 'requires _elementtree') |
Victor Stinner | b3c9e07 | 2011-01-04 02:07:34 +0000 | [diff] [blame] | 17 | class MiscTests(unittest.TestCase): |
| 18 | # Issue #8651. |
Serhiy Storchaka | 4847e4e | 2014-01-10 13:37:54 +0200 | [diff] [blame] | 19 | @support.bigmemtest(size=support._2G + 100, memuse=1, dry_run=False) |
Victor Stinner | b3c9e07 | 2011-01-04 02:07:34 +0000 | [diff] [blame] | 20 | def test_length_overflow(self, size): |
Victor Stinner | b3c9e07 | 2011-01-04 02:07:34 +0000 | [diff] [blame] | 21 | data = b'x' * size |
| 22 | parser = cET.XMLParser() |
| 23 | try: |
| 24 | self.assertRaises(OverflowError, parser.feed, data) |
| 25 | finally: |
| 26 | data = None |
| 27 | |
Serhiy Storchaka | b6aa537 | 2015-11-23 08:42:25 +0200 | [diff] [blame] | 28 | def test_del_attribute(self): |
| 29 | element = cET.Element('tag') |
| 30 | |
| 31 | element.tag = 'TAG' |
| 32 | with self.assertRaises(AttributeError): |
| 33 | del element.tag |
| 34 | self.assertEqual(element.tag, 'TAG') |
| 35 | |
| 36 | with self.assertRaises(AttributeError): |
| 37 | del element.text |
| 38 | self.assertIsNone(element.text) |
| 39 | element.text = 'TEXT' |
| 40 | with self.assertRaises(AttributeError): |
| 41 | del element.text |
| 42 | self.assertEqual(element.text, 'TEXT') |
| 43 | |
| 44 | with self.assertRaises(AttributeError): |
| 45 | del element.tail |
| 46 | self.assertIsNone(element.tail) |
| 47 | element.tail = 'TAIL' |
| 48 | with self.assertRaises(AttributeError): |
| 49 | del element.tail |
| 50 | self.assertEqual(element.tail, 'TAIL') |
| 51 | |
| 52 | with self.assertRaises(AttributeError): |
| 53 | del element.attrib |
| 54 | self.assertEqual(element.attrib, {}) |
| 55 | element.attrib = {'A': 'B', 'C': 'D'} |
| 56 | with self.assertRaises(AttributeError): |
| 57 | del element.attrib |
| 58 | self.assertEqual(element.attrib, {'A': 'B', 'C': 'D'}) |
| 59 | |
Serhiy Storchaka | 18f018c | 2016-12-21 12:32:56 +0200 | [diff] [blame] | 60 | def test_trashcan(self): |
| 61 | # If this test fails, it will most likely die via segfault. |
| 62 | e = root = cET.Element('root') |
| 63 | for i in range(200000): |
| 64 | e = cET.SubElement(e, 'x') |
| 65 | del e |
| 66 | del root |
| 67 | support.gc_collect() |
| 68 | |
Victor Stinner | e727d41 | 2017-09-18 05:29:37 -0700 | [diff] [blame] | 69 | def test_parser_ref_cycle(self): |
| 70 | # bpo-31499: xmlparser_dealloc() crashed with a segmentation fault when |
| 71 | # xmlparser_gc_clear() was called previously by the garbage collector, |
| 72 | # when the parser was part of a reference cycle. |
| 73 | |
| 74 | def parser_ref_cycle(): |
| 75 | parser = cET.XMLParser() |
| 76 | # Create a reference cycle using an exception to keep the frame |
| 77 | # alive, so the parser will be destroyed by the garbage collector |
| 78 | try: |
| 79 | raise ValueError |
| 80 | except ValueError as exc: |
| 81 | err = exc |
| 82 | |
| 83 | # Create a parser part of reference cycle |
| 84 | parser_ref_cycle() |
| 85 | # Trigger an explicit garbage collection to break the reference cycle |
| 86 | # and so destroy the parser |
| 87 | support.gc_collect() |
| 88 | |
Oren Milman | 39ecb9c | 2017-10-10 23:26:24 +0300 | [diff] [blame] | 89 | def test_bpo_31728(self): |
| 90 | # A crash or an assertion failure shouldn't happen, in case garbage |
| 91 | # collection triggers a call to clear() or a reading of text or tail, |
| 92 | # while a setter or clear() or __setstate__() is already running. |
| 93 | elem = cET.Element('elem') |
| 94 | class X: |
| 95 | def __del__(self): |
| 96 | elem.text |
| 97 | elem.tail |
| 98 | elem.clear() |
| 99 | |
| 100 | elem.text = X() |
| 101 | elem.clear() # shouldn't crash |
| 102 | |
| 103 | elem.tail = X() |
| 104 | elem.clear() # shouldn't crash |
| 105 | |
| 106 | elem.text = X() |
| 107 | elem.text = X() # shouldn't crash |
| 108 | elem.clear() |
| 109 | |
| 110 | elem.tail = X() |
| 111 | elem.tail = X() # shouldn't crash |
| 112 | elem.clear() |
| 113 | |
| 114 | elem.text = X() |
| 115 | elem.__setstate__({'tag': 42}) # shouldn't cause an assertion failure |
| 116 | elem.clear() |
| 117 | |
| 118 | elem.tail = X() |
| 119 | elem.__setstate__({'tag': 42}) # shouldn't cause an assertion failure |
| 120 | |
Serhiy Storchaka | 6f906b3 | 2018-10-18 09:49:54 +0300 | [diff] [blame] | 121 | def test_setstate_leaks(self): |
| 122 | # Test reference leaks |
| 123 | elem = cET.Element.__new__(cET.Element) |
| 124 | for i in range(100): |
| 125 | elem.__setstate__({'tag': 'foo', 'attrib': {'bar': 42}, |
| 126 | '_children': [cET.Element('child')], |
| 127 | 'text': 'text goes here', |
| 128 | 'tail': 'opposite of head'}) |
| 129 | |
| 130 | self.assertEqual(elem.tag, 'foo') |
| 131 | self.assertEqual(elem.text, 'text goes here') |
| 132 | self.assertEqual(elem.tail, 'opposite of head') |
| 133 | self.assertEqual(list(elem.attrib.items()), [('bar', 42)]) |
| 134 | self.assertEqual(len(elem), 1) |
| 135 | self.assertEqual(elem[0].tag, 'child') |
| 136 | |
Serhiy Storchaka | d2a75c6 | 2018-12-18 22:29:14 +0200 | [diff] [blame] | 137 | def test_iterparse_leaks(self): |
| 138 | # Test reference leaks in TreeBuilder (issue #35502). |
| 139 | # The test is written to be executed in the hunting reference leaks |
| 140 | # mode. |
| 141 | XML = '<a></a></b>' |
| 142 | parser = cET.iterparse(io.StringIO(XML)) |
| 143 | next(parser) |
| 144 | del parser |
| 145 | support.gc_collect() |
| 146 | |
| 147 | def test_xmlpullparser_leaks(self): |
| 148 | # Test reference leaks in TreeBuilder (issue #35502). |
| 149 | # The test is written to be executed in the hunting reference leaks |
| 150 | # mode. |
| 151 | XML = '<a></a></b>' |
| 152 | parser = cET.XMLPullParser() |
| 153 | parser.feed(XML) |
| 154 | del parser |
| 155 | support.gc_collect() |
| 156 | |
Eli Bendersky | 64d11e6 | 2012-06-15 07:42:50 +0300 | [diff] [blame] | 157 | |
Eli Bendersky | 292f9a8 | 2012-02-16 19:55:29 +0200 | [diff] [blame] | 158 | @unittest.skipUnless(cET, 'requires _elementtree') |
Eli Bendersky | 092af1f | 2012-03-04 07:14:03 +0200 | [diff] [blame] | 159 | class TestAliasWorking(unittest.TestCase): |
| 160 | # Test that the cET alias module is alive |
| 161 | def test_alias_working(self): |
| 162 | e = cET_alias.Element('foo') |
| 163 | self.assertEqual(e.tag, 'foo') |
Eli Bendersky | 092af1f | 2012-03-04 07:14:03 +0200 | [diff] [blame] | 164 | |
Eli Bendersky | 64d11e6 | 2012-06-15 07:42:50 +0300 | [diff] [blame] | 165 | |
Eli Bendersky | 092af1f | 2012-03-04 07:14:03 +0200 | [diff] [blame] | 166 | @unittest.skipUnless(cET, 'requires _elementtree') |
Eli Bendersky | e26fa1b | 2013-05-19 17:49:54 -0700 | [diff] [blame] | 167 | @support.cpython_only |
Eli Bendersky | da57819 | 2012-02-16 06:52:39 +0200 | [diff] [blame] | 168 | class TestAcceleratorImported(unittest.TestCase): |
| 169 | # Test that the C accelerator was imported, as expected |
| 170 | def test_correct_import_cET(self): |
Eli Bendersky | e26fa1b | 2013-05-19 17:49:54 -0700 | [diff] [blame] | 171 | # SubElement is a function so it retains _elementtree as its module. |
Eli Bendersky | 092af1f | 2012-03-04 07:14:03 +0200 | [diff] [blame] | 172 | self.assertEqual(cET.SubElement.__module__, '_elementtree') |
Eli Bendersky | da57819 | 2012-02-16 06:52:39 +0200 | [diff] [blame] | 173 | |
Florent Xicluna | e59a306 | 2012-02-16 23:17:31 +0100 | [diff] [blame] | 174 | def test_correct_import_cET_alias(self): |
Eli Bendersky | 092af1f | 2012-03-04 07:14:03 +0200 | [diff] [blame] | 175 | self.assertEqual(cET_alias.SubElement.__module__, '_elementtree') |
Florent Xicluna | e59a306 | 2012-02-16 23:17:31 +0100 | [diff] [blame] | 176 | |
Eli Bendersky | e26fa1b | 2013-05-19 17:49:54 -0700 | [diff] [blame] | 177 | def test_parser_comes_from_C(self): |
| 178 | # The type of methods defined in Python code is types.FunctionType, |
| 179 | # while the type of methods defined inside _elementtree is |
| 180 | # <class 'wrapper_descriptor'> |
| 181 | self.assertNotIsInstance(cET.Element.__init__, types.FunctionType) |
| 182 | |
Victor Stinner | b3c9e07 | 2011-01-04 02:07:34 +0000 | [diff] [blame] | 183 | |
Martin v. Löwis | bce1666 | 2012-06-17 10:41:22 +0200 | [diff] [blame] | 184 | @unittest.skipUnless(cET, 'requires _elementtree') |
Martin v. Löwis | 2b16844 | 2012-07-29 16:38:45 +0200 | [diff] [blame] | 185 | @support.cpython_only |
Martin v. Löwis | bce1666 | 2012-06-17 10:41:22 +0200 | [diff] [blame] | 186 | class SizeofTest(unittest.TestCase): |
| 187 | def setUp(self): |
Martin v. Löwis | 2b16844 | 2012-07-29 16:38:45 +0200 | [diff] [blame] | 188 | self.elementsize = support.calcobjsize('5P') |
Martin v. Löwis | bce1666 | 2012-06-17 10:41:22 +0200 | [diff] [blame] | 189 | # extra |
Serhiy Storchaka | 43036a6 | 2015-02-16 23:58:46 +0200 | [diff] [blame] | 190 | self.extra = struct.calcsize('PnnP4P') |
Martin v. Löwis | bce1666 | 2012-06-17 10:41:22 +0200 | [diff] [blame] | 191 | |
Martin v. Löwis | 2b16844 | 2012-07-29 16:38:45 +0200 | [diff] [blame] | 192 | check_sizeof = support.check_sizeof |
| 193 | |
Martin v. Löwis | bce1666 | 2012-06-17 10:41:22 +0200 | [diff] [blame] | 194 | def test_element(self): |
| 195 | e = cET.Element('a') |
Martin v. Löwis | 2b16844 | 2012-07-29 16:38:45 +0200 | [diff] [blame] | 196 | self.check_sizeof(e, self.elementsize) |
Martin v. Löwis | bce1666 | 2012-06-17 10:41:22 +0200 | [diff] [blame] | 197 | |
| 198 | def test_element_with_attrib(self): |
| 199 | e = cET.Element('a', href='about:') |
Martin v. Löwis | 2b16844 | 2012-07-29 16:38:45 +0200 | [diff] [blame] | 200 | self.check_sizeof(e, self.elementsize + self.extra) |
Martin v. Löwis | bce1666 | 2012-06-17 10:41:22 +0200 | [diff] [blame] | 201 | |
| 202 | def test_element_with_children(self): |
| 203 | e = cET.Element('a') |
| 204 | for i in range(5): |
| 205 | cET.SubElement(e, 'span') |
| 206 | # should have space for 8 children now |
Martin v. Löwis | 2b16844 | 2012-07-29 16:38:45 +0200 | [diff] [blame] | 207 | self.check_sizeof(e, self.elementsize + self.extra + |
| 208 | struct.calcsize('8P')) |
Martin v. Löwis | bce1666 | 2012-06-17 10:41:22 +0200 | [diff] [blame] | 209 | |
Fredrik Lundh | 9235ea4 | 2005-12-15 18:41:22 +0000 | [diff] [blame] | 210 | def test_main(): |
Serhiy Storchaka | e437a10 | 2016-04-24 21:41:02 +0300 | [diff] [blame] | 211 | from test import test_xml_etree |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 212 | |
| 213 | # Run the tests specific to the C implementation |
Eli Bendersky | 092af1f | 2012-03-04 07:14:03 +0200 | [diff] [blame] | 214 | support.run_unittest( |
| 215 | MiscTests, |
| 216 | TestAliasWorking, |
Martin v. Löwis | bce1666 | 2012-06-17 10:41:22 +0200 | [diff] [blame] | 217 | TestAcceleratorImported, |
| 218 | SizeofTest, |
Eli Bendersky | 092af1f | 2012-03-04 07:14:03 +0200 | [diff] [blame] | 219 | ) |
Victor Stinner | b3c9e07 | 2011-01-04 02:07:34 +0000 | [diff] [blame] | 220 | |
Florent Xicluna | a72a98f | 2012-02-13 11:03:30 +0100 | [diff] [blame] | 221 | # Run the same test suite as the Python module |
| 222 | test_xml_etree.test_main(module=cET) |
Eli Bendersky | 092af1f | 2012-03-04 07:14:03 +0200 | [diff] [blame] | 223 | |
Florent Xicluna | f15351d | 2010-03-13 23:24:31 +0000 | [diff] [blame] | 224 | |
Fredrik Lundh | 9235ea4 | 2005-12-15 18:41:22 +0000 | [diff] [blame] | 225 | if __name__ == '__main__': |
| 226 | test_main() |