/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar
0.431.1 by Jelmer Vernooij
Start work on propose command.
1
# Copyright (C) 2018 Breezy Developers
2
#
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.
7
#
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.
12
#
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
16
17
"""Helper functions for proposing merges."""
18
19
from __future__ import absolute_import
20
21
from ... import (
22
    errors,
23
    hooks,
24
    registry,
7268.12.3 by Jelmer Vernooij
Add missing import.
25
    urlutils,
0.431.1 by Jelmer Vernooij
Start work on propose command.
26
    )
27
28
0.431.38 by Jelmer Vernooij
Add NoSuchProject.
29
class NoSuchProject(errors.BzrError):
30
31
    _fmt = "Project does not exist: %(project)s."
32
33
    def __init__(self, project):
34
        errors.BzrError.__init__(self)
35
        self.project = project
36
37
0.431.2 by Jelmer Vernooij
Add launchpad implementation.
38
class MergeProposalExists(errors.BzrError):
39
40
    _fmt = "A merge proposal already exists: %(url)s."
41
42
    def __init__(self, url):
43
        errors.BzrError.__init__(self)
44
        self.url = url
45
46
0.432.2 by Jelmer Vernooij
Publish command sort of works.
47
class UnsupportedHoster(errors.BzrError):
48
49
    _fmt = "No supported hoster for %(branch)s."
50
51
    def __init__(self, branch):
52
        errors.BzrError.__init__(self)
53
        self.branch = branch
54
55
7381.5.1 by Jelmer Vernooij
Several more fixes for merge proposals. Add functions for reopening merge proposals.
56
class ReopenFailed(errors.BzrError):
57
58
    _fmt = "Reopening the merge proposal failed: %(error)s."
59
60
0.431.1 by Jelmer Vernooij
Start work on propose command.
61
class ProposeMergeHooks(hooks.Hooks):
62
    """Hooks for proposing a merge on Launchpad."""
63
64
    def __init__(self):
65
        hooks.Hooks.__init__(self, __name__, "Proposer.hooks")
0.431.57 by Jelmer Vernooij
Cleanups.
66
        self.add_hook(
67
            'get_prerequisite',
0.431.1 by Jelmer Vernooij
Start work on propose command.
68
            "Return the prerequisite branch for proposing as merge.", (3, 0))
0.431.57 by Jelmer Vernooij
Cleanups.
69
        self.add_hook(
70
            'merge_proposal_body',
0.431.1 by Jelmer Vernooij
Start work on propose command.
71
            "Return an initial body for the merge proposal message.", (3, 0))
72
73
0.431.13 by Jelmer Vernooij
Add support for labels on merge proposals.
74
class LabelsUnsupported(errors.BzrError):
75
    """Labels not supported by this hoster."""
76
77
    _fmt = "Labels are not supported by %(hoster)r."
78
79
    def __init__(self, hoster):
80
        errors.BzrError.__init__(self)
81
        self.hoster = hoster
82
83
0.431.56 by Jelmer Vernooij
Add support for prerequisite branches.
84
class PrerequisiteBranchUnsupported(errors.BzrError):
85
    """Prerequisite branch not supported by this hoster."""
86
87
    def __init__(self, hoster):
88
        errors.BzrError.__init__(self)
89
        self.hoster = hoster
90
91
7268.8.1 by Jelmer Vernooij
Add HosterLoginRequired exception.
92
class HosterLoginRequired(errors.BzrError):
93
    """Action requires hoster login credentials."""
94
7268.8.2 by Jelmer Vernooij
Handle GitHub errors.
95
    _fmt = "Action requires credentials for hosting site %(hoster)r."""
96
7268.8.1 by Jelmer Vernooij
Add HosterLoginRequired exception.
97
    def __init__(self, hoster):
98
        errors.BzrError.__init__(self)
99
        self.hoster = hoster
100
101
0.431.3 by Jelmer Vernooij
Add a MergeProposal object.
102
class MergeProposal(object):
103
    """A merge proposal.
104
105
    :ivar url: URL for the merge proposal
106
    """
107
108
    def __init__(self, url=None):
109
        self.url = url
110
0.431.39 by Jelmer Vernooij
Extend the merge proposal abstraction a bit.
111
    def get_description(self):
112
        """Get the description of the merge proposal."""
113
        raise NotImplementedError(self.get_description)
114
115
    def set_description(self, description):
116
        """Set the description of the merge proposal."""
117
        raise NotImplementedError(self.set_description)
118
7296.8.2 by Jelmer Vernooij
Add feature flag for commit message.
119
    def get_commit_message(self):
120
        """Get the proposed commit message."""
121
        raise NotImplementedError(self.get_commit_message)
122
123
    def set_commit_message(self, commit_message):
