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
29
class BranchBuilder(object):
30
r"""A BranchBuilder aids creating Branches with particular shapes.
32
The expected way to use BranchBuilder is to construct a
33
BranchBuilder on the transport you want your branch on, and then call
34
appropriate build_ methods on it to get the shape of history you want.
36
This is meant as a helper for the test suite, not as a general class for
41
>>> from breezy.transport.memory import MemoryTransport
42
>>> builder = BranchBuilder(MemoryTransport("memory:///"))
43
>>> builder.start_series()
44
>>> builder.build_snapshot(None, [
45
... ('add', ('', b'root-id', 'directory', '')),
46
... ('add', ('filename', b'f-id', 'file', b'content\n'))],
47
... revision_id=b'rev-id')
49
>>> builder.build_snapshot([b'rev-id'],
50
... [('modify', ('filename', b'new-content\n'))],
51
... revision_id=b'rev2-id')
53
>>> builder.finish_series()
54
>>> branch = builder.get_branch()
56
:ivar _tree: This is a private member which is not meant to be modified by
57
users of this class. While a 'series' is in progress, it should hold a
58
MemoryTree with the contents of the last commit (ready to be modified
59
by the next build_snapshot command) with a held write lock. Outside of
60
a series in progress, it should be None.
63
def __init__(self, transport=None, format=None, branch=None):
64
"""Construct a BranchBuilder on transport.
66
:param transport: The transport the branch should be created on.
67
If the path of the transport does not exist but its parent does
69
:param format: Either a BzrDirFormat, or the name of a format in the
70
controldir format registry for the branch to be built.
71
:param branch: An already constructed branch to use. This param is
72
mutually exclusive with the transport and format params.
74
if branch is not None:
75
if format is not None:
77
"branch and format kwargs are mutually exclusive")
78
if transport is not None:
80
"branch and transport kwargs are mutually exclusive")
83
if not transport.has('.'):
87
if isinstance(format, str):
88
format = controldir.format_registry.make_controldir(format)
89
self._branch = controldir.ControlDir.create_branch_convenience(
90
transport.base, format=format, force_new_tree=False)
93
def build_commit(self, parent_ids=None, allow_leftmost_as_ghost=False,
95
"""Build a commit on the branch.
97
This makes a commit with no real file content for when you only want
98
to look at the revision graph structure.
100
:param commit_kwargs: Arguments to pass through to commit, such as
103
if parent_ids is not None:
104
if len(parent_ids) == 0:
105
base_id = revision.NULL_REVISION
107
base_id = parent_ids[0]
108
if base_id != self._branch.last_revision():
109
self._move_branch_pointer(
110
base_id, allow_leftmost_as_ghost=allow_leftmost_as_ghost)
111
tree = self._branch.create_memorytree()
112
with tree.lock_write():
113
if parent_ids is not None:
116
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
118
return self._do_commit(tree, **commit_kwargs)
120
def _do_commit(self, tree, message=None, message_callback=None, **kwargs):
121
reporter = commit.NullCommitReporter()
122
if message is None and message_callback is None:
123
message = u'commit %d' % (self._branch.revno() + 1,)
124
return tree.commit(message, message_callback=message_callback,
125
reporter=reporter, **kwargs)
127
def _move_branch_pointer(self, new_revision_id,
128
allow_leftmost_as_ghost=False):
129
"""Point self._branch to a different revision id."""
130
with self._branch.lock_write():
131
# We don't seem to have a simple set_last_revision(), so we
133
cur_revno, cur_revision_id = self._branch.last_revision_info()
135
g = self._branch.repository.get_graph()
136
new_revno = g.find_distance_to_null(
137
new_revision_id, [(cur_revision_id, cur_revno)])
138
self._branch.set_last_revision_info(new_revno, new_revision_id)
139
except errors.GhostRevisionsHaveNoRevno:
140
if not allow_leftmost_as_ghost:
143
if self._tree is not None:
144
# We are currently processing a series, but when switching branch
145
# pointers, it is easiest to just create a new memory tree.
146
# That way we are sure to have the right files-on-disk
147
# We are cheating a little bit here, and locking the new tree
148
# before the old tree is unlocked. But that way the branch stays
150
new_tree = self._branch.create_memorytree()
151
new_tree.lock_write()
153
self._tree = new_tree
155
def start_series(self):
156
"""We will be creating a series of commits.
158
This allows us to hold open the locks while we are processing.
160
Make sure to call 'finish_series' when you are done.
162
if self._tree is not None:
163
raise AssertionError('You cannot start a new series while a'
164
' series is already going.')
165
self._tree = self._branch.create_memorytree()
166
self._tree.lock_write()
168
def finish_series(self):
169
"""Call this after start_series to unlock the various objects."""
173
def build_snapshot(self, parent_ids, actions, message=None, timestamp=None,
174
allow_leftmost_as_ghost=False, committer=None,
175
timezone=None, message_callback=None, revision_id=None):
176
"""Build a commit, shaped in a specific way.
178
Most of the actions are self-explanatory. 'flush' is special action to
179
break a series of actions into discrete steps so that complex changes
180
(such as unversioning a file-id and re-adding it with a different kind)
181
can be expressed in a way that will clearly work.
183
:param parent_ids: A list of parent_ids to use for the commit.
184
It can be None, which indicates to use the last commit.
185
:param actions: A list of actions to perform. Supported actions are:
186
('add', ('path', b'file-id', 'kind', b'content' or None))
187
('modify', ('path', b'new-content'))
188
('unversion', 'path')
189
('rename', ('orig-path', 'new-path'))
191
:param message: An optional commit message, if not supplied, a default
192
commit message will be written.
193
:param message_callback: A message callback to use for the commit, as
194
per mutabletree.commit.
195
:param timestamp: If non-None, set the timestamp of the commit to this
197
:param timezone: An optional timezone for timestamp.
198
:param committer: An optional username to use for commit
199
:param allow_leftmost_as_ghost: True if the leftmost parent should be
200
permitted to be a ghost.
201
:param revision_id: The handle for the new commit, can be None
202
:return: The revision_id of the new commit
204
if parent_ids is not None:
205
if len(parent_ids) == 0:
206
base_id = revision.NULL_REVISION
208
base_id = parent_ids[0]
209
if base_id != self._branch.last_revision():
210
self._move_branch_pointer(
211
base_id, allow_leftmost_as_ghost=allow_leftmost_as_ghost)
213
if self._tree is not None:
216
tree = self._branch.create_memorytree()
217
with tree.lock_write():
218
if parent_ids is not None:
221
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
222
# Unfortunately, MemoryTree.add(directory) just creates an
223
# inventory entry. And the only public function to create a
224
# directory is MemoryTree.mkdir() which creates the directory, but
225
# also always adds it. So we have to use a multi-pass setup.
226
pending = _PendingActions()
227
for action, info in actions:
229
path, file_id, kind, content = info
230
if kind == 'directory':
231
pending.to_add_directories.append((path, file_id))
233
pending.to_add_files.append(path)
234
pending.to_add_file_ids.append(file_id)
235
pending.to_add_kinds.append(kind)
236
if content is not None:
237
pending.new_contents[path] = content
238
elif action == 'modify':
240
pending.new_contents[path] = content
241
elif action == 'unversion':
242
pending.to_unversion_paths.add(info)
243
elif action == 'rename':
244
from_relpath, to_relpath = info
245
pending.to_rename.append((from_relpath, to_relpath))
246
elif action == 'flush':
247
self._flush_pending(tree, pending)
248
pending = _PendingActions()
250
raise ValueError('Unknown build action: "%s"' % (action,))
251
self._flush_pending(tree, pending)
252
return self._do_commit(
253
tree, message=message, rev_id=revision_id,
254
timestamp=timestamp, timezone=timezone, committer=committer,
255
message_callback=message_callback)
257
def _flush_pending(self, tree, pending):
258
"""Flush the pending actions in 'pending', i.e. apply them to tree."""
259
for path, file_id in pending.to_add_directories:
261
if tree.has_filename(path) \
262
and path in pending.to_unversion_paths:
263
# We're overwriting this path, no need to unversion
264
pending.to_unversion_paths.discard(path)
265
# Special case, because the path already exists
266
tree.add([path], [file_id], ['directory'])
268
tree.mkdir(path, file_id)
269
for from_relpath, to_relpath in pending.to_rename:
270
tree.rename_one(from_relpath, to_relpath)
271
if pending.to_unversion_paths:
272
tree.unversion(pending.to_unversion_paths)
273
tree.add(pending.to_add_files, pending.to_add_file_ids,
274
pending.to_add_kinds)
275
for path, content in pending.new_contents.items():
276
tree.put_file_bytes_non_atomic(path, content)
278
def get_branch(self):
279
"""Return the branch created by the builder."""
283
class _PendingActions(object):
284
"""Pending actions for build_snapshot to take.
286
This is just a simple class to hold a bunch of the intermediate state of
287
build_snapshot in single object.
291
self.to_add_directories = []
292
self.to_add_files = []
293
self.to_add_file_ids = []
294
self.to_add_kinds = []
295
self.new_contents = {}
296
self.to_unversion_paths = set()
added
removed
breezy/branchbuilder.py
