1
# Copyright (C) 2009, 2010 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
24
from bzrlib.hooks import HookPoint, Hooks
25
from bzrlib.plugins.launchpad import (
30
from lazr.restfulclient import errors as restful_errors
33
class ProposeMergeHooks(Hooks):
34
"""Hooks for proposing a merge on Launchpad."""
41
"Return the prerequisite branch for proposing as merge.",
46
'merge_proposal_body',
47
"Return an initial body for the merge proposal message.",
52
class Proposer(object):
54
hooks = ProposeMergeHooks()
56
def __init__(self, tree, source_branch, target_branch, message, reviews,
60
:param tree: The working tree for the source branch.
61
:param source_branch: The branch to propose for merging.
62
:param target_branch: The branch to merge into.
63
:param message: The commit message to use. (May be None.)
64
:param reviews: A list of tuples of reviewer, review type.
65
:param staging: If True, propose the merge against staging instead of
70
lp_instance = 'staging'
73
service = lp_registration.LaunchpadService(lp_instance=lp_instance)
74
self.launchpad = lp_api.login(service)
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_dev_focus()
80
self.target_branch = lp_api.LaunchpadBranch.from_bzr(
81
self.launchpad, target_branch)
82
self.commit_message = message
84
target_reviewer = self.target_branch.lp.reviewer
85
if target_reviewer is None:
86
raise errors.BzrCommandError('No reviewer specified')
87
self.reviews = [(target_reviewer, '')]
89
self.reviews = [(self.launchpad.people[reviewer], review_type)
90
for reviewer, review_type in
93
def get_comment(self, prerequisite_branch):
94
"""Determine the initial comment for the merge proposal."""
95
info = ["Source: %s\n" % self.source_branch.lp.bzr_identity]
96
info.append("Target: %s\n" % self.target_branch.lp.bzr_identity)
97
if prerequisite_branch is not None:
98
info.append("Prereq: %s\n" % prerequisite_branch.lp.bzr_identity)
99
for rdata in self.reviews:
100
uniquename = "%s (%s)" % (rdata[0].display_name, rdata[0].name)
101
info.append('Reviewer: %s, type "%s"\n' % (uniquename, rdata[1]))
102
self.source_branch.bzr.lock_read()
104
self.target_branch.bzr.lock_read()
106
body = self.get_initial_body()
108
self.target_branch.bzr.unlock()
110
self.source_branch.bzr.unlock()
111
initial_comment = msgeditor.edit_commit_message(''.join(info),
113
return initial_comment.strip().encode('utf-8')
115
def get_initial_body(self):
116
"""Get a body for the proposal for the user to modify.
118
:return: a str or None.
120
def list_modified_files():
121
lca_tree = self.source_branch.find_lca_tree(
123
source_tree = self.source_branch.bzr.basis_tree()
124
files = modified_files(lca_tree, source_tree)
126
target_loc = ('bzr+ssh://bazaar.launchpad.net/%s' %
127
self.target_branch.lp.unique_name)
129
for hook in self.hooks['merge_proposal_body']:
132
'target_branch': target_loc,
133
'modified_files_callback': list_modified_files,
138
def check_proposal(self):
139
"""Check that the submission is sensible."""
140
if self.source_branch.lp.self_link == self.target_branch.lp.self_link:
141
raise errors.BzrCommandError(
142
'Source and target branches must be different.')
143
for mp in self.source_branch.lp.landing_targets:
144
if mp.queue_status in ('Merged', 'Rejected'):
146
if mp.target_branch.self_link == self.target_branch.lp.self_link:
147
raise errors.BzrCommandError(
148
'There is already a branch merge proposal: %s' %
151
def _get_prerequisite_branch(self):
152
hooks = self.hooks['get_prerequisite']
153
prerequisite_branch = None
155
prerequisite_branch = hook(
156
{'launchpad': self.launchpad,
157
'source_branch': self.source_branch,
158
'target_branch': self.target_branch,
159
'prerequisite_branch': prerequisite_branch})
160
return prerequisite_branch
162
def create_proposal(self):
163
"""Perform the submission."""
164
prerequisite_branch = self._get_prerequisite_branch()
165
if prerequisite_branch is None:
168
prereq = prerequisite_branch.lp
169
prerequisite_branch.update_lp()
170
self.source_branch.update_lp()
173
for reviewer, review_type in self.reviews:
174
review_types.append(review_type)
175
reviewers.append(reviewer.self_link)
176
initial_comment = self.get_comment(prerequisite_branch)
178
mp = self.source_branch.lp.createMergeProposal(
179
target_branch=self.target_branch.lp,
180
prerequisite_branch=prereq,
181
initial_comment=initial_comment,
182
commit_message=self.commit_message, reviewers=reviewers,
183
review_types=review_types)
184
except restful_errors.HTTPError, e:
186
for line in e.content.splitlines():
187
if line.startswith('Traceback (most recent call last):'):
189
error_lines.append(line)
190
raise Exception(''.join(error_lines))
192
webbrowser.open(canonical_url(mp))
195
def modified_files(old_tree, new_tree):
196
"""Return a list of paths in the new tree with modified contents."""
197
for f, (op, path), c, v, p, n, (ok, k), e in new_tree.iter_changes(
199
if c and k == 'file':
203
def canonical_url(object):
204
"""Return the canonical URL for a branch."""
205
url = object.self_link.replace('https://api.', 'https://code.')
206
return url.replace('/beta/', '/')
added
removed
bzrlib/plugins/launchpad/lp_propose.py
