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