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