← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_xml.py

(vila) Fix test failures blocking package builds. (Vincent Ladeuil)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_xml.py
1
 
# Copyright (C) 2005 Canonical Ltd
 
1
# Copyright (C) 2005-2011 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
from cStringIO import StringIO
18
18
 
19
19
from bzrlib import (
20
 
    errors, 
21
 
    inventory, 
 
20
    errors,
 
21
    fifo_cache,
 
22
    inventory,
 
23
    xml6,
22
24
    xml7,
23
25
    xml8,
24
 
    xml_serializer,
25
26
    )
26
27
from bzrlib.tests import TestCase
27
 
from bzrlib.inventory import Inventory, InventoryEntry
28
 
from bzrlib.xml4 import serializer_v4
 
28
from bzrlib.inventory import Inventory
29
29
import bzrlib.xml5
30
30
 
31
 
_working_inventory_v4 = """<inventory file_id="TREE_ROOT">
32
 
<entry file_id="bar-20050901064931-73b4b1138abc9cd2" kind="file" name="bar" parent_id="TREE_ROOT" />
33
 
<entry file_id="foo-20050801201819-4139aa4a272f4250" kind="directory" name="foo" parent_id="TREE_ROOT" />
34
 
<entry file_id="bar-20050824000535-6bc48cfad47ed134" kind="file" name="bar" parent_id="foo-20050801201819-4139aa4a272f4250" />
35
 
</inventory>"""
36
 
 
37
 
 
38
 
_revision_v4 = """<revision committer="Martin Pool &lt;mbp@sourcefrog.net&gt;"
39
 
    inventory_id="mbp@sourcefrog.net-20050905080035-e0439293f8b6b9f9"
40
 
    inventory_sha1="e79c31c1deb64c163cf660fdedd476dd579ffd41"
41
 
    revision_id="mbp@sourcefrog.net-20050905080035-e0439293f8b6b9f9"
42
 
    timestamp="1125907235.212"
43
 
    timezone="36000">
44
 
<message>- start splitting code for xml (de)serialization away from objects
45
 
  preparatory to supporting multiple formats by a single library
46
 
</message>
47
 
<parents>
48
 
<revision_ref revision_id="mbp@sourcefrog.net-20050905063503-43948f59fa127d92" revision_sha1="7bdf4cc8c5bdac739f8cf9b10b78cf4b68f915ff" />
49
 
</parents>
50
 
</revision>
51
 
"""
52
 
 
53
31
_revision_v5 = """<revision committer="Martin Pool &lt;mbp@sourcefrog.net&gt;"
54
32
    inventory_sha1="e79c31c1deb64c163cf660fdedd476dd579ffd41"
55
33
    revision_id="mbp@sourcefrog.net-20050905080035-e0439293f8b6b9f9"
80
58
"""
81
59
 
82
60
_committed_inv_v5 = """<inventory>
83
 
<file file_id="bar-20050901064931-73b4b1138abc9cd2" 
84
 
      name="bar" parent_id="TREE_ROOT" 
 
61
<file file_id="bar-20050901064931-73b4b1138abc9cd2"
 
62
      name="bar" parent_id="TREE_ROOT"
85
63
      revision="mbp@foo-123123"
86
64
      text_sha1="A" text_size="1"/>
87
65
<directory name="subdir"
88
66
           file_id="foo-20050801201819-4139aa4a272f4250"
89
 
           parent_id="TREE_ROOT" 
 
67
           parent_id="TREE_ROOT"
90
68
           revision="mbp@foo-00"/>
91
 
<file executable="yes" file_id="bar-20050824000535-6bc48cfad47ed134" 
92
 
      name="bar" parent_id="foo-20050801201819-4139aa4a272f4250" 
 
69
<file executable="yes" file_id="bar-20050824000535-6bc48cfad47ed134"
 
70
      name="bar" parent_id="foo-20050801201819-4139aa4a272f4250"
93
71
      revision="mbp@foo-00"
94
72
      text_sha1="B" text_size="0"/>
95
73
</inventory>
96
74
"""
97
75
 
