117
105
class GitHubMergeProposal(MergeProposal):
119
def __init__(self, gh, pr):
107
def __init__(self, pr):
124
return "<%s at %r>" % (type(self).__name__, self.url)
128
return self._pr['html_url']
112
return self._pr.html_url
130
114
def _branch_from_part(self, part):
131
if part['repo'] is None:
133
return github_url_to_bzr_url(part['repo']['html_url'], part['ref'])
115
return github_url_to_bzr_url(part.repo.html_url, part.ref)
135
117
def get_source_branch_url(self):
136
return self._branch_from_part(self._pr['head'])
118
return self._branch_from_part(self._pr.head)
138
120
def get_target_branch_url(self):
139
return self._branch_from_part(self._pr['base'])
141
def get_source_project(self):
142
return self._pr['head']['repo']['full_name']
144
def get_target_project(self):
145
return self._pr['base']['repo']['full_name']
121
return self._branch_from_part(self._pr.base)
147
123
def get_description(self):
148
return self._pr['body']
150
126
def get_commit_message(self):
153
def set_commit_message(self, message):
154
raise errors.UnsupportedOperation(self.set_commit_message, self)
156
def _patch(self, data):
157
response = self._gh._api_request(
158
'PATCH', self._pr['url'], body=json.dumps(data).encode('utf-8'))
159
if response.status == 422:
160
raise ValidationFailed(json.loads(response.text))
161
if response.status != 200:
162
raise InvalidHttpResponse(self._pr['url'], response.text)
163
self._pr = json.loads(response.text)
165
129
def set_description(self, description):
168
'title': determine_title(description),
130
self._pr.edit(body=description, title=determine_title(description))
171
132
def is_merged(self):
172
return bool(self._pr.get('merged_at'))
175
return self._pr['state'] == 'closed' and not bool(self._pr.get('merged_at'))
179
self._patch({'state': 'open'})
180
except ValidationFailed as e:
181
raise ReopenFailed(e.error['errors'][0]['message'])
133
return self._pr.merged
184
self._patch({'state': 'closed'})
186
def can_be_merged(self):
187
return self._pr['mergeable']
189
def merge(self, commit_message=None):
190
# https://developer.github.com/v3/pulls/#merge-a-pull-request-merge-button
191
self._pr.merge(commit_message=commit_message)
193
def get_merged_by(self):
194
merged_by = self._pr.get('merged_by')
195
if merged_by is None:
197
return merged_by['login']
199
def get_merged_at(self):
200
merged_at = self._pr.get('merged_at')
201
if merged_at is None:
204
return iso8601.parse_date(merged_at)
136
self._pr.edit(state='closed')
207
139
def parse_github_url(url):
208
140
(scheme, user, password, host, port, path) = urlutils.parse_url(
210
if host != GITHUB_HOST:
142
if host != 'github.com':
211
143
raise NotGitHubUrl(url)
212
144
(owner, repo_name) = path.strip('/').split('/')
213
145
if repo_name.endswith('.git'):
238
179
supports_merge_proposal_labels = True
239
180
supports_merge_proposal_commit_message = False
240
supports_allow_collaboration = True
241
merge_proposal_description_format = 'markdown'
243
182
def __repr__(self):
244
183
return "GitHub()"
246
def _api_request(self, method, path, body=None):
248
'Content-Type': 'application/json',
249
'Accept': 'application/vnd.github.v3+json'}
251
headers['Authorization'] = 'token %s' % self._token
252
response = self.transport.request(
253
method, urlutils.join(self.transport.base, path),
254
headers=headers, body=body, retries=3)
255
if response.status == 401:
256
raise GitHubLoginRequired(self)
259
def _get_repo(self, owner, repo):
260
path = 'repos/%s/%s' % (owner, repo)
261
response = self._api_request('GET', path)
262
if response.status == 404:
263
raise NoSuchProject(path)
264
if response.status == 200:
265
return json.loads(response.text)
266
raise InvalidHttpResponse(path, response.text)
268
def _get_repo_pulls(self, path, head=None, state=None):
272
params['head'] = head
273
if state is not None:
274
params['state'] = state
275
path += ';'.join(['%s=%s' % (k, urlutils.quote(v))
276
for k, v in params.items()])
277
response = self._api_request('GET', path)
278
if response.status == 404:
279
raise NoSuchProject(path)
280
if response.status == 200:
281
return json.loads(response.text)
282
raise InvalidHttpResponse(path, response.text)
284
def _create_pull(self, path, title, head, base, body=None, labels=None,
285
assignee=None, draft=False, maintainer_can_modify=False):
291
'maintainer_can_modify': maintainer_can_modify,
293
if labels is not None:
294
data['labels'] = labels
295
if assignee is not None:
296
data['assignee'] = assignee
300
response = self._api_request(
301
'POST', path, body=json.dumps(data).encode('utf-8'))
302
if response.status == 403:
303
raise PermissionDenied(path, response.text)
304
if response.status != 201:
305
raise InvalidHttpResponse(path, 'req is invalid %d %r: %r' % (response.status, data, response.text))
306
return json.loads(response.text)
308
def _get_user_by_email(self, email):
309
path = 'search/users?q=%s+in:email' % email
310
response = self._api_request('GET', path)
311
if response.status != 200:
312
raise InvalidHttpResponse(path, response.text)
313
ret = json.loads(response.text)
314
if ret['total_count'] == 0:
315
raise KeyError('no user with email %s' % email)
316
elif ret['total_count'] > 1:
317
raise ValueError('more than one result for email %s' % email)
318
return ret['items'][0]
320
def _get_user(self, username=None):
322
path = 'users/%s' % username
325
response = self._api_request('GET', path)
326
if response.status != 200:
327
raise InvalidHttpResponse(path, response.text)
328
return json.loads(response.text)
330
def _get_organization(self, name):
331
path = 'orgs/%s' % name
332
response = self._api_request('GET', path)
333
if response.status != 200:
334
raise InvalidHttpResponse(path, response.text)
335
return json.loads(response.text)
337
def _list_paged(self, path, parameters=None, per_page=None):
338
if parameters is None:
341
parameters = dict(parameters.items())
343
parameters['per_page'] = str(per_page)
347
parameters['page'] = str(page)
348
response = self._api_request(
350
';'.join(['%s=%s' % (k, urlutils.quote(v))
351
for (k, v) in parameters.items()]))
352
if response.status != 200:
353
raise InvalidHttpResponse(path, response.text)
354
data = json.loads(response.text)
355
for entry in data['items']:
358
if i >= data['total_count']:
362
def _search_issues(self, query):
363
path = 'search/issues'
364
return self._list_paged(path, {'q': query}, per_page=DEFAULT_PER_PAGE)
366
def _create_fork(self, path, owner=None):
367
if owner and owner != self._current_user['login']:
368
path += '?organization=%s' % owner
369
response = self._api_request('POST', path)
370
if response.status != 202:
371
raise InvalidHttpResponse(path, 'status: %d, %r' % (response.status, response.text))
372
return json.loads(response.text)
375
186
def base_url(self):
376
return WEB_GITHUB_URL
378
def __init__(self, transport):
379
self._token = retrieve_github_token('https', GITHUB_HOST)
380
self.transport = transport
381
self._current_user = self._get_user()
187
# TODO(jelmer): Can we get the default URL from the Python API package
189
return "https://github.com"
192
self.gh = connect_github()
194
@convert_github_error
383
195
def publish_derived(self, local_branch, base_branch, name, project=None,
384
196
owner=None, revision_id=None, overwrite=False,
385
allow_lossy=True, tag_selector=None):
386
199
base_owner, base_project, base_branch_name = parse_github_branch_url(base_branch)
387
base_repo = self._get_repo(base_owner, base_project)
200
base_repo = self.gh.get_repo('%s/%s' % (base_owner, base_project))
388
201
if owner is None:
389
owner = self._current_user['login']
202
owner = self.gh.get_user().login
390
203
if project is None:
391
project = base_repo['name']
204
project = base_repo.name
393
remote_repo = self._get_repo(owner, project)
394
except NoSuchProject:
395
base_repo = self._get_repo(base_owner, base_project)
396
remote_repo = self._create_fork(base_repo['forks_url'], owner)
206
remote_repo = self.gh.get_repo('%s/%s' % (owner, project))
208
except github.UnknownObjectException:
209
base_repo = self.gh.get_repo('%s/%s' % (base_owner, base_project))
210
if owner == self.gh.get_user().login:
211
owner_obj = self.gh.get_user()
213
owner_obj = self.gh.get_organization(owner)
214
remote_repo = owner_obj.create_fork(base_repo)
397
215
note(gettext('Forking new repository %s from %s') %
398
(remote_repo['html_url'], base_repo['html_url']))
216
(remote_repo.html_url, base_repo.html_url))
400
note(gettext('Reusing existing repository %s') % remote_repo['html_url'])
401
remote_dir = controldir.ControlDir.open(git_url_to_bzr_url(remote_repo['ssh_url']))
218
note(gettext('Reusing existing repository %s') % remote_repo.html_url)
219
remote_dir = controldir.ControlDir.open(git_url_to_bzr_url(remote_repo.ssh_url))
403
221
push_result = remote_dir.push_branch(
404
222
local_branch, revision_id=revision_id, overwrite=overwrite,
405
name=name, tag_selector=tag_selector)
406
224
except errors.NoRoundtrippingSupport:
407
225
if not allow_lossy:
409
227
push_result = remote_dir.push_branch(
410
228
local_branch, revision_id=revision_id,
411
overwrite=overwrite, name=name, lossy=True,
412
tag_selector=tag_selector)
229
overwrite=overwrite, name=name, lossy=True)
413
230
return push_result.target_branch, github_url_to_bzr_url(
414
remote_repo['html_url'], name)
231
remote_repo.html_url, name)
233
@convert_github_error
416
234
def get_push_url(self, branch):
417
235
owner, project, branch_name = parse_github_branch_url(branch)
418
repo = self._get_repo(owner, project)
419
return github_url_to_bzr_url(repo['ssh_url'], branch_name)
236
repo = self.gh.get_repo('%s/%s' % (owner, project))
237
return github_url_to_bzr_url(repo.ssh_url, branch_name)
239
@convert_github_error
421
240
def get_derived_branch(self, base_branch, name, project=None, owner=None):
422
242
base_owner, base_project, base_branch_name = parse_github_branch_url(base_branch)
423
base_repo = self._get_repo(base_owner, base_project)
243
base_repo = self.gh.get_repo('%s/%s' % (base_owner, base_project))
424
244
if owner is None:
425
owner = self._current_user['login']
245
owner = self.gh.get_user().login
426
246
if project is None:
427
project = base_repo['name']
247
project = base_repo.name
429
remote_repo = self._get_repo(owner, project)
430
full_url = github_url_to_bzr_url(remote_repo['ssh_url'], name)
249
remote_repo = self.gh.get_repo('%s/%s' % (owner, project))
250
full_url = github_url_to_bzr_url(remote_repo.ssh_url, name)
431
251
return _mod_branch.Branch.open(full_url)
432
except NoSuchProject:
433
raise errors.NotBranchError('%s/%s/%s' % (WEB_GITHUB_URL, owner, project))
252
except github.UnknownObjectException:
253
raise errors.NotBranchError('https://github.com/%s/%s' % (owner, project))
255
@convert_github_error
435
256
def get_proposer(self, source_branch, target_branch):
436
return GitHubMergeProposalBuilder(self, source_branch, target_branch)
257
return GitHubMergeProposalBuilder(self.gh, source_branch, target_branch)
259
@convert_github_error
438
260
def iter_proposals(self, source_branch, target_branch, status='open'):
439
261
(source_owner, source_repo_name, source_branch_name) = (
440
262
parse_github_branch_url(source_branch))
441
263
(target_owner, target_repo_name, target_branch_name) = (
442
264
parse_github_branch_url(target_branch))
443
target_repo = self._get_repo(target_owner, target_repo_name)
265
target_repo = self.gh.get_repo(
266
"%s/%s" % (target_owner, target_repo_name))
446
269
'merged': 'closed',
447
270
'closed': 'closed',
449
pulls = self._get_repo_pulls(
450
strip_optional(target_repo['pulls_url']),
451
head=target_branch_name,
454
if (status == 'closed' and pull['merged'] or
455
status == 'merged' and not pull['merged']):
457
if pull['head']['ref'] != source_branch_name:
459
if pull['head']['repo'] is None:
272
for pull in target_repo.get_pulls(
273
head=target_branch_name,
274
state=state[status]):
275
if (status == 'closed' and pull.merged or
276
status == 'merged' and not pull.merged):
278
if pull.head.ref != source_branch_name:
280
if pull.head.repo is None:
460
281
# Repo has gone the way of the dodo
462
if (pull['head']['repo']['owner']['login'] != source_owner or
463
pull['head']['repo']['name'] != source_repo_name):
283
if (pull.head.repo.owner.login != source_owner or
284
pull.head.repo.name != source_repo_name):
465
yield GitHubMergeProposal(self, pull)
286
yield GitHubMergeProposal(pull)
467
288
def hosts(self, branch):
560
353
def create_proposal(self, description, reviewers=None, labels=None,
561
prerequisite_branch=None, commit_message=None,
562
work_in_progress=False, allow_collaboration=False):
354
prerequisite_branch=None, commit_message=None):
563
355
"""Perform the submission."""
564
356
if prerequisite_branch is not None:
565
357
raise PrerequisiteBranchUnsupported(self)
566
358
# Note that commit_message is ignored, since github doesn't support it.
567
360
# TODO(jelmer): Probe for right repo name
568
361
if self.target_repo_name.endswith('.git'):
569
362
self.target_repo_name = self.target_repo_name[:-4]
363
target_repo = self.gh.get_repo("%s/%s" % (self.target_owner, self.target_repo_name))
570
364
# TODO(jelmer): Allow setting title explicitly?
571
365
title = determine_title(description)
572
target_repo = self.gh._get_repo(
573
self.target_owner, self.target_repo_name)
366
# TOOD(jelmer): Set maintainers_can_modify?
368
pull_request = target_repo.create_pull(
369
title=title, body=description,
370
head="%s:%s" % (self.source_owner, self.source_branch_name),
371
base=self.target_branch_name)
372
except github.GithubException as e:
374
raise MergeProposalExists(self.source_branch.user_url)
577
377
for reviewer in reviewers:
579
user = self.gh._get_user_by_email(reviewer)
581
user = self.gh._get_user(reviewer)
582
assignees.append(user['login'])
586
pull_request = self.gh._create_pull(
587
strip_optional(target_repo['pulls_url']),
588
title=title, body=description,
589
head="%s:%s" % (self.source_owner, self.source_branch_name),
590
base=self.target_branch_name,
591
labels=labels, assignee=assignees,
592
draft=work_in_progress,
593
maintainer_can_modify=allow_collaboration,
595
except ValidationFailed:
596
raise MergeProposalExists(self.source_branch.user_url)
597
return GitHubMergeProposal(self.gh, pull_request)
378
pull_request.assignees.append(
379
self.gh.get_user(reviewer))
382
pull_request.issue.labels.append(label)
383
return GitHubMergeProposal(pull_request)