~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_xml.py

  • Committer: Martin Pool
  • Date: 2010-01-29 10:36:23 UTC
  • mto: This revision was merged to the branch mainline in revision 4992.
  • Revision ID: mbp@sourcefrog.net-20100129103623-hywka5hymo5z13jw
Change url to canonical.com or wiki, plus some doc improvements in passing

Show diffs side-by-side

added added

removed removed

Lines of Context:
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,
 
25
    xml8,
 
26
    serializer,
23
27
    )
24
28
from bzrlib.tests import TestCase
25
29
from bzrlib.inventory import Inventory, InventoryEntry
78
82
"""
79
83
 
80
84
_committed_inv_v5 = """<inventory>
81
 
<file file_id="bar-20050901064931-73b4b1138abc9cd2" 
82
 
      name="bar" parent_id="TREE_ROOT" 
83
 
      revision="mbp@foo-123123"/>
 
85
<file file_id="bar-20050901064931-73b4b1138abc9cd2"
 
86
      name="bar" parent_id="TREE_ROOT"
 
87
      revision="mbp@foo-123123"
 
88
      text_sha1="A" text_size="1"/>
84
89
<directory name="subdir"
85
90
           file_id="foo-20050801201819-4139aa4a272f4250"
86
 
           parent_id="TREE_ROOT" 
 
91
           parent_id="TREE_ROOT"
87
92
           revision="mbp@foo-00"/>
88
 
<file executable="yes" file_id="bar-20050824000535-6bc48cfad47ed134" 
89
 
      name="bar" parent_id="foo-20050801201819-4139aa4a272f4250" 
90
 
      revision="mbp@foo-00"/>
 
93
<file executable="yes" file_id="bar-20050824000535-6bc48cfad47ed134"
 
94
      name="bar" parent_id="foo-20050801201819-4139aa4a272f4250"
 
95
      revision="mbp@foo-00"
 
96
      text_sha1="B" text_size="0"/>
91
97
</inventory>
92
98
"""
93
99
 
94
100
_basis_inv_v5 = """<inventory revision_id="mbp@sourcefrog.net-20050905063503-43948f59fa127d92">
95
 
<file file_id="bar-20050901064931-73b4b1138abc9cd2" 
96
 
      name="bar" parent_id="TREE_ROOT" 
 
101
<file file_id="bar-20050901064931-73b4b1138abc9cd2"
 
102
      name="bar" parent_id="TREE_ROOT"
97
103
      revision="mbp@foo-123123"/>
98
104
<directory name="subdir"
99
105
           file_id="foo-20050801201819-4139aa4a272f4250"
100
 
           parent_id="TREE_ROOT" 
 
106
           parent_id="TREE_ROOT"
101
107
           revision="mbp@foo-00"/>
102
 
<file file_id="bar-20050824000535-6bc48cfad47ed134" 
103
 
      name="bar" parent_id="foo-20050801201819-4139aa4a272f4250" 
 
108
<file file_id="bar-20050824000535-6bc48cfad47ed134"
 
109
      name="bar" parent_id="foo-20050801201819-4139aa4a272f4250"
104
110
      revision="mbp@foo-00"/>
105
111
</inventory>
106
112
"""
120
126
 
121
127
# DO NOT REFLOW THIS. Its the exact inventory we want.
122
128
_expected_inv_v5 = """<inventory format="5">
123
 
<file file_id="bar-20050901064931-73b4b1138abc9cd2" name="bar" revision="mbp@foo-123123" />
 
129
<file file_id="bar-20050901064931-73b4b1138abc9cd2" name="bar" revision="mbp@foo-123123" text_sha1="A" text_size="1" />
124
130
<directory file_id="foo-20050801201819-4139aa4a272f4250" name="subdir" revision="mbp@foo-00" />
125
 
<file executable="yes" file_id="bar-20050824000535-6bc48cfad47ed134" name="bar" parent_id="foo-20050801201819-4139aa4a272f4250" revision="mbp@foo-00" />
 
