MergeQueue added to common push handler and tests

Author: birmacher

bitriseapi/bitriseapi.go

@@ -41,6 +41,15 @@ const (
 	PullRequestReadyStateConvertedToReadyForReview PullRequestReadyState = "converted_to_ready_for_review"
 )
 
+// MergeQueue ...
+type MergeQueueModel struct {
+	QueueProvider string `json:"queue_provider"`
+	PullRequestID int    `json:"pull_request_id"`
+	BaseBranch    string `json:"base_branch"`
+	BaseSHA       string `json:"base_sha"`
+	SyntheticSHA  string `json:"synthetic_sha"`
+}
+
 // BuildParamsModel ...
 type BuildParamsModel struct {
 	// git commit hash
@@ -97,6 +106,8 @@ type BuildParamsModel struct {
 	PullRequestComment string `json:"pull_request_comment,omitempty"`
 	// newly added pull request comment's ID
 	PullRequestCommentID string `json:"pull_request_comment_id,omitempty"`
+	// merge queue
+	MergeQueue MergeQueueModel `json:"merge_queue,omitempty"`
 }
 
 // TriggerAPIParamsModel ...

service/hook/github/github.go

@@ -31,26 +31,15 @@ type CommitModel struct {
 	CommitMessage string `json:"message"`
 }
 
-// MergeQueueMeta ...
-type MergeQueuePushModel struct {
-	QueueProvider string `json:"queue_provider,omitempty"`
-	PRNumber      int    `json:"pr_number,omitempty"`
-	BaseBranch    string `json:"base_branch,omitempty"`
-	BaseSHA       string `json:"base_sha,omitempty"`
-	SyntheticSHA  string `json:"synthetic_sha,omitempty"`
-}
-
 // PushEventModel ...
 type PushEventModel struct {
-	Ref              string               `json:"ref"`
-	Deleted          bool                 `json:"deleted"`
-	HeadCommit       CommitModel          `json:"head_commit"`
-	Commits          []CommitModel        `json:"commits"`
-	Repo             RepoInfoModel        `json:"repository"`
-	Pusher           PusherModel          `json:"pusher"`
-	IsMergeQueuePush bool                 `json:"is_merge_queue_push"`
-	After            string               `json:"after"`
-	MergeQueue       *MergeQueuePushModel `json:"merge_queue"`
+	Ref        string        `json:"ref"`
+	Deleted    bool          `json:"deleted"`
+	HeadCommit CommitModel   `json:"head_commit"`
+	Commits    []CommitModel `json:"commits"`
+	Repo       RepoInfoModel `json:"repository"`
+	Pusher     PusherModel   `json:"pusher"`
+	After      string        `json:"after"`
 }
 
 // UserModel ...
@@ -218,28 +207,37 @@ func transformPushEvent(pushEvent PushEventModel) hookCommon.TransformResultMode
 		commitMessages = append(commitMessages, commit.CommitMessage)
 	}
 
