/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_xml.py

  • Committer: Robert Collins
  • Date: 2010-05-11 08:36:16 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100511083616-b8fjb19zomwupid0
Make all lock methods return Result objects, rather than lock_read returning self, as per John's review.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_xml.py
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005-2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
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
16
16
 
 
17
from cStringIO import StringIO
17
18
 
18
 
from ... import (
 
19
from bzrlib import (
19
20
    errors,
20
21
    fifo_cache,
21
 
    )
22
 
from .. import (
23
22
    inventory,
24
 
    serializer,
25
23
    xml6,
26
24
    xml7,
27
25
    xml8,
28
 
    )
29
 
from ...sixish import (
30
 
    BytesIO,
31
 
    text_type,
32
 
    )
33
 
from ..inventory import Inventory
34
 
from . import TestCase
35
 
import breezy.bzr.xml5
36
 
 
37
 
_revision_v5 = b"""<revision committer="Martin Pool &lt;mbp@sourcefrog.net&gt;"
 
26
    serializer,
 
27
    )
 
28
from bzrlib.tests import TestCase
 
29
from bzrlib.inventory import Inventory, InventoryEntry
 
30
from bzrlib.xml4 import serializer_v4
 
31
import bzrlib.xml5
 
32
 
 
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" />
 
37
</inventory>"""
 
38
 
 
39
 
 
40
_revision_v4 = """<revision committer="Martin Pool &lt;mbp@sourcefrog.net&gt;"
 
41
    inventory_id="mbp@sourcefrog.net-20050905080035-e0439293f8b6b9f9"
 
42
    inventory_sha1="e79c31c1deb64c163cf660fdedd476dd579ffd41"
 
43
    revision_id="mbp@sourcefrog.net-20050905080035-e0439293f8b6b9f9"
 
44
    timestamp="1125907235.212"
 
45
    timezone="36000">
 
46
<message>- start splitting code for xml (de)serialization away from objects
 
47
  preparatory to supporting multiple formats by a single library
 
48
</message>
 
49
<parents>
 
50
<revision_ref revision_id="mbp@sourcefrog.net-20050905063503-43948f59fa127d92" revision_sha1="7bdf4cc8c5bdac739f8cf9b10b78cf4b68f915ff" />
 
51
</parents>
 
52
</revision>
 
53
"""
 
54
 
 
55
_revision_v5 = """<revision committer="Martin Pool &lt;mbp@sourcefrog.net&gt;"
38
56
    inventory_sha1="e79c31c1deb64c163cf660fdedd476dd579ffd41"
39
57
    revision_id="mbp@sourcefrog.net-20050905080035-e0439293f8b6b9f9"
40
58
    timestamp="1125907235.212"
48
66
</revision>
49
67
"""
50
68
 
51
 
_revision_v5_utc = b"""\
 
69
_revision_v5_utc = """\
52
70
<revision committer="Martin Pool &lt;mbp@sourcefrog.net&gt;"
53
71
    inventory_sha1="e79c31c1deb64c163cf660fdedd476dd579ffd41"
54
72
    revision_id="mbp@sourcefrog.net-20050905080035-e0439293f8b6b9f9"
63
81
</revision>
64
82
"""
65
83
 
66
 
_committed_inv_v5 = b"""<inventory>
 
84
_committed_inv_v5 = """<inventory>
67
85
<file file_id="bar-20050901064931-73b4b1138abc9cd2"
68
86
      name="bar" parent_id="TREE_ROOT"
69
87
      revision="mbp@foo-123123"
79
97
</inventory>
80
98
"""
81
99
 
82
 
_basis_inv_v5 = b"""<inventory revision_id="mbp@sourcefrog.net-20050905063503-43948f59fa127d92">
 
100
_basis_inv_v5 = """<inventory revision_id="mbp@sourcefrog.net-20050905063503-43948f59fa127d92">
83
101
<file file_id="bar-20050901064931-73b4b1138abc9cd2"
84
102
      name="bar" parent_id="TREE_ROOT"
85
103
      revision="mbp@foo-123123"/>
95
113
 
96
114
 
97
115
# DO NOT REFLOW THIS. Its the exact revision we want.
98
 
_expected_rev_v5 = b"""<revision committer="Martin Pool &lt;mbp@sourcefrog.net&gt;" format="5" inventory_sha1="e79c31c1deb64c163cf660fdedd476dd579ffd41" revision_id="mbp@sourcefrog.net-20050905080035-e0439293f8b6b9f9" timestamp="1125907235.212" timezone="36000">
 
116
_expected_rev_v5 = """<revision committer="Martin Pool &lt;mbp@sourcefrog.net&gt;" format="5" inventory_sha1="e79c31c1deb64c163cf660fdedd476dd579ffd41" revision_id="mbp@sourcefrog.net-20050905080035-e0439293f8b6b9f9" timestamp="1125907235.212" timezone="36000">
99
117
<message>- start splitting code for xml (de)serialization away from objects
100
118
  preparatory to supporting multiple formats by a single library
101
119
</message>
107
125
 
108
126
 
109
127
# DO NOT REFLOW THIS. Its the exact inventory we want.
110
 
_expected_inv_v5 = b"""<inventory format="5">
 
128
_expected_inv_v5 = """<inventory format="5">
111
129
<file file_id="bar-20050901064931-73b4b1138abc9cd2" name="bar" revision="mbp@foo-123123" text_sha1="A" text_size="1" />
112
130
<directory file_id="foo-20050801201819-4139aa4a272f4250" name="subdir" revision="mbp@foo-00" />
113
131
<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" />
115
133
"""
116
134
 
117
135
 
118
 
_expected_inv_v5_root = b"""<inventory file_id="f&lt;" format="5" revision_id="mother!">
 
136
_expected_inv_v5_root = """<inventory file_id="f&lt;" format="5" revision_id="mother!">
119
137
<file file_id="bar-20050901064931-73b4b1138abc9cd2" name="bar" parent_id="f&lt;" revision="mbp@foo-123123" text_sha1="A" text_size="1" />
120
138
<directory file_id="foo-20050801201819-4139aa4a272f4250" name="subdir" parent_id="f&lt;" revision="mbp@foo-00" />
121
139
<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" />
123
141
</inventory>
124
142
"""
125
143
 
126
 
_expected_inv_v6 = b"""<inventory format="6" revision_id="rev_outer">
 
144
_expected_inv_v6 = """<inventory format="6" revision_id="rev_outer">
127
145
<directory file_id="tree-root-321" name="" revision="rev_outer" />
128
146
<directory file_id="dir-id" name="dir" parent_id="tree-root-321" revision="rev_outer" />
129
147
<file file_id="file-id" name="file" parent_id="tree-root-321" revision="rev_outer" text_sha1="A" text_size="1" />
131
149
</inventory>
132
150
"""
133
151
 
134
 
_expected_inv_v7 = b"""<inventory format="7" revision_id="rev_outer">
 
152
_expected_inv_v7 = """<inventory format="7" revision_id="rev_outer">
135
153
<directory file_id="tree-root-321" name="" revision="rev_outer" />
136
154
<directory file_id="dir-id" name="dir" parent_id="tree-root-321" revision="rev_outer" />
137
155
<file file_id="file-id" name="file" parent_id="tree-root-321" revision="rev_outer" text_sha1="A" text_size="1" />
140
158
</inventory>
141
159
"""
142
160
 
143
 
_expected_rev_v8 = b"""<revision committer="Martin Pool &lt;mbp@sourcefrog.net&gt;" format="8" inventory_sha1="e79c31c1deb64c163cf660fdedd476dd579ffd41" revision_id="mbp@sourcefrog.net-20050905080035-e0439293f8b6b9f9" timestamp="1125907235.212" timezone="36000">
 
161
_expected_rev_v8 = """<revision committer="Martin Pool &lt;mbp@sourcefrog.net&gt;" format="8" inventory_sha1="e79c31c1deb64c163cf660fdedd476dd579ffd41" revision_id="mbp@sourcefrog.net-20050905080035-e0439293f8b6b9f9" timestamp="1125907235.212" timezone="36000">
144
162
<message>- start splitting code for xml (de)serialization away from objects
145
163
  preparatory to supporting multiple formats by a single library
146
164
</message>
150
168
</revision>
151
169
"""
152
170
 
153
 
_expected_inv_v8 = b"""<inventory format="8" revision_id="rev_outer">
 
171
_expected_inv_v8 = """<inventory format="8" revision_id="rev_outer">
154
172
<directory file_id="tree-root-321" name="" revision="rev_outer" />
155
173
<directory file_id="dir-id" name="dir" parent_id="tree-root-321" revision="rev_outer" />
156
174
<file file_id="file-id" name="file" parent_id="tree-root-321" revision="rev_outer" text_sha1="A" text_size="1" />
158
176
</inventory>
159
177
"""
160
178
 
161
 
_revision_utf8_v5 = b"""<revision committer="Erik B&#229;gfors &lt;erik@foo.net&gt;"
 
179
_revision_utf8_v5 = """<revision committer="Erik B&#229;gfors &lt;erik@foo.net&gt;"
162
180
    inventory_sha1="e79c31c1deb64c163cf660fdedd476dd579ffd41"
163
181
    revision_id="erik@b&#229;gfors-02"
164
182
    timestamp="1125907235.212"
171
189
</revision>
172
190
"""
173
191
 
174
 
_expected_rev_v8_complex = b"""<revision committer="Erik B&#229;gfors &lt;erik@foo.net&gt;" format="8" inventory_sha1="e79c31c1deb64c163cf660fdedd476dd579ffd41" revision_id="erik@b&#229;gfors-02" timestamp="1125907235.212" timezone="36000">
175
 
<message>Include &#181;nicode characters
176
 
</message>
177
 
<parents>
178
 
<revision_ref revision_id="erik@b&#229;gfors-01" />
179
 
<revision_ref revision_id="erik@bagfors-02" />
180
 
</parents>
181
 
<properties><property name="bar" />
182
 
<property name="foo">this has a
183
 
newline in it</property>
184
 
</properties>
185
 
</revision>
186
 
"""
187
 
 
188
 
 
189
 
 
190
 
_inventory_utf8_v5 = b"""<inventory file_id="TRE&#233;_ROOT" format="5"
 
192
_inventory_utf8_v5 = """<inventory file_id="TRE&#233;_ROOT" format="5"
191
193
                                   revision_id="erik@b&#229;gfors-02">
192
194
<file file_id="b&#229;r-01"
193
195
      name="b&#229;r" parent_id="TRE&#233;_ROOT"
203
205
"""
204
206
 
205
207
# Before revision_id was always stored as an attribute
206
 
_inventory_v5a = b"""<inventory format="5">
 
208
_inventory_v5a = """<inventory format="5">
207
209
</inventory>
208
210
"""
209
211
 
210
212
# Before revision_id was always stored as an attribute
211
 
_inventory_v5b = b"""<inventory format="5" revision_id="a-rev-id">
 
213
_inventory_v5b = """<inventory format="5" revision_id="a-rev-id">
212
214
</inventory>
213
215
"""
214
216
 
216
218
class TestSerializer(TestCase):
217
219
    """Test XML serialization"""
218
220
 
 
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)
 
