/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/github.py

  • Committer: Jelmer Vernooij
  • Date: 2017-05-21 12:41:27 UTC
  • mto: This revision was merged to the branch mainline in revision 6623.
  • Revision ID: jelmer@jelmer.uk-20170521124127-iv8etg0vwymyai6y
s/bzr/brz/ in apport config.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/plugins/propose/github.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 GitHub."""
18
 
 
19
 
import json
20
 
import os
21
 
 
22
 
from ...propose import (
23
 
    determine_title,
24
 
    Hoster,
25
 
    HosterLoginRequired,
26
 
    MergeProposal,
27
 
    MergeProposalBuilder,
28
 
    MergeProposalExists,
29
 
    NoSuchProject,
30
 
    PrerequisiteBranchUnsupported,
31
 
    ReopenFailed,
32
 
    UnsupportedHoster,
33
 
    )
34
 
 
35
 
from ... import (
36
 
    bedding,
37
 
    branch as _mod_branch,
38
 
    controldir,
39
 
    errors,
40
 
    hooks,
41
 
    urlutils,
42
 
    version_string as breezy_version,
43
 
    )
44
 
from ...config import AuthenticationConfig, GlobalStack
45
 
from ...errors import InvalidHttpResponse, PermissionDenied
46
 
from ...git.urls import git_url_to_bzr_url
47
 
from ...i18n import gettext
48
 
from ...trace import note
49
 
from ...transport import get_transport
50
 
from ...transport.http import default_user_agent
51
 
 
52
 
 
53
 
GITHUB_HOST = 'github.com'
54
 
WEB_GITHUB_URL = 'https://github.com'
55
 
API_GITHUB_URL = 'https://api.github.com'
56
 
DEFAULT_PER_PAGE = 50
57
 
 
58
 
 
59
 
def store_github_token(scheme, host, token):
60
 
    with open(os.path.join(bedding.config_dir(), 'github.conf'), 'w') as f:
61
 
        f.write(token)
62
 
 
63
 
 
64
 
def retrieve_github_token(scheme, host):
65
 
    path = os.path.join(bedding.config_dir(), 'github.conf')
66
 
    if not os.path.exists(path):
67
 
        return None
68
 
    with open(path, 'r') as f:
69
 
        return f.read().strip()
70
 
 
71
 
 
72
 
class ValidationFailed(errors.BzrError):
73
 
 
74
 
    _fmt = "GitHub validation failed: %(error)s"
75
 
 
76
 
    def __init__(self, error):
77
 
        errors.BzrError.__init__(self)
78
 
        self.error = error
79
 
 
80
 
 
81
 
class NotGitHubUrl(errors.BzrError):
82
 
 
83
 
    _fmt = "Not a GitHub URL: %(url)s"
84
 
 
85
 
    def __init__(self, url):
86
 
        errors.BzrError.__init__(self)
87
 
        self.url = url
88
 
 
89
 
 
90
 
class GitHubLoginRequired(HosterLoginRequired):
91
 
 
92
 
    _fmt = "Action requires GitHub login."
93
 
 
94
 
 
95
 
def connect_github():
96
 
    """Connect to GitHub.
