/brz/remove-bazaar

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