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