/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 breezy/plugins/launchpad/lp_propose.py

  • Committer: Vincent Ladeuil
  • Date: 2019-11-19 18:10:28 UTC
  • mfrom: (7290.1.43 work)
  • mto: This revision was merged to the branch mainline in revision 7414.
  • Revision ID: v.ladeuil+brz@free.fr-20191119181028-rgajksejntz3vwil
Merge lp:brz/3.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/plugins/launchpad/lp_propose.py
 
1
# Copyright (C) 2010, 2011 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
from __future__ import absolute_import
 
18
 
 
19
from ... import (
 
20
    errors,
 
21
    hooks,
 
22
    )
 
23
from ...lazy_import import lazy_import
 
24
lazy_import(globals(), """
 
25
import webbrowser
 
26
 
 
27
from breezy import (
 
28
    msgeditor,
 
29
    )
 
30
from breezy.i18n import gettext
 
31
from breezy.plugins.launchpad import (
 
32
    lp_api,
 
33
    )
 
34
""")
 
35
 
 
36
 
 
37
class ProposeMergeHooks(hooks.Hooks):
 
38
    """Hooks for proposing a merge on Launchpad."""
 
39
 
 
40
    def __init__(self):
 
41
        hooks.Hooks.__init__(self, "breezy.plugins.launchpad.lp_propose",
 
42
                             "Proposer.hooks")
 
43
        self.add_hook('get_prerequisite',
 
44
                      "Return the prerequisite branch for proposing as merge.", (2, 1))
 
45
        self.add_hook('merge_proposal_body',
 
46
                      "Return an initial body for the merge proposal message.", (2, 1))
 
47
 
 
48
 
 
49
class Proposer(object):
 
50
 
 
51
    hooks = ProposeMergeHooks()
 
52
 
 
53
    def __init__(self, tree, source_branch, target_branch, message, reviews,
 
54
                 staging=False, approve=False, fixes=None):
 
55
        """Constructor.
 
56
 
 
57
        :param tree: The working tree for the source branch.
 
58
        :param source_branch: The branch to propose for merging.
 
59
        :param target_branch: The branch to merge into.
 
60
        :param message: The commit message to use.  (May be None.)
 
61
        :param reviews: A list of tuples of reviewer, review type.
 
62
        :param staging: If True, propose the merge against staging instead of
 
63
            production.
 
64
        :param approve: If True, mark the new proposal as approved immediately.
 
65
            This is useful when a project permits some things to be approved
 
66
            by the submitter (e.g. merges between release and deployment
 
67
            branches).
 
68
        """
 
69
        self.tree = tree
 
70
        if staging:
 
71
            lp_base_url = lp_api.uris.STAGING_SERVICE_ROOT
 
72
        else:
 
73
            lp_base_url = lp_api.uris.LPNET_SERVICE_ROOT
 
74
        self.launchpad = lp_api.connect_launchpad(lp_base_url)
 
75
        self.source_branch = lp_api.LaunchpadBranch.from_bzr(
 
76
            self.launchpad, source_branch)
 
77
        if target_branch is None:
 
78
            self.target_branch = self.source_branch.get_target()
 
79
        else:
 
80
            self.target_branch = lp_api.LaunchpadBranch.from_bzr(
 
81
                self.launchpad, target_branch)
 
82
        self.commit_message = message
 
83
        # XXX: this is where bug lp:583638 could be tackled.
 
84
        if reviews == []:
 
85
            self.reviews = []
 
86
        else:
 
87
            self.reviews = [(self.launchpad.people[reviewer], review_type)
 
88
                            for reviewer, review_type in
 
89
                            reviews]
 
90
        self.approve = approve
 
91
        self.fixes = fixes
 
92
 
 
93
    def get_comment(self, prerequisite_branch):
 
94
        """Determine the initial comment for the merge proposal."""
 
95
        if self.commit_message is not None:
 
96
            return self.commit_message.strip().encode('utf-8')
 
97
        info = ["Source: %s\n" % self.source_branch.lp.bzr_identity]
 
98
        info.append("Target: %s\n" % self.target_branch.lp.bzr_identity)
 
99
        if prerequisite_branch is not None:
 
100
            info.append("Prereq: %s\n" % prerequisite_branch.lp.bzr_identity)
 
101
        for rdata in self.reviews:
 
102
            uniquename = "%s (%s)" % (rdata[0].display_name, rdata[0].name)
 
103
            info.append('Reviewer: %s, type "%s"\n' % (uniquename, rdata[1]))
 
104
        with self.source_branch.bzr.lock_read(), \
 
105
                self.target_branch.bzr.lock_read():
 
106
            body = self.get_initial_body()
 
107
        initial_comment = msgeditor.edit_commit_message(''.join(info),
 
108
                                                        start_message=body)
 
109
        return initial_comment.strip().encode('utf-8')
 
110
 
 
111
    def get_initial_body(self):
 
112
        """Get a body for the proposal for the user to modify.
 
113
 
 
114
        :return: a str or None.
 
115
        """
 
116
        def list_modified_files():
 
117
            lca_tree = self.source_branch.find_lca_tree(
 
118
                self.target_branch)
 
