← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_xml.py

  • Committer: Jelmer Vernooij
  • Date: 2009-01-28 18:42:55 UTC
  • mto: This revision was merged to the branch mainline in revision 3968.
  • Revision ID: jelmer@samba.org-20090128184255-bdmklkvm83ltk191
https://launchpad.net/bugs/321183
Update NEWS

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_xml.py
16
16
 
17
17
from cStringIO import StringIO
18
18
 
 
19
from bzrlib import (
 
20
    errors, 
 
21
    inventory, 
 
22
    xml7,
 
23
    xml8,
 
24
    xml_serializer,
 
25
    )
19
26
from bzrlib.tests import TestCase
20
27
from bzrlib.inventory import Inventory, InventoryEntry
21
28
from bzrlib.xml4 import serializer_v4
75
82
_committed_inv_v5 = """<inventory>
76
83
<file file_id="bar-20050901064931-73b4b1138abc9cd2" 
77
84
      name="bar" parent_id="TREE_ROOT" 
78
 
      revision="mbp@foo-123123"/>
 
85
      revision="mbp@foo-123123"
 
86
      text_sha1="A" text_size="1"/>
79
87
<directory name="subdir"
80
88
           file_id="foo-20050801201819-4139aa4a272f4250"
81
89
           parent_id="TREE_ROOT" 
82
90
           revision="mbp@foo-00"/>
83
91
<file executable="yes" file_id="bar-20050824000535-6bc48cfad47ed134" 
84
92
      name="bar" parent_id="foo-20050801201819-4139aa4a272f4250" 
85
 
      revision="mbp@foo-00"/>
 
93
      revision="mbp@foo-00"
 
94
      text_sha1="B" text_size="0"/>
86
95
</inventory>
87
96
"""
88
97
 
115
124
 
116
125
# DO NOT REFLOW THIS. Its the exact inventory we want.
117
126
_expected_inv_v5 = """<inventory format="5">
118
 
<file file_id="bar-20050901064931-73b4b1138abc9cd2" name="bar" revision="mbp@foo-123123" />
 
127
<file file_id="bar-20050901064931-73b4b1138abc9cd2" name="bar" revision="mbp@foo-123123" text_sha1="A" text_size="1" />
119
128
<directory file_id="foo-20050801201819-4139aa4a272f4250" name="subdir" revision="mbp@foo-00" />
120
 
<file executable="yes" file_id="bar-20050824000535-6bc48cfad47ed134" name="bar" parent_id="foo-20050801201819-4139aa4a272f4250" revision="mbp@foo-00" />
 
129
<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" />
121
130
</inventory>
122
131
"""
123
132
 
124
133
 
125
134
_expected_inv_v5_root = """<inventory file_id="f&lt;" format="5" revision_id="mother!">
126
 
<file file_id="bar-20050901064931-73b4b1138abc9cd2" name="bar" parent_id="f&lt;" revision="mbp@foo-123123" />
 
135
<file file_id="bar-20050901064931-73b4b1138abc9cd2" name="bar" parent_id="f&lt;" revision="mbp@foo-123123" text_sha1="A" text_size="1" />
127
136
<directory file_id="foo-20050801201819-4139aa4a272f4250" name="subdir" parent_id="f&lt;" revision="mbp@foo-00" />
128
 
<file executable="yes" file_id="bar-20050824000535-6bc48cfad47ed134" name="bar" parent_id="foo-20050801201819-4139aa4a272f4250" revision="mbp@foo-00" />
129
 
</inventory>
130
 
"""
131
 
 
 
137
<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" />
 
138
<symlink file_id="link-1" name="link" parent_id="foo-20050801201819-4139aa4a272f4250" revision="mbp@foo-00" symlink_target="a" />
 
139
</inventory>
 
140
"""
 
141
 
 
142
_expected_inv_v7 = """<inventory format="7" revision_id="rev_outer">
 
143
<directory file_id="tree-root-321" name="" revision="rev_outer" />
 
144
<directory file_id="dir-id" name="dir" parent_id="tree-root-321" revision="rev_outer" />
 
145
<file file_id="file-id" name="file" parent_id="tree-root-321" revision="rev_outer" text_sha1="A" text_size="1" />
 
146
<symlink file_id="link-id" name="link" parent_id="tree-root-321" revision="rev_outer" symlink_target="a" />
 
