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

[merge] robertc's integration, updated tests to check for retcode=3

Show diffs side-by-side

added added

removed removed

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