fix(STONEINTG-1385): ignore refs/heads prefix from source branch

* The pipeline-as-code source branch annotation can contain the
  `refs/heads` prefix in it which needs to be ignored
  when detecting merge queues and extracting the PR number

Signed-off-by: dirgim <[email protected]>

rh-pre-commit.version: 2.2.0
rh-pre-commit.check-secrets: ENABLED

Author: dirgim

gitops/snapshot.go

@@ -207,6 +207,9 @@ const (
 	// PipelineAsCodeGitHubMergeQueueBranchPrefix is the prefix added to temporary branches which are created for merge queues
 	PipelineAsCodeGitHubMergeQueueBranchPrefix = "gh-readonly-queue/"
 
+	// GitRefBranchPrefix is the git prefix denoting a reference is a branch
+	GitRefBranchPrefix = "refs/heads/"
+
 	//AppStudioTestSucceededCondition is the condition for marking if the AppStudio Tests succeeded for the Snapshot.
 	AppStudioTestSucceededCondition = "AppStudioTestSucceeded"
 
@@ -783,7 +786,7 @@ func CompareSnapshots(expectedSnapshot *applicationapiv1alpha1.Snapshot, foundSn
 
 func IsSnapshotCreatedByPACMergeQueueEvent(snapshot *applicationapiv1alpha1.Snapshot) bool {
 	if branch, found := snapshot.Annotations[PipelineAsCodeSourceBranchAnnotation]; found {
-		if strings.HasPrefix(branch, PipelineAsCodeGitHubMergeQueueBranchPrefix) {
+		if strings.HasPrefix(strings.TrimPrefix(branch, GitRefBranchPrefix), PipelineAsCodeGitHubMergeQueueBranchPrefix) {
 			return true
 		}
 	}
@@ -898,8 +901,9 @@ func ExtractPullRequestNumberFromMergeQueueSnapshot(snapshot *applicationapiv1al
 
 	// If the PR number is not found above, attempt to extract it from the source branch name of the merge queue
 	// The branch should be in the format of 'gh-readonly-queue/{original_branch_name}/pr-{pull_request_number}-{sha}'
-	if snapshot.Annotations != nil && snapshot.Annotations[PipelineAsCodeSourceBranchAnnotation] != "" {
-		branchWithoutPrefix := strings.Split(snapshot.Annotations[PipelineAsCodeSourceBranchAnnotation], "/")
+	if branch, found := snapshot.Annotations[PipelineAsCodeSourceBranchAnnotation]; found {
+		// remove the refs/heads prefix to get the actual branch name
+		branchWithoutPrefix := strings.Split(strings.TrimPrefix(branch, GitRefBranchPrefix), "/")
 		if len(branchWithoutPrefix) > 1 {
 			branchSections := strings.Split(branchWithoutPrefix[len(branchWithoutPrefix)-1], "-")
 			if len(branchSections) > 1 && branchSections[0] == "pr" && branchSections[1] != "" {

gitops/snapshot_test.go

@@ -708,6 +708,10 @@ var _ = Describe("Gitops functions for managing Snapshots", Ordered, func() {
 		pullRequestNumber = gitops.ExtractPullRequestNumberFromMergeQueueSnapshot(mergeQueueSnapshot)
 		Expect(pullRequestNumber).To(Equal("2987"))
 
+		mergeQueueSnapshot.Annotations[gitops.PipelineAsCodeSourceBranchAnnotation] = "refs/heads/gh-readonly-queue/main/pr-7-54e7d2bfec0e0570915f5770c890407c714e6139"
+		pullRequestNumber = gitops.ExtractPullRequestNumberFromMergeQueueSnapshot(mergeQueueSnapshot)
+		Expect(pullRequestNumber).To(Equal("7"))
+
 		mergeQueueSnapshot.Annotations[gitops.PipelineAsCodePullRequestAnnotation] = "214"
 		pullRequestNumber = gitops.ExtractPullRequestNumberFromMergeQueueSnapshot(mergeQueueSnapshot)
 		Expect(pullRequestNumber).To(Equal("214"))
@@ -1069,6 +1073,8 @@ var _ = Describe("Gitops functions for managing Snapshots", Ordered, func() {
 				snapshot.Labels[gitops.PipelineAsCodeEventTypeLabel] = gitops.PipelineAsCodePushType
 				snapshot.Annotations[gitops.PipelineAsCodeSourceBranchAnnotation] = "gh-readonly-queue/main/pr-2987-bda9b312bf224a6b5fb1e7ed6ae76dd9e6b1b75b"
 				Expect(gitops.IsSnapshotCreatedByPACPushEvent(snapshot)).To(BeFalse())
+				snapshot.Annotations[gitops.PipelineAsCodeSourceBranchAnnotation] = "refs/heads/gh-readonly-queue/main/pr-7-54e7d2bfec0e0570915f5770c890407c714e6139"
+				Expect(gitops.IsSnapshotCreatedByPACPushEvent(snapshot)).To(BeFalse())
 			})
 
 			It("Testing UnmarshalJSON", func() {

tekton/build_pipeline.go

@@ -106,7 +106,7 @@ func GenerateSHA(str string) string {
 // IsPLRCreatedByPACPushEvent checks if a PLR has label PipelineAsCodeEventTypeLabel and with push or Push value
 func IsPLRCreatedByPACPushEvent(plr *tektonv1.PipelineRun) bool {
 	if branch, found := plr.Annotations[consts.PipelineAsCodeSourceBranchAnnotation]; found {
-		if strings.HasPrefix(branch, consts.PipelineAsCodeGitHubMergeQueueBranchPrefix) {
+		if strings.HasPrefix(strings.TrimPrefix(branch, consts.GitRefBranchPrefix), consts.PipelineAsCodeGitHubMergeQueueBranchPrefix) {
 			return false
 		}
 	}

tekton/build_pipeline_test.go

@@ -153,6 +153,8 @@ var _ = Describe("build pipeline", func() {
 			buildPipelineRun.Labels[tektonconsts.PipelineAsCodeEventTypeLabel] = "push"
 			buildPipelineRun.Annotations[tektonconsts.PipelineAsCodeSourceBranchAnnotation] = "gh-readonly-queue/main/pr-2987-bda9b312bf224a6b5fb1e7ed6ae76dd9e6b1b75b"
 			Expect(tekton.IsPLRCreatedByPACPushEvent(buildPipelineRun)).To(BeFalse())
+			buildPipelineRun.Annotations[tektonconsts.PipelineAsCodeSourceBranchAnnotation] = "refs/heads/gh-readonly-queue/main/pr-7-54e7d2bfec0e0570915f5770c890407c714e6139"
+			Expect(tekton.IsPLRCreatedByPACPushEvent(buildPipelineRun)).To(BeFalse())
 		})
 
 		It("can get the latest build pipelinerun for given component", func() {

tekton/consts/consts.go

@@ -70,6 +70,9 @@ const (
 	// main branch in github/gitlab
 	MainBranch = "main"
 
+	// GitRefBranchPrefix is the git prefix denoting a reference is a branch
+	GitRefBranchPrefix = "refs/heads/"
+
 	// PipelineAsCodeSourceBranchAnnotation is the branch name of the the pull request is created from
 	PipelineAsCodeSourceBranchAnnotation = "pipelinesascode.tekton.dev/source-branch"