147
<tree-reference file_id="nested-id" name="nested" parent_id="tree-root-321" revision="rev_outer" reference_revision="rev_inner" />
 
148
</inventory>
 
149
"""
 
150
 
 
151
_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">
 
152
<message>- start splitting code for xml (de)serialization away from objects
 
153
  preparatory to supporting multiple formats by a single library
 
154
</message>
 
155
<parents>
 
156
<revision_ref revision_id="mbp@sourcefrog.net-20050905063503-43948f59fa127d92" />
 
157
</parents>
 
158
</revision>
 
159
"""
 
160
 
 
161
_expected_inv_v8 = """<inventory format="8" revision_id="rev_outer">
 
162
<directory file_id="tree-root-321" name="" revision="rev_outer" />
 
163
<directory file_id="dir-id" name="dir" parent_id="tree-root-321" revision="rev_outer" />
 
164
<file file_id="file-id" name="file" parent_id="tree-root-321" revision="rev_outer" text_sha1="A" text_size="1" />
 
165
<symlink file_id="link-id" name="link" parent_id="tree-root-321" revision="rev_outer" symlink_target="a" />
 
166
</inventory>
 
167
"""
132
168
 
133
169
_revision_utf8_v5 = """<revision committer="Erik B&#229;gfors &lt;erik@foo.net&gt;"
134
170
    inventory_sha1="e79c31c1deb64c163cf660fdedd476dd579ffd41"
158
194
</inventory>
159
195
"""
160
196
 
 
197
# Before revision_id was always stored as an attribute
 
198
_inventory_v5a = """<inventory format="5">
 
199
</inventory>
 
200
"""
 
201
 
 
202
# Before revision_id was always stored as an attribute
 
203
_inventory_v5b = """<inventory format="5" revision_id="a-rev-id">
 
204
</inventory>
 
205
"""
 
206
 
161
207
 
162
208
class TestSerializer(TestCase):
163
209
    """Test XML serialization"""
 
210
 
164
211
    def test_canned_inventory(self):
165
212
        """Test unpacked a canned inventory v4 file."""
166
213
        inp = StringIO(_working_inventory_v4)
229
276
        eq(ie.name, 'bar')
230
277
        eq(inv[ie.parent_id].kind, 'directory')
231
278
 
 
279
    def test_unpack_inventory_5a(self):
 
280
        inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(
 
281
                _inventory_v5a, revision_id='test-rev-id')
 
282
        self.assertEqual('test-rev-id', inv.root.revision)
 
283
 
 
284
    def test_unpack_inventory_5b(self):
 
285
        inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(
 
286
                _inventory_v5b, revision_id='test-rev-id')
 
287
        self.assertEqual('a-rev-id', inv.root.revision)
 
288
 
232
289
    def test_repack_inventory_5(self):
233
290
        inp = StringIO(_committed_inv_v5)
234
291
        inv = bzrlib.xml5.serializer_v5.read_inventory(inp)
244
301
        outp = StringIO()
245
302
        bzrlib.xml5.serializer_v5.write_inventory(inv, outp)
246
303
        self.assertEqualDiff(xml_string, outp.getvalue())
 
304
        lines = bzrlib.xml5.serializer_v5.write_inventory_to_lines(inv)
 
305
        outp.seek(0)
 
306
        self.assertEqual(outp.readlines(), lines)
247
307
        inv2 = bzrlib.xml5.serializer_v5.read_inventory(StringIO(outp.getvalue()))
248
308
        self.assertEqual(inv, inv2)
249
309
 
289
349
        new_rev = s_v5.read_revision_from_string(txt)
290
350
        self.assertEqual(props, new_rev.properties)
291
351
 
 
352
    def get_sample_inventory(self):
 
353
        inv = Inventory('tree-root-321', revision_id='rev_outer')
 
354
        inv.add(inventory.InventoryFile('file-id', 'file', 'tree-root-321'))
 
355
        inv.add(inventory.InventoryDirectory('dir-id', 'dir', 
 
356
                                             'tree-root-321'))
 
357
        inv.add(inventory.InventoryLink('link-id', 'link', 'tree-root-321'))
 
358
        inv['tree-root-321'].revision = 'rev_outer'
 
359
        inv['dir-id'].revision = 'rev_outer'
 
360
        inv['file-id'].revision = 'rev_outer'
 