227
 
 
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
 
233
        eq(rev.committer,
 
234
           "Martin Pool <mbp@sourcefrog.net>")
 
235
        eq(rev.inventory_id,
 
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")
 
240
 
219
241
    def test_unpack_revision_5(self):
220
242
        """Test unpacking a canned revision v5"""
221
 
        inp = BytesIO(_revision_v5)
222
 
        rev = breezy.bzr.xml5.serializer_v5.read_revision(inp)
 
243
        inp = StringIO(_revision_v5)
 
244
        rev = bzrlib.xml5.serializer_v5.read_revision(inp)
223
245
        eq = self.assertEqual
224
246
        eq(rev.committer,
225
247
           "Martin Pool <mbp@sourcefrog.net>")
226
248
        eq(len(rev.parent_ids), 1)
227
249
        eq(rev.timezone, 36000)
228
250
        eq(rev.parent_ids[0],
229
 
           b"mbp@sourcefrog.net-20050905063503-43948f59fa127d92")
 
251
           "mbp@sourcefrog.net-20050905063503-43948f59fa127d92")
230
252
 
231
253
    def test_unpack_revision_5_utc(self):
232
 
        inp = BytesIO(_revision_v5_utc)
233
 
        rev = breezy.bzr.xml5.serializer_v5.read_revision(inp)
 
