218
215
class TestSerializer(TestCase):
219
216
"""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
218
def test_unpack_revision_5(self):
242
219
"""Test unpacking a canned revision v5"""
243
inp = StringIO(_revision_v5)
244
rev = bzrlib.xml5.serializer_v5.read_revision(inp)
220
inp = BytesIO(_revision_v5)
221
rev = breezy.bzr.xml5.serializer_v5.read_revision(inp)
245
222
eq = self.assertEqual
246
223
eq(rev.committer,
247
224
"Martin Pool <mbp@sourcefrog.net>")
248
225
eq(len(rev.parent_ids), 1)
249
226
eq(rev.timezone, 36000)
250
227
eq(rev.parent_ids[0],
251
"mbp@sourcefrog.net-20050905063503-43948f59fa127d92")
228
b"mbp@sourcefrog.net-20050905063503-43948f59fa127d92")
253
230
def test_unpack_revision_5_utc(self):
254
inp = StringIO(_revision_v5_utc)
255
rev = bzrlib.xml5.serializer_v5.read_revision(inp)
231
inp = BytesIO(_revision_v5_utc)
232
rev = breezy.bzr.xml5.serializer_v5.read_revision(inp)
256
233
eq = self.assertEqual
257
234
eq(rev.committer,
258
235
"Martin Pool <mbp@sourcefrog.net>")
259
236
eq(len(rev.parent_ids), 1)
260
237
eq(rev.timezone, 0)
261
238
eq(rev.parent_ids[0],
262
"mbp@sourcefrog.net-20050905063503-43948f59fa127d92")
239
b"mbp@sourcefrog.net-20050905063503-43948f59fa127d92")
264
241
def test_unpack_inventory_5(self):
265
242
"""Unpack canned new-style inventory"""
266
inp = StringIO(_committed_inv_v5)
267
inv = bzrlib.xml5.serializer_v5.read_inventory(inp)
243
inp = BytesIO(_committed_inv_v5)
244
inv = breezy.bzr.xml5.serializer_v5.read_inventory(inp)
268
245
eq = self.assertEqual
270
ie = inv['bar-20050824000535-6bc48cfad47ed134']
247
ie = inv.get_entry(b'bar-20050824000535-6bc48cfad47ed134')
271
248
eq(ie.kind, 'file')
272
eq(ie.revision, 'mbp@foo-00')
249
eq(ie.revision, b'mbp@foo-00')
273
250
eq(ie.name, 'bar')
274
eq(inv[ie.parent_id].kind, 'directory')
251
eq(inv.get_entry(ie.parent_id).kind, 'directory')
276
253
def test_unpack_basis_inventory_5(self):
277
254
"""Unpack canned new-style inventory"""
278
inp = StringIO(_basis_inv_v5)
279
inv = bzrlib.xml5.serializer_v5.read_inventory(inp)
255
inv = breezy.bzr.xml5.serializer_v5.read_inventory_from_lines(
256
breezy.osutils.split_lines(_basis_inv_v5))
280
257
eq = self.assertEqual
282
eq(inv.revision_id, 'mbp@sourcefrog.net-20050905063503-43948f59fa127d92')
283
ie = inv['bar-20050824000535-6bc48cfad47ed134']
260
b'mbp@sourcefrog.net-20050905063503-43948f59fa127d92')
261
ie = inv.get_entry(b'bar-20050824000535-6bc48cfad47ed134')
284
262
eq(ie.kind, 'file')
285
eq(ie.revision, 'mbp@foo-00')
263
eq(ie.revision, b'mbp@foo-00')
286
264
eq(ie.name, 'bar')
287
eq(inv[ie.parent_id].kind, 'directory')
265
eq(inv.get_entry(ie.parent_id).kind, 'directory')
289
267
def test_unpack_inventory_5a(self):
290
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(
291
_inventory_v5a, revision_id='test-rev-id')
292
self.assertEqual('test-rev-id', inv.root.revision)
268
inv = breezy.bzr.xml5.serializer_v5.read_inventory_from_lines(
269
breezy.osutils.split_lines(_inventory_v5a), revision_id=b'test-rev-id')
270
self.assertEqual(b'test-rev-id', inv.root.revision)
294
272
def test_unpack_inventory_5a_cache_and_copy(self):
295
273
# Passing an entry_cache should get populated with the objects
296
274
# But the returned objects should be copies if return_from_cache is
298
276
entry_cache = fifo_cache.FIFOCache()
299
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(
300
_inventory_v5a, revision_id='test-rev-id',
277
inv = breezy.bzr.xml5.serializer_v5.read_inventory_from_lines(
278
breezy.osutils.split_lines(_inventory_v5a), revision_id=b'test-rev-id',
301
279
entry_cache=entry_cache, return_from_cache=False)
302
280
for entry in inv.iter_just_entries():
303
281
key = (entry.file_id, entry.revision)
372
351
def test_pack_revision_5(self):
373
352
"""Pack revision to XML v5"""
374
353
# 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)
378
outfile_contents = outp.getvalue()
379
self.assertEqual(outfile_contents[-1], '\n')
380
self.assertEqualDiff(outfile_contents, bzrlib.xml5.serializer_v5.write_revision_to_string(rev))
354
rev = breezy.bzr.xml5.serializer_v5.read_revision_from_string(
356
outfile_contents = breezy.bzr.xml5.serializer_v5.write_revision_to_string(rev)
357
self.assertEqual(outfile_contents[-1:], b'\n')
358
self.assertEqualDiff(
360
b''.join(breezy.bzr.xml5.serializer_v5.write_revision_to_lines(rev)))
381
361
self.assertEqualDiff(outfile_contents, _expected_rev_v5)
383
363
def test_empty_property_value(self):
384
364
"""Create an empty property value check that it serializes correctly"""
385
s_v5 = bzrlib.xml5.serializer_v5
365
s_v5 = breezy.bzr.xml5.serializer_v5
386
366
rev = s_v5.read_revision_from_string(_revision_v5)
388
props = {'empty':'', 'one':'one'}
367
props = {'empty': '', 'one': 'one'}
389
368
rev.properties = props
390
txt = s_v5.write_revision_to_string(rev)
369
txt = b''.join(s_v5.write_revision_to_lines(rev))
391
370
new_rev = s_v5.read_revision_from_string(txt)
392
371
self.assertEqual(props, new_rev.properties)
394
373
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'
374
inv = Inventory(b'tree-root-321', revision_id=b'rev_outer')
375
inv.add(inventory.InventoryFile(b'file-id', 'file', b'tree-root-321'))
376
inv.add(inventory.InventoryDirectory(b'dir-id', 'dir',
378
inv.add(inventory.InventoryLink(b'link-id', 'link', b'tree-root-321'))
379
inv.get_entry(b'tree-root-321').revision = b'rev_outer'
380
inv.get_entry(b'dir-id').revision = b'rev_outer'
381
inv.get_entry(b'file-id').revision = b'rev_outer'
382
inv.get_entry(b'file-id').text_sha1 = b'A'
383
inv.get_entry(b'file-id').text_size = 1
384
inv.get_entry(b'link-id').revision = b'rev_outer'
385
inv.get_entry(b'link-id').symlink_target = 'a'
409
388
def test_roundtrip_inventory_v7(self):
410
389
inv = self.get_sample_inventory()
411
inv.add(inventory.TreeReference('nested-id', 'nested', 'tree-root-321',
412
'rev_outer', 'rev_inner'))
413
txt = xml7.serializer_v7.write_inventory_to_string(inv)
390
inv.add(inventory.TreeReference(b'nested-id', 'nested', b'tree-root-321',
391
b'rev_outer', b'rev_inner'))
414
392
lines = xml7.serializer_v7.write_inventory_to_lines(inv)
415
self.assertEqual(bzrlib.osutils.split_lines(txt), lines)
416
self.assertEqualDiff(_expected_inv_v7, txt)
417
inv2 = xml7.serializer_v7.read_inventory_from_string(txt)
393
self.assertEqualDiff(_expected_inv_v7, b''.join(lines))
394
inv2 = xml7.serializer_v7.read_inventory_from_lines(lines)
418
395
self.assertEqual(5, len(inv2))
419
396
for path, ie in inv.iter_entries():
420
self.assertEqual(ie, inv2[ie.file_id])
397
self.assertEqual(ie, inv2.get_entry(ie.file_id))
422
399
def test_roundtrip_inventory_v6(self):
423
400
inv = self.get_sample_inventory()
424
txt = xml6.serializer_v6.write_inventory_to_string(inv)
425
401
lines = xml6.serializer_v6.write_inventory_to_lines(inv)
426
self.assertEqual(bzrlib.osutils.split_lines(txt), lines)
427
self.assertEqualDiff(_expected_inv_v6, txt)
428
inv2 = xml6.serializer_v6.read_inventory_from_string(txt)
402
self.assertEqualDiff(_expected_inv_v6, b''.join(lines))
403
inv2 = xml6.serializer_v6.read_inventory_from_lines(lines)
429
404
self.assertEqual(4, len(inv2))
430
405
for path, ie in inv.iter_entries():
431
self.assertEqual(ie, inv2[ie.file_id])
406
self.assertEqual(ie, inv2.get_entry(ie.file_id))
433
408
def test_wrong_format_v7(self):
434
409
"""Can't accidentally open a file with wrong serializer"""
435
s_v6 = bzrlib.xml6.serializer_v6
410
s_v6 = breezy.bzr.xml6.serializer_v6
436
411
s_v7 = xml7.serializer_v7
437
412
self.assertRaises(errors.UnexpectedInventoryFormat,
438
s_v7.read_inventory_from_string, _expected_inv_v5)
413
s_v7.read_inventory_from_lines,
414
breezy.osutils.split_lines(_expected_inv_v5))
439
415
self.assertRaises(errors.UnexpectedInventoryFormat,
440
s_v6.read_inventory_from_string, _expected_inv_v7)
416
s_v6.read_inventory_from_lines,
417
breezy.osutils.split_lines(_expected_inv_v7))
442
419
def test_tree_reference(self):
443
s_v5 = bzrlib.xml5.serializer_v5
444
s_v6 = bzrlib.xml6.serializer_v6
420
s_v5 = breezy.bzr.xml5.serializer_v5
421
s_v6 = breezy.bzr.xml6.serializer_v6
445
422
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'))
450
self.assertRaises(errors.UnsupportedInventoryKind,
451
s_v5.write_inventory_to_string, inv)
452
self.assertRaises(errors.UnsupportedInventoryKind,
453
s_v6.write_inventory_to_string, inv)
454
txt = s_v7.write_inventory_to_string(inv)
455
lines = s_v7.write_inventory_to_lines(inv)
456
self.assertEqual(bzrlib.osutils.split_lines(txt), lines)
457
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"'))
423
inv = Inventory(b'tree-root-321', revision_id=b'rev-outer')
424
inv.root.revision = b'root-rev'
425
inv.add(inventory.TreeReference(b'nested-id', 'nested', b'tree-root-321',
426
b'rev-outer', b'rev-inner'))
427
self.assertRaises(errors.UnsupportedInventoryKind,
428
s_v5.write_inventory_to_lines, inv)
429
self.assertRaises(errors.UnsupportedInventoryKind,
430
s_v6.write_inventory_to_lines, inv)
431
lines = s_v7.write_inventory_to_chunks(inv)
432
inv2 = s_v7.read_inventory_from_lines(lines)
433
self.assertEqual(b'tree-root-321',
434
inv2.get_entry(b'nested-id').parent_id)
435
self.assertEqual(b'rev-outer', inv2.get_entry(b'nested-id').revision)
437
b'rev-inner', inv2.get_entry(b'nested-id').reference_revision)
468
439
def test_roundtrip_inventory_v8(self):
469
440
inv = self.get_sample_inventory()
470
txt = xml8.serializer_v8.write_inventory_to_string(inv)
471
inv2 = xml8.serializer_v8.read_inventory_from_string(txt)
441
lines = xml8.serializer_v8.write_inventory_to_lines(inv)
442
inv2 = xml8.serializer_v8.read_inventory_from_lines(lines)
472
443
self.assertEqual(4, len(inv2))
473
444
for path, ie in inv.iter_entries():
474
self.assertEqual(ie, inv2[ie.file_id])
445
self.assertEqual(ie, inv2.get_entry(ie.file_id))
476
447
def test_inventory_text_v8(self):
477
448
inv = self.get_sample_inventory()
478
txt = xml8.serializer_v8.write_inventory_to_string(inv)
479
449
lines = xml8.serializer_v8.write_inventory_to_lines(inv)
480
self.assertEqual(bzrlib.osutils.split_lines(txt), lines)
481
self.assertEqualDiff(_expected_inv_v8, txt)
450
self.assertEqualDiff(_expected_inv_v8, b''.join(lines))
483
452
def test_revision_text_v6(self):
484
453
"""Pack revision to XML v6"""
485
rev = bzrlib.xml6.serializer_v6.read_revision_from_string(
454
rev = breezy.bzr.xml6.serializer_v6.read_revision_from_string(
486
455
_expected_rev_v5)
487
serialized = bzrlib.xml6.serializer_v6.write_revision_to_string(rev)
488
self.assertEqualDiff(serialized, _expected_rev_v5)
456
serialized = breezy.bzr.xml6.serializer_v6.write_revision_to_lines(
458
self.assertEqualDiff(b''.join(serialized), _expected_rev_v5)
490
460
def test_revision_text_v7(self):
491
461
"""Pack revision to XML v7"""
492
rev = bzrlib.xml7.serializer_v7.read_revision_from_string(
462
rev = breezy.bzr.xml7.serializer_v7.read_revision_from_string(
493
463
_expected_rev_v5)
494
serialized = bzrlib.xml7.serializer_v7.write_revision_to_string(rev)
495
self.assertEqualDiff(serialized, _expected_rev_v5)
464
serialized = breezy.bzr.xml7.serializer_v7.write_revision_to_lines(
466
self.assertEqualDiff(b''.join(serialized), _expected_rev_v5)
497
468
def test_revision_text_v8(self):
498
469
"""Pack revision to XML v8"""
499
rev = bzrlib.xml8.serializer_v8.read_revision_from_string(
470
rev = breezy.bzr.xml8.serializer_v8.read_revision_from_string(
500
471
_expected_rev_v8)
501
serialized = bzrlib.xml8.serializer_v8.write_revision_to_string(rev)
502
self.assertEqualDiff(serialized, _expected_rev_v8)
472
serialized = breezy.bzr.xml8.serializer_v8.write_revision_to_lines(
474
self.assertEqualDiff(b''.join(serialized), _expected_rev_v8)
476
def test_revision_text_v8_complex(self):
477
"""Pack revision to XML v8"""
478
rev = breezy.bzr.xml8.serializer_v8.read_revision_from_string(
479
_expected_rev_v8_complex)
480
serialized = breezy.bzr.xml8.serializer_v8.write_revision_to_lines(
482
self.assertEqualDiff(b''.join(serialized), _expected_rev_v8_complex)
504
484
def test_revision_ids_are_utf8(self):
505
485
"""Parsed revision_ids should all be utf-8 strings, not unicode."""
506
s_v5 = bzrlib.xml5.serializer_v5
486
s_v5 = breezy.bzr.xml5.serializer_v5
507
487
rev = s_v5.read_revision_from_string(_revision_utf8_v5)
508
self.assertEqual('erik@b\xc3\xa5gfors-02', rev.revision_id)
509
self.assertIsInstance(rev.revision_id, str)
510
self.assertEqual(['erik@b\xc3\xa5gfors-01'], rev.parent_ids)
488
self.assertEqual(b'erik@b\xc3\xa5gfors-02', rev.revision_id)
489
self.assertIsInstance(rev.revision_id, bytes)
490
self.assertEqual([b'erik@b\xc3\xa5gfors-01'], rev.parent_ids)
511
491
for parent_id in rev.parent_ids:
512
self.assertIsInstance(parent_id, str)
492
self.assertIsInstance(parent_id, bytes)
513
493
self.assertEqual(u'Include \xb5nicode characters\n', rev.message)
514
self.assertIsInstance(rev.message, unicode)
494
self.assertIsInstance(rev.message, text_type)
516
496
# ie.revision should either be None or a utf-8 revision id
517
inv = s_v5.read_inventory_from_string(_inventory_utf8_v5)
497
inv = s_v5.read_inventory_from_lines(breezy.osutils.split_lines(_inventory_utf8_v5))
518
498
rev_id_1 = u'erik@b\xe5gfors-01'.encode('utf8')
519
499
rev_id_2 = u'erik@b\xe5gfors-02'.encode('utf8')
520
500
fid_root = u'TRE\xe9_ROOT'.encode('utf8')
525
505
(u'b\xe5r', fid_bar1, fid_root, rev_id_1),
526
506
(u's\xb5bdir', fid_sub, fid_root, rev_id_1),
527
507
(u's\xb5bdir/b\xe5r', fid_bar2, fid_sub, rev_id_2),
529
509
self.assertEqual(rev_id_2, inv.revision_id)
530
self.assertIsInstance(inv.revision_id, str)
510
self.assertIsInstance(inv.revision_id, bytes)
532
512
actual = list(inv.iter_entries_by_dir())
533
513
for ((exp_path, exp_file_id, exp_parent_id, exp_rev_id),
534
514
(act_path, act_ie)) in zip(expected, actual):
535
515
self.assertEqual(exp_path, act_path)
536
self.assertIsInstance(act_path, unicode)
516
self.assertIsInstance(act_path, text_type)
537
517
self.assertEqual(exp_file_id, act_ie.file_id)
538
self.assertIsInstance(act_ie.file_id, str)
518
self.assertIsInstance(act_ie.file_id, bytes)
539
519
self.assertEqual(exp_parent_id, act_ie.parent_id)
540
520
if exp_parent_id is not None:
541
self.assertIsInstance(act_ie.parent_id, str)
521
self.assertIsInstance(act_ie.parent_id, bytes)
542
522
self.assertEqual(exp_rev_id, act_ie.revision)
543
523
if exp_rev_id is not None:
544
self.assertIsInstance(act_ie.revision, str)
524
self.assertIsInstance(act_ie.revision, bytes)
546
526
self.assertEqual(len(expected), len(actual))
528
def test_serialization_error(self):
529
s_v5 = breezy.bzr.xml5.serializer_v5
530
e = self.assertRaises(
531
errors.UnexpectedInventoryFormat,
532
s_v5.read_inventory_from_lines, [b"<Notquitexml"])
533
self.assertEqual(str(e), "unclosed token: line 1, column 0")
549
536
class TestEncodeAndEscape(TestCase):
550
537
"""Whitebox testing of the _encode_and_escape function."""
540
super(TestEncodeAndEscape, self).setUp()
554
541
# 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)
542
breezy.bzr.xml_serializer._clear_cache()
543
self.addCleanup(breezy.bzr.xml_serializer._clear_cache)
559
545
def test_simple_ascii(self):
560
546
# _encode_and_escape always appends a final ", because these parameters
561
547
# are being used in xml attributes, and by returning it now, we have to
562
548
# do fewer string operations later.
563
val = bzrlib.xml8._encode_and_escape('foo bar')
564
self.assertEqual('foo bar"', val)
549
val = breezy.bzr.xml_serializer.encode_and_escape('foo bar')
550
self.assertEqual(b'foo bar', val)
565
551
# The second time should be cached
566
val2 = bzrlib.xml8._encode_and_escape('foo bar')
552
val2 = breezy.bzr.xml_serializer.encode_and_escape('foo bar')
567
553
self.assertIs(val2, val)
569
555
def test_ascii_with_xml(self):
570
self.assertEqual('&'"<>"',
571
bzrlib.xml8._encode_and_escape('&\'"<>'))
556
self.assertEqual(b'&'"<>',
557
breezy.bzr.xml_serializer.encode_and_escape('&\'"<>'))
573
559
def test_utf8_with_xml(self):
574
560
# u'\xb5\xe5&\u062c'
575
utf8_str = '\xc2\xb5\xc3\xa5&\xd8\xac'
576
self.assertEqual('µå&ج"',
577
bzrlib.xml8._encode_and_escape(utf8_str))
561
utf8_str = b'\xc2\xb5\xc3\xa5&\xd8\xac'
562
self.assertEqual(b'µå&ج',
563
breezy.bzr.xml_serializer.encode_and_escape(utf8_str))
579
565
def test_unicode(self):
580
566
uni_str = u'\xb5\xe5&\u062c'
581
self.assertEqual('µå&ج"',
582
bzrlib.xml8._encode_and_escape(uni_str))
567
self.assertEqual(b'µå&ج',
568
breezy.bzr.xml_serializer.encode_and_escape(uni_str))
571
class TestMisc(TestCase):
573
def test_unescape_xml(self):
574
"""We get some kind of error when malformed entities are passed"""
575
self.assertRaises(KeyError, breezy.bzr.xml8._unescape_xml, b'foo&bar;')