-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
tools/psltool: support for analyzing a github PR (#2087)
- Loading branch information
Showing
4 changed files
with
224 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,132 @@ | ||
| // Package github provides a github client with functions tailored to | ||
| // the PSL's needs. | ||
| package github | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "os" | ||
| "time" | ||
|
|
||
| "github.com/google/go-github/v63/github" | ||
| ) | ||
|
|
||
| // Client is a GitHub API client that performs PSL-specific | ||
| // operations. The zero value is a client that interacts with the | ||
| // official publicsuffix/list repository. | ||
| type Client struct { | ||
| // Owner is the github account of the repository to query. If | ||
| // empty, defaults to "publicsuffix". | ||
| Owner string | ||
| // Repo is the repository to query. If empty, defaults to "list". | ||
| Repo string | ||
|
|
||
| client *github.Client | ||
| } | ||
|
|
||
| func (c *Client) owner() string { | ||
| if c.Owner != "" { | ||
| return c.Owner | ||
| } | ||
| return "publicsuffix" | ||
| } | ||
|
|
||
| func (c *Client) repo() string { | ||
| if c.Repo != "" { | ||
| return c.Repo | ||
| } | ||
| return "list" | ||
| } | ||
|
|
||
| func (c *Client) apiClient() *github.Client { | ||
| if c.client == nil { | ||
| c.client = github.NewClient(nil) | ||
| if token := os.Getenv("GITHUB_TOKEN"); token != "" { | ||
| c.client = c.client.WithAuthToken(token) | ||
| } | ||
| } | ||
| return c.client | ||
| } | ||
|
|
||
| // PSLForPullRequest fetches the PSL files needed to validate the | ||
| // given pull request. Returns the PSL file for the target branch, and | ||
| // the same but with the PR's changes applied. | ||
| func (c *Client) PSLForPullRequest(ctx context.Context, prNum int) (withoutPR, withPR []byte, err error) { | ||
| ctx, cancel := context.WithTimeout(ctx, 5*time.Second) | ||
| defer cancel() | ||
|
|
||
| pr, _, err := c.apiClient().PullRequests.Get(ctx, c.owner(), c.repo(), prNum) | ||
| if err != nil { | ||
| return nil, nil, err | ||
| } | ||
|
|
||
| if state := pr.GetState(); state != "open" { | ||
| return nil, nil, fmt.Errorf("cannot get PSL for PR %d with status %q", prNum, state) | ||
| } | ||
| if !pr.GetMergeable() { | ||
| return nil, nil, fmt.Errorf("cannot get PSL for PR %d, needs rebase", prNum) | ||
| } | ||
| trialMergeCommit := pr.GetMergeCommitSHA() | ||
| if trialMergeCommit == "" { | ||
| return nil, nil, fmt.Errorf("no trial merge commit available for PR %d", prNum) | ||
| } | ||
|
|
||
| prHeadCommit := pr.GetHead().GetSHA() | ||
| if prHeadCommit == "" { | ||
| return nil, nil, fmt.Errorf("no commit SHA available for head of PR %d", prNum) | ||
| } | ||
|
|
||
| // We want to return the trial merge commit's PSL as withPR, and | ||
| // the non-PR parent of that merge as withoutPR. Github only | ||
| // provides information about the trial merge commit and the PR | ||
| // head commit in the PR API. It also provides a "base" ref, but | ||
| // empirical evidence shows this points at some random commit | ||
| // somewhere and updates based on unclear triggers. IOW, it is | ||
| // _not_ "master without the PR applied". | ||
| // | ||
| // Instead, we have to ask the git API for information about the | ||
| // trial merge commit, and find the correct withoutPR SHA from | ||
| // that. | ||
| commitInfo, _, err := c.apiClient().Git.GetCommit(ctx, c.owner(), c.repo(), trialMergeCommit) | ||
| if err != nil { | ||
| return nil, nil, fmt.Errorf("getting info for trial merge SHA %q: %w", trialMergeCommit, err) | ||
| } | ||
| var beforeMergeCommit string | ||
| if numParents := len(commitInfo.Parents); numParents != 2 { | ||
| return nil, nil, fmt.Errorf("unexpected parent count %d for trial merge commit on PR %d, expected 2 parents", numParents, prNum) | ||
| } | ||
| if commitInfo.Parents[0].GetSHA() == prHeadCommit { | ||
| beforeMergeCommit = commitInfo.Parents[1].GetSHA() | ||
| } else { | ||
| beforeMergeCommit = commitInfo.Parents[0].GetSHA() | ||
| } | ||
|
|
||
| withoutPR, err = c.PSLForHash(ctx, beforeMergeCommit) | ||
| if err != nil { | ||
| return nil, nil, err | ||
| } | ||
| withPR, err = c.PSLForHash(ctx, trialMergeCommit) | ||
| if err != nil { | ||
| return nil, nil, err | ||
| } | ||
| return withoutPR, withPR, nil | ||
| } | ||
|
|
||
| // PSLForHash returns the PSL file at the given git commit hash. | ||
| func (c *Client) PSLForHash(ctx context.Context, hash string) ([]byte, error) { | ||
| ctx, cancel := context.WithTimeout(ctx, 5*time.Second) | ||
| defer cancel() | ||
|
|
||
| opts := &github.RepositoryContentGetOptions{ | ||
| Ref: hash, | ||
| } | ||
| content, _, _, err := c.apiClient().Repositories.GetContents(ctx, c.owner(), c.repo(), "public_suffix_list.dat", opts) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("getting PSL for commit %q: %w", hash, err) | ||
| } | ||
| ret, err := content.GetContent() | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| return []byte(ret), nil | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters