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