~bzr-pqm/bzr/bzr.dev

6404.6.1 by Vincent Ladeuil
Tests passing for a first rough version of a cached branch config store. The changes here are too invasive and several parallel proposals have been made.
1
# Copyright (C) 2008-2012 Canonical Ltd
3221.19.1 by Ian Clatworthy
refactor cmd_push to use a helper function
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
4183.7.1 by Sabin Iacob
update FSF mailing address
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
3221.19.1 by Ian Clatworthy
refactor cmd_push to use a helper function
16
6379.6.7 by Jelmer Vernooij
Move importing from future until after doc string, otherwise the doc string will disappear.
17
"""UI helper for the push command."""
18
6379.6.3 by Jelmer Vernooij
Use absolute_import.
19
from __future__ import absolute_import
20
3978.3.13 by Jelmer Vernooij
Store the pushed branches' URL rather than the URL of the branch itself.
21
from bzrlib import (
6207.3.3 by jelmer at samba
Fix tests and the like.
22
    controldir,
3978.3.13 by Jelmer Vernooij
Store the pushed branches' URL rather than the URL of the branch itself.
23
    errors,
24
    revision as _mod_revision,
25
    transport,
26
    )
27
from bzrlib.trace import (
28
    note,
29
    warning,
30
    )
6138.3.4 by Jonathan Riddell
add gettext() to uses of trace.note()
31
from bzrlib.i18n import gettext
3221.19.1 by Ian Clatworthy
refactor cmd_push to use a helper function
32
33
4053.3.2 by Jelmer Vernooij
Use PushResult in push.py.
34
class PushResult(object):
35
    """Result of a push operation.
36
37
    :ivar branch_push_result: Result of a push between branches
3978.3.11 by Jelmer Vernooij
Move InterBranchBzrDir to bzrlib.push.
38
    :ivar target_branch: The target branch
4053.3.2 by Jelmer Vernooij
Use PushResult in push.py.
39
    :ivar stacked_on: URL of the branch on which the result is stacked
3978.3.11 by Jelmer Vernooij
Move InterBranchBzrDir to bzrlib.push.
40
    :ivar workingtree_updated: Whether or not the target workingtree was updated.
4053.3.2 by Jelmer Vernooij
Use PushResult in push.py.
41
    """
42
43
    def __init__(self):
44
        self.branch_push_result = None
45
        self.stacked_on = None
3978.3.11 by Jelmer Vernooij
Move InterBranchBzrDir to bzrlib.push.
46
        self.workingtree_updated = None
47
        self.target_branch = None
4053.3.2 by Jelmer Vernooij
Use PushResult in push.py.
48
49
    def report(self, to_file):
50
        """Write a human-readable description of the result."""
51
        if self.branch_push_result is None:
52
            if self.stacked_on is not None:
6138.3.4 by Jonathan Riddell
add gettext() to uses of trace.note()
53
                note(gettext('Created new stacked branch referring to %s.') %
4053.3.2 by Jelmer Vernooij
Use PushResult in push.py.
54
                    self.stacked_on)
55
            else:
6138.3.4 by Jonathan Riddell
add gettext() to uses of trace.note()
56
                note(gettext('Created new branch.'))
4053.3.2 by Jelmer Vernooij
Use PushResult in push.py.
57
        else:
58
            self.branch_push_result.report(to_file)
59
60
3221.19.1 by Ian Clatworthy
refactor cmd_push to use a helper function
61
def _show_push_branch(br_from, revision_id, location, to_file, verbose=False,
3549.1.1 by Martin Pool
rename push --reference to --stacked-on
62
    overwrite=False, remember=False, stacked_on=None, create_prefix=False,
5448.6.2 by Matthew Gordon
Tested push --no-tree ang gor it working right.
63
    use_existing_dir=False, no_tree=False):
3221.19.1 by Ian Clatworthy
refactor cmd_push to use a helper function
64
    """Push a branch to a location.
65
66
    :param br_from: the source branch
67
    :param revision_id: the revision-id to push up to
68
    :param location: the url of the destination
69
    :param to_file: the output stream
70
    :param verbose: if True, display more output than normal
6159.2.4 by Jelmer Vernooij
Add --overwrite-tags flag.
71
    :param overwrite: list of things to overwrite ("history", "tags")
72
        or boolean indicating for everything
3221.19.1 by Ian Clatworthy
refactor cmd_push to use a helper function
73
    :param remember: if True, store the location as the push location for
74
        the source branch
3549.1.1 by Martin Pool
rename push --reference to --stacked-on
75
    :param stacked_on: the url of the branch, if any, to stack on;
3221.19.1 by Ian Clatworthy
refactor cmd_push to use a helper function
76
        if set, only the revisions not in that branch are pushed
77
    :param create_prefix: if True, create the necessary parent directories
78
        at the destination if they don't already exist
79
    :param use_existing_dir: if True, proceed even if the destination
80
        directory exists without a current .bzr directory in it
81
    """
82
    to_transport = transport.get_transport(location)
83
    try:
6207.3.3 by jelmer at samba
Fix tests and the like.
84
        dir_to = controldir.ControlDir.open_from_transport(to_transport)
3221.19.1 by Ian Clatworthy
refactor cmd_push to use a helper function
85
    except errors.NotBranchError:
4294.2.1 by Robert Collins
Move directory checking for bzr push options into Branch.create_clone_on_transport.
86
        # Didn't find anything
87
        dir_to = None
3221.19.1 by Ian Clatworthy
refactor cmd_push to use a helper function
88
89
    if dir_to is None:
4294.2.6 by Robert Collins
Report errors back in the UI layer for push, to use the url the user gave us.
90
        try:
91
            br_to = br_from.create_clone_on_transport(to_transport,
92
                revision_id=revision_id, stacked_on=stacked_on,
5448.6.2 by Matthew Gordon
Tested push --no-tree ang gor it working right.
93
                create_prefix=create_prefix, use_existing_dir=use_existing_dir,
94
                no_tree=no_tree)
6437.10.5 by Jelmer Vernooij
FIx test - remove some no longer necessary special casing.
95
        except errors.AlreadyControlDirError, err:
96
            raise errors.BzrCommandError(gettext(
97
                "Target directory %s already contains a .bzr directory, "
98
                "but it is not valid.") % (location,))
4634.105.2 by Andrew Bennetts
Clearer code and error message.
99
        except errors.FileExists, err:
4294.2.6 by Robert Collins
Report errors back in the UI layer for push, to use the url the user gave us.
100
            if not use_existing_dir:
6138.3.7 by Jonathan Riddell
add gettext() to BzrCommandError uses
101
                raise errors.BzrCommandError(gettext("Target directory %s"
4634.105.1 by Andrew Bennetts
Fix traceback when doing 'bzr push --use-existing-dir' into a dir with an invalid .bzr directory.
102
                     " already exists, but does not have a .bzr"
4294.2.6 by Robert Collins
Report errors back in the UI layer for push, to use the url the user gave us.
103
                     " directory. Supply --use-existing-dir to push"
6138.3.7 by Jonathan Riddell
add gettext() to BzrCommandError uses
104
                     " there anyway.") % location)
4634.105.2 by Andrew Bennetts
Clearer code and error message.
105
            # This shouldn't occur, but if it does the FileExists error will be
106
            # more informative than an UnboundLocalError for br_to.
107
            raise
4294.2.6 by Robert Collins
Report errors back in the UI layer for push, to use the url the user gave us.
108
        except errors.NoSuchFile:
109
            if not create_prefix:
6138.3.7 by Jonathan Riddell
add gettext() to BzrCommandError uses
110
                raise errors.BzrCommandError(gettext("Parent directory of %s"
4294.2.6 by Robert Collins
Report errors back in the UI layer for push, to use the url the user gave us.
111
                    " does not exist."
112
                    "\nYou may supply --create-prefix to create all"
6138.3.7 by Jonathan Riddell
add gettext() to BzrCommandError uses
113
                    " leading parent directories.")
4294.2.6 by Robert Collins
Report errors back in the UI layer for push, to use the url the user gave us.
114
                    % location)
4634.129.2 by Andrew Bennetts
Add NEWS entry and elaborate comment, as suggested in Martin's review.
115
            # This shouldn't occur (because create_prefix is true, so
116
            # create_clone_on_transport should be catching NoSuchFile and
117
            # creating the missing directories) but if it does the original
118
            # NoSuchFile error will be more informative than an
119
            # UnboundLocalError for br_to.
4634.129.1 by Andrew Bennetts
Propagate the NoSuchFile error in show_push_branch when create_prefix is True, because a user reports that it can happen somehow.
120
            raise
4294.2.6 by Robert Collins
Report errors back in the UI layer for push, to use the url the user gave us.
121
        except errors.TooManyRedirections:
6138.3.7 by Jonathan Riddell
add gettext() to BzrCommandError uses
122
            raise errors.BzrCommandError(gettext("Too many redirections trying "
123
                                         "to make %s.") % location)
4294.2.1 by Robert Collins
Move directory checking for bzr push options into Branch.create_clone_on_transport.
124
        push_result = PushResult()
3221.19.1 by Ian Clatworthy
refactor cmd_push to use a helper function
125
        # TODO: Some more useful message about what was copied
3650.5.2 by Aaron Bentley
Always show stacked message if stacking done.
126
        try:
3978.3.3 by Jelmer Vernooij
Use PushResult everywhere.
127
            push_result.stacked_on = br_to.get_stacked_on_url()
3650.5.2 by Aaron Bentley
Always show stacked message if stacking done.
128
        except (errors.UnstackableBranchFormat,
129
                errors.UnstackableRepositoryFormat,
130
                errors.NotStacked):
3978.3.3 by Jelmer Vernooij
Use PushResult everywhere.
131
            push_result.stacked_on = None
3978.3.11 by Jelmer Vernooij
Move InterBranchBzrDir to bzrlib.push.
132
        push_result.target_branch = br_to
