/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to breezy/plugins/propose/gitlabs.py

  • Committer: Jelmer Vernooij
  • Date: 2019-06-16 02:23:42 UTC
  • mfrom: (7340 work)
  • mto: This revision was merged to the branch mainline in revision 7350.
  • Revision ID: jelmer@jelmer.uk-20190616022342-ihxzayq04x5culzd
merge trunk.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/plugins/propose/gitlabs.py
18
18
 
19
19
from __future__ import absolute_import
20
20
 
 
21
import json
 
22
import os
 
23
 
21
24
from ... import (
22
25
    branch as _mod_branch,
23
26
    controldir,
26
29
    )
27
30
from ...git.urls import git_url_to_bzr_url
28
31
from ...sixish import PY3
 
32
from ...transport import get_transport
29
33
 
30
34
from .propose import (
31
35
    Hoster,
37
41
    UnsupportedHoster,
38
42
    )
39
43
 
 
44
 
 
45
_DEFAULT_FILES = ['/etc/python-gitlab.cfg', '~/.python-gitlab.cfg']
 
46
 
 
47
 
40
48
def mp_status_to_status(status):
41
49
    return {
42
50
        'all': 'all',
79
87
    _fmt = ("Please log into GitLab")
80
88
 
81
89
 
 
90
class GitlabLoginError(errors.BzrError):
 
91
 
 
92
    _fmt = ("Error logging in: %(error)s")
 
93
 
 
94
    def __init__(self, error):
 
95
        self.error = error
 
96
 
 
97
 
82
98
def default_config_path():
83
99
    from breezy.config import config_dir
84
100
    import os
100
116
 
101
117
def iter_tokens():
102
118
    import configparser
103
 
    from gitlab.config import _DEFAULT_FILES
104
119
    config = configparser.ConfigParser()
105
 
    config.read(_DEFAULT_FILES + [default_config_path()])
 
120
    config.read(
 
121
        [os.path.expanduser(p) for p in _DEFAULT_FILES] +
 
122
        [default_config_path()])
106
123
    for name, section in config.items():
107
124
        yield name, section
108
125
 
109
126
 
110
 
def connect_gitlab(host):
111
 
    from gitlab import Gitlab, GitlabGetError
112
 
    url = 'https://%s' % host
113
 
    for name, section in iter_tokens():
114
 
        if section.get('url') == url:
115
 
            return Gitlab(**section)
116
 
    else:
117
 
        try:
118
 
            return Gitlab(url)
119
 
        except GitlabGetError:
120
 
            raise GitLabLoginMissing()
121
 
 
122
 
 
123
127
def parse_gitlab_url(url):
124
128
    (scheme, user, password, host, port, path) = urlutils.parse_url(
125
129
        url)
155
159
 
156
160
class GitLabMergeProposal(MergeProposal):
157
161
 
158
 
    def __init__(self, mr):
 
162
    def __init__(self, gl, mr):
 
163
        self.gl = gl
159
164
        self._mr = mr
160
165
 
161
166
    @property
162
167
    def url(self):
163
 
        return self._mr.web_url
 
168
        return self._mr['web_url']
164
169
 
165
170
    def get_description(self):
166
 
        return self._mr.description
 
171
        return self._mr['description']
167
172
 
168
173
    def set_description(self, description):
169
 
        self._mr.description = description
170
 
        self._mr.save()
 
174
        self._mr['description'] = description
 
175
        self.gl._update_merge_requests(self._mr)
171
176
 
172
177
    def get_commit_message(self):
173
178
        return None
174
179
 
175
180
    def _branch_url_from_project(self, project_id, branch_name):
176
 
        project = self._mr.manager.gitlab.projects.get(project_id)
177
 
        return gitlab_url_to_bzr_url(project.http_url_to_repo, branch_name)
 
181
        project = self.gl._get_project(project_id)
 
182
        return gitlab_url_to_bzr_url(project['http_url_to_repo'], branch_name)
178
183
 
179
184
    def get_source_branch_url(self):
180
185
        return self._branch_url_from_project(
181
 
            self._mr.source_project_id, self._mr.source_branch)
 
186
            self._mr['source_project_id'], self._mr['source_branch'])
