/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-09-29 12:45:26 UTC
  • mto: This revision was merged to the branch mainline in revision 7402.
  • Revision ID: jelmer@jelmer.uk-20190929124526-f2o8u8rk883l2g8o
Remove unused _iter_children function.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/plugins/propose/gitlabs.py
 
1
# Copyright (C) 2018 Breezy Developers
 
2
#
 
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.
 
7
#
 
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.
 
12
#
 
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
 
16
 
 
17
"""Support for GitLab."""
 
18
 
 
19
from __future__ import absolute_import
 
20
 
 
21
import json
 
22
import os
 
23
import time
 
24
 
 
25
from ... import (
 
26
    bedding,
 
27
    branch as _mod_branch,
 
28
    controldir,
 
29
    errors,
 
30
    urlutils,
 
31
    )
 
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
 
36
 
 
37
from .propose import (
 
38
    Hoster,
 
39
    MergeProposal,
 
40
    MergeProposalBuilder,
 
41
    MergeProposalExists,
 
42
    NoSuchProject,
 
43
    PrerequisiteBranchUnsupported,
 
44
    UnsupportedHoster,
 
45
    )
 
46
 
 
47
 
 
48
_DEFAULT_FILES = ['/etc/python-gitlab.cfg', '~/.python-gitlab.cfg']
 
49
 
 
50
 
 
51
def mp_status_to_status(status):
 
52
    return {
 
53
        'all': 'all',
 
54
        'open': 'opened',
 
55
        'merged': 'merged',
 
56
        'closed': 'closed'}[status]
 
57
 
 
58
 
 
59
class NotGitLabUrl(errors.BzrError):
 
60
 
 
61
    _fmt = "Not a GitLab URL: %(url)s"
 
62
 
 
63
    def __init__(self, url):
 
64
        errors.BzrError.__init__(self)
 
65
        self.url = url
 
66
 
 
67
 
 
68
class NotMergeRequestUrl(errors.BzrError):
 
69
 
 
70
    _fmt = "Not a merge proposal URL: %(url)s"
 
71
 
 
72
    def __init__(self, host, url):
 
73
        errors.BzrError.__init__(self)
 
74
        self.host = host
 
75
        self.url = url
 
76
 
 
77
 
 
78
class DifferentGitLabInstances(errors.BzrError):
 
79
 
 
80
    _fmt = ("Can't create merge proposals across GitLab instances: "
 
81
            "%(source_host)s and %(target_host)s")
 
82
 
 
83
    def __init__(self, source_host, target_host):
 
84
        self.source_host = source_host
 
85
        self.target_host = target_host
 
86
 
 
87
 
 
88
class GitLabLoginMissing(errors.BzrError):
 
89
 
 
90
    _fmt = ("Please log into GitLab")
 
91
 
 
92
 
 
93
class GitlabLoginError(errors.BzrError):
 
94
 
 
95
    _fmt = ("Error logging in: %(error)s")
 
96
 
 
97
    def __init__(self, error):
 
98
        self.error = error
 
99
 
 
100
 
 
101
def default_config_path():
 
102
    return os.path.join(bedding.config_dir(), 'gitlab.conf')
 
103
 
 
104
 
 
105
def store_gitlab_token(name, url, private_token):
 
106
    """Store a GitLab token in a configuration file."""
 
107
    import configparser
 
108
    config = configparser.ConfigParser()
 
109
    path = default_config_path()
 
110
    config.read([path])
 
111
    config.add_section(name)
 
112
    config[name]['url'] = url
 
113
    config[name]['private_token'] = private_token
 
114
    with open(path, 'w') as f:
 
115
        config.write(f)
 
116
 
 
117
 
 
118
def iter_tokens():
 
119
    import configparser
 
120
    config = configparser.ConfigParser()
 
121
    config.read(
 
122
        [os.path.expanduser(p) for p in _DEFAULT_FILES] +
 
123
        [default_config_path()])
 
124
    for name, section in config.items():
 
125
        yield name, section
 
126
 
 
127
 
 
128
def get_credentials_by_url(url):
 
129
    for name, credentials in iter_tokens():
 
130
        if 'url' not in credentials:
 
131
            continue
 
132
        if credentials['url'].rstrip('/') == url.rstrip('/'):
 
133
            return credentials
 
134
    else:
 
135
        return None
 
136
 
 
137
 
 
138
def parse_gitlab_url(url):
 
139
    (scheme, user, password, host, port, path) = urlutils.parse_url(
 
140
        url)
 
141
    if scheme not in ('git+ssh', 'https', 'http'):
 
