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 ...trace import mutter
34
from ...transport import get_transport
36
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.strip_segment_parameters(branch.user_url)
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=determine_title(description))
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):
263
return git_url_to_bzr_url(url, branch=name)
266
class GitLab(Hoster):
267
"""GitLab hoster implementation."""
269
supports_merge_proposal_labels = True
270
supports_merge_proposal_commit_message = False
271
merge_proposal_description_format = 'markdown'
274
return "<GitLab(%r)>" % self.base_url
278
return self.transport.base
280
def _api_request(self, method, path, fields=None, body=None):
281
return self.transport.request(
282
method, urlutils.join(self.base_url, 'api', 'v4', path),
283
headers=self.headers, fields=fields, body=body)
285
def __init__(self, transport, private_token):
286
self.transport = transport
287
self.headers = {"Private-Token": private_token}
290
def _get_user(self, username):
291
path = 'users/%s' % urlutils.quote(str(username), '')
292
response = self._api_request('GET', path)
293
if response.status == 404:
294
raise KeyError('no such user %s' % username)
295
if response.status == 200:
296
return json.loads(response.data)
297
raise errors.InvalidHttpResponse(path, response.text)
299
def _get_user_by_email(self, email):
300
path = 'users?search=%s' % urlutils.quote(str(email), '')
301
response = self._api_request('GET', path)
302
if response.status == 404:
303
raise KeyError('no such user %s' % email)
304
if response.status == 200:
305
ret = json.loads(response.data)
307
raise ValueError('unexpected number of results; %r' % ret)
309
raise errors.InvalidHttpResponse(path, response.text)
311
def _get_project(self, project_name):
312
path = 'projects/%s' % urlutils.quote(str(project_name), '')
313
response = self._api_request('GET', path)
314
if response.status == 404:
315
raise NoSuchProject(project_name)
316
if response.status == 200:
317
return json.loads(response.data)
318
raise errors.InvalidHttpResponse(path, response.text)
320
def _fork_project(self, project_name, timeout=50, interval=5):
321
path = 'projects/%s/fork' % urlutils.quote(str(project_name), '')
322
response = self._api_request('POST', path)
323
if response.status not in (200, 201):
324
raise errors.InvalidHttpResponse(path, response.text)
325
# The response should be valid JSON, but let's ignore it
326
project = json.loads(response.data)
327
# Spin and wait until import_status for new project
329
deadline = time.time() + timeout
330
while project['import_status'] not in ('finished', 'none'):
331
mutter('import status is %s', project['import_status'])
332
if time.time() > deadline:
333
raise Exception('timeout waiting for project to become available')
335
project = self._get_project(project['path_with_namespace'])
338
def _get_logged_in_username(self):
339
return self._current_user['username']
341
def _list_paged(self, path, parameters=None, per_page=None):
342
if parameters is None:
345
parameters = dict(parameters.items())
347
parameters['per_page'] = str(per_page)
350
parameters['page'] = page
351
response = self._api_request(
353
';'.join(['%s=%s' % item for item in parameters.items()]))
354
if response.status == 403:
355
raise errors.PermissionDenied(response.text)
356
if response.status != 200:
357
raise errors.InvalidHttpResponse(path, response.text)
358
page = response.getheader("X-Next-Page")
359
for entry in json.loads(response.data):
362
def _list_merge_requests(self, owner=None, project=None, state=None):
363
if project is not None:
364
path = 'projects/%s/merge_requests' % urlutils.quote(str(project), '')
366
path = 'merge_requests'
369
parameters['state'] = state
371
parameters['owner_id'] = urlutils.quote(owner, '')
372
return self._list_paged(path, parameters, per_page=DEFAULT_PAGE_SIZE)
374
def _list_projects(self, owner):
375
path = 'users/%s/projects' % urlutils.quote(str(owner), '')
377
return self._list_paged(path, parameters, per_page=DEFAULT_PAGE_SIZE)
379
def _update_merge_request(self, project_id, iid, mr):
380
path = 'projects/%s/merge_requests/%s' % (
381
urlutils.quote(str(project_id), ''), iid)
382
response = self._api_request('PUT', path, fields=mr)
383
if response.status == 200:
384
return json.loads(response.data)
385
raise errors.InvalidHttpResponse(path, response.text)
387
def _create_mergerequest(
388
self, title, source_project_id, target_project_id,
389
source_branch_name, target_branch_name, description,
391
path = 'projects/%s/merge_requests' % source_project_id
394
'source_branch': source_branch_name,
395
'target_branch': target_branch_name,
396
'target_project_id': target_project_id,
397
'description': description,
400
fields['labels'] = labels
401
response = self._api_request('POST', path, fields=fields)
402
if response.status == 403:
403
raise errors.PermissionDenied(response.text)
404
if response.status == 409:
405
raise MergeProposalExists(self.source_branch.user_url)
406
if response.status != 201:
407
raise errors.InvalidHttpResponse(path, response.text)
408
return json.loads(response.data)
410
def get_push_url(self, branch):
411
(host, project_name, branch_name) = parse_gitlab_branch_url(branch)
412
project = self._get_project(project_name)
413
return gitlab_url_to_bzr_url(
414
project['ssh_url_to_repo'], branch_name)
416
def publish_derived(self, local_branch, base_branch, name, project=None,
417
owner=None, revision_id=None, overwrite=False,
419
(host, base_project, base_branch_name) = parse_gitlab_branch_url(base_branch)
421
owner = self._get_logged_in_username()
423
project = self._get_project(base_project)['path']
425
target_project = self._get_project('%s/%s' % (owner, project))
426
except NoSuchProject:
427
target_project = self._fork_project(base_project)
428
remote_repo_url = git_url_to_bzr_url(target_project['ssh_url_to_repo'])
429
remote_dir = controldir.ControlDir.open(remote_repo_url)
431
push_result = remote_dir.push_branch(
432
local_branch, revision_id=revision_id, overwrite=overwrite,
434
except errors.NoRoundtrippingSupport:
437
push_result = remote_dir.push_branch(
438
local_branch, revision_id=revision_id, overwrite=overwrite,
439
name=name, lossy=True)
440
public_url = gitlab_url_to_bzr_url(
441
target_project['http_url_to_repo'], name)
442
return push_result.target_branch, public_url
444
def get_derived_branch(self, base_branch, name, project=None, owner=None):
445
(host, base_project, base_branch_name) = parse_gitlab_branch_url(base_branch)
447
owner = self._get_logged_in_username()
449
project = self._get_project(base_project)['path']
451
target_project = self._get_project('%s/%s' % (owner, project))
452
except NoSuchProject:
453
raise errors.NotBranchError('%s/%s/%s' % (self.base_url, owner, project))
454
return _mod_branch.Branch.open(gitlab_url_to_bzr_url(
455
target_project['ssh_url_to_repo'], name))
457
def get_proposer(self, source_branch, target_branch):
458
return GitlabMergeProposalBuilder(self, source_branch, target_branch)
460
def iter_proposals(self, source_branch, target_branch, status):
461
(source_host, source_project_name, source_branch_name) = (
462
parse_gitlab_branch_url(source_branch))
463
(target_host, target_project_name, target_branch_name) = (
464
parse_gitlab_branch_url(target_branch))
465
if source_host != target_host:
466
raise DifferentGitLabInstances(source_host, target_host)
467
source_project = self._get_project(source_project_name)
468
target_project = self._get_project(target_project_name)
469
state = mp_status_to_status(status)
470
for mr in self._list_merge_requests(
471
project=target_project['id'], state=state):
472
if (mr['source_project_id'] != source_project['id'] or
473
mr['source_branch'] != source_branch_name or
474
mr['target_project_id'] != target_project['id'] or
475
mr['target_branch'] != target_branch_name):
477
yield GitLabMergeProposal(self, mr)
479
def hosts(self, branch):
481
(host, project, branch_name) = parse_gitlab_branch_url(branch)
484
return (self.base_url == ('https://%s' % host))
487
response = self._api_request('GET', 'user')
488
if response.status == 200:
489
self._current_user = json.loads(response.data)
492
if json.loads(response.data) == {"message": "401 Unauthorized"}:
493
raise GitLabLoginMissing()
495
raise GitlabLoginError(response.text)
496
raise UnsupportedHoster(url)
499
def probe_from_url(cls, url, possible_transports=None):
501
(host, project) = parse_gitlab_url(url)
503
raise UnsupportedHoster(url)
504
transport = get_transport(
505
'https://%s' % host, possible_transports=possible_transports)
506
credentials = get_credentials_by_url(transport.base)
507
if credentials is not None:
508
return cls(transport, credentials.get('private_token'))
509
raise UnsupportedHoster(url)
512
def iter_instances(cls):
513
for name, credentials in iter_tokens():
514
if 'url' not in credentials:
517
get_transport(credentials['url']),
518
private_token=credentials.get('private_token'))
520
def iter_my_proposals(self, status='open'):
521
state = mp_status_to_status(status)
522
for mp in self._list_merge_requests(
523
owner=self._get_logged_in_username(), state=state):
524
yield GitLabMergeProposal(self, mp)
526
def iter_my_forks(self):
527
for project in self._list_projects(owner=self._get_logged_in_username()):
528
base_project = project.get('forked_from_project')
531
yield project['path_with_namespace']
533
def get_proposal_by_url(self, url):
535
(host, project, merge_id) = parse_gitlab_merge_request_url(url)
537
raise UnsupportedHoster(url)
538
except NotMergeRequestUrl as e:
539
if self.base_url == ('https://%s' % e.host):
542
raise UnsupportedHoster(url)
543
if self.base_url != ('https://%s' % host):
544
raise UnsupportedHoster(url)
545
project = self._get_project(project)
546
mr = project.mergerequests.get(merge_id)
547
return GitLabMergeProposal(mr)
549
def delete_project(self, project):
550
path = 'projects/%s' % urlutils.quote(str(project), '')
551
response = self._api_request('DELETE', path)
552
if response.status == 404:
553
raise NoSuchProject(project)
554
if response.status != 202:
555
raise errors.InvalidHttpResponse(path, response.text)
558
class GitlabMergeProposalBuilder(MergeProposalBuilder):
560
def __init__(self, gl, source_branch, target_branch):
562
self.source_branch = source_branch
563
(self.source_host, self.source_project_name, self.source_branch_name) = (
564
parse_gitlab_branch_url(source_branch))
565
self.target_branch = target_branch
566
(self.target_host, self.target_project_name, self.target_branch_name) = (
567
parse_gitlab_branch_url(target_branch))
568
if self.source_host != self.target_host:
569
raise DifferentGitLabInstances(self.source_host, self.target_host)
571
def get_infotext(self):
572
"""Determine the initial comment for the merge proposal."""
574
info.append("Gitlab instance: %s\n" % self.target_host)
575
info.append("Source: %s\n" % self.source_branch.user_url)
576
info.append("Target: %s\n" % self.target_branch.user_url)
579
def get_initial_body(self):
580
"""Get a body for the proposal for the user to modify.
582
:return: a str or None.
586
def create_proposal(self, description, reviewers=None, labels=None,
587
prerequisite_branch=None, commit_message=None,
588
work_in_progress=False):
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 = determine_title(description)
599
title = 'WIP: %s' % title
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}'))
added
removed
breezy/plugins/propose/gitlabs.py
