~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_xml.py

  • Committer: Ian Clatworthy
  • Date: 2007-07-10 01:37:27 UTC
  • mto: This revision was merged to the branch mainline in revision 2598.
  • Revision ID: ian.clatworthy@internode.on.net-20070710013727-xrx8w91shojt1p4l
(Ian Clatworthy) Prepare for 0.19 development

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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
from cStringIO import StringIO
18
18
 
19
19
from bzrlib import (
20
 
    errors,
21
 
    inventory,
 
20
    errors, 
 
21
    inventory, 
22
22
    xml7,
23
 
    xml8,
24
 
    serializer,
25
23
    )
26
24
from bzrlib.tests import TestCase
27
25
from bzrlib.inventory import Inventory, InventoryEntry
80
78
"""
81
79
 
82
80
_committed_inv_v5 = """<inventory>
83
 
<file file_id="bar-20050901064931-73b4b1138abc9cd2"
84
 
      name="bar" parent_id="TREE_ROOT"
85
 
      revision="mbp@foo-123123"
86
 
      text_sha1="A" text_size="1"/>
 
81
<file file_id="bar-20050901064931-73b4b1138abc9cd2" 
 
82
      name="bar" parent_id="TREE_ROOT" 
 
83
      revision="mbp@foo-123123"/>
87
84
<directory name="subdir"
88
85
           file_id="foo-20050801201819-4139aa4a272f4250"
89
 
           parent_id="TREE_ROOT"
 
86
           parent_id="TREE_ROOT" 
90
87
           revision="mbp@foo-00"/>
91
 
<file executable="yes" file_id="bar-20050824000535-6bc48cfad47ed134"
92
 
      name="bar" parent_id="foo-20050801201819-4139aa4a272f4250"
93
 
      revision="mbp@foo-00"
94
 
      text_sha1="B" text_size="0"/>
 
88
<file executable="yes" file_id="bar-20050824000535-6bc48cfad47ed134" 
 
89
      name="bar" parent_id="foo-20050801201819-4139aa4a272f4250" 
 
90
      revision="mbp@foo-00"/>
95
91
</inventory>
96
92
"""
97
93
 
98
94
_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"
 
95
<file file_id="bar-20050901064931-73b4b1138abc9cd2" 
 
96
      name="bar" parent_id="TREE_ROOT" 
101
97
      revision="mbp@foo-123123"/>
102
98
<directory name="subdir"
103
99
           file_id="foo-20050801201819-4139aa4a272f4250"
104
 
           parent_id="TREE_ROOT"
 
100
           parent_id="TREE_ROOT" 
105
101
           revision="mbp@foo-00"/>
106
 
<file file_id="bar-20050824000535-6bc48cfad47ed134"
107
 
      name="bar" parent_id="foo-20050801201819-4139aa4a272f4250"
 
102
<file file_id="bar-20050824000535-6bc48cfad47ed134" 
 
103
      name="bar" parent_id="foo-20050801201819-4139aa4a272f4250" 
108
104
      revision="mbp@foo-00"/>
109
105
</inventory>
110
106
"""
124
120
 
125
121
# DO NOT REFLOW THIS. Its the exact inventory we want.
126
122
_expected_inv_v5 = """<inventory format="5">
127
 
<file file_id="bar-20050901064931-73b4b1138abc9cd2" name="bar" revision="mbp@foo-123123" text_sha1="A" text_size="1" />
 
123
<file file_id="bar-20050901064931-73b4b1138abc9cd2" name="bar" revision="mbp@foo-123123" />
128
124
<directory file_id="foo-20050801201819-4139aa4a272f4250" name="subdir" 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" />
 
125
<file executable="yes" file_id="bar-20050824000535-6bc48cfad47ed134" name="bar" parent_id="foo-20050801201819-4139aa4a272f4250" revision="mbp@foo-00" />
130
126
</inventory>
131
127
"""
132
128
 
133
129
 
134
130
_expected_inv_v5_root = """<inventory file_id="f&lt;" format="5" revision_id="mother!">
135
 
<file file_id="bar-20050901064931-73b4b1138abc9cd2" name="bar" parent_id="f&lt;" revision="mbp@foo-123123" text_sha1="A" text_size="1" />
 
131
<file file_id="bar-20050901064931-73b4b1138abc9cd2" name="bar" parent_id="f&lt;" revision="mbp@foo-123123" />
136
132
<directory file_id="foo-20050801201819-4139aa4a272f4250" name="subdir" parent_id="f&lt;" revision="mbp@foo-00" />
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" />
 
133
<file executable="yes" file_id="bar-20050824000535-6bc48cfad47ed134" name="bar" parent_id="foo-20050801201819-4139aa4a272f4250" revision="mbp@foo-00" />
139
134
</inventory>
140
135
"""
141
136
 