254
        inp = StringIO(_revision_v5_utc)
 
255
        rev = bzrlib.xml5.serializer_v5.read_revision(inp)
234
256
        eq = self.assertEqual
235
257
        eq(rev.committer,
236
258
           "Martin Pool <mbp@sourcefrog.net>")
237
259
        eq(len(rev.parent_ids), 1)
238
260
        eq(rev.timezone, 0)
239
261
        eq(rev.parent_ids[0],
240
 
           b"mbp@sourcefrog.net-20050905063503-43948f59fa127d92")
 
262
           "mbp@sourcefrog.net-20050905063503-43948f59fa127d92")
241
263
 
242
264
    def test_unpack_inventory_5(self):
243
265
        """Unpack canned new-style inventory"""
244
 
        inp = BytesIO(_committed_inv_v5)
245
 
        inv = breezy.bzr.xml5.serializer_v5.read_inventory(inp)
 
266
        inp = StringIO(_committed_inv_v5)
 
267
        inv = bzrlib.xml5.serializer_v5.read_inventory(inp)
246
268
        eq = self.assertEqual
247
269
        eq(len(inv), 4)
248
 
        ie = inv.get_entry(b'bar-20050824000535-6bc48cfad47ed134')
 
270
        ie = inv['bar-20050824000535-6bc48cfad47ed134']
