← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/benchmarks/__init__.py

  • Committer: Robert Collins
  • Date: 2005-10-18 13:11:57 UTC
  • mfrom: (1185.16.72) (0.2.1)
  • Revision ID: robertc@robertcollins.net-20051018131157-76a9970aa78e927e
Merged Martin.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/benchmarks/__init__.py
1
 
# Copyright (C) 2006 Canonical Ltd
2
 
#
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.
7
 
#
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.
12
 
#
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
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
 
 
17
 
"""Benchmark test suite for bzr."""
18
 
 
19
 
from bzrlib import (
20
 
    bzrdir,
21
 
    plugin,
22
 
    )
23
 
import bzrlib.branch
24
 
from bzrlib.tests.TestUtil import TestLoader
25
 
from bzrlib.tests.blackbox import ExternalBase
26
 
 
27
 
 
28
 
class Benchmark(ExternalBase):
29
 
 
30
 
    def make_kernel_like_tree(self, url=None, root='.',
31
 
                              link_working=False):
32
 
        """Setup a temporary tree roughly like a kernel tree.
33
 
        
34
 
        :param url: Creat the kernel like tree as a lightweight checkout
35
 
        of a new branch created at url.
36
 
        :param link_working: instead of creating a new copy of all files
37
 
            just hardlink the working tree. Tests must request this, because
38
 
            they must break links if they want to change the files
39
 
        """
40
 
        from bzrlib.benchmarks.tree_creator.kernel_like import (
41
 
            KernelLikeTreeCreator,
42
 
            )
43
 
        creator = KernelLikeTreeCreator(self, link_working=link_working,
44
 
                                        url=url)
45
 
        return creator.create(root=root)
46
 
 
47
 
    def make_kernel_like_added_tree(self, root='.',
48
 
                                    link_working=True,
49
 
                                    hot_cache=True):
50
 
        """Make a kernel like tree, with all files added
51
 
 
52
 
        :param root: Where to create the files
53
 
        :param link_working: Instead of copying all of the working tree
54
 
            files, just hardlink them to the cached files. Tests can unlink
55
 
            files that they will change.
56
 
        :param hot_cache: Run through the newly created tree and make sure
57
 
            the stat-cache is correct. The old way of creating a freshly
58
 
            added tree always had a hot cache.
59
 
        """
60
 
        from bzrlib.benchmarks.tree_creator.kernel_like import (
61
 
            KernelLikeAddedTreeCreator,
62
 
            )
63
 
        creator = KernelLikeAddedTreeCreator(self, link_working=link_working,
64
 
                                             hot_cache=hot_cache)
65
 
        return creator.create(root=root)
66
 
 
67
 
    def make_kernel_like_committed_tree(self, root='.',
68
 
                                    link_working=True,
69
 
                                    link_bzr=False,
70
 
                                    hot_cache=True):
71
 
        """Make a kernel like tree, with all files added and committed
72
 
 
73
 
        :param root: Where to create the files
74
 
        :param link_working: Instead of copying all of the working tree
75
 
            files, just hardlink them to the cached files. Tests can unlink
76
 
            files that they will change.
77
 
        :param link_bzr: Hardlink the .bzr directory. For readonly 
78
 
            operations this is safe, and shaves off a lot of setup time
79
 
        """
80
 
        from bzrlib.benchmarks.tree_creator.kernel_like import (
81
 
            KernelLikeCommittedTreeCreator,
82
 
            )
83
 
        creator = KernelLikeCommittedTreeCreator(self,
84
 
                                                 link_working=link_working,
85
 
                                                 link_bzr=link_bzr,
86
 
                                                 hot_cache=hot_cache)
87
 
        return creator.create(root=root)
88
 
 
89
 
    def make_kernel_like_inventory(self):
90
 
        """Create an inventory with the properties of a kernel-like tree
91
 
 
92
 
        This should be equivalent to a committed kernel like tree, not
93
 
        just a working tree.
94
 
        """
95
 
        from bzrlib.benchmarks.tree_creator.kernel_like import (
96
 
            KernelLikeInventoryCreator,
97
 
            )
98
 
        creator = KernelLikeInventoryCreator(self)
99
 
        return creator.create()
100
 
 
101
 
    def make_many_commit_tree(self, directory_name='.',
102
 
                              hardlink=False):
103
 
        """Create a tree with many commits.
104
 
        
105
 
        No file changes are included. Not hardlinking the working tree, 
106
 
        because there are no working tree files.
107
 
        """
