← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branchbuilder.py

  • Committer: Ian Clatworthy
  • Date: 2007-12-07 05:31:54 UTC
  • mto: (3092.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 3093.
  • Revision ID: ian.clatworthy@internode.on.net-20071207053154-k9tmyczcf8niwonm
fix efficiency of local commit detection as recommended by jameinel's review

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/branchbuilder.py
1
 
# Copyright (C) 2007, 2008, 2009 Canonical Ltd
 
1
# Copyright (C) 2007 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
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""Utility for create branches with particular contents."""
18
18
 
19
 
from bzrlib import (
20
 
    bzrdir,
21
 
    commit,
22
 
    errors,
23
 
    memorytree,
24
 
    revision,
25
 
    )
 
19
from bzrlib import bzrdir, errors, memorytree
26
20
 
27
21
 
28
22
class BranchBuilder(object):
29
 
    r"""A BranchBuilder aids creating Branches with particular shapes.
30
 
 
 
23
    """A BranchBuilder aids creating Branches with particular shapes.
 
24
    
31
25
    The expected way to use BranchBuilder is to construct a
32
26
    BranchBuilder on the transport you want your branch on, and then call
33
27
    appropriate build_ methods on it to get the shape of history you want.
34
28
 
35
 
    This is meant as a helper for the test suite, not as a general class for
36
 
    real data.
37
 
 
38
29
    For instance:
39
 
 
40
 
    >>> from bzrlib.transport.memory import MemoryTransport
41
 
    >>> builder = BranchBuilder(MemoryTransport("memory:///"))
42
 
    >>> builder.start_series()
43
 
    >>> builder.build_snapshot('rev-id', None, [
44
 
    ...     ('add', ('', 'root-id', 'directory', '')),
45
 
    ...     ('add', ('filename', 'f-id', 'file', 'content\n'))])
46
 
    'rev-id'
47
 
    >>> builder.build_snapshot('rev2-id', ['rev-id'],
48
 
    ...     [('modify', ('f-id', 'new-content\n'))])
49
 
    'rev2-id'
50
 
    >>> builder.finish_series()
51
 
    >>> branch = builder.get_branch()
52
 
 
53
 
    :ivar _tree: This is a private member which is not meant to be modified by
54
 
        users of this class. While a 'series' is in progress, it should hold a
55
 
        MemoryTree with the contents of the last commit (ready to be modified
56
 
        by the next build_snapshot command) with a held write lock. Outside of
57
 
        a series in progress, it should be None.
 
30
      builder = BranchBuilder(self.get_transport().clone('relpath'))
 
31
      builder.build_commit()
 
32
      builder.build_commit()
 
33
      builder.build_commit()
 
34
      branch = builder.get_branch()
58
35
    """
59
36
 
60
 
    def __init__(self, transport=None, format=None, branch=None):
 
37
    def __init__(self, transport, format=None):
61
38
        """Construct a BranchBuilder on transport.
62
 
 
 
39
        
63
40
        :param transport: The transport the branch should be created on.
64
41
            If the path of the transport does not exist but its parent does
65
42
            it will be created.
66
 
        :param format: Either a BzrDirFormat, or the name of a format in the
67
 
            bzrdir format registry for the branch to be built.
68
 
        :param branch: An already constructed branch to use.  This param is
69
 
            mutually exclusive with the transport and format params.
70
 
        """
71
 
        if branch is not None:
72
 
            if format is not None:
73
 
                raise AssertionError(
74
 
                    "branch and format kwargs are mutually exclusive")
75
 
            if transport is not None:
76
 
                raise AssertionError(
77
 
                    "branch and transport kwargs are mutually exclusive")
78
 
            self._branch = branch
79
 
        else:
80
 
            if not transport.has('.'):
81
 
                transport.mkdir('.')
82
 
            if format is None:
83
 
                format = 'default'
84
 
            if isinstance(format, str):
85
 
                format = bzrdir.format_registry.make_bzrdir(format)
86
 
            self._branch = bzrdir.BzrDir.create_branch_convenience(
87
 
                transport.base, format=format, force_new_tree=False)
88
 
        self._tree = None
89
 
 
90
 
    def build_commit(self, **commit_kwargs):
91
 
        """Build a commit on the branch.
92
 
 
93
 
        This makes a commit with no real file content for when you only want
94
 
        to look at the revision graph structure.
95
 
 
96
 
        :param commit_kwargs: Arguments to pass through to commit, such as
97
 
             timestamp.
98
 
        """
 
43
        :param format: The name of a format in the bzrdir format registry
 
44
            for the branch to be built.
 
45
        """
 
46
        if not transport.has('.'):
 
47
            transport.mkdir('.')
 
48
        if format is None:
 
49
            format = 'default'
 
50
        self._branch = bzrdir.BzrDir.create_branch_convenience(transport.base,
 
51
            format=bzrdir.format_registry.make_bzrdir(format))
 
52
 
 
53
    def build_commit(self):
 
54
        """Build a commit on the branch."""
99
55
        tree = memorytree.MemoryTree.create_on_branch(self._branch)
100
56
        tree.lock_write()
101
57
        try:
102
58
            tree.add('')
103
 
            return self._do_commit(tree, **commit_kwargs)
104
 
        finally:
105
 
            tree.unlock()
106
 
 
107
 
    def _do_commit(self, tree, message=None, message_callback=None, **kwargs):
108
 
        reporter = commit.NullCommitReporter()
109
 
        if message is None and message_callback is None:
110
 
            message = u'commit %d' % (self._branch.revno() + 1,)
111
 
        return tree.commit(message, message_callback=message_callback,
112
 
            reporter=reporter,
113
 
            **kwargs)
114
 
 
115
 
    def _move_branch_pointer(self, new_revision_id,
116
 
        allow_leftmost_as_ghost=False):
117
 
        """Point self._branch to a different revision id."""
118
 
        self._branch.lock_write()
119
 
        try:
120
 
            # We don't seem to have a simple set_last_revision(), so we
121
 
            # implement it here.
122
 
            cur_revno, cur_revision_id = self._branch.last_revision_info()
123
 
            try:
124
 
                g = self._branch.repository.get_graph()
125
 
                new_revno = g.find_distance_to_null(new_revision_id,
126
 
                    [(cur_revision_id, cur_revno)])
127
 
                self._branch.set_last_revision_info(new_revno, new_revision_id)
128
 
            except errors.GhostRevisionsHaveNoRevno:
129
 
                if not allow_leftmost_as_ghost:
130
 
                    raise
131
 
                new_revno = 1
132
 
        finally:
133
 
            self._branch.unlock()
134
 
        if self._tree is not None:
135
 
            # We are currently processing a series, but when switching branch
136
 
            # pointers, it is easiest to just create a new memory tree.
137
 
            # That way we are sure to have the right files-on-disk
138
 
            # We are cheating a little bit here, and locking the new tree
139
 
            # before the old tree is unlocked. But that way the branch stays
140
 
            # locked throughout.
141
 
            new_tree = memorytree.MemoryTree.create_on_branch(self._branch)
142
 
            new_tree.lock_write()
143
 
            self._tree.unlock()
144
 
            self._tree = new_tree
145
 
 
146
 
    def start_series(self):
147
 
        """We will be creating a series of commits.
148
 
 
149
 
        This allows us to hold open the locks while we are processing.
150
 
 
151
 
        Make sure to call 'finish_series' when you are done.
152
 
        """
153
 
        if self._tree is not None:
154
 
            raise AssertionError('You cannot start a new series while a'
155
 
                                 ' series is already going.')
156
 
        self._tree = memorytree.MemoryTree.create_on_branch(self._branch)
157
 
        self._tree.lock_write()
158
 
 
159
 
    def finish_series(self):
160
 
        """Call this after start_series to unlock the various objects."""
161
 
        self._tree.unlock()
162
 
        self._tree = None
163
 
 
164
 
    def build_snapshot(self, revision_id, parent_ids, actions,
165
 
        message=None, timestamp=None, allow_leftmost_as_ghost=False,
166
 
        committer=None, timezone=None, message_callback=None):
167
 
        """Build a commit, shaped in a specific way.
168
 
 
169
 
        Most of the actions are self-explanatory.  'flush' is special action to
170
 
        break a series of actions into discrete steps so that complex changes
171
 
        (such as unversioning a file-id and re-adding it with a different kind)
172
 
        can be expressed in a way that will clearly work.
173
 
 
174
 
        :param revision_id: The handle for the new commit, can be None
175
 
        :param parent_ids: A list of parent_ids to use for the commit.
176
 
            It can be None, which indicates to use the last commit.
177
 
        :param actions: A list of actions to perform. Supported actions are:
178
 
            ('add', ('path', 'file-id', 'kind', 'content' or None))
179
 
            ('modify', ('file-id', 'new-content'))
180
 
            ('unversion', 'file-id')
181
 
            ('rename', ('orig-path', 'new-path'))
182
 
            ('flush', None)
183
 
        :param message: An optional commit message, if not supplied, a default
184
 
            commit message will be written.
185
 
        :param message_callback: A message callback to use for the commit, as
186
 
            per mutabletree.commit.
187
 
        :param timestamp: If non-None, set the timestamp of the commit to this
188
 
            value.
189
 
        :param timezone: An optional timezone for timestamp.
190
 
        :param committer: An optional username to use for commit
191
 
        :param allow_leftmost_as_ghost: True if the leftmost parent should be
192
 
            permitted to be a ghost.
193
 
        :return: The revision_id of the new commit
194
 
        """
195
 
        if parent_ids is not None:
196
 
            if len(parent_ids) == 0:
197
 
                base_id = revision.NULL_REVISION
198
 
            else:
199
 
                base_id = parent_ids[0]
200
 
            if base_id != self._branch.last_revision():
201
 
                self._move_branch_pointer(base_id,
202
 
                    allow_leftmost_as_ghost=allow_leftmost_as_ghost)
203
 
 
204
 
        if self._tree is not None:
205
 
            tree = self._tree
206
 
        else:
207
 
            tree = memorytree.MemoryTree.create_on_branch(self._branch)
208
 
        tree.lock_write()
209
 
        try:
210
 
            if parent_ids is not None:
211
 
                tree.set_parent_ids(parent_ids,
212
 
                    allow_leftmost_as_ghost=allow_leftmost_as_ghost)
213
 
            # Unfortunately, MemoryTree.add(directory) just creates an
214
 
            # inventory entry. And the only public function to create a
215
 
            # directory is MemoryTree.mkdir() which creates the directory, but
216
 
            # also always adds it. So we have to use a multi-pass setup.
217
 
            pending = _PendingActions()
218
 
            for action, info in actions:
219
 
                if action == 'add':
220
 
                    path, file_id, kind, content = info
221
 
                    if kind == 'directory':
222
 
                        pending.to_add_directories.append((path, file_id))
223
 
                    else:
224
 
                        pending.to_add_files.append(path)
225
 
                        pending.to_add_file_ids.append(file_id)
226
 
                        pending.to_add_kinds.append(kind)
227
 
                        if content is not None:
228
 
                            pending.new_contents[file_id] = content
229
 
                elif action == 'modify':
230
 
                    file_id, content = info
231
 
                    pending.new_contents[file_id] = content
232
 
                elif action == 'unversion':
233
 
                    pending.to_unversion_ids.add(info)
234
 
                elif action == 'rename':
235
 
                    from_relpath, to_relpath = info
236
 
                    pending.to_rename.append((from_relpath, to_relpath))
237
 
                elif action == 'flush':
238
 
                    self._flush_pending(tree, pending)
239
 
                    pending = _PendingActions()
240
 
                else:
241
 
                    raise ValueError('Unknown build action: "%s"' % (action,))
242
 
            self._flush_pending(tree, pending)
243
 
            return self._do_commit(tree, message=message, rev_id=revision_id,
244
 
                timestamp=timestamp, timezone=timezone, committer=committer,
245
 
                message_callback=message_callback)
246
 
        finally:
247
 
            tree.unlock()
248
 
 
249
 
    def _flush_pending(self, tree, pending):
250
 
        """Flush the pending actions in 'pending', i.e. apply them to 'tree'."""
251
 
        for path, file_id in pending.to_add_directories:
252
 
            if path == '':
253
 
                old_id = tree.path2id(path)
254
 
                if old_id is not None and old_id in pending.to_unversion_ids:
255
 
                    # We're overwriting this path, no need to unversion
256
 
                    pending.to_unversion_ids.discard(old_id)
257
 
                # Special case, because the path already exists
258
 
                tree.add([path], [file_id], ['directory'])
259
 
            else:
260
 
                tree.mkdir(path, file_id)
261
 
        for from_relpath, to_relpath in pending.to_rename:
262
 
            tree.rename_one(from_relpath, to_relpath)
263
 
        if pending.to_unversion_ids:
264
 
            tree.unversion(pending.to_unversion_ids)
265
 
        tree.add(pending.to_add_files, pending.to_add_file_ids, pending.to_add_kinds)
266
 
        for file_id, content in pending.new_contents.iteritems():
267
 
            tree.put_file_bytes_non_atomic(file_id, content)
 
59
            return tree.commit('commit %d' % (self._branch.revno() + 1))
 
60
        finally:
 
61
            tree.unlock()
268
62
 
269
63
    def get_branch(self):
270
64
        """Return the branch created by the builder."""
271
65
        return self._branch
272
 
 
273
 
 
274
 
class _PendingActions(object):
275
 
    """Pending actions for build_snapshot to take.
276
 
 
277
 
    This is just a simple class to hold a bunch of the intermediate state of
278
 
    build_snapshot in single object.
279
 
    """
280
 
 
281
 
    def __init__(self):
282
 
        self.to_add_directories = []
283
 
        self.to_add_files = []
284
 
        self.to_add_file_ids = []
285
 
        self.to_add_kinds = []
286
 
        self.new_contents = {}
287
 
        self.to_unversion_ids = set()
288
 
        self.to_rename = []
289