124
        """Set the propose commit message."""
125
        raise NotImplementedError(self.set_commit_message)
126
0.431.64 by Jelmer Vernooij
Add get_source_branch_url/get_target_branch_url methods.
127
    def get_source_branch_url(self):
128
        """Return the source branch."""
129
        raise NotImplementedError(self.get_source_branch_url)
130
131
    def get_target_branch_url(self):
132
        """Return the target branch."""
133
        raise NotImplementedError(self.get_target_branch_url)
134
0.431.39 by Jelmer Vernooij
Extend the merge proposal abstraction a bit.
135
    def close(self):
136
        """Close the merge proposal (without merging it)."""
137
        raise NotImplementedError(self.close)
138
0.431.46 by Jelmer Vernooij
Add MergeProposal.is_merged.
139
    def is_merged(self):
140
        """Check whether this merge proposal has been merged."""
141
        raise NotImplementedError(self.is_merged)
142
7381.5.1 by Jelmer Vernooij
Several more fixes for merge proposals. Add functions for reopening merge proposals.
143
    def is_closed(self):
144
        """Check whether this merge proposal is closed
145
146
        This can either mean that it is merged or rejected.
147
        """
148
        raise NotImplementedError(self.is_closed)
149
7296.9.1 by Jelmer Vernooij
Add 'brz land' subcommand.
150
    def merge(self, commit_message=None):
151
        """Merge this merge proposal."""
152
        raise NotImplementedError(self.merge)
153
7380.1.1 by Jelmer Vernooij
Several more fixes for git merge proposals.
154
    def can_be_merged(self):
155
        """Can this merge proposal be merged?
156
157
        The answer to this can be no if e.g. it has conflics.
158
        """
159
        raise NotImplementedError(self.can_be_merged)
160
7414.4.1 by Jelmer Vernooij
Add a MergeProposal.get_merged_by method.
161
    def get_merged_by(self):
162
        """If this proposal was merged, who merged it.
163
        """
164
        raise NotImplementedError(self.get_merged_by)
165
0.431.3 by Jelmer Vernooij
Add a MergeProposal object.
166
0.432.2 by Jelmer Vernooij
Publish command sort of works.
167
class MergeProposalBuilder(object):
0.431.1 by Jelmer Vernooij
Start work on propose command.
168
    """Merge proposal creator.
169
170
    :param source_branch: Branch to propose for merging
171
    :param target_branch: Target branch
172
    """
173
174
    hooks = ProposeMergeHooks()
175
176
    def __init__(self, source_branch, target_branch):
177
        self.source_branch = source_branch
178
        self.target_branch = target_branch
179
0.431.2 by Jelmer Vernooij
Add launchpad implementation.
180
    def get_initial_body(self):
181
        """Get a body for the proposal for the user to modify.
182
183
        :return: a str or None.
184
        """
185
        raise NotImplementedError(self.get_initial_body)
186
187
    def get_infotext(self):
188
        """Determine the initial comment for the merge proposal.
189
        """
190
        raise NotImplementedError(self.get_infotext)
191
0.431.56 by Jelmer Vernooij
Add support for prerequisite branches.
192
    def create_proposal(self, description, reviewers=None, labels=None,
7296.8.1 by Jelmer Vernooij
Add commit-message option to 'brz propose'.
193
                        prerequisite_branch=None, commit_message=None):
0.431.1 by Jelmer Vernooij
Start work on propose command.
194
        """Create a proposal to merge a branch for merging.
0.431.2 by Jelmer Vernooij
Add launchpad implementation.
195
196
        :param description: Description for the merge proposal
0.431.5 by Jelmer Vernooij
Initial work on gitlab support.
197
        :param reviewers: Optional list of people to ask reviews from
0.431.13 by Jelmer Vernooij
Add support for labels on merge proposals.
198
        :param labels: Labels to attach to the proposal
0.431.56 by Jelmer Vernooij
Add support for prerequisite branches.
199
        :param prerequisite_branch: Optional prerequisite branch
7296.8.1 by Jelmer Vernooij
Add commit-message option to 'brz propose'.
200
        :param commit_message: Optional commit message
0.431.3 by Jelmer Vernooij
Add a MergeProposal object.
201
        :return: A `MergeProposal` object
0.431.1 by Jelmer Vernooij
Start work on propose command.
202
        """
203
        raise NotImplementedError(self.create_proposal)
204
205
0.432.1 by Jelmer Vernooij
Initial work on hoster support.
206
class Hoster(object):
207
    """A hosting site manager.
208
    """
209
7260.1.1 by Jelmer Vernooij
Add .base_url property to Hoster.
210
    # Does this hoster support arbitrary labels being attached to merge
211
    # proposals?
