/brz/remove-bazaar

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