/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: 2007-04-19 02:27:44 UTC
  • mto: This revision was merged to the branch mainline in revision 2426.
  • Revision ID: robertc@robertcollins.net-20070419022744-pfdqz42kp1wizh43
``make docs`` now creates a man page at ``man1/bzr.1`` fixing bug 107388.
(Robert Collins)

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