← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/push.py

Turn completion assertions into separate methods.

Many common assertions used to be expressed as arguments to the complete
method.  This makes the checks more explicit, and the code easier to read.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/push.py
1
 
# Copyright (C) 2008, 2009, 2010 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
 
"""UI helper for the push command."""
18
 
 
19
 
from bzrlib import (
20
 
    bzrdir,
21
 
    errors,
22
 
    revision as _mod_revision,
23
 
    transport,
24
 
    )
25
 
from bzrlib.trace import (
26
 
    note,
27
 
    warning,
28
 
    )
29
 
 
30
 
 
31
 
class PushResult(object):
32
 
    """Result of a push operation.
33
 
 
34
 
    :ivar branch_push_result: Result of a push between branches
35
 
    :ivar target_branch: The target branch
36
 
    :ivar stacked_on: URL of the branch on which the result is stacked
37
 
    :ivar workingtree_updated: Whether or not the target workingtree was updated.
38
 
    """
39
 
 
40
 
    def __init__(self):
41
 
        self.branch_push_result = None
42
 
        self.stacked_on = None
43
 
        self.workingtree_updated = None
44
 
        self.target_branch = None
45
 
 
46
 
    def report(self, to_file):
47
 
        """Write a human-readable description of the result."""
48
 
        if self.branch_push_result is None:
49
 
            if self.stacked_on is not None:
50
 
                note('Created new stacked branch referring to %s.' %
51
 
                    self.stacked_on)
52
 
            else:
53
 
                note('Created new branch.')
54
 
        else:
55
 
            self.branch_push_result.report(to_file)
56
 
 
57
 
 
58
 
def _show_push_branch(br_from, revision_id, location, to_file, verbose=False,
59
 
    overwrite=False, remember=False, stacked_on=None, create_prefix=False,
60
 
    use_existing_dir=False, no_tree=False):
61
 
    """Push a branch to a location.
62
 
 
63
 
    :param br_from: the source branch
64
 
    :param revision_id: the revision-id to push up to
65
 
    :param location: the url of the destination
66
 
    :param to_file: the output stream
67
 
    :param verbose: if True, display more output than normal
68
 
    :param overwrite: if False, a current branch at the destination may not
69
 
        have diverged from the source, otherwise the push fails
70
 
    :param remember: if True, store the location as the push location for
71
 
        the source branch
72
 
    :param stacked_on: the url of the branch, if any, to stack on;
73
 
        if set, only the revisions not in that branch are pushed
74
 
    :param create_prefix: if True, create the necessary parent directories
75
 
        at the destination if they don't already exist
76
 
    :param use_existing_dir: if True, proceed even if the destination
77
 
        directory exists without a current .bzr directory in it
78
 
    """
79
 
    to_transport = transport.get_transport(location)
80
 
    try:
81
 
        dir_to = bzrdir.BzrDir.open_from_transport(to_transport)
82
 
    except errors.NotBranchError:
83
 
        # Didn't find anything
84
 
        dir_to = None
85
 
 
86
 
    if dir_to is None:
87
 
        try:
88
 
            br_to = br_from.create_clone_on_transport(to_transport,
89
 
                revision_id=revision_id, stacked_on=stacked_on,
90
 
                create_prefix=create_prefix, use_existing_dir=use_existing_dir,
91
 
                no_tree=no_tree)
92
 
        except errors.FileExists, err:
93
 
            if err.path.endswith('/.bzr'):
94
 
                raise errors.BzrCommandError(
95
 
                    "Target directory %s already contains a .bzr directory, "
96
 
                    "but it is not valid." % (location,))
97
 
            if not use_existing_dir:
98
 
                raise errors.BzrCommandError("Target directory %s"
99
 
                     " already exists, but does not have a .bzr"
100
 
                     " directory. Supply --use-existing-dir to push"
101
 
                     " there anyway." % location)
102
 
            # This shouldn't occur, but if it does the FileExists error will be
103
 
            # more informative than an UnboundLocalError for br_to.
104
 
            raise
105
 
        except errors.NoSuchFile:
106
 
            if not create_prefix:
107
 
                raise errors.BzrCommandError("Parent directory of %s"
108
 
                    " does not exist."
109
 
                    "\nYou may supply --create-prefix to create all"
110
 
                    " leading parent directories."
111
 
                    % location)
112
 
            # This shouldn't occur (because create_prefix is true, so
113
 
            # create_clone_on_transport should be catching NoSuchFile and
114
 
            # creating the missing directories) but if it does the original
115
 
            # NoSuchFile error will be more informative than an
116
 
            # UnboundLocalError for br_to.
117
 
            raise
118
 
        except errors.TooManyRedirections:
119
 
            raise errors.BzrCommandError("Too many redirections trying "
120
 
                                         "to make %s." % location)
121
 
        push_result = PushResult()
122
 
        # TODO: Some more useful message about what was copied
123
 
        try:
124
 
            push_result.stacked_on = br_to.get_stacked_on_url()
125
 
        except (errors.UnstackableBranchFormat,
126
 
                errors.UnstackableRepositoryFormat,
127
 
                errors.NotStacked):
128
 
            push_result.stacked_on = None
129
 
        push_result.target_branch = br_to
130
 
        push_result.old_revid = _mod_revision.NULL_REVISION
131
 
        push_result.old_revno = 0
132
 
        # Remembers if asked explicitly or no previous location is set
133
 
        if (remember
134
 
            or (remember is None and br_from.get_push_location() is None)):
135
 
            br_from.set_push_location(br_to.base)
136
 
    else:
137
 
        if stacked_on is not None:
138
 
            warning("Ignoring request for a stacked branch as repository "
139
 
                    "already exists at the destination location.")
140
 
        try:
141
 
            push_result = dir_to.push_branch(br_from, revision_id, overwrite, 
142
 
                remember, create_prefix)
143
 
        except errors.DivergedBranches:
144
 
            raise errors.BzrCommandError('These branches have diverged.'
145
 
                                    '  See "bzr help diverged-branches"'
146
 
                                    ' for more information.')
147
 
        except errors.NoRoundtrippingSupport, e:
148
 
            raise errors.BzrCommandError("It is not possible to losslessly "
149
 
                "push to %s. You may want to use dpush instead." % 
150
 
                    e.target_branch.mapping.vcs.abbreviation)
151
 
        except errors.NoRepositoryPresent:
152
 
            # we have a bzrdir but no branch or repository
153
 
            # XXX: Figure out what to do other than complain.
154
 
            raise errors.BzrCommandError("At %s you have a valid .bzr"
155
 
                " control directory, but not a branch or repository. This"
156
 
                " is an unsupported configuration. Please move the target"
157
 
                " directory out of the way and try again." % location)
158
 
        if push_result.workingtree_updated == False:
159
 
            warning("This transport does not update the working " 
160
 
                    "tree of: %s. See 'bzr help working-trees' for "
161
 
                    "more information." % push_result.target_branch.base)
162
 
    push_result.report(to_file)
163
 
    if verbose:
164
 
        br_to = push_result.target_branch
165
 
        br_to.lock_read()
166
 
        try:
167
 
            from bzrlib.log import show_branch_change
168
 
            show_branch_change(br_to, to_file, push_result.old_revno, 
169
 
                               push_result.old_revid)
170
 
        finally:
171
 
            br_to.unlock()
172
 
 
173