108
 
        from bzrlib.benchmarks.tree_creator.simple_many_commit import (
109
 
            SimpleManyCommitTreeCreator,
110
 
            )
111
 
        creator = SimpleManyCommitTreeCreator(self, link_bzr=hardlink)
112
 
        return creator.create(root=directory_name)
113
 
 
114
 
    def make_heavily_merged_tree(self, directory_name='.',
115
 
                                 hardlink=False):
116
 
        """Create a tree in which almost every commit is a merge.
117
 
       
118
 
        No file changes are included.  This produces two trees, 
119
 
        one of which is returned.  Except for the first commit, every
120
 
        commit in its revision-history is a merge another commit in the other
121
 
        tree.  Not hardlinking the working tree, because there are no working 
122
 
        tree files.
123
 
        """
124
 
        from bzrlib.benchmarks.tree_creator.heavily_merged import (
125
 
            HeavilyMergedTreeCreator,
126
 
            )
127
 
        creator = HeavilyMergedTreeCreator(self, link_bzr=hardlink)
128
 
        return creator.create(root=directory_name)
129
 
 
130
 
    def create_with_commits(self, num_files, num_commits, directory_name='.',
131
 
                            hardlink=False):
132
 
        """Create a tree with many files and many commits. Every commit changes
133
 
        exactly one file.
134
 
        
135
 
        :param num_files: number of files to be created
136
 
        :param num_commits: number of commits in the newly created tree
137
 
        """
138
 
        from bzrlib.benchmarks.tree_creator.many_commit import (
139
 
            ManyCommitTreeCreator,
140
 
            )
141
 
        creator = ManyCommitTreeCreator(self, link_bzr=hardlink,
142
 
                                        num_files=num_files,
143
 
                                        num_commits=num_commits)
144
 
        tree = creator.create(root=directory_name)
145
 
        files = ["%s/%s" % (directory_name, fn) for fn in creator.files]
146
 
        return tree, files
147
 
 
148
 
    def commit_some_revisions(self, tree, files, num_commits,
149
 
                              changes_per_commit):
150
 
        """Commit a specified number of revisions to some files in a tree,
151
 
        makeing a specified number of changes per commit.
152
 
 
153
 
        :param tree: The tree in which the changes happen.
154
 
        :param files: The list of files where changes should occur.
155
 
        :param num_commits: The number of commits
156
 
        :param changes_per_commit: The number of files that are touched in 
157
 
        each commit.
158
 
        """
159
 
        for j in range(num_commits):
160
 
            for i in range(changes_per_commit):
161
 
                fn = files[(i + j) % changes_per_commit]
162
 
                content = range(i) + [i, i, i, '']
163
 
                f = open(fn, "w")
164
 
                try:
165
 
                    f.write("\n".join([str(k) for k in content]))
166
 
                finally:
167
 
                    f.close()
168
 
            tree.commit("new revision")
169
 
 
170
 
 
171
 
def test_suite():
172
 
    """Build and return a TestSuite which contains benchmark tests only."""
173
 
    testmod_names = [ \
174
 
                   'bzrlib.benchmarks.bench_add',
175
 
                   'bzrlib.benchmarks.bench_bench',
176
 
                   'bzrlib.benchmarks.bench_bundle',
177
 
                   'bzrlib.benchmarks.bench_cache_utf8',
178
 
                   'bzrlib.benchmarks.bench_checkout',
179
 
                   'bzrlib.benchmarks.bench_commit',
180
 
                   'bzrlib.benchmarks.bench_info',
181
 
                   'bzrlib.benchmarks.bench_inventory',
182
 
                   'bzrlib.benchmarks.bench_log',
183
 
                   'bzrlib.benchmarks.bench_osutils',
184
 
                   'bzrlib.benchmarks.bench_rocks',
185
 
                   'bzrlib.benchmarks.bench_startup',
186
 
                   'bzrlib.benchmarks.bench_status',
187
 
                   'bzrlib.benchmarks.bench_transform',
188
 
                   'bzrlib.benchmarks.bench_workingtree',
189
 
                   'bzrlib.benchmarks.bench_sftp',
190
 
                   'bzrlib.benchmarks.bench_xml',
191
 
                   ]
192
 
    suite = TestLoader().loadTestsFromModuleNames(testmod_names) 
193
 
 
194
 
    # Load any benchmarks from plugins
195
 
    for name, module in plugin.all_plugins().items():
196
 
        if getattr(module, 'bench_suite', None) is not None:
197
 
            suite.addTest(module.bench_suite())
198
 
 
199
 
    return suite