1
# Copyright (C) 2010, 2011 Canonical Ltd
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.
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.
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
17
from __future__ import absolute_import
23
from bzrlib.lazy_import import lazy_import
24
lazy_import(globals(), """
30
from bzrlib.i18n import gettext
31
from bzrlib.plugins.launchpad import (
38
class ProposeMergeHooks(hooks.Hooks):
39
"""Hooks for proposing a merge on Launchpad."""
42
hooks.Hooks.__init__(self, "bzrlib.plugins.launchpad.lp_propose",
44
self.add_hook('get_prerequisite',
45
"Return the prerequisite branch for proposing as merge.", (2, 1))
46
self.add_hook('merge_proposal_body',
47
"Return an initial body for the merge proposal message.", (2, 1))
50
class Proposer(object):
52
hooks = ProposeMergeHooks()
54
def __init__(self, tree, source_branch, target_branch, message, reviews,
55
staging=False, approve=False, fixes=None):
58
:param tree: The working tree for the source branch.
59
:param source_branch: The branch to propose for merging.
60
:param target_branch: The branch to merge into.
61
:param message: The commit message to use. (May be None.)
62
:param reviews: A list of tuples of reviewer, review type.
63
:param staging: If True, propose the merge against staging instead of
65
:param approve: If True, mark the new proposal as approved immediately.
66
This is useful when a project permits some things to be approved
67
by the submitter (e.g. merges between release and deployment
72
lp_instance = 'staging'
74
lp_instance = 'production'
75
service = lp_registration.LaunchpadService(lp_instance=lp_instance)
76
self.launchpad = lp_api.login(service)
77
self.source_branch = lp_api.LaunchpadBranch.from_bzr(
78
self.launchpad, source_branch)
79
if target_branch is None:
80
self.target_branch = self.source_branch.get_target()
82
self.target_branch = lp_api.LaunchpadBranch.from_bzr(
83
self.launchpad, target_branch)
84
self.commit_message = message
85
# XXX: this is where bug lp:583638 could be tackled.
89
self.reviews = [(self.launchpad.people[reviewer], review_type)
90
for reviewer, review_type in
92
self.approve = approve
95
def get_comment(self, prerequisite_branch):
96
"""Determine the initial comment for the merge proposal."""
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
self.source_branch.bzr.lock_read()
106
self.target_branch.bzr.lock_read()
108
body = self.get_initial_body()
110
self.target_branch.bzr.unlock()
112
self.source_branch.bzr.unlock()
113
initial_comment = msgeditor.edit_commit_message(''.join(info),
115
return initial_comment.strip().encode('utf-8')
117
def get_initial_body(self):
118
"""Get a body for the proposal for the user to modify.
120
:return: a str or None.
122
def list_modified_files():
123
lca_tree = self.source_branch.find_lca_tree(
125
source_tree = self.source_branch.bzr.basis_tree()
126
files = modified_files(lca_tree, source_tree)
128
target_loc = ('bzr+ssh://bazaar.launchpad.net/%s' %
129
self.target_branch.lp.unique_name)
131
for hook in self.hooks['merge_proposal_body']:
134
'target_branch': target_loc,
135
'modified_files_callback': list_modified_files,
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'):
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))
153
def _get_prerequisite_branch(self):
154
hooks = self.hooks['get_prerequisite']
155
prerequisite_branch = None
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
164
def call_webservice(self, call, *args, **kwargs):
165
"""Make a call to the webservice, wrapping failures.
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).
172
from lazr.restfulclient import errors as restful_errors
174
return call(*args, **kwargs)
175
except restful_errors.HTTPError, e:
177
for line in e.content.splitlines():
178
if line.startswith('Traceback (most recent call last):'):
180
error_lines.append(line)
181
raise Exception(''.join(error_lines))
183
def create_proposal(self):
184
"""Perform the submission."""
185
prerequisite_branch = self._get_prerequisite_branch()
186
if prerequisite_branch is None:
189
prereq = prerequisite_branch.lp
190
prerequisite_branch.update_lp()
191
self.source_branch.update_lp()
194
for reviewer, review_type in self.reviews:
195
review_types.append(review_type)
196
reviewers.append(reviewer.self_link)
197
initial_comment = self.get_comment(prerequisite_branch)
198
mp = self.call_webservice(
199
self.source_branch.lp.createMergeProposal,
200
target_branch=self.target_branch.lp,
201
prerequisite_branch=prereq,
202
initial_comment=initial_comment,
203
commit_message=self.commit_message, reviewers=reviewers,
204
review_types=review_types)
206
self.call_webservice(mp.setStatus, status='Approved')
208
if self.fixes.startswith('lp:'):
209
self.fixes = self.fixes[3:]
210
self.call_webservice(
211
self.source_branch.lp.linkBug,
212
bug=self.launchpad.bugs[int(self.fixes)])
213
webbrowser.open(lp_api.canonical_url(mp))
216
def modified_files(old_tree, new_tree):
217
"""Return a list of paths in the new tree with modified contents."""
218
for f, (op, path), c, v, p, n, (ok, k), e in new_tree.iter_changes(
220
if c and k == 'file':