98
76
_basis_inv_v5 = """<inventory revision_id="mbp@sourcefrog.net-20050905063503-43948f59fa127d92">
99
 
<file file_id="bar-20050901064931-73b4b1138abc9cd2" 
100
 
      name="bar" parent_id="TREE_ROOT" 
 
77
<file file_id="bar-20050901064931-73b4b1138abc9cd2"
 
78
      name="bar" parent_id="TREE_ROOT"
101
79
      revision="mbp@foo-123123"/>
102
80
<directory name="subdir"
103
81
           file_id="foo-20050801201819-4139aa4a272f4250"
104
 
           parent_id="TREE_ROOT" 
 
82
           parent_id="TREE_ROOT"
105
83
           revision="mbp@foo-00"/>
106
 
<file file_id="bar-20050824000535-6bc48cfad47ed134" 
107
 
      name="bar" parent_id="foo-20050801201819-4139aa4a272f4250" 
 
84
<file file_id="bar-20050824000535-6bc48cfad47ed134"
 
85
      name="bar" parent_id="foo-20050801201819-4139aa4a272f4250"
108
86
      revision="mbp@foo-00"/>
109
87
</inventory>
110
88
"""
139
117
</inventory>
140
118
"""
141
119
 
 
120
_expected_inv_v6 = """<inventory format="6" revision_id="rev_outer">
 
121
<directory file_id="tree-root-321" name="" revision="rev_outer" />
 
122
<directory file_id="dir-id" name="dir" parent_id="tree-root-321" revision="rev_outer" />
 
123
<file file_id="file-id" name="file" parent_id="tree-root-321" revision="rev_outer" text_sha1="A" text_size="1" />
 
124
<symlink file_id="link-id" name="link" parent_id="tree-root-321" revision="rev_outer" symlink_target="a" />
 
125
</inventory>
 
126
"""
 
127
 
142
128
_expected_inv_v7 = """<inventory format="7" revision_id="rev_outer">
143
129
<directory file_id="tree-root-321" name="" revision="rev_outer" />
144
130
<directory file_id="dir-id" name="dir" parent_id="tree-root-321" revision="rev_outer" />
208
194
class TestSerializer(TestCase):
209
195
    """Test XML serialization"""
210
196
 
211
 
    def test_canned_inventory(self):
212
 
        """Test unpacked a canned inventory v4 file."""
213
 
        inp = StringIO(_working_inventory_v4)
214
 
        inv = serializer_v4.read_inventory(inp)
215
 
        self.assertEqual(len(inv), 4)
216
 
        self.assert_('bar-20050901064931-73b4b1138abc9cd2' in inv)
217
 
 
218
 
    def test_unpack_revision(self):
219
 
        """Test unpacking a canned revision v4"""
220
 
        inp = StringIO(_revision_v4)
221
 
        rev = serializer_v4.read_revision(inp)
222
 
        eq = self.assertEqual
223
 
        eq(rev.committer,
224
 
           "Martin Pool <mbp@sourcefrog.net>")
225
 
        eq(rev.inventory_id,
226
 
           "mbp@sourcefrog.net-20050905080035-e0439293f8b6b9f9")
227
 
        eq(len(rev.parent_ids), 1)
228
 
        eq(rev.parent_ids[0],
229
 
           "mbp@sourcefrog.net-20050905063503-43948f59fa127d92")
230
 
 
231
197
    def test_unpack_revision_5(self):
232
198
        """Test unpacking a canned revision v5"""
233
199
        inp = StringIO(_revision_v5)
281
247
                _inventory_v5a, revision_id='test-rev-id')
282
248
        self.assertEqual('test-rev-id', inv.root.revision)
283
249
 
 
250
    def test_unpack_inventory_5a_cache_and_copy(self):
 
251
        # Passing an entry_cache should get populated with the objects
 
252
        # But the returned objects should be copies if return_from_cache is
 
253
        # False
 
254
        entry_cache = fifo_cache.FIFOCache()
 
255
        inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(
 
256
            _inventory_v5a, revision_id='test-rev-id',
 
257
            entry_cache=entry_cache, return_from_cache=False)
 
258
        for entry in inv.iter_just_entries():
 
259
            key = (entry.file_id, entry.revision)
 
260
            if entry.file_id is inv.root.file_id:
 
