1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
|
# Copyright (C) 2006, 2007, 2008 Canonical Ltd
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
"""Tree implementation tests for bzr.
These test the conformance of all the tree variations to the expected API.
Specific tests for individual variations are in other places such as:
- tests/per_workingtree/*.py.
- tests/test_tree.py
- tests/test_revision.py
- tests/test_workingtree.py
"""
from bzrlib import (
errors,
osutils,
progress,
tests,
transform,
)
from bzrlib.tests.per_bzrdir.test_bzrdir import TestCaseWithBzrDir
from bzrlib.tests.per_workingtree import (
make_scenarios as wt_make_scenarios,
make_scenario as wt_make_scenario,
)
from bzrlib.revision import NULL_REVISION
from bzrlib.revisiontree import RevisionTree
from bzrlib.transform import TransformPreview
from bzrlib.workingtree import (
WorkingTreeFormat,
WorkingTreeFormat3,
_legacy_formats,
)
from bzrlib.workingtree_4 import (
DirStateRevisionTree,
WorkingTreeFormat4,
WorkingTreeFormat5,
)
def return_parameter(testcase, something):
"""A trivial thunk to return its input."""
return something
def revision_tree_from_workingtree(testcase, tree):
"""Create a revision tree from a working tree."""
revid = tree.commit('save tree', allow_pointless=True, recursive=None)
return tree.branch.repository.revision_tree(revid)
def _dirstate_tree_from_workingtree(testcase, tree):
revid = tree.commit('save tree', allow_pointless=True, recursive=None)
return tree.basis_tree()
def preview_tree_pre(testcase, tree):
tt = TransformPreview(tree)
testcase.addCleanup(tt.finalize)
preview_tree = tt.get_preview_tree()
preview_tree.set_parent_ids(tree.get_parent_ids())
return preview_tree
def preview_tree_post(testcase, tree):
basis = tree.basis_tree()
tt = TransformPreview(basis)
testcase.addCleanup(tt.finalize)
tree.lock_read()
testcase.addCleanup(tree.unlock)
pp = None
transform._prepare_revert_transform(basis, tree, tt, None, False, None,
basis, {})
preview_tree = tt.get_preview_tree()
preview_tree.set_parent_ids(tree.get_parent_ids())
return preview_tree
class TestTreeImplementationSupport(tests.TestCaseWithTransport):
def test_revision_tree_from_workingtree(self):
tree = self.make_branch_and_tree('.')
tree = revision_tree_from_workingtree(self, tree)
self.assertIsInstance(tree, RevisionTree)
class TestCaseWithTree(TestCaseWithBzrDir):
def make_branch_and_tree(self, relpath):
made_control = self.make_bzrdir(relpath, format=
self.workingtree_format._matchingbzrdir)
made_control.create_repository()
made_control.create_branch()
return self.workingtree_format.initialize(made_control)
def workingtree_to_test_tree(self, tree):
return self._workingtree_to_test_tree(self, tree)
def _convert_tree(self, tree, converter=None):
"""helper to convert using the converter or a supplied one."""
# convert that to the final shape
if converter is None:
converter = self.workingtree_to_test_tree
return converter(tree)
def get_tree_no_parents_no_content(self, empty_tree, converter=None):
"""Make a tree with no parents and no contents from empty_tree.
:param empty_tree: A working tree with no content and no parents to
modify.
"""
empty_tree.set_root_id('empty-root-id')
return self._convert_tree(empty_tree, converter)
def _make_abc_tree(self, tree):
"""setup an abc content tree."""
files = ['a', 'b/', 'b/c']
self.build_tree(files, line_endings='binary',
transport=tree.bzrdir.root_transport)
tree.set_root_id('root-id')
tree.add(files, ['a-id', 'b-id', 'c-id'])
def get_tree_no_parents_abc_content(self, tree, converter=None):
"""return a test tree with a, b/, b/c contents."""
self._make_abc_tree(tree)
return self._convert_tree(tree, converter)
def get_tree_no_parents_abc_content_2(self, tree, converter=None):
"""return a test tree with a, b/, b/c contents.
This variation changes the content of 'a' to foobar\n.
"""
self._make_abc_tree(tree)
f = open(tree.basedir + '/a', 'wb')
try:
f.write('foobar\n')
finally:
f.close()
return self._convert_tree(tree, converter)
def get_tree_no_parents_abc_content_3(self, tree, converter=None):
"""return a test tree with a, b/, b/c contents.
This variation changes the executable flag of b/c to True.
"""
self._make_abc_tree(tree)
tt = transform.TreeTransform(tree)
trans_id = tt.trans_id_tree_path('b/c')
tt.set_executability(True, trans_id)
tt.apply()
return self._convert_tree(tree, converter)
def get_tree_no_parents_abc_content_4(self, tree, converter=None):
"""return a test tree with d, b/, b/c contents.
This variation renames a to d.
"""
self._make_abc_tree(tree)
tree.rename_one('a', 'd')
return self._convert_tree(tree, converter)
def get_tree_no_parents_abc_content_5(self, tree, converter=None):
"""return a test tree with d, b/, b/c contents.
This variation renames a to d and alters its content to 'bar\n'.
"""
self._make_abc_tree(tree)
tree.rename_one('a', 'd')
f = open(tree.basedir + '/d', 'wb')
try:
f.write('bar\n')
finally:
f.close()
return self._convert_tree(tree, converter)
def get_tree_no_parents_abc_content_6(self, tree, converter=None):
"""return a test tree with a, b/, e contents.
This variation renames b/c to e, and makes it executable.
"""
self._make_abc_tree(tree)
tt = transform.TreeTransform(tree)
trans_id = tt.trans_id_tree_path('b/c')
parent_trans_id = tt.trans_id_tree_path('')
tt.adjust_path('e', parent_trans_id, trans_id)
tt.set_executability(True, trans_id)
tt.apply()
return self._convert_tree(tree, converter)
def get_tree_no_parents_abc_content_7(self, tree, converter=None):
"""return a test tree with a, b/, d/e contents.
This variation adds a dir 'd' ('d-id'), renames b to d/e.
"""
self._make_abc_tree(tree)
self.build_tree(['d/'], transport=tree.bzrdir.root_transport)
tree.add(['d'], ['d-id'])
tt = transform.TreeTransform(tree)
trans_id = tt.trans_id_tree_path('b')
parent_trans_id = tt.trans_id_tree_path('d')
tt.adjust_path('e', parent_trans_id, trans_id)
tt.apply()
return self._convert_tree(tree, converter)
def get_tree_with_subdirs_and_all_content_types(self):
"""Return a test tree with subdirs and all content types.
See get_tree_with_subdirs_and_all_supported_content_types for details.
"""
return self.get_tree_with_subdirs_and_all_supported_content_types(True)
def get_tree_with_subdirs_and_all_supported_content_types(self, symlinks):
"""Return a test tree with subdirs and all supported content types.
Some content types may not be created on some platforms
(like symlinks on native win32)
:param symlinks: control is symlink should be created in the tree.
Note: if you wish to automatically set this
parameters depending on underlying system,
please use value returned
by bzrlib.osutils.has_symlinks() function.
The returned tree has the following inventory:
[('', inventory.ROOT_ID),
('0file', '2file'),
('1top-dir', '1top-dir'),
(u'2utf\u1234file', u'0utf\u1234file'),
('symlink', 'symlink'), # only if symlinks arg is True
('1top-dir/0file-in-1topdir', '1file-in-1topdir'),
('1top-dir/1dir-in-1topdir', '0dir-in-1topdir')]
where each component has the type of its name -
i.e. '1file..' is afile.
note that the order of the paths and fileids is deliberately
mismatched to ensure that the result order is path based.
"""
self.requireFeature(tests.UnicodeFilenameFeature)
tree = self.make_branch_and_tree('.')
paths = ['0file',
'1top-dir/',
u'2utf\u1234file',
'1top-dir/0file-in-1topdir',
'1top-dir/1dir-in-1topdir/'
]
ids = [
'2file',
'1top-dir',
u'0utf\u1234file'.encode('utf8'),
'1file-in-1topdir',
'0dir-in-1topdir'
]
self.build_tree(paths)
tree.add(paths, ids)
tt = transform.TreeTransform(tree)
if symlinks:
root_transaction_id = tt.trans_id_tree_path('')
tt.new_symlink('symlink',
root_transaction_id, 'link-target', 'symlink')
tt.apply()
return self.workingtree_to_test_tree(tree)
def get_tree_with_utf8(self, tree):
"""Generate a tree with a utf8 revision and unicode paths."""
self._create_tree_with_utf8(tree)
return self.workingtree_to_test_tree(tree)
def _create_tree_with_utf8(self, tree):
"""Generate a tree with a utf8 revision and unicode paths."""
self.requireFeature(tests.UnicodeFilenameFeature)
# We avoid combining characters in file names here, normalization
# checks (as performed by some file systems (OSX) are outside the scope
# of these tests). We use the euro sign \N{Euro Sign} or \u20ac in
# unicode strings or '\xe2\x82\ac' (its utf-8 encoding) in raw strings.
paths = [u'',
u'fo\N{Euro Sign}o',
u'ba\N{Euro Sign}r/',
u'ba\N{Euro Sign}r/ba\N{Euro Sign}z',
]
# bzr itself does not create unicode file ids, but we want them for
# testing.
file_ids = ['TREE_ROOT',
'fo\xe2\x82\xaco-id',
'ba\xe2\x82\xacr-id',
'ba\xe2\x82\xacz-id',
]
self.build_tree(paths[1:])
if tree.get_root_id() is None:
# Some trees do not have a root yet.
tree.add(paths, file_ids)
else:
# Some trees will already have a root
tree.set_root_id(file_ids[0])
tree.add(paths[1:], file_ids[1:])
try:
tree.commit(u'in\xedtial', rev_id=u'r\xe9v-1'.encode('utf8'))
except errors.NonAsciiRevisionId:
raise tests.TestSkipped('non-ascii revision ids not supported')
def get_tree_with_merged_utf8(self, tree):
"""Generate a tree with utf8 ancestors."""
self._create_tree_with_utf8(tree)
tree2 = tree.bzrdir.sprout('tree2').open_workingtree()
self.build_tree([u'tree2/ba\N{Euro Sign}r/qu\N{Euro Sign}x'])
tree2.add([u'ba\N{Euro Sign}r/qu\N{Euro Sign}x'],
[u'qu\N{Euro Sign}x-id'.encode('utf-8')])
tree2.commit(u'to m\xe9rge', rev_id=u'r\xe9v-2'.encode('utf8'))
tree.merge_from_branch(tree2.branch)
tree.commit(u'm\xe9rge', rev_id=u'r\xe9v-3'.encode('utf8'))
return self.workingtree_to_test_tree(tree)
def make_scenarios(transport_server, transport_readonly_server, formats):
"""Generate test suites for each Tree implementation in bzrlib.
Currently this covers all working tree formats, and RevisionTree and
DirStateRevisionTree by committing a working tree to create the revision
tree.
"""
scenarios = wt_make_scenarios(transport_server, transport_readonly_server,
formats)
# now adjust the scenarios and add the non-working-tree tree scenarios.
for scenario in scenarios:
# for working tree format tests, preserve the tree
scenario[1]["_workingtree_to_test_tree"] = return_parameter
# add RevisionTree scenario
workingtree_format = WorkingTreeFormat._default_format
scenarios.append((RevisionTree.__name__,
create_tree_scenario(transport_server, transport_readonly_server,
workingtree_format, revision_tree_from_workingtree,)))
# also test WorkingTree4/5's RevisionTree implementation which is
# specialised.
# XXX: Ask igc if WT5 revision tree actually is different.
scenarios.append((DirStateRevisionTree.__name__ + ",WT4",
create_tree_scenario(transport_server, transport_readonly_server,
WorkingTreeFormat4(), _dirstate_tree_from_workingtree)))
scenarios.append((DirStateRevisionTree.__name__ + ",WT5",
create_tree_scenario(transport_server, transport_readonly_server,
WorkingTreeFormat5(), _dirstate_tree_from_workingtree)))
scenarios.append(("PreviewTree", create_tree_scenario(transport_server,
transport_readonly_server, workingtree_format, preview_tree_pre)))
scenarios.append(("PreviewTreePost", create_tree_scenario(transport_server,
transport_readonly_server, workingtree_format, preview_tree_post)))
return scenarios
def create_tree_scenario(transport_server, transport_readonly_server,
workingtree_format, converter):
"""Create a scenario for the specified converter
:param converter: A function that converts a workingtree into the
desired format.
:param workingtree_format: The particular workingtree format to
convert from.
:return: a (name, options) tuple, where options is a dict of values
to be used as members of the TestCase.
"""
scenario_options = wt_make_scenario(transport_server,
transport_readonly_server,
workingtree_format)
scenario_options["_workingtree_to_test_tree"] = converter
return scenario_options
def load_tests(standard_tests, module, loader):
per_tree_mod_names = [
'annotate_iter',
'get_file_mtime',
'get_file_with_stat',
'get_root_id',
'get_symlink_target',
'inv',
'iter_search_rules',
'list_files',
'path_content_summary',
'revision_tree',
'test_trees',
'tree',
'walkdirs',
]
submod_tests = loader.loadTestsFromModuleNames(
['bzrlib.tests.per_tree.test_' + name
for name in per_tree_mod_names])
scenarios = make_scenarios(
tests.default_transport,
# None here will cause a readonly decorator to be created
# by the TestCaseWithTransport.get_readonly_transport method.
None,
WorkingTreeFormat._formats.values() + _legacy_formats)
# add the tests for the sub modules
return tests.multiply_tests(submod_tests, scenarios, standard_tests)
|