131
<file executable="yes" file_id="bar-20050824000535-6bc48cfad47ed134" name="bar" parent_id="foo-20050801201819-4139aa4a272f4250" revision="mbp@foo-00" text_sha1="B" text_size="0" />
126
132
</inventory>
127
133
"""
128
134
 
129
135
 
130
136
_expected_inv_v5_root = """<inventory file_id="f&lt;" format="5" revision_id="mother!">
131
 
<file file_id="bar-20050901064931-73b4b1138abc9cd2" name="bar" parent_id="f&lt;" revision="mbp@foo-123123" />
 
137
<file file_id="bar-20050901064931-73b4b1138abc9cd2" name="bar" parent_id="f&lt;" revision="mbp@foo-123123" text_sha1="A" text_size="1" />
132
138
<directory file_id="foo-20050801201819-4139aa4a272f4250" name="subdir" parent_id="f&lt;" revision="mbp@foo-00" />
133
 
<file executable="yes" file_id="bar-20050824000535-6bc48cfad47ed134" name="bar" parent_id="foo-20050801201819-4139aa4a272f4250" revision="mbp@foo-00" />
 
139
<file executable="yes" file_id="bar-20050824000535-6bc48cfad47ed134" name="bar" parent_id="foo-20050801201819-4139aa4a272f4250" revision="mbp@foo-00" text_sha1="B" text_size="0" />
 
140
<symlink file_id="link-1" name="link" parent_id="foo-20050801201819-4139aa4a272f4250" revision="mbp@foo-00" symlink_target="a" />
 
141
</inventory>
 
142
"""
 
143
 
 
144
_expected_inv_v6 = """<inventory format="6" revision_id="rev_outer">
 
145
<directory file_id="tree-root-321" name="" revision="rev_outer" />
 
146
<directory file_id="dir-id" name="dir" parent_id="tree-root-321" revision="rev_outer" />
 
147
<file file_id="file-id" name="file" parent_id="tree-root-321" revision="rev_outer" text_sha1="A" text_size="1" />
 
148
<symlink file_id="link-id" name="link" parent_id="tree-root-321" revision="rev_outer" symlink_target="a" />
134
149
</inventory>
135
150
"""
136
151
 
137
152
_expected_inv_v7 = """<inventory format="7" revision_id="rev_outer">
138
153
<directory file_id="tree-root-321" name="" revision="rev_outer" />
139
154
<directory file_id="dir-id" name="dir" parent_id="tree-root-321" revision="rev_outer" />
140
 
<file file_id="file-id" name="file" parent_id="tree-root-321" revision="rev_outer" />
141
 
<symlink file_id="link-id" name="link" parent_id="tree-root-321" revision="rev_outer" />
 
155
<file file_id="file-id" name="file" parent_id="tree-root-321" revision="rev_outer" text_sha1="A" text_size="1" />
 
156
<symlink file_id="link-id" name="link" parent_id="tree-root-321" revision="rev_outer" symlink_target="a" />
142
157
<tree-reference file_id="nested-id" name="nested" parent_id="tree-root-321" revision="rev_outer" reference_revision="rev_inner" />
143
158
</inventory>
144
159
"""
145
160
 
 
161
_expected_rev_v8 = """<revision committer="Martin Pool &lt;mbp@sourcefrog.net&gt;" format="8" inventory_sha1="e79c31c1deb64c163cf660fdedd476dd579ffd41" revision_id="mbp@sourcefrog.net-20050905080035-e0439293f8b6b9f9" timestamp="1125907235.212" timezone="36000">
 
162
<message>- start splitting code for xml (de)serialization away from objects
 
163
  preparatory to supporting multiple formats by a single library
 
164
</message>
 
165
<parents>
 
166
<revision_ref revision_id="mbp@sourcefrog.net-20050905063503-43948f59fa127d92" />
 
167
</parents>
 
168
</revision>
 
169
"""
 
170
 
 
171
_expected_inv_v8 = """<inventory format="8" revision_id="rev_outer">
 
172
<directory file_id="tree-root-321" name="" revision="rev_outer" />
 
173
<directory file_id="dir-id" name="dir" parent_id="tree-root-321" revision="rev_outer" />
 