142
137
_expected_inv_v7 = """<inventory format="7" revision_id="rev_outer">
143
138
<directory file_id="tree-root-321" name="" revision="rev_outer" />
144
139
<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" />
 
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" />
147
142
<tree-reference file_id="nested-id" name="nested" parent_id="tree-root-321" revision="rev_outer" reference_revision="rev_inner" />
148
143
</inventory>
149
144
"""
150
145
 
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
 
"""
168
 
 
169
146
_revision_utf8_v5 = """<revision committer="Erik B&#229;gfors &lt;erik@foo.net&gt;"
170
147
    inventory_sha1="e79c31c1deb64c163cf660fdedd476dd579ffd41"
171
148
    revision_id="erik@b&#229;gfors-02"
194
171
</inventory>
195
172
"""
196
173
 
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
 
 
207
174
 
208
175
class TestSerializer(TestCase):
209
176
    """Test XML serialization"""
210
 
 
211
177
    def test_canned_inventory(self):
212
178
        """Test unpacked a canned inventory v4 file."""
213
179
        inp = StringIO(_working_inventory_v4)
276
242
        eq(ie.name, 'bar')
277
243
        eq(inv[ie.parent_id].kind, 'directory')
278
244
 
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
 
 
289
245
    def test_repack_inventory_5(self):
290
246
        inp = StringIO(_committed_inv_v5)
291
247
        inv = bzrlib.xml5.serializer_v5.read_inventory(inp)
294
250
        self.assertEqualDiff(_expected_inv_v5, outp.getvalue())
295
251
        inv2 = bzrlib.xml5.serializer_v5.read_inventory(StringIO(outp.getvalue()))
296
252
        self.assertEqual(inv, inv2)
297
 
 
 
253
    
298
254
    def assertRoundTrips(self, xml_string):
299
255
        inp = StringIO(xml_string)
300
256
        inv = bzrlib.xml5.serializer_v5.read_inventory(inp)
301
257
        outp = StringIO()
302
258
        bzrlib.xml5.serializer_v5.write_inventory(inv, outp)
303
259
        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)
307
260
        inv2 = bzrlib.xml5.serializer_v5.read_inventory(StringIO(outp.getvalue()))
308
261
        self.assertEqual(inv, inv2)
309
262
 
349
302
        new_rev = s_v5.read_revision_from_string(txt)
350
303
        self.assertEqual(props, new_rev.properties)
351
304
 
352
 
    def get_sample_inventory(self):
 
305
    def test_roundtrip_inventory_v7(self):
353
306
        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'))
354
309
        inv.add(inventory.InventoryFile('file-id', 'file', 'tree-root-321'))
355
 
        inv.add(inventory.InventoryDirectory('dir-id', 'dir',
 
310
        inv.add(inventory.InventoryDirectory('dir-id', 'dir', 
356
311
                                             'tree-root-321'))
357
312
        inv.add(inventory.InventoryLink('link-id', 'link', 'tree-root-321'))
358
313
        inv['tree-root-321'].revision = 'rev_outer'
359
314
        inv['dir-id'].revision = 'rev_outer'
360
315
        inv['file-id'].revision = 'rev_outer'
361
 
        inv['file-id'].text_sha1 = 'A'
362
 
        inv['file-id'].text_size = 1
363
316
        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
317
        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
318
        self.assertEqualDiff(_expected_inv_v7, txt)
375
319
        inv2 = xml7.serializer_v7.read_inventory_from_string(txt)
376
320
        self.assertEqual(5, len(inv2))
381
325
        """Can't accidentally open a file with wrong serializer"""
382
326
        s_v6 = bzrlib.xml6.serializer_v6
383
327
        s_v7 = xml7.serializer_v7
