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
def default_config_path():
104
return os.path.join(bedding.config_dir(), 'gitlab.conf')
107
def store_gitlab_token(name, url, private_token):
108
"""Store a GitLab token in a configuration file."""
110
config = configparser.ConfigParser()
111
path = default_config_path()
113
config.add_section(name)
114
config[name]['url'] = url
115
config[name]['private_token'] = private_token
116
with open(path, 'w') as f:
122
config = configparser.ConfigParser()
124
[os.path.expanduser(p) for p in _DEFAULT_FILES] +
125
[default_config_path()])
126
for name, section in config.items():
130
def get_credentials_by_url(url):
131
for name, credentials in iter_tokens():
132
if 'url' not in credentials:
134
if credentials['url'].rstrip('/') == url.rstrip('/'):
140
def parse_gitlab_url(url):
141
(scheme, user, password, host, port, path) = urlutils.parse_url(
143
if scheme not in ('git+ssh', 'https', 'http'):
144
raise NotGitLabUrl(url)
146
raise NotGitLabUrl(url)
147
path = path.strip('/')
148
if path.endswith('.git'):
153
def parse_gitlab_branch_url(branch):
154
url = urlutils.strip_segment_parameters(branch.user_url)
155
host, path = parse_gitlab_url(url)
156
return host, path, branch.name
159
def parse_gitlab_merge_request_url(url):
160
(scheme, user, password, host, port, path) = urlutils.parse_url(
162
if scheme not in ('git+ssh', 'https', 'http'):
163
raise NotGitLabUrl(url)
165
raise NotGitLabUrl(url)
166
path = path.strip('/')
167
parts = path.split('/')
168
if parts[-2] != 'merge_requests':
169
raise NotMergeRequestUrl(host, url)
170
return host, '/'.join(parts[:-2]), int(parts[-1])
173
class GitLabMergeProposal(MergeProposal):
175
def __init__(self, gl, mr):
179
def _update(self, **kwargs):
180
self.gl._update_merge_request(self._mr['project_id'], self._mr['iid'], kwargs)
183
return "<%s at %r>" % (type(self).__name__, self._mr['web_url'])
187
return self._mr['web_url']
189
def get_description(self):
190
return self._mr['description']
192
def set_description(self, description):
193
self._update(description=description, title=determine_title(description))
195
def get_commit_message(self):
196
return self._mr.get('merge_commit_message')
198
def set_commit_message(self, message):
199
raise errors.UnsupportedOperation(self.set_commit_message, self)
201
def _branch_url_from_project(self, project_id, branch_name):
202
if project_id is None:
204
project = self.gl._get_project(project_id)
205
return gitlab_url_to_bzr_url(project['http_url_to_repo'], branch_name)
207
def get_source_branch_url(self):
208
return self._branch_url_from_project(
209
self._mr['source_project_id'], self._mr['source_branch'])
211
def get_target_branch_url(self):
212
return self._branch_url_from_project(
213
self._mr['target_project_id'], self._mr['target_branch'])
215
def _get_project_name(self, project_id):
216
source_project = self.gl._get_project(project_id)
217
return source_project['path_with_namespace']
219
def get_source_project(self):
220
return self._get_project_name(self._mr['source_project_id'])
222
def get_target_project(self):
223
return self._get_project_name(self._mr['target_project_id'])
226
return (self._mr['state'] == 'merged')
229
return (self._mr['state'] == 'closed')
232
return self._update(state_event='reopen')
235
self._update(state_event='close')
237
def merge(self, commit_message=None):
238
# https://docs.gitlab.com/ee/api/merge_requests.html#accept-mr
239
self._mr.merge(merge_commit_message=commit_message)
241
def can_be_merged(self):
242
if self._mr['merge_status'] == 'cannot_be_merged':
244
elif self._mr['merge_status'] == 'can_be_merged':
247
raise ValueError(self._mr['merge_status'])
249
def get_merged_by(self):
250
user = self._mr.get('merged_by')
253
return user['username']
255
def get_merged_at(self):
256
merged_at = self._mr.get('merged_at')
257
if merged_at is None:
260
return iso8601.parse_date(merged_at)
263
def gitlab_url_to_bzr_url(url, name):
265
name = name.encode('utf-8')
266
return git_url_to_bzr_url(url, branch=name)
269
class GitLab(Hoster):
270
"""GitLab hoster implementation."""
272
supports_merge_proposal_labels = True
273
supports_merge_proposal_commit_message = False
274
merge_proposal_description_format = 'markdown'
277
return "<GitLab(%r)>" % self.base_url
281
return self.transport.base
283
def _api_request(self, method, path, fields=None, body=None):
284
return self.transport.request(
285
method, urlutils.join(self.base_url, 'api', 'v4', path),
286
headers=self.headers, fields=fields, body=body)
288
def __init__(self, transport, private_token):
289
self.transport = transport
290
self.headers = {"Private-Token": private_token}
293
def _get_user(self, username):
294
path = 'users/%s' % urlutils.quote(str(username), '')
295
response = self._api_request('GET', path)
296
if response.status == 404:
297
raise KeyError('no such user %s' % username)
298
if response.status == 200:
299
return json.loads(response.data)
300
raise errors.InvalidHttpResponse(path, response.text)
302
def _get_user_by_email(self, email):
303
path = 'users?search=%s' % urlutils.quote(str(email), '')
304
response = self._api_request('GET', path)
305
if response.status == 404:
306
raise KeyError('no such user %s' % email)
307
if response.status == 200:
308
ret = json.loads(response.data)
310
raise ValueError('unexpected number of results; %r' % ret)
312
raise errors.InvalidHttpResponse(path, response.text)
314
def _get_project(self, project_name):
315
path = 'projects/%s' % urlutils.quote(str(project_name), '')
316
response = self._api_request('GET', path)
317
if response.status == 404:
318
raise NoSuchProject(project_name)
319
if response.status == 200:
320
return json.loads(response.data)
321
raise errors.InvalidHttpResponse(path, response.text)
323
def _fork_project(self, project_name, timeout=50, interval=5):
324
path = 'projects/%s/fork' % urlutils.quote(str(project_name), '')
325
response = self._api_request('POST', path)
326
if response.status not in (200, 201):
327
raise errors.InvalidHttpResponse(path, response.text)
328
# The response should be valid JSON, but let's ignore it
329
project = json.loads(response.data)
330
# Spin and wait until import_status for new project
332
deadline = time.time() + timeout
333
while project['import_status'] not in ('finished', 'none'):
334
mutter('import status is %s', project['import_status'])
335
if time.time() > deadline:
336
raise Exception('timeout waiting for project to become available')
338
project = self._get_project(project['path_with_namespace'])
341
def _get_logged_in_username(self):
342
return self._current_user['username']
344
def _list_paged(self, path, parameters=None, per_page=None):
345
if parameters is None:
348
parameters = dict(parameters.items())
350
parameters['per_page'] = str(per_page)
353
parameters['page'] = page
354
response = self._api_request(
356
';'.join(['%s=%s' % item for item in parameters.items()]))
357
if response.status == 403:
358
raise errors.PermissionDenied(response.text)
359
if response.status != 200:
360
raise errors.InvalidHttpResponse(path, response.text)
361
page = response.getheader("X-Next-Page")
362
for entry in json.loads(response.data):
365
def _list_merge_requests(self, owner=None, project=None, state=None):
366
if project is not None:
367
path = 'projects/%s/merge_requests' % urlutils.quote(str(project), '')
369
path = 'merge_requests'
372
parameters['state'] = state
374
parameters['owner_id'] = urlutils.quote(owner, '')
375
return self._list_paged(path, parameters, per_page=DEFAULT_PAGE_SIZE)
377
def _list_projects(self, owner):
378
path = 'users/%s/projects' % urlutils.quote(str(owner), '')
380
return self._list_paged(path, parameters, per_page=DEFAULT_PAGE_SIZE)
382
def _update_merge_request(self, project_id, iid, mr):
383
path = 'projects/%s/merge_requests/%s' % (
384
urlutils.quote(str(project_id), ''), iid)
385
response = self._api_request('PUT', path, fields=mr)
386
if response.status == 200:
387
return json.loads(response.data)
388
raise errors.InvalidHttpResponse(path, response.text)
390
def _create_mergerequest(
391
self, title, source_project_id, target_project_id,
392
source_branch_name, target_branch_name, description,
394
path = 'projects/%s/merge_requests' % source_project_id
397
'source_branch': source_branch_name,
398
'target_branch': target_branch_name,
399
'target_project_id': target_project_id,
400
'description': description,
403
fields['labels'] = labels
404
response = self._api_request('POST', path, fields=fields)
405
if response.status == 403:
406
raise errors.PermissionDenied(response.text)
407
if response.status == 409:
408
raise MergeProposalExists(self.source_branch.user_url)
409
if response.status != 201:
410
raise errors.InvalidHttpResponse(path, response.text)
411
return json.loads(response.data)
413
def get_push_url(self, branch):
414
(host, project_name, branch_name) = parse_gitlab_branch_url(branch)
415
project = self._get_project(project_name)
416
return gitlab_url_to_bzr_url(
417
project['ssh_url_to_repo'], branch_name)
419
def publish_derived(self, local_branch, base_branch, name, project=None,
420
owner=None, revision_id=None, overwrite=False,
422
(host, base_project, base_branch_name) = parse_gitlab_branch_url(base_branch)
424
owner = self._get_logged_in_username()
426
project = self._get_project(base_project)['path']
428
target_project = self._get_project('%s/%s' % (owner, project))
429
except NoSuchProject:
430
target_project = self._fork_project(base_project)
431
remote_repo_url = git_url_to_bzr_url(target_project['ssh_url_to_repo'])
432
remote_dir = controldir.ControlDir.open(remote_repo_url)
434
push_result = remote_dir.push_branch(
435
local_branch, revision_id=revision_id, overwrite=overwrite,
437
except errors.NoRoundtrippingSupport:
440
push_result = remote_dir.push_branch(
441
local_branch, revision_id=revision_id, overwrite=overwrite,
442
name=name, lossy=True)
443
public_url = gitlab_url_to_bzr_url(
444
target_project['http_url_to_repo'], name)
445
return push_result.target_branch, public_url
447
def get_derived_branch(self, base_branch, name, project=None, owner=None):
448
(host, base_project, base_branch_name) = parse_gitlab_branch_url(base_branch)
450
owner = self._get_logged_in_username()
452
project = self._get_project(base_project)['path']
454
target_project = self._get_project('%s/%s' % (owner, project))
455
except NoSuchProject:
456
raise errors.NotBranchError('%s/%s/%s' % (self.base_url, owner, project))
457
return _mod_branch.Branch.open(gitlab_url_to_bzr_url(
458
target_project['ssh_url_to_repo'], name))
460
def get_proposer(self, source_branch, target_branch):
461
return GitlabMergeProposalBuilder(self, source_branch, target_branch)
463
def iter_proposals(self, source_branch, target_branch, status):
464
(source_host, source_project_name, source_branch_name) = (
465
parse_gitlab_branch_url(source_branch))
466
(target_host, target_project_name, target_branch_name) = (
467
parse_gitlab_branch_url(target_branch))
468
if source_host != target_host:
469
raise DifferentGitLabInstances(source_host, target_host)
470
source_project = self._get_project(source_project_name)
471
target_project = self._get_project(target_project_name)
472
state = mp_status_to_status(status)
473
for mr in self._list_merge_requests(
474
project=target_project['id'], state=state):
475
if (mr['source_project_id'] != source_project['id'] or
476
mr['source_branch'] != source_branch_name or
477
mr['target_project_id'] != target_project['id'] or
478
mr['target_branch'] != target_branch_name):
480
yield GitLabMergeProposal(self, mr)
482
def hosts(self, branch):
484
(host, project, branch_name) = parse_gitlab_branch_url(branch)
487
return (self.base_url == ('https://%s' % host))
490
response = self._api_request('GET', 'user')
491
if response.status == 200:
492
self._current_user = json.loads(response.data)
495
if json.loads(response.data) == {"message": "401 Unauthorized"}:
496
raise GitLabLoginMissing()
498
raise GitlabLoginError(response.text)
499
raise UnsupportedHoster(url)
502
def probe_from_url(cls, url, possible_transports=None):
504
(host, project) = parse_gitlab_url(url)
506
raise UnsupportedHoster(url)
507
transport = get_transport(
508
'https://%s' % host, possible_transports=possible_transports)
509
credentials = get_credentials_by_url(transport.base)
510
if credentials is not None:
511
return cls(transport, credentials.get('private_token'))
512
raise UnsupportedHoster(url)
515
def iter_instances(cls):
516
for name, credentials in iter_tokens():
517
if 'url' not in credentials:
520
get_transport(credentials['url']),
521
private_token=credentials.get('private_token'))
523
def iter_my_proposals(self, status='open'):
524
state = mp_status_to_status(status)
525
for mp in self._list_merge_requests(
526
owner=self._get_logged_in_username(), state=state):
527
yield GitLabMergeProposal(self, mp)
529
def iter_my_forks(self):
530
for project in self._list_projects(owner=self._get_logged_in_username()):
531
base_project = project.get('forked_from_project')
534
yield project['path_with_namespace']
536
def get_proposal_by_url(self, url):
538
(host, project, merge_id) = parse_gitlab_merge_request_url(url)
540
raise UnsupportedHoster(url)
541
except NotMergeRequestUrl as e:
542
if self.base_url == ('https://%s' % e.host):
545
raise UnsupportedHoster(url)
546
if self.base_url != ('https://%s' % host):
547
raise UnsupportedHoster(url)
548
project = self._get_project(project)
549
mr = project.mergerequests.get(merge_id)
550
return GitLabMergeProposal(mr)
552
def delete_project(self, project):
553
path = 'projects/%s' % urlutils.quote(str(project), '')
554
response = self._api_request('DELETE', path)
555
if response.status == 404:
556
raise NoSuchProject(project)
557
if response.status != 202:
558
raise errors.InvalidHttpResponse(path, response.text)
561
class GitlabMergeProposalBuilder(MergeProposalBuilder):
563
def __init__(self, gl, source_branch, target_branch):
565
self.source_branch = source_branch
566
(self.source_host, self.source_project_name, self.source_branch_name) = (
567
parse_gitlab_branch_url(source_branch))
568
self.target_branch = target_branch
569
(self.target_host, self.target_project_name, self.target_branch_name) = (
570
parse_gitlab_branch_url(target_branch))
571
if self.source_host != self.target_host:
572
raise DifferentGitLabInstances(self.source_host, self.target_host)
574
def get_infotext(self):
575
"""Determine the initial comment for the merge proposal."""
577
info.append("Gitlab instance: %s\n" % self.target_host)
578
info.append("Source: %s\n" % self.source_branch.user_url)
579
info.append("Target: %s\n" % self.target_branch.user_url)
582
def get_initial_body(self):
583
"""Get a body for the proposal for the user to modify.
585
:return: a str or None.
589
def create_proposal(self, description, reviewers=None, labels=None,
590
prerequisite_branch=None, commit_message=None):
591
"""Perform the submission."""
592
# https://docs.gitlab.com/ee/api/merge_requests.html#create-mr
593
if prerequisite_branch is not None:
594
raise PrerequisiteBranchUnsupported(self)
595
# Note that commit_message is ignored, since Gitlab doesn't support it.
596
source_project = self.gl._get_project(self.source_project_name)
597
target_project = self.gl._get_project(self.target_project_name)
598
# TODO(jelmer): Allow setting title explicitly
599
title = determine_title(description)
600
# TODO(jelmer): Allow setting allow_collaboration field
601
# TODO(jelmer): Allow setting milestone field
602
# TODO(jelmer): Allow setting squash field
605
'source_project_id': source_project['id'],
606
'target_project_id': target_project['id'],
607
'source_branch_name': self.source_branch_name,
608
'target_branch_name': self.target_branch_name,
609
'description': description}
611
kwargs['labels'] = ','.join(labels)
613
kwargs['assignee_ids'] = []
614
for reviewer in reviewers:
616
user = self.gl._get_user_by_email(reviewer)
618
user = self.gl._get_user(reviewer)
619
kwargs['assignee_ids'].append(user['id'])
620
merge_request = self.gl._create_mergerequest(**kwargs)
621
return GitLabMergeProposal(self.gl, merge_request)
624
def register_gitlab_instance(shortname, url):
625
"""Register a gitlab instance.
627
:param shortname: Short name (e.g. "gitlab")
628
:param url: URL to the gitlab instance
630
from breezy.bugtracker import (
632
ProjectIntegerBugTracker,
634
tracker_registry.register(
635
shortname, ProjectIntegerBugTracker(
636
shortname, url + '/{project}/issues/{id}'))