/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 bzrlib/push.py

  • Committer: Andrew Bennetts
  • Date: 2008-08-12 14:53:26 UTC
  • mto: This revision was merged to the branch mainline in revision 3624.
  • Revision ID: andrew.bennetts@canonical.com-20080812145326-yx693x2jc4rcovb7
Move the notes on writing tests out of HACKING into a new file, and improve
them.

Many of the testing notes in the HACKING file were in duplicated in two places
in that file!  This change removes that duplication.  It also adds new sections
on “Where should I put a new test?” and “TestCase and its subclasses”, and
others like “Test feature dependencies” have been expanded.  The whole document
has generally been edited to be a bit more coherent. 

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/push.py
1
 
# Copyright (C) 2008, 2009, 2010 Canonical Ltd
 
1
# Copyright (C) 2008 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
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
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""UI helper for the push command."""
18
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)
 
19
from bzrlib import builtins, bzrdir, errors, transport
 
20
from bzrlib.trace import note, warning
56
21
 
57
22
 
58
23
def _show_push_branch(br_from, revision_id, location, to_file, verbose=False,
77
42
        directory exists without a current .bzr directory in it
78
43
    """
79
44
    to_transport = transport.get_transport(location)
 
45
    br_to = repository_to = dir_to = None
80
46
    try:
81
47
        dir_to = bzrdir.BzrDir.open_from_transport(to_transport)
82
48
    except errors.NotBranchError:
83
 
        # Didn't find anything
84
 
        dir_to = None
 
49
        pass # Didn't find anything
 
50
    else:
 
51
        # If we can open a branch, use its direct repository, otherwise see
 
52
        # if there is a repository without a branch.
 
53
        try:
 
54
            br_to = dir_to.open_branch()
 
55
        except errors.NotBranchError:
 
56
            # Didn't find a branch, can we find a repository?
 
57
            try:
 
58
                repository_to = dir_to.find_repository()
 
59
            except errors.NoRepositoryPresent:
 
60
                pass
 
61
        else:
 
62
            # Found a branch, so we must have found a repository
 
63
            repository_to = br_to.repository
85
64
 
 
65
    push_result = None
 
66
    if verbose:
 
67
        old_rh = []
86
68
    if dir_to is None:
 
69
        # The destination doesn't exist; create it.
 
70
        # XXX: Refactor the create_prefix/no_create_prefix code into a
 
71
        #      common helper function
 
72
 
 
73
        def make_directory(transport):
 
74
            transport.mkdir('.')
 
75
            return transport
 
76
 
 
77
        def redirected(redirected_transport, e, redirection_notice):
 
78
            return transport.get_transport(e.get_target_url())
 
79
 
87
80
        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
 
        except errors.FileExists, err:
92
 
            if err.path.endswith('/.bzr'):
93
 
                raise errors.BzrCommandError(
94
 
                    "Target directory %s already contains a .bzr directory, "
95
 
                    "but it is not valid." % (location,))
 
81
            to_transport = transport.do_catching_redirections(
 
82
                make_directory, to_transport, redirected)
 
83
        except errors.FileExists:
96
84
            if not use_existing_dir:
97
85
                raise errors.BzrCommandError("Target directory %s"
98
 
                     " already exists, but does not have a .bzr"
 
86
                     " already exists, but does not have a valid .bzr"
99
87
                     " directory. Supply --use-existing-dir to push"
100
88
                     " there anyway." % location)
101
 
            # This shouldn't occur, but if it does the FileExists error will be
102
 
            # more informative than an UnboundLocalError for br_to.
103
 
            raise
104
89
        except errors.NoSuchFile:
105
90
            if not create_prefix:
106
91
                raise errors.BzrCommandError("Parent directory of %s"
108
93
                    "\nYou may supply --create-prefix to create all"
109
94
                    " leading parent directories."
110
95
                    % location)
111
 
            # This shouldn't occur (because create_prefix is true, so
112
 
            # create_clone_on_transport should be catching NoSuchFile and
113
 
            # creating the missing directories) but if it does the original
114
 
            # NoSuchFile error will be more informative than an
115
 
            # UnboundLocalError for br_to.
116
 
            raise
 
96
            builtins._create_prefix(to_transport)
117
97
        except errors.TooManyRedirections:
118
98
            raise errors.BzrCommandError("Too many redirections trying "
119
99
                                         "to make %s." % location)
120
 
        push_result = PushResult()
 
100
 
 
101
        # Now the target directory exists, but doesn't have a .bzr
 
102
        # directory. So we need to create it, along with any work to create
 
103
        # all of the dependent branches, etc.
 
104
        if stacked_on is not None:
 
105
            # This should be buried in the clone method itself. TODO.
 
106
            try:
 
107
                # if the from format is stackable, this will either work or
 
108
                # trigger NotStacked. If it's not, an error will be given to
 
109
                # the user.
 
110
                br_from.get_stacked_on_url()
 
111
            except errors.NotStacked:
 
112
                pass
 
113
            # now we need to sprout the repository,
 
114
            dir_to = br_from.bzrdir._format.initialize_on_transport(to_transport)
 
115
            br_from.repository._format.initialize(dir_to)
 
116
            br_to = br_from._format.initialize(dir_to)
 
117
            br_to.set_stacked_on_url(stacked_on)
 
118
            # and copy the data up.
 
119
            br_from.push(br_to)
 
120
        else:
 
121
            dir_to = br_from.bzrdir.clone_on_transport(to_transport,
 
122
                revision_id=revision_id)
 
