1
# Copyright (C) 2007 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.
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()
37
def __init__(self, transport, format=None):
38
"""Construct a BranchBuilder on transport.
40
:param transport: The transport the branch should be created on.
41
If the path of the transport does not exist but its parent does
43
:param format: The name of a format in the bzrdir format registry
44
for the branch to be built.
46
if not transport.has('.'):
50
if isinstance(format, str):
51
format = bzrdir.format_registry.make_bzrdir(format)
52
self._branch = bzrdir.BzrDir.create_branch_convenience(transport.base,
53
format=format, force_new_tree=False)
55
def build_commit(self):
56
"""Build a commit on the branch."""
57
tree = memorytree.MemoryTree.create_on_branch(self._branch)
61
return tree.commit('commit %d' % (self._branch.revno() + 1))
65
def _move_branch_pointer(self, new_revision_id):
66
"""Point self._branch to a different revision id."""
67
self._branch.lock_write()
69
# We don't seem to have a simple set_last_revision(), so we
71
cur_revno, cur_revision_id = self._branch.last_revision_info()
72
g = self._branch.repository.get_graph()
73
new_revno = g.find_distance_to_null(new_revision_id,
74
[(cur_revision_id, cur_revno)])
75
self._branch.set_last_revision_info(new_revno, new_revision_id)
79
def build_snapshot(self, revision_id, parent_ids, actions,
81
"""Build a commit, shaped in a specific way.
83
:param revision_id: The handle for the new commit, can be None
84
:param parent_ids: A list of parent_ids to use for the commit.
85
It can be None, which indicates to use the last commit.
86
:param actions: A list of actions to perform. Supported actions are:
87
('add', ('path', 'file-id', 'kind', 'content' or None))
88
('modify', ('file-id', 'new-content'))
89
('unversion', 'file-id')
90
# not supported yet: ('rename', ('orig-path', 'new-path'))
91
:param message: An optional commit message, if not supplied, a default
92
commit message will be written.
93
;return: The revision_id of the new commit
95
if parent_ids is not None:
96
base_id = parent_ids[0]
97
if base_id != self._branch.last_revision():
98
self._move_branch_pointer(base_id)
100
tree = memorytree.MemoryTree.create_on_branch(self._branch)
103
if parent_ids is not None:
104
tree.set_parent_ids(parent_ids)
105
# Unfortunately, MemoryTree.add(directory) just creates an
106
# inventory entry. And the only public function to create a
107
# directory is MemoryTree.mkdir() which creates the directory, but
108
# also always adds it. So we have to use a multi-pass setup.
109
to_add_directories = []
114
to_unversion_ids = []
115
# TODO: MemoryTree doesn't support rename() or
116
# apply_inventory_delta, so we'll postpone allowing renames
119
for action, info in actions:
121
path, file_id, kind, content = info
122
if kind == 'directory':
123
to_add_directories.append((path, file_id))
125
to_add_files.append(path)
126
to_add_file_ids.append(file_id)
127
to_add_kinds.append(kind)
128
if content is not None:
129
new_contents[file_id] = content
130
elif action == 'modify':
131
file_id, content = info
132
new_contents[file_id] = content
133
elif action == 'unversion':
134
to_unversion_ids.append(info)
136
raise errors.UnknownBuildAction(action)
138
tree.unversion(to_unversion_ids)
139
for path, file_id in to_add_directories:
141
# Special case, because the path already exists
142
tree.add([path], [file_id], ['directory'])
144
tree.mkdir(path, file_id)
145
tree.add(to_add_files, to_add_file_ids, to_add_kinds)
146
for file_id, content in new_contents.iteritems():
147
tree.put_file_bytes_non_atomic(file_id, content)
150
message = u'commit %d' % (self._branch.revno() + 1,)
151
return tree.commit(message, rev_id=revision_id)
155
def get_branch(self):
156
"""Return the branch created by the builder."""
added
removed
bzrlib/branchbuilder.py
