13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
17
from cStringIO import StringIO
19
27
from bzrlib.tests import TestCase
20
from bzrlib.inventory import Inventory, InventoryEntry
21
from bzrlib.xml4 import serializer_v4
28
from bzrlib.inventory import Inventory
24
_working_inventory_v4 = """<inventory file_id="TREE_ROOT">
25
<entry file_id="bar-20050901064931-73b4b1138abc9cd2" kind="file" name="bar" parent_id="TREE_ROOT" />
26
<entry file_id="foo-20050801201819-4139aa4a272f4250" kind="directory" name="foo" parent_id="TREE_ROOT" />
27
<entry file_id="bar-20050824000535-6bc48cfad47ed134" kind="file" name="bar" parent_id="foo-20050801201819-4139aa4a272f4250" />
31
_revision_v4 = """<revision committer="Martin Pool <mbp@sourcefrog.net>"
32
inventory_id="mbp@sourcefrog.net-20050905080035-e0439293f8b6b9f9"
33
inventory_sha1="e79c31c1deb64c163cf660fdedd476dd579ffd41"
34
revision_id="mbp@sourcefrog.net-20050905080035-e0439293f8b6b9f9"
35
timestamp="1125907235.212"
37
<message>- start splitting code for xml (de)serialization away from objects
38
preparatory to supporting multiple formats by a single library
41
<revision_ref revision_id="mbp@sourcefrog.net-20050905063503-43948f59fa127d92" revision_sha1="7bdf4cc8c5bdac739f8cf9b10b78cf4b68f915ff" />
46
31
_revision_v5 = """<revision committer="Martin Pool <mbp@sourcefrog.net>"
47
32
inventory_sha1="e79c31c1deb64c163cf660fdedd476dd579ffd41"
48
33
revision_id="mbp@sourcefrog.net-20050905080035-e0439293f8b6b9f9"
75
60
_committed_inv_v5 = """<inventory>
76
<file file_id="bar-20050901064931-73b4b1138abc9cd2"
77
name="bar" parent_id="TREE_ROOT"
78
revision="mbp@foo-123123"/>
61
<file file_id="bar-20050901064931-73b4b1138abc9cd2"
62
name="bar" parent_id="TREE_ROOT"
63
revision="mbp@foo-123123"
64
text_sha1="A" text_size="1"/>
79
65
<directory name="subdir"
80
66
file_id="foo-20050801201819-4139aa4a272f4250"
82
68
revision="mbp@foo-00"/>
83
<file executable="yes" file_id="bar-20050824000535-6bc48cfad47ed134"
84
name="bar" parent_id="foo-20050801201819-4139aa4a272f4250"
85
revision="mbp@foo-00"/>
69
<file executable="yes" file_id="bar-20050824000535-6bc48cfad47ed134"
70
name="bar" parent_id="foo-20050801201819-4139aa4a272f4250"
72
text_sha1="B" text_size="0"/>
89
76
_basis_inv_v5 = """<inventory revision_id="mbp@sourcefrog.net-20050905063503-43948f59fa127d92">
90
<file file_id="bar-20050901064931-73b4b1138abc9cd2"
91
name="bar" parent_id="TREE_ROOT"
77
<file file_id="bar-20050901064931-73b4b1138abc9cd2"
78
name="bar" parent_id="TREE_ROOT"
92
79
revision="mbp@foo-123123"/>
93
80
<directory name="subdir"
94
81
file_id="foo-20050801201819-4139aa4a272f4250"
96
83
revision="mbp@foo-00"/>
97
<file file_id="bar-20050824000535-6bc48cfad47ed134"
98
name="bar" parent_id="foo-20050801201819-4139aa4a272f4250"
84
<file file_id="bar-20050824000535-6bc48cfad47ed134"
85
name="bar" parent_id="foo-20050801201819-4139aa4a272f4250"
99
86
revision="mbp@foo-00"/>
116
103
# DO NOT REFLOW THIS. Its the exact inventory we want.
117
104
_expected_inv_v5 = """<inventory format="5">
118
<file file_id="bar-20050901064931-73b4b1138abc9cd2" name="bar" revision="mbp@foo-123123" />
105
<file file_id="bar-20050901064931-73b4b1138abc9cd2" name="bar" revision="mbp@foo-123123" text_sha1="A" text_size="1" />
119
106
<directory file_id="foo-20050801201819-4139aa4a272f4250" name="subdir" revision="mbp@foo-00" />
120
<file executable="yes" file_id="bar-20050824000535-6bc48cfad47ed134" name="bar" parent_id="foo-20050801201819-4139aa4a272f4250" revision="mbp@foo-00" />
107
<file executable="yes" file_id="bar-20050824000535-6bc48cfad47ed134" name="bar" parent_id="foo-20050801201819-4139aa4a272f4250" revision="mbp@foo-00" text_sha1="B" text_size="0" />
125
112
_expected_inv_v5_root = """<inventory file_id="f<" format="5" revision_id="mother!">
126
<file file_id="bar-20050901064931-73b4b1138abc9cd2" name="bar" parent_id="f<" revision="mbp@foo-123123" />
113
<file file_id="bar-20050901064931-73b4b1138abc9cd2" name="bar" parent_id="f<" revision="mbp@foo-123123" text_sha1="A" text_size="1" />
127
114
<directory file_id="foo-20050801201819-4139aa4a272f4250" name="subdir" parent_id="f<" revision="mbp@foo-00" />
128
<file executable="yes" file_id="bar-20050824000535-6bc48cfad47ed134" name="bar" parent_id="foo-20050801201819-4139aa4a272f4250" revision="mbp@foo-00" />
115
<file executable="yes" file_id="bar-20050824000535-6bc48cfad47ed134" name="bar" parent_id="foo-20050801201819-4139aa4a272f4250" revision="mbp@foo-00" text_sha1="B" text_size="0" />
116
<symlink file_id="link-1" name="link" parent_id="foo-20050801201819-4139aa4a272f4250" revision="mbp@foo-00" symlink_target="a" />
120
_expected_inv_v6 = """<inventory format="6" revision_id="rev_outer">
121
<directory file_id="tree-root-321" name="" revision="rev_outer" />
122
<directory file_id="dir-id" name="dir" parent_id="tree-root-321" revision="rev_outer" />
123
<file file_id="file-id" name="file" parent_id="tree-root-321" revision="rev_outer" text_sha1="A" text_size="1" />
124
<symlink file_id="link-id" name="link" parent_id="tree-root-321" revision="rev_outer" symlink_target="a" />
128
_expected_inv_v7 = """<inventory format="7" revision_id="rev_outer">
129
<directory file_id="tree-root-321" name="" revision="rev_outer" />
130
<directory file_id="dir-id" name="dir" parent_id="tree-root-321" revision="rev_outer" />
131
<file file_id="file-id" name="file" parent_id="tree-root-321" revision="rev_outer" text_sha1="A" text_size="1" />
132
<symlink file_id="link-id" name="link" parent_id="tree-root-321" revision="rev_outer" symlink_target="a" />
133
<tree-reference file_id="nested-id" name="nested" parent_id="tree-root-321" revision="rev_outer" reference_revision="rev_inner" />
137
_expected_rev_v8 = """<revision committer="Martin Pool <mbp@sourcefrog.net>" format="8" inventory_sha1="e79c31c1deb64c163cf660fdedd476dd579ffd41" revision_id="mbp@sourcefrog.net-20050905080035-e0439293f8b6b9f9" timestamp="1125907235.212" timezone="36000">
138
<message>- start splitting code for xml (de)serialization away from objects
139
preparatory to supporting multiple formats by a single library
142
<revision_ref revision_id="mbp@sourcefrog.net-20050905063503-43948f59fa127d92" />
147
_expected_inv_v8 = """<inventory format="8" revision_id="rev_outer">
148
<directory file_id="tree-root-321" name="" revision="rev_outer" />
149
<directory file_id="dir-id" name="dir" parent_id="tree-root-321" revision="rev_outer" />
150
<file file_id="file-id" name="file" parent_id="tree-root-321" revision="rev_outer" text_sha1="A" text_size="1" />
151
<symlink file_id="link-id" name="link" parent_id="tree-root-321" revision="rev_outer" symlink_target="a" />
133
155
_revision_utf8_v5 = """<revision committer="Erik Bågfors <erik@foo.net>"
134
156
inventory_sha1="e79c31c1deb64c163cf660fdedd476dd579ffd41"
183
# Before revision_id was always stored as an attribute
184
_inventory_v5a = """<inventory format="5">
188
# Before revision_id was always stored as an attribute
189
_inventory_v5b = """<inventory format="5" revision_id="a-rev-id">
162
194
class TestSerializer(TestCase):
163
195
"""Test XML serialization"""
164
def test_canned_inventory(self):
165
"""Test unpacked a canned inventory v4 file."""
166
inp = StringIO(_working_inventory_v4)
167
inv = serializer_v4.read_inventory(inp)
168
self.assertEqual(len(inv), 4)
169
self.assert_('bar-20050901064931-73b4b1138abc9cd2' in inv)
171
def test_unpack_revision(self):
172
"""Test unpacking a canned revision v4"""
173
inp = StringIO(_revision_v4)
174
rev = serializer_v4.read_revision(inp)
175
eq = self.assertEqual
177
"Martin Pool <mbp@sourcefrog.net>")
179
"mbp@sourcefrog.net-20050905080035-e0439293f8b6b9f9")
180
eq(len(rev.parent_ids), 1)
181
eq(rev.parent_ids[0],
182
"mbp@sourcefrog.net-20050905063503-43948f59fa127d92")
184
197
def test_unpack_revision_5(self):
185
198
"""Test unpacking a canned revision v5"""
229
242
eq(ie.name, 'bar')
230
243
eq(inv[ie.parent_id].kind, 'directory')
245
def test_unpack_inventory_5a(self):
246
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(
247
_inventory_v5a, revision_id='test-rev-id')
248
self.assertEqual('test-rev-id', inv.root.revision)
250
def test_unpack_inventory_5a_cache_and_copy(self):
251
# Passing an entry_cache should get populated with the objects
252
# But the returned objects should be copies if return_from_cache is
254
entry_cache = fifo_cache.FIFOCache()
255
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(
256
_inventory_v5a, revision_id='test-rev-id',
257
entry_cache=entry_cache, return_from_cache=False)
258
for entry in inv.iter_just_entries():
259
key = (entry.file_id, entry.revision)
260
if entry.file_id is inv.root.file_id:
261
# The root id is inferred for xml v5
262
self.assertFalse(key in entry_cache)
264
self.assertIsNot(entry, entry_cache[key])
266
def test_unpack_inventory_5a_cache_no_copy(self):
267
# Passing an entry_cache should get populated with the objects
268
# The returned objects should be exact if return_from_cache is
270
entry_cache = fifo_cache.FIFOCache()
271
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(
272
_inventory_v5a, revision_id='test-rev-id',
273
entry_cache=entry_cache, return_from_cache=True)
274
for entry in inv.iter_just_entries():
275
key = (entry.file_id, entry.revision)
276
if entry.file_id is inv.root.file_id:
277
# The root id is inferred for xml v5
278
self.assertFalse(key in entry_cache)
280
self.assertIs(entry, entry_cache[key])
282
def test_unpack_inventory_5b(self):
283
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(
284
_inventory_v5b, revision_id='test-rev-id')
285
self.assertEqual('a-rev-id', inv.root.revision)
232
287
def test_repack_inventory_5(self):
233
288
inp = StringIO(_committed_inv_v5)
234
289
inv = bzrlib.xml5.serializer_v5.read_inventory(inp)
289
347
new_rev = s_v5.read_revision_from_string(txt)
290
348
self.assertEqual(props, new_rev.properties)
350
def get_sample_inventory(self):
351
inv = Inventory('tree-root-321', revision_id='rev_outer')
352
inv.add(inventory.InventoryFile('file-id', 'file', 'tree-root-321'))
353
inv.add(inventory.InventoryDirectory('dir-id', 'dir',
355
inv.add(inventory.InventoryLink('link-id', 'link', 'tree-root-321'))
356
inv['tree-root-321'].revision = 'rev_outer'
357
inv['dir-id'].revision = 'rev_outer'
358
inv['file-id'].revision = 'rev_outer'
359
inv['file-id'].text_sha1 = 'A'
360
inv['file-id'].text_size = 1
361
inv['link-id'].revision = 'rev_outer'
362
inv['link-id'].symlink_target = 'a'
365
def test_roundtrip_inventory_v7(self):
366
inv = self.get_sample_inventory()
367
inv.add(inventory.TreeReference('nested-id', 'nested', 'tree-root-321',
368
'rev_outer', 'rev_inner'))
369
txt = xml7.serializer_v7.write_inventory_to_string(inv)
370
lines = xml7.serializer_v7.write_inventory_to_lines(inv)
371
self.assertEqual(bzrlib.osutils.split_lines(txt), lines)
372
self.assertEqualDiff(_expected_inv_v7, txt)
373
inv2 = xml7.serializer_v7.read_inventory_from_string(txt)
374
self.assertEqual(5, len(inv2))
375
for path, ie in inv.iter_entries():
376
self.assertEqual(ie, inv2[ie.file_id])
378
def test_roundtrip_inventory_v6(self):
379
inv = self.get_sample_inventory()
380
txt = xml6.serializer_v6.write_inventory_to_string(inv)
381
lines = xml6.serializer_v6.write_inventory_to_lines(inv)
382
self.assertEqual(bzrlib.osutils.split_lines(txt), lines)
383
self.assertEqualDiff(_expected_inv_v6, txt)
384
inv2 = xml6.serializer_v6.read_inventory_from_string(txt)
385
self.assertEqual(4, len(inv2))
386
for path, ie in inv.iter_entries():
387
self.assertEqual(ie, inv2[ie.file_id])
389
def test_wrong_format_v7(self):
390
"""Can't accidentally open a file with wrong serializer"""
391
s_v6 = bzrlib.xml6.serializer_v6
392
s_v7 = xml7.serializer_v7
393
self.assertRaises(errors.UnexpectedInventoryFormat,
394
s_v7.read_inventory_from_string, _expected_inv_v5)
395
self.assertRaises(errors.UnexpectedInventoryFormat,
396
s_v6.read_inventory_from_string, _expected_inv_v7)
398
def test_tree_reference(self):
399
s_v5 = bzrlib.xml5.serializer_v5
400
s_v6 = bzrlib.xml6.serializer_v6
401
s_v7 = xml7.serializer_v7
402
inv = Inventory('tree-root-321', revision_id='rev-outer')
403
inv.root.revision = 'root-rev'
404
inv.add(inventory.TreeReference('nested-id', 'nested', 'tree-root-321',
405
'rev-outer', 'rev-inner'))
406
self.assertRaises(errors.UnsupportedInventoryKind,
407
s_v5.write_inventory_to_string, inv)
408
self.assertRaises(errors.UnsupportedInventoryKind,
409
s_v6.write_inventory_to_string, inv)
410
txt = s_v7.write_inventory_to_string(inv)
411
lines = s_v7.write_inventory_to_lines(inv)
412
self.assertEqual(bzrlib.osutils.split_lines(txt), lines)
413
inv2 = s_v7.read_inventory_from_string(txt)
414
self.assertEqual('tree-root-321', inv2['nested-id'].parent_id)
415
self.assertEqual('rev-outer', inv2['nested-id'].revision)
416
self.assertEqual('rev-inner', inv2['nested-id'].reference_revision)
418
def test_roundtrip_inventory_v8(self):
419
inv = self.get_sample_inventory()
420
txt = xml8.serializer_v8.write_inventory_to_string(inv)
421
inv2 = xml8.serializer_v8.read_inventory_from_string(txt)
422
self.assertEqual(4, len(inv2))
423
for path, ie in inv.iter_entries():
424
self.assertEqual(ie, inv2[ie.file_id])
426
def test_inventory_text_v8(self):
427
inv = self.get_sample_inventory()
428
txt = xml8.serializer_v8.write_inventory_to_string(inv)
429
lines = xml8.serializer_v8.write_inventory_to_lines(inv)
430
self.assertEqual(bzrlib.osutils.split_lines(txt), lines)
431
self.assertEqualDiff(_expected_inv_v8, txt)
433
def test_revision_text_v6(self):
434
"""Pack revision to XML v6"""
435
rev = bzrlib.xml6.serializer_v6.read_revision_from_string(
437
serialized = bzrlib.xml6.serializer_v6.write_revision_to_string(rev)
438
self.assertEqualDiff(serialized, _expected_rev_v5)
440
def test_revision_text_v7(self):
441
"""Pack revision to XML v7"""
442
rev = bzrlib.xml7.serializer_v7.read_revision_from_string(
444
serialized = bzrlib.xml7.serializer_v7.write_revision_to_string(rev)
445
self.assertEqualDiff(serialized, _expected_rev_v5)
447
def test_revision_text_v8(self):
448
"""Pack revision to XML v8"""
449
rev = bzrlib.xml8.serializer_v8.read_revision_from_string(
451
serialized = bzrlib.xml8.serializer_v8.write_revision_to_string(rev)
452
self.assertEqualDiff(serialized, _expected_rev_v8)
292
454
def test_revision_ids_are_utf8(self):
293
455
"""Parsed revision_ids should all be utf-8 strings, not unicode."""
294
456
s_v5 = bzrlib.xml5.serializer_v5
338
500
"""Whitebox testing of the _encode_and_escape function."""
341
504
# Keep the cache clear before and after the test
342
bzrlib.xml5._ensure_utf8_re()
343
bzrlib.xml5._clear_cache()
344
self.addCleanup(bzrlib.xml5._clear_cache)
505
bzrlib.xml_serializer._clear_cache()
506
self.addCleanup(bzrlib.xml_serializer._clear_cache)
346
508
def test_simple_ascii(self):
347
509
# _encode_and_escape always appends a final ", because these parameters
348
510
# are being used in xml attributes, and by returning it now, we have to
349
511
# do fewer string operations later.
350
val = bzrlib.xml5._encode_and_escape('foo bar')
512
val = bzrlib.xml_serializer.encode_and_escape('foo bar')
351
513
self.assertEqual('foo bar"', val)
352
514
# The second time should be cached
353
val2 = bzrlib.xml5._encode_and_escape('foo bar')
515
val2 = bzrlib.xml_serializer.encode_and_escape('foo bar')
354
516
self.assertIs(val2, val)
356
518
def test_ascii_with_xml(self):
357
519
self.assertEqual('&'"<>"',
358
bzrlib.xml5._encode_and_escape('&\'"<>'))
520
bzrlib.xml_serializer.encode_and_escape('&\'"<>'))
360
522
def test_utf8_with_xml(self):
361
523
# u'\xb5\xe5&\u062c'
362
524
utf8_str = '\xc2\xb5\xc3\xa5&\xd8\xac'
363
525
self.assertEqual('µå&ج"',
364
bzrlib.xml5._encode_and_escape(utf8_str))
526
bzrlib.xml_serializer.encode_and_escape(utf8_str))
366
528
def test_unicode(self):
367
529
uni_str = u'\xb5\xe5&\u062c'
368
530
self.assertEqual('µå&ج"',
369
bzrlib.xml5._encode_and_escape(uni_str))
531
bzrlib.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, bzrlib.xml8._unescape_xml, 'foo&bar;')
added
removed
bzrlib/tests/test_xml.py
