Merge branch 'master' into v0.12.0-dev

Author: MichaelBroughton

dev_tools/auto_merge.py

@@ -1,14 +1,12 @@
 import datetime
-import traceback
-from typing import Callable, Optional, List, Any, Dict, Set, Union
-
 import json
 import os
-import time
 import sys
+import time
+import traceback
+from typing import Callable, Optional, List, Any, Dict, Set, Union
 
 from google.cloud import secretmanager_v1beta1
-import requests
 
 from dev_tools.github_repository import GithubRepository
 
@@ -47,11 +45,11 @@ def from_github(repo: GithubRepository, pull_id: int) -> 'PullRequestDetails':
         References:
             https://developer.github.com/v3/pulls/#get-a-single-pull-request
         """
-        url = "https://api.github.com/repos/{}/{}/pulls/{}?access_token={}".format(
-            repo.organization, repo.name, pull_id, repo.access_token
+        url = "https://api.github.com/repos/{}/{}/pulls/{}".format(
+            repo.organization, repo.name, pull_id
         )
 
-        response = requests.get(url)
+        response = repo.get(url)
 
         if response.status_code != 200:
             raise RuntimeError(
@@ -126,12 +124,11 @@ def check_collaborator_has_write(
     References:
         https://developer.github.com/v3/issues/events/#list-events-for-an-issue
     """