182
187
 
183
188
    def get_target_branch_url(self):
184
189
        return self._branch_url_from_project(
185
 
            self._mr.target_project_id, self._mr.target_branch)
 
190
            self._mr['target_project_id'], self._mr['target_branch'])
186
191
 
187
192
    def is_merged(self):
188
 
        return (self._mr.state == 'merged')
 
193
        return (self._mr['state'] == 'merged')
189
194
 
190
195
    def close(self):
191
 
        self._mr.state_event = 'close'
192
 
        self._mr.save()
 
196
        self._mr['state_event'] = 'close'
 
197
        self.gl._update_merge_requests(self._mr)
193
198
 
194
199
    def merge(self, commit_message=None):
195
200
        # https://docs.gitlab.com/ee/api/merge_requests.html#accept-mr
210
215
    supports_merge_proposal_commit_message = False
211
216
 
212
217
    def __repr__(self):
213
 
        return "<GitLab(%r)>" % self.gl.url
 
218
        return "<GitLab(%r)>" % self.base_url
214
219
 
215
220
    @property
216
221
    def base_url(self):
217
 
        return self.gl.url
218
 
 
219
 
    def __init__(self, gl):
220
 
        self.gl = gl
 
222
        return self.transport.base
 
223
 
 
224
    def _api_request(self, method, path):
 
225
        return self.transport.request(
 
226
            method, urlutils.join(self.base_url, 'api', 'v4', path),
 
227
            headers=self.headers)
 
228
 
 
229
    def __init__(self, transport, private_token):
 
230
        self.transport = transport
 
231
        self.headers = {"Private-Token": private_token}
 
232
        self.check()
 
233
 
 
234
    def _get_project(self, project_name):
 
235
        path = 'projects/:%s' % urlutils.quote(str(project_name), '')
 
236
        response = self._api_request('GET', path)
 
237
        if response.status == 404:
 
238
            raise NoSuchProject(project_name)
 
239
        if response.status == 200:
 
240
            return json.loads(response.data)
 
241
        raise InvalidHttpResponse(path, response.text)
 
242
 
 
243
    def _fork_project(self, project_name):
 
244
        path = 'projects/:%s/fork' % urlutils.quote(str(project_name), '')
 
245
        response = self._api_request('POST', path)
 
246
        if response != 200:
 
247
            raise InvalidHttpResponse(path, response.text)
 
248
        return json.loads(response.data)
 
249
 
 
250
    def _get_logged_in_username(self):
 
251
        return self._current_user['username']
 
252
 
 
253
    def _list_merge_requests(self, owner=None, project=None, state=None):
 
254
        if project is not None:
 
255
            path = 'projects/:%s/merge_requests' % urlutils.quote(str(project_name), '')
 
256
        else:
 
257
            path = 'merge_requests'
 
258
        parameters = {}
 
259
        if state:
 
260
            parameters['state'] = state
 
261
        if owner:
 
262
            parameters['owner_id'] = urlutils.quote(owner, '')
 
263
        response = self._api_request(
 
264
            'GET', path + '?' +
 
265
            ';'.join(['%s=%s' % item for item in parameters.items()]))
 
266
        if response.status == 403:
 
267
            raise errors.PermissionDenied(response.text)
 
268
        if response.status == 200:
 
269
            return json.loads(response.data)
 
270
        raise InvalidHttpResponse(path, response.text)
 
271
 
 
272
    def _create_mergerequest(
 
273
            self, title, source_project_id, target_project_id,
 
274
            source_branch_name, target_branch_name, description,
 
275
            labels=None):
 
276
        path = 'projects/:%s/merge_requests' % source_project_id
 
277
        response = self._api_request(
 
278
            'POST', path, fields={
 
279
                'title': title,
 
280
                'source_branch': source_branch_name,
 
281
                'target_branch': target_branch_name,
 
282
                'target_project_id': target_project_id,
 
283
                'description': description,
 
284
                'labels': labels})
 
