From e4dea0311debf65c2af9bea0ae4daf505b5cef08 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Henrik=20Lundstr=C3=B6m?= <henrik94lundstrom@gmail.com>
Date: Mon, 4 Nov 2024 18:59:23 +0100
Subject: [PATCH] fix: Ignore apply check(s) even if missing from rollup when
 determining mergeability for GitHub (#4974)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Henrik Lundström <henrik94lundstrom@gmail.com>
---
 server/events/vcs/github_client.go            |  7 ++-
 server/events/vcs/github_client_test.go       |  6 +++
 .../ruleset-atlantis-apply-expected.json      | 52 +++++++++++++++++++
 3 files changed, 63 insertions(+), 2 deletions(-)
 create mode 100644 server/events/vcs/testdata/github-pull-request-mergeability/ruleset-atlantis-apply-expected.json

diff --git a/server/events/vcs/github_client.go b/server/events/vcs/github_client.go
index 826cff8b09..698d4dc999 100644
--- a/server/events/vcs/github_client.go
+++ b/server/events/vcs/github_client.go
@@ -714,8 +714,7 @@ func CheckRunPassed(checkRun CheckRun) bool {
 }
 
 func StatusContextPassed(statusContext StatusContext, vcsstatusname string) bool {
-	return strings.HasPrefix(string(statusContext.Context), fmt.Sprintf("%s/%s", vcsstatusname, command.Apply.String())) ||
-		statusContext.State == "SUCCESS"
+	return statusContext.State == "SUCCESS"
 }
 
 func ExpectedCheckPassed(expectedContext githubv4.String, checkRuns []CheckRun, statusContexts []StatusContext, vcsstatusname string) bool {
@@ -775,6 +774,10 @@ func (g *GithubClient) IsMergeableMinusApply(logger logging.SimpleLogging, repo
 	// Go through all checks and workflows required by branch protection or rulesets
 	// Make sure that they can all be found in the statusCheckRollup and that they all pass
 	for _, requiredCheck := range requiredChecks {
+		if strings.HasPrefix(string(requiredCheck), fmt.Sprintf("%s/%s", vcsstatusname, command.Apply.String())) {
+			// Ignore atlantis apply check(s)
+			continue
+		}
 		if !ExpectedCheckPassed(requiredCheck, checkRuns, statusContexts, vcsstatusname) {
 			logger.Debug("%s: Expected Required Check: %s", notMergeablePrefix, requiredCheck)
 			return false, nil
diff --git a/server/events/vcs/github_client_test.go b/server/events/vcs/github_client_test.go
index 632fe6bca6..b668f9e919 100644
--- a/server/events/vcs/github_client_test.go
+++ b/server/events/vcs/github_client_test.go
@@ -691,6 +691,12 @@ func TestGithubClient_PullIsMergeableWithAllowMergeableBypassApply(t *testing.T)
 			`"APPROVED"`,
 			false,
 		},
+		{
+			"blocked",
+			"ruleset-atlantis-apply-expected.json",
+			`"APPROVED"`,
+			true,
+		},
 		{
 			"blocked",
 			"ruleset-optional-check-failed.json",
diff --git a/server/events/vcs/testdata/github-pull-request-mergeability/ruleset-atlantis-apply-expected.json b/server/events/vcs/testdata/github-pull-request-mergeability/ruleset-atlantis-apply-expected.json
new file mode 100644
index 0000000000..f83b126d4e
--- /dev/null
+++ b/server/events/vcs/testdata/github-pull-request-mergeability/ruleset-atlantis-apply-expected.json
@@ -0,0 +1,52 @@
+{
+  "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"
+                    }
+                  ]
+                }
+              }
+            ]
+          }
+        },
+        "commits": {
+          "nodes": [
+            {
+              "commit": {
+                "statusCheckRollup": {
+                  "contexts": {
+                    "pageInfo": {
+                      "endCursor": "QWERTY",
+                      "hasNextPage": false
+                    },
+                    "nodes": []
+                  }
+                }
+              }
+            }
+          ]
+        }
+      }
+    }
+  }
+}