/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/plugins/gitlab/hoster.py

  • Committer: Breezy landing bot
  • Author(s): Gustav Hartvigsson
  • Date: 2021-01-10 18:46:30 UTC
  • mfrom: (7526.1.1 brz-removed-api-doc)
  • mto: This revision was merged to the branch mainline in revision 7532.
  • Revision ID: breezy.the.bot@gmail.com-20210110184630-dxu0g9dqq020uiw6
Drop documentation for removed API API.

Merged from https://code.launchpad.net/~gustav-hartvigsson/brz/removed-api-doc/+merge/396033

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/plugins/gitlab/hoster.py
18
18
 
19
19
import json
20
20
import os
 
21
import re
21
22
import time
22
23
 
23
24
from ... import (
39
40
    MergeProposalExists,
40
41
    NoSuchProject,
41
42
    PrerequisiteBranchUnsupported,
 
43
    SourceNotDerivedFromTarget,
42
44
    UnsupportedHoster,
43
45
    )
44
46
 
74
76
        self.url = url
75
77
 
76
78
 
 
79
class GitLabUnprocessable(errors.BzrError):
 
80
 
 
81
    _fmt = "GitLab can not process request: %(error)s."
 
82
 
 
83
    def __init__(self, error):
 
84
        errors.BzrError.__init__(self, error=error)
 
85
 
 
86
 
77
87
class DifferentGitLabInstances(errors.BzrError):
78
88
 