285
        if response.status == 403:
 
286
            raise errors.PermissionDenied(response.text)
 
287
        if response.status == 409:
 
288
            raise MergeProposalExists(self.source_branch.user_url)
 
289
        if response.status == 200:
 
290
            raise InvalidHttpResponse(path, response.text)
 
291
        return json.loads(response.data)
221
292
 
222
293
    def get_push_url(self, branch):
223
294
        (host, project_name, branch_name) = parse_gitlab_branch_url(branch)
224
 
        project = self.gl.projects.get(project_name)
 
295
        project = self._get_project(project_name)
225
296
        return gitlab_url_to_bzr_url(
226
 
            project.ssh_url_to_repo, branch_name)
 
297
            project['ssh_url_to_repo'], branch_name)
227
298
 
228
299
    def publish_derived(self, local_branch, base_branch, name, project=None,
229
300
                        owner=None, revision_id=None, overwrite=False,
230
301
                        allow_lossy=True):
231
 
        import gitlab
232
302
        (host, base_project, base_branch_name) = parse_gitlab_branch_url(base_branch)
233
 
        self.gl.auth()
234
 
        try:
235
 
            base_project = self.gl.projects.get(base_project)
236
 
        except gitlab.GitlabGetError as e:
237
 
            if e.response_code == 404:
238
 
                raise NoSuchProject(base_project)
239
 
            else:
240
 
                raise
241
303
        if owner is None:
242
 
            owner = self.gl.user.username
 
304
            owner = self._get_logged_in_username()
243
305
        if project is None:
244
 
            project = base_project.path
 
306
            project = self._get_project(base_project)['path']
245
307
        try:
246
 
            target_project = self.gl.projects.get('%s/%s' % (owner, project))
247
 
        except gitlab.GitlabGetError as e:
248
 
            if e.response_code == 404:
249
 
                target_project = base_project.forks.create({})
250
 
            else:
251
 
                raise
252
 
        remote_repo_url = git_url_to_bzr_url(target_project.ssh_url_to_repo)
 
308
            target_project = self._get_project('%s/%s' % (owner, project))
 
309
        except NoSuchProject:
 
310
            target_project = self._fork_project(base_project)
 
311
            # TODO(jelmer): Spin and wait until import_status for new project
 
312
            # is complete.
 
313
        remote_repo_url = git_url_to_bzr_url(target_project['ssh_url_to_repo'])
253
314
        remote_dir = controldir.ControlDir.open(remote_repo_url)
254
315
        try:
255
316
            push_result = remote_dir.push_branch(
262
323
                local_branch, revision_id=revision_id, overwrite=overwrite,
263
324
                name=name, lossy=True)
264
325
        public_url = gitlab_url_to_bzr_url(
265
 
            target_project.http_url_to_repo, name)
 
326
            target_project['http_url_to_repo'], name)
266
327
        return push_result.target_branch, public_url
267
328
 
268
329
    def get_derived_branch(self, base_branch, name, project=None, owner=None):
269
 
        import gitlab
270
330
        (host, base_project, base_branch_name) = parse_gitlab_branch_url(base_branch)
271
 
        self.gl.auth()
272
 
        try:
273
 
            base_project = self.gl.projects.get(base_project)
274
 
        except gitlab.GitlabGetError as e:
275
 
            if e.response_code == 404:
276
 
                raise NoSuchProject(base_project)
277
 
            else:
278
 
                raise
279
331
        if owner is None:
280
 
            owner = self.gl.user.username
 
332
            owner = self._get_logged_in_username()
281
333
        if project is None:
282
 
            project = base_project.path
 
334
            project = self._get_project(base_project)['path']
283
335
        try:
284
 
            target_project = self.gl.projects.get('%s/%s' % (owner, project))
285
 
        except gitlab.GitlabGetError as e:
286
 
            if e.response_code == 404:
287
 
                raise errors.NotBranchError('%s/%s/%s' % (self.gl.url, owner, project))
288
 
            raise
 
336
            target_project = self._get_project('%s/%s' % (owner, project))
 
337
        except NoSuchProject:
 
338
            raise errors.NotBranchError('%s/%s/%s' % (self.base_url, owner, project))
289
339
        return _mod_branch.Branch.open(gitlab_url_to_bzr_url(
290
 
            target_project.ssh_url_to_repo, name))
 
340
            target_project['ssh_url_to_repo'], name))
291
341
 
292
342
    def get_proposer(self, source_branch, target_branch):
293
 
        return GitlabMergeProposalBuilder(self.gl, source_branch, target_branch)
 
343
        return GitlabMergeProposalBuilder(self, source_branch, target_branch)
294
344
 
295
345
    def iter_proposals(self, source_branch, target_branch, status):
296
 
        import gitlab
297
346
        (source_host, source_project_name, source_branch_name) = (
298
347
            parse_gitlab_branch_url(source_branch))
299
348
        (target_host, target_project_name, target_branch_name) = (
300
349
            parse_gitlab_branch_url(target_branch))
301
350
        if source_host != target_host:
302
351
            raise DifferentGitLabInstances(source_host, target_host)
303
 
        self.gl.auth()
304
 
        source_project = self.gl.projects.get(source_project_name)
305
 
        target_project = self.gl.projects.get(target_project_name)
 
352
        source_project = self._get_project(source_project_name)
 
353
        target_project = self._get_project(target_project_name)
306
354
        state = mp_status_to_status(status)
307
 
        try:
308
 
            for mr in target_project.mergerequests.list(state=state):
309
 
                if (mr.source_project_id != source_project.id or
310
 
                        mr.source_branch != source_branch_name or
311
 
                        mr.target_project_id != target_project.id or
312
 
                        mr.target_branch != target_branch_name):
313
 
                    continue
314
 
                yield GitLabMergeProposal(mr)
315
 
        except gitlab.GitlabListError as e:
316
 
            if e.response_code == 403:
317
 
                raise errors.PermissionDenied(e.error_message)
 
355
        for mr in self.gl._list_merge_requests(
 
356
                project=target_project['id'], state=state):
 
357
            if (mr['source_project_id'] != source_project['id'] or
 
358
                    mr['source_branch'] != source_branch_name or
 
359
                    mr['target_project_id'] != target_project['id'] or
 
360
                    mr['target_branch'] != target_branch_name):
 
361
                continue
 
362
            yield GitLabMergeProposal(self, mr)
318
363
 
319
364
    def hosts(self, branch):
320
365
        try:
321
366
            (host, project, branch_name) = parse_gitlab_branch_url(branch)
322
367
        except NotGitLabUrl:
323
368
            return False
324
 
        return (self.gl.url == ('https://%s' % host))
 
369
        return (self.base_url == ('https://%s' % host))
 
370
 
 
371
    def check(self):
 
372
        response = self._api_request('GET', 'user')
 
373
        if response.status == 200:
 
374
            self._current_user = json.loads(response.data)
 
375
            return
 
376
        if response == 401:
 
377
            if json.loads(response.data) == {"message": "401 Unauthorized"}:
 
378
                raise GitLabLoginMissing()
 
379
            else:
 
380
                raise GitlabLoginError(response.text)
 
381
        raise UnsupportedHoster(url)
325
382
 
326
383
    @classmethod
327
 
    def probe_from_url(cls, url):
 
384
    def probe_from_url(cls, url, possible_transports=None):
328
385
        try:
329
386
            (host, project) = parse_gitlab_url(url)
330
387
        except NotGitLabUrl:
331
388
            raise UnsupportedHoster(url)
332
 
        import gitlab
333
 
        import requests.exceptions
334
 
        try:
335
 
            gl = connect_gitlab(host)
336
 
            gl.auth()
337
 
        except requests.exceptions.SSLError:
338
 
            # Well, I guess it could be..