142
        raise NotGitLabUrl(url)
 
143
    if not host:
 
144
        raise NotGitLabUrl(url)
 
145
    path = path.strip('/')
 
146
    if path.endswith('.git'):
 
147
        path = path[:-4]
 
148
    return host, path
 
149
 
 
150
 
 
151
def parse_gitlab_branch_url(branch):
 
152
    url = urlutils.split_segment_parameters(branch.user_url)[0]
 
153
    host, path = parse_gitlab_url(url)
 
154
    return host, path, branch.name
 
155
 
 
156
 
 
157
def parse_gitlab_merge_request_url(url):
 
158
    (scheme, user, password, host, port, path) = urlutils.parse_url(
 
159
        url)
 
160
    if scheme not in ('git+ssh', 'https', 'http'):
 
161
        raise NotGitLabUrl(url)
 
162
    if not host:
 
163
        raise NotGitLabUrl(url)
 
164
    path = path.strip('/')
 
165
    parts = path.split('/')
 
166
    if parts[-2] != 'merge_requests':
 
167
        raise NotMergeRequestUrl(host, url)
 
168
    return host, '/'.join(parts[:-2]), int(parts[-1])
 
169
 
 
170
 
 
171
class GitLabMergeProposal(MergeProposal):
 
172
 
 
173
    def __init__(self, gl, mr):
 
174
        self.gl = gl
 
175
        self._mr = mr
 
176
 
 
177
    def _update(self, **kwargs):
 
178
        self.gl._update_merge_request(self._mr['project_id'], self._mr['iid'], kwargs)
 
179
 
 
180
    def __repr__(self):
 
181
        return "<%s at %r>" % (type(self).__name__, self._mr['web_url'])
 
182
 
 
183
    @property
 
184
    def url(self):
 
185
        return self._mr['web_url']
 
186
 
 
187
    def get_description(self):
 
188
        return self._mr['description']
 
189
 
 
190
    def set_description(self, description):
 
191
        self._update(description=description, title=description.splitlines()[0])
 
192
 
 
193
    def get_commit_message(self):
 
194
        return self._mr.get('merge_commit_message')
 
195
 
 
196
    def set_commit_message(self, message):
 
197
        raise errors.UnsupportedOperation(self.set_commit_message, self)
 
198
 
 
199
    def _branch_url_from_project(self, project_id, branch_name):
 
200
        if project_id is None:
 
201
            return None
 
202
        project = self.gl._get_project(project_id)
 
203
        return gitlab_url_to_bzr_url(project['http_url_to_repo'], branch_name)
 
204
 
 
205
    def get_source_branch_url(self):
 
206
        return self._branch_url_from_project(
 
207
            self._mr['source_project_id'], self._mr['source_branch'])
 
208
 
 
209
    def get_target_branch_url(self):
 
210
        return self._branch_url_from_project(
 
211
            self._mr['target_project_id'], self._mr['target_branch'])
 
212
 
 
213
    def is_merged(self):
 
214
        return (self._mr['state'] == 'merged')
 
215
 
 
216
    def is_closed(self):
 
217
        return (self._mr['state'] == 'closed')
 
218
 
 
219
    def reopen(self):
 
220
        return self._update(state_event='open')
 
221
 
 
222
    def close(self):
 
223
        self._update(state_event='close')
 
224
 
 
225
    def merge(self, commit_message=None):
 
226
        # https://docs.gitlab.com/ee/api/merge_requests.html#accept-mr
 
227
        self._mr.merge(merge_commit_message=commit_message)
 
228
 
 
229
    def can_be_merged(self):
 
230
        if self._mr['merge_status'] == 'cannot_be_merged':
 
231
            return False
 
232
        elif self._mr['merge_status'] == 'can_be_merged':
 
233
            return True
 
234
        else:
 
235
            raise ValueError(self._mr['merge_status'])
 
236
 
 
237
 
 
238
def gitlab_url_to_bzr_url(url, name):
 
239
    if not PY3:
 
240
        name = name.encode('utf-8')
 
241
    return urlutils.join_segment_parameters(
 
242
        git_url_to_bzr_url(url), {"branch": name})
 
243
 
 
244
 
 
245
class GitLab(Hoster):
 
246
    """GitLab hoster implementation."""
 
247
 
 
248
    supports_merge_proposal_labels = True
 
249
    supports_merge_proposal_commit_message = False
 
250
 
 
251
    def __repr__(self):
 
252
        return "<GitLab(%r)>" % self.base_url
 
253
 
 
254
    @property
 
