Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Modify graphql token logic to include refresh #2475

Closed
wants to merge 2 commits into from
Closed

Modify graphql token logic to include refresh #2475

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8352914
Modify graphql token logic to include refresh
rayterrill Aug 26, 2022
b17b65d
Remove extra print lines
rayterrill Aug 30, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 6 additions & 20 deletions server/events/vcs/github_client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ import (
"github.com/runatlantis/atlantis/server/events/vcs/common"
"github.com/runatlantis/atlantis/server/logging"
"github.com/shurcooL/githubv4"
"golang.org/x/oauth2"
)

// maxCommentLength is the maximum number of chars allowed in a single comment
Expand All @@ -42,7 +41,7 @@ type GithubClient struct {
user string
client *github.Client
v4MutateClient *graphql.Client
v4QueryClient *githubv4.Client
v4QueryClient GithubGraphQLClient
ctx context.Context
logger logging.SimpleLogging
config GithubConfig
Expand Down Expand Up @@ -95,16 +94,11 @@ func NewGithubClient(hostname string, credentials GithubCredentials, config Gith
transport,
graphql.WithHeader("Accept", "application/vnd.github.queen-beryl-preview+json"),
)
token, err := credentials.GetToken()
if err != nil {
return nil, errors.Wrap(err, "Failed to get GitHub token")

ghGraphQLClient := GithubGraphQLClient{
credentials: credentials,
graphqlURL: graphqlURL,
}
src := oauth2.StaticTokenSource(
&oauth2.Token{AccessToken: token},
)
httpClient := oauth2.NewClient(context.Background(), src)
// Use the client from shurcooL's githubv4 library for queries.
v4QueryClient := githubv4.NewEnterpriseClient(graphqlURL, httpClient)

user, err := credentials.GetUser()
logger.Debug("GH User: %s", user)
Expand All @@ -116,7 +110,7 @@ func NewGithubClient(hostname string, credentials GithubCredentials, config Gith
user: user,
client: client,
v4MutateClient: v4MutateClient,
v4QueryClient: v4QueryClient,
v4QueryClient: ghGraphQLClient,
ctx: context.Background(),
logger: logger,
config: config,
Expand Down Expand Up @@ -344,28 +338,22 @@ func (g *GithubClient) GetCombinedStatusMinusApply(repo models.Repo, pull *githu
//iterate over check completed check suites - return false if we find one that doesnt have conclusion = "success"
for _, c := range checksuites.CheckSuites {
if *c.Status == "completed" {
fmt.Printf("Looking at suite %v\n", *c.ID)
//iterate over the runs inside the suite
suite, _, err := g.client.Checks.ListCheckRunsCheckSuite(context.Background(), repo.Owner, repo.Name, *c.ID, nil)
if err != nil {
return false, errors.Wrap(err, "getting check runs for check suite")
}

for _, r := range suite.CheckRuns {
fmt.Printf("Looking at check run %s\n", *r.Name)
//check to see if the check is required
if isRequiredCheck(*r.Name, required.RequiredStatusChecks.Contexts) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This code will crash if no required checks are configured for the repo. While feature flag kind of implies that at least one required check should be set - atlantis/apply - it's completely plausible to have 1 or 2 repos in organization misconfigured or deliberately configured in a different way. If there are no required checks it means that we don't even need to go through CheckRuns.

I understand it's out of scope of this PR, but feels like the best place to point it out :)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure what you mean @stasostrovskyi - I just tested this again with no required checks configured and it works fine? It should just pass right through that section if none of the checks are required?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is what we got when running without required checks

Error: goroutine panic. This is a bug.

runtime error: invalid memory address or nil pointer dereference
runtime/panic.go:260 (0x44c9d5)
runtime/signal_unix.go:835 (0x44c9a5)
github.com/runatlantis/atlantis/server/events/vcs/github_client.go:357 (0xa89acc)
github.com/runatlantis/atlantis/server/events/vcs/github_client.go:430 (0xa8a197)
github.com/runatlantis/atlantis/server/events/vcs/instrumented_client.go:179 (0xa90beb)
github.com/runatlantis/atlantis/server/events/vcs/proxy.go:72 (0xa925e4)
github.com/runatlantis/atlantis/server/events/vcs/pull_status_fetcher.go:28 (0xa92e65)
github.com/runatlantis/atlantis/server/events/apply_command_runner.go:109 (0xc72835)
github.com/runatlantis/atlantis/server/events/command_runner.go:296 (0xc77443)
runtime/asm_amd64.s:1594 (0x467ce0)

I haven't debugged it but it's either required or RequiredStatusChecks are nil in the case when there are no required checks.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

GitHub probably returns nil ("null" in JSON) instead of an empty list as the code expects.

fmt.Println("Check is required")
if *c.Conclusion == "success" {
fmt.Println("Check is successful")
continue
} else {
fmt.Println("Check is failed")
return false, nil
}
} else {
//ignore checks that arent required
fmt.Println("Check is not required")
continue
}

Expand Down Expand Up @@ -432,8 +420,6 @@ func (g *GithubClient) PullIsMergeable(repo models.Repo, pull models.PullRequest
return false, errors.Wrap(err, "getting pull request status")
}

fmt.Printf("Status was %v\n", status)

//check to see if pr is approved using reviewDecision
approved, err := g.GetPullReviewDecision(repo, pull)
if err != nil {
Expand Down
34 changes: 34 additions & 0 deletions server/events/vcs/github_graphql_client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
package vcs

import (
"context"

"github.com/pkg/errors"
"github.com/shurcooL/githubv4"
"golang.org/x/oauth2"
)

type GithubGraphQLClient struct {
credentials GithubCredentials
graphqlURL string
}

func (gcl GithubGraphQLClient) Query(ctx context.Context, q interface{}, variables map[string]interface{}) error {
token, err := gcl.credentials.GetToken()
if err != nil {
return errors.Wrap(err, "Failed to get GitHub token")
}
src := oauth2.StaticTokenSource(
&oauth2.Token{AccessToken: token},
)
httpClient := oauth2.NewClient(context.Background(), src)
// Use the client from shurcooL's githubv4 library for queries.
v4QueryClient := githubv4.NewEnterpriseClient(gcl.graphqlURL, httpClient)

err = v4QueryClient.Query(ctx, q, variables)
if err != nil {
return errors.Wrap(err, "making graphql query")
}

return nil
}