39
>>> from breezy.transport.memory import MemoryTransport
39
>>> from bzrlib.transport.memory import MemoryTransport
40
40
>>> builder = BranchBuilder(MemoryTransport("memory:///"))
41
41
>>> builder.start_series()
42
>>> builder.build_snapshot(None, [
43
... ('add', ('', b'root-id', 'directory', '')),
44
... ('add', ('filename', b'f-id', 'file', b'content\n'))],
45
... revision_id=b'rev-id')
47
>>> builder.build_snapshot([b'rev-id'],
48
... [('modify', ('filename', b'new-content\n'))],
49
... revision_id=b'rev2-id')
42
>>> builder.build_snapshot('rev-id', None, [
43
... ('add', ('', 'root-id', 'directory', '')),
44
... ('add', ('filename', 'f-id', 'file', 'content\n'))])
46
>>> builder.build_snapshot('rev2-id', ['rev-id'],
47
... [('modify', ('f-id', 'new-content\n'))])
51
49
>>> builder.finish_series()
52
50
>>> branch = builder.get_branch()
98
95
:param commit_kwargs: Arguments to pass through to commit, such as
101
if parent_ids is not None:
102
if len(parent_ids) == 0:
103
base_id = revision.NULL_REVISION
105
base_id = parent_ids[0]
106
if base_id != self._branch.last_revision():
107
self._move_branch_pointer(
108
base_id, allow_leftmost_as_ghost=allow_leftmost_as_ghost)
109
tree = self._branch.create_memorytree()
110
with tree.lock_write():
111
if parent_ids is not None:
114
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
98
tree = memorytree.MemoryTree.create_on_branch(self._branch)
116
102
return self._do_commit(tree, **commit_kwargs)
118
def _do_commit(self, tree, message=None, message_callback=None, **kwargs):
106
def _do_commit(self, tree, message=None, **kwargs):
119
107
reporter = commit.NullCommitReporter()
120
if message is None and message_callback is None:
121
109
message = u'commit %d' % (self._branch.revno() + 1,)
122
return tree.commit(message, message_callback=message_callback,
123
reporter=reporter, **kwargs)
110
return tree.commit(message,
125
114
def _move_branch_pointer(self, new_revision_id,
126
allow_leftmost_as_ghost=False):
115
allow_leftmost_as_ghost=False):
127
116
"""Point self._branch to a different revision id."""
128
with self._branch.lock_write():
117
self._branch.lock_write()
129
119
# We don't seem to have a simple set_last_revision(), so we
130
120
# implement it here.
131
121
cur_revno, cur_revision_id = self._branch.last_revision_info()
133
123
g = self._branch.repository.get_graph()
134
new_revno = g.find_distance_to_null(
135
new_revision_id, [(cur_revision_id, cur_revno)])
124
new_revno = g.find_distance_to_null(new_revision_id,
125
[(cur_revision_id, cur_revno)])
136
126
self._branch.set_last_revision_info(new_revno, new_revision_id)
137
127
except errors.GhostRevisionsHaveNoRevno:
138
128
if not allow_leftmost_as_ghost:
132
self._branch.unlock()
141
133
if self._tree is not None:
142
134
# We are currently processing a series, but when switching branch
143
135
# pointers, it is easiest to just create a new memory tree.
168
160
self._tree.unlock()
169
161
self._tree = None
171
def build_snapshot(self, parent_ids, actions, message=None, timestamp=None,
172
allow_leftmost_as_ghost=False, committer=None,
173
timezone=None, message_callback=None, revision_id=None):
163
def build_snapshot(self, revision_id, parent_ids, actions,
164
message=None, timestamp=None, allow_leftmost_as_ghost=False,
165
committer=None, timezone=None):
174
166
"""Build a commit, shaped in a specific way.
176
Most of the actions are self-explanatory. 'flush' is special action to
177
break a series of actions into discrete steps so that complex changes
178
(such as unversioning a file-id and re-adding it with a different kind)
179
can be expressed in a way that will clearly work.
168
:param revision_id: The handle for the new commit, can be None
181
169
:param parent_ids: A list of parent_ids to use for the commit.
182
170
It can be None, which indicates to use the last commit.
183
171
:param actions: A list of actions to perform. Supported actions are:
184
('add', ('path', b'file-id', 'kind', b'content' or None))
185
('modify', ('path', b'new-content'))
186
('unversion', 'path')
172
('add', ('path', 'file-id', 'kind', 'content' or None))
173
('modify', ('file-id', 'new-content'))
174
('unversion', 'file-id')
187
175
('rename', ('orig-path', 'new-path'))
189
176
:param message: An optional commit message, if not supplied, a default
190
177
commit message will be written.
191
:param message_callback: A message callback to use for the commit, as
192
per mutabletree.commit.
193
178
:param timestamp: If non-None, set the timestamp of the commit to this
195
180
:param timezone: An optional timezone for timestamp.
196
181
:param committer: An optional username to use for commit
197
182
:param allow_leftmost_as_ghost: True if the leftmost parent should be
198
183
permitted to be a ghost.
199
:param revision_id: The handle for the new commit, can be None
200
184
:return: The revision_id of the new commit
202
186
if parent_ids is not None:
203
if len(parent_ids) == 0:
204
base_id = revision.NULL_REVISION
206
base_id = parent_ids[0]
187
base_id = parent_ids[0]
207
188
if base_id != self._branch.last_revision():
208
self._move_branch_pointer(
209
base_id, allow_leftmost_as_ghost=allow_leftmost_as_ghost)
189
self._move_branch_pointer(base_id,
190
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
211
192
if self._tree is not None:
212
193
tree = self._tree
214
tree = self._branch.create_memorytree()
215
with tree.lock_write():
195
tree = memorytree.MemoryTree.create_on_branch(self._branch)
216
198
if parent_ids is not None:
199
tree.set_parent_ids(parent_ids,
219
200
allow_leftmost_as_ghost=allow_leftmost_as_ghost)
220
201
# Unfortunately, MemoryTree.add(directory) just creates an
221
202
# inventory entry. And the only public function to create a
222
203
# directory is MemoryTree.mkdir() which creates the directory, but
223
204
# also always adds it. So we have to use a multi-pass setup.
224
pending = _PendingActions()
205
to_add_directories = []
210
to_unversion_ids = []
225
212
for action, info in actions:
226
213
if action == 'add':
227
214
path, file_id, kind, content = info
228
215
if kind == 'directory':
229
pending.to_add_directories.append((path, file_id))
216
to_add_directories.append((path, file_id))
231
pending.to_add_files.append(path)
232
pending.to_add_file_ids.append(file_id)
233
pending.to_add_kinds.append(kind)
218
to_add_files.append(path)
219
to_add_file_ids.append(file_id)
220
to_add_kinds.append(kind)
234
221
if content is not None:
235
pending.new_contents[path] = content
222
new_contents[file_id] = content
236
223
elif action == 'modify':
238
pending.new_contents[path] = content
224
file_id, content = info
225
new_contents[file_id] = content
239
226
elif action == 'unversion':
240
pending.to_unversion_paths.add(info)
227
to_unversion_ids.append(info)
241
228
elif action == 'rename':
242
229
from_relpath, to_relpath = info
243
pending.to_rename.append((from_relpath, to_relpath))
244
elif action == 'flush':
245
self._flush_pending(tree, pending)
246
pending = _PendingActions()
230
to_rename.append((from_relpath, to_relpath))
248
232
raise ValueError('Unknown build action: "%s"' % (action,))
249
self._flush_pending(tree, pending)
250
return self._do_commit(
251
tree, message=message, rev_id=revision_id,
252
timestamp=timestamp, timezone=timezone, committer=committer,
253
message_callback=message_callback)
255
def _flush_pending(self, tree, pending):
256
"""Flush the pending actions in 'pending', i.e. apply them to tree."""
257
for path, file_id in pending.to_add_directories:
259
if tree.has_filename(path) \
260
and path in pending.to_unversion_paths:
261
# We're overwriting this path, no need to unversion
262
pending.to_unversion_paths.discard(path)
263
# Special case, because the path already exists
264
tree.add([path], [file_id], ['directory'])
266
tree.mkdir(path, file_id)
267
for from_relpath, to_relpath in pending.to_rename:
268
tree.rename_one(from_relpath, to_relpath)
269
if pending.to_unversion_paths:
270
tree.unversion(pending.to_unversion_paths)
271
tree.add(pending.to_add_files, pending.to_add_file_ids,
272
pending.to_add_kinds)
273
for path, content in pending.new_contents.items():
274
tree.put_file_bytes_non_atomic(path, content)
234
tree.unversion(to_unversion_ids)
235
for path, file_id in to_add_directories:
237
# Special case, because the path already exists
238
tree.add([path], [file_id], ['directory'])
240
tree.mkdir(path, file_id)
241
for from_relpath, to_relpath in to_rename:
242
tree.rename_one(from_relpath, to_relpath)
243
tree.add(to_add_files, to_add_file_ids, to_add_kinds)
244
for file_id, content in new_contents.iteritems():
245
tree.put_file_bytes_non_atomic(file_id, content)
246
return self._do_commit(tree, message=message, rev_id=revision_id,
247
timestamp=timestamp, timezone=timezone, committer=committer)
276
251
def get_branch(self):
277
252
"""Return the branch created by the builder."""
278
253
return self._branch
281
class _PendingActions(object):
282
"""Pending actions for build_snapshot to take.
284
This is just a simple class to hold a bunch of the intermediate state of
285
build_snapshot in single object.
289
self.to_add_directories = []
290
self.to_add_files = []
291
self.to_add_file_ids = []
292
self.to_add_kinds = []
293
self.new_contents = {}
294
self.to_unversion_paths = set()