3978.3.13 by Jelmer Vernooij
Store the pushed branches' URL rather than the URL of the branch itself.
133
        push_result.old_revid = _mod_revision.NULL_REVISION
134
        push_result.old_revno = 0
5861.1.11 by Vincent Ladeuil
Add news entry and same comments.
135
        # Remembers if asked explicitly or no previous location is set
5861.1.9 by Vincent Ladeuil
Fix --no-remember for the first push.
136
        if (remember
137
            or (remember is None and br_from.get_push_location() is None)):
6404.6.7 by Vincent Ladeuil
Change set/remove to require a lock for the branch config files.
138
            # FIXME: Should be done only if we succeed ? -- vila 2012-01-18
139
            br_from.set_push_location(br_to.base)
3978.3.2 by Jelmer Vernooij
Move most of push to IterGenericBranchBzrDir.
140
    else:
3549.1.1 by Martin Pool
rename push --reference to --stacked-on
141
        if stacked_on is not None:
3221.19.4 by Ian Clatworthy
shallow -> stacked
142
            warning("Ignoring request for a stacked branch as repository "
3221.19.2 by Ian Clatworthy
tweaks to ui during review by igc
143
                    "already exists at the destination location.")
3221.19.1 by Ian Clatworthy
refactor cmd_push to use a helper function
144
        try:
3978.3.15 by Jelmer Vernooij
Rename BzrDir.push() to BzrDir.push_branch().
145
            push_result = dir_to.push_branch(br_from, revision_id, overwrite, 
4416.8.1 by Jelmer Vernooij
Pass create_prefix paremeter to BzrDir.push_branch.
146
                remember, create_prefix)
3221.19.1 by Ian Clatworthy
refactor cmd_push to use a helper function
147
        except errors.DivergedBranches:
6138.3.7 by Jonathan Riddell
add gettext() to BzrCommandError uses
148
            raise errors.BzrCommandError(gettext('These branches have diverged.'
4416.4.1 by Neil Martinsen-Burrell
Fix 269477 Add documentation about diverged branches and refer to it when pushing fails
149
                                    '  See "bzr help diverged-branches"'
6138.3.7 by Jonathan Riddell
add gettext() to BzrCommandError uses
150
                                    ' for more information.'))
4925.1.1 by Jelmer Vernooij
Print a proper error when attempting to push to a foreign VCS for which
151
        except errors.NoRoundtrippingSupport, e:
6138.3.7 by Jonathan Riddell
add gettext() to BzrCommandError uses
152
            raise errors.BzrCommandError(gettext("It is not possible to losslessly "
153
                "push to %s. You may want to use dpush instead.") % 
4925.1.1 by Jelmer Vernooij
Print a proper error when attempting to push to a foreign VCS for which
154
                    e.target_branch.mapping.vcs.abbreviation)
3978.3.13 by Jelmer Vernooij
Store the pushed branches' URL rather than the URL of the branch itself.
155
        except errors.NoRepositoryPresent:
6207.3.3 by jelmer at samba
Fix tests and the like.
156
            # we have a controldir but no branch or repository
3978.3.13 by Jelmer Vernooij
Store the pushed branches' URL rather than the URL of the branch itself.
157
            # XXX: Figure out what to do other than complain.
6138.3.7 by Jonathan Riddell
add gettext() to BzrCommandError uses
158
            raise errors.BzrCommandError(gettext("At %s you have a valid .bzr"
3978.3.13 by Jelmer Vernooij
Store the pushed branches' URL rather than the URL of the branch itself.
159
                " control directory, but not a branch or repository. This"
160
                " is an unsupported configuration. Please move the target"
6138.3.7 by Jonathan Riddell
add gettext() to BzrCommandError uses
161
                " directory out of the way and try again.") % location)
3978.3.11 by Jelmer Vernooij
Move InterBranchBzrDir to bzrlib.push.
162
        if push_result.workingtree_updated == False:
3978.3.2 by Jelmer Vernooij
Move most of push to IterGenericBranchBzrDir.
163
            warning("This transport does not update the working " 
164
                    "tree of: %s. See 'bzr help working-trees' for "
165
                    "more information." % push_result.target_branch.base)
3978.3.3 by Jelmer Vernooij
Use PushResult everywhere.
166
    push_result.report(to_file)
3848.1.19 by Aaron Bentley
Show log for non-initial push -v
167
    if verbose:
3978.3.11 by Jelmer Vernooij
Move InterBranchBzrDir to bzrlib.push.
168
        br_to = push_result.target_branch
3848.1.18 by Aaron Bentley
Update push to use show_branch_change
169
        br_to.lock_read()
170
        try:
171
            from bzrlib.log import show_branch_change
3978.3.13 by Jelmer Vernooij
Store the pushed branches' URL rather than the URL of the branch itself.
172
            show_branch_change(br_to, to_file, push_result.old_revno, 
173
                               push_result.old_revid)
3848.1.18 by Aaron Bentley
Update push to use show_branch_change
174
        finally:
175
            br_to.unlock()
3978.3.11 by Jelmer Vernooij
Move InterBranchBzrDir to bzrlib.push.
176
177