174
<file file_id="file-id" name="file" parent_id="tree-root-321" revision="rev_outer" text_sha1="A" text_size="1" />
 
175
<symlink file_id="link-id" name="link" parent_id="tree-root-321" revision="rev_outer" symlink_target="a" />
 
176
</inventory>
 
177
"""
 
178
 
146
179
_revision_utf8_v5 = """<revision committer="Erik B&#229;gfors &lt;erik@foo.net&gt;"
147
180
    inventory_sha1="e79c31c1deb64c163cf660fdedd476dd579ffd41"
148
181
    revision_id="erik@b&#229;gfors-02"
171
204
</inventory>
172
205
"""
173
206
 
 
207
# Before revision_id was always stored as an attribute
 
208
_inventory_v5a = """<inventory format="5">
 
209
</inventory>
 
210
"""
 
211
 
 
212
# Before revision_id was always stored as an attribute
 
213
_inventory_v5b = """<inventory format="5" revision_id="a-rev-id">
 
214
</inventory>
 
215
"""
 
216
 
174
217
 
175
218
class TestSerializer(TestCase):
176
219
    """Test XML serialization"""
 
220
 
177
221
    def test_canned_inventory(self):
178
222
        """Test unpacked a canned inventory v4 file."""
179
223
        inp = StringIO(_working_inventory_v4)
242
286
        eq(ie.name, 'bar')
243
287
        eq(inv[ie.parent_id].kind, 'directory')
244
288
 
 
289
    def test_unpack_inventory_5a(self):
 
290
        inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(
 
291
                _inventory_v5a, revision_id='test-rev-id')
 
292
        self.assertEqual('test-rev-id', inv.root.revision)
 
293
 
 
294
    def test_unpack_inventory_5a_cache_and_copy(self):
 
295
        # Passing an entry_cache should get populated with the objects
 
296
        # But the returned objects should be copies if return_from_cache is
 
297
        # False
 
298
        entry_cache = fifo_cache.FIFOCache()
 
299
        inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(
 
300
            _inventory_v5a, revision_id='test-rev-id',
 
301
            entry_cache=entry_cache, return_from_cache=False)
 
302
        for entry in inv.iter_just_entries():
 
303
            key = (entry.file_id, entry.revision)
 
304
            if entry.file_id is inv.root.file_id:
 
305
                # The root id is inferred for xml v5
 
306
                self.assertFalse(key in entry_cache)
 
307
            else:
 
308
                self.assertIsNot(entry, entry_cache[key])
 
309
 
 
310
    def test_unpack_inventory_5a_cache_no_copy(self):
 
311
        # Passing an entry_cache should get populated with the objects
 
312
        # The returned objects should be exact if return_from_cache is
 
313
        # True
 
314
        entry_cache = fifo_cache.FIFOCache()
 
315
        inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(
 
316
            _inventory_v5a, revision_id='test-rev-id',
 
317
            entry_cache=entry_cache, return_from_cache=True)
 
318
        for entry in inv.iter_just_entries():
 
319
            key = (entry.file_id, entry.revision)
 
320
            if entry.file_id is inv.root.file_id:
 
321
                # The root id is inferred for xml v5
 
322
                self.assertFalse(key in entry_cache)
 
323
            else:
 
324
                self.assertIs(entry, entry_cache[key])
 
325
 
 
326
    def test_unpack_inventory_5b(self):
 
327
        inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(
 
328
                _inventory_v5b, revision_id='test-rev-id')
 
329
        self.assertEqual('a-rev-id', inv.root.revision)
 
330
 
245
331
    def test_repack_inventory_5(self):
246
332
        inp = StringIO(_committed_inv_v5)
247
333
        inv = bzrlib.xml5.serializer_v5.read_inventory(inp)
250
336
        self.assertEqualDiff(_expected_inv_v5, outp.getvalue())
251
337
        inv2 = bzrlib.xml5.serializer_v5.read_inventory(StringIO(outp.getvalue()))
252
338
        self.assertEqual(inv, inv2)
253
 
    
 
339
 
254
340
    def assertRoundTrips(self, xml_string):
255
341
        inp = StringIO(xml_string)
256
342
        inv = bzrlib.xml5.serializer_v5.read_inventory(inp)
257
343
        outp = StringIO()
258
344
        bzrlib.xml5.serializer_v5.write_inventory(inv, outp)
259
345
        self.assertEqualDiff(xml_string, outp.getvalue())
 
346
        lines = bzrlib.xml5.serializer_v5.write_inventory_to_lines(inv)
 
347
        outp.seek(0)
 
348
        self.assertEqual(outp.readlines(), lines)
260
349
        inv2 = bzrlib.xml5.serializer_v5.read_inventory(StringIO(outp.getvalue()))
261
350
        self.assertEqual(inv, inv2)
262
351
 
302
391
        new_rev = s_v5.read_revision_from_string(txt)
303
392
        self.assertEqual(props, new_rev.properties)
304
393
 
305
 
    def test_roundtrip_inventory_v7(self):
 
394
    def get_sample_inventory(self):
306
395
        inv = Inventory('tree-root-321', revision_id='rev_outer')
307
 
        inv.add(inventory.TreeReference('nested-id', 'nested', 'tree-root-321',
308
 
                                        'rev_outer', 'rev_inner'))
309
396
        inv.add(inventory.InventoryFile('file-id', 'file', 'tree-root-321'))
310
 
        inv.add(inventory.InventoryDirectory('dir-id', 'dir', 
 
397
        inv.add(inventory.InventoryDirectory('dir-id', 'dir',
311
398
                                             'tree-root-321'))
312
399
        inv.add(inventory.InventoryLink('link-id', 'link', 'tree-root-321'))
313
400
        inv['tree-root-321'].revision = 'rev_outer'
314
401
        inv['dir-id'].revision = 'rev_outer'
315
402
        inv['file-id'].revision = 'rev_outer'
 
403
        inv['file-id'].text_sha1 = 'A'
 
404
        inv['file-id'].text_size = 1
316
405
        inv['link-id'].revision = 'rev_outer'
 
406
        inv['link-id'].symlink_target = 'a'
 
407
        return inv
 
408
 
 
409
    def test_roundtrip_inventory_v7(self):
 
410
        inv = self.get_sample_inventory()
 
411
        inv.add(inventory.TreeReference('nested-id', 'nested', 'tree-root-321',
 
412
                                        'rev_outer', 'rev_inner'))
317
413
        txt = xml7.serializer_v7.write_inventory_to_string(inv)
 
414
        lines = xml7.serializer_v7.write_inventory_to_lines(inv)
 
415
        self.assertEqual(bzrlib.osutils.split_lines(txt), lines)
318
416
        self.assertEqualDiff(_expected_inv_v7, txt)
319
417
        inv2 = xml7.serializer_v7.read_inventory_from_string(txt)
320
418
        self.assertEqual(5, len(inv2))
321
419
        for path, ie in inv.iter_entries():
322
420
            self.assertEqual(ie, inv2[ie.file_id])
323
421
 
 
422
    def test_roundtrip_inventory_v6(self):
 
423
        inv = self.get_sample_inventory()
 
424
        txt = xml6.serializer_v6.write_inventory_to_string(inv)
 
425
        lines = xml6.serializer_v6.write_inventory_to_lines(inv)
 
426
        self.assertEqual(bzrlib.osutils.split_lines(txt), lines)
 
427
        self.assertEqualDiff(_expected_inv_v6, txt)
 
428
        inv2 = xml6.serializer_v6.read_inventory_from_string(txt)
 
429
        self.assertEqual(4, len(inv2))
 
430
        for path, ie in inv.iter_entries():
 
431
            self.assertEqual(ie, inv2[ie.file_id])
 
432
 
324
433
    def test_wrong_format_v7(self):
325
434
        """Can't accidentally open a file with wrong serializer"""
