91
119
def iter_tokens():
92
120
import configparser
93
from gitlab.config import _DEFAULT_FILES
94
121
config = configparser.ConfigParser()
95
config.read(_DEFAULT_FILES + [default_config_path()])
123
[os.path.expanduser(p) for p in _DEFAULT_FILES] +
124
[default_config_path()])
96
125
for name, section in config.items():
97
126
yield name, section
100
def connect_gitlab(host):
101
from gitlab import Gitlab, GitlabGetError
102
url = 'https://%s' % host
103
for name, section in iter_tokens():
104
if section.get('url') == url:
105
return Gitlab(**section)
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('/'):
109
except GitlabGetError:
110
raise GitLabLoginMissing()
113
def parse_gitlab_url(branch):
114
url = urlutils.split_segment_parameters(branch.user_url)[0]
139
def parse_gitlab_url(url):
115
140
(scheme, user, password, host, port, path) = urlutils.parse_url(
117
142
if scheme not in ('git+ssh', 'https', 'http'):
118
raise NotGitLabUrl(branch.user_url)
143
raise NotGitLabUrl(url)
120
raise NotGitLabUrl(branch.user_url)
145
raise NotGitLabUrl(url)
121
146
path = path.strip('/')
122
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)
124
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])
127
172
class GitLabMergeProposal(MergeProposal):
129
def __init__(self, mr):
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'])
134
return self._mr.web_url
186
return self._mr['web_url']
136
188
def get_description(self):
137
return self._mr.description
189
return self._mr['description']
139
191
def set_description(self, description):
140
self._mr.description = 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)
143
200
def _branch_url_from_project(self, project_id, branch_name):
144
project = self._mr.manager.gitlab.projects.get(project_id)
145
return gitlab_url_to_bzr_url(project.http_url_to_repo, 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)
147
206
def get_source_branch_url(self):
148
207
return self._branch_url_from_project(
149
self._mr.source_project_id, self._mr.source_branch)
208
self._mr['source_project_id'], self._mr['source_branch'])
151
210
def get_target_branch_url(self):
152
211
return self._branch_url_from_project(
153
self._mr.target_project_id, self._mr.target_branch)
212
self._mr['target_project_id'], self._mr['target_branch'])
155
214
def is_merged(self):
156
return (self._mr.state == 'merged')
215
return (self._mr['state'] == 'merged')
218
return (self._mr['state'] == 'closed')
221
return self._update(state_event='reopen')
159
self._mr.state_event = 'close'
224
self._update(state_event='close')
226
def merge(self, commit_message=None):
227
# https://docs.gitlab.com/ee/api/merge_requests.html#accept-mr
228
self._mr.merge(merge_commit_message=commit_message)
230
def can_be_merged(self):
231
if self._mr['merge_status'] == 'cannot_be_merged':
233
elif self._mr['merge_status'] == 'can_be_merged':
236
raise ValueError(self._mr['merge_status'])
163
239
def gitlab_url_to_bzr_url(url, name):
165
241
name = name.encode('utf-8')
166
return urlutils.join_segment_parameters(
167
git_url_to_bzr_url(url), {"branch": name})
242
return git_url_to_bzr_url(url, branch=name)
170
245
class GitLab(Hoster):
171
246
"""GitLab hoster implementation."""
173
248
supports_merge_proposal_labels = True
249
supports_merge_proposal_commit_message = False
175
251
def __repr__(self):
176
return "<GitLab(%r)>" % self.gl.url
252
return "<GitLab(%r)>" % self.base_url
179
255
def base_url(self):
182
def __init__(self, gl):
256
return self.transport.base
258
def _api_request(self, method, path, fields=None):
259
return self.transport.request(
260
method, urlutils.join(self.base_url, 'api', 'v4', path),
261
headers=self.headers, fields=fields)
263
def __init__(self, transport, private_token):
264
self.transport = transport
265
self.headers = {"Private-Token": private_token}
268
def _get_user(self, username):
269
path = 'users/%s' % urlutils.quote(str(project_name), '')
270
response = self._api_request('GET', path)
271
if response.status == 404:
272
raise KeyError('no such user %s' % username)
273
if response.status == 200:
274
return json.loads(response.data)
275
raise errors.InvalidHttpResponse(path, response.text)
277
def _get_user_by_email(self, username):
278
path = 'users?search=%s' % urlutils.quote(str(project_name), '')
279
response = self._api_request('GET', path)
280
if response.status == 404:
281
raise KeyError('no such user %s' % username)
282
if response.status == 200:
283
ret = json.loads(response.data)
285
raise ValueError('unexpected number of results; %r' % ret)
287
raise errors.InvalidHttpResponse(path, response.text)
289
def _get_project(self, project_name):
290
path = 'projects/%s' % urlutils.quote(str(project_name), '')
291
response = self._api_request('GET', path)
292
if response.status == 404:
293
raise NoSuchProject(project_name)
294
if response.status == 200:
295
return json.loads(response.data)
296
raise errors.InvalidHttpResponse(path, response.text)
298
def _fork_project(self, project_name, timeout=50, interval=5):
299
path = 'projects/%s/fork' % urlutils.quote(str(project_name), '')
300
response = self._api_request('POST', path)
301
if response.status not in (200, 201):
302
raise errors.InvalidHttpResponse(path, response.text)
303
# The response should be valid JSON, but let's ignore it
304
project = json.loads(response.data)
305
# Spin and wait until import_status for new project
307
deadline = time.time() + timeout
308
while project['import_status'] not in ('finished', 'none'):
309
mutter('import status is %s', project['import_status'])
310
if time.time() > deadline:
311
raise Exception('timeout waiting for project to become available')
313
project = self._get_project(project['path_with_namespace'])
316
def _get_logged_in_username(self):
317
return self._current_user['username']
319
def _list_paged(self, path, parameters=None, per_page=None):
320
if parameters is None:
323
parameters = dict(parameters.items())
325
parameters['per_page'] = str(per_page)
328
parameters['page'] = page
329
response = self._api_request(
331
';'.join(['%s=%s' % item for item in parameters.items()]))
332
if response.status == 403:
333
raise errors.PermissionDenied(response.text)
334
if response.status != 200:
335
raise errors.InvalidHttpResponse(path, response.text)
336
page = response.getheader("X-Next-Page")
337
for entry in json.loads(response.data):
340
def _list_merge_requests(self, owner=None, project=None, state=None):
341
if project is not None:
342
path = 'projects/%s/merge_requests' % urlutils.quote(str(project), '')
344
path = 'merge_requests'
347
parameters['state'] = state
349
parameters['owner_id'] = urlutils.quote(owner, '')
350
return self._list_paged(path, parameters, per_page=DEFAULT_PAGE_SIZE)
352
def _update_merge_request(self, project_id, iid, mr):
353
path = 'projects/%s/merge_requests/%s' % (
354
urlutils.quote(str(project_id), ''), iid)
355
response = self._api_request('PUT', path, fields=mr)
356
if response.status == 200:
357
return json.loads(response.data)
358
raise errors.InvalidHttpResponse(path, response.text)
360
def _create_mergerequest(
361
self, title, source_project_id, target_project_id,
362
source_branch_name, target_branch_name, description,
364
path = 'projects/%s/merge_requests' % source_project_id
367
'source_branch': source_branch_name,
368
'target_branch': target_branch_name,
369
'target_project_id': target_project_id,
370
'description': description,
373
fields['labels'] = labels
374
response = self._api_request('POST', path, fields=fields)
375
if response.status == 403:
376
raise errors.PermissionDenied(response.text)
377
if response.status == 409:
378
raise MergeProposalExists(self.source_branch.user_url)
379
if response.status != 201:
380
raise errors.InvalidHttpResponse(path, response.text)
381
return json.loads(response.data)
185
383
def get_push_url(self, branch):
186
(host, project_name, branch_name) = parse_gitlab_url(branch)
187
project = self.gl.projects.get(project_name)
384
(host, project_name, branch_name) = parse_gitlab_branch_url(branch)
385
project = self._get_project(project_name)
188
386
return gitlab_url_to_bzr_url(
189
project.ssh_url_to_repo, branch_name)
387
project['ssh_url_to_repo'], branch_name)
191
389
def publish_derived(self, local_branch, base_branch, name, project=None,
192
390
owner=None, revision_id=None, overwrite=False,
193
391
allow_lossy=True):
195
(host, base_project, base_branch_name) = parse_gitlab_url(base_branch)
198
base_project = self.gl.projects.get(base_project)
199
except gitlab.GitlabGetError as e:
200
if e.response_code == 404:
201
raise NoSuchProject(base_project)
392
(host, base_project, base_branch_name) = parse_gitlab_branch_url(base_branch)
204
393
if owner is None:
205
owner = self.gl.user.username
394
owner = self._get_logged_in_username()
206
395
if project is None:
207
project = base_project.path
396
project = self._get_project(base_project)['path']
209
target_project = self.gl.projects.get('%s/%s' % (owner, project))
210
except gitlab.GitlabGetError as e:
211
if e.response_code == 404:
212
target_project = base_project.forks.create({})
215
remote_repo_url = git_url_to_bzr_url(target_project.ssh_url_to_repo)
398
target_project = self._get_project('%s/%s' % (owner, project))
399
except NoSuchProject:
400
target_project = self._fork_project(base_project)
401
remote_repo_url = git_url_to_bzr_url(target_project['ssh_url_to_repo'])
216
402
remote_dir = controldir.ControlDir.open(remote_repo_url)
218
404
push_result = remote_dir.push_branch(
225
411
local_branch, revision_id=revision_id, overwrite=overwrite,
226
412
name=name, lossy=True)
227
413
public_url = gitlab_url_to_bzr_url(
228
target_project.http_url_to_repo, name)
414
target_project['http_url_to_repo'], name)
229
415
return push_result.target_branch, public_url
231
417
def get_derived_branch(self, base_branch, name, project=None, owner=None):
233
(host, base_project, base_branch_name) = parse_gitlab_url(base_branch)
236
base_project = self.gl.projects.get(base_project)
237
except gitlab.GitlabGetError as e:
238
if e.response_code == 404:
239
raise NoSuchProject(base_project)
418
(host, base_project, base_branch_name) = parse_gitlab_branch_url(base_branch)
242
419
if owner is None:
243
owner = self.gl.user.username
420
owner = self._get_logged_in_username()
244
421
if project is None:
245
project = base_project.path
422
project = self._get_project(base_project)['path']
247
target_project = self.gl.projects.get('%s/%s' % (owner, project))
248
except gitlab.GitlabGetError as e:
249
if e.response_code == 404:
250
raise errors.NotBranchError('%s/%s/%s' % (self.gl.url, owner, project))
424
target_project = self._get_project('%s/%s' % (owner, project))
425
except NoSuchProject:
426
raise errors.NotBranchError('%s/%s/%s' % (self.base_url, owner, project))
252
427
return _mod_branch.Branch.open(gitlab_url_to_bzr_url(
253
target_project.ssh_url_to_repo, name))
428
target_project['ssh_url_to_repo'], name))
255
430
def get_proposer(self, source_branch, target_branch):
256
return GitlabMergeProposalBuilder(self.gl, source_branch, target_branch)
431
return GitlabMergeProposalBuilder(self, source_branch, target_branch)
258
433
def iter_proposals(self, source_branch, target_branch, status):
260
434
(source_host, source_project_name, source_branch_name) = (
261
parse_gitlab_url(source_branch))
435
parse_gitlab_branch_url(source_branch))
262
436
(target_host, target_project_name, target_branch_name) = (
263
parse_gitlab_url(target_branch))
437
parse_gitlab_branch_url(target_branch))
264
438
if source_host != target_host:
265
439
raise DifferentGitLabInstances(source_host, target_host)
267
source_project = self.gl.projects.get(source_project_name)
268
target_project = self.gl.projects.get(target_project_name)
440
source_project = self._get_project(source_project_name)
441
target_project = self._get_project(target_project_name)
269
442
state = mp_status_to_status(status)
271
for mr in target_project.mergerequests.list(state=state):
272
if (mr.source_project_id != source_project.id or
273
mr.source_branch != source_branch_name or
274
mr.target_project_id != target_project.id or
275
mr.target_branch != target_branch_name):
277
yield GitLabMergeProposal(mr)
278
except gitlab.GitlabListError as e:
279
if e.response_code == 403:
280
raise errors.PermissionDenied(e.error_message)
443
for mr in self._list_merge_requests(
444
project=target_project['id'], state=state):
445
if (mr['source_project_id'] != source_project['id'] or
446
mr['source_branch'] != source_branch_name or
447
mr['target_project_id'] != target_project['id'] or
448
mr['target_branch'] != target_branch_name):
450
yield GitLabMergeProposal(self, mr)
282
452
def hosts(self, branch):
284
(host, project, branch_name) = parse_gitlab_url(branch)
454
(host, project, branch_name) = parse_gitlab_branch_url(branch)
285
455
except NotGitLabUrl:
287
return (self.gl.url == ('https://%s' % host))
457
return (self.base_url == ('https://%s' % host))
290
def probe(cls, branch):
292
(host, project, branch_name) = parse_gitlab_url(branch)
294
raise UnsupportedHoster(branch)
296
import requests.exceptions
298
gl = connect_gitlab(host)
300
except requests.exceptions.SSLError:
301
# Well, I guess it could be..
302
raise UnsupportedHoster(branch)
303
except gitlab.GitlabGetError:
304
raise UnsupportedHoster(branch)
305
except gitlab.GitlabHttpError as e:
306
if e.response_code in (404, 405, 503):
307
raise UnsupportedHoster(branch)
460
response = self._api_request('GET', 'user')
461
if response.status == 200:
462
self._current_user = json.loads(response.data)
465
if json.loads(response.data) == {"message": "401 Unauthorized"}:
466
raise GitLabLoginMissing()
468
raise GitlabLoginError(response.text)
469
raise UnsupportedHoster(url)
472
def probe_from_url(cls, url, possible_transports=None):
474
(host, project) = parse_gitlab_url(url)
476
raise UnsupportedHoster(url)
477
transport = get_transport(
478
'https://%s' % host, possible_transports=possible_transports)
479
credentials = get_credentials_by_url(transport.base)
480
if credentials is not None:
481
return cls(transport, credentials.get('private_token'))
482
raise UnsupportedHoster(url)
313
485
def iter_instances(cls):
314
from gitlab import Gitlab
315
486
for name, credentials in iter_tokens():
316
487
if 'url' not in credentials:
318
gl = Gitlab(**credentials)
490
get_transport(credentials['url']),
491
private_token=credentials.get('private_token'))
321
493
def iter_my_proposals(self, status='open'):
322
494
state = mp_status_to_status(status)
324
for mp in self.gl.mergerequests.list(
325
owner=self.gl.user.username, state=state):
326
yield GitLabMergeProposal(mp)
495
for mp in self._list_merge_requests(
496
owner=self._get_logged_in_username(), state=state):
497
yield GitLabMergeProposal(self, mp)
499
def get_proposal_by_url(self, url):
501
(host, project, merge_id) = parse_gitlab_merge_request_url(url)
503
raise UnsupportedHoster(url)
504
except NotMergeRequestUrl as e:
505
if self.base_url == ('https://%s' % e.host):
508
raise UnsupportedHoster(url)
509
if self.base_url != ('https://%s' % host):
510
raise UnsupportedHoster(url)
511
project = self._get_project(project)
512
mr = project.mergerequests.get(merge_id)
513
return GitLabMergeProposal(mr)
329
516
class GitlabMergeProposalBuilder(MergeProposalBuilder):