1
# Copyright (C) 2018 Breezy Developers
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
"""Helper functions for proposing merges."""
19
from __future__ import absolute_import
29
class NoSuchProject(errors.BzrError):
31
_fmt = "Project does not exist: %(project)s."
33
def __init__(self, project):
34
errors.BzrError.__init__(self)
35
self.project = project
38
class MergeProposalExists(errors.BzrError):
40
_fmt = "A merge proposal already exists: %(url)s."
42
def __init__(self, url):
43
errors.BzrError.__init__(self)
47
class UnsupportedHoster(errors.BzrError):
49
_fmt = "No supported hoster for %(branch)s."
51
def __init__(self, branch):
52
errors.BzrError.__init__(self)
56
class ReopenFailed(errors.BzrError):
58
_fmt = "Reopening the merge proposal failed: %(error)s."
61
class ProposeMergeHooks(hooks.Hooks):
62
"""Hooks for proposing a merge on Launchpad."""
65
hooks.Hooks.__init__(self, __name__, "Proposer.hooks")
68
"Return the prerequisite branch for proposing as merge.", (3, 0))
70
'merge_proposal_body',
71
"Return an initial body for the merge proposal message.", (3, 0))
74
class LabelsUnsupported(errors.BzrError):
75
"""Labels not supported by this hoster."""
77
_fmt = "Labels are not supported by %(hoster)r."
79
def __init__(self, hoster):
80
errors.BzrError.__init__(self)
84
class PrerequisiteBranchUnsupported(errors.BzrError):
85
"""Prerequisite branch not supported by this hoster."""
87
def __init__(self, hoster):
88
errors.BzrError.__init__(self)
92
class HosterLoginRequired(errors.BzrError):
93
"""Action requires hoster login credentials."""
95
_fmt = "Action requires credentials for hosting site %(hoster)r."""
97
def __init__(self, hoster):
98
errors.BzrError.__init__(self)
102
class MergeProposal(object):
105
:ivar url: URL for the merge proposal
108
def __init__(self, url=None):
111
def get_description(self):
112
"""Get the description of the merge proposal."""
113
raise NotImplementedError(self.get_description)
115
def set_description(self, description):
116
"""Set the description of the merge proposal."""
117
raise NotImplementedError(self.set_description)
119
def get_commit_message(self):
120
"""Get the proposed commit message."""
121
raise NotImplementedError(self.get_commit_message)
123
def set_commit_message(self, commit_message):
124
"""Set the propose commit message."""
125
raise NotImplementedError(self.set_commit_message)
127
def get_source_branch_url(self):
128
"""Return the source branch."""
129
raise NotImplementedError(self.get_source_branch_url)
131
def get_target_branch_url(self):
132
"""Return the target branch."""
133
raise NotImplementedError(self.get_target_branch_url)
136
"""Close the merge proposal (without merging it)."""
137
raise NotImplementedError(self.close)
140
"""Check whether this merge proposal has been merged."""
141
raise NotImplementedError(self.is_merged)
144
"""Check whether this merge proposal is closed
146
This can either mean that it is merged or rejected.
148
raise NotImplementedError(self.is_closed)
150
def merge(self, commit_message=None):
151
"""Merge this merge proposal."""
152
raise NotImplementedError(self.merge)
154
def can_be_merged(self):
155
"""Can this merge proposal be merged?
157
The answer to this can be no if e.g. it has conflics.
159
raise NotImplementedError(self.can_be_merged)
162
class MergeProposalBuilder(object):
163
"""Merge proposal creator.
165
:param source_branch: Branch to propose for merging
166
:param target_branch: Target branch
169
hooks = ProposeMergeHooks()
171
def __init__(self, source_branch, target_branch):
172
self.source_branch = source_branch
173
self.target_branch = target_branch
175
def get_initial_body(self):
176
"""Get a body for the proposal for the user to modify.
178
:return: a str or None.
180
raise NotImplementedError(self.get_initial_body)
182
def get_infotext(self):
183
"""Determine the initial comment for the merge proposal.
185
raise NotImplementedError(self.get_infotext)
187
def create_proposal(self, description, reviewers=None, labels=None,
188
prerequisite_branch=None, commit_message=None):
189
"""Create a proposal to merge a branch for merging.
191
:param description: Description for the merge proposal
192
:param reviewers: Optional list of people to ask reviews from
193
:param labels: Labels to attach to the proposal
194
:param prerequisite_branch: Optional prerequisite branch
195
:param commit_message: Optional commit message
196
:return: A `MergeProposal` object
198
raise NotImplementedError(self.create_proposal)
201
class Hoster(object):
202
"""A hosting site manager.
205
# Does this hoster support arbitrary labels being attached to merge
207
supports_merge_proposal_labels = None
209
# Does this hoster support suggesting a commit message in the
211
supports_merge_proposal_commit_message = None
213
# The base_url that would be visible to users. I.e. https://github.com/
214
# rather than https://api.github.com/
217
def publish_derived(self, new_branch, base_branch, name, project=None,
218
owner=None, revision_id=None, overwrite=False,
220
"""Publish a branch to the site, derived from base_branch.
222
:param base_branch: branch to derive the new branch from
223
:param new_branch: branch to publish
224
:return: resulting branch, public URL
225
:raise HosterLoginRequired: Action requires a hoster login, but none is
228
raise NotImplementedError(self.publish)
230
def get_derived_branch(self, base_branch, name, project=None, owner=None):
231
"""Get a derived branch ('a fork').
233
raise NotImplementedError(self.get_derived_branch)
235
def get_push_url(self, branch):
236
"""Get the push URL for a branch."""
237
raise NotImplementedError(self.get_push_url)
239
def get_proposer(self, source_branch, target_branch):
240
"""Get a merge proposal creator.
242
:note: source_branch does not have to be hosted by the hoster.
244
:param source_branch: Source branch
245
:param target_branch: Target branch
246
:return: A MergeProposalBuilder object
248
raise NotImplementedError(self.get_proposer)
250
def iter_proposals(self, source_branch, target_branch, status='open'):
251
"""Get the merge proposals for a specified branch tuple.
253
:param source_branch: Source branch
254
:param target_branch: Target branch
255
:param status: Status of proposals to iterate over
256
:return: Iterate over MergeProposal object
258
raise NotImplementedError(self.iter_proposals)
260
def get_proposal_by_url(self, url):
261
"""Retrieve a branch proposal by URL.
263
:param url: Merge proposal URL.
264
:return: MergeProposal object
265
:raise UnsupportedHoster: Hoster does not support this URL
267
raise NotImplementedError(self.get_proposal_by_url)
269
def hosts(self, branch):
270
"""Return true if this hoster hosts given branch."""
271
raise NotImplementedError(self.hosts)
274
def probe_from_branch(cls, branch):
275
"""Create a Hoster object if this hoster knows about a branch."""
276
url = urlutils.split_segment_parameters(branch.user_url)[0]
277
return cls.probe_from_url(
278
url, possible_transports=[branch.control_transport])
281
def probe_from_url(cls, url, possible_hosters=None):
282
"""Create a Hoster object if this hoster knows about a URL."""
283
raise NotImplementedError(cls.probe_from_url)
285
# TODO(jelmer): Some way of cleaning up old branch proposals/branches
287
def iter_my_proposals(self, status='open'):
288
"""Iterate over the proposals created by the currently logged in user.
290
:param status: Only yield proposals with this status
291
(one of: 'open', 'closed', 'merged', 'all')
292
:return: Iterator over MergeProposal objects
293
:raise HosterLoginRequired: Action requires a hoster login, but none is
296
raise NotImplementedError(self.iter_my_proposals)
299
def iter_instances(cls):
300
"""Iterate instances.
302
:return: Hoster instances
304
raise NotImplementedError(cls.iter_instances)
307
def get_hoster(branch, possible_hosters=None):
308
"""Find the hoster for a branch."""
310
for hoster in possible_hosters:
311
if hoster.hosts(branch):
313
for name, hoster_cls in hosters.items():
315
hoster = hoster_cls.probe_from_branch(branch)
316
except UnsupportedHoster:
319
if possible_hosters is not None:
320
possible_hosters.append(hoster)
322
raise UnsupportedHoster(branch)
325
def get_proposal_by_url(url):
326
for name, hoster_cls in hosters.items():
327
for instance in hoster_cls.iter_instances():
329
return instance.get_proposal_by_url(url)
330
except UnsupportedHoster:
332
raise UnsupportedHoster(url)
335
hosters = registry.Registry()
336
hosters.register_lazy(
337
"launchpad", "breezy.plugins.propose.launchpad",
339
hosters.register_lazy(
340
"github", "breezy.plugins.propose.github",
342
hosters.register_lazy(
343
"gitlab", "breezy.plugins.propose.gitlabs",