79
89
    _fmt = ("Can't create merge proposals across GitLab instances: "
97
107
        self.error = error
98
108
 
99
109
 
 
110
class GitLabConflict(errors.BzrError):
 
111
 
 
112
    _fmt = "Conflict during operation: %(reason)s"
 
113
 
 
114
    def __init__(self, reason):
 
115
        errors.BzrError(self, reason=reason)
 
116
 
 
117
 
 
118
class ForkingDisabled(errors.BzrError):
 
119
 
 
120
    _fmt = ("Forking on project %(project)s is disabled.")
 
121
 
 
122
    def __init__(self, project):
 
123
        self.project = project
 
124
 
 
125
 
 
126
class MergeRequestConflict(Exception):
 
127
    """Raised when a merge requests conflicts."""
 
128
 
 
129
    def __init__(self, reason):
 
130
        self.reason = reason
 
131
 
 
132
 
 
133
class ProjectCreationTimeout(errors.BzrError):
 
134
 
 
135
    _fmt = ("Timeout (%(timeout)ds) while waiting for project "
 
136
            "%(project)s to be created.")
 
137
 
 
138
    def __init__(self, project, timeout):
 
139
        self.project = project
 
140
        self.timeout = timeout
 
141
 
 
142
 
100
143
def default_config_path():
101
144
    return os.path.join(bedding.config_dir(), 'gitlab.conf')
102
145
 
162
205
        raise NotGitLabUrl(url)
163
206
    path = path.strip('/')
164
207
    parts = path.split('/')
 
208
    if len(parts) < 2:
 
209
        raise NotMergeRequestUrl(host, url)
165
210
    if parts[-2] != 'merge_requests':
166
211
        raise NotMergeRequestUrl(host, url)
167
 
    return host, '/'.join(parts[:-2]), int(parts[-1])
 
212
    if parts[-3] == '-':
 
213
        project_name = '/'.join(parts[:-3])
 
214
    else:
 
215
        project_name = '/'.join(parts[:-2])
 
216
    return host, project_name, int(parts[-1])
 
217
 
 
218
 
 
219
def _unexpected_status(path, response):
 
220
    raise errors.UnexpectedHttpStatus(
 
221
        path, response.status, response.data.decode('utf-8', 'replace'))
168
222
 
169
223
 
170
224
class GitLabMergeProposal(MergeProposal):
205
259
        return self._branch_url_from_project(
206
260
            self._mr['source_project_id'], self._mr['source_branch'])
207
261
 
 
262
    def get_source_revision(self):
 
263
        from breezy.git.mapping import default_mapping
 
264
        sha = self._mr['sha']
 
265
        if sha is None:
 
266
            return None
 
267
        return default_mapping.revision_id_foreign_to_bzr(sha.encode('ascii'))
 
268
 
208
269
    def get_target_branch_url(self):
209
270
        return self._branch_url_from_project(
210
271
            self._mr['target_project_id'], self._mr['target_branch'])
240
301
            return False
241
302
        elif self._mr['merge_status'] == 'can_be_merged':
242
303
            return True
 
304
        elif self._mr['merge_status'] in (
 
305
                'unchecked', 'cannot_be_merged_recheck'):
 
306
            # See https://gitlab.com/gitlab-org/gitlab/-/commit/7517105303c for
 
307
            # an explanation of the distinction between unchecked and
 
308
            # cannot_be_merged_recheck
 
309
            return None
243
310
        else:
244
311
            raise ValueError(self._mr['merge_status'])
245
312
 
256
323
        import iso8601
257
324
        return iso8601.parse_date(merged_at)
258
325
 
 
326
    def post_comment(self, body):
 
327
        kwargs = {'body': body}
 
328
        self.gl._post_merge_request_note(
 
329
            self._mr['project_id'], self._mr['iid'], kwargs)
 
330
 
259
331
 
260
332
def gitlab_url_to_bzr_url(url, name):
261
333
    return git_url_to_bzr_url(url, branch=name)
266
338
 
267
339
    supports_merge_proposal_labels = True
268
340
    supports_merge_proposal_commit_message = False
 
341
    supports_allow_collaboration = True
269
342
    merge_proposal_description_format = 'markdown'
270
343
 
271
344
    def __repr__(self):
275
348
    def base_url(self):
276
349
        return self.transport.base
277
350
 
 
351
    @property
 
352
    def base_hostname(self):
 
353
        return urlutils.parse_url(self.base_url)[3]
 
354
 
 
355
    def _find_correct_project_name(self, path):
 
356
        try:
 
357
            resp = self.transport.request(
 
358
                'GET', urlutils.join(self.base_url, path),
 
359
                headers=self.headers)
 
360
        except errors.RedirectRequested as e:
 
361
            return urlutils.parse_url(e.target)[-1].strip('/')
 
362
        if resp.status != 200:
 
363
            _unexpected_status(path, resp)
 
364
        return None
 
365
 
278
366
    def _api_request(self, method, path, fields=None, body=None):
279
367
        return self.transport.request(
280
368
            method, urlutils.join(self.base_url, 'api', 'v4', path),
292
380
            raise KeyError('no such user %s' % username)
293
381
        if response.status == 200:
294
382
            return json.loads(response.data)
295
 
        raise errors.InvalidHttpResponse(path, response.text)
 
383
        _unexpected_status(path, response)
296
384
 
297
385
    def _get_user_by_email(self, email):
298
386
        path = 'users?search=%s' % urlutils.quote(str(email), '')
304
392
            if len(ret) != 1:
305
393
                raise ValueError('unexpected number of results; %r' % ret)
306
394
            return ret[0]
307
 
        raise errors.InvalidHttpResponse(path, response.text)
 
395
        _unexpected_status(path, response)
308
396
 
309
 
    def _get_project(self, project_name):
 
397
    def _get_project(self, project_name, _redirect_checked=False):
310
398
        path = 'projects/%s' % urlutils.quote(str(project_name), '')
311
399
        response = self._api_request('GET', path)
312
400
        if response.status == 404:
 
401
            if not _redirect_checked:
 
402
                project_name = self._find_correct_project_name(project_name)
 
403
                if project_name is not None:
 
404
                    return self._get_project(project_name, _redirect_checked=True)
313
405
            raise NoSuchProject(project_name)
314
406
        if response.status == 200:
315
407
            return json.loads(response.data)
316
 
        raise errors.InvalidHttpResponse(path, response.text)
 
408
        _unexpected_status(path, response)
317
409
 
318
 
    def _fork_project(self, project_name, timeout=50, interval=5):
 
410
    def _fork_project(self, project_name, timeout=50, interval=5, owner=None):
319
411
        path = 'projects/%s/fork' % urlutils.quote(str(project_name), '')
320
 
        response = self._api_request('POST', path)
 
412
        fields = {}
 
413
        if owner is not None:
 
414
            fields['namespace'] = owner
 
415
        response = self._api_request('POST', path, fields=fields)
 
416
        if response.status == 404:
 
417
            raise ForkingDisabled(project_name)
 
418
        if response.status == 409:
 
419
            resp = json.loads(response.data)
 
420
            raise GitLabConflict(resp.get('message'))
321
421
        if response.status not in (200, 201):
322
 
            raise errors.InvalidHttpResponse(path, response.text)
 
422
            _unexpected_status(path, response)
323
423
        # The response should be valid JSON, but let's ignore it
324
424
        project = json.loads(response.data)
325
425
        # Spin and wait until import_status for new project
328
428
        while project['import_status'] not in ('finished', 'none'):
329
429
            mutter('import status is %s', project['import_status'])
330
430
            if time.time() > deadline:
331
 
                raise Exception('timeout waiting for project to become available')
 
431
                raise ProjectCreationTimeout(
 
432
                    project['path_with_namespace'], timeout)
332
433
            time.sleep(interval)
333
434
            project = self._get_project(project['path_with_namespace'])
334
435
        return project
335
436
 
336
 
    def _get_logged_in_username(self):
 
437
    def get_current_user(self):
337
438
        return self._current_user['username']
338
439
 
 
440
    def get_user_url(self, username):
 
441
        return urlutils.join(self.base_url, username)
 
442
 
339
443
    def _list_paged(self, path, parameters=None, per_page=None):
340
444
        if parameters is None:
341
445
            parameters = {}
352
456
            if response.status == 403:
353
457
                raise errors.PermissionDenied(response.text)
354
458
            if response.status != 200:
355
 
                raise errors.InvalidHttpResponse(path, response.text)
 
459
                _unexpected_status(path, response)
356
460
            page = response.getheader("X-Next-Page")
357
461
            for entry in json.loads(response.data):
358
462
                yield entry
359
463
 
360
 
    def _list_merge_requests(self, owner=None, project=None, state=None):
 
464
    def _list_merge_requests(self, author=None, project=None, state=None):
361
465
        if project is not None:
362
466
            path = 'projects/%s/merge_requests' % urlutils.quote(str(project), '')
363
467
        else:
365
469
        parameters = {}
366
470
        if state:
367
471
            parameters['state'] = state
368
 
        if owner:
369
 
            parameters['owner_id'] = urlutils.quote(owner, '')
 
472
        if author:
 
473
            parameters['author_username'] = urlutils.quote(author, '')
370
474
        return self._list_paged(path, parameters, per_page=DEFAULT_PAGE_SIZE)
371
475
 
 
476
    def _get_merge_request(self, project, merge_id):
 
477
        path = 'projects/%s/merge_requests/%d' % (urlutils.quote(str(project), ''), merge_id)
 
478
        response = self._api_request('GET', path)
 
479
        if response.status == 403:
 
480
            raise errors.PermissionDenied(response.text)
 
481
        if response.status != 200:
 
482
            _unexpected_status(path, response)
 
483
        return json.loads(response.data)
 
484
 
372
485
    def _list_projects(self, owner):
373
486
        path = 'users/%s/projects' % urlutils.quote(str(owner), '')
374
487
        parameters = {}
380
493
        response = self._api_request('PUT', path, fields=mr)
381
494
        if response.status == 200:
382
495
            return json.loads(response.data)
383
 
        raise errors.InvalidHttpResponse(path, response.text)
 
496
        if response.status == 403:
 
497
            raise errors.PermissionDenied(response.text)
 
498
        _unexpected_status(path, response)
 
499
 
 
500
    def _post_merge_request_note(self, project_id, iid, kwargs):
 
501
        path = 'projects/%s/merge_requests/%s/notes' % (
 
502
            urlutils.quote(str(project_id), ''), iid)
 
503
        response = self._api_request('POST', path, fields=kwargs)
 
504
        if response.status == 201:
 
505
            json.loads(response.data)
 
506
            return
 
507
        if response.status == 403:
 
508
            raise errors.PermissionDenied(response.text)
 
509
        _unexpected_status(path, response)
384
510
 
385
511
    def _create_mergerequest(
386
512
            self, title, source_project_id, target_project_id,
387
513
            source_branch_name, target_branch_name, description,
388
 
            labels=None):
 
514
            labels=None, allow_collaboration=False):
389
515
        path = 'projects/%s/merge_requests' % source_project_id
390
516
        fields = {
391
517
            'title': title,
393
519
            'target_branch': target_branch_name,
394
520
            'target_project_id': target_project_id,
395
521
            'description': description,
 
522
            'allow_collaboration': allow_collaboration,
396
523
            }
397
524
        if labels:
398
525
            fields['labels'] = labels
400
527
        if response.status == 403:
401
528
            raise errors.PermissionDenied(response.text)
402
529
        if response.status == 409:
403
 
            raise MergeProposalExists(self.source_branch.user_url)
 
530
            raise MergeRequestConflict(json.loads(response.data))
 
531
        if response.status == 422:
 
532
            data = json.loads(response.data)
 
533
            raise GitLabUnprocessable(data['error'])
404
534
        if response.status != 201:
405
 
            raise errors.InvalidHttpResponse(path, response.text)
 
535
            _unexpected_status(path, response)
406
536
        return json.loads(response.data)
407
537
 
408
538
    def get_push_url(self, branch):
413
543
 
414
544
    def publish_derived(self, local_branch, base_branch, name, project=None,
415
545
                        owner=None, revision_id=None, overwrite=False,
416
 
                        allow_lossy=True):
417
 
        (host, base_project, base_branch_name) = parse_gitlab_branch_url(base_branch)
418
 
        if owner is None:
419
 
            owner = self._get_logged_in_username()
 
546
                        allow_lossy=True, tag_selector=None):
 
