mirror of
https://github.com/acidanthera/audk.git
synced 2025-04-08 17:05:09 +02:00
f617b6ee0e
Enhances the flow that adds a comment on a PR if a non-collaborator is in the reviewer list by checking if a comment was previously left on the PR. If it was for the same set of non-collaborators, another comment is not created. If a new non-collaborator is discovered, the message will be left identifying that new user account. Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
268 lines
9.1 KiB
Python
268 lines
9.1 KiB
Python
## @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()
|
|
|
|
current_pr_requested_reviewers = [
|
|
r.login.strip() for r in pr.get_review_requests()[0]
|
|
]
|
|
current_pr_reviewed_reviewers = [r.user.login.strip() for r in pr.get_reviews()]
|
|
current_pr_reviewers = list(
|
|
set(current_pr_requested_reviewers + current_pr_reviewed_reviewers)
|
|
)
|
|
|
|
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]
|
|
|
|
excluded_pr_reviewers = [pr_author] + current_pr_reviewers + non_collaborators
|
|
new_pr_reviewers = [u for u in user_names if u not in excluded_pr_reviewers]
|
|
|
|
if non_collaborators:
|
|
print(
|
|
f"::error title=User is not a Collaborator!::{', '.join(non_collaborators)}"
|
|
)
|
|
|
|
for comment in pr.get_issue_comments():
|
|
# If a comment has already been made for these non-collaborators,
|
|
# do not make another comment.
|
|
if (
|
|
comment.user.login == "github-actions[bot]"
|
|
and "WARNING: Cannot add some reviewers" in comment.body
|
|
and all(u in comment.body for u in non_collaborators)
|
|
):
|
|
break
|
|
else:
|
|
repo_admins = [
|
|
a.login for a in repo_gh.get_collaborators(permission="admin")
|
|
]
|
|
|
|
leave_pr_comment(
|
|
token,
|
|
owner,
|
|
repo,
|
|
pr_number,
|
|
f"⚠ **WARNING: Cannot add some reviewers**: A user "
|
|
f"specified as a reviewer for this PR is not a collaborator "
|
|
f"of the repository. Please add them as a collaborator to "
|
|
f"the repository so they can be requested in the future.\n\n"
|
|
f"Non-collaborators requested:\n"
|
|
f"{'\n'.join([f'- @{c}' for c in non_collaborators])}"
|
|
f"\n\nAttn Admins:\n"
|
|
f"{'\n'.join([f'- @{a}' for a in repo_admins])}\n---\n"
|
|
f"**Admin Instructions:**\n"
|
|
f"- Add the non-collaborators as collaborators to the "
|
|
f"appropriate team(s) listed in "
|
|
f"[teams](https://github.com/orgs/tianocore/teams)\n"
|
|
f"- If they are no longer needed as reviewers, remove them "
|
|
f"from [`Maintainers.txt`](https://github.com/tianocore/edk2/blob/HEAD/Maintainers.txt)",
|
|
)
|
|
|
|
# Add any new reviewers to the PR if needed.
|
|
if new_pr_reviewers:
|
|
print(
|
|
f"::debug title=Adding New PR Reviewers::" f"{', '.join(new_pr_reviewers)}"
|
|
)
|
|
|
|
pr.create_review_request(reviewers=new_pr_reviewers)
|
|
|
|
return new_pr_reviewers
|