255
    def base_url(self):
 
256
        return self.transport.base
 
257
 
 
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)
 
262
 
 
263
    def __init__(self, transport, private_token):
 
264
        self.transport = transport
 
265
        self.headers = {"Private-Token": private_token}
 
266
        self.check()
 
267
 
 
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)
 
276
 
 
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)
 
284
            if len(ret) != 1:
 
285
                raise ValueError('unexpected number of results; %r' % ret)
 
286
            return ret[0]
 
287
        raise errors.InvalidHttpResponse(path, response.text)
 
288
 
 
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)
 
297
 
 
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
        json.loads(response.data)
 
305
        # Spin and wait until import_status for new project
 
306
        # is complete.
 
307
        deadline = time.time() + timeout
 
308
        while True:
 
309
            project = self._get_project(project_name)
 
310
            if project['import_status'] in ('finished', 'none'):
 
311
                return project
 
312
            mutter('import status is %s', project['import_status'])
 
313
            if time.time() > deadline:
 
314
                raise Exception('timeout waiting for project to become available')
 
315
            time.sleep(interval)
 
316
 
 
317
    def _get_logged_in_username(self):
 
318
        return self._current_user['username']
 
319
 
 
320
    def _list_merge_requests(self, owner=None, project=None, state=None):
 
321
        if project is not None:
 
322
            path = 'projects/%s/merge_requests' % urlutils.quote(str(project), '')
 
323
        else:
 
324
            path = 'merge_requests'
 
325
        parameters = {}
 
326
        if state:
 
327
            parameters['state'] = state
 
328
        if owner:
 
329
            parameters['owner_id'] = urlutils.quote(owner, '')
 
330
        response = self._api_request(
 
331
            'GET', path + '?' +
 
332
            ';'.join(['%s=%s' % item for item in parameters.items()]))
 
333
        if response.status == 403:
 
334
            raise errors.PermissionDenied(response.text)
 
335
        if response.status == 200:
 
336
            return json.loads(response.data)
 
337
        raise errors.InvalidHttpResponse(path, response.text)
 
338
 
 
339
    def _update_merge_request(self, project_id, iid, mr):
 
340
        path = 'projects/%s/merge_requests/%s' % (
 
341
            urlutils.quote(str(project_id), ''), iid)
 
342
        response = self._api_request('PUT', path, fields=mr)
 
343
        if response.status == 200:
 
344
            return json.loads(response.data)
 
345
        raise errors.InvalidHttpResponse(path, response.text)
 
346
 
 
347
    def _create_mergerequest(
 
348
            self, title, source_project_id, target_project_id,
 
349
            source_branch_name, target_branch_name, description,
 
350
            labels=None):
 
351
        path = 'projects/%s/merge_requests' % source_project_id
 
352
        fields = {
 
353
            'title': title,
 
354
            'source_branch': source_branch_name,
 
355
            'target_branch': target_branch_name,
 
356
            'target_project_id': target_project_id,
 
357
            'description': description,
 
358
            }
 
359
        if labels:
 
360
            fields['labels'] = labels
 
361
        response = self._api_request('POST', path, fields=fields)
 
362
        if response.status == 403:
 
363
            raise errors.PermissionDenied(response.text)
 
364
        if response.status == 409:
 
365
            raise MergeProposalExists(self.source_branch.user_url)
 
366
        if response.status != 201:
 
367
            raise errors.InvalidHttpResponse(path, response.text)
 
368
        return json.loads(response.data)
 
369
 
 
370
    def get_push_url(self, branch):
 
371
        (host, project_name, branch_name) = parse_gitlab_branch_url(branch)
 
372
        project = self._get_project(project_name)
 
373
        return gitlab_url_to_bzr_url(
 
374
            project['ssh_url_to_repo'], branch_name)
 
375
 
 
376
    def publish_derived(self, local_branch, base_branch, name, project=None,
 
377
                        owner=None, revision_id=None, overwrite=False,
 
378
                        allow_lossy=True):
 
379
        (host, base_project, base_branch_name) = parse_gitlab_branch_url(base_branch)
 
380
        if owner is None:
 
381
            owner = self._get_logged_in_username()
 
382
        if project is None:
 
383
            project = self._get_project(base_project)['path']
 
384
        try:
 
385
            target_project = self._get_project('%s/%s' % (owner, project))
 
386
        except NoSuchProject:
 
387
            target_project = self._fork_project(base_project)
 
388
        remote_repo_url = git_url_to_bzr_url(target_project['ssh_url_to_repo'])
 