97
 
    """
98
 
    user_agent = default_user_agent()
99
 
    auth = AuthenticationConfig()
100
 
 
101
 
    credentials = auth.get_credentials('https', GITHUB_HOST)
102
 
    if credentials is not None:
103
 
        return Github(credentials['user'], credentials['password'],
104
 
                      user_agent=user_agent)
105
 
 
106
 
    # TODO(jelmer): token = auth.get_token('https', GITHUB_HOST)
107
 
    if token is not None:
108
 
        return Github(token, user_agent=user_agent)
109
 
    else:
110
 
        note('Accessing GitHub anonymously. To log in, run \'brz gh-login\'.')
111
 
        return Github(user_agent=user_agent)
112
 
 
113
 
 
114
 
class GitHubMergeProposal(MergeProposal):
115
 
 
116
 
    def __init__(self, gh, pr):
117
 
        self._gh = gh
118
 
        self._pr = pr
119
 
 
120
 
    def __repr__(self):
121
 
        return "<%s at %r>" % (type(self).__name__, self.url)
122
 
 
123
 
    @property
124
 
    def url(self):
125
 
        return self._pr['html_url']
126
 
 
127
 
    def _branch_from_part(self, part):
128
 
        if part['repo'] is None:
129
 
            return None
130
 
        return github_url_to_bzr_url(part['repo']['html_url'], part['ref'])
131
 
 
132
 
    def get_source_branch_url(self):
133
 
        return self._branch_from_part(self._pr['head'])
134
 
 
135
 
    def get_target_branch_url(self):
136
 
        return self._branch_from_part(self._pr['base'])
137
 
 
138
 
    def get_source_project(self):
139
 
        return self._pr['head']['repo']['full_name']
140
 
 
141
 
    def get_target_project(self):
142
 
        return self._pr['base']['repo']['full_name']
143
 
 
144
 
    def get_description(self):
145
 
        return self._pr['body']
146
 
 
147
 
    def get_commit_message(self):
148
 
        return None
149
 
 
150
 
    def set_commit_message(self, message):
151
 
        raise errors.UnsupportedOperation(self.set_commit_message, self)
152
 
 
153
 
    def _patch(self, data):
154
 
        response = self._gh._api_request(
155
 
            'PATCH', self._pr['url'], body=json.dumps(data).encode('utf-8'))
156
 
        if response.status == 422:
157
 
            raise ValidationFailed(json.loads(response.text))
158
 
        if response.status != 200:
159
 
            raise InvalidHttpResponse(self._pr['url'], response.text)
160
 
        self._pr = json.loads(response.text)
161
 
 
162
 
    def set_description(self, description):
163
 
        self._patch({
164
 
            'body': description,
165
 
            'title': determine_title(description),
166
 
            })
167
 
 
168
 
    def is_merged(self):
169
 
        return bool(self._pr.get('merged_at'))
170
 
 
171
 
    def is_closed(self):
172
 
        return self._pr['state'] == 'closed' and not bool(self._pr.get('merged_at'))
173
 
 
174
 
    def reopen(self):
175
 
        try:
176
 
            self._patch({'state': 'open'})
177
 
        except ValidationFailed as e:
178
 
            raise ReopenFailed(e.error['errors'][0]['message'])
179
 
 
180
 
    def close(self):
181
 
        self._patch({'state': 'closed'})
182
 
 
183
 
    def can_be_merged(self):
184
 
        return self._pr['mergeable']
185
 
 
186
 
    def merge(self, commit_message=None):
187
 
        # https://developer.github.com/v3/pulls/#merge-a-pull-request-merge-button
188
 
        self._pr.merge(commit_message=commit_message)
189
 
 
190
 
    def get_merged_by(self):
191
 
        merged_by = self._pr.get('merged_by')
192
 
        if merged_by is None:
193
 
            return None
194
 
        return merged_by['login']
195
 
 
196
 
    def get_merged_at(self):
197
 
        merged_at = self._pr.get('merged_at')
198
 
        if merged_at is None:
199
 
            return None
200
 
        import iso8601
201
 
        return iso8601.parse_date(merged_at)
202
 
 
203
 
 
204
 
def parse_github_url(url):
205
 
    (scheme, user, password, host, port, path) = urlutils.parse_url(
206
 
        url)
207
 
    if host != GITHUB_HOST:
208
 
        raise NotGitHubUrl(url)
209
 
    (owner, repo_name) = path.strip('/').split('/')
210
 
    if repo_name.endswith('.git'):
211
 
        repo_name = repo_name[:-4]
212
 
    return owner, repo_name
213
 
 
214
 
 
215
 
def parse_github_branch_url(branch):
216
 
    url = urlutils.strip_segment_parameters(branch.user_url)
217
 
    owner, repo_name = parse_github_url(url)
218
 
    return owner, repo_name, branch.name
219
 
 
220
 
 
221
 
def github_url_to_bzr_url(url, branch_name):
222
 
    return git_url_to_bzr_url(url, branch_name)
223
 
 
224
 
 
225
 
def strip_optional(url):
226
 
    return url.split('{')[0]
227
 
 
228
 
 
229
 
class GitHub(Hoster):
230
 
 
231
 
    name = 'github'
232
 
 
233
 
    supports_merge_proposal_labels = True
234
 
    supports_merge_proposal_commit_message = False
235
 
    merge_proposal_description_format = 'markdown'
236
 
 
237
 
    def __repr__(self):
238
 
        return "GitHub()"
239
 
 
240
 
    def _api_request(self, method, path, body=None):
241
 
        headers = {
242
 
            'Content-Type': 'application/json',
243
 
            'Accept': 'application/vnd.github.v3+json'}
244
 
        if self._token:
245
 
            headers['Authorization'] = 'token %s' % self._token
246
 
        response = self.transport.request(
247
 
            method, urlutils.join(self.transport.base, path),
248
 
            headers=headers, body=body, retries=3)
249
 
        if response.status == 401:
250
 
            raise GitHubLoginRequired(self)
251
 
        return response
252
 
 
253
 
    def _get_repo(self, owner, repo):
254
 
        path = 'repos/%s/%s' % (owner, repo)
255
 
        response = self._api_request('GET', path)
256
 
        if response.status == 404:
257
 
            raise NoSuchProject(path)
258
 
        if response.status == 200:
259
 
            return json.loads(response.text)
260
 
        raise InvalidHttpResponse(path, response.text)
261
 
 
262
 
    def _get_repo_pulls(self, path, head=None, state=None):
263
 
        path = path + '?'
264
 
        params = {}
265
 
        if head is not None:
266
 
            params['head'] = head
267
 
        if state is not None:
268
 
            params['state'] = state
269
 
        path += ';'.join(['%s=%s' % (k, urlutils.quote(v))
270
 
                         for k, v in params.items()])
271
 
        response = self._api_request('GET', path)
272
 
        if response.status == 404:
273
 
            raise NoSuchProject(path)
274
 
        if response.status == 200:
275
 
            return json.loads(response.text)
276
 
        raise InvalidHttpResponse(path, response.text)
277
 
 
278
 
    def _create_pull(self, path, title, head, base, body=None, labels=None, assignee=None):
279
 
        data = {
280
 
            'title': title,
281
 
            'head': head,
282
 
            'base': base,
283
 
        }
284
 
        if labels is not None:
285
 
            data['labels'] = labels
286
 
        if assignee is not None:
287
 
            data['assignee'] = assignee
288
 
        if body:
289
 
            data['body'] = body
290
 
 
291
 
        response = self._api_request(
292
 
            'POST', path, body=json.dumps(data).encode('utf-8'))
293
 
        if response.status == 403:
294
 
            raise PermissionDenied(path, response.text)
295
 
        if response.status != 201:
296
 
            raise InvalidHttpResponse(path, 'req is invalid %d %r: %r' % (response.status, data, response.text))
297
 
        return json.loads(response.text)
298
 
 
299
 
    def _get_user_by_email(self, email):
300
 
        path = 'search/users?q=%s+in:email' % email
301
 
        response = self._api_request('GET', path)
302
 
        if response.status != 200:
303
 
            raise InvalidHttpResponse(path, response.text)
304
 
        ret = json.loads(response.text)
305
 
        if ret['total_count'] == 0:
306
 
            raise KeyError('no user with email %s' % email)
307
 
        elif ret['total_count'] > 1:
308
 
            raise ValueError('more than one result for email %s' % email)
309
 
        return ret['items'][0]
310
 
 
311
 
    def _get_user(self, username=None):
312
 
        if username:
313
 
            path = 'users/%s' % username
314
 
        else:
315
 
            path = 'user'
316
 
        response = self._api_request('GET', path)
317
 
        if response.status != 200:
318
 
            raise InvalidHttpResponse(path, response.text)
319
 
        return json.loads(response.text)
320
 
 
321
 
    def _get_organization(self, name):
322
 
        path = 'orgs/%s' % name
323
 
        response = self._api_request('GET', path)
324
 
        if response.status != 200:
325
 
            raise InvalidHttpResponse(path, response.text)
326
 
        return json.loads(response.text)
327
 
 
328
 
    def _list_paged(self, path, parameters=None, per_page=None):
329
 
        if parameters is None:
330
 
            parameters = {}
331
 
        else:
332
 
            parameters = dict(parameters.items())
333
 
        if per_page:
334
 
            parameters['per_page'] = str(per_page)
335
 
        page = 1
336
 
        i = 0
337
 
        while path:
338
 
            parameters['page'] = str(page)
339
 
            response = self._api_request(
340
 
                'GET', path + '?' +
341
 
                ';'.join(['%s=%s' % (k, urlutils.quote(v))
342
 
                          for (k, v) in parameters.items()]))
343
 
            if response.status != 200:
344
 
                raise InvalidHttpResponse(path, response.text)
345
 
            data = json.loads(response.text)
346
 
            for entry in data['items']:
347
 
                i += 1
348
 
                yield entry
349
 
            if i >= data['total_count']:
350
 
                break
351
 
            page += 1
352
 
 
353
 
    def _search_issues(self, query):
354
 
        path = 'search/issues'
355
 
        return self._list_paged(path, {'q': query}, per_page=DEFAULT_PER_PAGE)
356
 
 
357
 
    def _create_fork(self, path, owner=None):
358
 
        if owner and owner != self._current_user['login']:
359
 
            path += '?organization=%s' % owner
360
 
        response = self._api_request('POST', path)
361
 
        if response.status != 202:
362
 
            raise InvalidHttpResponse(path, 'status: %d, %r' % (response.status, response.text))
363
 
        return json.loads(response.text)
364
 
 
365
 
    @property
366
 
    def base_url(self):
367
 
        return WEB_GITHUB_URL
368
 
 
369
 
    def __init__(self, transport):
370
 
        self._token = retrieve_github_token('https', GITHUB_HOST)
371
 
        self.transport = transport
372
 
        self._current_user = self._get_user()
373
 
 
374
 
    def publish_derived(self, local_branch, base_branch, name, project=None,
375
 
                        owner=None, revision_id=None, overwrite=False,
376
 
                        allow_lossy=True):
377
 
        base_owner, base_project, base_branch_name = parse_github_branch_url(base_branch)
378
 
        base_repo = self._get_repo(base_owner, base_project)
379
 
        if owner is None:
380
 
            owner = self._current_user['login']
381
 
        if project is None:
382
 
            project = base_repo['name']
383
 
        try:
384
 
            remote_repo = self._get_repo(owner, project)
385
 
        except NoSuchProject:
386
 
            base_repo = self._get_repo(base_owner, base_project)
387
 
            remote_repo = self._create_fork(base_repo['forks_url'], owner)
388
 
            note(gettext('Forking new repository %s from %s') %
389
 
                 (remote_repo['html_url'], base_repo['html_url']))
390
 
        else:
391
 
            note(gettext('Reusing existing repository %s') % remote_repo['html_url'])
392
 
        remote_dir = controldir.ControlDir.open(git_url_to_bzr_url(remote_repo['ssh_url']))
393
 
        try:
394
 
            push_result = remote_dir.push_branch(
395
 
                local_branch, revision_id=revision_id, overwrite=overwrite,
396
 
                name=name)
397
 
        except errors.NoRoundtrippingSupport:
398
 
            if not allow_lossy:
399
 
                raise
400
 
            push_result = remote_dir.push_branch(
401
 
                local_branch, revision_id=revision_id,
402
 
                overwrite=overwrite, name=name, lossy=True)
403
 
        return push_result.target_branch, github_url_to_bzr_url(
404
 
            remote_repo['html_url'], name)
405
 
 
406
 
    def get_push_url(self, branch):
407
 
        owner, project, branch_name = parse_github_branch_url(branch)
408
 
        repo = self._get_repo(owner, project)
409
 
        return github_url_to_bzr_url(repo['ssh_url'], branch_name)
410
 
 
411
 
    def get_derived_branch(self, base_branch, name, project=None, owner=None):
412
 
        base_owner, base_project, base_branch_name = parse_github_branch_url(base_branch)
413
 
        base_repo = self._get_repo(base_owner, base_project)
414
 
        if owner is None:
415
 
            owner = self._current_user['login']
416
 
        if project is None:
417
 
            project = base_repo['name']
418
 
        try:
419
 
            remote_repo = self._get_repo(owner, project)
420
 
            full_url = github_url_to_bzr_url(remote_repo['ssh_url'], name)
421
 
            return _mod_branch.Branch.open(full_url)
422
 
        except NoSuchProject:
423
 
            raise errors.NotBranchError('%s/%s/%s' % (WEB_GITHUB_URL, owner, project))
424
 
 
425
 
    def get_proposer(self, source_branch, target_branch):
426
 
        return GitHubMergeProposalBuilder(self, source_branch, target_branch)
427
 
 
428
 
    def iter_proposals(self, source_branch, target_branch, status='open'):
429
 
        (source_owner, source_repo_name, source_branch_name) = (
430
 
            parse_github_branch_url(source_branch))
431
 
        (target_owner, target_repo_name, target_branch_name) = (
432
 
            parse_github_branch_url(target_branch))
433
 
        target_repo = self._get_repo(target_owner, target_repo_name)
434
 
        state = {
435
 
            'open': 'open',
436
 
            'merged': 'closed',
437
 
            'closed': 'closed',
438
 
            'all': 'all'}
439
 
        pulls = self._get_repo_pulls(
440
 
            strip_optional(target_repo['pulls_url']),
441
 
            head=target_branch_name,
442
 
            state=state[status])
443
 
        for pull in pulls:
444
 
            if (status == 'closed' and pull['merged'] or
445
 
                    status == 'merged' and not pull['merged']):
446
 
                continue
447
 
            if pull['head']['ref'] != source_branch_name:
448
 
                continue
449
 
            if pull['head']['repo'] is None:
450
 
                # Repo has gone the way of the dodo
451
 
                continue
452
 
            if (pull['head']['repo']['owner']['login'] != source_owner or
453
 
                    pull['head']['repo']['name'] != source_repo_name):
454
 
                continue
455
 
            yield GitHubMergeProposal(self, pull)
456
 
 
457
 
    def hosts(self, branch):
458
 
        try:
459
 
            parse_github_branch_url(branch)
460
 
        except NotGitHubUrl:
461
 
            return False
462
 
        else:
463
 
            return True
464
 
 
465
 
    @classmethod
466
 
    def probe_from_url(cls, url, possible_transports=None):
467
 
        try:
468
 
            parse_github_url(url)
469
 
        except NotGitHubUrl:
470
 
            raise UnsupportedHoster(url)
471
 
        transport = get_transport(
472
 
            API_GITHUB_URL, possible_transports=possible_transports)
473
 
        return cls(transport)
474
 
 
475
 
    @classmethod
476
 
    def iter_instances(cls):
477
 
        yield cls(get_transport(API_GITHUB_URL))
478
 
 
479
 
    def iter_my_proposals(self, status='open'):
480
 
        query = ['is:pr']
481
 
        if status == 'open':
482
 
            query.append('is:open')
483
 
        elif status == 'closed':
484
 
            query.append('is:unmerged')
485
 
            # Also use "is:closed" otherwise unmerged open pull requests are
486
 
            # also included.
487
 
            query.append('is:closed')
488
 
        elif status == 'merged':
489
 
            query.append('is:merged')
490
 
        query.append('author:%s' % self._current_user['login'])
491
 
        for issue in self._search_issues(query=' '.join(query)):
492
 
            url = issue['pull_request']['url']
493
 
            response = self._api_request('GET', url)
494
 
            if response.status != 200:
495
 
                raise InvalidHttpResponse(url, response.text)
496
 
            yield GitHubMergeProposal(self, json.loads(response.text))
497
 
 
498
 
    def get_proposal_by_url(self, url):
499
 
        raise UnsupportedHoster(url)
500
 
 
501
 
    def iter_my_forks(self):
502
 
        response = self._api_request('GET', '/user/repos')
503
 
        if response.status != 200:
504
 
            raise InvalidHttpResponse(url, response.text)
505
 
        for project in json.loads(response.text):
506
 
            if not project['fork']:
507
 
                continue
508
 
            yield project['full_name']
509
 
 
510
 
    def delete_project(self, path):
511
 
        path = 'repos/' + path
512
 
        response = self._api_request('DELETE', path)
513
 
        if response.status == 404:
514
 
            raise NoSuchProject(path)
515
 
        if response.status == 204:
516
 
            return
517
 
        if response.status == 200:
518
 
            return json.loads(response.text)
519
 
        raise InvalidHttpResponse(path, response.text)
520
 
 
521
 
 
522
 
class GitHubMergeProposalBuilder(MergeProposalBuilder):
523
 
 
524
 
    def __init__(self, gh, source_branch, target_branch):
525
 
        self.gh = gh
526
 
        self.source_branch = source_branch
527
 
        self.target_branch = target_branch
528
 
        (self.target_owner, self.target_repo_name, self.target_branch_name) = (
529
 
            parse_github_branch_url(self.target_branch))
530
 
        (self.source_owner, self.source_repo_name, self.source_branch_name) = (
531
 
            parse_github_branch_url(self.source_branch))
532
 
 
533
 
    def get_infotext(self):
534
 
        """Determine the initial comment for the merge proposal."""
535
 
        info = []
536
 
        info.append("Merge %s into %s:%s\n" % (
537
 
            self.source_branch_name, self.target_owner,
538
 
            self.target_branch_name))
539
 
        info.append("Source: %s\n" % self.source_branch.user_url)
540
 
        info.append("Target: %s\n" % self.target_branch.user_url)
541
 
        return ''.join(info)
542
 
 
543
 
    def get_initial_body(self):
544
 
        """Get a body for the proposal for the user to modify.