249
271
        eq(ie.kind, 'file')
250
 
        eq(ie.revision, b'mbp@foo-00')
 
272
        eq(ie.revision, 'mbp@foo-00')
251
273
        eq(ie.name, 'bar')
252
 
        eq(inv.get_entry(ie.parent_id).kind, 'directory')
 
274
        eq(inv[ie.parent_id].kind, 'directory')
253
275
 
254
276
    def test_unpack_basis_inventory_5(self):
255
277
        """Unpack canned new-style inventory"""
256
 
        inv = breezy.bzr.xml5.serializer_v5.read_inventory_from_lines(
257
 
            breezy.osutils.split_lines(_basis_inv_v5))
 
278
        inp = StringIO(_basis_inv_v5)
 
279
        inv = bzrlib.xml5.serializer_v5.read_inventory(inp)
258
280
        eq = self.assertEqual
259
281
        eq(len(inv), 4)
260
 
        eq(inv.revision_id,
261
 
           b'mbp@sourcefrog.net-20050905063503-43948f59fa127d92')
262
 
        ie = inv.get_entry(b'bar-20050824000535-6bc48cfad47ed134')
 
282
        eq(inv.revision_id, 'mbp@sourcefrog.net-20050905063503-43948f59fa127d92')
 
283
        ie = inv['bar-20050824000535-6bc48cfad47ed134']
263
284
        eq(ie.kind, 'file')
264
 
        eq(ie.revision, b'mbp@foo-00')
 
285
        eq(ie.revision, 'mbp@foo-00')
265
286
        eq(ie.name, 'bar')
266
 
        eq(inv.get_entry(ie.parent_id).kind, 'directory')
 
287
        eq(inv[ie.parent_id].kind, 'directory')
267
288
 
268
289
    def test_unpack_inventory_5a(self):
269
 
        inv = breezy.bzr.xml5.serializer_v5.read_inventory_from_lines(
270
 
            breezy.osutils.split_lines(_inventory_v5a), revision_id=b'test-rev-id')
271
 
        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)
272
293
 
273
294
    def test_unpack_inventory_5a_cache_and_copy(self):
274
295
        # Passing an entry_cache should get populated with the objects
275
296
        # But the returned objects should be copies if return_from_cache is
276
297
        # False
277
298
        entry_cache = fifo_cache.FIFOCache()
278
 
        inv = breezy.bzr.xml5.serializer_v5.read_inventory_from_lines(
279
 
            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',
280
301
            entry_cache=entry_cache, return_from_cache=False)
281
302
        for entry in inv.iter_just_entries():
282
303
            key = (entry.file_id, entry.revision)
291
312
        # The returned objects should be exact if return_from_cache is
292
313
        # True
293
314
        entry_cache = fifo_cache.FIFOCache()