361
        inv['file-id'].text_sha1 = 'A'
 
362
        inv['file-id'].text_size = 1
 
363
        inv['link-id'].revision = 'rev_outer'
 
364
        inv['link-id'].symlink_target = 'a'
 
365
        return inv
 
366
 
 
367
    def test_roundtrip_inventory_v7(self):
 
368
        inv = self.get_sample_inventory()
 
369
        inv.add(inventory.TreeReference('nested-id', 'nested', 'tree-root-321',
 
370
                                        'rev_outer', 'rev_inner'))
 
371
        txt = xml7.serializer_v7.write_inventory_to_string(inv)
 
372
        lines = xml7.serializer_v7.write_inventory_to_lines(inv)
 
373
        self.assertEqual(bzrlib.osutils.split_lines(txt), lines)
 
374
        self.assertEqualDiff(_expected_inv_v7, txt)
 
375
        inv2 = xml7.serializer_v7.read_inventory_from_string(txt)
 
376
        self.assertEqual(5, len(inv2))
 
377
        for path, ie in inv.iter_entries():
 
378
            self.assertEqual(ie, inv2[ie.file_id])
 
379
 
 
380
    def test_wrong_format_v7(self):
 
381
        """Can't accidentally open a file with wrong serializer"""
 
382
        s_v6 = bzrlib.xml6.serializer_v6
 
383
        s_v7 = xml7.serializer_v7
 
384
        self.assertRaises(errors.UnexpectedInventoryFormat, 
 
385
                          s_v7.read_inventory_from_string, _expected_inv_v5)
 
386
        self.assertRaises(errors.UnexpectedInventoryFormat, 
 
387
                          s_v6.read_inventory_from_string, _expected_inv_v7)
 
388
 
 
389
    def test_tree_reference(self):
 
390
        s_v5 = bzrlib.xml5.serializer_v5
 
391
        s_v6 = bzrlib.xml6.serializer_v6
 
392
        s_v7 = xml7.serializer_v7
 
393
        inv = Inventory('tree-root-321', revision_id='rev-outer')
 
394
        inv.root.revision = 'root-rev'
 
395
        inv.add(inventory.TreeReference('nested-id', 'nested', 'tree-root-321',
 
396
                                        'rev-outer', 'rev-inner'))
 
397
        self.assertRaises(errors.UnsupportedInventoryKind,
 
398
                          s_v5.write_inventory_to_string, inv)
 
399
        self.assertRaises(errors.UnsupportedInventoryKind,
 
400
                          s_v6.write_inventory_to_string, inv)
 
401
        txt = s_v7.write_inventory_to_string(inv)
 
402
        lines = s_v7.write_inventory_to_lines(inv)
 
403
        self.assertEqual(bzrlib.osutils.split_lines(txt), lines)
 
404
        inv2 = s_v7.read_inventory_from_string(txt)
 
405
        self.assertEqual('tree-root-321', inv2['nested-id'].parent_id)
 
406
        self.assertEqual('rev-outer', inv2['nested-id'].revision)
 
407
        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
 
 
415
    def test_roundtrip_inventory_v8(self):
 
416
        inv = self.get_sample_inventory()
 
417
        txt = xml8.serializer_v8.write_inventory_to_string(inv)
 
418
        inv2 = xml8.serializer_v8.read_inventory_from_string(txt)
 
419
        self.assertEqual(4, len(inv2))
 
420
        for path, ie in inv.iter_entries():
 
421
            self.assertEqual(ie, inv2[ie.file_id])
 
422
 
 
423
    def test_inventory_text_v8(self):
 
424
        inv = self.get_sample_inventory()
 
425
        txt = xml8.serializer_v8.write_inventory_to_string(inv)
 
426
        lines = xml8.serializer_v8.write_inventory_to_lines(inv)
 
427
        self.assertEqual(bzrlib.osutils.split_lines(txt), lines)
 
428
        self.assertEqualDiff(_expected_inv_v8, txt)
 
429
 
 
430
    def test_revision_text_v6(self):
 
431
        """Pack revision to XML v6"""
 
432
        rev = bzrlib.xml6.serializer_v6.read_revision_from_string(
 
433
            _expected_rev_v5)
 
434
        serialized = bzrlib.xml6.serializer_v6.write_revision_to_string(rev)
 
