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
17
17
"""Utility for create branches with particular contents."""
19
from bzrlib import bzrdir, errors, memorytree
27
22
class BranchBuilder(object):
28
r"""A BranchBuilder aids creating Branches with particular shapes.
23
"""A BranchBuilder aids creating Branches with particular shapes.
30
25
The expected way to use BranchBuilder is to construct a
31
26
BranchBuilder on the transport you want your branch on, and then call
32
27
appropriate build_ methods on it to get the shape of history you want.
34
This is meant as a helper for the test suite, not as a general class for
39
>>> from bzrlib.transport.memory import MemoryTransport
40
>>> builder = BranchBuilder(MemoryTransport("memory:///"))
41
>>> builder.start_series()
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'))])
49
>>> builder.finish_series()
50
>>> branch = builder.get_branch()
52
:ivar _tree: This is a private member which is not meant to be modified by
53
users of this class. While a 'series' is in progress, it should hold a
54
MemoryTree with the contents of the last commit (ready to be modified
55
by the next build_snapshot command) with a held write lock. Outside of
56
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()
59
37
def __init__(self, transport, format=None):
60
38
"""Construct a BranchBuilder on transport.
62
40
:param transport: The transport the branch should be created on.
63
41
If the path of the transport does not exist but its parent does
64
42
it will be created.
65
:param format: Either a BzrDirFormat, or the name of a format in the
66
bzrdir format registry for the branch to be built.
43
:param format: The name of a format in the bzrdir format registry
44
for the branch to be built.
68
46
if not transport.has('.'):
69
47
transport.mkdir('.')
72
if isinstance(format, str):
73
format = bzrdir.format_registry.make_bzrdir(format)
74
50
self._branch = bzrdir.BzrDir.create_branch_convenience(transport.base,
75
format=format, force_new_tree=False)
78
def build_commit(self, **commit_kwargs):
79
"""Build a commit on the branch.
81
This makes a commit with no real file content for when you only want
82
to look at the revision graph structure.
84
:param commit_kwargs: Arguments to pass through to commit, such as
51
format=bzrdir.format_registry.make_bzrdir(format))
53
def build_commit(self):
54
"""Build a commit on the branch."""
87
55
tree = memorytree.MemoryTree.create_on_branch(self._branch)
91
return self._do_commit(tree, **commit_kwargs)
95
def _do_commit(self, tree, message=None, **kwargs):
96
reporter = commit.NullCommitReporter()
98
message = u'commit %d' % (self._branch.revno() + 1,)
99
return tree.commit(message,
103
def _move_branch_pointer(self, new_revision_id):
104
"""Point self._branch to a different revision id."""
105
self._branch.lock_write()
107
# We don't seem to have a simple set_last_revision(), so we
109
cur_revno, cur_revision_id = self._branch.last_revision_info()
110
g = self._branch.repository.get_graph()
111
new_revno = g.find_distance_to_null(new_revision_id,
112
[(cur_revision_id, cur_revno)])
113
self._branch.set_last_revision_info(new_revno, new_revision_id)
115
self._branch.unlock()
116
if self._tree is not None:
117
# We are currently processing a series, but when switching branch
118
# pointers, it is easiest to just create a new memory tree.
119
# That way we are sure to have the right files-on-disk
120
# We are cheating a little bit here, and locking the new tree
121
# before the old tree is unlocked. But that way the branch stays
123
new_tree = memorytree.MemoryTree.create_on_branch(self._branch)
124
new_tree.lock_write()
126
self._tree = new_tree
128
def start_series(self):
129
"""We will be creating a series of commits.
131
This allows us to hold open the locks while we are processing.
133
Make sure to call 'finish_series' when you are done.
135
if self._tree is not None:
136
raise AssertionError('You cannot start a new series while a'
137
' series is already going.')
138
self._tree = memorytree.MemoryTree.create_on_branch(self._branch)
139
self._tree.lock_write()
141
def finish_series(self):
142
"""Call this after start_series to unlock the various objects."""
146
def build_snapshot(self, revision_id, parent_ids, actions,
147
message=None, timestamp=None):
148
"""Build a commit, shaped in a specific way.
150
:param revision_id: The handle for the new commit, can be None
151
:param parent_ids: A list of parent_ids to use for the commit.
152
It can be None, which indicates to use the last commit.
153
:param actions: A list of actions to perform. Supported actions are:
154
('add', ('path', 'file-id', 'kind', 'content' or None))
155
('modify', ('file-id', 'new-content'))
156
('unversion', 'file-id')
157
('rename', ('orig-path', 'new-path'))
158
:param message: An optional commit message, if not supplied, a default
159
commit message will be written.
160
:param timestamp: If non-None, set the timestamp of the commit to this
162
:return: The revision_id of the new commit
164
if parent_ids is not None:
165
base_id = parent_ids[0]
166
if base_id != self._branch.last_revision():
167
self._move_branch_pointer(base_id)
169
if self._tree is not None:
172
tree = memorytree.MemoryTree.create_on_branch(self._branch)
175
if parent_ids is not None:
176
tree.set_parent_ids(parent_ids)
177
# Unfortunately, MemoryTree.add(directory) just creates an
178
# inventory entry. And the only public function to create a
179
# directory is MemoryTree.mkdir() which creates the directory, but
180
# also always adds it. So we have to use a multi-pass setup.
181
to_add_directories = []
186
to_unversion_ids = []
188
for action, info in actions:
190
path, file_id, kind, content = info
191
if kind == 'directory':
192
to_add_directories.append((path, file_id))
194
to_add_files.append(path)
195
to_add_file_ids.append(file_id)
196
to_add_kinds.append(kind)
197
if content is not None:
198
new_contents[file_id] = content
199
elif action == 'modify':
200
file_id, content = info
201
new_contents[file_id] = content
202
elif action == 'unversion':
203
to_unversion_ids.append(info)
204
elif action == 'rename':
205
from_relpath, to_relpath = info
206
to_rename.append((from_relpath, to_relpath))
208
raise ValueError('Unknown build action: "%s"' % (action,))
210
tree.unversion(to_unversion_ids)
211
for path, file_id in to_add_directories:
213
# Special case, because the path already exists
214
tree.add([path], [file_id], ['directory'])
216
tree.mkdir(path, file_id)
217
for from_relpath, to_relpath in to_rename:
218
tree.rename_one(from_relpath, to_relpath)
219
tree.add(to_add_files, to_add_file_ids, to_add_kinds)
220
for file_id, content in new_contents.iteritems():
221
tree.put_file_bytes_non_atomic(file_id, content)
222
return self._do_commit(tree, message=message, rev_id=revision_id,
59
return tree.commit('commit %d' % (self._branch.revno() + 1))
added
removed
bzrlib/branchbuilder.py