294
 
        inv = breezy.bzr.xml5.serializer_v5.read_inventory_from_lines(
295
 
            breezy.osutils.split_lines(_inventory_v5a), revision_id=b'test-rev-id',
 
315
        inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(
 
316
            _inventory_v5a, revision_id='test-rev-id',
296
317
            entry_cache=entry_cache, return_from_cache=True)
297
318
        for entry in inv.iter_just_entries():
298
319
            key = (entry.file_id, entry.revision)
303
324
                self.assertIs(entry, entry_cache[key])
304
325
 
305
326
    def test_unpack_inventory_5b(self):
306
 
        inv = breezy.bzr.xml5.serializer_v5.read_inventory_from_lines(
307
 
            breezy.osutils.split_lines(_inventory_v5b), revision_id=b'test-rev-id')
308
 
        self.assertEqual(b'a-rev-id', inv.root.revision)
 
327
        inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(
 
328
                _inventory_v5b, revision_id='test-rev-id')
 
329
        self.assertEqual('a-rev-id', inv.root.revision)
309
330
 
310
331
    def test_repack_inventory_5(self):
311
 
        inv = breezy.bzr.xml5.serializer_v5.read_inventory_from_lines(
312
 
            breezy.osutils.split_lines(_committed_inv_v5))
313
 
        outp = BytesIO()
314
 
        breezy.bzr.xml5.serializer_v5.write_inventory(inv, outp)
 
332
        inp = StringIO(_committed_inv_v5)
 
333
        inv = bzrlib.xml5.serializer_v5.read_inventory(inp)
 
334
        outp = StringIO()
 
335
        bzrlib.xml5.serializer_v5.write_inventory(inv, outp)
315
336
        self.assertEqualDiff(_expected_inv_v5, outp.getvalue())
316
 
        inv2 = breezy.bzr.xml5.serializer_v5.read_inventory_from_lines(
317
 
            breezy.osutils.split_lines(outp.getvalue()))
 
337
        inv2 = bzrlib.xml5.serializer_v5.read_inventory(StringIO(outp.getvalue()))
318
338
        self.assertEqual(inv, inv2)
319
339
 
320
340
    def assertRoundTrips(self, xml_string):
321
 
        inp = BytesIO(xml_string)
322
 
        inv = breezy.bzr.xml5.serializer_v5.read_inventory(inp)
323
 
        outp = BytesIO()
324
 
        breezy.bzr.xml5.serializer_v5.write_inventory(inv, outp)
 
341
        inp = StringIO(xml_string)
 
342
        inv = bzrlib.xml5.serializer_v5.read_inventory(inp)
 
343
        outp = StringIO()
 
344
        bzrlib.xml5.serializer_v5.write_inventory(inv, outp)
325
345
        self.assertEqualDiff(xml_string, outp.getvalue())
326
 
        lines = breezy.bzr.xml5.serializer_v5.write_inventory_to_lines(inv)
 
346
        lines = bzrlib.xml5.serializer_v5.write_inventory_to_lines(inv)
327
347
        outp.seek(0)
328
348
        self.assertEqual(outp.readlines(), lines)
329
 
        inv2 = breezy.bzr.xml5.serializer_v5.read_inventory(
330
 
            BytesIO(outp.getvalue()))
 
349
        inv2 = bzrlib.xml5.serializer_v5.read_inventory(StringIO(outp.getvalue()))
331
350
        self.assertEqual(inv, inv2)
332
351
 
333
352
    def tests_serialize_inventory_v5_with_root(self):
335
354
 
336
355
    def check_repack_revision(self, txt):
337
356
        """Check that repacking a revision yields the same information"""
338
 
        inp = BytesIO(txt)
339
 
        rev = breezy.bzr.xml5.serializer_v5.read_revision(inp)
340
 
        outfile_contents = breezy.bzr.xml5.serializer_v5.write_revision_to_string(rev)
341
 
        rev2 = breezy.bzr.xml5.serializer_v5.read_revision(
342
 
            BytesIO(outfile_contents))
 
357
        inp = StringIO(txt)
 
358
        rev = bzrlib.xml5.serializer_v5.read_revision(inp)
 
359
        outp = StringIO()
 
360
        bzrlib.xml5.serializer_v5.write_revision(rev, outp)
 
361
        outfile_contents = outp.getvalue()
 
362
        rev2 = bzrlib.xml5.serializer_v5.read_revision(StringIO(outfile_contents))
343
363
        self.assertEqual(rev, rev2)
344
364
 
345
365
    def test_repack_revision_5(self):
352
372
    def test_pack_revision_5(self):
353
373
        """Pack revision to XML v5"""
354
374
        # fixed 20051025, revisions should have final newline
355
 
        rev = breezy.bzr.xml5.serializer_v5.read_revision_from_string(
356
 
            _revision_v5)
357
 
        outfile_contents = breezy.bzr.xml5.serializer_v5.write_revision_to_string(rev)
358
 
        self.assertEqual(outfile_contents[-1:], b'\n')
359
 
        self.assertEqualDiff(
360
 
            outfile_contents,
361
 
            b''.join(breezy.bzr.xml5.serializer_v5.write_revision_to_lines(rev)))
 
375
        rev = bzrlib.xml5.serializer_v5.read_revision_from_string(_revision_v5)
 
376
        outp = StringIO()
 
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))
362
381
        self.assertEqualDiff(outfile_contents, _expected_rev_v5)
363
382
 
364
383
    def test_empty_property_value(self):
365
384
        """Create an empty property value check that it serializes correctly"""
366
 
        s_v5 = breezy.bzr.xml5.serializer_v5
 
385
        s_v5 = bzrlib.xml5.serializer_v5
367
386
        rev = s_v5.read_revision_from_string(_revision_v5)
368
 
        props = {'empty': '', 'one': 'one'}
 
387
        outp = StringIO()
 
388
        props = {'empty':'', 'one':'one'}
369
389
        rev.properties = props
370
 
        txt = b''.join(s_v5.write_revision_to_lines(rev))
 
390
        txt = s_v5.write_revision_to_string(rev)
371
391
        new_rev = s_v5.read_revision_from_string(txt)
372
392
        self.assertEqual(props, new_rev.properties)
373
393
 
374
394
    def get_sample_inventory(self):
375
 
        inv = Inventory(b'tree-root-321', revision_id=b'rev_outer')
