/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to breezy/branchbuilder.py

[merge] robertc's integration, updated tests to check for retcode=3

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/branchbuilder.py
1
 
# Copyright (C) 2007, 2008, 2009 Canonical Ltd
2
 
#
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.
7
 
#
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.
12
 
#
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
 
 
17
 
"""Utility for create branches with particular contents."""
18
 
 
19
 
from __future__ import absolute_import
20
 
 
21
 
from . import (
22
 
    controldir,
23
 
    commit,
24
 
    errors,
25
 
    revision,
26
 
    )
27
 
from .sixish import (
28
 
    viewitems,
29
 
    )
30
 
 
31
 
 
32
 
class BranchBuilder(object):
33
 
    r"""A BranchBuilder aids creating Branches with particular shapes.
34
 
 
35
 
    The expected way to use BranchBuilder is to construct a
36
 
    BranchBuilder on the transport you want your branch on, and then call
37
 
    appropriate build_ methods on it to get the shape of history you want.
38
 
 
39
 
    This is meant as a helper for the test suite, not as a general class for
40
 
    real data.
41
 
 
42
 
    For instance:
43
 
 
44
 
    >>> from breezy.transport.memory import MemoryTransport
45
 
    >>> builder = BranchBuilder(MemoryTransport("memory:///"))
46
 
    >>> builder.start_series()
47
 
    >>> builder.build_snapshot(None, [
48
 
    ...     ('add', ('', b'root-id', 'directory', '')),
49
 
    ...     ('add', ('filename', b'f-id', 'file', b'content\n'))],
50
 
    ...     revision_id=b'rev-id')
51
 
    'rev-id'
52
 
    >>> builder.build_snapshot([b'rev-id'],
53
 
    ...     [('modify', ('filename', b'new-content\n'))],
54
 
    ...     revision_id=b'rev2-id')
55
 
    'rev2-id'
56
 
    >>> builder.finish_series()
57
 
    >>> branch = builder.get_branch()
58
 
 
59
 
    :ivar _tree: This is a private member which is not meant to be modified by
60
 
        users of this class. While a 'series' is in progress, it should hold a
61
 
        MemoryTree with the contents of the last commit (ready to be modified
62
 
        by the next build_snapshot command) with a held write lock. Outside of
63
 
        a series in progress, it should be None.
64
 
    """
65
 
 
66
 
    def __init__(self, transport=None, format=None, branch=None):
67
 
        """Construct a BranchBuilder on transport.
68
 
 
69
 
        :param transport: The transport the branch should be created on.
70
 
            If the path of the transport does not exist but its parent does
71
 
            it will be created.
72
 
        :param format: Either a BzrDirFormat, or the name of a format in the
73
 
            controldir format registry for the branch to be built.
74
 
        :param branch: An already constructed branch to use.  This param is
75
 
            mutually exclusive with the transport and format params.
76
 
        """
77
 
        if branch is not None:
78
 
            if format is not None:
79
 
                raise AssertionError(
80
 
                    "branch and format kwargs are mutually exclusive")
81
 
            if transport is not None:
82
 
                raise AssertionError(
83
 
                    "branch and transport kwargs are mutually exclusive")
84
 
            self._branch = branch
85
 
        else:
86
 
            if not transport.has('.'):
87
 
                transport.mkdir('.')
88
 
            if format is None:
89
 
                format = 'default'
90
 
            if isinstance(format, str):
91
 
                format = controldir.format_registry.make_controldir(format)
92
 
            self._branch = controldir.ControlDir.create_branch_convenience(
93
 
                transport.base, format=format, force_new_tree=False)
94
 
        self._tree = None
95
 
 
96
 
    def build_commit(self, parent_ids=None, allow_leftmost_as_ghost=False,
97
 
                     **commit_kwargs):
98
 
        """Build a commit on the branch.
99
 
 
100
 
        This makes a commit with no real file content for when you only want
101
 
        to look at the revision graph structure.
102
 
 
103
 
        :param commit_kwargs: Arguments to pass through to commit, such as
104
 
             timestamp.
105
 
        """
106
 
        if parent_ids is not None:
107
 
            if len(parent_ids) == 0:
108
 
                base_id = revision.NULL_REVISION
109
 
            else:
110
 
                base_id = parent_ids[0]
111
 
            if base_id != self._branch.last_revision():
112
 
                self._move_branch_pointer(
113
 
                    base_id, allow_leftmost_as_ghost=allow_leftmost_as_ghost)
