1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
|
# Copyright (C) 2018 Breezy Developers
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
"""Helper functions for proposing merges."""
from __future__ import absolute_import
from ... import (
errors,
hooks,
registry,
)
class MergeProposalExists(errors.BzrError):
_fmt = "A merge proposal already exists: %(url)s."
def __init__(self, url):
errors.BzrError.__init__(self)
self.url = url
class UnsupportedHoster(errors.BzrError):
_fmt = "No supported hoster for %(branch)s."
def __init__(self, branch):
errors.BzrError.__init__(self)
self.branch = branch
class ProposeMergeHooks(hooks.Hooks):
"""Hooks for proposing a merge on Launchpad."""
def __init__(self):
hooks.Hooks.__init__(self, __name__, "Proposer.hooks")
self.add_hook('get_prerequisite',
"Return the prerequisite branch for proposing as merge.", (3, 0))
self.add_hook('merge_proposal_body',
"Return an initial body for the merge proposal message.", (3, 0))
class LabelsUnsupported(errors.BzrError):
"""Labels not supported by this hoster."""
_fmt = "Labels are not supported by %(hoster)r."
def __init__(self, hoster):
errors.BzrError.__init__(self)
self.hoster = hoster
class MergeProposal(object):
"""A merge proposal.
:ivar url: URL for the merge proposal
"""
def __init__(self, url=None):
self.url = url
# TODO(jelmer): provide some way to check if this merge proposal has been
# merged.
class MergeProposalBuilder(object):
"""Merge proposal creator.
:param source_branch: Branch to propose for merging
:param target_branch: Target branch
"""
hooks = ProposeMergeHooks()
def __init__(self, source_branch, target_branch):
self.source_branch = source_branch
self.target_branch = target_branch
def get_initial_body(self):
"""Get a body for the proposal for the user to modify.
:return: a str or None.
"""
raise NotImplementedError(self.get_initial_body)
def get_infotext(self):
"""Determine the initial comment for the merge proposal.
"""
raise NotImplementedError(self.get_infotext)
def create_proposal(self, description, reviewers=None, labels=None):
"""Create a proposal to merge a branch for merging.
:param description: Description for the merge proposal
:param reviewers: Optional list of people to ask reviews from
:param labels: Labels to attach to the proposal
:return: A `MergeProposal` object
"""
raise NotImplementedError(self.create_proposal)
class Hoster(object):
"""A hosting site manager.
"""
supports_merge_proposal_labels = None
def publish(self, new_branch, base_branch, name, project=None, owner=None,
revision_id=None, overwrite=False):
"""Publish a branch to the site, derived from base_branch.
:param base_branch: branch to derive the new branch from
:param new_branch: branch to publish
:return: resulting branch, public URL
"""
raise NotImplementedError(self.publish)
def get_proposer(self, source_branch, target_branch):
"""Get a merge proposal creator.
:param source_branch: Source branch
:param target_branch: Target branch
:return: A MergeProposalBuilder object
"""
raise NotImplementedError(self.get_proposer)
@classmethod
def probe(cls, branch):
"""Create a Hoster object if this hoster knows about a branch."""
raise NotImplementedError(cls.probe)
# TODO(jelmer): Some way of cleaning up old branch proposals/branches
# TODO(jelmer): Some way of checking up on outstanding merge proposals
def get_hoster(branch):
"""Find the hoster for a branch."""
for name, hoster_cls in hosters.items():
try:
return hoster_cls.probe(branch)
except UnsupportedHoster:
pass
raise UnsupportedHoster(branch)
hosters = registry.Registry()
hosters.register_lazy(
"launchpad", "breezy.plugins.propose.launchpad",
"Launchpad")
hosters.register_lazy(
"github", "breezy.plugins.propose.github",
"GitHub")
hosters.register_lazy(
"gitlab", "breezy.plugins.propose.gitlabs",
"GitLab")
|