545
 
 
546
 
        :return: a str or None.
547
 
        """
548
 
        return None
549
 
 
550
 
    def create_proposal(self, description, reviewers=None, labels=None,
551
 
                        prerequisite_branch=None, commit_message=None,
552
 
                        work_in_progress=False):
553
 
        """Perform the submission."""
554
 
        if prerequisite_branch is not None:
555
 
            raise PrerequisiteBranchUnsupported(self)
556
 
        # Note that commit_message is ignored, since github doesn't support it.
557
 
        # TODO(jelmer): Probe for right repo name
558
 
        if self.target_repo_name.endswith('.git'):
559
 
            self.target_repo_name = self.target_repo_name[:-4]
560
 
        # TODO(jelmer): Allow setting title explicitly?
561
 
        title = determine_title(description)
562
 
        # TODO(jelmer): Set maintainers_can_modify?
563
 
        target_repo = self.gh._get_repo(
564
 
            self.target_owner, self.target_repo_name)
565
 
        assignees = []
566
 
        if reviewers:
567
 
            assignees = []
568
 
            for reviewer in reviewers:
569
 
                if '@' in reviewer:
570
 
                    user = self.gh._get_user_by_email(reviewer)
571
 
                else:
572
 
                    user = self.gh._get_user(reviewer)
573
 
                assignees.append(user['login'])
574
 
        else:
575
 
            assignees = None
576
 
        try:
577
 
            pull_request = self.gh._create_pull(
578
 
                strip_optional(target_repo['pulls_url']),
579
 
                title=title, body=description,
580
 
                head="%s:%s" % (self.source_owner, self.source_branch_name),
581
 
                base=self.target_branch_name,
582
 
                labels=labels, assignee=assignees,
583
 
                draft=(not work_in_progress))
584
 
        except ValidationFailed:
585
 
            raise MergeProposalExists(self.source_branch.user_url)
586
 
        return GitHubMergeProposal(self.gh, pull_request)