1
# Copyright (C) 2018 Breezy Developers
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.
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.
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
17
"""Support for GitLab."""
19
from __future__ import absolute_import
27
branch as _mod_branch,
32
from ...git.urls import git_url_to_bzr_url
33
from ...sixish import PY3
34
from ...trace import mutter
35
from ...transport import get_transport
37
from ...propose import (
44
PrerequisiteBranchUnsupported,
49
_DEFAULT_FILES = ['/etc/python-gitlab.cfg', '~/.python-gitlab.cfg']
50
DEFAULT_PAGE_SIZE = 50
53
def mp_status_to_status(status):
58
'closed': 'closed'}[status]
61
class NotGitLabUrl(errors.BzrError):
63
_fmt = "Not a GitLab URL: %(url)s"
65
def __init__(self, url):
66
errors.BzrError.__init__(self)
70
class NotMergeRequestUrl(errors.BzrError):
72
_fmt = "Not a merge proposal URL: %(url)s"
74
def __init__(self, host, url):
75
errors.BzrError.__init__(self)
80
class DifferentGitLabInstances(errors.BzrError):
82
_fmt = ("Can't create merge proposals across GitLab instances: "
83
"%(source_host)s and %(target_host)s")
85
def __init__(self, source_host, target_host):
86
self.source_host = source_host
87
self.target_host = target_host
90
class GitLabLoginMissing(errors.BzrError):
92
_fmt = ("Please log into GitLab")
95
class GitlabLoginError(errors.BzrError):
97
_fmt = ("Error logging in: %(error)s")
99
def __init__(self, error):
103
class ForkingDisabled(errors.BzrError):
105
_fmt = ("Forking on project %(project)s is disabled.")
107
def __init__(self, project):
108
self.project = project
111
class MergeRequestExists(Exception):
112
"""Raised when a merge requests already exists."""
115
def default_config_path():
116
return os.path.join(bedding.config_dir(), 'gitlab.conf')
119
def store_gitlab_token(name, url, private_token):
120
"""Store a GitLab token in a configuration file."""
122
config = configparser.ConfigParser()
123
path = default_config_path()
125
config.add_section(name)
126
config[name]['url'] = url
127
config[name]['private_token'] = private_token
128
with open(path, 'w') as f:
134
config = configparser.ConfigParser()
136
[os.path.expanduser(p) for p in _DEFAULT_FILES] +
137
[default_config_path()])
138
for name, section in config.items():
142
def get_credentials_by_url(url):
143
for name, credentials in iter_tokens():
144
if 'url' not in credentials:
146
if credentials['url'].rstrip('/') == url.rstrip('/'):
152
def parse_gitlab_url(url):
153
(scheme, user, password, host, port, path) = urlutils.parse_url(
155
if scheme not in ('git+ssh', 'https', 'http'):
156
raise NotGitLabUrl(url)
158
raise NotGitLabUrl(url)
159
path = path.strip('/')
160
if path.endswith('.git'):
165
def parse_gitlab_branch_url(branch):
166
url = urlutils.strip_segment_parameters(branch.user_url)
167
host, path = parse_gitlab_url(url)
168
return host, path, branch.name
171
def parse_gitlab_merge_request_url(url):
172
(scheme, user, password, host, port, path) = urlutils.parse_url(
174
if scheme not in ('git+ssh', 'https', 'http'):
175
raise NotGitLabUrl(url)
177
raise NotGitLabUrl(url)
178
path = path.strip('/')
179
parts = path.split('/')
181
raise NotMergeRequestUrl(host, url)
182
if parts[-2] != 'merge_requests':
183
raise NotMergeRequestUrl(host, url)
185
project_name = '/'.join(parts[:-3])
187
project_name = '/'.join(parts[:-2])
188
return host, project_name, int(parts[-1])
191
class GitLabMergeProposal(MergeProposal):
193
def __init__(self, gl, mr):
197
def _update(self, **kwargs):
198
self.gl._update_merge_request(self._mr['project_id'], self._mr['iid'], kwargs)
201
return "<%s at %r>" % (type(self).__name__, self._mr['web_url'])
205
return self._mr['web_url']
207
def get_description(self):
208
return self._mr['description']
210
def set_description(self, description):
211
self._update(description=description, title=determine_title(description))
213
def get_commit_message(self):
214
return self._mr.get('merge_commit_message')
216
def set_commit_message(self, message):
217
raise errors.UnsupportedOperation(self.set_commit_message, self)
219
def _branch_url_from_project(self, project_id, branch_name):
220
if project_id is None:
222
project = self.gl._get_project(project_id)
223
return gitlab_url_to_bzr_url(project['http_url_to_repo'], branch_name)
225
def get_source_branch_url(self):
226
return self._branch_url_from_project(
227
self._mr['source_project_id'], self._mr['source_branch'])
229
def get_source_revision(self):
230
from breezy.git.mapping import default_mapping
231
sha = self._mr['sha']
234
return default_mapping.revision_id_foreign_to_bzr(sha.encode('ascii'))
236
def get_target_branch_url(self):
237
return self._branch_url_from_project(
238
self._mr['target_project_id'], self._mr['target_branch'])
240
def _get_project_name(self, project_id):
241
source_project = self.gl._get_project(project_id)
242
return source_project['path_with_namespace']
244
def get_source_project(self):
245
return self._get_project_name(self._mr['source_project_id'])
247
def get_target_project(self):
248
return self._get_project_name(self._mr['target_project_id'])
251
return (self._mr['state'] == 'merged')
254
return (self._mr['state'] == 'closed')
257
return self._update(state_event='reopen')
260
self._update(state_event='close')
262
def merge(self, commit_message=None):
263
# https://docs.gitlab.com/ee/api/merge_requests.html#accept-mr
264
self._mr.merge(merge_commit_message=commit_message)
266
def can_be_merged(self):
267
if self._mr['merge_status'] == 'cannot_be_merged':
269
elif self._mr['merge_status'] == 'can_be_merged':
271
elif self._mr['merge_status'] in (
272
'unchecked', 'cannot_be_merged_recheck'):
273
# See https://gitlab.com/gitlab-org/gitlab/-/commit/7517105303c for
274
# an explanation of the distinction between unchecked and
275
# cannot_be_merged_recheck
278
raise ValueError(self._mr['merge_status'])
280
def get_merged_by(self):
281
user = self._mr.get('merged_by')
284
return user['username']
286
def get_merged_at(self):
287
merged_at = self._mr.get('merged_at')
288
if merged_at is None:
291
return iso8601.parse_date(merged_at)
293
def post_comment(self, body):
294
kwargs = {'body': body}
295
self.gl._post_merge_request_note(
296
self._mr['project_id'], self._mr['iid'], kwargs)
299
def gitlab_url_to_bzr_url(url, name):
301
name = name.encode('utf-8')
302
return git_url_to_bzr_url(url, branch=name)
305
class GitLab(Hoster):
306
"""GitLab hoster implementation."""
308
supports_merge_proposal_labels = True
309
supports_merge_proposal_commit_message = False
310
supports_allow_collaboration = True
311
merge_proposal_description_format = 'markdown'
314
return "<GitLab(%r)>" % self.base_url
318
return self.transport.base
321
def base_hostname(self):
322
return urlutils.parse_url(self.base_url)[3]
324
def _api_request(self, method, path, fields=None, body=None):
325
return self.transport.request(
326
method, urlutils.join(self.base_url, 'api', 'v4', path),
327
headers=self.headers, fields=fields, body=body)
329
def __init__(self, transport, private_token):
330
self.transport = transport
331
self.headers = {"Private-Token": private_token}
334
def _get_user(self, username):
335
path = 'users/%s' % urlutils.quote(str(username), '')
336
response = self._api_request('GET', path)
337
if response.status == 404:
338
raise KeyError('no such user %s' % username)
339
if response.status == 200:
340
return json.loads(response.data)
341
raise errors.UnexpectedHttpStatus(path, response.status)
343
def _get_user_by_email(self, email):
344
path = 'users?search=%s' % urlutils.quote(str(email), '')
345
response = self._api_request('GET', path)
346
if response.status == 404:
347
raise KeyError('no such user %s' % email)
348
if response.status == 200:
349
ret = json.loads(response.data)
351
raise ValueError('unexpected number of results; %r' % ret)
353
raise errors.UnexpectedHttpStatus(path, response.status)
355
def _get_project(self, project_name):
356
path = 'projects/%s' % urlutils.quote(str(project_name), '')
357
response = self._api_request('GET', path)
358
if response.status == 404:
359
raise NoSuchProject(project_name)
360
if response.status == 200:
361
return json.loads(response.data)
362
raise errors.UnexpectedHttpStatus(path, response.status)
364
def _fork_project(self, project_name, timeout=50, interval=5):
365
path = 'projects/%s/fork' % urlutils.quote(str(project_name), '')
366
response = self._api_request('POST', path)
367
if response.status == 404:
368
raise ForkingDisabled(project_name)
369
if response.status not in (200, 201):
370
raise errors.UnexpectedHttpStatus(path, response.status)
371
# The response should be valid JSON, but let's ignore it
372
project = json.loads(response.data)
373
# Spin and wait until import_status for new project
375
deadline = time.time() + timeout
376
while project['import_status'] not in ('finished', 'none'):
377
mutter('import status is %s', project['import_status'])
378
if time.time() > deadline:
379
raise Exception('timeout waiting for project to become available')
381
project = self._get_project(project['path_with_namespace'])
384
def _get_logged_in_username(self):
385
return self._current_user['username']
387
def _list_paged(self, path, parameters=None, per_page=None):
388
if parameters is None:
391
parameters = dict(parameters.items())
393
parameters['per_page'] = str(per_page)
396
parameters['page'] = page
397
response = self._api_request(
399
';'.join(['%s=%s' % item for item in parameters.items()]))
400
if response.status == 403:
401
raise errors.PermissionDenied(response.text)
402
if response.status != 200:
403
raise errors.UnexpectedHttpStatus(path, response.status)
404
page = response.getheader("X-Next-Page")
405
for entry in json.loads(response.data):
408
def _list_merge_requests(self, owner=None, project=None, state=None):
409
if project is not None:
410
path = 'projects/%s/merge_requests' % urlutils.quote(str(project), '')
412
path = 'merge_requests'
415
parameters['state'] = state
417
parameters['owner_id'] = urlutils.quote(owner, '')
418
return self._list_paged(path, parameters, per_page=DEFAULT_PAGE_SIZE)
420
def _get_merge_request(self, project, merge_id):
421
path = 'projects/%s/merge_requests/%d' % (urlutils.quote(str(project), ''), merge_id)
422
response = self._api_request('GET', path)
423
if response.status == 403:
424
raise errors.PermissionDenied(response.text)
425
if response.status != 200:
426
raise errors.UnexpectedHttpStatus(path, response.status
427
return json.loads(response.data)
429
def _list_projects(self, owner):
430
path = 'users/%s/projects' % urlutils.quote(str(owner), '')
432
return self._list_paged(path, parameters, per_page=DEFAULT_PAGE_SIZE)
434
def _update_merge_request(self, project_id, iid, mr):
435
path = 'projects/%s/merge_requests/%s' % (
436
urlutils.quote(str(project_id), ''), iid)
437
response = self._api_request('PUT', path, fields=mr)
438
if response.status == 200:
439
return json.loads(response.data)
440
raise errors.UnexpectedHttpStatus(path, response.status)
442
def _post_merge_request_note(self, project_id, iid, kwargs):
443
path = 'projects/%s/merge_requests/%s/notes' % (
444
urlutils.quote(str(project_id), ''), iid)
445
response = self._api_request('POST', path, fields=kwargs)
446
if response.status == 201:
447
json.loads(response.data)
449
raise errors.UnexpectedHttpStatus(path, response.status)
451
def _create_mergerequest(
452
self, title, source_project_id, target_project_id,
453
source_branch_name, target_branch_name, description,
454
labels=None, allow_collaboration=False):
455
path = 'projects/%s/merge_requests' % source_project_id
458
'source_branch': source_branch_name,
459
'target_branch': target_branch_name,
460
'target_project_id': target_project_id,
461
'description': description,
462
'allow_collaboration': allow_collaboration,
465
fields['labels'] = labels
466
response = self._api_request('POST', path, fields=fields)
467
if response.status == 403:
468
raise errors.PermissionDenied(response.text)
469
if response.status == 409:
470
raise MergeRequestExists()
471
if response.status != 201:
472
raise errors.UnexpectedHttpStatus(path, response.status)
473
return json.loads(response.data)
475
def get_push_url(self, branch):
476
(host, project_name, branch_name) = parse_gitlab_branch_url(branch)
477
project = self._get_project(project_name)
478
return gitlab_url_to_bzr_url(
479
project['ssh_url_to_repo'], branch_name)
481
def publish_derived(self, local_branch, base_branch, name, project=None,
482
owner=None, revision_id=None, overwrite=False,
483
allow_lossy=True, tag_selector=None):
484
(host, base_project, base_branch_name) = parse_gitlab_branch_url(base_branch)
486
owner = self._get_logged_in_username()
488
project = self._get_project(base_project)['path']
490
target_project = self._get_project('%s/%s' % (owner, project))
491
except NoSuchProject:
492
target_project = self._fork_project(base_project)
493
remote_repo_url = git_url_to_bzr_url(target_project['ssh_url_to_repo'])
494
remote_dir = controldir.ControlDir.open(remote_repo_url)
496
push_result = remote_dir.push_branch(
497
local_branch, revision_id=revision_id, overwrite=overwrite,
498
name=name, tag_selector=tag_selector)
499
except errors.NoRoundtrippingSupport:
502
push_result = remote_dir.push_branch(
503
local_branch, revision_id=revision_id, overwrite=overwrite,
504
name=name, lossy=True, tag_selector=tag_selector)
505
public_url = gitlab_url_to_bzr_url(
506
target_project['http_url_to_repo'], name)
507
return push_result.target_branch, public_url
509
def get_derived_branch(self, base_branch, name, project=None, owner=None):
510
(host, base_project, base_branch_name) = parse_gitlab_branch_url(base_branch)
512
owner = self._get_logged_in_username()
514
project = self._get_project(base_project)['path']
516
target_project = self._get_project('%s/%s' % (owner, project))
517
except NoSuchProject:
518
raise errors.NotBranchError('%s/%s/%s' % (self.base_url, owner, project))
519
return _mod_branch.Branch.open(gitlab_url_to_bzr_url(
520
target_project['ssh_url_to_repo'], name))
522
def get_proposer(self, source_branch, target_branch):
523
return GitlabMergeProposalBuilder(self, source_branch, target_branch)
525
def iter_proposals(self, source_branch, target_branch, status):
526
(source_host, source_project_name, source_branch_name) = (
527
parse_gitlab_branch_url(source_branch))
528
(target_host, target_project_name, target_branch_name) = (
529
parse_gitlab_branch_url(target_branch))
530
if source_host != target_host:
531
raise DifferentGitLabInstances(source_host, target_host)
532
source_project = self._get_project(source_project_name)
533
target_project = self._get_project(target_project_name)
534
state = mp_status_to_status(status)
535
for mr in self._list_merge_requests(
536
project=target_project['id'], state=state):
537
if (mr['source_project_id'] != source_project['id'] or
538
mr['source_branch'] != source_branch_name or
539
mr['target_project_id'] != target_project['id'] or
540
mr['target_branch'] != target_branch_name):
542
yield GitLabMergeProposal(self, mr)
544
def hosts(self, branch):
546
(host, project, branch_name) = parse_gitlab_branch_url(branch)
549
return self.base_hostname == host
552
response = self._api_request('GET', 'user')
553
if response.status == 200:
554
self._current_user = json.loads(response.data)
557
if json.loads(response.data) == {"message": "401 Unauthorized"}:
558
raise GitLabLoginMissing()
560
raise GitlabLoginError(response.text)
561
raise UnsupportedHoster(self.base_url)
564
def probe_from_url(cls, url, possible_transports=None):
566
(host, project) = parse_gitlab_url(url)
568
raise UnsupportedHoster(url)
569
transport = get_transport(
570
'https://%s' % host, possible_transports=possible_transports)
571
credentials = get_credentials_by_url(transport.base)
572
if credentials is not None:
573
return cls(transport, credentials.get('private_token'))
574
raise UnsupportedHoster(url)
577
def iter_instances(cls):
578
for name, credentials in iter_tokens():
579
if 'url' not in credentials:
582
get_transport(credentials['url']),
583
private_token=credentials.get('private_token'))
585
def iter_my_proposals(self, status='open'):
586
state = mp_status_to_status(status)
587
for mp in self._list_merge_requests(
588
owner=self._get_logged_in_username(), state=state):
589
yield GitLabMergeProposal(self, mp)
591
def iter_my_forks(self):
592
for project in self._list_projects(owner=self._get_logged_in_username()):
593
base_project = project.get('forked_from_project')
596
yield project['path_with_namespace']
598
def get_proposal_by_url(self, url):
600
(host, project, merge_id) = parse_gitlab_merge_request_url(url)
602
raise UnsupportedHoster(url)
603
except NotMergeRequestUrl as e:
604
if self.base_hostname == e.host:
607
raise UnsupportedHoster(url)
608
if self.base_hostname != host:
609
raise UnsupportedHoster(url)
610
project = self._get_project(project)
611
mr = self._get_merge_request(project['path_with_namespace'], merge_id)
612
return GitLabMergeProposal(self, mr)
614
def delete_project(self, project):
615
path = 'projects/%s' % urlutils.quote(str(project), '')
616
response = self._api_request('DELETE', path)
617
if response.status == 404:
618
raise NoSuchProject(project)
619
if response.status != 202:
620
raise errors.UnexpectedHttpStatus(path, response.status)
623
class GitlabMergeProposalBuilder(MergeProposalBuilder):
625
def __init__(self, gl, source_branch, target_branch):
627
self.source_branch = source_branch
628
(self.source_host, self.source_project_name, self.source_branch_name) = (
629
parse_gitlab_branch_url(source_branch))
630
self.target_branch = target_branch
631
(self.target_host, self.target_project_name, self.target_branch_name) = (
632
parse_gitlab_branch_url(target_branch))
633
if self.source_host != self.target_host:
634
raise DifferentGitLabInstances(self.source_host, self.target_host)
636
def get_infotext(self):
637
"""Determine the initial comment for the merge proposal."""
639
info.append("Gitlab instance: %s\n" % self.target_host)
640
info.append("Source: %s\n" % self.source_branch.user_url)
641
info.append("Target: %s\n" % self.target_branch.user_url)
644
def get_initial_body(self):
645
"""Get a body for the proposal for the user to modify.
647
:return: a str or None.
651
def create_proposal(self, description, reviewers=None, labels=None,
652
prerequisite_branch=None, commit_message=None,
653
work_in_progress=False, allow_collaboration=False):
654
"""Perform the submission."""
655
# https://docs.gitlab.com/ee/api/merge_requests.html#create-mr
656
if prerequisite_branch is not None:
657
raise PrerequisiteBranchUnsupported(self)
658
# Note that commit_message is ignored, since Gitlab doesn't support it.
659
source_project = self.gl._get_project(self.source_project_name)
660
target_project = self.gl._get_project(self.target_project_name)
661
# TODO(jelmer): Allow setting title explicitly
662
title = determine_title(description)
664
title = 'WIP: %s' % title
665
# TODO(jelmer): Allow setting milestone field
666
# TODO(jelmer): Allow setting squash field
669
'source_project_id': source_project['id'],
670
'target_project_id': target_project['id'],
671
'source_branch_name': self.source_branch_name,
672
'target_branch_name': self.target_branch_name,
673
'description': description,
674
'allow_collaboration': allow_collaboration}
676
kwargs['labels'] = ','.join(labels)
678
kwargs['assignee_ids'] = []
679
for reviewer in reviewers:
681
user = self.gl._get_user_by_email(reviewer)
683
user = self.gl._get_user(reviewer)
684
kwargs['assignee_ids'].append(user['id'])
686
merge_request = self.gl._create_mergerequest(**kwargs)
687
except MergeRequestExists:
688
raise MergeProposalExists(self.source_branch.user_url)
689
return GitLabMergeProposal(self.gl, merge_request)
692
def register_gitlab_instance(shortname, url):
693
"""Register a gitlab instance.
695
:param shortname: Short name (e.g. "gitlab")
696
:param url: URL to the gitlab instance
698
from breezy.bugtracker import (
700
ProjectIntegerBugTracker,
702
tracker_registry.register(
703
shortname, ProjectIntegerBugTracker(
704
shortname, url + '/{project}/issues/{id}'))