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

fix: Fix GitHub pull request mergeability for rerun checks #5051

Closed
wants to merge 5 commits into from
Closed

fix: Fix GitHub pull request mergeability for rerun checks #5051

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
639a424
Fix GitHub pull request mergeability for rerun checks
ajax-ryzhyi-r Nov 2, 2024
c2128ca
Fix GitHub pull request mergeability for rerun checks
ajax-ryzhyi-r Nov 2, 2024
ebb3e19
Merge branch 'main' into github-mergeability-fix
ajax-ryzhyi-r Nov 2, 2024
325dda2
Merge branch 'main' into github-mergeability-fix
jamengual Nov 3, 2024
6a002a6
Fix GitHub pull request mergeability for rerun checks
ajax-ryzhyi-r Nov 3, 2024
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: 16 additions & 10 deletions server/events/vcs/github_client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -719,32 +719,38 @@ func StatusContextPassed(statusContext StatusContext, vcsstatusname string) bool
}

func ExpectedCheckPassed(expectedContext githubv4.String, checkRuns []CheckRun, statusContexts []StatusContext, vcsstatusname string) bool {
for _, checkRun := range checkRuns {
if checkRun.Name == expectedContext {
return CheckRunPassed(checkRun)
// Iterate through checkRuns from the end, as GitHub returns them in chronological order
// The last checkRun in the array represents the current status
for i := len(checkRuns) - 1; i >= 0; i-- {
if checkRuns[i].Name == expectedContext {
return CheckRunPassed(checkRuns[i])
}
}

for _, statusContext := range statusContexts {
if statusContext.Context == expectedContext {
return StatusContextPassed(statusContext, vcsstatusname)
// Iterate through statusContexts from the end, as GitHub returns them in chronological order
// The last statusContext in the array represents the current status
for i := len(statusContexts) - 1; i >= 0; i-- {
if statusContexts[i].Context == expectedContext {
return StatusContextPassed(statusContexts[i], vcsstatusname)
}
}

return false
}

func (g *GithubClient) ExpectedWorkflowPassed(expectedWorkflow WorkflowFileReference, checkRuns []CheckRun) (bool, error) {
for _, checkRun := range checkRuns {
if checkRun.CheckSuite.WorkflowRun == nil {
// Iterate through checkRuns from the end, as GitHub returns them in chronological order
// The last checkRun in the array represents the current status
for i := len(checkRuns) - 1; i >= 0; i-- {
if checkRuns[i].CheckSuite.WorkflowRun == nil {
continue
}
match, err := g.WorkflowRunMatchesWorkflowFileReference(*checkRun.CheckSuite.WorkflowRun, expectedWorkflow)
match, err := g.WorkflowRunMatchesWorkflowFileReference(*checkRuns[i].CheckSuite.WorkflowRun, expectedWorkflow)
if err != nil {
return false, err
}
if match {
return CheckRunPassed(checkRun), nil
return CheckRunPassed(checkRuns[i]), nil
}
}

Expand Down
18 changes: 18 additions & 0 deletions server/events/vcs/github_client_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -745,6 +745,12 @@ func TestGithubClient_PullIsMergeableWithAllowMergeableBypassApply(t *testing.T)
`"APPROVED"`,
true,
},
{
"blocked",
"branch-protection-passed-with-retry.json",
`"APPROVED"`,
true,
},
{
"blocked",
"ruleset-check-expected.json",
Expand All @@ -763,6 +769,12 @@ func TestGithubClient_PullIsMergeableWithAllowMergeableBypassApply(t *testing.T)
`"APPROVED"`,
true,
},
{
"blocked",
"ruleset-check-passed-with-retry.json",
`"APPROVED"`,
true,
},
{
"blocked",
"ruleset-workflow-expected.json",
Expand Down Expand Up @@ -793,6 +805,12 @@ func TestGithubClient_PullIsMergeableWithAllowMergeableBypassApply(t *testing.T)
`"APPROVED"`,
false,
},
{
"blocked",
"ruleset-workflow-passed-with-retry.json",
`"APPROVED"`,
true,
},
}

// Use a real GitHub json response and edit the mergeable_state field.
Expand Down
70 changes: 70 additions & 0 deletions ...ts/vcs/testdata/github-pull-request-mergeability/branch-protection-passed-with-retry.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
{
"data": {
"repository": {
"pullRequest": {
"reviewDecision": null,
"baseRef": {
"branchProtectionRule": {
"requiredStatusChecks": [
{
"context": "atlantis/apply"
},
{
"context": "my-required-expected-check"
}
]
},
"rules": {
"pageInfo": {
"endCursor": "QWERTY",
"hasNextPage": false
},
"nodes": []
}
},
"commits": {
"nodes": [
{
"commit": {
"statusCheckRollup": {
"contexts": {
"pageInfo": {
"endCursor": "QWERTY",
"hasNextPage": false
},
"nodes": [
{
"__typename": "StatusContext",
"context": "atlantis/apply",
"state": "PENDING",
"isRequired": true
},
{
"__typename": "StatusContext",
"context": "atlantis/plan",
"state": "SUCCESS",
"isRequired": false
},
{
"__typename": "StatusContext",
"context": "my-required-expected-check",
"state": "FAILURE",
"isRequired": true
},
{
"__typename": "StatusContext",
"context": "my-required-expected-check",
"state": "SUCCESS",
"isRequired": true
}
]
}
}
}
}
]
}
}
}
}
}
80 changes: 80 additions & 0 deletions ...events/vcs/testdata/github-pull-request-mergeability/ruleset-check-passed-with-retry.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
{
"data": {
"repository": {
"pullRequest": {
"reviewDecision": null,
"baseRef": {
"branchProtectionRule": {
"requiredStatusChecks": []
},
"rules": {
"pageInfo": {
"endCursor": "QWERTY",
"hasNextPage": false
},
"nodes": [
{
"type": "REQUIRED_STATUS_CHECKS",
"repositoryRuleset": {
"enforcement": "ACTIVE"
},
"parameters": {
"requiredStatusChecks": [
{
"context": "atlantis/apply"
},
{
"context": "my-required-expected-check"
}
]
}
}
]
}
},
"commits": {
"nodes": [
{
"commit": {
"statusCheckRollup": {
"contexts": {
"pageInfo": {
"endCursor": "QWERTY",
"hasNextPage": false
},
"nodes": [
{
"__typename": "StatusContext",
"context": "atlantis/apply",
"state": "PENDING",
"isRequired": true
},
{
"__typename": "StatusContext",
"context": "atlantis/plan",
"state": "SUCCESS",
"isRequired": false
},
{
"__typename": "StatusContext",
"context": "my-required-expected-check",
"state": "FAILURE",
"isRequired": true
},
{
"__typename": "StatusContext",
"context": "my-required-expected-check",
"state": "SUCCESS",
"isRequired": true
}
]
}
}
}
}
]
}
}
}
}
}
110 changes: 110 additions & 0 deletions ...nts/vcs/testdata/github-pull-request-mergeability/ruleset-workflow-passed-with-retry.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
{
"data": {
"repository": {
"pullRequest": {
"reviewDecision": null,
"baseRef": {
"branchProtectionRule": {
"requiredStatusChecks": []
},
"rules": {
"pageInfo": {
"endCursor": "QWERTY",
"hasNextPage": false
},
"nodes": [
{
"type": "REQUIRED_STATUS_CHECKS",
"repositoryRuleset": {
"enforcement": "ACTIVE"
},
"parameters": {
"requiredStatusChecks": [
{
"context": "atlantis/apply"
}
]
}
},
{
"type": "WORKFLOWS",
"repositoryRuleset": {
"enforcement": "ACTIVE"
},
"parameters": {
"workflows": [
{
"path": ".github/workflows/my-required-workflow.yaml",
"repositoryId": 120519269,
"sha": null
}
]
}
}
]
}
},
"commits": {
"nodes": [
{
"commit": {
"statusCheckRollup": {
"contexts": {
"pageInfo": {
"endCursor": "QWERTY",
"hasNextPage": false
},
"nodes": [
{
"__typename": "StatusContext",
"context": "atlantis/apply",
"state": "PENDING",
"isRequired": true
},
{
"__typename": "StatusContext",
"context": "atlantis/plan",
"state": "SUCCESS",
"isRequired": false
},
{
"__typename": "CheckRun",
"name": "my required check",
"conclusion": "FAILURE",
"isRequired": true,
"checkSuite": {
"workflowRun": {
"file": {
"path": ".github/workflows/my-required-workflow.yaml",
"repositoryFileUrl": "https://github.com/runatlantis/atlantis/blob/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/.github/workflows/my-required-workflow.yaml",
"repositoryName": "runatlantis/atlantis"
}
}
}
},
{
"__typename": "CheckRun",
"name": "my required check",
"conclusion": "SUCCESS",
"isRequired": true,
"checkSuite": {
"workflowRun": {
"file": {
"path": ".github/workflows/my-required-workflow.yaml",
"repositoryFileUrl": "https://github.com/runatlantis/atlantis/blob/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/.github/workflows/my-required-workflow.yaml",
"repositoryName": "runatlantis/atlantis"
}
}
}
}
]
}
}
}
}
]
}
}
}
}
}