-    url = (
-        "https://api.github.com/repos/{}/{}/collaborators/{}/permission"
-        "?access_token={}".format(repo.organization, repo.name, username, repo.access_token)
+    url = "https://api.github.com/repos/{}/{}/collaborators/{}/permission" "".format(
+        repo.organization, repo.name, username
     )
 
-    response = requests.get(url)
+    response = repo.get(url)
 
     if response.status_code != 200:
         raise RuntimeError(
@@ -148,13 +145,13 @@ def check_collaborator_has_write(
 
 
 # pylint: enable=docstring-first-line-empty
-def get_all(url_func: Callable[[int], str]) -> List[Any]:
+def get_all(repo: GithubRepository, url_func: Callable[[int], str]) -> List[Any]:
     results: List[Any] = []
     page = 0
     has_next = True
     while has_next:
         url = url_func(page)
-        response = requests.get(url)
+        response = repo.get(url)
 
         if response.status_code != 200:
             raise RuntimeError(
@@ -179,12 +176,11 @@ def check_auto_merge_labeler(
         https://developer.github.com/v3/issues/events/#list-events-for-an-issue
     """
     events = get_all(
+        repo,
         lambda page: (
             "https://api.github.com/repos/{}/{}/issues/{}/events"
-            "?access_token={}&per_page=100&page={}".format(
-                repo.organization, repo.name, pull_id, repo.access_token, page
-            )
-        )
+            "?per_page=100&page={}".format(repo.organization, repo.name, pull_id, page)
+        ),
     )
 
     relevant = [
@@ -204,11 +200,11 @@ def add_comment(repo: GithubRepository, pull_id: int, text: str) -> None:
     References:
         https://developer.github.com/v3/issues/comments/#create-a-comment
     """
-    url = "https://api.github.com/repos/{}/{}/issues/{}/comments?access_token={}".format(
-        repo.organization, repo.name, pull_id, repo.access_token
+    url = "https://api.github.com/repos/{}/{}/issues/{}/comments".format(
+        repo.organization, repo.name, pull_id
     )
     data = {'body': text}
-    response = requests.post(url, json=data)
+    response = repo.post(url, json=data)
 
     if response.status_code != 201:
         raise RuntimeError(
@@ -224,11 +220,11 @@ def edit_comment(repo: GithubRepository, text: str, comment_id: int) -> None:
     References:
         https://developer.github.com/v3/issues/comments/#edit-a-comment
     """
-    url = "https://api.github.com/repos/{}/{}/issues/comments/{}?access_token={}".format(
-        repo.organization, repo.name, comment_id, repo.access_token
+    url = "https://api.github.com/repos/{}/{}/issues/comments/{}".format(
+        repo.organization, repo.name, comment_id
     )
     data = {'body': text}
-    response = requests.patch(url, json=data)
+    response = repo.patch(url, json=data)
 
     if response.status_code != 200:
         raise RuntimeError(
@@ -244,10 +240,10 @@ def get_branch_details(repo: GithubRepository, branch: str) -> Any:
     References:
         https://developer.github.com/v3/repos/branches/#get-branch
     """
-    url = "https://api.github.com/repos/{}/{}/branches/{}?access_token={}".format(
-        repo.organization, repo.name, branch, repo.access_token
+    url = "https://api.github.com/repos/{}/{}/branches/{}".format(
+        repo.organization, repo.name, branch
     )
-    response = requests.get(url)
+    response = repo.get(url)
 
     if response.status_code != 200:
         raise RuntimeError(
@@ -266,10 +262,10 @@ def get_pr_statuses(pr: PullRequestDetails) -> List[Dict[str, Any]]:
         https://developer.github.com/v3/repos/statuses/#list-statuses-for-a-specific-ref
     """
 
-    url = "https://api.github.com/repos/{}/{}/commits/{}/statuses?access_token={}".format(
-        pr.repo.organization, pr.repo.name, pr.branch_sha, pr.repo.access_token
+    url = "https://api.github.com/repos/{}/{}/commits/{}/statuses".format(
+        pr.repo.organization, pr.repo.name, pr.branch_sha
     )
-    response = requests.get(url)
+    response = pr.repo.get(url)
 
     if response.status_code != 200:
         raise RuntimeError(
@@ -288,10 +284,10 @@ def get_pr_check_status(pr: PullRequestDetails) -> Any:
         https://developer.github.com/v3/repos/statuses/#get-the-combined-status-for-a-specific-ref
     """
 
-    url = "https://api.github.com/repos/{}/{}/commits/{}/status?access_token={}".format(
-        pr.repo.organization, pr.repo.name, pr.branch_sha, pr.repo.access_token
+    url = "https://api.github.com/repos/{}/{}/commits/{}/status".format(
+        pr.repo.organization, pr.repo.name, pr.branch_sha
     )
-    response = requests.get(url)
+    response = pr.repo.get(url)
 
     if response.status_code != 200:
         raise RuntimeError(
@@ -356,9 +352,9 @@ def get_pr_review_status(pr: PullRequestDetails, per_page: int = 100) -> Any:
     url = (
         f"https://api.github.com/repos/{pr.repo.organization}/{pr.repo.name}"
         f"/pulls/{pr.pull_id}/reviews"
-        f"?per_page={per_page}&access_token={pr.repo.access_token}"
+        f"?per_page={per_page}"
     )
-    response = requests.get(url)
+    response = pr.repo.get(url)
 
     if response.status_code != 200:
         raise RuntimeError(
@@ -378,9 +374,9 @@ def get_pr_checks(pr: PullRequestDetails) -> Dict[str, Any]:
     """
     url = (
         f"https://api.github.com/repos/{pr.repo.organization}/{pr.repo.name}"
-        f"/commits/{pr.branch_sha}/check-runs?per_page=100&access_token={pr.repo.access_token}"
+        f"/commits/{pr.branch_sha}/check-runs?per_page=100"
     )
-    response = requests.get(url, headers={'Accept': 'application/vnd.github.antiope-preview+json'})
+    response = pr.repo.get(url, headers={'Accept': 'application/vnd.github.antiope-preview+json'})
 
     if response.status_code != 200:
         raise RuntimeError(
@@ -439,10 +435,8 @@ def get_repo_ref(repo: GithubRepository, ref: str) -> Dict[str, Any]:
         https://developer.github.com/v3/git/refs/#get-a-reference
     """
 
-    url = "https://api.github.com/repos/{}/{}/git/refs/{}?access_token={}".format(
-        repo.organization, repo.name, ref, repo.access_token
-    )
-    response = requests.get(url)
+    url = f"https://api.github.com/repos/{repo.organization}/{repo.name}/git/refs/{ref}"
+    response = repo.get(url)
     if response.status_code != 200:
         raise RuntimeError(
             'Refs get failed. Code: {}. Content: {!r}.'.format(
@@ -466,10 +460,10 @@ def list_pr_comments(repo: GithubRepository, pull_id: int) -> List[Dict[str, Any
     References:
         https://developer.github.com/v3/issues/comments/#list-comments-on-an-issue
     """
-    url = "https://api.github.com/repos/{}/{}/issues/{}/comments?access_token={}".format(
-        repo.organization, repo.name, pull_id, repo.access_token
+    url = "https://api.github.com/repos/{}/{}/issues/{}/comments".format(
+        repo.organization, repo.name, pull_id
     )
-    response = requests.get(url)
+    response = repo.get(url)
     if response.status_code != 200:
         raise RuntimeError(
             'Comments get failed. Code: {}. Content: {!r}.'.format(
@@ -486,10 +480,10 @@ def delete_comment(repo: GithubRepository, comment_id: int) -> None:
     References:
         https://developer.github.com/v3/issues/comments/#delete-a-comment
     """
-    url = "https://api.github.com/repos/{}/{}/issues/comments/{}?access_token={}".format(
-        repo.organization, repo.name, comment_id, repo.access_token
+    url = "https://api.github.com/repos/{}/{}/issues/comments/{}".format(
+        repo.organization, repo.name, comment_id
     )
-    response = requests.delete(url)
+    response = repo.delete(url)
     if response.status_code != 204:
         raise RuntimeError(
             'Comment delete failed. Code: {}. Content: {!r}.'.format(
@@ -512,12 +506,11 @@ def update_branch(pr: PullRequestDetails) -> Union[bool, CannotAutomergeError]:
     url = (
         f"https://api.github.com/repos/{pr.repo.organization}/{pr.repo.name}"
         f"/pulls/{pr.pull_id}/update-branch"
-        f"?access_token={pr.repo.access_token}"
     )
     data = {
         'expected_head_sha': pr.branch_sha,
     }
-    response = requests.put(
+    response = pr.repo.put(
         url,
         json=data,
         # Opt into BETA feature.
@@ -546,15 +539,13 @@ def attempt_sync_with_master(pr: PullRequestDetails) -> Union[bool, CannotAutome
     """
     master_sha = get_master_sha(pr.repo)
     remote = pr.remote_repo
-    url = "https://api.github.com/repos/{}/{}/merges?access_token={}".format(
-        remote.organization, remote.name, remote.access_token
-    )
+    url = f"https://api.github.com/repos/{remote.organization}/{remote.name}/merges"
     data = {
         'base': pr.branch_name,
         'head': master_sha,
         'commit_message': 'Update branch (automerge)',
     }
-    response = requests.post(url, json=data)
+    response = pr.remote_repo.post(url, json=data)
 
     if response.status_code == 201:
         # Merge succeeded.
@@ -589,16 +580,16 @@ def attempt_squash_merge(pr: PullRequestDetails) -> Union[bool, CannotAutomergeE
     References:
         https://developer.github.com/v3/pulls/#merge-a-pull-request-merge-button
     """
-    url = "https://api.github.com/repos/{}/{}/pulls/{}/merge?access_token={}".format(
-        pr.repo.organization, pr.repo.name, pr.pull_id, pr.repo.access_token
+    url = "https://api.github.com/repos/{}/{}/pulls/{}/merge".format(
+        pr.repo.organization, pr.repo.name, pr.pull_id
     )
     data = {
         'commit_title': f'{pr.title} (#{pr.pull_id})',
         'commit_message': pr.body,
         'sha': pr.branch_sha,
         'merge_method': 'squash',
     }
-    response = requests.put(url, json=data)
+    response = pr.repo.put(url, json=data)
 
     if response.status_code == 200:
         # Merge succeeded.
@@ -638,10 +629,10 @@ def auto_delete_pr_branch(pr: PullRequestDetails) -> bool:
         )
         return False
 
-    url = "https://api.github.com/repos/{}/{}/git/refs/heads/{}?access_token={}".format(
-        remote.organization, remote.name, pr.branch_name, remote.access_token
+    url = "https://api.github.com/repos/{}/{}/git/refs/heads/{}".format(
+        remote.organization, remote.name, pr.branch_name
     )
-    response = requests.delete(url)
+    response = pr.repo.delete(url)
 
     if response.status_code == 204:
         # Delete succeeded.
@@ -662,17 +653,15 @@ def branch_data_modified_recently(payload: Any) -> bool:
 
 # TODO(#3388) Add summary line to docstring.
 # pylint: disable=docstring-first-line-empty
-def add_labels_to_pr(
-    repo: GithubRepository, pull_id: int, *labels: str, override_token: str = None
-) -> None:
+def add_labels_to_pr(repo: GithubRepository, pull_id: int, *labels: str) -> None:
     """
     References:
         https://developer.github.com/v3/issues/labels/#add-labels-to-an-issue
     """
-    url = "https://api.github.com/repos/{}/{}/issues/{}/labels?access_token={}".format(
-        repo.organization, repo.name, pull_id, override_token or repo.access_token
+    url = "https://api.github.com/repos/{}/{}/issues/{}/labels".format(
+        repo.organization, repo.name, pull_id
     )
-    response = requests.post(url, json=list(labels))
+    response = repo.post(url, json=list(labels))
 
     if response.status_code != 200:
         raise RuntimeError(
@@ -688,10 +677,10 @@ def remove_label_from_pr(repo: GithubRepository, pull_id: int, label: str) -> bo
     References:
         https://developer.github.com/v3/issues/labels/#remove-a-label-from-an-issue
     """
-    url = "https://api.github.com/repos/{}/{}/issues/{}/labels/{}?access_token={}".format(
-        repo.organization, repo.name, pull_id, label, repo.access_token
+    url = "https://api.github.com/repos/{}/{}/issues/{}/labels/{}".format(
+        repo.organization, repo.name, pull_id, label
     )
-    response = requests.delete(url)
+    response = repo.delete(url)
 
     if response.status_code == 404:
         payload = json.JSONDecoder().decode(response.content.decode())
@@ -715,14 +704,14 @@ def list_open_pull_requests(
 ) -> List[PullRequestDetails]:
     url = (
         f"https://api.github.com/repos/{repo.organization}/{repo.name}/pulls"
-        f"?per_page={per_page};access_token={repo.access_token}"
+        f"?per_page={per_page}"
     )
     data = {
         'state': 'open',
     }
     if base_branch is not None:
         data['base'] = base_branch
-    response = requests.get(url, json=data)
+    response = repo.get(url, json=data)
 
     if response.status_code != 200:
         raise RuntimeError(

dev_tools/github_repository.py

@@ -14,6 +14,8 @@
 
 from typing import Optional
 
+import requests
+
 
 class GithubRepository:
     """Details how to access a repository on github."""
@@ -36,3 +38,25 @@ def __init__(self, organization: str, name: str, access_token: Optional[str]) ->
     def as_remote(self) -> str:
         """Returns a string identifying the location of this repository."""
         return f'[email protected]:{self.organization}/{self.name}.git'
+
+    def delete(self, url, **kwargs):
+        return requests.delete(url, **self._auth(kwargs))
+
+    def get(self, url, **kwargs):
+        return requests.get(url, **self._auth(kwargs))
+
+    def put(self, url, **kwargs):
+        return requests.put(url, **self._auth(kwargs))
+
+    def post(self, url, **kwargs):
+        return requests.post(url, **self._auth(kwargs))
+
+    def patch(self, url, **kwargs):
+        return requests.patch(url, **self._auth(kwargs))
+
+    def _auth(self, kwargs):
+        new_kwargs = kwargs.copy()
+        headers = kwargs.get('headers', {})
+        headers.update({"Authorization": f"token {self.access_token}"})
+        new_kwargs.update(headers=headers)
+        return new_kwargs