← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/upgrade.py

  • Committer: Vincent Ladeuil
  • Date: 2010-12-20 12:01:56 UTC
  • mfrom: (4360.10.50 smooth-upgrades)
  • mto: This revision was merged to the branch mainline in revision 5576.
  • Revision ID: v.ladeuil+lp@free.fr-20101220120156-0rje08csoeuszd93
Smoother upgrades

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/upgrade.py
17
17
"""bzr upgrade logic."""
18
18
 
19
19
 
 
20
from bzrlib import (
 
21
    errors,
 
22
    osutils,
 
23
    repository,
 
24
    trace,
 
25
    ui,
 
26
    )
20
27
from bzrlib.bzrdir import BzrDir, format_registry
21
 
import bzrlib.errors as errors
22
28
from bzrlib.remote import RemoteBzrDir
23
 
import bzrlib.ui as ui
24
29
 
25
30
 
26
31
class Convert(object):
27
32
 
28
 
    def __init__(self, url, format=None):
 
33
    def __init__(self, url=None, format=None, control_dir=None):
 
34
        """Convert a Bazaar control directory to a given format.
 
35
 
 
36
        Either the url or control_dir parameter must be given.
 
37
 
 
38
        :param url: the URL of the control directory or None if the
 
39
          control_dir is explicitly given instead
 
40
        :param format: the format to convert to or None for the default
 
41
        :param control_dir: the control directory or None if it is
 
42
          specified via the URL parameter instead
 
43
        """
29
44
        self.format = format
30
 
        self.bzrdir = BzrDir.open_unsupported(url)
31
45
        # XXX: Change to cleanup
32
46
        warning_id = 'cross_format_fetch'
33
47
        saved_warning = warning_id in ui.ui_factory.suppressed_warnings
 
48
        if url is None and control_dir is None:
 
49
            raise AssertionError(
 
50
                "either the url or control_dir parameter must be set.")
 
51
        if control_dir is not None:
 
52
            self.bzrdir = control_dir
 
53
        else:
 
54
            self.bzrdir = BzrDir.open_unsupported(url)
34
55
        if isinstance(self.bzrdir, RemoteBzrDir):
35
56
            self.bzrdir._ensure_real()
36
57
            self.bzrdir = self.bzrdir._real_bzrdir
48
69
        try:
49
70
            branch = self.bzrdir.open_branch()
50
71
            if branch.user_url != self.bzrdir.user_url:
51
 
                ui.ui_factory.note("This is a checkout. The branch (%s) needs to be "
52
 
                             "upgraded separately." %
53
 
                             branch.user_url)
 
72
                ui.ui_factory.note(
 
73
                    'This is a checkout. The branch (%s) needs to be upgraded'
 
74
                    ' separately.' % (branch.user_url,))
54
75
            del branch
55
76
        except (errors.NotBranchError, errors.IncompatibleRepositories):
56
77
            # might not be a format we can open without upgrading; see e.g.
76
97
        self.bzrdir.check_conversion_target(format)
77
98
        ui.ui_factory.note('starting upgrade of %s' % self.transport.base)
78
99
 
79
 
        self.bzrdir.backup_bzrdir()
 
100
        self.backup_oldpath, self.backup_newpath = self.bzrdir.backup_bzrdir()
80
101
        while self.bzrdir.needs_format_conversion(format):
81
102
            converter = self.bzrdir._format.get_converter(format)
82
103
            self.bzrdir = converter.convert(self.bzrdir, None)
83
 
        ui.ui_factory.note("finished")
84
 
 
85
 
 
86
 
def upgrade(url, format=None):
87
 
    """Upgrade to format, or the default bzrdir format if not supplied."""
88
 
    Convert(url, format)
 
104
        ui.ui_factory.note('finished')
 
105
 
 
106
    def clean_up(self):
 
107
        """Clean-up after a conversion.
 
108
 
 
109
        This removes the backup.bzr directory.
 
110
        """
 
111
        transport = self.transport
 
112
        backup_relpath = transport.relpath(self.backup_newpath)
 
113
        child_pb = ui.ui_factory.nested_progress_bar()
 
114
        child_pb.update('Deleting backup.bzr')
 
115
        try:
 