123
        br_to = dir_to.open_branch()
121
124
        # TODO: Some more useful message about what was copied
122
 
        try:
123
 
            push_result.stacked_on = br_to.get_stacked_on_url()
124
 
        except (errors.UnstackableBranchFormat,
125
 
                errors.UnstackableRepositoryFormat,
126
 
                errors.NotStacked):
127
 
            push_result.stacked_on = None
128
 
        push_result.target_branch = br_to
129
 
        push_result.old_revid = _mod_revision.NULL_REVISION
130
 
        push_result.old_revno = 0
 
125
        if stacked_on is not None:
 
126
            note('Created new stacked branch referring to %s.' % stacked_on)
 
127
        else:
 
128
            note('Created new branch.')
 
129
        # We successfully created the target, remember it
131
130
        if br_from.get_push_location() is None or remember:
132
131
            br_from.set_push_location(br_to.base)
133
 
    else:
 
132
    elif repository_to is None:
 
133
        # we have a bzrdir but no branch or repository
 
134
        # XXX: Figure out what to do other than complain.
 
135
        raise errors.BzrCommandError("At %s you have a valid .bzr control"
 
136
            " directory, but not a branch or repository. This is an"
 
137
            " unsupported configuration. Please move the target directory"
 
138
            " out of the way and try again."
 
139
            % location)
 
140
    elif br_to is None:
 
141
        # We have a repository but no branch, copy the revisions, and then
 
142
        # create a branch.
134
143
        if stacked_on is not None:
135
144
            warning("Ignoring request for a stacked branch as repository "
136
145
                    "already exists at the destination location.")
 
146
        repository_to.fetch(br_from.repository, revision_id=revision_id)
 
147
        br_to = br_from.clone(dir_to, revision_id=revision_id)
 
148
        note('Created new branch.')
 
149
        if br_from.get_push_location() is None or remember:
 
150
            br_from.set_push_location(br_to.base)
 
151
    else: # We have a valid to branch
 
152
        if stacked_on is not None:
 
153
            warning("Ignoring request for a stacked branch as branch "
 
154
                    "already exists at the destination location.")
 
155
        # We were able to connect to the remote location, so remember it.
 
156
        # (We don't need to successfully push because of possible divergence.)
 
157
        if br_from.get_push_location() is None or remember:
 
158
            br_from.set_push_location(br_to.base)
 
159
        if verbose:
 
160
            old_rh = br_to.revision_history()
137
161
        try:
138
 
            push_result = dir_to.push_branch(br_from, revision_id, overwrite, 
139
 
                remember, create_prefix)
 
162
            try:
 
163
                tree_to = dir_to.open_workingtree()
 
164
            except errors.NotLocalUrl:
 
165
                warning("This transport does not update the working " 
 
166
                        "tree of: %s. See 'bzr help working-trees' for "
 
167
                        "more information." % br_to.base)
 
168
                push_result = br_from.push(br_to, overwrite,
 
169
                                           stop_revision=revision_id)
 
170
            except errors.NoWorkingTree:
 
171
                push_result = br_from.push(br_to, overwrite,
 
172
                                           stop_revision=revision_id)
 
173
            else:
 
174
                tree_to.lock_write()
 
175
                try:
 
176
                    push_result = br_from.push(tree_to.branch, overwrite,
 
177
                                               stop_revision=revision_id)
 
178
                    tree_to.update()
 
179
                finally:
 
180
                    tree_to.unlock()
140
181
        except errors.DivergedBranches:
141
182
            raise errors.BzrCommandError('These branches have diverged.'
142
 
                                    '  See "bzr help diverged-branches"'
143
 
                                    ' for more information.')
144
 
        except errors.NoRoundtrippingSupport, e:
145
 
            raise errors.BzrCommandError("It is not possible to losslessly "
146
 
                "push to %s. You may want to use dpush instead." % 
147
 
                    e.target_branch.mapping.vcs.abbreviation)
148
 
        except errors.NoRepositoryPresent:
149
 
            # we have a bzrdir but no branch or repository
150
 
            # XXX: Figure out what to do other than complain.
151
 
            raise errors.BzrCommandError("At %s you have a valid .bzr"
152
 
                " control directory, but not a branch or repository. This"
153
 
                " is an unsupported configuration. Please move the target"
154
 
                " directory out of the way and try again." % location)
155
 
        if push_result.workingtree_updated == False:
156
 
            warning("This transport does not update the working " 
157
 
                    "tree of: %s. See 'bzr help working-trees' for "
158
 
                    "more information." % push_result.target_branch.base)
159
 
    push_result.report(to_file)
160
 
    if verbose:
161
 
        br_to = push_result.target_branch
162
 
        br_to.lock_read()
163
 
        try:
164
 
            from bzrlib.log import show_branch_change
165
 
            show_branch_change(br_to, to_file, push_result.old_revno, 
166
 
                               push_result.old_revid)
167
 
        finally:
168
 
            br_to.unlock()
169
 
 
170
 
 
 
183
                                    '  Try using "merge" and then "push".')
 
184
    if push_result is not None:
 
185
        push_result.report(to_file)
 
186
    elif verbose:
 
187
        new_rh = br_to.revision_history()
 
188
        if old_rh != new_rh:
 
189
            # Something changed
 
190
            from bzrlib.log import show_changed_revisions
 
191
            show_changed_revisions(br_to, old_rh, new_rh,
 
192
                                   to_file=to_file)
 
193
    else:
 
194
        # we probably did a clone rather than a push, so a message was
 
195
        # emitted above
 
196
        pass