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 (
43
PrerequisiteBranchUnsupported,
48
_DEFAULT_FILES = ['/etc/python-gitlab.cfg', '~/.python-gitlab.cfg']
49
DEFAULT_PAGE_SIZE = 50
52
def mp_status_to_status(status):
57
'closed': 'closed'}[status]
60
class NotGitLabUrl(errors.BzrError):
62
_fmt = "Not a GitLab URL: %(url)s"
64
def __init__(self, url):
65
errors.BzrError.__init__(self)
69
class NotMergeRequestUrl(errors.BzrError):
71
_fmt = "Not a merge proposal URL: %(url)s"
73
def __init__(self, host, url):
74
errors.BzrError.__init__(self)
79
class DifferentGitLabInstances(errors.BzrError):
81
_fmt = ("Can't create merge proposals across GitLab instances: "
82
"%(source_host)s and %(target_host)s")
84
def __init__(self, source_host, target_host):
85
self.source_host = source_host
86
self.target_host = target_host
89
class GitLabLoginMissing(errors.BzrError):
91
_fmt = ("Please log into GitLab")
94
class GitlabLoginError(errors.BzrError):
96
_fmt = ("Error logging in: %(error)s")
98
def __init__(self, error):
102
def default_config_path():
103
return os.path.join(bedding.config_dir(), 'gitlab.conf')
106
def store_gitlab_token(name, url, private_token):
107
"""Store a GitLab token in a configuration file."""
109
config = configparser.ConfigParser()
110
path = default_config_path()
112
config.add_section(name)
113
config[name]['url'] = url
114
config[name]['private_token'] = private_token
115
with open(path, 'w') as f:
121
config = configparser.ConfigParser()
123
[os.path.expanduser(p) for p in _DEFAULT_FILES] +
124
[default_config_path()])
125
for name, section in config.items():
129
def get_credentials_by_url(url):
130
for name, credentials in iter_tokens():
131
if 'url' not in credentials:
133
if credentials['url'].rstrip('/') == url.rstrip('/'):
139
def parse_gitlab_url(url):
140
(scheme, user, password, host, port, path) = urlutils.parse_url(
142
if scheme not in ('git+ssh', 'https', 'http'):
143
raise NotGitLabUrl(url)
145
raise NotGitLabUrl(url)
146
path = path.strip('/')
147
if path.endswith('.git'):
152
def parse_gitlab_branch_url(branch):
153
url = urlutils.split_segment_parameters(branch.user_url)[0]
154
host, path = parse_gitlab_url(url)
155
return host, path, branch.name
158
def parse_gitlab_merge_request_url(url):
159
(scheme, user, password, host, port, path) = urlutils.parse_url(
161
if scheme not in ('git+ssh', 'https', 'http'):
162
raise NotGitLabUrl(url)
164
raise NotGitLabUrl(url)
165
path = path.strip('/')
166
parts = path.split('/')
167
if parts[-2] != 'merge_requests':
168
raise NotMergeRequestUrl(host, url)
169
return host, '/'.join(parts[:-2]), int(parts[-1])
172
class GitLabMergeProposal(MergeProposal):
174
def __init__(self, gl, mr):
178
def _update(self, **kwargs):
179
self.gl._update_merge_request(self._mr['project_id'], self._mr['iid'], kwargs)
182
return "<%s at %r>" % (type(self).__name__, self._mr['web_url'])
186
return self._mr['web_url']
188
def get_description(self):
189
return self._mr['description']
191
def set_description(self, description):
192
self._update(description=description, title=description.splitlines()[0])
194
def get_commit_message(self):
195
return self._mr.get('merge_commit_message')
197
def set_commit_message(self, message):
198
raise errors.UnsupportedOperation(self.set_commit_message, self)
200
def _branch_url_from_project(self, project_id, branch_name):
201
if project_id is None:
203
project = self.gl._get_project(project_id)
204
return gitlab_url_to_bzr_url(project['http_url_to_repo'], branch_name)
206
def get_source_branch_url(self):
207
return self._branch_url_from_project(
208
self._mr['source_project_id'], self._mr['source_branch'])
210
def get_target_branch_url(self):
211
return self._branch_url_from_project(
212
self._mr['target_project_id'], self._mr['target_branch'])
214
def _get_project_name(self, project_id):
215
source_project = self.gl._get_project(project_id)
216
return source_project['path_with_namespace']
218
def get_source_project(self):
219
return self._get_project_name(self._mr['source_project_id'])
221
def get_target_project(self):
222
return self._get_project_name(self._mr['target_project_id'])
225
return (self._mr['state'] == 'merged')
228
return (self._mr['state'] == 'closed')
231
return self._update(state_event='reopen')
234
self._update(state_event='close')
236
def merge(self, commit_message=None):
237
# https://docs.gitlab.com/ee/api/merge_requests.html#accept-mr
238
self._mr.merge(merge_commit_message=commit_message)
240
def can_be_merged(self):
241
if self._mr['merge_status'] == 'cannot_be_merged':
243
elif self._mr['merge_status'] == 'can_be_merged':
246
raise ValueError(self._mr['merge_status'])
248
def get_merged_by(self):
249
user = self._mr.get('merged_by')
252
return user['username']
254
def get_merged_at(self):
255
merged_at = self._mr.get('merged_at')
256
if merged_at is None:
259
return iso8601.parse_date(merged_at)
262
def gitlab_url_to_bzr_url(url, name):
264
name = name.encode('utf-8')
265
return git_url_to_bzr_url(url, branch=name)
268
class GitLab(Hoster):
269
"""GitLab hoster implementation."""
271
supports_merge_proposal_labels = True
272
supports_merge_proposal_commit_message = False
275
return "<GitLab(%r)>" % self.base_url
279
return self.transport.base
281
def _api_request(self, method, path, fields=None, body=None):
282
return self.transport.request(
283
method, urlutils.join(self.base_url, 'api', 'v4', path),
284
headers=self.headers, fields=fields, body=body)
286
def __init__(self, transport, private_token):
287
self.transport = transport
288
self.headers = {"Private-Token": private_token}
291
def _get_user(self, username):
292
path = 'users/%s' % urlutils.quote(str(username), '')
293
response = self._api_request('GET', path)
294
if response.status == 404:
295
raise KeyError('no such user %s' % username)
296
if response.status == 200:
297
return json.loads(response.data)
298
raise errors.InvalidHttpResponse(path, response.text)
300
def _get_user_by_email(self, email):
301
path = 'users?search=%s' % urlutils.quote(str(email), '')
302
response = self._api_request('GET', path)
303
if response.status == 404:
304
raise KeyError('no such user %s' % email)
305
if response.status == 200:
306
ret = json.loads(response.data)
308
raise ValueError('unexpected number of results; %r' % ret)
310
raise errors.InvalidHttpResponse(path, response.text)
312
def _get_project(self, project_name):
313
path = 'projects/%s' % urlutils.quote(str(project_name), '')
314
response = self._api_request('GET', path)
315
if response.status == 404:
316
raise NoSuchProject(project_name)
317
if response.status == 200:
318
return json.loads(response.data)
319
raise errors.InvalidHttpResponse(path, response.text)
321
def _fork_project(self, project_name, timeout=50, interval=5):
322
path = 'projects/%s/fork' % urlutils.quote(str(project_name), '')
323
response = self._api_request('POST', path)
324
if response.status not in (200, 201):
325
raise errors.InvalidHttpResponse(path, response.text)
326
# The response should be valid JSON, but let's ignore it
327
project = json.loads(response.data)
328
# Spin and wait until import_status for new project
330
deadline = time.time() + timeout
331
while project['import_status'] not in ('finished', 'none'):
332
mutter('import status is %s', project['import_status'])
333
if time.time() > deadline:
334
raise Exception('timeout waiting for project to become available')
336
project = self._get_project(project['path_with_namespace'])
339
def _get_logged_in_username(self):
340
return self._current_user['username']
342
def _list_paged(self, path, parameters=None, per_page=None):
343
if parameters is None:
346
parameters = dict(parameters.items())
348
parameters['per_page'] = str(per_page)
351
parameters['page'] = page
352
response = self._api_request(
354
';'.join(['%s=%s' % item for item in parameters.items()]))
355
if response.status == 403:
356
raise errors.PermissionDenied(response.text)
357
if response.status != 200:
358
raise errors.InvalidHttpResponse(path, response.text)
359
page = response.getheader("X-Next-Page")
360
for entry in json.loads(response.data):
363
def _list_merge_requests(self, owner=None, project=None, state=None):
364
if project is not None:
365
path = 'projects/%s/merge_requests' % urlutils.quote(str(project), '')
367
path = 'merge_requests'
370
parameters['state'] = state
372
parameters['owner_id'] = urlutils.quote(owner, '')
373
return self._list_paged(path, parameters, per_page=DEFAULT_PAGE_SIZE)
375
def _list_projects(self, owner):
376
path = 'users/%s/projects' % urlutils.quote(str(owner), '')
378
return self._list_paged(path, parameters, per_page=DEFAULT_PAGE_SIZE)
380
def _update_merge_request(self, project_id, iid, mr):
381
path = 'projects/%s/merge_requests/%s' % (
382
urlutils.quote(str(project_id), ''), iid)
383
response = self._api_request('PUT', path, fields=mr)
384
if response.status == 200:
385
return json.loads(response.data)
386
raise errors.InvalidHttpResponse(path, response.text)
388
def _create_mergerequest(
389
self, title, source_project_id, target_project_id,
390
source_branch_name, target_branch_name, description,
392
path = 'projects/%s/merge_requests' % source_project_id
395
'source_branch': source_branch_name,
396
'target_branch': target_branch_name,
397
'target_project_id': target_project_id,
398
'description': description,
401
fields['labels'] = labels
402
response = self._api_request('POST', path, fields=fields)
403
if response.status == 403:
404
raise errors.PermissionDenied(response.text)
405
if response.status == 409:
406
raise MergeProposalExists(self.source_branch.user_url)
407
if response.status != 201:
408
raise errors.InvalidHttpResponse(path, response.text)
409
return json.loads(response.data)
411
def get_push_url(self, branch):
412
(host, project_name, branch_name) = parse_gitlab_branch_url(branch)
413
project = self._get_project(project_name)
414
return gitlab_url_to_bzr_url(
415
project['ssh_url_to_repo'], branch_name)
417
def publish_derived(self, local_branch, base_branch, name, project=None,
418
owner=None, revision_id=None, overwrite=False,
420
(host, base_project, base_branch_name) = parse_gitlab_branch_url(base_branch)
422
owner = self._get_logged_in_username()
424
project = self._get_project(base_project)['path']
426
target_project = self._get_project('%s/%s' % (owner, project))
427
except NoSuchProject:
428
target_project = self._fork_project(base_project)
429
remote_repo_url = git_url_to_bzr_url(target_project['ssh_url_to_repo'])
430
remote_dir = controldir.ControlDir.open(remote_repo_url)
432
push_result = remote_dir.push_branch(
433
local_branch, revision_id=revision_id, overwrite=overwrite,
435
except errors.NoRoundtrippingSupport:
438
push_result = remote_dir.push_branch(
439
local_branch, revision_id=revision_id, overwrite=overwrite,
440
name=name, lossy=True)
441
public_url = gitlab_url_to_bzr_url(
442
target_project['http_url_to_repo'], name)
443
return push_result.target_branch, public_url
445
def get_derived_branch(self, base_branch, name, project=None, owner=None):
446
(host, base_project, base_branch_name) = parse_gitlab_branch_url(base_branch)
448
owner = self._get_logged_in_username()
450
project = self._get_project(base_project)['path']
452
target_project = self._get_project('%s/%s' % (owner, project))
453
except NoSuchProject:
454
raise errors.NotBranchError('%s/%s/%s' % (self.base_url, owner, project))
455
return _mod_branch.Branch.open(gitlab_url_to_bzr_url(
456
target_project['ssh_url_to_repo'], name))
458
def get_proposer(self, source_branch, target_branch):
459
return GitlabMergeProposalBuilder(self, source_branch, target_branch)
461
def iter_proposals(self, source_branch, target_branch, status):
462
(source_host, source_project_name, source_branch_name) = (
463
parse_gitlab_branch_url(source_branch))
464
(target_host, target_project_name, target_branch_name) = (
465
parse_gitlab_branch_url(target_branch))
466
if source_host != target_host:
467
raise DifferentGitLabInstances(source_host, target_host)
468
source_project = self._get_project(source_project_name)
469
target_project = self._get_project(target_project_name)
470
state = mp_status_to_status(status)
471
for mr in self._list_merge_requests(
472
project=target_project['id'], state=state):
473
if (mr['source_project_id'] != source_project['id'] or
474
mr['source_branch'] != source_branch_name or
475
mr['target_project_id'] != target_project['id'] or
476
mr['target_branch'] != target_branch_name):
478
yield GitLabMergeProposal(self, mr)
480
def hosts(self, branch):
482
(host, project, branch_name) = parse_gitlab_branch_url(branch)
485
return (self.base_url == ('https://%s' % host))
488
response = self._api_request('GET', 'user')
489
if response.status == 200:
490
self._current_user = json.loads(response.data)
493
if json.loads(response.data) == {"message": "401 Unauthorized"}:
494
raise GitLabLoginMissing()
496
raise GitlabLoginError(response.text)
497
raise UnsupportedHoster(url)
500
def probe_from_url(cls, url, possible_transports=None):
502
(host, project) = parse_gitlab_url(url)
504
raise UnsupportedHoster(url)
505
transport = get_transport(
506
'https://%s' % host, possible_transports=possible_transports)
507
credentials = get_credentials_by_url(transport.base)
508
if credentials is not None:
509
return cls(transport, credentials.get('private_token'))
510
raise UnsupportedHoster(url)
513
def iter_instances(cls):
514
for name, credentials in iter_tokens():
515
if 'url' not in credentials:
518
get_transport(credentials['url']),
519
private_token=credentials.get('private_token'))
521
def iter_my_proposals(self, status='open'):
522
state = mp_status_to_status(status)
523
for mp in self._list_merge_requests(
524
owner=self._get_logged_in_username(), state=state):
525
yield GitLabMergeProposal(self, mp)
527
def iter_my_forks(self):
528
for project in self._list_projects(owner=self._get_logged_in_username()):
529
base_project = project.get('forked_from_project')
532
yield project['path_with_namespace']
534
def get_proposal_by_url(self, url):
536
(host, project, merge_id) = parse_gitlab_merge_request_url(url)
538
raise UnsupportedHoster(url)
539
except NotMergeRequestUrl as e:
540
if self.base_url == ('https://%s' % e.host):
543
raise UnsupportedHoster(url)
544
if self.base_url != ('https://%s' % host):
545
raise UnsupportedHoster(url)
546
project = self._get_project(project)
547
mr = project.mergerequests.get(merge_id)
548
return GitLabMergeProposal(mr)
550
def delete_project(self, project):
551
path = 'projects/%s' % urlutils.quote(str(project_name), '')
552
response = self._api_request('DELETE', path)
553
if response.status == 404:
554
raise NoSuchProject(project_name)
555
if response.status != 200:
556
raise errors.InvalidHttpResponse(path, response.text)
559
class GitlabMergeProposalBuilder(MergeProposalBuilder):
561
def __init__(self, gl, source_branch, target_branch):
563
self.source_branch = source_branch
564
(self.source_host, self.source_project_name, self.source_branch_name) = (
565
parse_gitlab_branch_url(source_branch))
566
self.target_branch = target_branch
567
(self.target_host, self.target_project_name, self.target_branch_name) = (
568
parse_gitlab_branch_url(target_branch))
569
if self.source_host != self.target_host:
570
raise DifferentGitLabInstances(self.source_host, self.target_host)
572
def get_infotext(self):
573
"""Determine the initial comment for the merge proposal."""
575
info.append("Gitlab instance: %s\n" % self.target_host)
576
info.append("Source: %s\n" % self.source_branch.user_url)
577
info.append("Target: %s\n" % self.target_branch.user_url)
580
def get_initial_body(self):
581
"""Get a body for the proposal for the user to modify.
583
:return: a str or None.
587
def create_proposal(self, description, reviewers=None, labels=None,
588
prerequisite_branch=None, commit_message=None):
589
"""Perform the submission."""
590
# https://docs.gitlab.com/ee/api/merge_requests.html#create-mr
591
if prerequisite_branch is not None:
592
raise PrerequisiteBranchUnsupported(self)
593
# Note that commit_message is ignored, since Gitlab doesn't support it.
594
source_project = self.gl._get_project(self.source_project_name)
595
target_project = self.gl._get_project(self.target_project_name)
596
# TODO(jelmer): Allow setting title explicitly
597
title = description.splitlines()[0]
598
# TODO(jelmer): Allow setting allow_collaboration field
599
# TODO(jelmer): Allow setting milestone field
600
# TODO(jelmer): Allow setting squash field
603
'source_project_id': source_project['id'],
604
'target_project_id': target_project['id'],
605
'source_branch_name': self.source_branch_name,
606
'target_branch_name': self.target_branch_name,
607
'description': description}
609
kwargs['labels'] = ','.join(labels)
611
kwargs['assignee_ids'] = []
612
for reviewer in reviewers:
614
user = self.gl._get_user_by_email(reviewer)
616
user = self.gl._get_user(reviewer)
617
kwargs['assignee_ids'].append(user['id'])
618
merge_request = self.gl._create_mergerequest(**kwargs)
619
return GitLabMergeProposal(self.gl, merge_request)
622
def register_gitlab_instance(shortname, url):
623
"""Register a gitlab instance.
625
:param shortname: Short name (e.g. "gitlab")
626
:param url: URL to the gitlab instance
628
from breezy.bugtracker import (
630
ProjectIntegerBugTracker,
632
tracker_registry.register(
633
shortname, ProjectIntegerBugTracker(
634
shortname, url + '/{project}/issues/{id}'))