116
            transport.delete_tree(backup_relpath)
 
117
        finally:
 
118
            child_pb.finished()
 
119
 
 
120
 
 
121
def upgrade(url, format=None, clean_up=False, dry_run=False):
 
122
    """Upgrade locations to format.
 
123
 
 
124
    This routine wraps the smart_upgrade() routine with a nicer UI.
 
125
    In particular, it ensures all URLs can be opened before starting
 
126
    and reports a summary at the end if more than one upgrade was attempted.
 
127
    This routine is useful for command line tools. Other bzrlib clients
 
128
    probably ought to use smart_upgrade() instead.
 
129
 
 
130
    :param url: a URL of the locations to upgrade.
 
131
    :param format: the format to convert to or None for the best default
 
132
    :param clean-up: if True, the backup.bzr directory is removed if the
 
133
      upgrade succeeded for a given repo/branch/tree
 
134
    :param dry_run: show what would happen but don't actually do any upgrades
 
135
    :return: the list of exceptions encountered
 
136
    """
 
137
    control_dirs = [BzrDir.open_unsupported(url)]
 
138
    attempted, succeeded, exceptions = smart_upgrade(control_dirs,
 
139
        format, clean_up=clean_up, dry_run=dry_run)
 
140
    if len(attempted) > 1:
 
141
        attempted_count = len(attempted)
 
142
        succeeded_count = len(succeeded)
 
143
        failed_count = attempted_count - succeeded_count
 
144
        ui.ui_factory.note(
 
145
            '\nSUMMARY: %d upgrades attempted, %d succeeded, %d failed'
 
146
            % (attempted_count, succeeded_count, failed_count))
 
147
    return exceptions
 
148
 
 
149
 
 
150
def smart_upgrade(control_dirs, format, clean_up=False,
 
151
    dry_run=False):
 
152
    """Convert control directories to a new format intelligently.
 
153
 
 
154
    If the control directory is a shared repository, dependent branches
 
155
    are also converted provided the repository converted successfully.
 
156
    If the conversion of a branch fails, remaining branches are still tried.
 
157
 
 
158
    :param control_dirs: the BzrDirs to upgrade
 
159
    :param format: the format to convert to or None for the best default
 
160
    :param clean_up: if True, the backup.bzr directory is removed if the
 
161
      upgrade succeeded for a given repo/branch/tree
 
162
    :param dry_run: show what would happen but don't actually do any upgrades
 
163
    :return: attempted-control-dirs, succeeded-control-dirs, exceptions
 
164
    """
 
165
    all_attempted = []
 
166
    all_succeeded = []
 
167
    all_exceptions = []
 
168
    for control_dir in control_dirs:
 
169
        attempted, succeeded, exceptions = _smart_upgrade_one(control_dir,
 
170
            format, clean_up=clean_up, dry_run=dry_run)
 
171
        all_attempted.extend(attempted)
 
172
        all_succeeded.extend(succeeded)
 
173
        all_exceptions.extend(exceptions)
 
174
    return all_attempted, all_succeeded, all_exceptions
 
175
 
 
176
 
 
177
def _smart_upgrade_one(control_dir, format, clean_up=False,
 
178
    dry_run=False):
 
179
    """Convert a control directory to a new format intelligently.
 
180
 
 
181
    See smart_upgrade for parameter details.
 
182
    """
 
183
    # If the URL is a shared repository, find the dependent branches
 
184
    dependents = None
 
185
    try:
 
186
        repo = control_dir.open_repository()
 
187
    except errors.NoRepositoryPresent:
 
188
        # A branch or checkout using a shared repository higher up
 
189
        pass
 
190
    else:
 
191
        # The URL is a repository. If it successfully upgrades,
 
192
        # then upgrade the dependent branches as well.
 
193
        if repo.is_shared():
 
194
            dependents = repo.find_branches(using=True)
 
195
 
 
196
    # Do the conversions
 
197
    attempted = [control_dir]
 
198
    succeeded, exceptions = _convert_items([control_dir], format, clean_up,
 
199
                                           dry_run)
 
200
    if succeeded and dependents:
 
201
        ui.ui_factory.note('Found %d dependent branches - upgrading ...'
 
202
                           % (len(dependents),))
 
