5752.3.8
by John Arbash Meinel
Merge bzr.dev 5764 to resolve release-notes (aka NEWS) conflicts |
1 |
# Copyright (C) 2010, 2011 Canonical Ltd
|
4969.2.16
by Aaron Bentley
Updates from review. |
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 |
||
6379.6.3
by Jelmer Vernooij
Use absolute_import. |
17 |
from __future__ import absolute_import |
18 |
||
4969.2.1
by Aaron Bentley
Initial import of lp_submit command. |
19 |
from bzrlib import ( |
20 |
errors, |
|
5184.1.1
by Vincent Ladeuil
Random cleanups to catch up with copyright updates in trunk. |
21 |
hooks, |
5615.1.1
by Jelmer Vernooij
Lazy load a couple of modules in bzrlib.plugins.launchpad.lp_propose. |
22 |
)
|
23 |
from bzrlib.lazy_import import lazy_import |
|
24 |
lazy_import(globals(), """ |
|
25 |
import webbrowser
|
|
26 |
||
27 |
from bzrlib import (
|
|
4969.2.1
by Aaron Bentley
Initial import of lp_submit command. |
28 |
msgeditor,
|
5753.2.2
by Jelmer Vernooij
Remove some unnecessary imports, clean up lazy imports. |
29 |
)
|
6336.1.1
by Jelmer Vernooij
Deprecate ``RevisionSpec.wants_revision_history`` and remove any uses of it. |
30 |
from bzrlib.i18n import gettext
|
4969.2.16
by Aaron Bentley
Updates from review. |
31 |
from bzrlib.plugins.launchpad import (
|
32 |
lp_api,
|
|
33 |
lp_registration,
|
|
5753.2.2
by Jelmer Vernooij
Remove some unnecessary imports, clean up lazy imports. |
34 |
)
|
5615.1.1
by Jelmer Vernooij
Lazy load a couple of modules in bzrlib.plugins.launchpad.lp_propose. |
35 |
""") |
4969.2.1
by Aaron Bentley
Initial import of lp_submit command. |
36 |
|
37 |
||
5184.1.1
by Vincent Ladeuil
Random cleanups to catch up with copyright updates in trunk. |
38 |
class ProposeMergeHooks(hooks.Hooks): |
4969.2.19
by Aaron Bentley
Rename submit to propose everywhere. |
39 |
"""Hooks for proposing a merge on Launchpad."""
|
4969.2.6
by Aaron Bentley
Add a hook point for getting the prerequisite branch, and make the pipeline |
40 |
|
5622.3.10
by Jelmer Vernooij
Don't require arguments to hooks. |
41 |
def __init__(self): |
42 |
hooks.Hooks.__init__(self, "bzrlib.plugins.launchpad.lp_propose", |
|
43 |
"Proposer.hooks") |
|
5622.3.2
by Jelmer Vernooij
Add more lazily usable hook points. |
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)) |
|
4969.2.6
by Aaron Bentley
Add a hook point for getting the prerequisite branch, and make the pipeline |
48 |
|
49 |
||
4969.2.19
by Aaron Bentley
Rename submit to propose everywhere. |
50 |
class Proposer(object): |
4969.2.1
by Aaron Bentley
Initial import of lp_submit command. |
51 |
|
5622.3.10
by Jelmer Vernooij
Don't require arguments to hooks. |
52 |
hooks = ProposeMergeHooks() |
4969.2.6
by Aaron Bentley
Add a hook point for getting the prerequisite branch, and make the pipeline |
53 |
|
54 |
def __init__(self, tree, source_branch, target_branch, message, reviews, |
|
6468.4.2
by Ross Lagerwall
Use --fixes instead of --link-bug for consistency with bzr commit. |
55 |
staging=False, approve=False, fixes=None): |
4969.2.10
by Aaron Bentley
Cleanup and docs. |
56 |
"""Constructor.
|
57 |
||
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
|
|
64 |
production.
|
|
5244.1.3
by Robert Collins
Allow setting new proposals as approved immediately. |
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
|
|
68 |
branches).
|
|
4969.2.10
by Aaron Bentley
Cleanup and docs. |
69 |
"""
|
4969.2.1
by Aaron Bentley
Initial import of lp_submit command. |
70 |
self.tree = tree |
4969.2.4
by Aaron Bentley
Remove the staging instance variable and the lp() function. Just make a |
71 |
if staging: |
4969.2.7
by Aaron Bentley
Add lp-submit, get working. |
72 |
lp_instance = 'staging' |
4969.2.4
by Aaron Bentley
Remove the staging instance variable and the lp() function. Just make a |
73 |
else: |
5050.45.15
by Vincent Ladeuil
Fix mode edge.lp.net references in the lp plugin and check-newsbugs. |
74 |
lp_instance = 'production' |
4969.2.7
by Aaron Bentley
Add lp-submit, get working. |
75 |
service = lp_registration.LaunchpadService(lp_instance=lp_instance) |
76 |
self.launchpad = lp_api.login(service) |
|
4969.2.3
by Aaron Bentley
Move LaunchpadBranch to lp_api. Change the interface so that it uses launchpad |
77 |
self.source_branch = lp_api.LaunchpadBranch.from_bzr( |
4969.2.7
by Aaron Bentley
Add lp-submit, get working. |
78 |
self.launchpad, source_branch) |
4969.2.1
by Aaron Bentley
Initial import of lp_submit command. |
79 |
if target_branch is None: |
5616.1.1
by Jelmer Vernooij
Support 'bzr lp-propose' without an explicit target branch for packaging branches. |
80 |
self.target_branch = self.source_branch.get_target() |
4969.2.1
by Aaron Bentley
Initial import of lp_submit command. |
81 |
else: |
4969.2.3
by Aaron Bentley
Move LaunchpadBranch to lp_api. Change the interface so that it uses launchpad |
82 |
self.target_branch = lp_api.LaunchpadBranch.from_bzr( |
4969.2.7
by Aaron Bentley
Add lp-submit, get working. |
83 |
self.launchpad, target_branch) |
4969.2.1
by Aaron Bentley
Initial import of lp_submit command. |
84 |
self.commit_message = message |
5244.1.2
by Robert Collins
Refactor to make calling the webservice cleaner. |
85 |
# XXX: this is where bug lp:583638 could be tackled.
|
4969.2.1
by Aaron Bentley
Initial import of lp_submit command. |
86 |
if reviews == []: |
5616.5.2
by Jelmer Vernooij
Fix typo. |
87 |
self.reviews = [] |
4969.2.1
by Aaron Bentley
Initial import of lp_submit command. |
88 |
else: |
4969.2.4
by Aaron Bentley
Remove the staging instance variable and the lp() function. Just make a |
89 |
self.reviews = [(self.launchpad.people[reviewer], review_type) |
4969.2.1
by Aaron Bentley
Initial import of lp_submit command. |
90 |
for reviewer, review_type in |
91 |
reviews] |
|
5244.1.3
by Robert Collins
Allow setting new proposals as approved immediately. |
92 |
self.approve = approve |
6468.4.2
by Ross Lagerwall
Use --fixes instead of --link-bug for consistency with bzr commit. |
93 |
self.fixes = fixes |
4969.2.1
by Aaron Bentley
Initial import of lp_submit command. |
94 |
|
95 |
def get_comment(self, prerequisite_branch): |
|
4969.2.10
by Aaron Bentley
Cleanup and docs. |
96 |
"""Determine the initial comment for the merge proposal."""
|
6603.4.1
by Shawn Wang
use initial_comment as commit_message for lp_propose |
97 |
if self.commit_message is not None: |
98 |
return self.commit_message.strip().encode('utf-8') |
|
4969.2.1
by Aaron Bentley
Initial import of lp_submit command. |
99 |
info = ["Source: %s\n" % self.source_branch.lp.bzr_identity] |
100 |
info.append("Target: %s\n" % self.target_branch.lp.bzr_identity) |
|
101 |
if prerequisite_branch is not None: |
|
102 |
info.append("Prereq: %s\n" % prerequisite_branch.lp.bzr_identity) |
|
103 |
for rdata in self.reviews: |
|
104 |
uniquename = "%s (%s)" % (rdata[0].display_name, rdata[0].name) |
|
105 |
info.append('Reviewer: %s, type "%s"\n' % (uniquename, rdata[1])) |
|
106 |
self.source_branch.bzr.lock_read() |
|
107 |
try: |
|
108 |
self.target_branch.bzr.lock_read() |
|
109 |
try: |
|
4969.2.13
by Aaron Bentley
Get working with lpreview_body. |
110 |
body = self.get_initial_body() |
4969.2.1
by Aaron Bentley
Initial import of lp_submit command. |
111 |
finally: |
112 |
self.target_branch.bzr.unlock() |
|
113 |
finally: |
|
114 |
self.source_branch.bzr.unlock() |
|
115 |
initial_comment = msgeditor.edit_commit_message(''.join(info), |
|
116 |
start_message=body) |
|
117 |
return initial_comment.strip().encode('utf-8') |
|
118 |
||
4969.2.13
by Aaron Bentley
Get working with lpreview_body. |
119 |
def get_initial_body(self): |
4969.2.15
by Aaron Bentley
Update docs. |
120 |
"""Get a body for the proposal for the user to modify.
|
121 |
||
122 |
:return: a str or None.
|
|
123 |
"""
|
|
4969.2.1
by Aaron Bentley
Initial import of lp_submit command. |
124 |
def list_modified_files(): |
125 |
lca_tree = self.source_branch.find_lca_tree( |
|
126 |
self.target_branch) |
|
127 |
source_tree = self.source_branch.bzr.basis_tree() |
|
128 |
files = modified_files(lca_tree, source_tree) |
|
129 |
return list(files) |
|
130 |
target_loc = ('bzr+ssh://bazaar.launchpad.net/%s' % |
|
131 |
self.target_branch.lp.unique_name) |
|
4969.2.9
by Aaron Bentley
Add a hook for getting an initial merge proposal body. |
132 |
body = None |
133 |
for hook in self.hooks['merge_proposal_body']: |
|
134 |
body = hook({ |
|
135 |
'tree': self.tree, |
|
136 |
'target_branch': target_loc, |
|
137 |
'modified_files_callback': list_modified_files, |
|
138 |
'old_body': body, |
|
139 |
})
|
|
4969.2.13
by Aaron Bentley
Get working with lpreview_body. |
140 |
return body |
4969.2.1
by Aaron Bentley
Initial import of lp_submit command. |
141 |
|
6570.1.2
by Jonathan Lange
Set the approved revision to tip. |
142 |
def get_source_revid(self): |
143 |
"""Get the revision ID of the source branch."""
|
|
144 |
source_branch = self.source_branch.bzr |
|
145 |
source_branch.lock_read() |
|
146 |
try: |
|
147 |
return source_branch.last_revision() |
|
148 |
finally: |
|
149 |
source_branch.unlock() |
|
150 |
||
4969.2.19
by Aaron Bentley
Rename submit to propose everywhere. |
151 |
def check_proposal(self): |
4969.2.10
by Aaron Bentley
Cleanup and docs. |
152 |
"""Check that the submission is sensible."""
|
4969.2.1
by Aaron Bentley
Initial import of lp_submit command. |
153 |
if self.source_branch.lp.self_link == self.target_branch.lp.self_link: |
154 |
raise errors.BzrCommandError( |
|
155 |
'Source and target branches must be different.') |
|
156 |
for mp in self.source_branch.lp.landing_targets: |
|
157 |
if mp.queue_status in ('Merged', 'Rejected'): |
|
158 |
continue
|
|
159 |
if mp.target_branch.self_link == self.target_branch.lp.self_link: |
|
6150.3.1
by Jonathan Riddell
gettext() in launchpad plugin |
160 |
raise errors.BzrCommandError(gettext( |
161 |
'There is already a branch merge proposal: %s') % |
|
5615.1.1
by Jelmer Vernooij
Lazy load a couple of modules in bzrlib.plugins.launchpad.lp_propose. |
162 |
lp_api.canonical_url(mp)) |
4969.2.1
by Aaron Bentley
Initial import of lp_submit command. |
163 |
|
4969.2.6
by Aaron Bentley
Add a hook point for getting the prerequisite branch, and make the pipeline |
164 |
def _get_prerequisite_branch(self): |
4969.2.7
by Aaron Bentley
Add lp-submit, get working. |
165 |
hooks = self.hooks['get_prerequisite'] |
4969.2.6
by Aaron Bentley
Add a hook point for getting the prerequisite branch, and make the pipeline |
166 |
prerequisite_branch = None |
167 |
for hook in hooks: |
|
168 |
prerequisite_branch = hook( |
|
169 |
{'launchpad': self.launchpad, |
|
4969.2.7
by Aaron Bentley
Add lp-submit, get working. |
170 |
'source_branch': self.source_branch, |
171 |
'target_branch': self.target_branch, |
|
4969.2.6
by Aaron Bentley
Add a hook point for getting the prerequisite branch, and make the pipeline |
172 |
'prerequisite_branch': prerequisite_branch}) |
173 |
return prerequisite_branch |
|
174 |
||
5244.1.2
by Robert Collins
Refactor to make calling the webservice cleaner. |
175 |
def call_webservice(self, call, *args, **kwargs): |
176 |
"""Make a call to the webservice, wrapping failures.
|
|
177 |
|
|
178 |
:param call: The call to make.
|
|
179 |
:param *args: *args for the call.
|
|
180 |
:param **kwargs: **kwargs for the call.
|
|
181 |
:return: The result of calling call(*args, *kwargs).
|
|
182 |
"""
|
|
5615.1.1
by Jelmer Vernooij
Lazy load a couple of modules in bzrlib.plugins.launchpad.lp_propose. |
183 |
from lazr.restfulclient import errors as restful_errors |
5244.1.2
by Robert Collins
Refactor to make calling the webservice cleaner. |
184 |
try: |
185 |
return call(*args, **kwargs) |
|
186 |
except restful_errors.HTTPError, e: |
|
187 |
error_lines = [] |
|
188 |
for line in e.content.splitlines(): |
|
189 |
if line.startswith('Traceback (most recent call last):'): |
|
190 |
break
|
|
191 |
error_lines.append(line) |
|
192 |
raise Exception(''.join(error_lines)) |
|
193 |
||
6570.1.1
by Jonathan Lange
Factor out approve code. |
194 |
def approve_proposal(self, mp): |
6570.1.2
by Jonathan Lange
Set the approved revision to tip. |
195 |
revid = self.get_source_revid() |
6570.1.4
by Jonathan Lange
Vote for approve when we approve. |
196 |
self.call_webservice( |
197 |
mp.createComment, |
|
198 |
vote=u'Approve', |
|
6570.1.5
by Jonathan Lange
Use the default subject |
199 |
subject='', # Use the default subject. |
200 |
content=u"Rubberstamp! Proposer approves of own proposal.") |
|
6570.1.4
by Jonathan Lange
Vote for approve when we approve. |
201 |
self.call_webservice(mp.setStatus, status=u'Approved', revid=revid) |
6570.1.1
by Jonathan Lange
Factor out approve code. |
202 |
|
4969.2.19
by Aaron Bentley
Rename submit to propose everywhere. |
203 |
def create_proposal(self): |
4969.2.10
by Aaron Bentley
Cleanup and docs. |
204 |
"""Perform the submission."""
|
4969.2.6
by Aaron Bentley
Add a hook point for getting the prerequisite branch, and make the pipeline |
205 |
prerequisite_branch = self._get_prerequisite_branch() |
4969.2.1
by Aaron Bentley
Initial import of lp_submit command. |
206 |
if prerequisite_branch is None: |
207 |
prereq = None |
|
208 |
else: |
|
209 |
prereq = prerequisite_branch.lp |
|
4969.2.14
by Aaron Bentley
Restore update functionality. |
210 |
prerequisite_branch.update_lp() |
211 |
self.source_branch.update_lp() |
|
4969.2.1
by Aaron Bentley
Initial import of lp_submit command. |
212 |
reviewers = [] |
213 |
review_types = [] |
|
214 |
for reviewer, review_type in self.reviews: |
|
215 |
review_types.append(review_type) |
|
216 |
reviewers.append(reviewer.self_link) |
|
217 |
initial_comment = self.get_comment(prerequisite_branch) |
|
5244.1.2
by Robert Collins
Refactor to make calling the webservice cleaner. |
218 |
mp = self.call_webservice( |
219 |
self.source_branch.lp.createMergeProposal, |
|
220 |
target_branch=self.target_branch.lp, |
|
221 |
prerequisite_branch=prereq, |
|
222 |
initial_comment=initial_comment, |
|
223 |
commit_message=self.commit_message, reviewers=reviewers, |
|
224 |
review_types=review_types) |
|
5244.1.3
by Robert Collins
Allow setting new proposals as approved immediately. |
225 |
if self.approve: |
6570.1.1
by Jonathan Lange
Factor out approve code. |
226 |
self.approve_proposal(mp) |
6468.4.2
by Ross Lagerwall
Use --fixes instead of --link-bug for consistency with bzr commit. |
227 |
if self.fixes: |
6468.4.3
by Ross Lagerwall
Allow the --fixes argument to start with 'lp:' for consistency with bzr commit. |
228 |
if self.fixes.startswith('lp:'): |
229 |
self.fixes = self.fixes[3:] |
|
6468.4.1
by Ross Lagerwall
Add '--link-bug' option to lp-propose-merge. |
230 |
self.call_webservice( |
231 |
self.source_branch.lp.linkBug, |
|
6468.4.2
by Ross Lagerwall
Use --fixes instead of --link-bug for consistency with bzr commit. |
232 |
bug=self.launchpad.bugs[int(self.fixes)]) |
5615.1.1
by Jelmer Vernooij
Lazy load a couple of modules in bzrlib.plugins.launchpad.lp_propose. |
233 |
webbrowser.open(lp_api.canonical_url(mp)) |
4969.2.1
by Aaron Bentley
Initial import of lp_submit command. |
234 |
|
4969.2.6
by Aaron Bentley
Add a hook point for getting the prerequisite branch, and make the pipeline |
235 |
|
4969.2.13
by Aaron Bentley
Get working with lpreview_body. |
236 |
def modified_files(old_tree, new_tree): |
4969.2.15
by Aaron Bentley
Update docs. |
237 |
"""Return a list of paths in the new tree with modified contents."""
|
4969.2.13
by Aaron Bentley
Get working with lpreview_body. |
238 |
for f, (op, path), c, v, p, n, (ok, k), e in new_tree.iter_changes( |
239 |
old_tree): |
|
240 |
if c and k == 'file': |
|
241 |
yield str(path) |