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."""
25
branch as _mod_branch,
30
from ...git.urls import git_url_to_bzr_url
31
from ...trace import mutter
32
from ...transport import get_transport
34
from ...propose import (
41
PrerequisiteBranchUnsupported,
46
_DEFAULT_FILES = ['/etc/python-gitlab.cfg', '~/.python-gitlab.cfg']
47
DEFAULT_PAGE_SIZE = 50
50
def mp_status_to_status(status):
55
'closed': 'closed'}[status]
58
class NotGitLabUrl(errors.BzrError):
60
_fmt = "Not a GitLab URL: %(url)s"
62
def __init__(self, url):
63
errors.BzrError.__init__(self)
67
class NotMergeRequestUrl(errors.BzrError):
69
_fmt = "Not a merge proposal URL: %(url)s"
71
def __init__(self, host, url):
72
errors.BzrError.__init__(self)
77
class DifferentGitLabInstances(errors.BzrError):
79
_fmt = ("Can't create merge proposals across GitLab instances: "
80
"%(source_host)s and %(target_host)s")
82
def __init__(self, source_host, target_host):
83
self.source_host = source_host
84
self.target_host = target_host
87
class GitLabLoginMissing(errors.BzrError):
89
_fmt = ("Please log into GitLab")
92
class GitlabLoginError(errors.BzrError):
94
_fmt = ("Error logging in: %(error)s")
96
def __init__(self, error):
100
def default_config_path():
101
return os.path.join(bedding.config_dir(), 'gitlab.conf')
104
def store_gitlab_token(name, url, private_token):
105
"""Store a GitLab token in a configuration file."""
107
config = configparser.ConfigParser()
108
path = default_config_path()
110
config.add_section(name)
111
config[name]['url'] = url
112
config[name]['private_token'] = private_token
113
with open(path, 'w') as f:
119
config = configparser.ConfigParser()
121
[os.path.expanduser(p) for p in _DEFAULT_FILES] +
122
[default_config_path()])
123
for name, section in config.items():
127
def get_credentials_by_url(url):
128
for name, credentials in iter_tokens():
129
if 'url' not in credentials:
131
if credentials['url'].rstrip('/') == url.rstrip('/'):
137
def parse_gitlab_url(url):
138
(scheme, user, password, host, port, path) = urlutils.parse_url(
140
if scheme not in ('git+ssh', 'https', 'http'):
141
raise NotGitLabUrl(url)
143
raise NotGitLabUrl(url)
144
path = path.strip('/')
145
if path.endswith('.git'):
150
def parse_gitlab_branch_url(branch):
151
url = urlutils.strip_segment_parameters(branch.user_url)
152
host, path = parse_gitlab_url(url)
153
return host, path, branch.name
156
def parse_gitlab_merge_request_url(url):
157
(scheme, user, password, host, port, path) = urlutils.parse_url(
159
if scheme not in ('git+ssh', 'https', 'http'):
160
raise NotGitLabUrl(url)
162
raise NotGitLabUrl(url)
163
path = path.strip('/')
164
parts = path.split('/')
165
if parts[-2] != 'merge_requests':
166
raise NotMergeRequestUrl(host, url)
167
return host, '/'.join(parts[:-2]), int(parts[-1])
170
class GitLabMergeProposal(MergeProposal):
172
def __init__(self, gl, mr):
176
def _update(self, **kwargs):
177
self.gl._update_merge_request(self._mr['project_id'], self._mr['iid'], kwargs)
180
return "<%s at %r>" % (type(self).__name__, self._mr['web_url'])
184
return self._mr['web_url']
186
def get_description(self):
187
return self._mr['description']
189
def set_description(self, description):
190
self._update(description=description, title=determine_title(description))
192
def get_commit_message(self):
193
return self._mr.get('merge_commit_message')
195
def set_commit_message(self, message):
196
raise errors.UnsupportedOperation(self.set_commit_message, self)
198
def _branch_url_from_project(self, project_id, branch_name):
199
if project_id is None:
201
project = self.gl._get_project(project_id)
202
return gitlab_url_to_bzr_url(project['http_url_to_repo'], branch_name)
204
def get_source_branch_url(self):
205
return self._branch_url_from_project(
206
self._mr['source_project_id'], self._mr['source_branch'])
208
def get_target_branch_url(self):
209
return self._branch_url_from_project(
210
self._mr['target_project_id'], self._mr['target_branch'])
212
def _get_project_name(self, project_id):
213
source_project = self.gl._get_project(project_id)
214
return source_project['path_with_namespace']
216
def get_source_project(self):
217
return self._get_project_name(self._mr['source_project_id'])
219
def get_target_project(self):
220
return self._get_project_name(self._mr['target_project_id'])
223
return (self._mr['state'] == 'merged')
226
return (self._mr['state'] == 'closed')
229
return self._update(state_event='reopen')
232
self._update(state_event='close')
234
def merge(self, commit_message=None):
235
# https://docs.gitlab.com/ee/api/merge_requests.html#accept-mr
236
self._mr.merge(merge_commit_message=commit_message)
238
def can_be_merged(self):
239
if self._mr['merge_status'] == 'cannot_be_merged':
241
elif self._mr['merge_status'] == 'can_be_merged':
244
raise ValueError(self._mr['merge_status'])
246
def get_merged_by(self):
247
user = self._mr.get('merged_by')
250
return user['username']
252
def get_merged_at(self):
253
merged_at = self._mr.get('merged_at')
254
if merged_at is None:
257
return iso8601.parse_date(merged_at)
260
def gitlab_url_to_bzr_url(url, name):
261
return git_url_to_bzr_url(url, branch=name)
264
class GitLab(Hoster):
265
"""GitLab hoster implementation."""
267
supports_merge_proposal_labels = True
268
supports_merge_proposal_commit_message = False
269
merge_proposal_description_format = 'markdown'
272
return "<GitLab(%r)>" % self.base_url
276
return self.transport.base
278
def _api_request(self, method, path, fields=None, body=None):
279
return self.transport.request(
280
method, urlutils.join(self.base_url, 'api', 'v4', path),
281
headers=self.headers, fields=fields, body=body)
283
def __init__(self, transport, private_token):
284
self.transport = transport
285
self.headers = {"Private-Token": private_token}
288
def _get_user(self, username):
289
path = 'users/%s' % urlutils.quote(str(username), '')
290
response = self._api_request('GET', path)
291
if response.status == 404:
292
raise KeyError('no such user %s' % username)
293
if response.status == 200:
294
return json.loads(response.data)
295
raise errors.InvalidHttpResponse(path, response.text)
297
def _get_user_by_email(self, email):
298
path = 'users?search=%s' % urlutils.quote(str(email), '')
299
response = self._api_request('GET', path)
300
if response.status == 404:
301
raise KeyError('no such user %s' % email)
302
if response.status == 200:
303
ret = json.loads(response.data)
305
raise ValueError('unexpected number of results; %r' % ret)
307
raise errors.InvalidHttpResponse(path, response.text)
309
def _get_project(self, project_name):
310
path = 'projects/%s' % urlutils.quote(str(project_name), '')
311
response = self._api_request('GET', path)
312
if response.status == 404:
313
raise NoSuchProject(project_name)
314
if response.status == 200:
315
return json.loads(response.data)
316
raise errors.InvalidHttpResponse(path, response.text)
318
def _fork_project(self, project_name, timeout=50, interval=5):
319
path = 'projects/%s/fork' % urlutils.quote(str(project_name), '')
320
response = self._api_request('POST', path)
321
if response.status not in (200, 201):
322
raise errors.InvalidHttpResponse(path, response.text)
323
# The response should be valid JSON, but let's ignore it
324
project = json.loads(response.data)
325
# Spin and wait until import_status for new project
327
deadline = time.time() + timeout
328
while project['import_status'] not in ('finished', 'none'):
329
mutter('import status is %s', project['import_status'])
330
if time.time() > deadline:
331
raise Exception('timeout waiting for project to become available')
333
project = self._get_project(project['path_with_namespace'])
336
def _get_logged_in_username(self):
337
return self._current_user['username']
339
def _list_paged(self, path, parameters=None, per_page=None):
340
if parameters is None:
343
parameters = dict(parameters.items())
345
parameters['per_page'] = str(per_page)
348
parameters['page'] = page
349
response = self._api_request(
351
';'.join(['%s=%s' % item for item in parameters.items()]))
352
if response.status == 403:
353
raise errors.PermissionDenied(response.text)
354
if response.status != 200:
355
raise errors.InvalidHttpResponse(path, response.text)
356
page = response.getheader("X-Next-Page")
357
for entry in json.loads(response.data):
360
def _list_merge_requests(self, owner=None, project=None, state=None):
361
if project is not None:
362
path = 'projects/%s/merge_requests' % urlutils.quote(str(project), '')
364
path = 'merge_requests'
367
parameters['state'] = state
369
parameters['owner_id'] = urlutils.quote(owner, '')
370
return self._list_paged(path, parameters, per_page=DEFAULT_PAGE_SIZE)
372
def _list_projects(self, owner):
373
path = 'users/%s/projects' % urlutils.quote(str(owner), '')
375
return self._list_paged(path, parameters, per_page=DEFAULT_PAGE_SIZE)
377
def _update_merge_request(self, project_id, iid, mr):
378
path = 'projects/%s/merge_requests/%s' % (
379
urlutils.quote(str(project_id), ''), iid)
380
response = self._api_request('PUT', path, fields=mr)
381
if response.status == 200:
382
return json.loads(response.data)
383
raise errors.InvalidHttpResponse(path, response.text)
385
def _create_mergerequest(
386
self, title, source_project_id, target_project_id,
387
source_branch_name, target_branch_name, description,
389
path = 'projects/%s/merge_requests' % source_project_id
392
'source_branch': source_branch_name,
393
'target_branch': target_branch_name,
394
'target_project_id': target_project_id,
395
'description': description,
398
fields['labels'] = labels
399
response = self._api_request('POST', path, fields=fields)
400
if response.status == 403:
401
raise errors.PermissionDenied(response.text)
402
if response.status == 409:
403
raise MergeProposalExists(self.source_branch.user_url)
404
if response.status != 201:
405
raise errors.InvalidHttpResponse(path, response.text)
406
return json.loads(response.data)
408
def get_push_url(self, branch):
409
(host, project_name, branch_name) = parse_gitlab_branch_url(branch)
410
project = self._get_project(project_name)
411
return gitlab_url_to_bzr_url(
412
project['ssh_url_to_repo'], branch_name)
414
def publish_derived(self, local_branch, base_branch, name, project=None,
415
owner=None, revision_id=None, overwrite=False,
417
(host, base_project, base_branch_name) = parse_gitlab_branch_url(base_branch)
419
owner = self._get_logged_in_username()
421
project = self._get_project(base_project)['path']
423
target_project = self._get_project('%s/%s' % (owner, project))
424
except NoSuchProject:
425
target_project = self._fork_project(base_project)
426
remote_repo_url = git_url_to_bzr_url(target_project['ssh_url_to_repo'])
427
remote_dir = controldir.ControlDir.open(remote_repo_url)
429
push_result = remote_dir.push_branch(
430
local_branch, revision_id=revision_id, overwrite=overwrite,
432
except errors.NoRoundtrippingSupport:
435
push_result = remote_dir.push_branch(
436
local_branch, revision_id=revision_id, overwrite=overwrite,
437
name=name, lossy=True)
438
public_url = gitlab_url_to_bzr_url(
439
target_project['http_url_to_repo'], name)
440
return push_result.target_branch, public_url
442
def get_derived_branch(self, base_branch, name, project=None, owner=None):
443
(host, base_project, base_branch_name) = parse_gitlab_branch_url(base_branch)
445
owner = self._get_logged_in_username()
447
project = self._get_project(base_project)['path']
449
target_project = self._get_project('%s/%s' % (owner, project))
450
except NoSuchProject:
451
raise errors.NotBranchError('%s/%s/%s' % (self.base_url, owner, project))
452
return _mod_branch.Branch.open(gitlab_url_to_bzr_url(
453
target_project['ssh_url_to_repo'], name))
455
def get_proposer(self, source_branch, target_branch):
456
return GitlabMergeProposalBuilder(self, source_branch, target_branch)
458
def iter_proposals(self, source_branch, target_branch, status):
459
(source_host, source_project_name, source_branch_name) = (
460
parse_gitlab_branch_url(source_branch))
461
(target_host, target_project_name, target_branch_name) = (
462
parse_gitlab_branch_url(target_branch))
463
if source_host != target_host:
464
raise DifferentGitLabInstances(source_host, target_host)
465
source_project = self._get_project(source_project_name)
466
target_project = self._get_project(target_project_name)
467
state = mp_status_to_status(status)
468
for mr in self._list_merge_requests(
469
project=target_project['id'], state=state):
470
if (mr['source_project_id'] != source_project['id'] or
471
mr['source_branch'] != source_branch_name or
472
mr['target_project_id'] != target_project['id'] or
473
mr['target_branch'] != target_branch_name):
475
yield GitLabMergeProposal(self, mr)
477
def hosts(self, branch):
479
(host, project, branch_name) = parse_gitlab_branch_url(branch)
482
return (self.base_url == ('https://%s' % host))
485
response = self._api_request('GET', 'user')
486
if response.status == 200:
487
self._current_user = json.loads(response.data)
490
if json.loads(response.data) == {"message": "401 Unauthorized"}:
491
raise GitLabLoginMissing()
493
raise GitlabLoginError(response.text)
494
raise UnsupportedHoster(url)
497
def probe_from_url(cls, url, possible_transports=None):
499
(host, project) = parse_gitlab_url(url)
501
raise UnsupportedHoster(url)
502
transport = get_transport(
503
'https://%s' % host, possible_transports=possible_transports)
504
credentials = get_credentials_by_url(transport.base)
505
if credentials is not None:
506
return cls(transport, credentials.get('private_token'))
507
raise UnsupportedHoster(url)
510
def iter_instances(cls):
511
for name, credentials in iter_tokens():
512
if 'url' not in credentials:
515
get_transport(credentials['url']),
516
private_token=credentials.get('private_token'))
518
def iter_my_proposals(self, status='open'):
519
state = mp_status_to_status(status)
520
for mp in self._list_merge_requests(
521
owner=self._get_logged_in_username(), state=state):
522
yield GitLabMergeProposal(self, mp)
524
def iter_my_forks(self):
525
for project in self._list_projects(owner=self._get_logged_in_username()):
526
base_project = project.get('forked_from_project')
529
yield project['path_with_namespace']
531
def get_proposal_by_url(self, url):
533
(host, project, merge_id) = parse_gitlab_merge_request_url(url)
535
raise UnsupportedHoster(url)
536
except NotMergeRequestUrl as e:
537
if self.base_url == ('https://%s' % e.host):
540
raise UnsupportedHoster(url)
541
if self.base_url != ('https://%s' % host):
542
raise UnsupportedHoster(url)
543
project = self._get_project(project)
544
mr = project.mergerequests.get(merge_id)
545
return GitLabMergeProposal(mr)
547
def delete_project(self, project):
548
path = 'projects/%s' % urlutils.quote(str(project), '')
549
response = self._api_request('DELETE', path)
550
if response.status == 404:
551
raise NoSuchProject(project)
552
if response.status != 202:
553
raise errors.InvalidHttpResponse(path, response.text)
556
class GitlabMergeProposalBuilder(MergeProposalBuilder):
558
def __init__(self, gl, source_branch, target_branch):
560
self.source_branch = source_branch
561
(self.source_host, self.source_project_name, self.source_branch_name) = (
562
parse_gitlab_branch_url(source_branch))
563
self.target_branch = target_branch
564
(self.target_host, self.target_project_name, self.target_branch_name) = (
565
parse_gitlab_branch_url(target_branch))
566
if self.source_host != self.target_host:
567
raise DifferentGitLabInstances(self.source_host, self.target_host)
569
def get_infotext(self):
570
"""Determine the initial comment for the merge proposal."""
572
info.append("Gitlab instance: %s\n" % self.target_host)
573
info.append("Source: %s\n" % self.source_branch.user_url)
574
info.append("Target: %s\n" % self.target_branch.user_url)
577
def get_initial_body(self):
578
"""Get a body for the proposal for the user to modify.
580
:return: a str or None.
584
def create_proposal(self, description, reviewers=None, labels=None,
585
prerequisite_branch=None, commit_message=None,
586
work_in_progress=False):
587
"""Perform the submission."""
588
# https://docs.gitlab.com/ee/api/merge_requests.html#create-mr
589
if prerequisite_branch is not None:
590
raise PrerequisiteBranchUnsupported(self)
591
# Note that commit_message is ignored, since Gitlab doesn't support it.
592
source_project = self.gl._get_project(self.source_project_name)
593
target_project = self.gl._get_project(self.target_project_name)
594
# TODO(jelmer): Allow setting title explicitly
595
title = determine_title(description)
597
title = 'WIP: %s' % title
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}'))
added
removed
breezy/plugins/propose/gitlabs.py
