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 (
40
class cmd_launchpad_open(Command):
41
__doc__ = """Open a Launchpad branch page in your web browser."""
46
'Do not actually open the browser. Just say the URL we would '
49
takes_args = ['location?']
51
def _possible_locations(self, location):
52
"""Yield possible external locations for the branch at 'location'."""
55
branch = _mod_branch.Branch.open_containing(location)[0]
56
except NotBranchError:
58
branch_url = branch.get_public_branch()
59
if branch_url is not None:
61
branch_url = branch.get_push_location()
62
if branch_url is not None:
65
def _get_web_url(self, service, location):
66
from .lp_registration import (
69
for branch_url in self._possible_locations(location):
71
return service.get_web_url_from_branch_url(branch_url)
72
except (NotLaunchpadBranch, InvalidURL):
74
raise NotLaunchpadBranch(branch_url)
76
def run(self, location=None, dry_run=False):
77
from .lp_registration import (
81
web_url = self._get_web_url(LaunchpadService(), location)
82
trace.note(gettext('Opening %s in web browser') % web_url)
84
import webbrowser # this import should not be lazy
85
# otherwise brz.exe lacks this module
86
webbrowser.open(web_url)
89
class cmd_launchpad_login(Command):
90
__doc__ = """Show or set the Launchpad user ID.
92
When communicating with Launchpad, some commands need to know your
93
Launchpad user ID. This command can be used to set or show the
94
user ID that Bazaar will use for such communication.
97
Show the Launchpad ID of the current user::
101
Set the Launchpad ID of the current user to 'bob'::
103
brz launchpad-login bob
105
aliases = ['lp-login']
106
takes_args = ['name?']
110
"Don't check that the user name is valid."),
113
def run(self, name=None, no_check=False, verbose=False):
114
# This is totally separate from any launchpadlib login system.
115
from . import account
116
check_account = not no_check
119
username = account.get_lp_login()
122
account.check_lp_login(username)
124
self.outf.write(gettext(
125
"Launchpad user ID exists and has SSH keys.\n"))
126
self.outf.write(username + '\n')
128
self.outf.write(gettext('No Launchpad user ID configured.\n'))
133
account.check_lp_login(name)
135
self.outf.write(gettext(
136
"Launchpad user ID exists and has SSH keys.\n"))
137
account.set_lp_login(name)
139
self.outf.write(gettext("Launchpad user ID set to '%s'.\n") %
143
class cmd_launchpad_logout(Command):
144
__doc__ = """Unset the Launchpad user ID.
146
When communicating with Launchpad, some commands need to know your
147
Launchpad user ID. This command will log you out from Launchpad.
148
This means that communication with Launchpad will happen over
149
HTTPS, and will not require one of your SSH keys to be available.
151
aliases = ['lp-logout']
152
takes_options = ['verbose']
154
def run(self, verbose=False):
155
from . import account
156
old_username = account.get_lp_login()
157
if old_username is None:
158
self.outf.write(gettext('Not logged into Launchpad.\n'))
160
account.set_lp_login(None)
162
self.outf.write(gettext(
163
"Launchpad user ID %s logged out.\n") %
167
class cmd_lp_propose_merge(Command):
168
__doc__ = """Propose merging a branch on Launchpad.
170
This will open your usual editor to provide the initial comment. When it
171
has created the proposal, it will open it in your default web browser.
173
The branch will be proposed to merge into SUBMIT_BRANCH. If SUBMIT_BRANCH
174
is not supplied, the remembered submit branch will be used. If no submit
175
branch is remembered, the development focus will be used.
177
By default, the SUBMIT_BRANCH's review team will be requested to review
178
the merge proposal. This can be overriden by specifying --review (-R).
179
The parameter the launchpad account name of the desired reviewer. This
180
may optionally be followed by '=' and the review type. For example:
182
brz lp-propose-merge --review jrandom --review review-team=qa
184
This will propose a merge, request "jrandom" to perform a review of
185
unspecified type, and request "review-team" to perform a "qa" review.
189
takes_options = [Option('staging',
190
help='Propose the merge on staging.'),
191
Option('message', short_name='m', type=str,
192
help='Commit message.'),
194
help=('Mark the proposal as approved immediately, '
195
'setting the approved revision to tip.')),
196
Option('fixes', 'The bug this proposal fixes.', str),
197
ListOption('review', short_name='R', type=str,
198
help='Requested reviewer and optional type.')]
200
takes_args = ['submit_branch?']
202
aliases = ['lp-submit', 'lp-propose']
204
def run(self, submit_branch=None, review=None, staging=False,
205
message=None, approve=False, fixes=None):
206
from . import lp_propose
207
tree, branch, relpath = controldir.ControlDir.open_containing_tree_or_branch(
213
for review in review:
215
reviews.append(review.split('=', 2))
217
reviews.append((review, ''))
218
if submit_branch is None:
219
submit_branch = branch.get_submit_branch()
220
if submit_branch is None:
223
target = _mod_branch.Branch.open(submit_branch)
224
proposer = lp_propose.Proposer(tree, branch, target, message,
225
reviews, staging, approve=approve,
227
proposer.check_proposal()
228
proposer.create_proposal()
231
class cmd_lp_find_proposal(Command):
233
__doc__ = """Find the proposal to merge this revision.
235
Finds the merge proposal(s) that discussed landing the specified revision.
236
This works only if the if the merged_revno was recorded for the merge
237
proposal. The proposal(s) are opened in a web browser.
239
Only the revision specified is searched for. To find the mainline
240
revision that merged it into mainline, use the "mainline" revision spec.
242
So, to find the merge proposal that reviewed line 1 of README::
244
brz lp-find-proposal -r mainline:annotate:README:1
247
takes_options = ['revision']
249
def run(self, revision=None):
253
b = _mod_branch.Branch.open_containing('.')[0]
254
with ui.ui_factory.nested_progress_bar() as pb, b.lock_read():
256
revision_id = b.last_revision()
258
revision_id = revision[0].as_revision_id(b)
259
merged = self._find_proposals(revision_id, pb)
261
raise BzrCommandError(gettext('No review found.'))
262
trace.note(gettext('%d proposals(s) found.') % len(merged))
264
webbrowser.open(lp_api.canonical_url(mp))
266
def _find_proposals(self, revision_id, pb):
267
from launchpadlib import uris
269
# "devel" because branches.getMergeProposals is not part of 1.0 API.
270
lp_base_url = uris.LPNET_SERVICE_ROOT
271
launchpad = lp_api.connect_launchpad(lp_base_url, version='devel')
272
pb.update(gettext('Finding proposals'))
273
return list(launchpad.branches.getMergeProposals(
274
merged_revision=revision_id.decode('utf-8')))