-	if strings.HasPrefix(pushEvent.Ref, "refs/heads/gh-readonly-queue/") || strings.HasPrefix(pushEvent.Ref, "refs/heads/gt-queue/") {
-		// merge queue push
-		provider, base, pr, sha, err := parseMergeQueueRef(pushEvent.Ref)
-		if err != nil {
-			return hookCommon.TransformResultModel{
-				Error: fmt.Errorf("failed to parse merge queue ref: %w", err),
-			}
-		}
-		pushEvent.IsMergeQueuePush = true
-		pushEvent.MergeQueue = &MergeQueuePushModel{
-			QueueProvider: provider,
-			PRNumber:      pr,
-			BaseBranch:    base,
-			BaseSHA:       sha,
-			SyntheticSHA:  pushEvent.After,
-		}
-	}
-
 	if strings.HasPrefix(pushEvent.Ref, "refs/heads/") {
 		// code push
 		branch := strings.TrimPrefix(pushEvent.Ref, "refs/heads/")
 
+		// merge queue push
+		var mergeQueue bitriseapi.MergeQueueModel
+		if strings.HasPrefix(pushEvent.Ref, "refs/heads/gh-readonly-queue/") || strings.HasPrefix(pushEvent.Ref, "refs/heads/gt-queue/") {
+			providerRef, base, pr, sha, err := parseMergeQueueRef(pushEvent.Ref)
+			if err != nil {
+				return hookCommon.TransformResultModel{
+					Error: fmt.Errorf("failed to parse merge queue ref: %w", err),
+				}
+			}
+
+			var provider string
+			switch providerRef {
+			case "gh-readonly-queue":
+				provider = "github"
+			case "gt-queue":
+				provider = "gitlab"
+			}
+
+			mergeQueue = bitriseapi.MergeQueueModel{
+				QueueProvider: provider,
+				PullRequestID: pr,
+				BaseBranch:    base,
+				BaseSHA:       sha,
+				SyntheticSHA:  pushEvent.After,
+			}
+		}
+
 		return hookCommon.TransformResultModel{
 			TriggerAPIParams: []bitriseapi.TriggerAPIParamsModel{
 				{
@@ -250,6 +248,7 @@ func transformPushEvent(pushEvent PushEventModel) hookCommon.TransformResultMode
 						CommitMessages:    commitMessages,
 						PushCommitPaths:   commitPaths,
 						BaseRepositoryURL: pushEvent.Repo.getRepositoryURL(),
+						MergeQueue:        mergeQueue,
 					},
 					TriggeredBy: hookCommon.GenerateTriggeredBy(ProviderID, pushEvent.Pusher.Name),
 				},

service/hook/github/github_test.go

@@ -681,7 +681,7 @@ const (
     "fork": false,
     "url": "https://api.github.com/repos/bitrise-io/birmacher-test",
     "ssh_url": "git@github.com:bitrise-io/birmacher-test.git",
-    "clone_url": "https://github.com/bitrise-io/birmacher-test.git",
+    "clone_url": "https://github.com/bitrise-io/birmacher-test.git"
   },
   "pusher": {
     "name": "github-merge-queue[bot]",
@@ -1929,6 +1929,47 @@ func Test_HookProvider_TransformRequest(t *testing.T) {
 		require.Equal(t, false, hookTransformResult.DontWaitForTriggerResponse)
 	}
 
+	t.Log("Merge Queue Push - should be handled")
+	{
+		request := http.Request{
+			Header: http.Header{
+				"X-Github-Event": {"push"},
+				"Content-Type":   {"application/json"},
+			},
+			Body: io.NopCloser(strings.NewReader(sampleMergeQueuePushData)),
+		}
+		hookTransformResult := provider.TransformRequest(&request)
+		require.NoError(t, hookTransformResult.Error)
+		require.False(t, hookTransformResult.ShouldSkip)
+		require.Equal(t, []bitriseapi.TriggerAPIParamsModel{
+			{
+				BuildParams: bitriseapi.BuildParamsModel{
+					CommitHash:     "cc76bc3a5ffd4836ca30d0eeb224967b7127ab50",
+					CommitMessage:  "Merge pull request #1 from bitrise-io/birmacher-patch-1\n\nUpdate README.md",
+					CommitMessages: []string{"Merge pull request #1 from bitrise-io/birmacher-patch-1\n\nUpdate README.md"},
+					Branch:         "gh-readonly-queue/main/pr-1-7ed40c455464eaa0c5c4a0aeaefb9ffb16bd2c64",
+					PushCommitPaths: []bitriseapi.CommitPaths{
+						{
+							Added:    []string{},
+							Removed:  []string{},
+							Modified: []string{"README.md"},
+						},
+					},
+					BaseRepositoryURL: "git@github.com:bitrise-io/birmacher-test.git",
+					MergeQueue: bitriseapi.MergeQueueModel{
+						QueueProvider: "github",
+						PullRequestID: 1,
+						BaseBranch:    "main",
+						BaseSHA:       "7ed40c455464eaa0c5c4a0aeaefb9ffb16bd2c64",
+						SyntheticSHA:  "cc76bc3a5ffd4836ca30d0eeb224967b7127ab50",
+					},
+				},
+				TriggeredBy: "webhook-github/github-merge-queue[bot]",
+			},
+		}, hookTransformResult.TriggerAPIParams)
+		require.Equal(t, false, hookTransformResult.DontWaitForTriggerResponse)
+	}
+
 	t.Log("Tag Push - should be handled")
 	{
 		request := http.Request{