17
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" />
27
from brzlib.tests import TestCase
28
from brzlib.inventory import Inventory
55
31
_revision_v5 = """<revision committer="Martin Pool <mbp@sourcefrog.net>"
56
32
inventory_sha1="e79c31c1deb64c163cf660fdedd476dd579ffd41"
218
194
class TestSerializer(TestCase):
219
195
"""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
197
def test_unpack_revision_5(self):
242
198
"""Test unpacking a canned revision v5"""
243
199
inp = StringIO(_revision_v5)
244
rev = bzrlib.xml5.serializer_v5.read_revision(inp)
200
rev = brzlib.xml5.serializer_v5.read_revision(inp)
245
201
eq = self.assertEqual
246
202
eq(rev.committer,
247
203
"Martin Pool <mbp@sourcefrog.net>")
253
209
def test_unpack_revision_5_utc(self):
254
210
inp = StringIO(_revision_v5_utc)
255
rev = bzrlib.xml5.serializer_v5.read_revision(inp)
211
rev = brzlib.xml5.serializer_v5.read_revision(inp)
256
212
eq = self.assertEqual
257
213
eq(rev.committer,
258
214
"Martin Pool <mbp@sourcefrog.net>")
264
220
def test_unpack_inventory_5(self):
265
221
"""Unpack canned new-style inventory"""
266
222
inp = StringIO(_committed_inv_v5)
267
inv = bzrlib.xml5.serializer_v5.read_inventory(inp)
223
inv = brzlib.xml5.serializer_v5.read_inventory(inp)
268
224
eq = self.assertEqual
270
226
ie = inv['bar-20050824000535-6bc48cfad47ed134']
276
232
def test_unpack_basis_inventory_5(self):
277
233
"""Unpack canned new-style inventory"""
278
234
inp = StringIO(_basis_inv_v5)
279
inv = bzrlib.xml5.serializer_v5.read_inventory(inp)
235
inv = brzlib.xml5.serializer_v5.read_inventory(inp)
280
236
eq = self.assertEqual
282
238
eq(inv.revision_id, 'mbp@sourcefrog.net-20050905063503-43948f59fa127d92')
287
243
eq(inv[ie.parent_id].kind, 'directory')
289
245
def test_unpack_inventory_5a(self):
290
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(
246
inv = brzlib.xml5.serializer_v5.read_inventory_from_string(
291
247
_inventory_v5a, revision_id='test-rev-id')
292
248
self.assertEqual('test-rev-id', inv.root.revision)
296
252
# But the returned objects should be copies if return_from_cache is
298
254
entry_cache = fifo_cache.FIFOCache()
299
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(
255
inv = brzlib.xml5.serializer_v5.read_inventory_from_string(
300
256
_inventory_v5a, revision_id='test-rev-id',
301
257
entry_cache=entry_cache, return_from_cache=False)
302
258
for entry in inv.iter_just_entries():
312
268
# The returned objects should be exact if return_from_cache is
314
270
entry_cache = fifo_cache.FIFOCache()
315
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(
271
inv = brzlib.xml5.serializer_v5.read_inventory_from_string(
316
272
_inventory_v5a, revision_id='test-rev-id',
317
273
entry_cache=entry_cache, return_from_cache=True)
318
274
for entry in inv.iter_just_entries():
324
280
self.assertIs(entry, entry_cache[key])
326
282
def test_unpack_inventory_5b(self):
327
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(
283
inv = brzlib.xml5.serializer_v5.read_inventory_from_string(
328
284
_inventory_v5b, revision_id='test-rev-id')
329
285
self.assertEqual('a-rev-id', inv.root.revision)
331
287
def test_repack_inventory_5(self):
332
288
inp = StringIO(_committed_inv_v5)
333
inv = bzrlib.xml5.serializer_v5.read_inventory(inp)
289
inv = brzlib.xml5.serializer_v5.read_inventory(inp)
334
290
outp = StringIO()
335
bzrlib.xml5.serializer_v5.write_inventory(inv, outp)
291
brzlib.xml5.serializer_v5.write_inventory(inv, outp)
336
292
self.assertEqualDiff(_expected_inv_v5, outp.getvalue())
337
inv2 = bzrlib.xml5.serializer_v5.read_inventory(StringIO(outp.getvalue()))
293
inv2 = brzlib.xml5.serializer_v5.read_inventory(StringIO(outp.getvalue()))
338
294
self.assertEqual(inv, inv2)
340
296
def assertRoundTrips(self, xml_string):
341
297
inp = StringIO(xml_string)
342
inv = bzrlib.xml5.serializer_v5.read_inventory(inp)
298
inv = brzlib.xml5.serializer_v5.read_inventory(inp)
343
299
outp = StringIO()
344
bzrlib.xml5.serializer_v5.write_inventory(inv, outp)
300
brzlib.xml5.serializer_v5.write_inventory(inv, outp)
345
301
self.assertEqualDiff(xml_string, outp.getvalue())
346
lines = bzrlib.xml5.serializer_v5.write_inventory_to_lines(inv)
302
lines = brzlib.xml5.serializer_v5.write_inventory_to_lines(inv)
348
304
self.assertEqual(outp.readlines(), lines)
349
inv2 = bzrlib.xml5.serializer_v5.read_inventory(StringIO(outp.getvalue()))
305
inv2 = brzlib.xml5.serializer_v5.read_inventory(StringIO(outp.getvalue()))
350
306
self.assertEqual(inv, inv2)
352
308
def tests_serialize_inventory_v5_with_root(self):
355
311
def check_repack_revision(self, txt):
356
312
"""Check that repacking a revision yields the same information"""
357
313
inp = StringIO(txt)
358
rev = bzrlib.xml5.serializer_v5.read_revision(inp)
314
rev = brzlib.xml5.serializer_v5.read_revision(inp)
359
315
outp = StringIO()
360
bzrlib.xml5.serializer_v5.write_revision(rev, outp)
316
brzlib.xml5.serializer_v5.write_revision(rev, outp)
361
317
outfile_contents = outp.getvalue()
362
rev2 = bzrlib.xml5.serializer_v5.read_revision(StringIO(outfile_contents))
318
rev2 = brzlib.xml5.serializer_v5.read_revision(StringIO(outfile_contents))
363
319
self.assertEqual(rev, rev2)
365
321
def test_repack_revision_5(self):
372
328
def test_pack_revision_5(self):
373
329
"""Pack revision to XML v5"""
374
330
# fixed 20051025, revisions should have final newline
375
rev = bzrlib.xml5.serializer_v5.read_revision_from_string(_revision_v5)
331
rev = brzlib.xml5.serializer_v5.read_revision_from_string(_revision_v5)
376
332
outp = StringIO()
377
bzrlib.xml5.serializer_v5.write_revision(rev, outp)
333
brzlib.xml5.serializer_v5.write_revision(rev, outp)
378
334
outfile_contents = outp.getvalue()
379
335
self.assertEqual(outfile_contents[-1], '\n')
380
self.assertEqualDiff(outfile_contents, bzrlib.xml5.serializer_v5.write_revision_to_string(rev))
336
self.assertEqualDiff(outfile_contents, brzlib.xml5.serializer_v5.write_revision_to_string(rev))
381
337
self.assertEqualDiff(outfile_contents, _expected_rev_v5)
383
339
def test_empty_property_value(self):
384
340
"""Create an empty property value check that it serializes correctly"""
385
s_v5 = bzrlib.xml5.serializer_v5
341
s_v5 = brzlib.xml5.serializer_v5
386
342
rev = s_v5.read_revision_from_string(_revision_v5)
387
343
outp = StringIO()
388
344
props = {'empty':'', 'one':'one'}
412
368
'rev_outer', 'rev_inner'))
413
369
txt = xml7.serializer_v7.write_inventory_to_string(inv)
414
370
lines = xml7.serializer_v7.write_inventory_to_lines(inv)
415
self.assertEqual(bzrlib.osutils.split_lines(txt), lines)
371
self.assertEqual(brzlib.osutils.split_lines(txt), lines)
416
372
self.assertEqualDiff(_expected_inv_v7, txt)
417
373
inv2 = xml7.serializer_v7.read_inventory_from_string(txt)
418
374
self.assertEqual(5, len(inv2))
423
379
inv = self.get_sample_inventory()
424
380
txt = xml6.serializer_v6.write_inventory_to_string(inv)
425
381
lines = xml6.serializer_v6.write_inventory_to_lines(inv)
426
self.assertEqual(bzrlib.osutils.split_lines(txt), lines)
382
self.assertEqual(brzlib.osutils.split_lines(txt), lines)
427
383
self.assertEqualDiff(_expected_inv_v6, txt)
428
384
inv2 = xml6.serializer_v6.read_inventory_from_string(txt)
429
385
self.assertEqual(4, len(inv2))
433
389
def test_wrong_format_v7(self):
434
390
"""Can't accidentally open a file with wrong serializer"""
435
s_v6 = bzrlib.xml6.serializer_v6
391
s_v6 = brzlib.xml6.serializer_v6
436
392
s_v7 = xml7.serializer_v7
437
393
self.assertRaises(errors.UnexpectedInventoryFormat,
438
394
s_v7.read_inventory_from_string, _expected_inv_v5)
440
396
s_v6.read_inventory_from_string, _expected_inv_v7)
442
398
def test_tree_reference(self):
443
s_v5 = bzrlib.xml5.serializer_v5
444
s_v6 = bzrlib.xml6.serializer_v6
399
s_v5 = brzlib.xml5.serializer_v5
400
s_v6 = brzlib.xml6.serializer_v6
445
401
s_v7 = xml7.serializer_v7
446
402
inv = Inventory('tree-root-321', revision_id='rev-outer')
447
403
inv.root.revision = 'root-rev'
453
409
s_v6.write_inventory_to_string, inv)
454
410
txt = s_v7.write_inventory_to_string(inv)
455
411
lines = s_v7.write_inventory_to_lines(inv)
456
self.assertEqual(bzrlib.osutils.split_lines(txt), lines)
412
self.assertEqual(brzlib.osutils.split_lines(txt), lines)
457
413
inv2 = s_v7.read_inventory_from_string(txt)
458
414
self.assertEqual('tree-root-321', inv2['nested-id'].parent_id)
459
415
self.assertEqual('rev-outer', inv2['nested-id'].revision)
460
416
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"'))
468
418
def test_roundtrip_inventory_v8(self):
469
419
inv = self.get_sample_inventory()
477
427
inv = self.get_sample_inventory()
478
428
txt = xml8.serializer_v8.write_inventory_to_string(inv)
479
429
lines = xml8.serializer_v8.write_inventory_to_lines(inv)
480
self.assertEqual(bzrlib.osutils.split_lines(txt), lines)
430
self.assertEqual(brzlib.osutils.split_lines(txt), lines)
481
431
self.assertEqualDiff(_expected_inv_v8, txt)
483
433
def test_revision_text_v6(self):
484
434
"""Pack revision to XML v6"""
485
rev = bzrlib.xml6.serializer_v6.read_revision_from_string(
435
rev = brzlib.xml6.serializer_v6.read_revision_from_string(
486
436
_expected_rev_v5)
487
serialized = bzrlib.xml6.serializer_v6.write_revision_to_string(rev)
437
serialized = brzlib.xml6.serializer_v6.write_revision_to_string(rev)
488
438
self.assertEqualDiff(serialized, _expected_rev_v5)
490
440
def test_revision_text_v7(self):
491
441
"""Pack revision to XML v7"""
492
rev = bzrlib.xml7.serializer_v7.read_revision_from_string(
442
rev = brzlib.xml7.serializer_v7.read_revision_from_string(
493
443
_expected_rev_v5)
494
serialized = bzrlib.xml7.serializer_v7.write_revision_to_string(rev)
444
serialized = brzlib.xml7.serializer_v7.write_revision_to_string(rev)
495
445
self.assertEqualDiff(serialized, _expected_rev_v5)
497
447
def test_revision_text_v8(self):
498
448
"""Pack revision to XML v8"""
499
rev = bzrlib.xml8.serializer_v8.read_revision_from_string(
449
rev = brzlib.xml8.serializer_v8.read_revision_from_string(
500
450
_expected_rev_v8)
501
serialized = bzrlib.xml8.serializer_v8.write_revision_to_string(rev)
451
serialized = brzlib.xml8.serializer_v8.write_revision_to_string(rev)
502
452
self.assertEqualDiff(serialized, _expected_rev_v8)
504
454
def test_revision_ids_are_utf8(self):
505
455
"""Parsed revision_ids should all be utf-8 strings, not unicode."""
506
s_v5 = bzrlib.xml5.serializer_v5
456
s_v5 = brzlib.xml5.serializer_v5
507
457
rev = s_v5.read_revision_from_string(_revision_utf8_v5)
508
458
self.assertEqual('erik@b\xc3\xa5gfors-02', rev.revision_id)
509
459
self.assertIsInstance(rev.revision_id, str)
550
500
"""Whitebox testing of the _encode_and_escape function."""
503
super(TestEncodeAndEscape, self).setUp()
554
504
# 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)
505
brzlib.xml_serializer._clear_cache()
506
self.addCleanup(brzlib.xml_serializer._clear_cache)
559
508
def test_simple_ascii(self):
560
509
# _encode_and_escape always appends a final ", because these parameters
561
510
# are being used in xml attributes, and by returning it now, we have to
562
511
# do fewer string operations later.
563
val = bzrlib.xml8._encode_and_escape('foo bar')
512
val = brzlib.xml_serializer.encode_and_escape('foo bar')
564
513
self.assertEqual('foo bar"', val)
565
514
# The second time should be cached
566
val2 = bzrlib.xml8._encode_and_escape('foo bar')
515
val2 = brzlib.xml_serializer.encode_and_escape('foo bar')
567
516
self.assertIs(val2, val)
569
518
def test_ascii_with_xml(self):
570
519
self.assertEqual('&'"<>"',
571
bzrlib.xml8._encode_and_escape('&\'"<>'))
520
brzlib.xml_serializer.encode_and_escape('&\'"<>'))
573
522
def test_utf8_with_xml(self):
574
523
# u'\xb5\xe5&\u062c'
575
524
utf8_str = '\xc2\xb5\xc3\xa5&\xd8\xac'
576
525
self.assertEqual('µå&ج"',
577
bzrlib.xml8._encode_and_escape(utf8_str))
526
brzlib.xml_serializer.encode_and_escape(utf8_str))
579
528
def test_unicode(self):
580
529
uni_str = u'\xb5\xe5&\u062c'
581
530
self.assertEqual('µå&ج"',
582
bzrlib.xml8._encode_and_escape(uni_str))
531
brzlib.xml_serializer.encode_and_escape(uni_str))
534
class TestMisc(TestCase):
536
def test_unescape_xml(self):
537
"""We get some kind of error when malformed entities are passed"""
538
self.assertRaises(KeyError, brzlib.xml8._unescape_xml, 'foo&bar;')