← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branchbuilder.py

  • Committer: Patch Queue Manager
  • Date: 2015-10-05 13:45:00 UTC
  • mfrom: (6603.3.1 bts794146)
  • Revision ID: pqm@pqm.ubuntu.com-20151005134500-v244rho557tv0ukd
(vila) Resolve Bug #1480015: Test failure: hexify removed from paramiko
 (Andrew Starr-Bochicchio) (Andrew Starr-Bochicchio)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/branchbuilder.py
16
16
 
17
17
"""Utility for create branches with particular contents."""
18
18
 
 
19
from __future__ import absolute_import
 
20
 
19
21
from bzrlib import (
20
 
    bzrdir,
 
22
    controldir,
21
23
    commit,
22
24
    errors,
23
25
    memorytree,
 
26
    revision,
24
27
    )
25
28
 
26
29
 
63
66
            If the path of the transport does not exist but its parent does
64
67
            it will be created.
65
68
        :param format: Either a BzrDirFormat, or the name of a format in the
66
 
            bzrdir format registry for the branch to be built.
 
69
            controldir format registry for the branch to be built.
67
70
        :param branch: An already constructed branch to use.  This param is
68
71
            mutually exclusive with the transport and format params.
69
72
        """
81
84
            if format is None:
82
85
                format = 'default'
83
86
            if isinstance(format, str):
84
 
                format = bzrdir.format_registry.make_bzrdir(format)
85
 
            self._branch = bzrdir.BzrDir.create_branch_convenience(
 
87
                format = controldir.format_registry.make_bzrdir(format)
 
88
            self._branch = controldir.ControlDir.create_branch_convenience(
86
89
                transport.base, format=format, force_new_tree=False)
87
90
        self._tree = None
88
91
 
89
 
    def build_commit(self, **commit_kwargs):
 
92
    def build_commit(self, parent_ids=None, allow_leftmost_as_ghost=False,
 
93
                     **commit_kwargs):
90
94
        """Build a commit on the branch.
91
95
 
92
96
        This makes a commit with no real file content for when you only want
95
99
        :param commit_kwargs: Arguments to pass through to commit, such as
96
100
             timestamp.
97
101
        """
 
102
        if parent_ids is not None:
 
103
            if len(parent_ids) == 0:
 
104
                base_id = revision.NULL_REVISION
 
105
            else:
 
106
                base_id = parent_ids[0]
 
107
            if base_id != self._branch.last_revision():
 
108
                self._move_branch_pointer(base_id,
 
109
                    allow_leftmost_as_ghost=allow_leftmost_as_ghost)
98
110
        tree = memorytree.MemoryTree.create_on_branch(self._branch)
99
111
        tree.lock_write()
100
112
        try:
 
113
            if parent_ids is not None:
 
114
                tree.set_parent_ids(parent_ids,
 
115
                    allow_leftmost_as_ghost=allow_leftmost_as_ghost)
101
116
            tree.add('')
102
117
            return self._do_commit(tree, **commit_kwargs)
103
118
        finally:
104
119
            tree.unlock()
105
120
 
106
 
    def _do_commit(self, tree, message=None, **kwargs):
 
121
    def _do_commit(self, tree, message=None, message_callback=None, **kwargs):
107
122
        reporter = commit.NullCommitReporter()
108
 
        if message is None:
 
123
        if message is None and message_callback is None:
109
124
            message = u'commit %d' % (self._branch.revno() + 1,)
110
 
        return tree.commit(message,
 
125
        return tree.commit(message, message_callback=message_callback,
111
126
            reporter=reporter,
112
127
            **kwargs)
113
128
 
114
 
    def _move_branch_pointer(self, new_revision_id):
 
129
    def _move_branch_pointer(self, new_revision_id,
 
130
        allow_leftmost_as_ghost=False):
115
131
        """Point self._branch to a different revision id."""
116
132
        self._branch.lock_write()
117
133
        try:
118
134
            # We don't seem to have a simple set_last_revision(), so we
119
135
            # implement it here.
120
136
            cur_revno, cur_revision_id = self._branch.last_revision_info()
121
 
            g = self._branch.repository.get_graph()
122
 
            new_revno = g.find_distance_to_null(new_revision_id,
123
 
                                                [(cur_revision_id, cur_revno)])
124
 
            self._branch.set_last_revision_info(new_revno, new_revision_id)
 
137
            try:
 
138
                g = self._branch.repository.get_graph()
 
139
                new_revno = g.find_distance_to_null(new_revision_id,
 
140
                    [(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
125
146
        finally:
126
147
            self._branch.unlock()
127
148
        if self._tree is not None:
155
176
        self._tree = None
156
177
 
157
178
    def build_snapshot(self, revision_id, parent_ids, actions,
158
 
                       message=None, timestamp=None):
 
179
        message=None, timestamp=None, allow_leftmost_as_ghost=False,
 
180
        committer=None, timezone=None, message_callback=None):
159
181
        """Build a commit, shaped in a specific way.
