68
_revision_v5_utc = """\
69
<revision committer="Martin Pool <mbp@sourcefrog.net>"
70
inventory_sha1="e79c31c1deb64c163cf660fdedd476dd579ffd41"
71
revision_id="mbp@sourcefrog.net-20050905080035-e0439293f8b6b9f9"
72
timestamp="1125907235.212"
74
<message>- start splitting code for xml (de)serialization away from objects
75
preparatory to supporting multiple formats by a single library
78
<revision_ref revision_id="mbp@sourcefrog.net-20050905063503-43948f59fa127d92"/>
83
60
_committed_inv_v5 = """<inventory>
84
<file file_id="bar-20050901064931-73b4b1138abc9cd2"
85
name="bar" parent_id="TREE_ROOT"
86
revision="mbp@foo-123123"
87
text_sha1="A" text_size="1"/>
61
<file file_id="bar-20050901064931-73b4b1138abc9cd2"
62
name="bar" parent_id="TREE_ROOT"
63
revision="mbp@foo-123123"/>
88
64
<directory name="subdir"
89
65
file_id="foo-20050801201819-4139aa4a272f4250"
91
67
revision="mbp@foo-00"/>
92
<file executable="yes" file_id="bar-20050824000535-6bc48cfad47ed134"
93
name="bar" parent_id="foo-20050801201819-4139aa4a272f4250"
95
text_sha1="B" text_size="0"/>
68
<file file_id="bar-20050824000535-6bc48cfad47ed134"
69
name="bar" parent_id="foo-20050801201819-4139aa4a272f4250"
70
revision="mbp@foo-00"/>
99
74
_basis_inv_v5 = """<inventory revision_id="mbp@sourcefrog.net-20050905063503-43948f59fa127d92">
100
<file file_id="bar-20050901064931-73b4b1138abc9cd2"
101
name="bar" parent_id="TREE_ROOT"
75
<file file_id="bar-20050901064931-73b4b1138abc9cd2"
76
name="bar" parent_id="TREE_ROOT"
102
77
revision="mbp@foo-123123"/>
103
78
<directory name="subdir"
104
79
file_id="foo-20050801201819-4139aa4a272f4250"
105
parent_id="TREE_ROOT"
106
81
revision="mbp@foo-00"/>
107
<file file_id="bar-20050824000535-6bc48cfad47ed134"
108
name="bar" parent_id="foo-20050801201819-4139aa4a272f4250"
82
<file file_id="bar-20050824000535-6bc48cfad47ed134"
83
name="bar" parent_id="foo-20050801201819-4139aa4a272f4250"
109
84
revision="mbp@foo-00"/>
114
# DO NOT REFLOW THIS. Its the exact revision we want.
115
_expected_rev_v5 = """<revision committer="Martin Pool <mbp@sourcefrog.net>" format="5" inventory_sha1="e79c31c1deb64c163cf660fdedd476dd579ffd41" revision_id="mbp@sourcefrog.net-20050905080035-e0439293f8b6b9f9" timestamp="1125907235.212" timezone="36000">
116
<message>- start splitting code for xml (de)serialization away from objects
117
preparatory to supporting multiple formats by a single library
120
<revision_ref revision_id="mbp@sourcefrog.net-20050905063503-43948f59fa127d92" />
126
# DO NOT REFLOW THIS. Its the exact inventory we want.
127
_expected_inv_v5 = """<inventory format="5">
128
<file file_id="bar-20050901064931-73b4b1138abc9cd2" name="bar" revision="mbp@foo-123123" text_sha1="A" text_size="1" />
129
<directory file_id="foo-20050801201819-4139aa4a272f4250" name="subdir" revision="mbp@foo-00" />
130
<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" />
135
_expected_inv_v5_root = """<inventory file_id="f<" format="5" revision_id="mother!">
136
<file file_id="bar-20050901064931-73b4b1138abc9cd2" name="bar" parent_id="f<" revision="mbp@foo-123123" text_sha1="A" text_size="1" />
137
<directory file_id="foo-20050801201819-4139aa4a272f4250" name="subdir" parent_id="f<" revision="mbp@foo-00" />
138
<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" />
139
<symlink file_id="link-1" name="link" parent_id="foo-20050801201819-4139aa4a272f4250" revision="mbp@foo-00" symlink_target="a" />
143
_expected_inv_v6 = """<inventory format="6" revision_id="rev_outer">
144
<directory file_id="tree-root-321" name="" revision="rev_outer" />
145
<directory file_id="dir-id" name="dir" parent_id="tree-root-321" revision="rev_outer" />
146
<file file_id="file-id" name="file" parent_id="tree-root-321" revision="rev_outer" text_sha1="A" text_size="1" />
147
<symlink file_id="link-id" name="link" parent_id="tree-root-321" revision="rev_outer" symlink_target="a" />
151
_expected_inv_v7 = """<inventory format="7" revision_id="rev_outer">
152
<directory file_id="tree-root-321" name="" revision="rev_outer" />
153
<directory file_id="dir-id" name="dir" parent_id="tree-root-321" revision="rev_outer" />
154
<file file_id="file-id" name="file" parent_id="tree-root-321" revision="rev_outer" text_sha1="A" text_size="1" />
155
<symlink file_id="link-id" name="link" parent_id="tree-root-321" revision="rev_outer" symlink_target="a" />
156
<tree-reference file_id="nested-id" name="nested" parent_id="tree-root-321" revision="rev_outer" reference_revision="rev_inner" />
160
_expected_rev_v8 = """<revision committer="Martin Pool <mbp@sourcefrog.net>" format="8" inventory_sha1="e79c31c1deb64c163cf660fdedd476dd579ffd41" revision_id="mbp@sourcefrog.net-20050905080035-e0439293f8b6b9f9" timestamp="1125907235.212" timezone="36000">
161
<message>- start splitting code for xml (de)serialization away from objects
162
preparatory to supporting multiple formats by a single library
165
<revision_ref revision_id="mbp@sourcefrog.net-20050905063503-43948f59fa127d92" />
170
_expected_inv_v8 = """<inventory format="8" revision_id="rev_outer">
171
<directory file_id="tree-root-321" name="" revision="rev_outer" />
172
<directory file_id="dir-id" name="dir" parent_id="tree-root-321" revision="rev_outer" />
173
<file file_id="file-id" name="file" parent_id="tree-root-321" revision="rev_outer" text_sha1="A" text_size="1" />
174
<symlink file_id="link-id" name="link" parent_id="tree-root-321" revision="rev_outer" symlink_target="a" />
178
_revision_utf8_v5 = """<revision committer="Erik Bågfors <erik@foo.net>"
179
inventory_sha1="e79c31c1deb64c163cf660fdedd476dd579ffd41"
180
revision_id="erik@bågfors-02"
181
timestamp="1125907235.212"
183
<message>Include µnicode characters
186
<revision_ref revision_id="erik@bågfors-01"/>
191
_inventory_utf8_v5 = """<inventory file_id="TREé_ROOT" format="5"
192
revision_id="erik@bågfors-02">
193
<file file_id="bår-01"
194
name="bår" parent_id="TREé_ROOT"
195
revision="erik@bågfors-01"/>
196
<directory name="sµbdir"
197
file_id="sµbdir-01"
198
parent_id="TREé_ROOT"
199
revision="erik@bågfors-01"/>
200
<file executable="yes" file_id="bår-02"
201
name="bår" parent_id="sµbdir-01"
202
revision="erik@bågfors-02"/>
206
# Before revision_id was always stored as an attribute
207
_inventory_v5a = """<inventory format="5">
211
# Before revision_id was always stored as an attribute
212
_inventory_v5b = """<inventory format="5" revision_id="a-rev-id">
217
88
class TestSerializer(TestCase):
218
89
"""Test XML serialization"""
220
90
def test_canned_inventory(self):
221
91
"""Test unpacked a canned inventory v4 file."""
222
92
inp = StringIO(_working_inventory_v4)
285
144
eq(ie.name, 'bar')
286
145
eq(inv[ie.parent_id].kind, 'directory')
288
def test_unpack_inventory_5a(self):
289
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(
290
_inventory_v5a, revision_id='test-rev-id')
291
self.assertEqual('test-rev-id', inv.root.revision)
293
def test_unpack_inventory_5b(self):
294
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(
295
_inventory_v5b, revision_id='test-rev-id')
296
self.assertEqual('a-rev-id', inv.root.revision)
298
147
def test_repack_inventory_5(self):
299
148
inp = StringIO(_committed_inv_v5)
300
149
inv = bzrlib.xml5.serializer_v5.read_inventory(inp)
301
150
outp = StringIO()
302
151
bzrlib.xml5.serializer_v5.write_inventory(inv, outp)
303
self.assertEqualDiff(_expected_inv_v5, outp.getvalue())
304
inv2 = bzrlib.xml5.serializer_v5.read_inventory(StringIO(outp.getvalue()))
305
self.assertEqual(inv, inv2)
307
def assertRoundTrips(self, xml_string):
308
inp = StringIO(xml_string)
309
inv = bzrlib.xml5.serializer_v5.read_inventory(inp)
311
bzrlib.xml5.serializer_v5.write_inventory(inv, outp)
312
self.assertEqualDiff(xml_string, outp.getvalue())
313
lines = bzrlib.xml5.serializer_v5.write_inventory_to_lines(inv)
315
self.assertEqual(outp.readlines(), lines)
316
inv2 = bzrlib.xml5.serializer_v5.read_inventory(StringIO(outp.getvalue()))
317
self.assertEqual(inv, inv2)
319
def tests_serialize_inventory_v5_with_root(self):
320
self.assertRoundTrips(_expected_inv_v5_root)
322
def check_repack_revision(self, txt):
323
"""Check that repacking a revision yields the same information"""
152
inv2 = bzrlib.xml5.serializer_v5.read_inventory(StringIO(outp.getvalue()))
153
self.assertEqual(inv, inv2)
155
def test_repack_revision_5(self):
156
"""Round-trip revision to XML v5"""
157
inp = StringIO(_revision_v5)
325
158
rev = bzrlib.xml5.serializer_v5.read_revision(inp)
326
159
outp = StringIO()
327
160
bzrlib.xml5.serializer_v5.write_revision(rev, outp)
345
171
outfile_contents = outp.getvalue()
346
172
self.assertEqual(outfile_contents[-1], '\n')
347
173
self.assertEqualDiff(outfile_contents, bzrlib.xml5.serializer_v5.write_revision_to_string(rev))
348
self.assertEqualDiff(outfile_contents, _expected_rev_v5)
350
def test_empty_property_value(self):
351
"""Create an empty property value check that it serializes correctly"""
352
s_v5 = bzrlib.xml5.serializer_v5
353
rev = s_v5.read_revision_from_string(_revision_v5)
355
props = {'empty':'', 'one':'one'}
356
rev.properties = props
357
txt = s_v5.write_revision_to_string(rev)
358
new_rev = s_v5.read_revision_from_string(txt)
359
self.assertEqual(props, new_rev.properties)
361
def get_sample_inventory(self):
362
inv = Inventory('tree-root-321', revision_id='rev_outer')
363
inv.add(inventory.InventoryFile('file-id', 'file', 'tree-root-321'))
364
inv.add(inventory.InventoryDirectory('dir-id', 'dir',
366
inv.add(inventory.InventoryLink('link-id', 'link', 'tree-root-321'))
367
inv['tree-root-321'].revision = 'rev_outer'
368
inv['dir-id'].revision = 'rev_outer'
369
inv['file-id'].revision = 'rev_outer'
370
inv['file-id'].text_sha1 = 'A'
371
inv['file-id'].text_size = 1
372
inv['link-id'].revision = 'rev_outer'
373
inv['link-id'].symlink_target = 'a'
376
def test_roundtrip_inventory_v7(self):
377
inv = self.get_sample_inventory()
378
inv.add(inventory.TreeReference('nested-id', 'nested', 'tree-root-321',
379
'rev_outer', 'rev_inner'))
380
txt = xml7.serializer_v7.write_inventory_to_string(inv)
381
lines = xml7.serializer_v7.write_inventory_to_lines(inv)
382
self.assertEqual(bzrlib.osutils.split_lines(txt), lines)
383
self.assertEqualDiff(_expected_inv_v7, txt)
384
inv2 = xml7.serializer_v7.read_inventory_from_string(txt)
385
self.assertEqual(5, len(inv2))
386
for path, ie in inv.iter_entries():
387
self.assertEqual(ie, inv2[ie.file_id])
389
def test_roundtrip_inventory_v6(self):
390
inv = self.get_sample_inventory()
391
txt = xml6.serializer_v6.write_inventory_to_string(inv)
392
lines = xml6.serializer_v6.write_inventory_to_lines(inv)
393
self.assertEqual(bzrlib.osutils.split_lines(txt), lines)
394
self.assertEqualDiff(_expected_inv_v6, txt)
395
inv2 = xml6.serializer_v6.read_inventory_from_string(txt)
396
self.assertEqual(4, len(inv2))
397
for path, ie in inv.iter_entries():
398
self.assertEqual(ie, inv2[ie.file_id])
400
def test_wrong_format_v7(self):
401
"""Can't accidentally open a file with wrong serializer"""
402
s_v6 = bzrlib.xml6.serializer_v6
403
s_v7 = xml7.serializer_v7
404
self.assertRaises(errors.UnexpectedInventoryFormat,
405
s_v7.read_inventory_from_string, _expected_inv_v5)
406
self.assertRaises(errors.UnexpectedInventoryFormat,
407
s_v6.read_inventory_from_string, _expected_inv_v7)
409
def test_tree_reference(self):
410
s_v5 = bzrlib.xml5.serializer_v5
411
s_v6 = bzrlib.xml6.serializer_v6
412
s_v7 = xml7.serializer_v7
413
inv = Inventory('tree-root-321', revision_id='rev-outer')
414
inv.root.revision = 'root-rev'
415
inv.add(inventory.TreeReference('nested-id', 'nested', 'tree-root-321',
416
'rev-outer', 'rev-inner'))
417
self.assertRaises(errors.UnsupportedInventoryKind,
418
s_v5.write_inventory_to_string, inv)
419
self.assertRaises(errors.UnsupportedInventoryKind,
420
s_v6.write_inventory_to_string, inv)
421
txt = s_v7.write_inventory_to_string(inv)
422
lines = s_v7.write_inventory_to_lines(inv)
423
self.assertEqual(bzrlib.osutils.split_lines(txt), lines)
424
inv2 = s_v7.read_inventory_from_string(txt)
425
self.assertEqual('tree-root-321', inv2['nested-id'].parent_id)
426
self.assertEqual('rev-outer', inv2['nested-id'].revision)
427
self.assertEqual('rev-inner', inv2['nested-id'].reference_revision)
428
self.assertRaises(errors.UnsupportedInventoryKind,
429
s_v6.read_inventory_from_string,
430
txt.replace('format="7"', 'format="6"'))
431
self.assertRaises(errors.UnsupportedInventoryKind,
432
s_v5.read_inventory_from_string,
433
txt.replace('format="7"', 'format="5"'))
435
def test_roundtrip_inventory_v8(self):
436
inv = self.get_sample_inventory()
437
txt = xml8.serializer_v8.write_inventory_to_string(inv)
438
inv2 = xml8.serializer_v8.read_inventory_from_string(txt)
439
self.assertEqual(4, len(inv2))
440
for path, ie in inv.iter_entries():
441
self.assertEqual(ie, inv2[ie.file_id])
443
def test_inventory_text_v8(self):
444
inv = self.get_sample_inventory()
445
txt = xml8.serializer_v8.write_inventory_to_string(inv)
446
lines = xml8.serializer_v8.write_inventory_to_lines(inv)
447
self.assertEqual(bzrlib.osutils.split_lines(txt), lines)
448
self.assertEqualDiff(_expected_inv_v8, txt)
450
def test_revision_text_v6(self):
451
"""Pack revision to XML v6"""
452
rev = bzrlib.xml6.serializer_v6.read_revision_from_string(
454
serialized = bzrlib.xml6.serializer_v6.write_revision_to_string(rev)
455
self.assertEqualDiff(serialized, _expected_rev_v5)
457
def test_revision_text_v7(self):
458
"""Pack revision to XML v7"""
459
rev = bzrlib.xml7.serializer_v7.read_revision_from_string(
461
serialized = bzrlib.xml7.serializer_v7.write_revision_to_string(rev)
462
self.assertEqualDiff(serialized, _expected_rev_v5)
464
def test_revision_text_v8(self):
465
"""Pack revision to XML v8"""
466
rev = bzrlib.xml8.serializer_v8.read_revision_from_string(
468
serialized = bzrlib.xml8.serializer_v8.write_revision_to_string(rev)
469
self.assertEqualDiff(serialized, _expected_rev_v8)
471
def test_revision_ids_are_utf8(self):
472
"""Parsed revision_ids should all be utf-8 strings, not unicode."""
473
s_v5 = bzrlib.xml5.serializer_v5
474
rev = s_v5.read_revision_from_string(_revision_utf8_v5)
475
self.assertEqual('erik@b\xc3\xa5gfors-02', rev.revision_id)
476
self.assertIsInstance(rev.revision_id, str)
477
self.assertEqual(['erik@b\xc3\xa5gfors-01'], rev.parent_ids)
478
for parent_id in rev.parent_ids:
479
self.assertIsInstance(parent_id, str)
480
self.assertEqual(u'Include \xb5nicode characters\n', rev.message)
481
self.assertIsInstance(rev.message, unicode)
483
# ie.revision should either be None or a utf-8 revision id
484
inv = s_v5.read_inventory_from_string(_inventory_utf8_v5)
485
rev_id_1 = u'erik@b\xe5gfors-01'.encode('utf8')
486
rev_id_2 = u'erik@b\xe5gfors-02'.encode('utf8')
487
fid_root = u'TRE\xe9_ROOT'.encode('utf8')
488
fid_bar1 = u'b\xe5r-01'.encode('utf8')
489
fid_sub = u's\xb5bdir-01'.encode('utf8')
490
fid_bar2 = u'b\xe5r-02'.encode('utf8')
491
expected = [(u'', fid_root, None, rev_id_2),
492
(u'b\xe5r', fid_bar1, fid_root, rev_id_1),
493
(u's\xb5bdir', fid_sub, fid_root, rev_id_1),
494
(u's\xb5bdir/b\xe5r', fid_bar2, fid_sub, rev_id_2),
496
self.assertEqual(rev_id_2, inv.revision_id)
497
self.assertIsInstance(inv.revision_id, str)
499
actual = list(inv.iter_entries_by_dir())
500
for ((exp_path, exp_file_id, exp_parent_id, exp_rev_id),
501
(act_path, act_ie)) in zip(expected, actual):
502
self.assertEqual(exp_path, act_path)
503
self.assertIsInstance(act_path, unicode)
504
self.assertEqual(exp_file_id, act_ie.file_id)
505
self.assertIsInstance(act_ie.file_id, str)
506
self.assertEqual(exp_parent_id, act_ie.parent_id)
507
if exp_parent_id is not None:
508
self.assertIsInstance(act_ie.parent_id, str)
509
self.assertEqual(exp_rev_id, act_ie.revision)
510
if exp_rev_id is not None:
511
self.assertIsInstance(act_ie.revision, str)
513
self.assertEqual(len(expected), len(actual))
516
class TestEncodeAndEscape(TestCase):
517
"""Whitebox testing of the _encode_and_escape function."""
521
# Keep the cache clear before and after the test
522
bzrlib.xml8._ensure_utf8_re()
523
bzrlib.xml8._clear_cache()
524
self.addCleanup(bzrlib.xml8._clear_cache)
526
def test_simple_ascii(self):
527
# _encode_and_escape always appends a final ", because these parameters
528
# are being used in xml attributes, and by returning it now, we have to
529
# do fewer string operations later.
530
val = bzrlib.xml8._encode_and_escape('foo bar')
531
self.assertEqual('foo bar"', val)
532
# The second time should be cached
533
val2 = bzrlib.xml8._encode_and_escape('foo bar')
534
self.assertIs(val2, val)
536
def test_ascii_with_xml(self):
537
self.assertEqual('&'"<>"',
538
bzrlib.xml8._encode_and_escape('&\'"<>'))
540
def test_utf8_with_xml(self):
542
utf8_str = '\xc2\xb5\xc3\xa5&\xd8\xac'
543
self.assertEqual('µå&ج"',
544
bzrlib.xml8._encode_and_escape(utf8_str))
546
def test_unicode(self):
547
uni_str = u'\xb5\xe5&\u062c'
548
self.assertEqual('µå&ج"',
549
bzrlib.xml8._encode_and_escape(uni_str))
added
removed
bzrlib/tests/test_xml.py
