/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to breezy/propose.py

  • Committer: Jelmer Vernooij
  • Date: 2020-07-18 15:20:23 UTC
  • mto: (7490.40.61 work)
  • mto: This revision was merged to the branch mainline in revision 7519.
  • Revision ID: jelmer@jelmer.uk-20200718152023-cabh92o24ke217te
Ignore missing revs.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/propose.py
 
1
# Copyright (C) 2018-2019 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,
 
25
    urlutils,
 
26
    )
 
27
 
 
28
 
 
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
 
 
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
 
 
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
 
 
56
class ReopenFailed(errors.BzrError):
 
57
 
 
58
    _fmt = "Reopening the merge proposal failed: %(error)s."
 
59
 
 
60
 
 
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")
 
66
        self.add_hook(
 
67
            'get_prerequisite',
 
68
            "Return the prerequisite branch for proposing as merge.", (3, 0))
 
69
        self.add_hook(
 
70
            'merge_proposal_body',
 
71
            "Return an initial body for the merge proposal message.", (3, 0))
 
72
 
 
73
 
 
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
 
 
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
 
 
92
class HosterLoginRequired(errors.BzrError):
 
93
    """Action requires hoster login credentials."""
 
94
 
 
95
    _fmt = "Action requires credentials for hosting site %(hoster)r."""
 
96
 
 
97
    def __init__(self, hoster):
 
98
        errors.BzrError.__init__(self)
 
99
        self.hoster = hoster
 
100
 
 
101
 
 
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
 
 
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
 
 
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
 
 
127
    def get_source_branch_url(self):
 
128
        """Return the source branch."""
 
129
        raise NotImplementedError(self.get_source_branch_url)
 
130
 
 
131
    def get_source_revision(self):
 
132
        """Return the latest revision for the source branch."""
 
133
        raise NotImplementedError(self.get_source_revision)
 
134
 
 
135
    def get_target_branch_url(self):
 
136
        """Return the target branch."""
 
137
        raise NotImplementedError(self.get_target_branch_url)
 
138
 
 
139
    def get_source_project(self):
 
140
        raise NotImplementedError(self.get_source_project)
 
141
 
 
142
    def get_target_project(self):
 
143
        raise NotImplementedError(self.get_target_project)
 
144
 
 
145
    def close(self):
 
146
        """Close the merge proposal (without merging it)."""
 
147
        raise NotImplementedError(self.close)
 
148
 
 
149
    def is_merged(self):
 
150
        """Check whether this merge proposal has been merged."""
 
151
        raise NotImplementedError(self.is_merged)
 
152
 
 
153
    def is_closed(self):
 
154
        """Check whether this merge proposal is closed
 
155
 
 
156
        This can either mean that it is merged or rejected.
 
157
        """
 
158
        raise NotImplementedError(self.is_closed)
 
159
 
 
160
    def merge(self, commit_message=None):
 
161
        """Merge this merge proposal."""
 
162
        raise NotImplementedError(self.merge)
 
163
 
 
164
    def can_be_merged(self):
 
165
        """Can this merge proposal be merged?
 
166
 
 
167
        The answer to this can be no if e.g. it has conflics.
 
168
        """
 
169
        raise NotImplementedError(self.can_be_merged)
 
170
 
 
171
    def get_merged_by(self):
 
172
        """If this proposal was merged, who merged it.
 
173
        """
 
174
        raise NotImplementedError(self.get_merged_by)
 
175
 
 
176
    def get_merged_at(self):
 
177
        """If this proposal was merged, when it was merged.
 
178
        """
 
179
        raise NotImplementedError(self.get_merged_at)
 
180
 
 
181
    def post_comment(self, body):
 
182
        """Post a comment on the merge proposal.
 
183
 
 
184
        Args:
 
185
          body: Body of the comment
 
186
        """
 
187
        raise NotImplementedError(self.post_comment)
 
188
 
 
189
 
 
190
class MergeProposalBuilder(object):
 
191
    """Merge proposal creator.
 
192
 
 
193
    :param source_branch: Branch to propose for merging
 
194
    :param target_branch: Target branch
 
195
    """
 
196
 
 
197
    hooks = ProposeMergeHooks()
 
198
 
 
199
    def __init__(self, source_branch, target_branch):
 