160
182
 
 
183
        Most of the actions are self-explanatory.  'flush' is special action to
 
184
        break a series of actions into discrete steps so that complex changes
 
185
        (such as unversioning a file-id and re-adding it with a different kind)
 
186
        can be expressed in a way that will clearly work.
 
187
 
161
188
        :param revision_id: The handle for the new commit, can be None
162
189
        :param parent_ids: A list of parent_ids to use for the commit.
163
190
            It can be None, which indicates to use the last commit.
166
193
            ('modify', ('file-id', 'new-content'))
167
194
            ('unversion', 'file-id')
168
195
            ('rename', ('orig-path', 'new-path'))
 
196
            ('flush', None)
169
197
        :param message: An optional commit message, if not supplied, a default
170
198
            commit message will be written.
 
199
        :param message_callback: A message callback to use for the commit, as
 
200
            per mutabletree.commit.
171
201
        :param timestamp: If non-None, set the timestamp of the commit to this
172
202
            value.
 
203
        :param timezone: An optional timezone for timestamp.
 
204
        :param committer: An optional username to use for commit
 
205
        :param allow_leftmost_as_ghost: True if the leftmost parent should be
 
206
            permitted to be a ghost.
173
207
        :return: The revision_id of the new commit
174
208
        """
175
209
        if parent_ids is not None:
176
 
            base_id = parent_ids[0]
 
210
            if len(parent_ids) == 0:
 
211
                base_id = revision.NULL_REVISION
 
212
            else:
 
213
                base_id = parent_ids[0]
177
214
            if base_id != self._branch.last_revision():
178
 
                self._move_branch_pointer(base_id)
 
215
                self._move_branch_pointer(base_id,
 
216
                    allow_leftmost_as_ghost=allow_leftmost_as_ghost)
179
217
 
180
218
        if self._tree is not None:
181
219
            tree = self._tree
184
222
        tree.lock_write()
185
223
        try:
186
224
            if parent_ids is not None:
187
 
                tree.set_parent_ids(parent_ids)
 
225
                tree.set_parent_ids(parent_ids,
 
226
                    allow_leftmost_as_ghost=allow_leftmost_as_ghost)
188
227
            # Unfortunately, MemoryTree.add(directory) just creates an
189
228
            # inventory entry. And the only public function to create a
190
229
            # directory is MemoryTree.mkdir() which creates the directory, but
191
230
            # also always adds it. So we have to use a multi-pass setup.
192
 
            to_add_directories = []
193
 
            to_add_files = []
194
 
            to_add_file_ids = []
195
 
            to_add_kinds = []
196
 
            new_contents = {}
197
 
            to_unversion_ids = []
198
 
            to_rename = []
 
231
            pending = _PendingActions()
199
232
            for action, info in actions:
200
233
                if action == 'add':
201
234
                    path, file_id, kind, content = info
202
235
                    if kind == 'directory':
203
 
                        to_add_directories.append((path, file_id))
 
236
                        pending.to_add_directories.append((path, file_id))
204
237
                    else:
205
 
                        to_add_files.append(path)
206
 
                        to_add_file_ids.append(file_id)
207
 
                        to_add_kinds.append(kind)
 
238
                        pending.to_add_files.append(path)
 
239
                        pending.to_add_file_ids.append(file_id)
 
240
                        pending.to_add_kinds.append(kind)
208
241
                        if content is not None:
209
 
                            new_contents[file_id] = content
 
242
                            pending.new_contents[file_id] = content
210
243
                elif action == 'modify':
211
244
                    file_id, content = info
212
 
                    new_contents[file_id] = content
 
245
                    pending.new_contents[file_id] = content
213
246
                elif action == 'unversion':
214
 
                    to_unversion_ids.append(info)
 
247
                    pending.to_unversion_ids.add(info)
215
248
                elif action == 'rename':
216
249
                    from_relpath, to_relpath = info
217
 
                    to_rename.append((from_relpath, to_relpath))
 
250
                    pending.to_rename.append((from_relpath, to_relpath))
 
251
                elif action == 'flush':
 
252
                    self._flush_pending(tree, pending)
 
253
                    pending = _PendingActions()
218
254
                else:
219
255
                    raise ValueError('Unknown build action: "%s"' % (action,))
220
 
            if to_unversion_ids:
221
 
                tree.unversion(to_unversion_ids)
222
 
            for path, file_id in to_add_directories:
223
 
                if path == '':
224
 
                    # Special case, because the path already exists
225
 
                    tree.add([path], [file_id], ['directory'])
226
 
                else:
227
 
                    tree.mkdir(path, file_id)
228
 
            for from_relpath, to_relpath in to_rename:
229
 
                tree.rename_one(from_relpath, to_relpath)
230
 
            tree.add(to_add_files, to_add_file_ids, to_add_kinds)
231
 
            for file_id, content in new_contents.iteritems():
232
 
                tree.put_file_bytes_non_atomic(file_id, content)
 
256
            self._flush_pending(tree, pending)
233
257
            return self._do_commit(tree, message=message, rev_id=revision_id,
234
 
                timestamp=timestamp)
 
258
                timestamp=timestamp, timezone=timezone, committer=committer,
 
259
                message_callback=message_callback)
235
260
        finally:
236
261
            tree.unlock()
237
262
 
 
263
    def _flush_pending(self, tree, pending):
 
264
        """Flush the pending actions in 'pending', i.e. apply them to 'tree'."""
 
265
        for path, file_id in pending.to_add_directories:
 
266
            if path == '':
 
267
                old_id = tree.path2id(path)
 
268
                if old_id is not None and old_id in pending.to_unversion_ids:
 
269
                    # We're overwriting this path, no need to unversion
 
270
                    pending.to_unversion_ids.discard(old_id)
 
271
                # Special case, because the path already exists
 
272
                tree.add([path], [file_id], ['directory'])
 
273
            else:
 
274
                tree.mkdir(path, file_id)
 
275
        for from_relpath, to_relpath in pending.to_rename:
 
276
            tree.rename_one(from_relpath, to_relpath)
 
277
        if pending.to_unversion_ids:
 
278
            tree.unversion(pending.to_unversion_ids)
 
279
        tree.add(pending.to_add_files, pending.to_add_file_ids, pending.to_add_kinds)
 
280
        for file_id, content in pending.new_contents.iteritems():
 
281
            tree.put_file_bytes_non_atomic(file_id, content)
 
282
 
238
283
    def get_branch(self):
239
284
        """Return the branch created by the builder."""
240
285
        return self._branch
 
286
 
 
287
 
 
288
class _PendingActions(object):
 
289
    """Pending actions for build_snapshot to take.
 
290
 
 
291
    This is just a simple class to hold a bunch of the intermediate state of
 
292
    build_snapshot in single object.
 
293
    """
 
294
 
 
295
    def __init__(self):
 
296
        self.to_add_directories = []
 
297
        self.to_add_files = []
 
298
        self.to_add_file_ids = []
 
299
        self.to_add_kinds = []
 
300
        self.new_contents = {}
 
301
        self.to_unversion_ids = set()
 
302
        self.to_rename = []
 
303