376
 
        inv.add(inventory.InventoryFile(b'file-id', 'file', b'tree-root-321'))
377
 
        inv.add(inventory.InventoryDirectory(b'dir-id', 'dir',
378
 
                                             b'tree-root-321'))
379
 
        inv.add(inventory.InventoryLink(b'link-id', 'link', b'tree-root-321'))
380
 
        inv.get_entry(b'tree-root-321').revision = b'rev_outer'
381
 
        inv.get_entry(b'dir-id').revision = b'rev_outer'
382
 
        inv.get_entry(b'file-id').revision = b'rev_outer'
383
 
        inv.get_entry(b'file-id').text_sha1 = b'A'
384
 
        inv.get_entry(b'file-id').text_size = 1
385
 
        inv.get_entry(b'link-id').revision = b'rev_outer'
386
 
        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',
 
398
                                             'tree-root-321'))
 
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'
387
407
        return inv
388
408
 
389
409
    def test_roundtrip_inventory_v7(self):
390
410
        inv = self.get_sample_inventory()
391
 
        inv.add(inventory.TreeReference(b'nested-id', 'nested', b'tree-root-321',
392
 
                                        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)
393
414
        lines = xml7.serializer_v7.write_inventory_to_lines(inv)
394
 
        self.assertEqualDiff(_expected_inv_v7, b''.join(lines))
395
 
        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)
396
418
        self.assertEqual(5, len(inv2))
397
419
        for path, ie in inv.iter_entries():
398
 
            self.assertEqual(ie, inv2.get_entry(ie.file_id))
 
420
            self.assertEqual(ie, inv2[ie.file_id])
399
421
 
400
422
    def test_roundtrip_inventory_v6(self):
401
423
        inv = self.get_sample_inventory()
 
424
        txt = xml6.serializer_v6.write_inventory_to_string(inv)
402
425
        lines = xml6.serializer_v6.write_inventory_to_lines(inv)
403
 
        self.assertEqualDiff(_expected_inv_v6, b''.join(lines))
404
 
        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)
405
429
        self.assertEqual(4, len(inv2))
406
430
        for path, ie in inv.iter_entries():
407
 
            self.assertEqual(ie, inv2.get_entry(ie.file_id))
 
431
            self.assertEqual(ie, inv2[ie.file_id])
408
432
 
409
433
    def test_wrong_format_v7(self):
410
434
        """Can't accidentally open a file with wrong serializer"""
411
 
        s_v6 = breezy.bzr.xml6.serializer_v6
 
435
        s_v6 = bzrlib.xml6.serializer_v6
412
436
        s_v7 = xml7.serializer_v7
413
 
        self.assertRaises(serializer.UnexpectedInventoryFormat,
414
 
                          s_v7.read_inventory_from_lines,
415
 
                          breezy.osutils.split_lines(_expected_inv_v5))
416
 
        self.assertRaises(serializer.UnexpectedInventoryFormat,
417
 
                          s_v6.read_inventory_from_lines,
418
 
                          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)
419
441
 
420
442
    def test_tree_reference(self):
421
 
        s_v5 = breezy.bzr.xml5.serializer_v5
422
 
        s_v6 = breezy.bzr.xml6.serializer_v6
 
443
        s_v5 = bzrlib.xml5.serializer_v5
 
444
        s_v6 = bzrlib.xml6.serializer_v6
423
445
        s_v7 = xml7.serializer_v7
424
 
        inv = Inventory(b'tree-root-321', revision_id=b'rev-outer')
425
 
        inv.root.revision = b'root-rev'
426
 
        inv.add(inventory.TreeReference(b'nested-id', 'nested', b'tree-root-321',
427
 
                                        b'rev-outer', b'rev-inner'))
428
 
        self.assertRaises(serializer.UnsupportedInventoryKind,
429
 
                          s_v5.write_inventory_to_lines, inv)
430
 
        self.assertRaises(serializer.UnsupportedInventoryKind,
431
 
                          s_v6.write_inventory_to_lines, inv)
432
 
        lines = s_v7.write_inventory_to_chunks(inv)
433
 
        inv2 = s_v7.read_inventory_from_lines(lines)
434
 
        self.assertEqual(b'tree-root-321',
435
 
                         inv2.get_entry(b'nested-id').parent_id)
436
 
        self.assertEqual(b'rev-outer', inv2.get_entry(b'nested-id').revision)
437
 
        self.assertEqual(
438
 
            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"'))
439
467
 
440
468
    def test_roundtrip_inventory_v8(self):
441
469
        inv = self.get_sample_inventory()
442
 
        lines = xml8.serializer_v8.write_inventory_to_lines(inv)
443
 
        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)
