1
# Copyright (C) 2010, 2011 Canonical Ltd
2
# Copyright (C) 2018 Breezy Developers
4
# This program is free software; you can redistribute it and/or modify
5
# it under the terms of the GNU General Public License as published by
6
# the Free Software Foundation; either version 2 of the License, or
7
# (at your option) any later version.
9
# This program is distributed in the hope that it will be useful,
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
# GNU General Public License for more details.
14
# You should have received a copy of the GNU General Public License
15
# along with this program; if not, write to the Free Software
16
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
"""Support for Launchpad."""
20
from __future__ import absolute_import
24
from .propose import (
34
branch as _mod_branch,
40
from ...git.refs import ref_to_branch_name
41
from ...lazy_import import lazy_import
42
lazy_import(globals(), """
43
from breezy.plugins.launchpad import (
47
from launchpadlib import uris
49
from ...transport import get_transport
52
# TODO(jelmer): Make selection of launchpad staging a configuration option.
54
def status_to_lp_mp_statuses(status):
56
if status in ('open', 'all'):
61
'Code failed to merge',
63
if status in ('closed', 'all'):
64
statuses.extend(['Rejected', 'Superseded'])
65
if status in ('merged', 'all'):
66
statuses.append('Merged')
70
def plausible_launchpad_url(url):
73
if url.startswith('lp:'):
75
regex = re.compile('([a-z]*\+)*(bzr\+ssh|http|ssh|git|https)'
76
'://(bazaar|git).*.launchpad.net')
77
return bool(regex.match(url))
80
class WebserviceFailure(Exception):
82
def __init__(self, message):
83
self.message = message
86
def _call_webservice(call, *args, **kwargs):
87
"""Make a call to the webservice, wrapping failures.
89
:param call: The call to make.
90
:param *args: *args for the call.
91
:param **kwargs: **kwargs for the call.
92
:return: The result of calling call(*args, *kwargs).
94
from lazr.restfulclient import errors as restful_errors
96
return call(*args, **kwargs)
97
except restful_errors.HTTPError as e:
99
for line in e.content.splitlines():
100
if line.startswith(b'Traceback (most recent call last):'):
102
error_lines.append(line)
103
raise WebserviceFailure(b''.join(error_lines))
106
class LaunchpadMergeProposal(MergeProposal):
108
def __init__(self, mp):
111
def get_source_branch_url(self):
112
if self._mp.source_branch:
113
return self._mp.source_branch.bzr_identity
115
branch_name = ref_to_branch_name(
116
self._mp.source_git_path.encode('utf-8'))
117
return urlutils.join_segment_parameters(
118
self._mp.source_git_repository.git_identity,
119
{"branch": branch_name})
121
def get_target_branch_url(self):
122
if self._mp.target_branch:
123
return self._mp.target_branch.bzr_identity
125
branch_name = ref_to_branch_name(
126
self._mp.target_git_path.encode('utf-8'))
127
return urlutils.join_segment_parameters(
128
self._mp.target_git_repository.git_identity,
129
{"branch": branch_name})
133
return lp_api.canonical_url(self._mp)
136
return (self._mp.queue_status == 'Merged')
138
def get_description(self):
139
return self._mp.description
141
def set_description(self, description):
142
self._mp.description = description
146
self._mp.setStatus(status='Rejected')
149
class Launchpad(Hoster):
150
"""The Launchpad hosting service."""
154
# https://bugs.launchpad.net/launchpad/+bug/397676
155
supports_merge_proposal_labels = False
157
def __init__(self, staging=False):
158
self._staging = staging
160
lp_base_url = uris.STAGING_SERVICE_ROOT
162
lp_base_url = uris.LPNET_SERVICE_ROOT
163
self.launchpad = lp_api.connect_launchpad(lp_base_url)
167
return lp_api.uris.web_root_for_service_root(
168
str(self.launchpad._root_uri))
171
return "Launchpad(staging=%s)" % self._staging
173
def hosts(self, branch):
174
# TODO(jelmer): staging vs non-staging?
175
return plausible_launchpad_url(branch.user_url)
178
def probe_from_url(cls, url):
179
if plausible_launchpad_url(url):
181
raise UnsupportedHoster(url)
183
def _get_lp_git_ref_from_branch(self, branch):
184
url, params = urlutils.split_segment_parameters(branch.user_url)
185
(scheme, user, password, host, port, path) = urlutils.parse_url(
187
repo_lp = self.launchpad.git_repositories.getByPath(
188
path=path.strip('/'))
190
ref_path = params['ref']
192
branch_name = params.get('branch', branch.name)
194
ref_path = 'refs/heads/%s' % branch_name
196
ref_path = repo_lp.default_branch
197
ref_lp = repo_lp.getRefByPath(path=ref_path)
198
return (repo_lp, ref_lp)
200
def _get_lp_bzr_branch_from_branch(self, branch):
201
return self.launchpad.branches.getByUrl(
202
url=urlutils.unescape(branch.user_url))
204
def _get_derived_git_path(self, base_path, owner, project):
205
base_repo = self.launchpad.git_repositories.getByPath(path=base_path)
207
project = urlutils.parse_url(base_repo.git_ssh_url)[-1].strip('/')
208
if project.startswith('~'):
209
project = '/'.join(base_path.split('/')[1:])
210
# TODO(jelmer): Surely there is a better way of creating one of these
212
return "~%s/%s" % (owner, project)
214
def _publish_git(self, local_branch, base_path, name, owner, project=None,
215
revision_id=None, overwrite=False, allow_lossy=True):
216
to_path = self._get_derived_git_path(base_path, owner, project)
217
to_transport = get_transport("git+ssh://git.launchpad.net/" + to_path)
219
dir_to = controldir.ControlDir.open_from_transport(to_transport)
220
except errors.NotBranchError:
221
# Didn't find anything
226
br_to = local_branch.create_clone_on_transport(
227
to_transport, revision_id=revision_id, name=name)
228
except errors.NoRoundtrippingSupport:
229
br_to = local_branch.create_clone_on_transport(
230
to_transport, revision_id=revision_id, name=name,
234
dir_to = dir_to.push_branch(
235
local_branch, revision_id, overwrite=overwrite, name=name)
236
except errors.NoRoundtrippingSupport:
239
dir_to = dir_to.push_branch(
240
local_branch, revision_id, overwrite=overwrite, name=name,
242
br_to = dir_to.target_branch
244
"https://git.launchpad.net/%s/+ref/%s" % (to_path, name))
246
def _get_derived_bzr_path(self, base_branch, name, owner, project):
248
base_branch_lp = self._get_lp_bzr_branch_from_branch(base_branch)
249
project = '/'.join(base_branch_lp.unique_name.split('/')[1:-1])
250
# TODO(jelmer): Surely there is a better way of creating one of these
252
return "~%s/%s/%s" % (owner, project, name)
254
def get_push_url(self, branch):
255
(vcs, user, password, path, params) = self._split_url(branch.user_url)
257
branch_lp = self._get_lp_bzr_branch_from_branch(branch)
258
return branch_lp.bzr_identity
260
return urlutils.join_segment_parameters(
261
"git+ssh://git.launchpad.net/" + path, params)
265
def _publish_bzr(self, local_branch, base_branch, name, owner,
266
project=None, revision_id=None, overwrite=False,
268
to_path = self._get_derived_bzr_path(base_branch, name, owner, project)
269
to_transport = get_transport("lp:" + to_path)
271
dir_to = controldir.ControlDir.open_from_transport(to_transport)
272
except errors.NotBranchError:
273
# Didn't find anything
277
br_to = local_branch.create_clone_on_transport(
278
to_transport, revision_id=revision_id)
280
br_to = dir_to.push_branch(
281
local_branch, revision_id, overwrite=overwrite).target_branch
282
return br_to, ("https://code.launchpad.net/" + to_path)
284
def _split_url(self, url):
285
url, params = urlutils.split_segment_parameters(url)
286
(scheme, user, password, host, port, path) = urlutils.parse_url(url)
287
path = path.strip('/')
288
if host.startswith('bazaar.'):
290
elif host.startswith('git.'):
293
raise ValueError("unknown host %s" % host)
294
return (vcs, user, password, path, params)
296
def publish_derived(self, local_branch, base_branch, name, project=None,
297
owner=None, revision_id=None, overwrite=False,
299
"""Publish a branch to the site, derived from base_branch.
301
:param base_branch: branch to derive the new branch from
302
:param new_branch: branch to publish
303
:param name: Name of the new branch on the remote host
304
:param project: Optional project name
305
:param owner: Optional owner
306
:return: resulting branch
309
owner = self.launchpad.me.name
310
(base_vcs, base_user, base_password, base_path,
311
base_params) = self._split_url(base_branch.user_url)
312
# TODO(jelmer): Prevent publishing to development focus
313
if base_vcs == 'bzr':
314
return self._publish_bzr(
315
local_branch, base_branch, name, project=project, owner=owner,
316
revision_id=revision_id, overwrite=overwrite,
317
allow_lossy=allow_lossy)
318
elif base_vcs == 'git':
319
return self._publish_git(
320
local_branch, base_path, name, project=project, owner=owner,
321
revision_id=revision_id, overwrite=overwrite,
322
allow_lossy=allow_lossy)
324
raise AssertionError('not a valid Launchpad URL')
326
def get_derived_branch(self, base_branch, name, project=None, owner=None):
328
owner = self.launchpad.me.name
329
(base_vcs, base_user, base_password, base_path,
330
base_params) = self._split_url(base_branch.user_url)
331
if base_vcs == 'bzr':
332
to_path = self._get_derived_bzr_path(
333
base_branch, name, owner, project)
334
return _mod_branch.Branch.open("lp:" + to_path)
335
elif base_vcs == 'git':
336
to_path = self._get_derived_git_path(
337
base_path.strip('/'), owner, project)
338
to_url = urlutils.join_segment_parameters(
339
"git+ssh://git.launchpad.net/" + to_path,
341
return _mod_branch.Branch.open(to_url)
343
raise AssertionError('not a valid Launchpad URL')
345
def iter_proposals(self, source_branch, target_branch, status='open'):
346
(base_vcs, base_user, base_password, base_path,
347
base_params) = self._split_url(target_branch.user_url)
348
statuses = status_to_lp_mp_statuses(status)
349
if base_vcs == 'bzr':
350
target_branch_lp = self.launchpad.branches.getByUrl(
351
url=target_branch.user_url)
352
source_branch_lp = self.launchpad.branches.getByUrl(
353
url=source_branch.user_url)
354
for mp in target_branch_lp.getMergeProposals(status=statuses):
355
if mp.source_branch_link != source_branch_lp.self_link:
357
yield LaunchpadMergeProposal(mp)
358
elif base_vcs == 'git':
359
(source_repo_lp, source_branch_lp) = (
360
self._get_lp_git_ref_from_branch(source_branch))
361
(target_repo_lp, target_branch_lp) = (
362
self._get_lp_git_ref_from_branch(target_branch))
363
for mp in target_branch_lp.getMergeProposals(status=statuses):
364
if (target_branch_lp.path != mp.target_git_path or
365
target_repo_lp != mp.target_git_repository or
366
source_branch_lp.path != mp.source_git_path or
367
source_repo_lp != mp.source_git_repository):
369
yield LaunchpadMergeProposal(mp)
371
raise AssertionError('not a valid Launchpad URL')
373
def get_proposer(self, source_branch, target_branch):
374
(base_vcs, base_user, base_password, base_path,
375
base_params) = self._split_url(target_branch.user_url)
376
if base_vcs == 'bzr':
377
return LaunchpadBazaarMergeProposalBuilder(
378
self, source_branch, target_branch)
379
elif base_vcs == 'git':
380
return LaunchpadGitMergeProposalBuilder(
381
self, source_branch, target_branch)
383
raise AssertionError('not a valid Launchpad URL')
386
def iter_instances(cls):
389
def iter_my_proposals(self, status='open'):
390
statuses = status_to_lp_mp_statuses(status)
391
for mp in self.launchpad.me.getMergeProposals(status=statuses):
392
yield LaunchpadMergeProposal(mp)
395
class LaunchpadBazaarMergeProposalBuilder(MergeProposalBuilder):
397
def __init__(self, lp_host, source_branch, target_branch, message=None,
398
staging=None, approve=None, fixes=None):
401
:param source_branch: The branch to propose for merging.
402
:param target_branch: The branch to merge into.
403
:param message: The commit message to use. (May be None.)
404
:param staging: If True, propose the merge against staging instead of
406
:param approve: If True, mark the new proposal as approved immediately.
407
This is useful when a project permits some things to be approved
408
by the submitter (e.g. merges between release and deployment
411
self.lp_host = lp_host
412
self.launchpad = lp_host.launchpad
413
self.source_branch = source_branch
414
self.source_branch_lp = self.launchpad.branches.getByUrl(
415
url=source_branch.user_url)
416
if target_branch is None:
417
self.target_branch_lp = self.source_branch_lp.get_target()
418
self.target_branch = _mod_branch.Branch.open(
419
self.target_branch_lp.bzr_identity)
421
self.target_branch = target_branch
422
self.target_branch_lp = self.launchpad.branches.getByUrl(
423
url=target_branch.user_url)
424
self.commit_message = message
425
self.approve = approve
428
def get_infotext(self):
429
"""Determine the initial comment for the merge proposal."""
430
if self.commit_message is not None:
431
return self.commit_message.strip().encode('utf-8')
432
info = ["Source: %s\n" % self.source_branch_lp.bzr_identity]
433
info.append("Target: %s\n" % self.target_branch_lp.bzr_identity)
436
def get_initial_body(self):
437
"""Get a body for the proposal for the user to modify.
439
:return: a str or None.
441
if not self.hooks['merge_proposal_body']:
444
def list_modified_files():
445
lca_tree = self.source_branch_lp.find_lca_tree(
446
self.target_branch_lp)
447
source_tree = self.source_branch.basis_tree()
448
files = modified_files(lca_tree, source_tree)
450
with self.target_branch.lock_read(), \
451
self.source_branch.lock_read():
453
for hook in self.hooks['merge_proposal_body']:
455
'target_branch': self.target_branch_lp.bzr_identity,
456
'modified_files_callback': list_modified_files,
461
def check_proposal(self):
462
"""Check that the submission is sensible."""
463
if self.source_branch_lp.self_link == self.target_branch_lp.self_link:
464
raise errors.BzrCommandError(
465
'Source and target branches must be different.')
466
for mp in self.source_branch_lp.landing_targets:
467
if mp.queue_status in ('Merged', 'Rejected'):
469
if mp.target_branch.self_link == self.target_branch_lp.self_link:
470
raise MergeProposalExists(lp_api.canonical_url(mp))
472
def approve_proposal(self, mp):
473
with self.source_branch.lock_read():
477
subject='', # Use the default subject.
478
content=u"Rubberstamp! Proposer approves of own proposal.")
479
_call_webservice(mp.setStatus, status=u'Approved',
480
revid=self.source_branch.last_revision())
482
def create_proposal(self, description, reviewers=None, labels=None,
483
prerequisite_branch=None):
484
"""Perform the submission."""
486
raise LabelsUnsupported()
487
if prerequisite_branch is not None:
488
prereq = self.launchpad.branches.getByUrl(
489
url=prerequisite_branch.user_url)
492
if reviewers is None:
495
mp = _call_webservice(
496
self.source_branch_lp.createMergeProposal,
497
target_branch=self.target_branch_lp,
498
prerequisite_branch=prereq,
499
initial_comment=description.strip(),
500
commit_message=self.commit_message,
501
reviewers=[self.launchpad.people[reviewer].self_link
502
for reviewer in reviewers],
503
review_types=[None for reviewer in reviewers])
504
except WebserviceFailure as e:
506
if (b'There is already a branch merge proposal '
507
b'registered for branch ') in e.message:
508
raise MergeProposalExists(self.source_branch.user_url)
512
self.approve_proposal(mp)
514
if self.fixes.startswith('lp:'):
515
self.fixes = self.fixes[3:]
518
bug=self.launchpad.bugs[int(self.fixes)])
519
return LaunchpadMergeProposal(mp)
522
class LaunchpadGitMergeProposalBuilder(MergeProposalBuilder):
524
def __init__(self, lp_host, source_branch, target_branch, message=None,
525
staging=None, approve=None, fixes=None):
528
:param source_branch: The branch to propose for merging.
529
:param target_branch: The branch to merge into.
530
:param message: The commit message to use. (May be None.)
531
:param staging: If True, propose the merge against staging instead of
533
:param approve: If True, mark the new proposal as approved immediately.
534
This is useful when a project permits some things to be approved
535
by the submitter (e.g. merges between release and deployment
538
self.lp_host = lp_host
539
self.launchpad = lp_host.launchpad
540
self.source_branch = source_branch
541
(self.source_repo_lp,
542
self.source_branch_lp) = self.lp_host._get_lp_git_ref_from_branch(
544
if target_branch is None:
545
self.target_branch_lp = self.source_branch.get_target()
546
self.target_branch = _mod_branch.Branch.open(
547
self.target_branch_lp.git_https_url)
549
self.target_branch = target_branch
550
(self.target_repo_lp, self.target_branch_lp) = (
551
self.lp_host._get_lp_git_ref_from_branch(target_branch))
552
self.commit_message = message
553
self.approve = approve
556
def get_infotext(self):
557
"""Determine the initial comment for the merge proposal."""
558
if self.commit_message is not None:
559
return self.commit_message.strip().encode('utf-8')
560
info = ["Source: %s\n" % self.source_branch.user_url]
561
info.append("Target: %s\n" % self.target_branch.user_url)
564
def get_initial_body(self):
565
"""Get a body for the proposal for the user to modify.
567
:return: a str or None.
569
if not self.hooks['merge_proposal_body']:
572
def list_modified_files():
573
lca_tree = self.source_branch_lp.find_lca_tree(
574
self.target_branch_lp)
575
source_tree = self.source_branch.basis_tree()
576
files = modified_files(lca_tree, source_tree)
578
with self.target_branch.lock_read(), \
579
self.source_branch.lock_read():
581
for hook in self.hooks['merge_proposal_body']:
583
'target_branch': self.target_branch,
584
'modified_files_callback': list_modified_files,
589
def check_proposal(self):
590
"""Check that the submission is sensible."""
591
if self.source_branch_lp.self_link == self.target_branch_lp.self_link:
592
raise errors.BzrCommandError(
593
'Source and target branches must be different.')
594
for mp in self.source_branch_lp.landing_targets:
595
if mp.queue_status in ('Merged', 'Rejected'):
597
if mp.target_branch.self_link == self.target_branch_lp.self_link:
598
raise MergeProposalExists(lp_api.canonical_url(mp))
600
def approve_proposal(self, mp):
601
with self.source_branch.lock_read():
605
subject='', # Use the default subject.
606
content=u"Rubberstamp! Proposer approves of own proposal.")
608
mp.setStatus, status=u'Approved',
609
revid=self.source_branch.last_revision())
611
def create_proposal(self, description, reviewers=None, labels=None,
612
prerequisite_branch=None):
613
"""Perform the submission."""
615
raise LabelsUnsupported()
616
if prerequisite_branch is not None:
617
(prereq_repo_lp, prereq_branch_lp) = (
618
self.lp_host._get_lp_git_ref_from_branch(prerequisite_branch))
620
prereq_branch_lp = None
621
if reviewers is None:
624
mp = _call_webservice(
625
self.source_branch_lp.createMergeProposal,
626
merge_target=self.target_branch_lp,
627
merge_prerequisite=prereq_branch_lp,
628
initial_comment=description.strip(),
629
commit_message=self.commit_message,
631
reviewers=[self.launchpad.people[reviewer].self_link
632
for reviewer in reviewers],
633
review_types=[None for reviewer in reviewers])
634
except WebserviceFailure as e:
636
if ('There is already a branch merge proposal '
637
'registered for branch ') in e.message:
638
raise MergeProposalExists(self.source_branch.user_url)
641
self.approve_proposal(mp)
643
if self.fixes.startswith('lp:'):
644
self.fixes = self.fixes[3:]
647
bug=self.launchpad.bugs[int(self.fixes)])
648
return LaunchpadMergeProposal(mp)
651
def modified_files(old_tree, new_tree):
652
"""Return a list of paths in the new tree with modified contents."""
653
for f, (op, path), c, v, p, n, (ok, k), e in new_tree.iter_changes(
655
if c and k == 'file':
added
removed
breezy/plugins/propose/launchpad.py
