/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: Jelmer Vernooij
  • Date: 2020-07-05 12:50:01 UTC
  • mfrom: (7490.40.46 work)
  • mto: (7490.40.48 work)
  • mto: This revision was merged to the branch mainline in revision 7519.
  • Revision ID: jelmer@jelmer.uk-20200705125001-7s3vo0p55szbbws7
Merge lp:brz/3.1.

Show diffs side-by-side

added added

removed removed

Lines of Context:
16
16
 
17
17
"""Support for GitLab."""
18
18
 
 
19
from __future__ import absolute_import
 
20
 
19
21
import json
20
22
import os
21
 
import re
22
23
import time
23
24
 
24
25
from ... import (
29
30
    urlutils,
30
31
    )
31
32
from ...git.urls import git_url_to_bzr_url
 
33
from ...sixish import PY3
32
34
from ...trace import mutter
33
35
from ...transport import get_transport
34
36
 
40
42
    MergeProposalExists,
41
43
    NoSuchProject,
42
44
    PrerequisiteBranchUnsupported,
43
 
    SourceNotDerivedFromTarget,
44
45
    UnsupportedHoster,
45
46
    )
46
47
 
76
77
        self.url = url
77
78
 
78
79
 
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
 
 
87
80
class DifferentGitLabInstances(errors.BzrError):
88
81
 