444
472
        self.assertEqual(4, len(inv2))
445
473
        for path, ie in inv.iter_entries():
446
 
            self.assertEqual(ie, inv2.get_entry(ie.file_id))
 
474
            self.assertEqual(ie, inv2[ie.file_id])
447
475
 
448
476
    def test_inventory_text_v8(self):
449
477
        inv = self.get_sample_inventory()
 
478
        txt = xml8.serializer_v8.write_inventory_to_string(inv)
450
479
        lines = xml8.serializer_v8.write_inventory_to_lines(inv)
451
 
        self.assertEqualDiff(_expected_inv_v8, b''.join(lines))
 
480
        self.assertEqual(bzrlib.osutils.split_lines(txt), lines)
 
481
        self.assertEqualDiff(_expected_inv_v8, txt)
452
482
 
453
483
    def test_revision_text_v6(self):
454
484
        """Pack revision to XML v6"""
455
 
        rev = breezy.bzr.xml6.serializer_v6.read_revision_from_string(
 
485
        rev = bzrlib.xml6.serializer_v6.read_revision_from_string(
456
486
            _expected_rev_v5)
457
 
        serialized = breezy.bzr.xml6.serializer_v6.write_revision_to_lines(
458
 
            rev)
459
 
        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)
460
489
 
461
490
    def test_revision_text_v7(self):
462
491
        """Pack revision to XML v7"""
463
 
        rev = breezy.bzr.xml7.serializer_v7.read_revision_from_string(
 
492
        rev = bzrlib.xml7.serializer_v7.read_revision_from_string(
464
493
            _expected_rev_v5)
465
 
        serialized = breezy.bzr.xml7.serializer_v7.write_revision_to_lines(
466
 
            rev)
467
 
        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)
468
496
 
469
497
    def test_revision_text_v8(self):
470
498
        """Pack revision to XML v8"""
471
 
        rev = breezy.bzr.xml8.serializer_v8.read_revision_from_string(
 
499
        rev = bzrlib.xml8.serializer_v8.read_revision_from_string(
472
500
            _expected_rev_v8)
473
 
        serialized = breezy.bzr.xml8.serializer_v8.write_revision_to_lines(
474
 
            rev)
475
 
        self.assertEqualDiff(b''.join(serialized), _expected_rev_v8)
476
 
 
477
 
    def test_revision_text_v8_complex(self):
478
 
        """Pack revision to XML v8"""
479
 
        rev = breezy.bzr.xml8.serializer_v8.read_revision_from_string(
480
 
            _expected_rev_v8_complex)
481
 
        serialized = breezy.bzr.xml8.serializer_v8.write_revision_to_lines(
482
 
            rev)
483
 
        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)
484
503
 
485
504
    def test_revision_ids_are_utf8(self):
486
505
        """Parsed revision_ids should all be utf-8 strings, not unicode."""
487
 
        s_v5 = breezy.bzr.xml5.serializer_v5
 
506
        s_v5 = bzrlib.xml5.serializer_v5
488
507
        rev = s_v5.read_revision_from_string(_revision_utf8_v5)
489
 
        self.assertEqual(b'erik@b\xc3\xa5gfors-02', rev.revision_id)
490
 
        self.assertIsInstance(rev.revision_id, bytes)
491
 
        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)
492
511
        for parent_id in rev.parent_ids:
493
 
            self.assertIsInstance(parent_id, bytes)
 
512
            self.assertIsInstance(parent_id, str)
494
513
        self.assertEqual(u'Include \xb5nicode characters\n', rev.message)
495
 
        self.assertIsInstance(rev.message, text_type)
 
514
        self.assertIsInstance(rev.message, unicode)
496
515
 
497
516
        # ie.revision should either be None or a utf-8 revision id
498
 
        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)
499
518
        rev_id_1 = u'erik@b\xe5gfors-01'.encode('utf8')
500
519
        rev_id_2 = u'erik@b\xe5gfors-02'.encode('utf8')
501
520
        fid_root = u'TRE\xe9_ROOT'.encode('utf8')
506
525
                    (u'b\xe5r', fid_bar1, fid_root, rev_id_1),
507
526
                    (u's\xb5bdir', fid_sub, fid_root, rev_id_1),
508
527
                    (u's\xb5bdir/b\xe5r', fid_bar2, fid_sub, rev_id_2),
509
 
                    ]
 
528
                   ]
510
529
        self.assertEqual(rev_id_2, inv.revision_id)
511
 
        self.assertIsInstance(inv.revision_id, bytes)
 
530
        self.assertIsInstance(inv.revision_id, str)
512
531
 
513
532
        actual = list(inv.iter_entries_by_dir())
