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
17
17
from cStringIO import StringIO
19
19
from bzrlib import (
27
25
from bzrlib.tests import TestCase
28
from bzrlib.inventory import Inventory
26
from bzrlib.inventory import Inventory, InventoryEntry
27
from bzrlib.xml4 import serializer_v4
30
_working_inventory_v4 = """<inventory file_id="TREE_ROOT">
31
<entry file_id="bar-20050901064931-73b4b1138abc9cd2" kind="file" name="bar" parent_id="TREE_ROOT" />
32
<entry file_id="foo-20050801201819-4139aa4a272f4250" kind="directory" name="foo" parent_id="TREE_ROOT" />
33
<entry file_id="bar-20050824000535-6bc48cfad47ed134" kind="file" name="bar" parent_id="foo-20050801201819-4139aa4a272f4250" />
37
_revision_v4 = """<revision committer="Martin Pool <mbp@sourcefrog.net>"
38
inventory_id="mbp@sourcefrog.net-20050905080035-e0439293f8b6b9f9"
39
inventory_sha1="e79c31c1deb64c163cf660fdedd476dd579ffd41"
40
revision_id="mbp@sourcefrog.net-20050905080035-e0439293f8b6b9f9"
41
timestamp="1125907235.212"
43
<message>- start splitting code for xml (de)serialization away from objects
44
preparatory to supporting multiple formats by a single library
47
<revision_ref revision_id="mbp@sourcefrog.net-20050905063503-43948f59fa127d92" revision_sha1="7bdf4cc8c5bdac739f8cf9b10b78cf4b68f915ff" />
31
52
_revision_v5 = """<revision committer="Martin Pool <mbp@sourcefrog.net>"
32
53
inventory_sha1="e79c31c1deb64c163cf660fdedd476dd579ffd41"
33
54
revision_id="mbp@sourcefrog.net-20050905080035-e0439293f8b6b9f9"
60
81
_committed_inv_v5 = """<inventory>
61
<file file_id="bar-20050901064931-73b4b1138abc9cd2"
62
name="bar" parent_id="TREE_ROOT"
63
revision="mbp@foo-123123"
64
text_sha1="A" text_size="1"/>
82
<file file_id="bar-20050901064931-73b4b1138abc9cd2"
83
name="bar" parent_id="TREE_ROOT"
84
revision="mbp@foo-123123"/>
65
85
<directory name="subdir"
66
86
file_id="foo-20050801201819-4139aa4a272f4250"
68
88
revision="mbp@foo-00"/>
69
<file executable="yes" file_id="bar-20050824000535-6bc48cfad47ed134"
70
name="bar" parent_id="foo-20050801201819-4139aa4a272f4250"
72
text_sha1="B" text_size="0"/>
89
<file executable="yes" file_id="bar-20050824000535-6bc48cfad47ed134"
90
name="bar" parent_id="foo-20050801201819-4139aa4a272f4250"
91
revision="mbp@foo-00"/>
76
95
_basis_inv_v5 = """<inventory revision_id="mbp@sourcefrog.net-20050905063503-43948f59fa127d92">
77
<file file_id="bar-20050901064931-73b4b1138abc9cd2"
78
name="bar" parent_id="TREE_ROOT"
96
<file file_id="bar-20050901064931-73b4b1138abc9cd2"
97
name="bar" parent_id="TREE_ROOT"
79
98
revision="mbp@foo-123123"/>
80
99
<directory name="subdir"
81
100
file_id="foo-20050801201819-4139aa4a272f4250"
101
parent_id="TREE_ROOT"
83
102
revision="mbp@foo-00"/>
84
<file file_id="bar-20050824000535-6bc48cfad47ed134"
85
name="bar" parent_id="foo-20050801201819-4139aa4a272f4250"
103
<file file_id="bar-20050824000535-6bc48cfad47ed134"
104
name="bar" parent_id="foo-20050801201819-4139aa4a272f4250"
86
105
revision="mbp@foo-00"/>
103
122
# DO NOT REFLOW THIS. Its the exact inventory we want.
104
123
_expected_inv_v5 = """<inventory format="5">
105
<file file_id="bar-20050901064931-73b4b1138abc9cd2" name="bar" revision="mbp@foo-123123" text_sha1="A" text_size="1" />
124
<file file_id="bar-20050901064931-73b4b1138abc9cd2" name="bar" revision="mbp@foo-123123" />
106
125
<directory file_id="foo-20050801201819-4139aa4a272f4250" name="subdir" revision="mbp@foo-00" />
107
<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
<file executable="yes" file_id="bar-20050824000535-6bc48cfad47ed134" name="bar" parent_id="foo-20050801201819-4139aa4a272f4250" revision="mbp@foo-00" />
112
131
_expected_inv_v5_root = """<inventory file_id="f<" format="5" revision_id="mother!">
113
<file file_id="bar-20050901064931-73b4b1138abc9cd2" name="bar" parent_id="f<" revision="mbp@foo-123123" text_sha1="A" text_size="1" />
132
<file file_id="bar-20050901064931-73b4b1138abc9cd2" name="bar" parent_id="f<" revision="mbp@foo-123123" />
114
133
<directory file_id="foo-20050801201819-4139aa4a272f4250" name="subdir" parent_id="f<" revision="mbp@foo-00" />
115
<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" />
116
<symlink file_id="link-1" name="link" parent_id="foo-20050801201819-4139aa4a272f4250" revision="mbp@foo-00" symlink_target="a" />
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" />
134
<file executable="yes" file_id="bar-20050824000535-6bc48cfad47ed134" name="bar" parent_id="foo-20050801201819-4139aa4a272f4250" revision="mbp@foo-00" />
128
138
_expected_inv_v7 = """<inventory format="7" revision_id="rev_outer">
129
139
<directory file_id="tree-root-321" name="" revision="rev_outer" />
130
140
<directory file_id="dir-id" name="dir" parent_id="tree-root-321" revision="rev_outer" />
131
<file file_id="file-id" name="file" parent_id="tree-root-321" revision="rev_outer" text_sha1="A" text_size="1" />
132
<symlink file_id="link-id" name="link" parent_id="tree-root-321" revision="rev_outer" symlink_target="a" />
141
<file file_id="file-id" name="file" parent_id="tree-root-321" revision="rev_outer" />
142
<symlink file_id="link-id" name="link" parent_id="tree-root-321" revision="rev_outer" />
133
143
<tree-reference file_id="nested-id" name="nested" parent_id="tree-root-321" revision="rev_outer" reference_revision="rev_inner" />
137
_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">
138
<message>- start splitting code for xml (de)serialization away from objects
139
preparatory to supporting multiple formats by a single library
142
<revision_ref revision_id="mbp@sourcefrog.net-20050905063503-43948f59fa127d92" />
147
_expected_inv_v8 = """<inventory format="8" revision_id="rev_outer">
148
<directory file_id="tree-root-321" name="" revision="rev_outer" />
149
<directory file_id="dir-id" name="dir" parent_id="tree-root-321" revision="rev_outer" />
150
<file file_id="file-id" name="file" parent_id="tree-root-321" revision="rev_outer" text_sha1="A" text_size="1" />
151
<symlink file_id="link-id" name="link" parent_id="tree-root-321" revision="rev_outer" symlink_target="a" />
155
147
_revision_utf8_v5 = """<revision committer="Erik Bågfors <erik@foo.net>"
156
148
inventory_sha1="e79c31c1deb64c163cf660fdedd476dd579ffd41"
157
149
revision_id="erik@bågfors-02"
242
243
eq(ie.name, 'bar')
243
244
eq(inv[ie.parent_id].kind, 'directory')
245
def test_unpack_inventory_5a(self):
246
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(
247
_inventory_v5a, revision_id='test-rev-id')
248
self.assertEqual('test-rev-id', inv.root.revision)
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
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)
264
self.assertIsNot(entry, entry_cache[key])
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
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)
280
self.assertIs(entry, entry_cache[key])
282
def test_unpack_inventory_5b(self):
283
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(
284
_inventory_v5b, revision_id='test-rev-id')
285
self.assertEqual('a-rev-id', inv.root.revision)
287
246
def test_repack_inventory_5(self):
288
247
inp = StringIO(_committed_inv_v5)
289
248
inv = bzrlib.xml5.serializer_v5.read_inventory(inp)
347
303
new_rev = s_v5.read_revision_from_string(txt)
348
304
self.assertEqual(props, new_rev.properties)
350
def get_sample_inventory(self):
306
def test_roundtrip_inventory_v7(self):
351
307
inv = Inventory('tree-root-321', revision_id='rev_outer')
308
inv.add(inventory.TreeReference('nested-id', 'nested', 'tree-root-321',
309
'rev_outer', 'rev_inner'))
352
310
inv.add(inventory.InventoryFile('file-id', 'file', 'tree-root-321'))
353
inv.add(inventory.InventoryDirectory('dir-id', 'dir',
311
inv.add(inventory.InventoryDirectory('dir-id', 'dir',
354
312
'tree-root-321'))
355
313
inv.add(inventory.InventoryLink('link-id', 'link', 'tree-root-321'))
356
314
inv['tree-root-321'].revision = 'rev_outer'
357
315
inv['dir-id'].revision = 'rev_outer'
358
316
inv['file-id'].revision = 'rev_outer'
359
inv['file-id'].text_sha1 = 'A'
360
inv['file-id'].text_size = 1
361
317
inv['link-id'].revision = 'rev_outer'
362
inv['link-id'].symlink_target = 'a'
365
def test_roundtrip_inventory_v7(self):
366
inv = self.get_sample_inventory()
367
inv.add(inventory.TreeReference('nested-id', 'nested', 'tree-root-321',
368
'rev_outer', 'rev_inner'))
369
318
txt = xml7.serializer_v7.write_inventory_to_string(inv)
370
lines = xml7.serializer_v7.write_inventory_to_lines(inv)
371
self.assertEqual(bzrlib.osutils.split_lines(txt), lines)
372
319
self.assertEqualDiff(_expected_inv_v7, txt)
373
320
inv2 = xml7.serializer_v7.read_inventory_from_string(txt)
374
321
self.assertEqual(5, len(inv2))
375
322
for path, ie in inv.iter_entries():
376
323
self.assertEqual(ie, inv2[ie.file_id])
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])
389
325
def test_wrong_format_v7(self):
390
326
"""Can't accidentally open a file with wrong serializer"""
391
327
s_v6 = bzrlib.xml6.serializer_v6
392
328
s_v7 = xml7.serializer_v7
393
self.assertRaises(errors.UnexpectedInventoryFormat,
329
self.assertRaises(errors.UnexpectedInventoryFormat,
394
330
s_v7.read_inventory_from_string, _expected_inv_v5)
395
self.assertRaises(errors.UnexpectedInventoryFormat,
331
self.assertRaises(errors.UnexpectedInventoryFormat,
396
332
s_v6.read_inventory_from_string, _expected_inv_v7)
398
334
def test_tree_reference(self):
399
335
s_v5 = bzrlib.xml5.serializer_v5
400
336
s_v6 = bzrlib.xml6.serializer_v6
401
337
s_v7 = xml7.serializer_v7
402
inv = Inventory('tree-root-321', revision_id='rev-outer')
403
inv.root.revision = 'root-rev'
338
inv = Inventory('tree-root-321')
404
339
inv.add(inventory.TreeReference('nested-id', 'nested', 'tree-root-321',
405
340
'rev-outer', 'rev-inner'))
406
self.assertRaises(errors.UnsupportedInventoryKind,
341
self.assertRaises(errors.UnsupportedInventoryKind,
407
342
s_v5.write_inventory_to_string, inv)
408
self.assertRaises(errors.UnsupportedInventoryKind,
343
self.assertRaises(errors.UnsupportedInventoryKind,
409
344
s_v6.write_inventory_to_string, inv)
410
345
txt = s_v7.write_inventory_to_string(inv)
411
lines = s_v7.write_inventory_to_lines(inv)
412
self.assertEqual(bzrlib.osutils.split_lines(txt), lines)
413
346
inv2 = s_v7.read_inventory_from_string(txt)
414
347
self.assertEqual('tree-root-321', inv2['nested-id'].parent_id)
415
348
self.assertEqual('rev-outer', inv2['nested-id'].revision)
416
349
self.assertEqual('rev-inner', inv2['nested-id'].reference_revision)
417
self.assertRaises(errors.UnsupportedInventoryKind,
350
self.assertRaises(errors.UnsupportedInventoryKind,
418
351
s_v6.read_inventory_from_string,
419
352
txt.replace('format="7"', 'format="6"'))
420
self.assertRaises(errors.UnsupportedInventoryKind,
353
self.assertRaises(errors.UnsupportedInventoryKind,
421
354
s_v5.read_inventory_from_string,
422
355
txt.replace('format="7"', 'format="5"'))
424
def test_roundtrip_inventory_v8(self):
425
inv = self.get_sample_inventory()
426
txt = xml8.serializer_v8.write_inventory_to_string(inv)
427
inv2 = xml8.serializer_v8.read_inventory_from_string(txt)
428
self.assertEqual(4, len(inv2))
429
for path, ie in inv.iter_entries():
430
self.assertEqual(ie, inv2[ie.file_id])
432
def test_inventory_text_v8(self):
433
inv = self.get_sample_inventory()
434
txt = xml8.serializer_v8.write_inventory_to_string(inv)
435
lines = xml8.serializer_v8.write_inventory_to_lines(inv)
436
self.assertEqual(bzrlib.osutils.split_lines(txt), lines)
437
self.assertEqualDiff(_expected_inv_v8, txt)
439
def test_revision_text_v6(self):
440
"""Pack revision to XML v6"""
441
rev = bzrlib.xml6.serializer_v6.read_revision_from_string(
443
serialized = bzrlib.xml6.serializer_v6.write_revision_to_string(rev)
444
self.assertEqualDiff(serialized, _expected_rev_v5)
446
def test_revision_text_v7(self):
447
"""Pack revision to XML v7"""
448
rev = bzrlib.xml7.serializer_v7.read_revision_from_string(
450
serialized = bzrlib.xml7.serializer_v7.write_revision_to_string(rev)
451
self.assertEqualDiff(serialized, _expected_rev_v5)
453
def test_revision_text_v8(self):
454
"""Pack revision to XML v8"""
455
rev = bzrlib.xml8.serializer_v8.read_revision_from_string(
457
serialized = bzrlib.xml8.serializer_v8.write_revision_to_string(rev)
458
self.assertEqualDiff(serialized, _expected_rev_v8)
460
357
def test_revision_ids_are_utf8(self):
461
358
"""Parsed revision_ids should all be utf-8 strings, not unicode."""
462
359
s_v5 = bzrlib.xml5.serializer_v5
502
399
self.assertEqual(len(expected), len(actual))
401
def test_registry(self):
402
self.assertIs(serializer_v4,
403
xml_serializer.format_registry.get('4'))
404
self.assertIs(bzrlib.xml5.serializer_v5,
405
xml_serializer.format_registry.get('5'))
406
self.assertIs(bzrlib.xml6.serializer_v6,
407
xml_serializer.format_registry.get('6'))
408
self.assertIs(bzrlib.xml7.serializer_v7,
409
xml_serializer.format_registry.get('7'))
505
412
class TestEncodeAndEscape(TestCase):
506
413
"""Whitebox testing of the _encode_and_escape function."""
510
416
# Keep the cache clear before and after the test
511
bzrlib.xml8._ensure_utf8_re()
512
bzrlib.xml8._clear_cache()
513
self.addCleanup(bzrlib.xml8._clear_cache)
417
bzrlib.xml5._ensure_utf8_re()
418
bzrlib.xml5._clear_cache()
419
self.addCleanup(bzrlib.xml5._clear_cache)
515
421
def test_simple_ascii(self):
516
422
# _encode_and_escape always appends a final ", because these parameters
517
423
# are being used in xml attributes, and by returning it now, we have to
518
424
# do fewer string operations later.
519
val = bzrlib.xml8._encode_and_escape('foo bar')
425
val = bzrlib.xml5._encode_and_escape('foo bar')
520
426
self.assertEqual('foo bar"', val)
521
427
# The second time should be cached
522
val2 = bzrlib.xml8._encode_and_escape('foo bar')
428
val2 = bzrlib.xml5._encode_and_escape('foo bar')
523
429
self.assertIs(val2, val)
525
431
def test_ascii_with_xml(self):
526
432
self.assertEqual('&'"<>"',
527
bzrlib.xml8._encode_and_escape('&\'"<>'))
433
bzrlib.xml5._encode_and_escape('&\'"<>'))
529
435
def test_utf8_with_xml(self):
530
436
# u'\xb5\xe5&\u062c'
531
437
utf8_str = '\xc2\xb5\xc3\xa5&\xd8\xac'
532
438
self.assertEqual('µå&ج"',
533
bzrlib.xml8._encode_and_escape(utf8_str))
439
bzrlib.xml5._encode_and_escape(utf8_str))
535
441
def test_unicode(self):
536
442
uni_str = u'\xb5\xe5&\u062c'
537
443
self.assertEqual('µå&ج"',
538
bzrlib.xml8._encode_and_escape(uni_str))
541
class TestMisc(TestCase):
543
def test_unescape_xml(self):
544
"""We get some kind of error when malformed entities are passed"""
545
self.assertRaises(KeyError, bzrlib.xml8._unescape_xml, 'foo&bar;')
444
bzrlib.xml5._encode_and_escape(uni_str))
added
removed
bzrlib/tests/test_xml.py
