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
class cmd_lp_propose_merge(Command):
171
__doc__ = """Propose merging a branch on Launchpad.
173
This will open your usual editor to provide the initial comment. When it
174
has created the proposal, it will open it in your default web browser.
176
The branch will be proposed to merge into SUBMIT_BRANCH. If SUBMIT_BRANCH
177
is not supplied, the remembered submit branch will be used. If no submit
178
branch is remembered, the development focus will be used.
180
By default, the SUBMIT_BRANCH's review team will be requested to review
181
the merge proposal. This can be overriden by specifying --review (-R).
182
The parameter the launchpad account name of the desired reviewer. This
183
may optionally be followed by '=' and the review type. For example:
185
brz lp-propose-merge --review jrandom --review review-team=qa
187
This will propose a merge, request "jrandom" to perform a review of
188
unspecified type, and request "review-team" to perform a "qa" review.
192
takes_options = [Option('staging',
193
help='Propose the merge on staging.'),
194
Option('message', short_name='m', type=text_type,
195
help='Commit message.'),
197
help=('Mark the proposal as approved immediately, '
198
'setting the approved revision to tip.')),
199
Option('fixes', 'The bug this proposal fixes.', str),
200
ListOption('review', short_name='R', type=text_type,
201
help='Requested reviewer and optional type.')]
203
takes_args = ['submit_branch?']
205
aliases = ['lp-submit', 'lp-propose']
207
def run(self, submit_branch=None, review=None, staging=False,
208
message=None, approve=False, fixes=None):
209
from . import lp_propose
210
tree, branch, relpath = controldir.ControlDir.open_containing_tree_or_branch(
216
for review in review:
218
reviews.append(review.split('=', 2))
220
reviews.append((review, ''))
221
if submit_branch is None:
222
submit_branch = branch.get_submit_branch()
223
if submit_branch is None:
226
target = _mod_branch.Branch.open(submit_branch)
227
proposer = lp_propose.Proposer(tree, branch, target, message,
228
reviews, staging, approve=approve,
230
proposer.check_proposal()
231
proposer.create_proposal()
234
class cmd_lp_find_proposal(Command):
236
__doc__ = """Find the proposal to merge this revision.
238
Finds the merge proposal(s) that discussed landing the specified revision.
239
This works only if the if the merged_revno was recorded for the merge
240
proposal. The proposal(s) are opened in a web browser.
242
Only the revision specified is searched for. To find the mainline
243
revision that merged it into mainline, use the "mainline" revision spec.
245
So, to find the merge proposal that reviewed line 1 of README::
247
brz lp-find-proposal -r mainline:annotate:README:1
250
takes_options = ['revision']
252
def run(self, revision=None):
256
b = _mod_branch.Branch.open_containing('.')[0]
257
with ui.ui_factory.nested_progress_bar() as pb, b.lock_read():
259
revision_id = b.last_revision()
261
revision_id = revision[0].as_revision_id(b)
262
merged = self._find_proposals(revision_id, pb)
264
raise BzrCommandError(gettext('No review found.'))
265
trace.note(gettext('%d proposals(s) found.') % len(merged))
267
webbrowser.open(lp_api.canonical_url(mp))
269
def _find_proposals(self, revision_id, pb):
270
from launchpadlib import uris
272
# "devel" because branches.getMergeProposals is not part of 1.0 API.
273
lp_base_url = uris.LPNET_SERVICE_ROOT
274
launchpad = lp_api.connect_launchpad(lp_base_url, version='devel')
275
pb.update(gettext('Finding proposals'))
276
return list(launchpad.branches.getMergeProposals(
277
merged_revision=revision_id.decode('utf-8')))