89
82
    _fmt = ("Can't create merge proposals across GitLab instances: "
107
100
        self.error = error
108
101
 
109
102
 
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
103
class ForkingDisabled(errors.BzrError):
119
104
 
120
105
    _fmt = ("Forking on project %(project)s is disabled.")
123
108
        self.project = project
124
109
 
125
110
 
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
 
111
class MergeRequestExists(Exception):
 
112
    """Raised when a merge requests already exists."""
141
113
 
142
114
 
143
115
def default_config_path():
216
188
    return host, project_name, int(parts[-1])
217
189
 
218
190
 
219
 
def _unexpected_status(path, response):
220
 
    raise errors.UnexpectedHttpStatus(
221
 
        path, response.status, response.data.decode('utf-8', 'replace'))
222
 
 
223
 
 
224
191
class GitLabMergeProposal(MergeProposal):
225
192
 
226
193
    def __init__(self, gl, mr):
330
297
 
331
298
 
332
299
def gitlab_url_to_bzr_url(url, name):
 
300
    if not PY3:
 
301
        name = name.encode('utf-8')
333
302
    return git_url_to_bzr_url(url, branch=name)
334
303
 
335
304
 
352
321
    def base_hostname(self):
353
322
        return urlutils.parse_url(self.base_url)[3]
354
323
 
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
 
 
366
324
    def _api_request(self, method, path, fields=None, body=None):
367
325
        return self.transport.request(
368
326
            method, urlutils.join(self.base_url, 'api', 'v4', path),
380
338
            raise KeyError('no such user %s' % username)
381
339
        if response.status == 200:
382
340
            return json.loads(response.data)
383
 
        _unexpected_status(path, response)
 
341
        raise errors.InvalidHttpResponse(path, response.text)
384
342
 
385
343
    def _get_user_by_email(self, email):
386
344
        path = 'users?search=%s' % urlutils.quote(str(email), '')
392
350
            if len(ret) != 1:
393
351
                raise ValueError('unexpected number of results; %r' % ret)
394
352
            return ret[0]
395
 
        _unexpected_status(path, response)
 
353
        raise errors.InvalidHttpResponse(path, response.text)
396
354
 
397
 
    def _get_project(self, project_name, _redirect_checked=False):
 
355
    def _get_project(self, project_name):
398
356
        path = 'projects/%s' % urlutils.quote(str(project_name), '')
399
357
        response = self._api_request('GET', path)
400
358
        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)
405
359
            raise NoSuchProject(project_name)
406
360
        if response.status == 200:
407
361
            return json.loads(response.data)
408
 
        _unexpected_status(path, response)
 
362
        raise errors.InvalidHttpResponse(path, response.text)
409
363
 
410
 
    def _fork_project(self, project_name, timeout=50, interval=5, owner=None):
 
364
    def _fork_project(self, project_name, timeout=50, interval=5):
411
365
        path = 'projects/%s/fork' % urlutils.quote(str(project_name), '')
412
 
        fields = {}
413
 
        if owner is not None:
414
 
            fields['namespace'] = owner
415
 
        response = self._api_request('POST', path, fields=fields)
 
366
        response = self._api_request('POST', path)
416
367
        if response.status == 404:
417
368
            raise ForkingDisabled(project_name)
418
 
        if response.status == 409:
419
 
            resp = json.loads(response.data)
420
 
            raise GitLabConflict(resp.get('message'))
421
369
        if response.status not in (200, 201):
422
 
            _unexpected_status(path, response)
 
370
            raise errors.InvalidHttpResponse(path, response.text)
423
371
        # The response should be valid JSON, but let's ignore it
424
372
        project = json.loads(response.data)
425
373
        # Spin and wait until import_status for new project
428
376
        while project['import_status'] not in ('finished', 'none'):
429
377
            mutter('import status is %s', project['import_status'])
430
378
            if time.time() > deadline:
431
 
                raise ProjectCreationTimeout(
432
 
                    project['path_with_namespace'], timeout)
 
379
                raise Exception('timeout waiting for project to become available')
433
380
            time.sleep(interval)
434
381
            project = self._get_project(project['path_with_namespace'])
435
382
        return project
436
383
 
437
 
    def get_current_user(self):
 
384
    def _get_logged_in_username(self):
438
385
        return self._current_user['username']
439
386
 
440
 
    def get_user_url(self, username):
441
 
        return urlutils.join(self.base_url, username)
442
 
 
443
387
    def _list_paged(self, path, parameters=None, per_page=None):
444
388
        if parameters is None:
445
389
            parameters = {}
456
400
            if response.status == 403:
457
401
                raise errors.PermissionDenied(response.text)
458
402
            if response.status != 200:
459
 
                _unexpected_status(path, response)
 
403
                raise errors.InvalidHttpResponse(path, response.text)
460
404
            page = response.getheader("X-Next-Page")
461
405
            for entry in json.loads(response.data):
462
406
                yield entry
463
407
 
464
 
    def _list_merge_requests(self, author=None, project=None, state=None):
 
408
    def _list_merge_requests(self, owner=None, project=None, state=None):
465
409
        if project is not None:
466
410
            path = 'projects/%s/merge_requests' % urlutils.quote(str(project), '')
467
411
        else:
469
413
        parameters = {}
470
414
        if state:
471
415
            parameters['state'] = state
472
 
        if author:
473
 
            parameters['author_username'] = urlutils.quote(author, '')
 
416
        if owner:
 
417
            parameters['owner_id'] = urlutils.quote(owner, '')
474
418
        return self._list_paged(path, parameters, per_page=DEFAULT_PAGE_SIZE)
475
419
 
476
420
    def _get_merge_request(self, project, merge_id):
479
423
        if response.status == 403:
480
424
            raise errors.PermissionDenied(response.text)
481
425
        if response.status != 200:
482
 
            _unexpected_status(path, response)
 
426
            raise errors.InvalidHttpResponse(path, response.text)
483
427
        return json.loads(response.data)
484
428
 
485
429
    def _list_projects(self, owner):
493
437
        response = self._api_request('PUT', path, fields=mr)
494
438
        if response.status == 200:
495
439
            return json.loads(response.data)
496
 
        if response.status == 403:
497
 
            raise errors.PermissionDenied(response.text)
498
 
        _unexpected_status(path, response)
 
440
        raise errors.InvalidHttpResponse(path, response.text)
499
441
 
500
442
    def _post_merge_request_note(self, project_id, iid, kwargs):
501
443
        path = 'projects/%s/merge_requests/%s/notes' % (
504
446
        if response.status == 201:
505
447
            json.loads(response.data)
506
448
            return
507
 
        if response.status == 403:
508
 
            raise errors.PermissionDenied(response.text)
509
 
        _unexpected_status(path, response)
 
449
        raise errors.InvalidHttpResponse(path, response.text)
510
450
 
511
451
    def _create_mergerequest(
512
452
            self, title, source_project_id, target_project_id,
527
467
        if response.status == 403:
528
468
            raise errors.PermissionDenied(response.text)
529
469
        if response.status == 409:
530
 
            raise MergeRequestConflict(json.loads(response.data))
531
 
        if response.status == 422:
532
 
            data = json.loads(response.data)
533
 
            raise GitLabUnprocessable(data['error'])
 
470
            raise MergeRequestExists()
534
471
        if response.status != 201:
535
 
            _unexpected_status(path, response)
 
472
            raise errors.InvalidHttpResponse(path, response.text)
536
473
        return json.loads(response.data)
537
474
 
538
475
    def get_push_url(self, branch):
544
481
    def publish_derived(self, local_branch, base_branch, name, project=None,
545
482
                        owner=None, revision_id=None, overwrite=False,
546
483
                        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)
 
484
        (host, base_project, base_branch_name) = parse_gitlab_branch_url(base_branch)
 
485
        if owner is None:
 
486
            owner = self._get_logged_in_username()
553
487
        if project is None:
554
 
            project = base_project['path']
 
488
            project = self._get_project(base_project)['path']
555
489
        try:
556
490
            target_project = self._get_project('%s/%s' % (owner, project))
557
491
        except NoSuchProject:
558
 
            target_project = self._fork_project(
559
 
                base_project['path_with_namespace'], owner=owner)
 
492
            target_project = self._fork_project(base_project)
560
493
        remote_repo_url = git_url_to_bzr_url(target_project['ssh_url_to_repo'])
561
494
        remote_dir = controldir.ControlDir.open(remote_repo_url)
562
495
        try:
576
509
    def get_derived_branch(self, base_branch, name, project=None, owner=None):
577
510
        (host, base_project, base_branch_name) = parse_gitlab_branch_url(base_branch)
578
511
        if owner is None:
579
 
            owner = self.get_current_user()
 
512
            owner = self._get_logged_in_username()
580
513
        if project is None:
581
514
            project = self._get_project(base_project)['path']
582
515
        try:
625
558
                raise GitLabLoginMissing()
626
559
            else:
627
560
                raise GitlabLoginError(response.text)
628
 
        raise UnsupportedHoster(self.base_url)
 
561
        raise UnsupportedHoster(url)
629
562
 
630
563
    @classmethod
631
564
    def probe_from_url(cls, url, possible_transports=None):
649
582
                get_transport(credentials['url']),
650
583
                private_token=credentials.get('private_token'))
651
584
 
652
 
    def iter_my_proposals(self, status='open', author=None):
653
 
        if author is None:
654
 
            author = self.get_current_user()
 
585
    def iter_my_proposals(self, status='open'):
655
586
        state = mp_status_to_status(status)
656
 
        for mp in self._list_merge_requests(author=author, state=state):
 
587
        for mp in self._list_merge_requests(
 
588
                owner=self._get_logged_in_username(), state=state):
657
589
            yield GitLabMergeProposal(self, mp)
658
590
 
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):
 
591
    def iter_my_forks(self):
 
592
        for project in self._list_projects(owner=self._get_logged_in_username()):
663
593
            base_project = project.get('forked_from_project')
664
594
            if not base_project:
665
595
                continue
687
617
        if response.status == 404:
688
618
            raise NoSuchProject(project)
689
619
        if response.status != 202:
690
 
            _unexpected_status(path, response)
 
620
            raise errors.InvalidHttpResponse(path, response.text)
691
621
 
692
622
 
693
623
class GitlabMergeProposalBuilder(MergeProposalBuilder):
754
684
                kwargs['assignee_ids'].append(user['id'])
755
685
        try:
756
686
            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)
 
687
        except MergeRequestExists:
 
688
            raise MergeProposalExists(self.source_branch.user_url)
774
689
        return GitLabMergeProposal(self.gl, merge_request)
775
690
 
776
691