389
        remote_dir = controldir.ControlDir.open(remote_repo_url)
 
390
        try:
 
391
            push_result = remote_dir.push_branch(
 
392
                local_branch, revision_id=revision_id, overwrite=overwrite,
 
393
                name=name)
 
394
        except errors.NoRoundtrippingSupport:
 
395
            if not allow_lossy:
 
396
                raise
 
397
            push_result = remote_dir.push_branch(
 
398
                local_branch, revision_id=revision_id, overwrite=overwrite,
 
399
                name=name, lossy=True)
 
400
        public_url = gitlab_url_to_bzr_url(
 
401
            target_project['http_url_to_repo'], name)
 
402
        return push_result.target_branch, public_url
 
403
 
 
404
    def get_derived_branch(self, base_branch, name, project=None, owner=None):
 
405
        (host, base_project, base_branch_name) = parse_gitlab_branch_url(base_branch)
 
406
        if owner is None:
 
407
            owner = self._get_logged_in_username()
 
408
        if project is None:
 
409
            project = self._get_project(base_project)['path']
 
410
        try:
 
411
            target_project = self._get_project('%s/%s' % (owner, project))
 
412
        except NoSuchProject:
 
413
            raise errors.NotBranchError('%s/%s/%s' % (self.base_url, owner, project))
 
414
        return _mod_branch.Branch.open(gitlab_url_to_bzr_url(
 
415
            target_project['ssh_url_to_repo'], name))
 
416
 
 
417
    def get_proposer(self, source_branch, target_branch):
 
418
        return GitlabMergeProposalBuilder(self, source_branch, target_branch)
 
419
 
 
420
    def iter_proposals(self, source_branch, target_branch, status):
 
421
        (source_host, source_project_name, source_branch_name) = (
 
422
            parse_gitlab_branch_url(source_branch))
 
423
        (target_host, target_project_name, target_branch_name) = (
 
424
            parse_gitlab_branch_url(target_branch))
 
425
        if source_host != target_host:
 
426
            raise DifferentGitLabInstances(source_host, target_host)
 
427
        source_project = self._get_project(source_project_name)
 
428
        target_project = self._get_project(target_project_name)
 
429
        state = mp_status_to_status(status)
 
430
        for mr in self._list_merge_requests(
 
431
                project=target_project['id'], state=state):
 
432
            if (mr['source_project_id'] != source_project['id'] or
 
433
                    mr['source_branch'] != source_branch_name or
 
434
                    mr['target_project_id'] != target_project['id'] or
 
435
                    mr['target_branch'] != target_branch_name):
 
436
                continue
 
437
            yield GitLabMergeProposal(self, mr)
 
438
 
 
439
    def hosts(self, branch):
 
440
        try:
 
441
            (host, project, branch_name) = parse_gitlab_branch_url(branch)
 
442
        except NotGitLabUrl:
 
443
            return False
 
444
        return (self.base_url == ('https://%s' % host))
 
445
 
 
446
    def check(self):
 
447
        response = self._api_request('GET', 'user')
 
448
        if response.status == 200:
 
449
            self._current_user = json.loads(response.data)
 
450
            return
 
451
        if response == 401:
 
452
            if json.loads(response.data) == {"message": "401 Unauthorized"}:
 
453
                raise GitLabLoginMissing()
 
454
            else:
 
455
                raise GitlabLoginError(response.text)
 
456
        raise UnsupportedHoster(url)
 
457
 
 
458
    @classmethod
 
459
    def probe_from_url(cls, url, possible_transports=None):
 
460
        try:
 
461
            (host, project) = parse_gitlab_url(url)
 
462
        except NotGitLabUrl:
 
463
            raise UnsupportedHoster(url)
 
464
        transport = get_transport(
 
465
            'https://%s' % host, possible_transports=possible_transports)
 
466
        credentials = get_credentials_by_url(transport.base)
 
467
        if credentials is not None:
 
468
            return cls(transport, credentials.get('private_token'))
 
469
        raise UnsupportedHoster(url)
 
470
 
 
471
    @classmethod
 
472
    def iter_instances(cls):
 
473
        for name, credentials in iter_tokens():
 
474
            if 'url' not in credentials:
 
475
                continue
 
476
            yield cls(
 
477
                get_transport(credentials['url']),
 
478
                private_token=credentials.get('private_token'))
 
479
 
 
480
    def iter_my_proposals(self, status='open'):
 
481
        state = mp_status_to_status(status)
 
482
        for mp in self._list_merge_requests(
 
483
                owner=self._get_logged_in_username(), state=state):
 