0.431.13 by Jelmer Vernooij
Add support for labels on merge proposals.
212
    supports_merge_proposal_labels = None
213
7296.8.2 by Jelmer Vernooij
Add feature flag for commit message.
214
    # Does this hoster support suggesting a commit message in the
215
    # merge proposal?
216
    supports_merge_proposal_commit_message = None
217
7260.1.1 by Jelmer Vernooij
Add .base_url property to Hoster.
218
    # The base_url that would be visible to users. I.e. https://github.com/
219
    # rather than https://api.github.com/
220
    base_url = None
221
0.431.20 by Jelmer Vernooij
publish -> publish_derived.
222
    def publish_derived(self, new_branch, base_branch, name, project=None,
0.431.51 by Jelmer Vernooij
Allow fallback to lossy by default.
223
                        owner=None, revision_id=None, overwrite=False,
224
                        allow_lossy=True):
0.432.1 by Jelmer Vernooij
Initial work on hoster support.
225
        """Publish a branch to the site, derived from base_branch.
226
227
        :param base_branch: branch to derive the new branch from
228
        :param new_branch: branch to publish
0.432.3 by Jelmer Vernooij
Publish command works for github.
229
        :return: resulting branch, public URL
7268.8.1 by Jelmer Vernooij
Add HosterLoginRequired exception.
230
        :raise HosterLoginRequired: Action requires a hoster login, but none is
231
            known.
0.432.1 by Jelmer Vernooij
Initial work on hoster support.
232
        """
233
        raise NotImplementedError(self.publish)
234
0.431.22 by Jelmer Vernooij
Add Hoster.get_derived_branch.
235
    def get_derived_branch(self, base_branch, name, project=None, owner=None):
0.431.31 by Jelmer Vernooij
Drop autopropose command.
236
        """Get a derived branch ('a fork').
237
        """
0.431.22 by Jelmer Vernooij
Add Hoster.get_derived_branch.
238
        raise NotImplementedError(self.get_derived_branch)
239
0.431.28 by Jelmer Vernooij
Implement Hoster.get_push_url.
240
    def get_push_url(self, branch):
241
        """Get the push URL for a branch."""
242
        raise NotImplementedError(self.get_push_url)
243
0.432.1 by Jelmer Vernooij
Initial work on hoster support.
244
    def get_proposer(self, source_branch, target_branch):
245
        """Get a merge proposal creator.
246
0.431.31 by Jelmer Vernooij
Drop autopropose command.
247
        :note: source_branch does not have to be hosted by the hoster.
248
0.432.1 by Jelmer Vernooij
Initial work on hoster support.
249
        :param source_branch: Source branch
250
        :param target_branch: Target branch
0.432.2 by Jelmer Vernooij
Publish command sort of works.
251
        :return: A MergeProposalBuilder object
0.432.1 by Jelmer Vernooij
Initial work on hoster support.
252
        """
253
        raise NotImplementedError(self.get_proposer)
254
0.431.68 by Jelmer Vernooij
Add status to other Hosters.
255
    def iter_proposals(self, source_branch, target_branch, status='open'):
7296.9.1 by Jelmer Vernooij
Add 'brz land' subcommand.
256
        """Get the merge proposals for a specified branch tuple.
0.431.35 by Jelmer Vernooij
Add Hoster.get_proposal.
257
258
        :param source_branch: Source branch
259
        :param target_branch: Target branch
0.431.68 by Jelmer Vernooij
Add status to other Hosters.
260
        :param status: Status of proposals to iterate over
0.431.67 by Jelmer Vernooij
Support multiple merge proposals per branch.
261
        :return: Iterate over MergeProposal object
0.431.35 by Jelmer Vernooij
Add Hoster.get_proposal.
262
        """
0.431.67 by Jelmer Vernooij
Support multiple merge proposals per branch.
263
        raise NotImplementedError(self.iter_proposals)
0.431.35 by Jelmer Vernooij
Add Hoster.get_proposal.
264
7296.9.1 by Jelmer Vernooij
Add 'brz land' subcommand.
265
    def get_proposal_by_url(self, url):
266
        """Retrieve a branch proposal by URL.
267
268
        :param url: Merge proposal URL.
269
        :return: MergeProposal object
270
        :raise UnsupportedHoster: Hoster does not support this URL
271
        """
272
        raise NotImplementedError(self.get_proposal_by_url)
273
0.433.1 by Jelmer Vernooij
Add Hoster.hosts.
274
    def hosts(self, branch):
275
        """Return true if this hoster hosts given branch."""
276
        raise NotImplementedError(self.hosts)
277
0.432.1 by Jelmer Vernooij
Initial work on hoster support.
278
    @classmethod