547
        (host, base_project_name, base_branch_name) = parse_gitlab_branch_url(base_branch)
 
548
        if owner is None:
 
549
            owner = base_branch.get_config_stack().get('fork-namespace')
 
550
        if owner is None:
 
551
            owner = self.get_current_user()
 
552
        base_project = self._get_project(base_project_name)
420
553
        if project is None:
421
 
            project = self._get_project(base_project)['path']
 
554
            project = base_project['path']
422
555
        try:
423
556
            target_project = self._get_project('%s/%s' % (owner, project))
424
557
        except NoSuchProject:
425
 
            target_project = self._fork_project(base_project)
 
558
            target_project = self._fork_project(
 
559
                base_project['path_with_namespace'], owner=owner)
426
560
        remote_repo_url = git_url_to_bzr_url(target_project['ssh_url_to_repo'])
427
561
        remote_dir = controldir.ControlDir.open(remote_repo_url)
428
562
        try:
429
563
            push_result = remote_dir.push_branch(
430
564
                local_branch, revision_id=revision_id, overwrite=overwrite,
431
 
                name=name)
 
565
                name=name, tag_selector=tag_selector)
432
566
        except errors.NoRoundtrippingSupport:
433
567
            if not allow_lossy:
434
568
                raise
435
569
            push_result = remote_dir.push_branch(
436
570
                local_branch, revision_id=revision_id, overwrite=overwrite,
437
 
                name=name, lossy=True)
 
