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
|
# Copyright (C) 2006 by 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
"""Benchmark test suite for bzr."""
import os
import shutil
from bzrlib import (
add,
bzrdir,
osutils,
plugin,
workingtree,
)
from bzrlib.tests.TestUtil import TestLoader
from bzrlib.tests.blackbox import ExternalBase
class Benchmark(ExternalBase):
CACHE_ROOT = None
def get_cache_dir(self, extra):
"""Get the directory to use for caching the given object."""
if Benchmark.CACHE_ROOT is None:
Benchmark.CACHE_ROOT = osutils.pathjoin(self.TEST_ROOT, 'CACHE')
if not os.path.isdir(Benchmark.CACHE_ROOT):
os.mkdir(Benchmark.CACHE_ROOT)
cache_dir = osutils.pathjoin(self.CACHE_ROOT, extra)
return cache_dir, os.path.exists(cache_dir)
def make_kernel_like_tree(self, url=None, root='.',
hardlink_working=False):
"""Setup a temporary tree roughly like a kernel tree.
:param url: Creat the kernel like tree as a lightweight checkout
of a new branch created at url.
:param hardlink_working: instead of creating a new copy of all files
just hardlink the working tree. Tests must request this, because
they must break links if they want to change the files
"""
if url is not None:
b = bzrdir.BzrDir.create_branch_convenience(url)
d = bzrdir.BzrDir.create(root)
bzrlib.branch.BranchReferenceFormat().initialize(d, b)
tree = d.create_workingtree()
else:
tree = bzrdir.BzrDir.create_standalone_workingtree(root)
self._link_or_copy_kernel_files(root=root, do_link=hardlink_working)
return tree
def _make_kernel_files(self, root='.'):
# a kernel tree has ~10000 and 500 directory, with most files around
# 3-4 levels deep.
# we simulate this by three levels of dirs named 0-7, givin 512 dirs,
# and 20 files each.
files = []
for outer in range(8):
files.append("%s/" % outer)
for middle in range(8):
files.append("%s/%s/" % (outer, middle))
for inner in range(8):
prefix = "%s/%s/%s/" % (outer, middle, inner)
files.append(prefix)
files.extend([prefix + str(foo) for foo in range(20)])
cwd = osutils.getcwd()
os.chdir(root)
self.build_tree(files)
os.chdir(cwd)
def _cache_kernel_like_tree(self):
"""Create the kernel_like_tree cache dir if it doesn't exist"""
cache_dir, is_cached = self.get_cache_dir('kernel_like_tree')
if is_cached:
return cache_dir
os.mkdir(cache_dir)
self._make_kernel_files(root=cache_dir)
self._protect_files(cache_dir)
return cache_dir
def _link_or_copy_kernel_files(self, root, do_link=True):
"""Hardlink the kernel files from the cached location.
If the platform doesn't correctly support hardlinking files, it
reverts to just creating new ones.
"""
if not osutils.hardlinks_good() or not do_link:
# Turns out that 'shutil.copytree()' is no faster than
# just creating them. Probably the python overhead.
# Plain _make_kernel_files takes 5s
# cp -a takes 3s
# using hardlinks takes < 1s.
self._make_kernel_files(root=root)
return
cache_dir = self._cache_kernel_like_tree()
# Hardlinking the target directory is *much* faster (7s => <1s).
osutils.copy_tree(cache_dir, root,
handlers={'file':os.link})
def _clone_tree(self, source, dest, link_bzr=False, link_working=True,
hot_cache=True):
"""Copy the contents from a given location to another location.
Optionally hardlink certain pieces of the tree.
:param source: The directory to copy
:param dest: The destination
:param link_bzr: Should the .bzr/ files be hardlinked?
:param link_working: Should the working tree be hardlinked?
:param hot_cache: Update the hash-cache when you are done
"""
# We use shutil.copyfile so that we don't copy permissions
# because most of our source trees are marked readonly to
# prevent modifying in the case of hardlinks
handlers = {'file':shutil.copyfile}
if osutils.hardlinks_good():
if link_working:
if link_bzr:
handlers = {'file':os.link}
else:
# Don't hardlink files inside bzr
def file_handler(source, dest):
if '.bzr/' in source:
shutil.copyfile(source, dest)
else:
os.link(source, dest)
handlers = {'file':file_handler}
elif link_bzr:
# Only link files inside .bzr/
def file_handler(source, dest):
if '.bzr/' in source:
os.link(source, dest)
else:
shutil.copyfile(source, dest)
handlers = {'file':file_handler}
osutils.copy_tree(source, dest, handlers=handlers)
tree = workingtree.WorkingTree.open(dest)
if hot_cache:
tree.lock_write()
try:
# tree._hashcache.scan() just checks and removes
# entries that are out of date
# we need to actually store new ones
for path, ie in tree.inventory.iter_entries_by_dir():
tree.get_file_sha1(ie.file_id, path)
finally:
tree.unlock()
# If we didn't iterate the tree, the hash cache is technically
# invalid, and it would be better to remove it, but there is
# no public api for that.
return tree
def _protect_files(self, root):
"""Chmod all files underneath 'root' to prevent writing
:param root: The base directory to modify
"""
for dirinfo, entries in osutils.walkdirs(root):
for relpath, name, kind, st, abspath in entries:
if kind == 'file':
os.chmod(abspath, 0440)
def _cache_kernel_like_added_tree(self):
cache_dir, is_cached = self.get_cache_dir('kernel_like_added_tree')
if is_cached:
return cache_dir
# Get a basic tree with working files
tree = self.make_kernel_like_tree(root=cache_dir,
hardlink_working=True)
# Add everything to it
tree.lock_write()
try:
add.smart_add_tree(tree, [cache_dir], recurse=True, save=True)
self._protect_files(cache_dir+'/.bzr')
finally:
tree.unlock()
return cache_dir
def make_kernel_like_added_tree(self, root='.',
hardlink_working=True,
hot_cache=True):
"""Make a kernel like tree, with all files added
:param root: Where to create the files
:param hardlink_working: Instead of copying all of the working tree
files, just hardlink them to the cached files. Tests can unlink
files that they will change.
:param hot_cache: Run through the newly created tree and make sure
the stat-cache is correct. The old way of creating a freshly
added tree always had a hot cache.
"""
# There isn't much underneath .bzr, so we don't support hardlinking
# it. Testing showed there wasn't much gain, and there is potentially
# a problem if someone modifies something underneath us.
cache_dir = self._cache_kernel_like_added_tree()
return self._clone_tree(cache_dir, root,
link_working=hardlink_working,
hot_cache=hot_cache)
def _cache_kernel_like_committed_tree(self):
cache_dir, is_cached = self.get_cache_dir('kernel_like_committed_tree')
if is_cached:
return cache_dir
# Get a basic tree with working files
tree = self.make_kernel_like_added_tree(root=cache_dir,
hardlink_working=True,
hot_cache=False)
tree.commit('first post', rev_id='r1')
self._protect_files(cache_dir+'/.bzr')
return cache_dir
def make_kernel_like_committed_tree(self, root='.',
hardlink_working=True,
hardlink_bzr=False,
hot_cache=True):
"""Make a kernel like tree, with all files added and committed
:param root: Where to create the files
:param hardlink_working: Instead of copying all of the working tree
files, just hardlink them to the cached files. Tests can unlink
files that they will change.
:param hardlink_bzr: Hardlink the .bzr directory. For readonly
operations this is safe, and shaves off a lot of setup time
"""
cache_dir = self._cache_kernel_like_committed_tree()
# Now we have a cached tree, just copy it
return self._clone_tree(cache_dir, root,
link_bzr=hardlink_bzr,
link_working=hardlink_working,
hot_cache=hot_cache)
def _cache_many_commit_tree(self):
cache_dir, is_cached = self.get_cache_dir('many_commit_tree')
if is_cached:
return cache_dir
tree = bzrdir.BzrDir.create_standalone_workingtree(cache_dir)
tree.lock_write()
tree.branch.lock_write()
tree.branch.repository.lock_write()
try:
for i in xrange(1000):
tree.commit('no-changes commit %d' % i)
finally:
try:
try:
tree.branch.repository.unlock()
finally:
tree.branch.unlock()
finally:
tree.unlock()
return cache_dir
def make_many_commit_tree(self, directory_name='.',
hardlink=False):
"""Create a tree with many commits.
No file changes are included. Not hardlinking the working tree,
because there are no working tree files.
"""
cache_dir = self._cache_many_commit_tree()
return self._clone_tree(cache_dir, directory_name,
link_bzr=hardlink,
hot_cache=True)
def _cache_heavily_merged_tree(self):
cache_dir, is_cached = self.get_cache_dir('heavily_merged_tree')
if is_cached:
return cache_dir
os.mkdir(cache_dir)
tree = bzrdir.BzrDir.create_standalone_workingtree(
cache_dir + '/tree1')
tree.lock_write()
try:
tree2 = tree.bzrdir.sprout(cache_dir + '/tree2').open_workingtree()
tree2.lock_write()
try:
for i in xrange(250):
revision_id = tree.commit('no-changes commit %d-a' % i)
tree2.branch.fetch(tree.branch, revision_id)
tree2.set_pending_merges([revision_id])
revision_id = tree2.commit('no-changes commit %d-b' % i)
tree.branch.fetch(tree2.branch, revision_id)
tree.set_pending_merges([revision_id])
tree.set_pending_merges([])
finally:
tree2.unlock()
finally:
tree.unlock()
return cache_dir
def make_heavily_merged_tree(self, directory_name='.',
hardlink=False):
"""Create a tree in which almost every commit is a merge.
No file changes are included. This produces two trees,
one of which is returned. Except for the first commit, every
commit in its revision-history is a merge another commit in the other
tree. Not hardlinking the working tree, because there are no working
tree files.
"""
cache_dir = self._cache_heavily_merged_tree()
tree_dir = cache_dir + '/tree1'
return self._clone_tree(tree_dir, directory_name,
link_bzr=hardlink,
hot_cache=True)
def test_suite():
"""Build and return a TestSuite which contains benchmark tests only."""
testmod_names = [ \
'bzrlib.benchmarks.bench_add',
'bzrlib.benchmarks.bench_bench',
'bzrlib.benchmarks.bench_checkout',
'bzrlib.benchmarks.bench_commit',
'bzrlib.benchmarks.bench_inventory',
'bzrlib.benchmarks.bench_log',
'bzrlib.benchmarks.bench_osutils',
'bzrlib.benchmarks.bench_rocks',
'bzrlib.benchmarks.bench_status',
'bzrlib.benchmarks.bench_transform',
'bzrlib.benchmarks.bench_workingtree',
]
suite = TestLoader().loadTestsFromModuleNames(testmod_names)
# Load any benchmarks from plugins
for name, module in plugin.all_plugins().items():
if getattr(module, 'bench_suite', None) is not None:
suite.addTest(module.bench_suite())
return suite
|