484
            yield GitLabMergeProposal(self, mp)
 
485
 
 
486
    def get_proposal_by_url(self, url):
 
487
        try:
 
488
            (host, project, merge_id) = parse_gitlab_merge_request_url(url)
 
489
        except NotGitLabUrl:
 
490
            raise UnsupportedHoster(url)
 
491
        except NotMergeRequestUrl as e:
 
492
            if self.base_url == ('https://%s' % e.host):
 
493
                raise
 
494
            else:
 
495
                raise UnsupportedHoster(url)
 
496
        if self.base_url != ('https://%s' % host):
 
497
            raise UnsupportedHoster(url)
 
498
        project = self._get_project(project)
 
499
        mr = project.mergerequests.get(merge_id)
 
500
        return GitLabMergeProposal(mr)
 
501
 
 
502
 
 
503
class GitlabMergeProposalBuilder(MergeProposalBuilder):
 
504
 
 
505
    def __init__(self, gl, source_branch, target_branch):
 
506
        self.gl = gl
 
507
        self.source_branch = source_branch
 
508
        (self.source_host, self.source_project_name, self.source_branch_name) = (
 
509
            parse_gitlab_branch_url(source_branch))
 
510
        self.target_branch = target_branch
 
511
        (self.target_host, self.target_project_name, self.target_branch_name) = (
 
512
            parse_gitlab_branch_url(target_branch))
 
513
        if self.source_host != self.target_host:
 
514
            raise DifferentGitLabInstances(self.source_host, self.target_host)
 
515
 
 
516
    def get_infotext(self):
 
517
        """Determine the initial comment for the merge proposal."""
 
518
        info = []
 
519
        info.append("Gitlab instance: %s\n" % self.target_host)
 
520
        info.append("Source: %s\n" % self.source_branch.user_url)
 
521
        info.append("Target: %s\n" % self.target_branch.user_url)
 
522
        return ''.join(info)
 
523
 
 
524
    def get_initial_body(self):
 
525
        """Get a body for the proposal for the user to modify.
 
526
 
 
527
        :return: a str or None.
 
528
        """
 
529
        return None
 
530
 
 
531
    def create_proposal(self, description, reviewers=None, labels=None,
 
532
                        prerequisite_branch=None, commit_message=None):
 
533
        """Perform the submission."""
 
534
        # https://docs.gitlab.com/ee/api/merge_requests.html#create-mr
 
535
        if prerequisite_branch is not None:
 
536
            raise PrerequisiteBranchUnsupported(self)
 
537
        # Note that commit_message is ignored, since Gitlab doesn't support it.
 
538
        source_project = self.gl._get_project(self.source_project_name)
 
539
        target_project = self.gl._get_project(self.target_project_name)
 
540
        # TODO(jelmer): Allow setting title explicitly
 
541
        title = description.splitlines()[0]
 
542
        # TODO(jelmer): Allow setting allow_collaboration field
 
543
        # TODO(jelmer): Allow setting milestone field
 
544
        # TODO(jelmer): Allow setting squash field
 
545
        kwargs = {
 
546
            'title': title,
 
547
            'source_project_id': source_project['id'],
 
548
            'target_project_id': target_project['id'],
 
549
            'source_branch_name': self.source_branch_name,
 
550
            'target_branch_name': self.target_branch_name,
 
551
            'description': description}
 
552
        if labels:
 
553
            kwargs['labels'] = ','.join(labels)
 
554
        if reviewers:
 
555
            kwargs['assignee_ids'] = []
 
556
            for reviewer in reviewers:
 
557
                if '@' in reviewer:
 
558
                    user = self.gl._get_user_by_email(reviewer)
 
559
                else:
 
560
                    user = self.gl._get_user(reviewer)
 
561
                kwargs['assignee_ids'].append(user['id'])
 
562
        merge_request = self.gl._create_mergerequest(**kwargs)
 
563
        return GitLabMergeProposal(self.gl, merge_request)
 
564
 
 
565
 
 
566
def register_gitlab_instance(shortname, url):
 
567
    """Register a gitlab instance.
 
568
 
 
569
    :param shortname: Short name (e.g. "gitlab")
 
570
    :param url: URL to the gitlab instance
 
571
    """
 
572
    from breezy.bugtracker import (
 
573
        tracker_registry,
 
574
        ProjectIntegerBugTracker,
 
575
        )
 
576
    tracker_registry.register(
 
577
        shortname, ProjectIntegerBugTracker(
 
578
            shortname, url + '/{project}/issues/{id}'))