571
                name=name, lossy=True, tag_selector=tag_selector)
438
572
        public_url = gitlab_url_to_bzr_url(
439
573
            target_project['http_url_to_repo'], name)
440
574
        return push_result.target_branch, public_url
442
576
    def get_derived_branch(self, base_branch, name, project=None, owner=None):
443
577
        (host, base_project, base_branch_name) = parse_gitlab_branch_url(base_branch)
444
578
        if owner is None:
445
 
            owner = self._get_logged_in_username()
 
579
            owner = self.get_current_user()
446
580
        if project is None:
447
581
            project = self._get_project(base_project)['path']
448
582
        try:
479
613
            (host, project, branch_name) = parse_gitlab_branch_url(branch)
480
614
        except NotGitLabUrl:
481
615
            return False
482
 
        return (self.base_url == ('https://%s' % host))
 
616
        return self.base_hostname == host
483
617
 
484
618
    def check(self):
485
619
        response = self._api_request('GET', 'user')
491
625
                raise GitLabLoginMissing()
492
626
            else:
493
627
                raise GitlabLoginError(response.text)
494
 
        raise UnsupportedHoster(url)
 
628
        raise UnsupportedHoster(self.base_url)
495
629
 
496
630
    @classmethod
497
631
    def probe_from_url(cls, url, possible_transports=None):
515
649
                get_transport(credentials['url']),
516
650
                private_token=credentials.get('private_token'))
517
651
 
518
 
    def iter_my_proposals(self, status='open'):
 
652
    def iter_my_proposals(self, status='open', author=None):
 
653
        if author is None:
 
654
            author = self.get_current_user()
519
655
        state = mp_status_to_status(status)
520
 
        for mp in self._list_merge_requests(
521
 
                owner=self._get_logged_in_username(), state=state):
 