7268.12.1 by Jelmer Vernooij
Split out probe_from_url.
279
    def probe_from_branch(cls, branch):
0.432.9 by Jelmer Vernooij
Drop is_compatible nonesense.
280
        """Create a Hoster object if this hoster knows about a branch."""
7268.12.1 by Jelmer Vernooij
Split out probe_from_url.
281
        url = urlutils.split_segment_parameters(branch.user_url)[0]
7296.10.1 by Jelmer Vernooij
Initial work making gitlab just directly use ReST.
282
        return cls.probe_from_url(
7296.10.2 by Jelmer Vernooij
More fixes.
283
            url, possible_transports=[branch.control_transport])
7268.12.1 by Jelmer Vernooij
Split out probe_from_url.
284
285
    @classmethod
7296.10.1 by Jelmer Vernooij
Initial work making gitlab just directly use ReST.
286
    def probe_from_url(cls, url, possible_hosters=None):
7268.12.1 by Jelmer Vernooij
Split out probe_from_url.
287
        """Create a Hoster object if this hoster knows about a URL."""
288
        raise NotImplementedError(cls.probe_from_url)
0.432.1 by Jelmer Vernooij
Initial work on hoster support.
289
0.432.4 by Jelmer Vernooij
Some work on gitlab.
290
    # TODO(jelmer): Some way of cleaning up old branch proposals/branches
291
0.431.66 by Jelmer Vernooij
Add support for status argument.
292
    def iter_my_proposals(self, status='open'):
0.431.63 by Jelmer Vernooij
Add 'brz my-proposals' command.
293
        """Iterate over the proposals created by the currently logged in user.
294
0.431.66 by Jelmer Vernooij
Add support for status argument.
295
        :param status: Only yield proposals with this status
296
            (one of: 'open', 'closed', 'merged', 'all')
0.431.63 by Jelmer Vernooij
Add 'brz my-proposals' command.
297
        :return: Iterator over MergeProposal objects
7268.8.1 by Jelmer Vernooij
Add HosterLoginRequired exception.
298
        :raise HosterLoginRequired: Action requires a hoster login, but none is
299
            known.
0.431.63 by Jelmer Vernooij
Add 'brz my-proposals' command.
300
        """
301
        raise NotImplementedError(self.iter_my_proposals)
302
303
    @classmethod
304
    def iter_instances(cls):
305
        """Iterate instances.
306
307
        :return: Hoster instances
308
        """
309
        raise NotImplementedError(cls.iter_instances)
310
0.432.1 by Jelmer Vernooij
Initial work on hoster support.
311
0.433.1 by Jelmer Vernooij
Add Hoster.hosts.
312
def get_hoster(branch, possible_hosters=None):
0.432.2 by Jelmer Vernooij
Publish command sort of works.
313
    """Find the hoster for a branch."""
0.433.1 by Jelmer Vernooij
Add Hoster.hosts.
314
    if possible_hosters:
315
        for hoster in possible_hosters:
316
            if hoster.hosts(branch):
317
                return hoster
0.432.2 by Jelmer Vernooij
Publish command sort of works.
318
    for name, hoster_cls in hosters.items():
0.432.9 by Jelmer Vernooij
Drop is_compatible nonesense.
319
        try:
7268.12.1 by Jelmer Vernooij
Split out probe_from_url.
320
            hoster = hoster_cls.probe_from_branch(branch)
0.432.9 by Jelmer Vernooij
Drop is_compatible nonesense.
321
        except UnsupportedHoster:
322
            pass
0.433.1 by Jelmer Vernooij
Add Hoster.hosts.
323
        else:
324
            if possible_hosters is not None:
325
                possible_hosters.append(hoster)
326
            return hoster
0.432.2 by Jelmer Vernooij
Publish command sort of works.
327
    raise UnsupportedHoster(branch)
328
329
7296.9.1 by Jelmer Vernooij
Add 'brz land' subcommand.
330
def get_proposal_by_url(url):
331
    for name, hoster_cls in hosters.items():
332
        for instance in hoster_cls.iter_instances():
333
            try:
334
                return instance.get_proposal_by_url(url)
335
            except UnsupportedHoster:
336
                pass
337
    raise UnsupportedHoster(url)
338
339
0.432.2 by Jelmer Vernooij
Publish command sort of works.
340
hosters = registry.Registry()
341
hosters.register_lazy(
7211.13.7 by Jelmer Vernooij
Fix formatting.
342
    "launchpad", "breezy.plugins.propose.launchpad",
343
    "Launchpad")
344
hosters.register_lazy(
345
    "github", "breezy.plugins.propose.github",
346
    "GitHub")
347
hosters.register_lazy(
348
    "gitlab", "breezy.plugins.propose.gitlabs",
349
    "GitLab")