119
            source_tree = self.source_branch.bzr.basis_tree()
 
120
            files = modified_files(lca_tree, source_tree)
 
121
            return list(files)
 
122
        target_loc = ('bzr+ssh://bazaar.launchpad.net/%s' %
 
123
                      self.target_branch.lp.unique_name)
 
124
        body = None
 
125
        for hook in self.hooks['merge_proposal_body']:
 
126
            body = hook({
 
127
                'tree': self.tree,
 
128
                'target_branch': target_loc,
 
129
                'modified_files_callback': list_modified_files,
 
130
                'old_body': body,
 
131
            })
 
132
        return body
 
133
 
 
134
    def get_source_revid(self):
 
135
        """Get the revision ID of the source branch."""
 
136
        source_branch = self.source_branch.bzr
 
137
        with source_branch.lock_read():
 
138
            return source_branch.last_revision()
 
139
 
 
140
    def check_proposal(self):
 
141
        """Check that the submission is sensible."""
 
142
        if self.source_branch.lp.self_link == self.target_branch.lp.self_link:
 
143
            raise errors.BzrCommandError(
 
144
                'Source and target branches must be different.')
 
145
        for mp in self.source_branch.lp.landing_targets:
 
146
            if mp.queue_status in ('Merged', 'Rejected'):
 
147
                continue
 
148
            if mp.target_branch.self_link == self.target_branch.lp.self_link:
 
149
                raise errors.BzrCommandError(gettext(
 
150
                    'There is already a branch merge proposal: %s') %
 
151
                    lp_api.canonical_url(mp))
 
152
 
 
153
    def _get_prerequisite_branch(self):
 
154
        hooks = self.hooks['get_prerequisite']
 
155
        prerequisite_branch = None
 
156
        for hook in hooks:
 
157
            prerequisite_branch = hook(
 
158
                {'launchpad': self.launchpad,
 
159
                 'source_branch': self.source_branch,
 
160
                 'target_branch': self.target_branch,
 
161
                 'prerequisite_branch': prerequisite_branch})
 
162
        return prerequisite_branch
 
163
 
 
164
    def call_webservice(self, call, *args, **kwargs):
 
165
        """Make a call to the webservice, wrapping failures.
 
166
 
 
167
        :param call: The call to make.
 
168
        :param *args: *args for the call.
 
169
        :param **kwargs: **kwargs for the call.
 
170
        :return: The result of calling call(*args, *kwargs).
 
171
        """
 
172
        from lazr.restfulclient import errors as restful_errors
 
173
        try:
 
174
            return call(*args, **kwargs)
 
175
        except restful_errors.HTTPError as e:
 
176
            error_lines = []
 
177
            for line in e.content.splitlines():
 
178
                if line.startswith('Traceback (most recent call last):'):
 
179
                    break
 
180
                error_lines.append(line)
 
181
            raise Exception(''.join(error_lines))
 
182
 
 
183
    def approve_proposal(self, mp):
 
184
        revid = self.get_source_revid()
 
185
        self.call_webservice(
 
186
            mp.createComment,
 
187
            vote=u'Approve',
 
188
            subject='',  # Use the default subject.
 
189
            content=u"Rubberstamp! Proposer approves of own proposal.")
 
190
        self.call_webservice(mp.setStatus, status=u'Approved', revid=revid)
 
191
 
 
192
    def create_proposal(self):
 
193
        """Perform the submission."""
 
194
        prerequisite_branch = self._get_prerequisite_branch()
 
195
        if prerequisite_branch is None:
 
196
            prereq = None
 
197
        else:
 
198
            prereq = prerequisite_branch.lp
 
199
            prerequisite_branch.update_lp()
 
200
        self.source_branch.update_lp()
 
201
        reviewers = []
 
202
        review_types = []
 
203
        for reviewer, review_type in self.reviews:
 
204
            review_types.append(review_type)
 
205
            reviewers.append(reviewer.self_link)
 
206
        initial_comment = self.get_comment(prerequisite_branch)
 
207
        mp = self.call_webservice(
 
208
            self.source_branch.lp.createMergeProposal,
 
209
            target_branch=self.target_branch.lp,
 
210
            prerequisite_branch=prereq,
 
211
            initial_comment=initial_comment,
 
212
            commit_message=self.commit_message, reviewers=reviewers,
 
213
            review_types=review_types)
 
214
        if self.approve:
 
215
            self.approve_proposal(mp)
 
216
        if self.fixes:
 
217
            if self.fixes.startswith('lp:'):
 
218
                self.fixes = self.fixes[3:]
 
219
            self.call_webservice(
 
220
                self.source_branch.lp.linkBug,
 
221
                bug=self.launchpad.bugs[int(self.fixes)])
 
222
        webbrowser.open(lp_api.canonical_url(mp))
 
223
 
 
224
 
 
225
def modified_files(old_tree, new_tree):
 
226
    """Return a list of paths in the new tree with modified contents."""
 
227
    for change in new_tree.iter_changes(old_tree):
 
228
        if change.changed_content and change.kind[1] == 'file':
 
229
            yield str(path)