1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
|
# Copyright (C) 2007 Canonical Ltd
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
"""Utility for create branches with particular contents."""
from bzrlib import bzrdir, errors, memorytree
class BranchBuilder(object):
"""A BranchBuilder aids creating Branches with particular shapes.
The expected way to use BranchBuilder is to construct a
BranchBuilder on the transport you want your branch on, and then call
appropriate build_ methods on it to get the shape of history you want.
For instance:
builder = BranchBuilder(self.get_transport().clone('relpath'))
builder.build_commit()
builder.build_commit()
builder.build_commit()
branch = builder.get_branch()
"""
def __init__(self, transport, format=None):
"""Construct a BranchBuilder on transport.
:param transport: The transport the branch should be created on.
If the path of the transport does not exist but its parent does
it will be created.
:param format: The name of a format in the bzrdir format registry
for the branch to be built.
"""
if not transport.has('.'):
transport.mkdir('.')
if format is None:
format = 'default'
if isinstance(format, str):
format = bzrdir.format_registry.make_bzrdir(format)
self._branch = bzrdir.BzrDir.create_branch_convenience(transport.base,
format=format, force_new_tree=False)
def build_commit(self):
"""Build a commit on the branch."""
tree = memorytree.MemoryTree.create_on_branch(self._branch)
tree.lock_write()
try:
tree.add('')
return tree.commit('commit %d' % (self._branch.revno() + 1))
finally:
tree.unlock()
def _move_branch_pointer(self, new_revision_id):
"""Point self._branch to a different revision id."""
self._branch.lock_write()
try:
# We don't seem to have a simple set_last_revision(), so we
# implement it here.
cur_revno, cur_revision_id = self._branch.last_revision_info()
g = self._branch.repository.get_graph()
new_revno = g.find_distance_to_null(new_revision_id,
[(cur_revision_id, cur_revno)])
self._branch.set_last_revision_info(new_revno, new_revision_id)
finally:
self._branch.unlock()
def build_snapshot(self, revision_id, parent_ids, actions):
"""Build a commit, shaped in a specific way.
:param revision_id: The handle for the new commit, could be none, as it
will be returned, though it is put in the commit message.
:param parent_ids: A list of parent_ids to use for the commit.
It can be None, which indicates to use the last commit.
:param actions: A list of actions to perform. Supported actions are:
('add', ('path', 'file-id', 'kind', 'content' or None))
('modify', ('file-id', 'new-content'))
('unversion', 'file-id')
# not supported yet: ('rename', ('orig-path', 'new-path'))
;return: The revision_id of the new commit
"""
if parent_ids is not None:
base_id = parent_ids[0]
if base_id != self._branch.last_revision():
self._move_branch_pointer(base_id)
tree = memorytree.MemoryTree.create_on_branch(self._branch)
tree.lock_write()
try:
if parent_ids is not None:
tree.set_parent_ids(parent_ids)
# Unfortunately, MemoryTree.add(directory) just creates an
# inventory entry. And the only public function to create a
# directory is MemoryTree.mkdir() which creates the directory, but
# also always adds it. So we have to use a multi-pass setup.
to_add_directories = []
to_add_files = []
to_add_file_ids = []
to_add_kinds = []
new_contents = {}
to_unversion_ids = []
# TODO: MemoryTree doesn't support rename() or
# apply_inventory_delta, so we'll postpone allowing renames
# for now
# to_rename = []
for action, info in actions:
if action == 'add':
path, file_id, kind, content = info
if kind == 'directory':
to_add_directories.append((path, file_id))
else:
to_add_files.append(path)
to_add_file_ids.append(file_id)
to_add_kinds.append(kind)
if content is not None:
new_contents[file_id] = content
elif action == 'modify':
file_id, content = info
new_contents[file_id] = content
elif action == 'unversion':
to_unversion_ids.append(info)
else:
raise errors.UnknownBuildAction(action)
if to_unversion_ids:
tree.unversion(to_unversion_ids)
for path, file_id in to_add_directories:
if path == '':
# Special case, because the path already exists
tree.add([path], [file_id], ['directory'])
else:
tree.mkdir(path, file_id)
tree.add(to_add_files, to_add_file_ids, to_add_kinds)
for file_id, content in new_contents.iteritems():
tree.put_file_bytes_non_atomic(file_id, content)
return tree.commit('commit %s' % (revision_id,), rev_id=revision_id)
finally:
tree.unlock()
def get_branch(self):
"""Return the branch created by the builder."""
return self._branch
|