14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
from cStringIO import StringIO
28
from bzrlib.tests import TestCase
29
from bzrlib.inventory import Inventory, InventoryEntry
30
from bzrlib.xml4 import serializer_v4
33
_working_inventory_v4 = """<inventory file_id="TREE_ROOT">
34
<entry file_id="bar-20050901064931-73b4b1138abc9cd2" kind="file" name="bar" parent_id="TREE_ROOT" />
35
<entry file_id="foo-20050801201819-4139aa4a272f4250" kind="directory" name="foo" parent_id="TREE_ROOT" />
36
<entry file_id="bar-20050824000535-6bc48cfad47ed134" kind="file" name="bar" parent_id="foo-20050801201819-4139aa4a272f4250" />
40
_revision_v4 = """<revision committer="Martin Pool <mbp@sourcefrog.net>"
41
inventory_id="mbp@sourcefrog.net-20050905080035-e0439293f8b6b9f9"
42
inventory_sha1="e79c31c1deb64c163cf660fdedd476dd579ffd41"
43
revision_id="mbp@sourcefrog.net-20050905080035-e0439293f8b6b9f9"
44
timestamp="1125907235.212"
46
<message>- start splitting code for xml (de)serialization away from objects
47
preparatory to supporting multiple formats by a single library
50
<revision_ref revision_id="mbp@sourcefrog.net-20050905063503-43948f59fa127d92" revision_sha1="7bdf4cc8c5bdac739f8cf9b10b78cf4b68f915ff" />
55
_revision_v5 = """<revision committer="Martin Pool <mbp@sourcefrog.net>"
28
from ..sixish import (
31
from ..bzr.inventory import Inventory
32
from . import TestCase
33
import breezy.bzr.xml5
35
_revision_v5 = b"""<revision committer="Martin Pool <mbp@sourcefrog.net>"
56
36
inventory_sha1="e79c31c1deb64c163cf660fdedd476dd579ffd41"
57
37
revision_id="mbp@sourcefrog.net-20050905080035-e0439293f8b6b9f9"
58
38
timestamp="1125907235.212"
218
198
class TestSerializer(TestCase):
219
199
"""Test XML serialization"""
221
def test_canned_inventory(self):
222
"""Test unpacked a canned inventory v4 file."""
223
inp = StringIO(_working_inventory_v4)
224
inv = serializer_v4.read_inventory(inp)
225
self.assertEqual(len(inv), 4)
226
self.assert_('bar-20050901064931-73b4b1138abc9cd2' in inv)
228
def test_unpack_revision(self):
229
"""Test unpacking a canned revision v4"""
230
inp = StringIO(_revision_v4)
231
rev = serializer_v4.read_revision(inp)
232
eq = self.assertEqual
234
"Martin Pool <mbp@sourcefrog.net>")
236
"mbp@sourcefrog.net-20050905080035-e0439293f8b6b9f9")
237
eq(len(rev.parent_ids), 1)
238
eq(rev.parent_ids[0],
239
"mbp@sourcefrog.net-20050905063503-43948f59fa127d92")
241
201
def test_unpack_revision_5(self):
242
202
"""Test unpacking a canned revision v5"""
243
inp = StringIO(_revision_v5)
244
rev = bzrlib.xml5.serializer_v5.read_revision(inp)
203
inp = BytesIO(_revision_v5)
204
rev = breezy.bzr.xml5.serializer_v5.read_revision(inp)
245
205
eq = self.assertEqual
246
206
eq(rev.committer,
247
207
"Martin Pool <mbp@sourcefrog.net>")
264
224
def test_unpack_inventory_5(self):
265
225
"""Unpack canned new-style inventory"""
266
inp = StringIO(_committed_inv_v5)
267
inv = bzrlib.xml5.serializer_v5.read_inventory(inp)
226
inp = BytesIO(_committed_inv_v5)
227
inv = breezy.bzr.xml5.serializer_v5.read_inventory(inp)
268
228
eq = self.assertEqual
270
ie = inv['bar-20050824000535-6bc48cfad47ed134']
230
ie = inv.get_entry('bar-20050824000535-6bc48cfad47ed134')
271
231
eq(ie.kind, 'file')
272
232
eq(ie.revision, 'mbp@foo-00')
273
233
eq(ie.name, 'bar')
274
eq(inv[ie.parent_id].kind, 'directory')
234
eq(inv.get_entry(ie.parent_id).kind, 'directory')
276
236
def test_unpack_basis_inventory_5(self):
277
237
"""Unpack canned new-style inventory"""
278
inp = StringIO(_basis_inv_v5)
279
inv = bzrlib.xml5.serializer_v5.read_inventory(inp)
238
inp = BytesIO(_basis_inv_v5)
239
inv = breezy.bzr.xml5.serializer_v5.read_inventory(inp)
280
240
eq = self.assertEqual
282
242
eq(inv.revision_id, 'mbp@sourcefrog.net-20050905063503-43948f59fa127d92')
283
ie = inv['bar-20050824000535-6bc48cfad47ed134']
243
ie = inv.get_entry('bar-20050824000535-6bc48cfad47ed134')
284
244
eq(ie.kind, 'file')
285
245
eq(ie.revision, 'mbp@foo-00')
286
246
eq(ie.name, 'bar')
287
eq(inv[ie.parent_id].kind, 'directory')
247
eq(inv.get_entry(ie.parent_id).kind, 'directory')
289
249
def test_unpack_inventory_5a(self):
290
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(
250
inv = breezy.bzr.xml5.serializer_v5.read_inventory_from_string(
291
251
_inventory_v5a, revision_id='test-rev-id')
292
252
self.assertEqual('test-rev-id', inv.root.revision)
324
284
self.assertIs(entry, entry_cache[key])
326
286
def test_unpack_inventory_5b(self):
327
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(
287
inv = breezy.bzr.xml5.serializer_v5.read_inventory_from_string(
328
288
_inventory_v5b, revision_id='test-rev-id')
329
289
self.assertEqual('a-rev-id', inv.root.revision)
331
291
def test_repack_inventory_5(self):
332
inp = StringIO(_committed_inv_v5)
333
inv = bzrlib.xml5.serializer_v5.read_inventory(inp)
335
bzrlib.xml5.serializer_v5.write_inventory(inv, outp)
292
inp = BytesIO(_committed_inv_v5)
293
inv = breezy.bzr.xml5.serializer_v5.read_inventory(inp)
295
breezy.bzr.xml5.serializer_v5.write_inventory(inv, outp)
336
296
self.assertEqualDiff(_expected_inv_v5, outp.getvalue())
337
inv2 = bzrlib.xml5.serializer_v5.read_inventory(StringIO(outp.getvalue()))
297
inv2 = breezy.bzr.xml5.serializer_v5.read_inventory(BytesIO(outp.getvalue()))
338
298
self.assertEqual(inv, inv2)
340
300
def assertRoundTrips(self, xml_string):
341
inp = StringIO(xml_string)
342
inv = bzrlib.xml5.serializer_v5.read_inventory(inp)
344
bzrlib.xml5.serializer_v5.write_inventory(inv, outp)
301
inp = BytesIO(xml_string)
302
inv = breezy.bzr.xml5.serializer_v5.read_inventory(inp)
304
breezy.bzr.xml5.serializer_v5.write_inventory(inv, outp)
345
305
self.assertEqualDiff(xml_string, outp.getvalue())
346
lines = bzrlib.xml5.serializer_v5.write_inventory_to_lines(inv)
306
lines = breezy.bzr.xml5.serializer_v5.write_inventory_to_lines(inv)
348
308
self.assertEqual(outp.readlines(), lines)
349
inv2 = bzrlib.xml5.serializer_v5.read_inventory(StringIO(outp.getvalue()))
309
inv2 = breezy.bzr.xml5.serializer_v5.read_inventory(BytesIO(outp.getvalue()))
350
310
self.assertEqual(inv, inv2)
352
312
def tests_serialize_inventory_v5_with_root(self):
355
315
def check_repack_revision(self, txt):
356
316
"""Check that repacking a revision yields the same information"""
358
rev = bzrlib.xml5.serializer_v5.read_revision(inp)
360
bzrlib.xml5.serializer_v5.write_revision(rev, outp)
318
rev = breezy.bzr.xml5.serializer_v5.read_revision(inp)
320
breezy.bzr.xml5.serializer_v5.write_revision(rev, outp)
361
321
outfile_contents = outp.getvalue()
362
rev2 = bzrlib.xml5.serializer_v5.read_revision(StringIO(outfile_contents))
322
rev2 = breezy.bzr.xml5.serializer_v5.read_revision(BytesIO(outfile_contents))
363
323
self.assertEqual(rev, rev2)
365
325
def test_repack_revision_5(self):
372
332
def test_pack_revision_5(self):
373
333
"""Pack revision to XML v5"""
374
334
# fixed 20051025, revisions should have final newline
375
rev = bzrlib.xml5.serializer_v5.read_revision_from_string(_revision_v5)
377
bzrlib.xml5.serializer_v5.write_revision(rev, outp)
335
rev = breezy.bzr.xml5.serializer_v5.read_revision_from_string(_revision_v5)
337
breezy.bzr.xml5.serializer_v5.write_revision(rev, outp)
378
338
outfile_contents = outp.getvalue()
379
339
self.assertEqual(outfile_contents[-1], '\n')
380
self.assertEqualDiff(outfile_contents, bzrlib.xml5.serializer_v5.write_revision_to_string(rev))
340
self.assertEqualDiff(outfile_contents, breezy.bzr.xml5.serializer_v5.write_revision_to_string(rev))
381
341
self.assertEqualDiff(outfile_contents, _expected_rev_v5)
383
343
def test_empty_property_value(self):
384
344
"""Create an empty property value check that it serializes correctly"""
385
s_v5 = bzrlib.xml5.serializer_v5
345
s_v5 = breezy.bzr.xml5.serializer_v5
386
346
rev = s_v5.read_revision_from_string(_revision_v5)
388
348
props = {'empty':'', 'one':'one'}
389
349
rev.properties = props
390
350
txt = s_v5.write_revision_to_string(rev)
392
352
self.assertEqual(props, new_rev.properties)
394
354
def get_sample_inventory(self):
395
inv = Inventory('tree-root-321', revision_id='rev_outer')
396
inv.add(inventory.InventoryFile('file-id', 'file', 'tree-root-321'))
397
inv.add(inventory.InventoryDirectory('dir-id', 'dir',
399
inv.add(inventory.InventoryLink('link-id', 'link', 'tree-root-321'))
400
inv['tree-root-321'].revision = 'rev_outer'
401
inv['dir-id'].revision = 'rev_outer'
402
inv['file-id'].revision = 'rev_outer'
403
inv['file-id'].text_sha1 = 'A'
404
inv['file-id'].text_size = 1
405
inv['link-id'].revision = 'rev_outer'
406
inv['link-id'].symlink_target = 'a'
355
inv = Inventory(b'tree-root-321', revision_id=b'rev_outer')
356
inv.add(inventory.InventoryFile(b'file-id', 'file', b'tree-root-321'))
357
inv.add(inventory.InventoryDirectory(b'dir-id', 'dir',
359
inv.add(inventory.InventoryLink(b'link-id', 'link', b'tree-root-321'))
360
inv.get_entry(b'tree-root-321').revision = b'rev_outer'
361
inv.get_entry(b'dir-id').revision = b'rev_outer'
362
inv.get_entry(b'file-id').revision = b'rev_outer'
363
inv.get_entry(b'file-id').text_sha1 = 'A'
364
inv.get_entry(b'file-id').text_size = 1
365
inv.get_entry(b'link-id').revision = b'rev_outer'
366
inv.get_entry(b'link-id').symlink_target = 'a'
409
369
def test_roundtrip_inventory_v7(self):
410
370
inv = self.get_sample_inventory()
411
inv.add(inventory.TreeReference('nested-id', 'nested', 'tree-root-321',
412
'rev_outer', 'rev_inner'))
371
inv.add(inventory.TreeReference(b'nested-id', 'nested', b'tree-root-321',
372
b'rev_outer', b'rev_inner'))
413
373
txt = xml7.serializer_v7.write_inventory_to_string(inv)
414
374
lines = xml7.serializer_v7.write_inventory_to_lines(inv)
415
self.assertEqual(bzrlib.osutils.split_lines(txt), lines)
375
self.assertEqual(breezy.osutils.split_lines(txt), lines)
416
376
self.assertEqualDiff(_expected_inv_v7, txt)
417
377
inv2 = xml7.serializer_v7.read_inventory_from_string(txt)
418
378
self.assertEqual(5, len(inv2))
419
379
for path, ie in inv.iter_entries():
420
self.assertEqual(ie, inv2[ie.file_id])
380
self.assertEqual(ie, inv2.get_entry(ie.file_id))
422
382
def test_roundtrip_inventory_v6(self):
423
383
inv = self.get_sample_inventory()
424
384
txt = xml6.serializer_v6.write_inventory_to_string(inv)
425
385
lines = xml6.serializer_v6.write_inventory_to_lines(inv)
426
self.assertEqual(bzrlib.osutils.split_lines(txt), lines)
386
self.assertEqual(breezy.osutils.split_lines(txt), lines)
427
387
self.assertEqualDiff(_expected_inv_v6, txt)
428
388
inv2 = xml6.serializer_v6.read_inventory_from_string(txt)
429
389
self.assertEqual(4, len(inv2))
430
390
for path, ie in inv.iter_entries():
431
self.assertEqual(ie, inv2[ie.file_id])
391
self.assertEqual(ie, inv2.get_entry(ie.file_id))
433
393
def test_wrong_format_v7(self):
434
394
"""Can't accidentally open a file with wrong serializer"""
435
s_v6 = bzrlib.xml6.serializer_v6
395
s_v6 = breezy.bzr.xml6.serializer_v6
436
396
s_v7 = xml7.serializer_v7
437
397
self.assertRaises(errors.UnexpectedInventoryFormat,
438
398
s_v7.read_inventory_from_string, _expected_inv_v5)
440
400
s_v6.read_inventory_from_string, _expected_inv_v7)
442
402
def test_tree_reference(self):
443
s_v5 = bzrlib.xml5.serializer_v5
444
s_v6 = bzrlib.xml6.serializer_v6
403
s_v5 = breezy.bzr.xml5.serializer_v5
404
s_v6 = breezy.bzr.xml6.serializer_v6
445
405
s_v7 = xml7.serializer_v7
446
inv = Inventory('tree-root-321', revision_id='rev-outer')
447
inv.root.revision = 'root-rev'
448
inv.add(inventory.TreeReference('nested-id', 'nested', 'tree-root-321',
449
'rev-outer', 'rev-inner'))
406
inv = Inventory(b'tree-root-321', revision_id=b'rev-outer')
407
inv.root.revision = b'root-rev'
408
inv.add(inventory.TreeReference(b'nested-id', 'nested', b'tree-root-321',
409
b'rev-outer', b'rev-inner'))
450
410
self.assertRaises(errors.UnsupportedInventoryKind,
451
411
s_v5.write_inventory_to_string, inv)
452
412
self.assertRaises(errors.UnsupportedInventoryKind,
453
413
s_v6.write_inventory_to_string, inv)
454
414
txt = s_v7.write_inventory_to_string(inv)
455
415
lines = s_v7.write_inventory_to_lines(inv)
456
self.assertEqual(bzrlib.osutils.split_lines(txt), lines)
416
self.assertEqual(breezy.osutils.split_lines(txt), lines)
457
417
inv2 = s_v7.read_inventory_from_string(txt)
458
self.assertEqual('tree-root-321', inv2['nested-id'].parent_id)
459
self.assertEqual('rev-outer', inv2['nested-id'].revision)
460
self.assertEqual('rev-inner', inv2['nested-id'].reference_revision)
461
self.assertRaises(errors.UnsupportedInventoryKind,
462
s_v6.read_inventory_from_string,
463
txt.replace('format="7"', 'format="6"'))
464
self.assertRaises(errors.UnsupportedInventoryKind,
465
s_v5.read_inventory_from_string,
466
txt.replace('format="7"', 'format="5"'))
418
self.assertEqual(b'tree-root-321', inv2.get_entry(b'nested-id').parent_id)
419
self.assertEqual(b'rev-outer', inv2.get_entry(b'nested-id').revision)
420
self.assertEqual(b'rev-inner', inv2.get_entry(b'nested-id').reference_revision)
468
422
def test_roundtrip_inventory_v8(self):
469
423
inv = self.get_sample_inventory()
471
425
inv2 = xml8.serializer_v8.read_inventory_from_string(txt)
472
426
self.assertEqual(4, len(inv2))
473
427
for path, ie in inv.iter_entries():
474
self.assertEqual(ie, inv2[ie.file_id])
428
self.assertEqual(ie, inv2.get_entry(ie.file_id))
476
430
def test_inventory_text_v8(self):
477
431
inv = self.get_sample_inventory()
478
432
txt = xml8.serializer_v8.write_inventory_to_string(inv)
479
433
lines = xml8.serializer_v8.write_inventory_to_lines(inv)
480
self.assertEqual(bzrlib.osutils.split_lines(txt), lines)
434
self.assertEqual(breezy.osutils.split_lines(txt), lines)
481
435
self.assertEqualDiff(_expected_inv_v8, txt)
483
437
def test_revision_text_v6(self):
484
438
"""Pack revision to XML v6"""
485
rev = bzrlib.xml6.serializer_v6.read_revision_from_string(
439
rev = breezy.bzr.xml6.serializer_v6.read_revision_from_string(
486
440
_expected_rev_v5)
487
serialized = bzrlib.xml6.serializer_v6.write_revision_to_string(rev)
441
serialized = breezy.bzr.xml6.serializer_v6.write_revision_to_string(rev)
488
442
self.assertEqualDiff(serialized, _expected_rev_v5)
490
444
def test_revision_text_v7(self):
491
445
"""Pack revision to XML v7"""
492
rev = bzrlib.xml7.serializer_v7.read_revision_from_string(
446
rev = breezy.bzr.xml7.serializer_v7.read_revision_from_string(
493
447
_expected_rev_v5)
494
serialized = bzrlib.xml7.serializer_v7.write_revision_to_string(rev)
448
serialized = breezy.bzr.xml7.serializer_v7.write_revision_to_string(rev)
495
449
self.assertEqualDiff(serialized, _expected_rev_v5)
497
451
def test_revision_text_v8(self):
498
452
"""Pack revision to XML v8"""
499
rev = bzrlib.xml8.serializer_v8.read_revision_from_string(
453
rev = breezy.bzr.xml8.serializer_v8.read_revision_from_string(
500
454
_expected_rev_v8)
501
serialized = bzrlib.xml8.serializer_v8.write_revision_to_string(rev)
455
serialized = breezy.bzr.xml8.serializer_v8.write_revision_to_string(rev)
502
456
self.assertEqualDiff(serialized, _expected_rev_v8)
504
458
def test_revision_ids_are_utf8(self):
505
459
"""Parsed revision_ids should all be utf-8 strings, not unicode."""
506
s_v5 = bzrlib.xml5.serializer_v5
460
s_v5 = breezy.bzr.xml5.serializer_v5
507
461
rev = s_v5.read_revision_from_string(_revision_utf8_v5)
508
462
self.assertEqual('erik@b\xc3\xa5gfors-02', rev.revision_id)
509
463
self.assertIsInstance(rev.revision_id, str)
550
504
"""Whitebox testing of the _encode_and_escape function."""
507
super(TestEncodeAndEscape, self).setUp()
554
508
# Keep the cache clear before and after the test
555
bzrlib.xml8._ensure_utf8_re()
556
bzrlib.xml8._clear_cache()
557
self.addCleanup(bzrlib.xml8._clear_cache)
509
breezy.bzr.xml_serializer._clear_cache()
510
self.addCleanup(breezy.bzr.xml_serializer._clear_cache)
559
512
def test_simple_ascii(self):
560
513
# _encode_and_escape always appends a final ", because these parameters
561
514
# are being used in xml attributes, and by returning it now, we have to
562
515
# do fewer string operations later.
563
val = bzrlib.xml8._encode_and_escape('foo bar')
516
val = breezy.bzr.xml_serializer.encode_and_escape('foo bar')
564
517
self.assertEqual('foo bar"', val)
565
518
# The second time should be cached
566
val2 = bzrlib.xml8._encode_and_escape('foo bar')
519
val2 = breezy.bzr.xml_serializer.encode_and_escape('foo bar')
567
520
self.assertIs(val2, val)
569
522
def test_ascii_with_xml(self):
570
523
self.assertEqual('&'"<>"',
571
bzrlib.xml8._encode_and_escape('&\'"<>'))
524
breezy.bzr.xml_serializer.encode_and_escape('&\'"<>'))
573
526
def test_utf8_with_xml(self):
574
527
# u'\xb5\xe5&\u062c'
575
528
utf8_str = '\xc2\xb5\xc3\xa5&\xd8\xac'
576
529
self.assertEqual('µå&ج"',
577
bzrlib.xml8._encode_and_escape(utf8_str))
530
breezy.bzr.xml_serializer.encode_and_escape(utf8_str))
579
532
def test_unicode(self):
580
533
uni_str = u'\xb5\xe5&\u062c'
581
534
self.assertEqual('µå&ج"',
582
bzrlib.xml8._encode_and_escape(uni_str))
535
breezy.bzr.xml_serializer.encode_and_escape(uni_str))
538
class TestMisc(TestCase):
540
def test_unescape_xml(self):
541
"""We get some kind of error when malformed entities are passed"""
542
self.assertRaises(KeyError, breezy.bzr.xml8._unescape_xml, 'foo&bar;')