114
 
        tree = self._branch.create_memorytree()
115
 
        with tree.lock_write():
116
 
            if parent_ids is not None:
117
 
                tree.set_parent_ids(
118
 
                    parent_ids,
119
 
                    allow_leftmost_as_ghost=allow_leftmost_as_ghost)
120
 
            tree.add('')
121
 
            return self._do_commit(tree, **commit_kwargs)
122
 
 
123
 
    def _do_commit(self, tree, message=None, message_callback=None, **kwargs):
124
 
        reporter = commit.NullCommitReporter()
125
 
        if message is None and message_callback is None:
126
 
            message = u'commit %d' % (self._branch.revno() + 1,)
127
 
        return tree.commit(message, message_callback=message_callback,
128
 
                           reporter=reporter, **kwargs)
129
 
 
130
 
    def _move_branch_pointer(self, new_revision_id,
131
 
                             allow_leftmost_as_ghost=False):
132
 
        """Point self._branch to a different revision id."""
133
 
        with self._branch.lock_write():
134
 
            # We don't seem to have a simple set_last_revision(), so we
135
 
            # implement it here.
136
 
            cur_revno, cur_revision_id = self._branch.last_revision_info()
137
 
            try:
138
 
                g = self._branch.repository.get_graph()
139
 
                new_revno = g.find_distance_to_null(
140
 
                    new_revision_id, [(cur_revision_id, cur_revno)])
141
 
                self._branch.set_last_revision_info(new_revno, new_revision_id)
142
 
            except errors.GhostRevisionsHaveNoRevno:
143
 
                if not allow_leftmost_as_ghost:
144
 
                    raise
145
 
                new_revno = 1
146
 
        if self._tree is not None:
147
 
            # We are currently processing a series, but when switching branch
148
 
            # pointers, it is easiest to just create a new memory tree.
149
 
            # That way we are sure to have the right files-on-disk
150
 
            # We are cheating a little bit here, and locking the new tree
151
 
            # before the old tree is unlocked. But that way the branch stays
152
 
            # locked throughout.
153
 
            new_tree = self._branch.create_memorytree()
154
 
            new_tree.lock_write()
155
 
            self._tree.unlock()
156
 
            self._tree = new_tree
157
 
 
158
 
    def start_series(self):
159
 
        """We will be creating a series of commits.
160
 
 
161
 
        This allows us to hold open the locks while we are processing.
162
 
 
163
 
        Make sure to call 'finish_series' when you are done.
164
 
        """
165
 
        if self._tree is not None:
166
 
            raise AssertionError('You cannot start a new series while a'
167
 
                                 ' series is already going.')
168
 
        self._tree = self._branch.create_memorytree()
169
 
        self._tree.lock_write()
170
 
 
171
 
    def finish_series(self):
172
 
        """Call this after start_series to unlock the various objects."""
173
 
        self._tree.unlock()
174
 
        self._tree = None
175
 
 
176
 
    def build_snapshot(self, parent_ids, actions, message=None, timestamp=None,
177
 
                       allow_leftmost_as_ghost=False, committer=None,
178
 
                       timezone=None, message_callback=None, revision_id=None):
179
 
        """Build a commit, shaped in a specific way.
180
 
 
181
 
        Most of the actions are self-explanatory.  'flush' is special action to
182
 
        break a series of actions into discrete steps so that complex changes
183
 
        (such as unversioning a file-id and re-adding it with a different kind)
184
 
        can be expressed in a way that will clearly work.
185
 
 
186
 
        :param parent_ids: A list of parent_ids to use for the commit.
187
 
            It can be None, which indicates to use the last commit.
188
 
        :param actions: A list of actions to perform. Supported actions are:
189
 
            ('add', ('path', b'file-id', 'kind', b'content' or None))
190
 
            ('modify', ('path', b'new-content'))
191
 
            ('unversion', 'path')
192
 
            ('rename', ('orig-path', 'new-path'))
193
 
            ('flush', None)
194
 
        :param message: An optional commit message, if not supplied, a default
195
 
            commit message will be written.
196
 
        :param message_callback: A message callback to use for the commit, as
197
 
            per mutabletree.commit.
198
 
        :param timestamp: If non-None, set the timestamp of the commit to this
199
 
            value.
200
 
        :param timezone: An optional timezone for timestamp.
201
 
        :param committer: An optional username to use for commit
202
 
        :param allow_leftmost_as_ghost: True if the leftmost parent should be
203
 
            permitted to be a ghost.
204
 
        :param revision_id: The handle for the new commit, can be None
205
 
        :return: The revision_id of the new commit
206
 
        """