384
 
        self.assertRaises(errors.UnexpectedInventoryFormat,
 
328
        self.assertRaises(errors.UnexpectedInventoryFormat, 
385
329
                          s_v7.read_inventory_from_string, _expected_inv_v5)
386
 
        self.assertRaises(errors.UnexpectedInventoryFormat,
 
330
        self.assertRaises(errors.UnexpectedInventoryFormat, 
387
331
                          s_v6.read_inventory_from_string, _expected_inv_v7)
388
332
 
389
333
    def test_tree_reference(self):
390
334
        s_v5 = bzrlib.xml5.serializer_v5
391
335
        s_v6 = bzrlib.xml6.serializer_v6
392
336
        s_v7 = xml7.serializer_v7
393
 
        inv = Inventory('tree-root-321', revision_id='rev-outer')
394
 
        inv.root.revision = 'root-rev'
 
337
        inv = Inventory('tree-root-321')
395
338
        inv.add(inventory.TreeReference('nested-id', 'nested', 'tree-root-321',
396
339
                                        'rev-outer', 'rev-inner'))
397
 
        self.assertRaises(errors.UnsupportedInventoryKind,
 
340
        self.assertRaises(errors.UnsupportedInventoryKind, 
398
341
                          s_v5.write_inventory_to_string, inv)
399
 
        self.assertRaises(errors.UnsupportedInventoryKind,
 
342
        self.assertRaises(errors.UnsupportedInventoryKind, 
400
343
                          s_v6.write_inventory_to_string, inv)
401
344
        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
345
        inv2 = s_v7.read_inventory_from_string(txt)
405
346
        self.assertEqual('tree-root-321', inv2['nested-id'].parent_id)
406
347
        self.assertEqual('rev-outer', inv2['nested-id'].revision)
407
348
        self.assertEqual('rev-inner', inv2['nested-id'].reference_revision)
408
 
        self.assertRaises(errors.UnsupportedInventoryKind,
 
349
        self.assertRaises(errors.UnsupportedInventoryKind, 
409
350
                          s_v6.read_inventory_from_string,
410
351
                          txt.replace('format="7"', 'format="6"'))
411
 
        self.assertRaises(errors.UnsupportedInventoryKind,
 
352
        self.assertRaises(errors.UnsupportedInventoryKind, 
412
353
                          s_v5.read_inventory_from_string,
413
354
                          txt.replace('format="7"', 'format="5"'))
414
355
 
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
 
 
451
356
    def test_revision_ids_are_utf8(self):
452
357
        """Parsed revision_ids should all be utf-8 strings, not unicode."""
453
358
        s_v5 = bzrlib.xml5.serializer_v5
468
373
        fid_bar1 = u'b\xe5r-01'.encode('utf8')
469
374
        fid_sub = u's\xb5bdir-01'.encode('utf8')
470
375
        fid_bar2 = u'b\xe5r-02'.encode('utf8')
471
 
        expected = [(u'', fid_root, None, rev_id_2),
 
376
        expected = [(u'', fid_root, None, None),
472
377
                    (u'b\xe5r', fid_bar1, fid_root, rev_id_1),
473
378
                    (u's\xb5bdir', fid_sub, fid_root, rev_id_1),
474
379
                    (u's\xb5bdir/b\xe5r', fid_bar2, fid_sub, rev_id_2),
497
402
    """Whitebox testing of the _encode_and_escape function."""
498
403
 
499
404
    def setUp(self):
500
 
        TestCase.setUp(self)
501
405
        # Keep the cache clear before and after the test
502
 
        bzrlib.xml8._ensure_utf8_re()
503
 
        bzrlib.xml8._clear_cache()
504
 
        self.addCleanup(bzrlib.xml8._clear_cache)
 
406
        bzrlib.xml5._ensure_utf8_re()
 
407
        bzrlib.xml5._clear_cache()
 
408
        self.addCleanup(bzrlib.xml5._clear_cache)
505
409
 
506
410
    def test_simple_ascii(self):
507
411
        # _encode_and_escape always appends a final ", because these parameters
508
412
        # are being used in xml attributes, and by returning it now, we have to
509
413
        # do fewer string operations later.
510
 
        val = bzrlib.xml8._encode_and_escape('foo bar')
 
414
        val = bzrlib.xml5._encode_and_escape('foo bar')
511
415
        self.assertEqual('foo bar"', val)
512
416
        # The second time should be cached
513
 
        val2 = bzrlib.xml8._encode_and_escape('foo bar')
 
417
        val2 = bzrlib.xml5._encode_and_escape('foo bar')
514
418
        self.assertIs(val2, val)
515
419
 
516
420
    def test_ascii_with_xml(self):
517
421
        self.assertEqual('&amp;&apos;&quot;&lt;&gt;"',
518
 
                         bzrlib.xml8._encode_and_escape('&\'"<>'))
 
422
                         bzrlib.xml5._encode_and_escape('&\'"<>'))
519
423
 
520
424
    def test_utf8_with_xml(self):
521
425
        # u'\xb5\xe5&\u062c'
522
426
        utf8_str = '\xc2\xb5\xc3\xa5&\xd8\xac'
523
427
        self.assertEqual('&#181;&#229;&amp;&#1580;"',
524
 
                         bzrlib.xml8._encode_and_escape(utf8_str))
 
428
                         bzrlib.xml5._encode_and_escape(utf8_str))
525
429
 
526
430
    def test_unicode(self):
527
431
        uni_str = u'\xb5\xe5&\u062c'
528
432
        self.assertEqual('&#181;&#229;&amp;&#1580;"',
529
 
                         bzrlib.xml8._encode_and_escape(uni_str))
 
433
                         bzrlib.xml5._encode_and_escape(uni_str))