339
 
            raise UnsupportedHoster(url)
340
 
        except gitlab.GitlabGetError:
341
 
            raise UnsupportedHoster(url)
342
 
        except gitlab.GitlabHttpError as e:
343
 
            if e.response_code in (404, 405, 503):
344
 
                raise UnsupportedHoster(url)
345
 
            else:
346
 
                raise
347
 
        return cls(gl)
 
389
        transport = get_transport(
 
390
            'https://%s' % host, possible_transports=possible_transports)
 
391
        return cls(transport)
348
392
 
349
393
    @classmethod
350
394
    def iter_instances(cls):
351
 
        from gitlab import Gitlab
352
395
        for name, credentials in iter_tokens():
353
396
            if 'url' not in credentials:
354
397
                continue
355
 
            gl = Gitlab(**credentials)
356
 
            yield cls(gl)
 
398
            yield cls(
 
399
                get_transport(credentials['url']),
 
400
                private_token=credentials.get('private_token'))
357
401
 
358
402
    def iter_my_proposals(self, status='open'):
359
403
        state = mp_status_to_status(status)
360
 
        self.gl.auth()
361
 
        for mp in self.gl.mergerequests.list(
362
 
                owner=self.gl.user.username, state=state):
363
 
            yield GitLabMergeProposal(mp)
 
404
        for mp in self._list_merge_requests(
 
405
                owner=self._get_logged_in_username(), state=state):
 
406
            yield GitLabMergeProposal(self, mp)
364
407
 
365
408
    def get_proposal_by_url(self, url):
366
409
        try:
381
424
 
382
425
class GitlabMergeProposalBuilder(MergeProposalBuilder):
383
426
 
384
 
    def __init__(self, gl, source_branch, target_branch):
 
427
    def __init__(self, l, source_branch, target_branch):
385
428
        self.gl = gl
386
429
        self.source_branch = source_branch
387
430
        (self.source_host, self.source_project_name, self.source_branch_name) = (
413
456
        # https://docs.gitlab.com/ee/api/merge_requests.html#create-mr
414
457
        if prerequisite_branch is not None:
415
458
            raise PrerequisiteBranchUnsupported(self)
416
 
        import gitlab
417
459
        # Note that commit_message is ignored, since Gitlab doesn't support it.
418
460
        # TODO(jelmer): Support reviewers
419
 
        self.gl.auth()
420
 
        source_project = self.gl.projects.get(self.source_project_name)
421
 
        target_project = self.gl.projects.get(self.target_project_name)
 
461
        source_project = self.gl._get_project(self.source_project_name)
 
462
        target_project = self.gl._get_project(self.target_project_name)
422
463
        # TODO(jelmer): Allow setting title explicitly
423
464
        title = description.splitlines()[0]
424
465
        # TODO(jelmer): Allow setting allow_collaboration field
426
467
        # TODO(jelmer): Allow setting squash field
427
468
        kwargs = {
428
469
            'title': title,
429
 
            'target_project_id': target_project.id,
 
470
            'source_project_id': source_project['id'],
 
471
            'target_project_id': target_project['id'],
430
472
            'source_branch': self.source_branch_name,
431
473
            'target_branch': self.target_branch_name,
432
474
            'description': description}
433
475
        if labels:
434
476
            kwargs['labels'] = ','.join(labels)
435
 
        try:
436
 
            merge_request = source_project.mergerequests.create(kwargs)
437
 
        except gitlab.GitlabCreateError as e:
438
 
            if e.response_code == 403:
439
 
                raise errors.PermissionDenied(e.error_message)
440
 
            if e.response_code == 409:
441
 
                raise MergeProposalExists(self.source_branch.user_url)
442
 
            raise
443
 
        return GitLabMergeProposal(merge_request)
 
477
        merge_request = self.gl._create_mergerequest(**kwargs)
 
478
        return GitLabMergeProposal(self.gl, merge_request)
444
479
 
445
480
 
446
481
def register_gitlab_instance(shortname, url):