207
 
        if parent_ids is not None:
208
 
            if len(parent_ids) == 0:
209
 
                base_id = revision.NULL_REVISION
210
 
            else:
211
 
                base_id = parent_ids[0]
212
 
            if base_id != self._branch.last_revision():
213
 
                self._move_branch_pointer(
214
 
                    base_id, allow_leftmost_as_ghost=allow_leftmost_as_ghost)
215
 
 
216
 
        if self._tree is not None:
217
 
            tree = self._tree
218
 
        else:
219
 
            tree = self._branch.create_memorytree()
220
 
        with tree.lock_write():
221
 
            if parent_ids is not None:
222
 
                tree.set_parent_ids(
223
 
                    parent_ids,
224
 
                    allow_leftmost_as_ghost=allow_leftmost_as_ghost)
225
 
            # Unfortunately, MemoryTree.add(directory) just creates an
226
 
            # inventory entry. And the only public function to create a
227
 
            # directory is MemoryTree.mkdir() which creates the directory, but
228
 
            # also always adds it. So we have to use a multi-pass setup.
229
 
            pending = _PendingActions()
230
 
            for action, info in actions:
231
 
                if action == 'add':
232
 
                    path, file_id, kind, content = info
233
 
                    if kind == 'directory':
234
 
                        pending.to_add_directories.append((path, file_id))
235
 
                    else:
236
 
                        pending.to_add_files.append(path)
237
 
                        pending.to_add_file_ids.append(file_id)
238
 
                        pending.to_add_kinds.append(kind)
239
 
                        if content is not None:
240
 
                            pending.new_contents[path] = content
241
 
                elif action == 'modify':
242
 
                    path, content = info
243
 
                    pending.new_contents[path] = content
244
 
                elif action == 'unversion':
245
 
                    pending.to_unversion_paths.add(info)
246
 
                elif action == 'rename':
247
 
                    from_relpath, to_relpath = info
248
 
                    pending.to_rename.append((from_relpath, to_relpath))
249
 
                elif action == 'flush':
250
 
                    self._flush_pending(tree, pending)
251
 
                    pending = _PendingActions()
252
 
                else:
253
 
                    raise ValueError('Unknown build action: "%s"' % (action,))
254
 
            self._flush_pending(tree, pending)
255
 
            return self._do_commit(
256
 
                tree, message=message, rev_id=revision_id,
257
 
                timestamp=timestamp, timezone=timezone, committer=committer,
258
 
                message_callback=message_callback)
259
 
 
260
 
    def _flush_pending(self, tree, pending):
261
 
        """Flush the pending actions in 'pending', i.e. apply them to tree."""
262
 
        for path, file_id in pending.to_add_directories:
263
 
            if path == '':
264
 
                if tree.has_filename(path) \
265
 
                        and path in pending.to_unversion_paths:
266
 
                    # We're overwriting this path, no need to unversion
267
 
                    pending.to_unversion_paths.discard(path)
268
 
                # Special case, because the path already exists
269
 
                tree.add([path], [file_id], ['directory'])
270
 
            else:
271
 
                tree.mkdir(path, file_id)
272
 
        for from_relpath, to_relpath in pending.to_rename:
273
 
            tree.rename_one(from_relpath, to_relpath)
274
 
        if pending.to_unversion_paths:
275
 
            tree.unversion(pending.to_unversion_paths)
276
 
        tree.add(pending.to_add_files, pending.to_add_file_ids,
277
 
                 pending.to_add_kinds)
278
 
        for path, content in viewitems(pending.new_contents):
279
 
            tree.put_file_bytes_non_atomic(path, content)
280
 
 
281
 
    def get_branch(self):
282
 
        """Return the branch created by the builder."""
283
 
        return self._branch
284
 
 
285
 
 
286
 
class _PendingActions(object):
287
 
    """Pending actions for build_snapshot to take.
288
 
 
289
 
    This is just a simple class to hold a bunch of the intermediate state of
290
 
    build_snapshot in single object.
291
 
    """
292
 
 
293
 
    def __init__(self):
294
 
        self.to_add_directories = []
295
 
        self.to_add_files = []
296
 
        self.to_add_file_ids = []
297
 
        self.to_add_kinds = []
298
 
        self.new_contents = {}
299
 
        self.to_unversion_paths = set()
300
 
        self.to_rename = []