/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 breezy/tests/test_xml.py

  • Committer: Jelmer Vernooij
  • Date: 2018-05-19 13:16:11 UTC
  • mto: (6968.4.3 git-archive)
  • mto: This revision was merged to the branch mainline in revision 6972.
  • Revision ID: jelmer@jelmer.uk-20180519131611-l9h9ud41j7qg1m03
Move tar/zip to breezy.archive.

Show diffs side-by-side

added added

removed removed

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