1
# Copyright (C) 2006-2017 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
"""Launchpad plugin commands."""
19
from __future__ import absolute_import
22
branch as _mod_branch,
26
from ...commands import (
29
from ...errors import (
33
from ...i18n import gettext
34
from ...option import (
38
from ...sixish import (
43
class cmd_launchpad_open(Command):
44
__doc__ = """Open a Launchpad branch page in your web browser."""
49
'Do not actually open the browser. Just say the URL we would '
52
takes_args = ['location?']
54
def _possible_locations(self, location):
55
"""Yield possible external locations for the branch at 'location'."""
58
branch = _mod_branch.Branch.open_containing(location)[0]
59
except NotBranchError:
61
branch_url = branch.get_public_branch()
62
if branch_url is not None:
64
branch_url = branch.get_push_location()
65
if branch_url is not None:
68
def _get_web_url(self, service, location):
69
from .lp_registration import (
72
for branch_url in self._possible_locations(location):
74
return service.get_web_url_from_branch_url(branch_url)
75
except (NotLaunchpadBranch, InvalidURL):
77
raise NotLaunchpadBranch(branch_url)
79
def run(self, location=None, dry_run=False):
80
from .lp_registration import (
84
web_url = self._get_web_url(LaunchpadService(), location)
85
trace.note(gettext('Opening %s in web browser') % web_url)
87
import webbrowser # this import should not be lazy
88
# otherwise brz.exe lacks this module
89
webbrowser.open(web_url)
92
class cmd_launchpad_login(Command):
93
__doc__ = """Show or set the Launchpad user ID.
95
When communicating with Launchpad, some commands need to know your
96
Launchpad user ID. This command can be used to set or show the
97
user ID that Bazaar will use for such communication.
100
Show the Launchpad ID of the current user::
104
Set the Launchpad ID of the current user to 'bob'::
106
brz launchpad-login bob
108
aliases = ['lp-login']
109
takes_args = ['name?']
113
"Don't check that the user name is valid."),
116
def run(self, name=None, no_check=False, verbose=False):
117
# This is totally separate from any launchpadlib login system.
118
from . import account
119
check_account = not no_check
122
username = account.get_lp_login()
125
account.check_lp_login(username)
127
self.outf.write(gettext(
128
"Launchpad user ID exists and has SSH keys.\n"))
129
self.outf.write(username + '\n')
131
self.outf.write(gettext('No Launchpad user ID configured.\n'))
136
account.check_lp_login(name)
138
self.outf.write(gettext(
139
"Launchpad user ID exists and has SSH keys.\n"))
140
account.set_lp_login(name)
142
self.outf.write(gettext("Launchpad user ID set to '%s'.\n") %
146
class cmd_launchpad_logout(Command):
147
__doc__ = """Unset the Launchpad user ID.
149
When communicating with Launchpad, some commands need to know your
150
Launchpad user ID. This command will log you out from Launchpad.
151
This means that communication with Launchpad will happen over
152
HTTPS, and will not require one of your SSH keys to be available.
154
aliases = ['lp-logout']
155
takes_options = ['verbose']
157
def run(self, verbose=False):
158
from . import account
159
old_username = account.get_lp_login()
160
if old_username is None:
161
self.outf.write(gettext('Not logged into Launchpad.\n'))
163
account.set_lp_login(None)
165
self.outf.write(gettext(
166
"Launchpad user ID %s logged out.\n") %
170
# XXX: cmd_launchpad_mirror is untested
171
class cmd_launchpad_mirror(Command):
172
__doc__ = """Ask Launchpad to mirror a branch now."""
174
aliases = ['lp-mirror']
175
takes_args = ['location?']
177
def run(self, location='.'):
179
from .lp_registration import LaunchpadService
180
branch, _ = _mod_branch.Branch.open_containing(location)
181
service = LaunchpadService()
182
launchpad = lp_api.login(service)
183
lp_branch = lp_api.LaunchpadBranch.from_bzr(launchpad, branch,
184
create_missing=False)
185
lp_branch.lp.requestMirror()
188
class cmd_lp_propose_merge(Command):
189
__doc__ = """Propose merging a branch on Launchpad.
191
This will open your usual editor to provide the initial comment. When it
192
has created the proposal, it will open it in your default web browser.
194
The branch will be proposed to merge into SUBMIT_BRANCH. If SUBMIT_BRANCH
195
is not supplied, the remembered submit branch will be used. If no submit
196
branch is remembered, the development focus will be used.
198
By default, the SUBMIT_BRANCH's review team will be requested to review
199
the merge proposal. This can be overriden by specifying --review (-R).
200
The parameter the launchpad account name of the desired reviewer. This
201
may optionally be followed by '=' and the review type. For example:
203
brz lp-propose-merge --review jrandom --review review-team=qa
205
This will propose a merge, request "jrandom" to perform a review of
206
unspecified type, and request "review-team" to perform a "qa" review.
209
takes_options = [Option('staging',
210
help='Propose the merge on staging.'),
211
Option('message', short_name='m', type=text_type,
212
help='Commit message.'),
214
help=('Mark the proposal as approved immediately, '
215
'setting the approved revision to tip.')),
216
Option('fixes', 'The bug this proposal fixes.', str),
217
ListOption('review', short_name='R', type=text_type,
218
help='Requested reviewer and optional type.')]
220
takes_args = ['submit_branch?']
222
aliases = ['lp-submit', 'lp-propose']
224
def run(self, submit_branch=None, review=None, staging=False,
225
message=None, approve=False, fixes=None):
226
from . import lp_propose
227
tree, branch, relpath = controldir.ControlDir.open_containing_tree_or_branch(
233
for review in review:
235
reviews.append(review.split('=', 2))
237
reviews.append((review, ''))
238
if submit_branch is None:
239
submit_branch = branch.get_submit_branch()
240
if submit_branch is None:
243
target = _mod_branch.Branch.open(submit_branch)
244
proposer = lp_propose.Proposer(tree, branch, target, message,
245
reviews, staging, approve=approve,
247
proposer.check_proposal()
248
proposer.create_proposal()
251
class cmd_lp_find_proposal(Command):
253
__doc__ = """Find the proposal to merge this revision.
255
Finds the merge proposal(s) that discussed landing the specified revision.
256
This works only if the if the merged_revno was recorded for the merge
257
proposal. The proposal(s) are opened in a web browser.
259
Only the revision specified is searched for. To find the mainline
260
revision that merged it into mainline, use the "mainline" revision spec.
262
So, to find the merge proposal that reviewed line 1 of README::
264
brz lp-find-proposal -r mainline:annotate:README:1
267
takes_options = ['revision']
269
def run(self, revision=None):
273
b = _mod_branch.Branch.open_containing('.')[0]
274
with ui.ui_factory.nested_progress_bar() as pb, b.lock_read():
276
revision_id = b.last_revision()
278
revision_id = revision[0].as_revision_id(b)
279
merged = self._find_proposals(revision_id, pb)
281
raise BzrCommandError(gettext('No review found.'))
282
trace.note(gettext('%d proposals(s) found.') % len(merged))
284
webbrowser.open(lp_api.canonical_url(mp))
286
def _find_proposals(self, revision_id, pb):
287
from . import (lp_api, lp_registration)
288
# "devel" because branches.getMergeProposals is not part of 1.0 API.
289
launchpad = lp_api.login(lp_registration.LaunchpadService(),
291
pb.update(gettext('Finding proposals'))
292
return list(launchpad.branches.getMergeProposals(
293
merged_revision=revision_id))