261
                # The root id is inferred for xml v5
 
262
                self.assertFalse(key in entry_cache)
 
263
            else:
 
264
                self.assertIsNot(entry, entry_cache[key])
 
265
 
 
266
    def test_unpack_inventory_5a_cache_no_copy(self):
 
267
        # Passing an entry_cache should get populated with the objects
 
268
        # The returned objects should be exact if return_from_cache is
 
269
        # True
 
270
        entry_cache = fifo_cache.FIFOCache()
 
271
        inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(
 
272
            _inventory_v5a, revision_id='test-rev-id',
 
273
            entry_cache=entry_cache, return_from_cache=True)
 
274
        for entry in inv.iter_just_entries():
 
275
            key = (entry.file_id, entry.revision)
 
276
            if entry.file_id is inv.root.file_id:
 
277
                # The root id is inferred for xml v5
 
278
                self.assertFalse(key in entry_cache)
 
279
            else:
 
280
                self.assertIs(entry, entry_cache[key])
 
281
 
284
282
    def test_unpack_inventory_5b(self):
285
283
        inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(
286
284
                _inventory_v5b, revision_id='test-rev-id')
294
292
        self.assertEqualDiff(_expected_inv_v5, outp.getvalue())
295
293
        inv2 = bzrlib.xml5.serializer_v5.read_inventory(StringIO(outp.getvalue()))
296
294
        self.assertEqual(inv, inv2)
297
 
    
 
295
 
298
296
    def assertRoundTrips(self, xml_string):
299
297
        inp = StringIO(xml_string)
300
298
        inv = bzrlib.xml5.serializer_v5.read_inventory(inp)
352
350
    def get_sample_inventory(self):
353
351
        inv = Inventory('tree-root-321', revision_id='rev_outer')
354
352
        inv.add(inventory.InventoryFile('file-id', 'file', 'tree-root-321'))