203
        # Convert dependent branches
 
204
        branch_cdirs = [b.bzrdir for b in dependents]
 
205
        successes, problems = _convert_items(branch_cdirs, format, clean_up,
 
206
            dry_run, label="branch")
 
207
        attempted.extend(branch_cdirs)
 
208
        succeeded.extend(successes)
 
209
        exceptions.extend(problems)
 
210
 
 
211
    # Return the result
 
212
    return attempted, succeeded, exceptions
 
213
 
 
214
# FIXME: There are several problems below:
 
215
# - RemoteRepository doesn't support _unsupported (really ?)
 
216
# - raising AssertionError is rude and may not be necessary
 
217
# - no tests
 
218
# - the only caller uses only the label
 
219
def _get_object_and_label(control_dir):
 
220
    """Return the primary object and type label for a control directory.
 
221
 
 
222
    :return: object, label where
 
223
      object is a Branch, Repository or WorkingTree and
 
224
      label is one of:
 
225
        branch            - a branch
 
226
        repository        - a repository
 
227
        tree              - a lightweight checkout
 
228
    """
 
229
    try:
 
230
        try:
 
231
            br = control_dir.open_branch(unsupported=True,
 
232
                                         ignore_fallbacks=True)
 
233
        except NotImplementedError:
 
234
            # RemoteRepository doesn't support the unsupported parameter
 
235
            br = control_dir.open_branch(ignore_fallbacks=True)
 
236
    except errors.NotBranchError:
 
237
        pass
 
238
    else:
 
239
        return br, "branch"
 
240
    try:
 
241
        repo = control_dir.open_repository()
 
242
    except errors.NoRepositoryPresent:
 
243
        pass
 
244
    else:
 
245
        return repo, "repository"
 
246
    try:
 
247
        wt = control_dir.open_workingtree()
 
248
    except (errors.NoWorkingTree, errors.NotLocalUrl):
 
249
        pass
 
250
    else:
 
251
        return wt, "tree"
 
252
    raise AssertionError("unknown type of control directory %s", control_dir)
 
253
 
 
254
 
 
255
def _convert_items(items, format, clean_up, dry_run, label=None):
 
256
    """Convert a sequence of control directories to the given format.
 
257
 
 
258
    :param items: the control directories to upgrade
 
259
    :param format: the format to convert to or None for the best default
 
260
    :param clean-up: if True, the backup.bzr directory is removed if the
 
261
      upgrade succeeded for a given repo/branch/tree
 
262
    :param dry_run: show what would happen but don't actually do any upgrades
 
263
    :param label: the label for these items or None to calculate one
 
264
    :return: items successfully upgraded, exceptions
 
265
    """
 
266
    succeeded = []
 
267
    exceptions = []
 
268
    child_pb = ui.ui_factory.nested_progress_bar()
 
269
    child_pb.update('Upgrading bzrdirs', 0, len(items))
 
270
    for i, control_dir in enumerate(items):
 
271
        # Do the conversion
 
272
        location = control_dir.root_transport.base
 
273
        bzr_object, bzr_label = _get_object_and_label(control_dir)
 
274
        type_label = label or bzr_label
 
275
        child_pb.update("Upgrading %s" % (type_label), i+1, len(items))
 
276
        ui.ui_factory.note('Upgrading %s %s ...' % (type_label, location,))
 
277
        try:
 
278
            if not dry_run:
 
279
                cv = Convert(control_dir=control_dir, format=format)
 
280
        except Exception, ex:
 
281
            trace.warning('conversion error: %s' % ex)
 
282
            exceptions.append(ex)
 
283
            continue
 
284
 
 
285
        # Do any required post processing
 
286
        succeeded.append(control_dir)
 
287
        if clean_up:
 
288
            try:
 
289
                ui.ui_factory.note('Removing backup ...')
 
290
                if not dry_run:
 
291
                    cv.clean_up()
 
292
            except Exception, ex:
 
293
                trace.warning('failed to clean-up %s: %s' % (location, ex))
 
294
                exceptions.append(ex)
 
295
 
 
296
    child_pb.finished()
 
297
 
 
298
    # Return the result
 
299
    return succeeded, exceptions