200
        self.source_branch = source_branch
 
201
        self.target_branch = target_branch
 
202
 
 
203
    def get_initial_body(self):
 
204
        """Get a body for the proposal for the user to modify.
 
205
 
 
206
        :return: a str or None.
 
207
        """
 
208
        raise NotImplementedError(self.get_initial_body)
 
209
 
 
210
    def get_infotext(self):
 
211
        """Determine the initial comment for the merge proposal.
 
212
        """
 
213
        raise NotImplementedError(self.get_infotext)
 
214
 
 
215
    def create_proposal(self, description, reviewers=None, labels=None,
 
216
                        prerequisite_branch=None, commit_message=None,
 
217
                        work_in_progress=False, allow_collaboration=False):
 
218
        """Create a proposal to merge a branch for merging.
 
219
 
 
220
        :param description: Description for the merge proposal
 
221
        :param reviewers: Optional list of people to ask reviews from
 
222
        :param labels: Labels to attach to the proposal
 
223
        :param prerequisite_branch: Optional prerequisite branch
 
224
        :param commit_message: Optional commit message
 
225
        :param work_in_progress:
 
226
            Whether this merge proposal is still a work-in-progress
 
227
        :param allow_collaboration:
 
228
            Whether to allow changes to the branch from the target branch
 
229
            maintainer(s)
 
230
        :return: A `MergeProposal` object
 
231
        """
 
232
        raise NotImplementedError(self.create_proposal)
 
233
 
 
234
 
 
235
class Hoster(object):
 
236
    """A hosting site manager.
 
237
    """
 
238
 
 
239
    # Does this hoster support arbitrary labels being attached to merge
 
240
    # proposals?
 
241
    supports_merge_proposal_labels = None
 
242
 
 
243
    # Does this hoster support suggesting a commit message in the
 
244
    # merge proposal?
 
245
    supports_merge_proposal_commit_message = None
 
246
 
 
247
    # The base_url that would be visible to users. I.e. https://github.com/
 
248
    # rather than https://api.github.com/
 
249
    base_url = None
 
250
 
 
251
    # The syntax to use for formatting merge proposal descriptions.
 
252
    # Common values: 'plain', 'markdown'
 
253
    merge_proposal_description_format = None
 
254
 
 
255
    # Does this hoster support the allow_collaboration flag?
 
256
    supports_allow_collaboration = False
 
257
 
 
258
    def publish_derived(self, new_branch, base_branch, name, project=None,
 
259
                        owner=None, revision_id=None, overwrite=False,
 
260
                        allow_lossy=True, tag_selector=None):
 
261
        """Publish a branch to the site, derived from base_branch.
 
262
 
 
263
        :param base_branch: branch to derive the new branch from
 
264
        :param new_branch: branch to publish
 
265
        :return: resulting branch, public URL
 
266
        :raise HosterLoginRequired: Action requires a hoster login, but none is
 
267
            known.
 
268
        """
 
269
        raise NotImplementedError(self.publish)
 
270
 
 
271
    def get_derived_branch(self, base_branch, name, project=None, owner=None):
 
272
        """Get a derived branch ('a fork').
 
273
        """
 
274
        raise NotImplementedError(self.get_derived_branch)
 
275
 
 
276
    def get_push_url(self, branch):
 
277
        """Get the push URL for a branch."""
 
278
        raise NotImplementedError(self.get_push_url)
 
279
 
 
280
    def get_proposer(self, source_branch, target_branch):
 
281
        """Get a merge proposal creator.
 
282
 
 
283
        :note: source_branch does not have to be hosted by the hoster.
 
284
 
 
285
        :param source_branch: Source branch
 
286
        :param target_branch: Target branch
 
287
        :return: A MergeProposalBuilder object
 
288
        """
 
289
        raise NotImplementedError(self.get_proposer)
 
290
 
 
291
    def iter_proposals(self, source_branch, target_branch, status='open'):
 
292
        """Get the merge proposals for a specified branch tuple.
 
293
 
 
294
        :param source_branch: Source branch
 
295
        :param target_branch: Target branch
 
296
        :param status: Status of proposals to iterate over
 
297
        :return: Iterate over MergeProposal object
 
298
        """
 
299
        raise NotImplementedError(self.iter_proposals)
 
300
 
 
301
    def get_proposal_by_url(self, url):
 
302
        """Retrieve a branch proposal by URL.
 
303
 
 
304
        :param url: Merge proposal URL.
 
305
        :return: MergeProposal object
 
306
        :raise UnsupportedHoster: Hoster does not support this URL
 
307
        """
 
308
        raise NotImplementedError(self.get_proposal_by_url)
 
309
 
 
310
    def hosts(self, branch):
 
311
        """Return true if this hoster hosts given branch."""
 
312
        raise NotImplementedError(self.hosts)
 
313
 
 
314
    @classmethod
 
315
    def probe_from_branch(cls, branch):
 
316
        """Create a Hoster object if this hoster knows about a branch."""
 
317
        url = urlutils.strip_segment_parameters(branch.user_url)
 
318
        return cls.probe_from_url(
 
319
            url, possible_transports=[branch.control_transport])
 
320
 
 
321
    @classmethod
 
322
    def probe_from_url(cls, url, possible_hosters=None):
 
323
        """Create a Hoster object if this hoster knows about a URL."""
 
324
        raise NotImplementedError(cls.probe_from_url)
 
325
 
 
326
    def iter_my_proposals(self, status='open'):
 
327
        """Iterate over the proposals created by the currently logged in user.
 
328
 
 
329
        :param status: Only yield proposals with this status
 
330
            (one of: 'open', 'closed', 'merged', 'all')
 
331
        :return: Iterator over MergeProposal objects
 
332
        :raise HosterLoginRequired: Action requires a hoster login, but none is
 
333
            known.
 
334
        """
 
335
        raise NotImplementedError(self.iter_my_proposals)
 
336
 
 
337
    def iter_my_forks(self):
 
338
        """Iterate over the currently logged in users' forks.
 
339
 
 
340
        :return: Iterator over project_name
 
341
        """
 
342
        raise NotImplementedError(self.iter_my_forks)
 
343
 
 
344
    def delete_project(self, name):
 
345
        """Delete a project.
 
346
        """
 
347
        raise NotImplementedError(self.delete_project)
 
348
 
 
349
    @classmethod
 
350
    def iter_instances(cls):
 
351
        """Iterate instances.
 
352
 
 
353
        :return: Hoster instances
 
354
        """
 
355
        raise NotImplementedError(cls.iter_instances)
 
356
 
 
357
 
 
358
def determine_title(description):
 
359
    """Determine the title for a merge proposal based on full description."""
 
360
    return description.splitlines()[0].split('.')[0]
 
361
 
 
362
 
 
363
def get_hoster(branch, possible_hosters=None):
 
364
    """Find the hoster for a branch.
 
365
 
 
366
    :param branch: Branch to find hoster for
 
367
    :param possible_hosters: Optional list of hosters to reuse
 
368
    :raise UnsupportedHoster: if there is no hoster that supports `branch`
 
369
    :return: A `Hoster` object
 
370
    """
 
371
    if possible_hosters:
 
372
        for hoster in possible_hosters:
 
373
            if hoster.hosts(branch):
 
374
                return hoster
 
375
    for name, hoster_cls in hosters.items():
 
376
        try:
 
377
            hoster = hoster_cls.probe_from_branch(branch)
 
378
        except UnsupportedHoster:
 
379
            pass
 
380
        else:
 
381
            if possible_hosters is not None:
 
382
                possible_hosters.append(hoster)
 
383
            return hoster
 
384
    raise UnsupportedHoster(branch)
 
385
 
 
386
 
 
387
def get_proposal_by_url(url):
 
388
    """Get the proposal object associated with a URL.
 
389
 
 
390
    :param url: URL of the proposal
 
391
    :raise UnsupportedHoster: if there is no hoster that supports the URL
 
392
    :return: A `MergeProposal` object
 
393
    """
 
394
    for name, hoster_cls in hosters.items():
 
395
        for instance in hoster_cls.iter_instances():
 
396
            try:
 
397
                return instance.get_proposal_by_url(url)
 
398
            except UnsupportedHoster:
 
399
                pass
 
400
    raise UnsupportedHoster(url)
 
401
 
 
402
 
 
403
hosters = registry.Registry()