514
533
        for ((exp_path, exp_file_id, exp_parent_id, exp_rev_id),
515
534
             (act_path, act_ie)) in zip(expected, actual):
516
535
            self.assertEqual(exp_path, act_path)
517
 
            self.assertIsInstance(act_path, text_type)
 
536
            self.assertIsInstance(act_path, unicode)
518
537
            self.assertEqual(exp_file_id, act_ie.file_id)
519
 
            self.assertIsInstance(act_ie.file_id, bytes)
 
538
            self.assertIsInstance(act_ie.file_id, str)
520
539
            self.assertEqual(exp_parent_id, act_ie.parent_id)
521
540
            if exp_parent_id is not None:
522
 
                self.assertIsInstance(act_ie.parent_id, bytes)
 
541
                self.assertIsInstance(act_ie.parent_id, str)
523
542
            self.assertEqual(exp_rev_id, act_ie.revision)
524
543
            if exp_rev_id is not None:
525
 
                self.assertIsInstance(act_ie.revision, bytes)
 
544
                self.assertIsInstance(act_ie.revision, str)
526
545
 
527
546
        self.assertEqual(len(expected), len(actual))
528
547
 
529
 
    def test_serialization_error(self):
530
 
        s_v5 = breezy.bzr.xml5.serializer_v5
531
 
        e = self.assertRaises(
532
 
            serializer.UnexpectedInventoryFormat,
533
 
            s_v5.read_inventory_from_lines, [b"<Notquitexml"])
534
 
        self.assertEqual(str(e), "unclosed token: line 1, column 0")
535
 
 
536
548
 
537
549
class TestEncodeAndEscape(TestCase):
538
550
    """Whitebox testing of the _encode_and_escape function."""
539
551
 
540
552
    def setUp(self):
541
 
        super(TestEncodeAndEscape, self).setUp()
 
553
        TestCase.setUp(self)
542
554
        # Keep the cache clear before and after the test
543
 
        breezy.bzr.xml_serializer._clear_cache()
544
 
        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)
545
558
 
546
559
    def test_simple_ascii(self):
547
560
        # _encode_and_escape always appends a final ", because these parameters
548
561
        # are being used in xml attributes, and by returning it now, we have to
549
562
        # do fewer string operations later.
550
 
        val = breezy.bzr.xml_serializer.encode_and_escape('foo bar')
551
 
        self.assertEqual(b'foo bar', val)
 
563
        val = bzrlib.xml8._encode_and_escape('foo bar')
 
564
        self.assertEqual('foo bar"', val)
552
565
        # The second time should be cached
553
 
        val2 = breezy.bzr.xml_serializer.encode_and_escape('foo bar')
 
566
        val2 = bzrlib.xml8._encode_and_escape('foo bar')
554
567
        self.assertIs(val2, val)
555
568
 
556
569
    def test_ascii_with_xml(self):
557
 
        self.assertEqual(b'&amp;&apos;&quot;&lt;&gt;',
558
 
                         breezy.bzr.xml_serializer.encode_and_escape('&\'"<>'))
 
570
        self.assertEqual('&amp;&apos;&quot;&lt;&gt;"',
 
571
                         bzrlib.xml8._encode_and_escape('&\'"<>'))
559
572
 
560
573
    def test_utf8_with_xml(self):
561
574
        # u'\xb5\xe5&\u062c'
562
 
        utf8_str = b'\xc2\xb5\xc3\xa5&\xd8\xac'
563
 
        self.assertEqual(b'&#181;&#229;&amp;&#1580;',
564
 
                         breezy.bzr.xml_serializer.encode_and_escape(utf8_str))
 
575
        utf8_str = '\xc2\xb5\xc3\xa5&\xd8\xac'
 
576
        self.assertEqual('&#181;&#229;&amp;&#1580;"',
 
577
                         bzrlib.xml8._encode_and_escape(utf8_str))
565
578
 
566
579
    def test_unicode(self):
567
580
        uni_str = u'\xb5\xe5&\u062c'
568
 
        self.assertEqual(b'&#181;&#229;&amp;&#1580;',
569
 
                         breezy.bzr.xml_serializer.encode_and_escape(uni_str))
570
 
 
571
 
 
572
 
class TestMisc(TestCase):
573
 
 
574
 
    def test_unescape_xml(self):
575
 
        """We get some kind of error when malformed entities are passed"""
576
 
        self.assertRaises(KeyError, breezy.bzr.xml8._unescape_xml, b'foo&bar;')
 
581
        self.assertEqual('&#181;&#229;&amp;&#1580;"',
 
582
                         bzrlib.xml8._encode_and_escape(uni_str))