326
435
        s_v6 = bzrlib.xml6.serializer_v6
327
436
        s_v7 = xml7.serializer_v7
328
 
        self.assertRaises(errors.UnexpectedInventoryFormat, 
 
437
        self.assertRaises(errors.UnexpectedInventoryFormat,
329
438
                          s_v7.read_inventory_from_string, _expected_inv_v5)
330
 
        self.assertRaises(errors.UnexpectedInventoryFormat, 
 
439
        self.assertRaises(errors.UnexpectedInventoryFormat,
331
440
                          s_v6.read_inventory_from_string, _expected_inv_v7)
332
441
 
333
442
    def test_tree_reference(self):
334
443
        s_v5 = bzrlib.xml5.serializer_v5
335
444
        s_v6 = bzrlib.xml6.serializer_v6
336
445
        s_v7 = xml7.serializer_v7
337
 
        inv = Inventory('tree-root-321')
 
446
        inv = Inventory('tree-root-321', revision_id='rev-outer')
 
447
        inv.root.revision = 'root-rev'
338
448
        inv.add(inventory.TreeReference('nested-id', 'nested', 'tree-root-321',
339
449
                                        'rev-outer', 'rev-inner'))
340
 
        self.assertRaises(errors.UnsupportedInventoryKind, 
 
450
        self.assertRaises(errors.UnsupportedInventoryKind,
341
451
                          s_v5.write_inventory_to_string, inv)
342
 
        self.assertRaises(errors.UnsupportedInventoryKind, 
 
452
        self.assertRaises(errors.UnsupportedInventoryKind,
343
453
                          s_v6.write_inventory_to_string, inv)
344
454
        txt = s_v7.write_inventory_to_string(inv)
 
455
        lines = s_v7.write_inventory_to_lines(inv)
 
456
        self.assertEqual(bzrlib.osutils.split_lines(txt), lines)
345
457
        inv2 = s_v7.read_inventory_from_string(txt)
346
458
        self.assertEqual('tree-root-321', inv2['nested-id'].parent_id)
347
459
        self.assertEqual('rev-outer', inv2['nested-id'].revision)
348
460
        self.assertEqual('rev-inner', inv2['nested-id'].reference_revision)
349
 
        self.assertRaises(errors.UnsupportedInventoryKind, 
 
461
        self.assertRaises(errors.UnsupportedInventoryKind,
350
462
                          s_v6.read_inventory_from_string,
351
463
                          txt.replace('format="7"', 'format="6"'))
352
 
        self.assertRaises(errors.UnsupportedInventoryKind, 
 
464
        self.assertRaises(errors.UnsupportedInventoryKind,
353
465
                          s_v5.read_inventory_from_string,
354
466
                          txt.replace('format="7"', 'format="5"'))
355
467
 
 
468
    def test_roundtrip_inventory_v8(self):
 
469
        inv = self.get_sample_inventory()
 
470
        txt = xml8.serializer_v8.write_inventory_to_string(inv)
 
471
        inv2 = xml8.serializer_v8.read_inventory_from_string(txt)
 
472
        self.assertEqual(4, len(inv2))
 
473
        for path, ie in inv.iter_entries():
 
474
            self.assertEqual(ie, inv2[ie.file_id])
 
475
 
 
476
    def test_inventory_text_v8(self):
 
477
        inv = self.get_sample_inventory()
 
478
        txt = xml8.serializer_v8.write_inventory_to_string(inv)
 
479
        lines = xml8.serializer_v8.write_inventory_to_lines(inv)
 
480
        self.assertEqual(bzrlib.osutils.split_lines(txt), lines)
 
481
        self.assertEqualDiff(_expected_inv_v8, txt)
 
482
 
 
483
    def test_revision_text_v6(self):
 
484
        """Pack revision to XML v6"""
 
485
        rev = bzrlib.xml6.serializer_v6.read_revision_from_string(
 
486
            _expected_rev_v5)
 
487
        serialized = bzrlib.xml6.serializer_v6.write_revision_to_string(rev)
 
488
        self.assertEqualDiff(serialized, _expected_rev_v5)
 
489
 
 
490
    def test_revision_text_v7(self):
 
491
        """Pack revision to XML v7"""
 
492
        rev = bzrlib.xml7.serializer_v7.read_revision_from_string(
 
493
            _expected_rev_v5)
 
494
        serialized = bzrlib.xml7.serializer_v7.write_revision_to_string(rev)
 
495
        self.assertEqualDiff(serialized, _expected_rev_v5)
 
496
 
 
497
    def test_revision_text_v8(self):
 
498
        """Pack revision to XML v8"""
 
499
        rev = bzrlib.xml8.serializer_v8.read_revision_from_string(
 
500
            _expected_rev_v8)
 
501
        serialized = bzrlib.xml8.serializer_v8.write_revision_to_string(rev)
 
502
        self.assertEqualDiff(serialized, _expected_rev_v8)
 
503
 
356
504
    def test_revision_ids_are_utf8(self):
357
505
        """Parsed revision_ids should all be utf-8 strings, not unicode."""
358
506
        s_v5 = bzrlib.xml5.serializer_v5
373
521
        fid_bar1 = u'b\xe5r-01'.encode('utf8')
374
522
        fid_sub = u's\xb5bdir-01'.encode('utf8')
375
523
        fid_bar2 = u'b\xe5r-02'.encode('utf8')
376
 
        expected = [(u'', fid_root, None, None),
 
524
        expected = [(u'', fid_root, None, rev_id_2),
377
525
                    (u'b\xe5r', fid_bar1, fid_root, rev_id_1),
378
526
                    (u's\xb5bdir', fid_sub, fid_root, rev_id_1),
379
527
                    (u's\xb5bdir/b\xe5r', fid_bar2, fid_sub, rev_id_2),
402
550
    """Whitebox testing of the _encode_and_escape function."""
403
551
 
404
552
    def setUp(self):
 
553
        TestCase.setUp(self)
405
554
        # Keep the cache clear before and after the test
406
 
        bzrlib.xml5._ensure_utf8_re()
407
 
        bzrlib.xml5._clear_cache()
408
 
        self.addCleanup(bzrlib.xml5._clear_cache)
 
555
        bzrlib.xml8._ensure_utf8_re()
 
556
        bzrlib.xml8._clear_cache()
 
557
        self.addCleanup(bzrlib.xml8._clear_cache)
409
558
 
410
559
    def test_simple_ascii(self):
411
560
        # _encode_and_escape always appends a final ", because these parameters
412
561
        # are being used in xml attributes, and by returning it now, we have to
413
562
        # do fewer string operations later.
414
 
        val = bzrlib.xml5._encode_and_escape('foo bar')
 
563
        val = bzrlib.xml8._encode_and_escape('foo bar')
415
564
        self.assertEqual('foo bar"', val)
416
565
        # The second time should be cached
417
 
        val2 = bzrlib.xml5._encode_and_escape('foo bar')
 
566
        val2 = bzrlib.xml8._encode_and_escape('foo bar')
418
567
        self.assertIs(val2, val)
419
568
 
420
569
    def test_ascii_with_xml(self):
421
570
        self.assertEqual('&amp;&apos;&quot;&lt;&gt;"',
422
 
                         bzrlib.xml5._encode_and_escape('&\'"<>'))
 
571
                         bzrlib.xml8._encode_and_escape('&\'"<>'))
423
572
 
424
573
    def test_utf8_with_xml(self):
425
574
        # u'\xb5\xe5&\u062c'
426
575
        utf8_str = '\xc2\xb5\xc3\xa5&\xd8\xac'
427
576
        self.assertEqual('&#181;&#229;&amp;&#1580;"',
428
 
                         bzrlib.xml5._encode_and_escape(utf8_str))
 
577
                         bzrlib.xml8._encode_and_escape(utf8_str))
429
578
 
430
579
    def test_unicode(self):
431
580
        uni_str = u'\xb5\xe5&\u062c'
432
581
        self.assertEqual('&#181;&#229;&amp;&#1580;"',
433
 
                         bzrlib.xml5._encode_and_escape(uni_str))
 
582
                         bzrlib.xml8._encode_and_escape(uni_str))