1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
|
## @file
# GitHub API helper functions.
#
# Copyright (c) Microsoft Corporation.
# SPDX-License-Identifier: BSD-2-Clause-Patent
#
import git
import logging
import re
from collections import OrderedDict
from edk2toollib.utility_functions import RunPythonScript
from github import Auth, Github, GithubException
from io import StringIO
from typing import List
"""GitHub API helper functions."""
def _authenticate(token: str):
"""Authenticate to GitHub using a token.
Returns a GitHub instance that is authenticated using the provided
token.
Args:
token (str): The GitHub token to use for authentication.
Returns:
Github: A GitHub instance.
"""
auth = Auth.Token(token)
return Github(auth=auth)
def _get_pr(token: str, owner: str, repo: str, pr_number: int):
"""Get the PR object from GitHub.
Args:
token (str): The GitHub token to use for authentication.
owner (str): The GitHub owner (organization) name.
repo (str): The GitHub repository name (e.g. 'edk2').
pr_number (int): The pull request number.
Returns:
PullRequest: A PyGithub PullRequest object for the given pull request
or None if the attempt to get the PR fails.
"""
try:
g = _authenticate(token)
return g.get_repo(f"{owner}/{repo}").get_pull(pr_number)
except GithubException as ge:
print(
f"::error title=Error Getting PR {pr_number} Info!::"
f"{ge.data['message']}"
)
return None
def leave_pr_comment(
token: str, owner: str, repo: str, pr_number: int, comment_body: str
):
"""Leaves a comment on a PR.
Args:
token (str): The GitHub token to use for authentication.
owner (str): The GitHub owner (organization) name.
repo (str): The GitHub repository name (e.g. 'edk2').
pr_number (int): The pull request number.
comment_body (str): The comment text. Markdown is supported.
"""
if pr := _get_pr(token, owner, repo, pr_number):
try:
pr.create_issue_comment(comment_body)
except GithubException as ge:
print(
f"::error title=Error Commenting on PR {pr_number}!::"
f"{ge.data['message']}"
)
def get_reviewers_for_range(
workspace_path: str,
maintainer_file_path: str,
range_start: str = "master",
range_end: str = "HEAD",
) -> List[str]:
"""Get the reviewers for the current branch.
To get the reviewers for a single commit, set `range_start` and
`range_end` to the commit SHA.
Args:
workspace_path (str): The workspace path.
maintainer_file_path (str): The maintainer file path.
range_start (str, optional): The range start ref. Defaults to "master".
range_end (str, optional): The range end ref. Defaults to "HEAD".
Returns:
List[str]: A list of GitHub usernames.
"""
if range_start == range_end:
commits = [range_start]
else:
commits = [
c.hexsha
for c in git.Repo(workspace_path).iter_commits(
f"{range_start}..{range_end}"
)
]
raw_reviewers = []
for commit_sha in commits:
reviewer_stream_buffer = StringIO()
cmd_ret = RunPythonScript(
maintainer_file_path,
f"-g {commit_sha}",
workingdir=workspace_path,
outstream=reviewer_stream_buffer,
logging_level=logging.INFO,
)
if cmd_ret != 0:
print(
f"::error title=Reviewer Lookup Error!::Error calling GetMaintainer.py: [{cmd_ret}]: {reviewer_stream_buffer.getvalue()}"
)
return []
commit_reviewers = reviewer_stream_buffer.getvalue()
pattern = r"\[(.*?)\]"
matches = re.findall(pattern, commit_reviewers)
if not matches:
return []
print(
f"::debug title=Commit {commit_sha[:7]} Reviewer(s)::{', '.join(matches)}"
)
raw_reviewers.extend(matches)
reviewers = list(OrderedDict.fromkeys([r.strip() for r in raw_reviewers]))
print(f"::debug title=Total Reviewer Set::{', '.join(reviewers)}")
return reviewers
def get_pr_sha(token: str, owner: str, repo: str, pr_number: int) -> str:
"""Returns the commit SHA of given PR branch.
This returns the SHA of the merge commit that GitHub creates from a
PR branch. This commit contains all of the files in the PR branch in
a single commit.
Args:
token (str): The GitHub token to use for authentication.
owner (str): The GitHub owner (organization) name.
repo (str): The GitHub repository name (e.g. 'edk2').
pr_number (int): The pull request number.
Returns:
str: The commit SHA of the PR branch. An empty string is returned
if the request fails.
"""
if pr := _get_pr(token, owner, repo, pr_number):
merge_commit_sha = pr.merge_commit_sha
print(f"::debug title=PR {pr_number} Merge Commit SHA::{merge_commit_sha}")
return merge_commit_sha
return ""
def add_reviewers_to_pr(
token: str, owner: str, repo: str, pr_number: int, user_names: List[str]
) -> List[str]:
"""Adds the set of GitHub usernames as reviewers to the PR.
Args:
token (str): The GitHub token to use for authentication.
owner (str): The GitHub owner (organization) name.
repo (str): The GitHub repository name (e.g. 'edk2').
pr_number (int): The pull request number.
user_names (List[str]): List of GitHub usernames to add as reviewers.
Returns:
List[str]: A list of GitHub usernames that were successfully added as
reviewers to the PR. This list will exclude any reviewers
from the list provided if they are not relevant to the PR.
"""
try:
g = _authenticate(token)
repo_gh = g.get_repo(f"{owner}/{repo}")
pr = repo_gh.get_pull(pr_number)
except GithubException as ge:
print(
f"::error title=Error Getting PR {pr_number} Info!::"
f"{ge.data['message']}"
)
return None
pr_author = pr.user.login.strip()
while pr_author in user_names:
user_names.remove(pr_author)
repo_collaborators = [c.login.strip() for c in repo_gh.get_collaborators()]
non_collaborators = [u for u in user_names if u not in repo_collaborators]
if non_collaborators:
print(
f"::error title=User is not a Collaborator!::{', '.join(non_collaborators)}"
)
leave_pr_comment(
token,
owner,
repo,
pr_number,
f"⚠ **WARNING: Cannot add reviewers**: A user specified as a "
f"reviewer for this PR is not a collaborator "
f"of the edk2 repository. Please add them as a collaborator to the "
f"repository and re-request the review.\n\n"
f"Users requested:\n{', '.join(user_names)}",
)
pr.create_review_request(reviewers=user_names)
return user_names
|