355
 
        inv.add(inventory.InventoryDirectory('dir-id', 'dir', 
 
353
        inv.add(inventory.InventoryDirectory('dir-id', 'dir',
356
354
                                             'tree-root-321'))
357
355
        inv.add(inventory.InventoryLink('link-id', 'link', 'tree-root-321'))
358
356
        inv['tree-root-321'].revision = 'rev_outer'
377
375
        for path, ie in inv.iter_entries():
378
376
            self.assertEqual(ie, inv2[ie.file_id])
379
377
 
 
378
    def test_roundtrip_inventory_v6(self):
 
379
        inv = self.get_sample_inventory()
 
380
        txt = xml6.serializer_v6.write_inventory_to_string(inv)
 
381
        lines = xml6.serializer_v6.write_inventory_to_lines(inv)
 
382
        self.assertEqual(bzrlib.osutils.split_lines(txt), lines)
 
383
        self.assertEqualDiff(_expected_inv_v6, txt)
 
384
        inv2 = xml6.serializer_v6.read_inventory_from_string(txt)
 
385
        self.assertEqual(4, len(inv2))
 
386
        for path, ie in inv.iter_entries():
 
387
            self.assertEqual(ie, inv2[ie.file_id])
 
388
 
380
389
    def test_wrong_format_v7(self):
381
390
        """Can't accidentally open a file with wrong serializer"""
382
391
        s_v6 = bzrlib.xml6.serializer_v6
383
392
        s_v7 = xml7.serializer_v7
384
 
        self.assertRaises(errors.UnexpectedInventoryFormat, 
 
393
        self.assertRaises(errors.UnexpectedInventoryFormat,
385
394
                          s_v7.read_inventory_from_string, _expected_inv_v5)
386
 
        self.assertRaises(errors.UnexpectedInventoryFormat, 
 
395
        self.assertRaises(errors.UnexpectedInventoryFormat,
387
396
                          s_v6.read_inventory_from_string, _expected_inv_v7)
388
397
 
389
398
    def test_tree_reference(self):
405
414
        self.assertEqual('tree-root-321', inv2['nested-id'].parent_id)
406
415
        self.assertEqual('rev-outer', inv2['nested-id'].revision)
407
416
        self.assertEqual('rev-inner', inv2['nested-id'].reference_revision)
408
 
        self.assertRaises(errors.UnsupportedInventoryKind, 
409
 
                          s_v6.read_inventory_from_string,
410
 
                          txt.replace('format="7"', 'format="6"'))
411
 
        self.assertRaises(errors.UnsupportedInventoryKind, 
412
 
                          s_v5.read_inventory_from_string,
413
 
                          txt.replace('format="7"', 'format="5"'))
414
417
 
415
418
    def test_roundtrip_inventory_v8(self):
416
419
        inv = self.get_sample_inventory()
492
495
 
493
496
        self.assertEqual(len(expected), len(actual))
494
497
 
495
 
    def test_registry(self):
496
 
        self.assertIs(serializer_v4,
497
 
                      xml_serializer.format_registry.get('4'))
498
 
        self.assertIs(bzrlib.xml5.serializer_v5,
499
 
                      xml_serializer.format_registry.get('5'))
500
 
        self.assertIs(bzrlib.xml6.serializer_v6,
501
 
                      xml_serializer.format_registry.get('6'))
502
 
        self.assertIs(bzrlib.xml7.serializer_v7,
503
 
                      xml_serializer.format_registry.get('7'))
504
 
        self.assertIs(bzrlib.xml8.serializer_v8,
505
 
                      xml_serializer.format_registry.get('8'))
506
 
 
507
498
 
508
499
class TestEncodeAndEscape(TestCase):
509
500
    """Whitebox testing of the _encode_and_escape function."""
510
501
 
511
502
    def setUp(self):
 
503
        super(TestEncodeAndEscape, self).setUp()
512
504
        # Keep the cache clear before and after the test
513
 
        bzrlib.xml8._ensure_utf8_re()
514
 
        bzrlib.xml8._clear_cache()
515
 
        self.addCleanup(bzrlib.xml8._clear_cache)
 
505
        bzrlib.xml_serializer._clear_cache()
 
506
        self.addCleanup(bzrlib.xml_serializer._clear_cache)
516
507
 
517
508
    def test_simple_ascii(self):
518
509
        # _encode_and_escape always appends a final ", because these parameters
519
510
        # are being used in xml attributes, and by returning it now, we have to
520
511
        # do fewer string operations later.
521
 
        val = bzrlib.xml8._encode_and_escape('foo bar')
 
512
        val = bzrlib.xml_serializer.encode_and_escape('foo bar')
522
513
        self.assertEqual('foo bar"', val)
523
514
        # The second time should be cached
524
 
        val2 = bzrlib.xml8._encode_and_escape('foo bar')
 
515
        val2 = bzrlib.xml_serializer.encode_and_escape('foo bar')
525
516
        self.assertIs(val2, val)
526
517
 
527
518
    def test_ascii_with_xml(self):
528
519
        self.assertEqual('&amp;&apos;&quot;&lt;&gt;"',
529
 
                         bzrlib.xml8._encode_and_escape('&\'"<>'))
 
520
                         bzrlib.xml_serializer.encode_and_escape('&\'"<>'))
530
521
 
531
522
    def test_utf8_with_xml(self):
532
523
        # u'\xb5\xe5&\u062c'
533
524
        utf8_str = '\xc2\xb5\xc3\xa5&\xd8\xac'
534
525
        self.assertEqual('&#181;&#229;&amp;&#1580;"',
535
 
                         bzrlib.xml8._encode_and_escape(utf8_str))
 
526
                         bzrlib.xml_serializer.encode_and_escape(utf8_str))
536
527
 
537
528
    def test_unicode(self):
538
529
        uni_str = u'\xb5\xe5&\u062c'
539
530
        self.assertEqual('&#181;&#229;&amp;&#1580;"',
540
 
                         bzrlib.xml8._encode_and_escape(uni_str))
 
531
                         bzrlib.xml_serializer.encode_and_escape(uni_str))
 
532
 
 
533
 
 
534
class TestMisc(TestCase):
 
535
 
 
536
    def test_unescape_xml(self):
 
537
        """We get some kind of error when malformed entities are passed"""
 
538
        self.assertRaises(KeyError, bzrlib.xml8._unescape_xml, 'foo&bar;')