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.

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 multiple required workflow runs #5057

Merged
merged 21 commits into from
Nov 19, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
0bbf42a
Fix GitHub pull request mergeability for workflows with multiple runs
ajax-ryzhyi-r Nov 4, 2024
246abf5
Merge remote-tracking branch 'origin/main' into fix_github_pr_mergeab…
ajax-ryzhyi-r Nov 4, 2024
faecb4b
Merge remote-tracking branch 'origin/main' into fix_github_pr_mergeab…
ajax-ryzhyi-r Nov 4, 2024
ffebd15
Refactor fix to use runNumber for determining latest workflow run
ajax-ryzhyi-r Nov 4, 2024
8ae2d46
Refactor fix to use runNumber for determining latest workflow run
ajax-ryzhyi-r Nov 4, 2024
c354153
Refactor fix to use runNumber for determining latest workflow run
ajax-ryzhyi-r Nov 4, 2024
d7bafaa
Refactor fix to use runNumber for determining latest workflow run
ajax-ryzhyi-r Nov 4, 2024
e6a927e
Add trailing whitespaces for test files
ajax-ryzhyi-r Nov 4, 2024
69dbdd9
Merge branch 'main' into fix_github_pr_mergeability
ajax-ryzhyi-r Nov 5, 2024
7ac6b8d
Merge branch 'main' into fix_github_pr_mergeability
X-Guardian Nov 5, 2024
99c00e3
Revert EOF LFs in test files
ajax-ryzhyi-r Nov 6, 2024
7dc0b29
Merge branch 'main' into fix_github_pr_mergeability
ajax-ryzhyi-r Nov 6, 2024
4594e28
Fix comments
ajax-ryzhyi-r Nov 7, 2024
101e7e7
Fix comments
ajax-ryzhyi-r Nov 7, 2024
c97685d
Merge branch 'main' into fix_github_pr_mergeability
ajax-ryzhyi-r Nov 7, 2024
df00c99
Fix comment
ajax-ryzhyi-r Nov 12, 2024
bd76d67
Merge branch 'main' into fix_github_pr_mergeability
ajax-ryzhyi-r Nov 12, 2024
c107dae
Merge branch 'main' into fix_github_pr_mergeability
X-Guardian Nov 16, 2024
b1ab021
Merge branch 'main' into fix_github_pr_mergeability
X-Guardian Nov 17, 2024
ea10ec2
Merge branch 'main' into fix_github_pr_mergeability
X-Guardian Nov 17, 2024
7f95b8f
Merge branch 'main' into fix_github_pr_mergeability
X-Guardian Nov 19, 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
18 changes: 11 additions & 7 deletions server/events/vcs/github_client.go
Original file line number Diff line number Diff line change
Expand Up @@ -719,9 +719,11 @@ 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
X-Guardian marked this conversation as resolved.
Show resolved Hide resolved
// 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])
}
}

Expand All @@ -735,16 +737,18 @@ func ExpectedCheckPassed(expectedContext githubv4.String, checkRuns []CheckRun,
}

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
6 changes: 6 additions & 0 deletions server/events/vcs/github_client_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -781,6 +781,12 @@ func TestGithubClient_PullIsMergeableWithAllowMergeableBypassApply(t *testing.T)
`"APPROVED"`,
true,
},
{
"blocked",
"ruleset-workflow-passed-multiple-runs.json",
`"APPROVED"`,
true,
},
{
"blocked",
"ruleset-workflow-passed-sha-match.json",
Expand Down
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"
}
}
}
}
]
}
}
}
}
]
}
}
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -92,4 +92,4 @@
}
}
}
}
}