656
        for mp in self._list_merge_requests(author=author, state=state):
522
657
            yield GitLabMergeProposal(self, mp)
523
658
 
524
 
    def iter_my_forks(self):
525
 
        for project in self._list_projects(owner=self._get_logged_in_username()):
 
659
    def iter_my_forks(self, owner=None):
 
660
        if owner is not None:
 
661
            owner = self.get_current_user()
 
662
        for project in self._list_projects(owner=owner):
526
663
            base_project = project.get('forked_from_project')
527
664
            if not base_project:
528
665
                continue
534
671
        except NotGitLabUrl:
535
672
            raise UnsupportedHoster(url)
536
673
        except NotMergeRequestUrl as e:
537
 
            if self.base_url == ('https://%s' % e.host):
 
674
            if self.base_hostname == e.host:
538
675
                raise
539
676
            else:
540
677
                raise UnsupportedHoster(url)
541
 
        if self.base_url != ('https://%s' % host):
 
678
        if self.base_hostname != host:
542
679
            raise UnsupportedHoster(url)
543
680
        project = self._get_project(project)
544
 
        mr = project.mergerequests.get(merge_id)
545
 
        return GitLabMergeProposal(mr)
 
681
        mr = self._get_merge_request(project['path_with_namespace'], merge_id)
 
682
        return GitLabMergeProposal(self, mr)
546
683
 
547
684
    def delete_project(self, project):
548
685
        path = 'projects/%s' % urlutils.quote(str(project), '')
550
687
        if response.status == 404:
551
688
            raise NoSuchProject(project)
552
689
        if response.status != 202:
553
 
            raise errors.InvalidHttpResponse(path, response.text)
 
690
            _unexpected_status(path, response)
554
691
 
555
692
 
556
693
class GitlabMergeProposalBuilder(MergeProposalBuilder):
583
720
 
584
721
    def create_proposal(self, description, reviewers=None, labels=None,
585
722
                        prerequisite_branch=None, commit_message=None,
586
 
                        work_in_progress=False):
 
723
                        work_in_progress=False, allow_collaboration=False):
587
724
        """Perform the submission."""
588
725
        # https://docs.gitlab.com/ee/api/merge_requests.html#create-mr
589
726
        if prerequisite_branch is not None:
595
732
        title = determine_title(description)
596
733
        if work_in_progress:
597
734
            title = 'WIP: %s' % title
598
 
        # TODO(jelmer): Allow setting allow_collaboration field
599
735
        # TODO(jelmer): Allow setting milestone field
600
736
        # TODO(jelmer): Allow setting squash field
601
737
        kwargs = {
604
740
            'target_project_id': target_project['id'],
605
741
            'source_branch_name': self.source_branch_name,
606
742
            'target_branch_name': self.target_branch_name,
607
 
            'description': description}
 
743
            'description': description,
 
744
            'allow_collaboration': allow_collaboration}
608
745
        if labels:
609
746
            kwargs['labels'] = ','.join(labels)
610
747
        if reviewers:
615
752
                else:
616
753
                    user = self.gl._get_user(reviewer)
617
754
                kwargs['assignee_ids'].append(user['id'])
618
 
        merge_request = self.gl._create_mergerequest(**kwargs)
 
755
        try:
 
756
            merge_request = self.gl._create_mergerequest(**kwargs)
 
757
        except MergeRequestConflict as e:
 
758
            m = re.fullmatch(
 
759
                r'Another open merge request already exists for '
 
760
                r'this source branch: \!([0-9]+)',
 
761
                e.reason['message'][0])
 
762
            if m:
 
763
                merge_id = int(m.group(1))
 
764
                mr = self.gl._get_merge_request(
 
765
                    target_project['path_with_namespace'], merge_id)
 
766
                raise MergeProposalExists(
 
767
                    self.source_branch.user_url, GitLabMergeProposal(self.gl, mr))
 
768
            raise Exception('conflict: %r' % e.reason)
 
769
        except GitLabUnprocessable as e:
 
770
            if e.error == [
 
771
                    "Source project is not a fork of the target project"]:
 
772
                raise SourceNotDerivedFromTarget(
 
773
                    self.source_branch, self.target_branch)
619
774
        return GitLabMergeProposal(self.gl, merge_request)
620
775
 
621
776