435
        self.assertEqualDiff(serialized, _expected_rev_v5)
 
436
 
 
437
    def test_revision_text_v7(self):
 
438
        """Pack revision to XML v7"""
 
439
        rev = bzrlib.xml7.serializer_v7.read_revision_from_string(
 
440
            _expected_rev_v5)
 
441
        serialized = bzrlib.xml7.serializer_v7.write_revision_to_string(rev)
 
442
        self.assertEqualDiff(serialized, _expected_rev_v5)
 
443
 
 
444
    def test_revision_text_v8(self):
 
445
        """Pack revision to XML v8"""
 
446
        rev = bzrlib.xml8.serializer_v8.read_revision_from_string(
 
447
            _expected_rev_v8)
 
448
        serialized = bzrlib.xml8.serializer_v8.write_revision_to_string(rev)
 
449
        self.assertEqualDiff(serialized, _expected_rev_v8)
 
450
 
292
451
    def test_revision_ids_are_utf8(self):
293
452
        """Parsed revision_ids should all be utf-8 strings, not unicode."""
294
453
        s_v5 = bzrlib.xml5.serializer_v5
309
468
        fid_bar1 = u'b\xe5r-01'.encode('utf8')
310
469
        fid_sub = u's\xb5bdir-01'.encode('utf8')
311
470
        fid_bar2 = u'b\xe5r-02'.encode('utf8')
312
 
        expected = [(u'', fid_root, None, None),
 
471
        expected = [(u'', fid_root, None, rev_id_2),
313
472
                    (u'b\xe5r', fid_bar1, fid_root, rev_id_1),
314
473
                    (u's\xb5bdir', fid_sub, fid_root, rev_id_1),
315
474
                    (u's\xb5bdir/b\xe5r', fid_bar2, fid_sub, rev_id_2),
333
492
 
334
493
        self.assertEqual(len(expected), len(actual))
335
494
 
 
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
 
336
507
 
337
508
class TestEncodeAndEscape(TestCase):
338
509
    """Whitebox testing of the _encode_and_escape function."""
339
510
 
340
511
    def setUp(self):
341
512
        # Keep the cache clear before and after the test
342
 
        bzrlib.xml5._ensure_utf8_re()
343
 
        bzrlib.xml5._clear_cache()
344
 
        self.addCleanup(bzrlib.xml5._clear_cache)
 
513
        bzrlib.xml8._ensure_utf8_re()
 
514
        bzrlib.xml8._clear_cache()
 
515
        self.addCleanup(bzrlib.xml8._clear_cache)
345
516
 
346
517
    def test_simple_ascii(self):
347
518
        # _encode_and_escape always appends a final ", because these parameters
348
519
        # are being used in xml attributes, and by returning it now, we have to
349
520
        # do fewer string operations later.
350
 
        val = bzrlib.xml5._encode_and_escape('foo bar')
 
521
        val = bzrlib.xml8._encode_and_escape('foo bar')
351
522
        self.assertEqual('foo bar"', val)
352
523
        # The second time should be cached
353
 
        val2 = bzrlib.xml5._encode_and_escape('foo bar')
 
524
        val2 = bzrlib.xml8._encode_and_escape('foo bar')
354
525
        self.assertIs(val2, val)
355
526
 
356
527
    def test_ascii_with_xml(self):
357
528
        self.assertEqual('&amp;&apos;&quot;&lt;&gt;"',
358
 
                         bzrlib.xml5._encode_and_escape('&\'"<>'))
 
529
                         bzrlib.xml8._encode_and_escape('&\'"<>'))
359
530
 
360
531
    def test_utf8_with_xml(self):
361
532
        # u'\xb5\xe5&\u062c'
362
533
        utf8_str = '\xc2\xb5\xc3\xa5&\xd8\xac'
363
534
        self.assertEqual('&#181;&#229;&amp;&#1580;"',
364
 
                         bzrlib.xml5._encode_and_escape(utf8_str))
 
535
                         bzrlib.xml8._encode_and_escape(utf8_str))
365
536
 
366
537
    def test_unicode(self):
367
538
        uni_str = u'\xb5\xe5&\u062c'
368
539
        self.assertEqual('&#181;&#229;&amp;&#1580;"',
369
 
                         bzrlib.xml5._encode_and_escape(uni_str))
 
540
                         bzrlib.xml8._encode_and_escape(uni_str))