1
# Copyright (C) 2007, 2008 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""Utility for create branches with particular contents."""
19
from bzrlib import bzrdir, errors, memorytree
22
class BranchBuilder(object):
23
"""A BranchBuilder aids creating Branches with particular shapes.
25
The expected way to use BranchBuilder is to construct a
26
BranchBuilder on the transport you want your branch on, and then call
27
appropriate build_ methods on it to get the shape of history you want.
29
This is meant as a helper for the test suite, not as a general class for
33
builder = BranchBuilder(self.get_transport().clone('relpath'))
34
builder.start_series()
35
builder.build_snapshot('rev-id', [],
36
[('add', ('', 'a-root-id', 'directory', None)),
37
('add', ('filename', 'f-id', 'file', 'content\n'))])
38
builder.build_snapshot('rev2-id', ['rev-id'],
39
[('modify', ('f-id', 'new-content\n'))])
40
builder.finish_series()
41
branch = builder.get_branch()
43
:ivar _tree: This is a private member which is not meant to be modified by
44
users of this class. While a 'series' is in progress, it should hold a
45
MemoryTree with the contents of the last commit (ready to be modified
46
by the next build_snapshot command) with a held write lock. Outside of
47
a series in progress, it should be None.
50
def __init__(self, transport, format=None):
51
"""Construct a BranchBuilder on transport.
53
:param transport: The transport the branch should be created on.
54
If the path of the transport does not exist but its parent does
56
:param format: Either a BzrDirFormat, or the name of a format in the
57
bzrdir format registry for the branch to be built.
59
if not transport.has('.'):
63
if isinstance(format, str):
64
format = bzrdir.format_registry.make_bzrdir(format)
65
self._branch = bzrdir.BzrDir.create_branch_convenience(transport.base,
66
format=format, force_new_tree=False)
69
def build_commit(self):
70
"""Build a commit on the branch."""
71
tree = memorytree.MemoryTree.create_on_branch(self._branch)
75
return tree.commit('commit %d' % (self._branch.revno() + 1))
79
def _move_branch_pointer(self, new_revision_id):
80
"""Point self._branch to a different revision id."""
81
self._branch.lock_write()
83
# We don't seem to have a simple set_last_revision(), so we
85
cur_revno, cur_revision_id = self._branch.last_revision_info()
86
g = self._branch.repository.get_graph()
87
new_revno = g.find_distance_to_null(new_revision_id,
88
[(cur_revision_id, cur_revno)])
89
self._branch.set_last_revision_info(new_revno, new_revision_id)
92
if self._tree is not None:
93
# We are currently processing a series, but when switching branch
94
# pointers, it is easiest to just create a new memory tree.
95
# That way we are sure to have the right files-on-disk
96
# We are cheating a little bit here, and locking the new tree
97
# before the old tree is unlocked. But that way the branch stays
99
new_tree = memorytree.MemoryTree.create_on_branch(self._branch)
100
new_tree.lock_write()
102
self._tree = new_tree
104
def start_series(self):
105
"""We will be creating a series of commits.
107
This allows us to hold open the locks while we are processing.
109
Make sure to call 'finish_series' when you are done.
111
if self._tree is not None:
112
raise AssertionError('You cannot start a new series while a'
113
' series is already going.')
114
self._tree = memorytree.MemoryTree.create_on_branch(self._branch)
115
self._tree.lock_write()
117
def finish_series(self):
118
"""Call this after start_series to unlock the various objects."""
122
def build_snapshot(self, revision_id, parent_ids, actions,
124
"""Build a commit, shaped in a specific way.
126
:param revision_id: The handle for the new commit, can be None
127
:param parent_ids: A list of parent_ids to use for the commit.
128
It can be None, which indicates to use the last commit.
129
:param actions: A list of actions to perform. Supported actions are:
130
('add', ('path', 'file-id', 'kind', 'content' or None))
131
('modify', ('file-id', 'new-content'))
132
('unversion', 'file-id')
133
# not supported yet: ('rename', ('orig-path', 'new-path'))
134
:param message: An optional commit message, if not supplied, a default
135
commit message will be written.
136
:return: The revision_id of the new commit
138
if parent_ids is not None:
139
base_id = parent_ids[0]
140
if base_id != self._branch.last_revision():
141
self._move_branch_pointer(base_id)
143
if self._tree is not None:
146
tree = memorytree.MemoryTree.create_on_branch(self._branch)
149
if parent_ids is not None:
150
tree.set_parent_ids(parent_ids)
151
# Unfortunately, MemoryTree.add(directory) just creates an
152
# inventory entry. And the only public function to create a
153
# directory is MemoryTree.mkdir() which creates the directory, but
154
# also always adds it. So we have to use a multi-pass setup.
155
to_add_directories = []
160
to_unversion_ids = []
161
# TODO: MemoryTree doesn't support rename() or
162
# apply_inventory_delta, so we'll postpone allowing renames
165
for action, info in actions:
167
path, file_id, kind, content = info
168
if kind == 'directory':
169
to_add_directories.append((path, file_id))
171
to_add_files.append(path)
172
to_add_file_ids.append(file_id)
173
to_add_kinds.append(kind)
174
if content is not None:
175
new_contents[file_id] = content
176
elif action == 'modify':
177
file_id, content = info
178
new_contents[file_id] = content
179
elif action == 'unversion':
180
to_unversion_ids.append(info)
182
raise ValueError('Unknown build action: "%s"' % (action,))
184
tree.unversion(to_unversion_ids)
185
for path, file_id in to_add_directories:
187
# Special case, because the path already exists
188
tree.add([path], [file_id], ['directory'])
190
tree.mkdir(path, file_id)
191
tree.add(to_add_files, to_add_file_ids, to_add_kinds)
192
for file_id, content in new_contents.iteritems():
193
tree.put_file_bytes_non_atomic(file_id, content)
196
message = u'commit %d' % (self._branch.revno() + 1,)
197
return tree.commit(message, rev_id=revision_id)
201
def get_branch(self):
202
"""Return the branch created by the builder."""
added
removed
bzrlib/branchbuilder.py
