chore: experimental refactor

Experimental refactor of cancel-in-progress label selection. Kept as a
separate commit for now to more easily scrap, if abandoned

Author: aThorp96

pkg/pipelineascode/cancel_pipelineruns.go

@@ -27,13 +27,14 @@ var cancelMergePatch = map[string]interface{}{
 	},
 }
 
-// cancelAllInProgressBelongingToPullRequest cancels all in-progress PipelineRuns
-// that belong to a specific pull request in the given repository.
-func (p *PacRun) cancelAllInProgressBelongingToPullRequest(ctx context.Context, repo *v1alpha1.Repository) error {
-	labelSelector := getLabelSelector(map[string]string{
-		keys.URLRepository: formatting.CleanValueKubernetes(p.event.Repository),
-		keys.PullRequest:   strconv.Itoa(int(p.event.PullRequestNumber)),
-	})
+// cancelInProgressPipelineRunsForRepository cancels all in-progress PipelineRuns
+// that are selected by the given labelSelectorMap and for which the matchFunc returns true.
+func (p *PacRun) cancelInProgressPipelineRunsForRepository(ctx context.Context, repo *v1alpha1.Repository, labelSelectorMap map[string]string, matchFunc matchingCond) error {
+	labelSelectorMap[keys.URLRepository] = formatting.CleanValueKubernetes(p.event.Repository)
+
+	labelSelector := getLabelSelector(labelSelectorMap)
+	p.run.Clients.Log.Infof("cancel-in-progress: selecting pipelineRuns to cancel with labels: %v", labelSelector)
+
 	prs, err := p.run.Clients.Tekton.TektonV1().PipelineRuns(repo.Namespace).List(ctx, metav1.ListOptions{
 		LabelSelector: labelSelector,
 	})
@@ -48,20 +49,29 @@ func (p *PacRun) cancelAllInProgressBelongingToPullRequest(ctx context.Context,
 		return nil
 	}
 
-	p.cancelPipelineRuns(ctx, prs, repo, func(_ tektonv1.PipelineRun) bool {
-		return true
-	})
+	p.cancelPipelineRuns(ctx, prs, repo, matchFunc)
 
 	return nil
 }
 
-// cancelInProgressMatchingPR cancels all PipelineRuns associated with a given repository and pull request,
+// cancelAllInProgressBelongingToPullRequest cancels all in-progress PipelineRuns
+// which are associated with the event's Pull Request.
+func (p *PacRun) cancelAllInProgressBelongingToPullRequest(ctx context.Context, repo *v1alpha1.Repository) error {
+	return p.cancelInProgressPipelineRunsForRepository(
+		ctx,
+		repo,
+		map[string]string{keys.PullRequest: strconv.Itoa(int(p.event.PullRequestNumber))},
+		func(_ tektonv1.PipelineRun) bool { return true },
+	)
+}
+
+// cancelInProgressExceptMatchingPR cancels all PipelineRuns associated with a given repository and pull request,
 // except for the one that triggered the cancellation. It first checks if the cancellation is in progress
 // and if the repository has a concurrency limit. If a concurrency limit is set, it returns an error as
 // cancellation is not supported with concurrency limits. It then retrieves the original pull request name
 // from the annotations and lists all PipelineRuns with matching labels. For each PipelineRun that is not
 // already done, cancelled, or gracefully stopped, it patches the PipelineRun to cancel it.
-func (p *PacRun) cancelInProgressMatchingPR(ctx context.Context, matchPR *tektonv1.PipelineRun, repo *v1alpha1.Repository) error {
+func (p *PacRun) cancelInProgressExceptMatchingPR(ctx context.Context, matchPR *tektonv1.PipelineRun, repo *v1alpha1.Repository) error {
 	if matchPR == nil {
 		return nil
 	}
@@ -79,77 +89,53 @@ func (p *PacRun) cancelInProgressMatchingPR(ctx context.Context, matchPR *tekton
 	}
 
 	labelMap := map[string]string{
-		keys.URLRepository:  formatting.CleanValueKubernetes(p.event.Repository),
 		keys.OriginalPRName: prName,
 	}
 	if p.event.TriggerTarget == triggertype.PullRequest {
 		labelMap[keys.PullRequest] = strconv.Itoa(p.event.PullRequestNumber)
 	}
-	labelSelector := getLabelSelector(labelMap)
-	p.run.Clients.Log.Infof("cancel-in-progress: selecting pipelineRuns to cancel with labels: %v", labelSelector)
-	prs, err := p.run.Clients.Tekton.TektonV1().PipelineRuns(matchPR.GetNamespace()).List(ctx, metav1.ListOptions{
-		LabelSelector: labelSelector,
-	})
-	if err != nil {
-		return fmt.Errorf("failed to list pipelineRuns : %w", err)
-	}
-
-	p.cancelPipelineRuns(ctx, prs, repo, func(pr tektonv1.PipelineRun) bool {
-		// skip our own for cancellation
-		if sourceBranch, ok := pr.GetAnnotations()[keys.SourceBranch]; ok {
-			// NOTE(chmouel): Every PR has their own branch and so is every push to different branch
-			// it means we only cancel pipelinerun of the same name that runs to
-			// the unique branch. Note: HeadBranch is the branch from where the PR
-			// comes from in git jargon.
-			if sourceBranch != p.event.HeadBranch {
-				p.logger.Infof("cancel-in-progress: skipping pipelinerun %v/%v as it is not from the same branch, annotation source-branch: %s event headbranch: %s", pr.GetNamespace(), pr.GetName(), sourceBranch, p.event.HeadBranch)
-				return false
+	return p.cancelInProgressPipelineRunsForRepository(
+		ctx,
+		repo,
+		labelMap,
+		func(pr tektonv1.PipelineRun) bool {
+			// skip our own for cancellation
+			if sourceBranch, ok := pr.GetAnnotations()[keys.SourceBranch]; ok {
+				// NOTE(chmouel): Every PR has their own branch and so is every push to different branch
+				// it means we only cancel pipelinerun of the same name that runs to
+				// the unique branch. Note: HeadBranch is the branch from where the PR
+				// comes from in git jargon.
+				if sourceBranch != p.event.HeadBranch {
+					p.logger.Infof("cancel-in-progress: skipping pipelinerun %v/%v as it is not from the same branch, annotation source-branch: %s event headbranch: %s", pr.GetNamespace(), pr.GetName(), sourceBranch, p.event.HeadBranch)
+					return false
+				}
 			}
-		}
 
-		return pr.GetName() != matchPR.GetName()
-	})
-	return nil
+			return pr.GetName() != matchPR.GetName()
+		})
 }
 
 // cancelPipelineRunsOpsComment cancels all PipelineRuns associated with a given repository and pull request.
 // when the user issue a cancel comment.
 func (p *PacRun) cancelPipelineRunsOpsComment(ctx context.Context, repo *v1alpha1.Repository) error {
-	labelSelector := getLabelSelector(map[string]string{
-		keys.URLRepository: formatting.CleanValueKubernetes(p.event.Repository),
-		keys.SHA:           formatting.CleanValueKubernetes(p.event.SHA),
-	})
+	labelMap := map[string]string{
+		keys.SHA: formatting.CleanValueKubernetes(p.event.SHA),
+	}
 
 	if p.event.TriggerTarget == triggertype.PullRequest {
-		labelSelector = getLabelSelector(map[string]string{
+		labelMap = map[string]string{
 			keys.PullRequest: strconv.Itoa(p.event.PullRequestNumber),
-		})
-	}
-
-	prs, err := p.run.Clients.Tekton.TektonV1().PipelineRuns(repo.Namespace).List(ctx, metav1.ListOptions{
-		LabelSelector: labelSelector,
-	})
-	if err != nil {
-		return fmt.Errorf("failed to list pipelineRuns : %w", err)
-	}
-
-	if len(prs.Items) == 0 {
-		msg := fmt.Sprintf("no pipelinerun found for repository: %v , sha: %v and pulRequest %v",
-			p.event.Repository, p.event.SHA, p.event.PullRequestNumber)
-		p.eventEmitter.EmitMessage(repo, zap.InfoLevel, "RepositoryPipelineRun", msg)
-		return nil
+		}
 	}
 
-	p.cancelPipelineRuns(ctx, prs, repo, func(pr tektonv1.PipelineRun) bool {
+	return p.cancelInProgressPipelineRunsForRepository(ctx, repo, labelMap, func(pr tektonv1.PipelineRun) bool {
 		if p.event.TargetCancelPipelineRun != "" {
 			if prName, ok := pr.GetAnnotations()[keys.OriginalPRName]; !ok || prName != p.event.TargetCancelPipelineRun {
 				return false
 			}
 		}
 		return true
 	})
-
-	return nil
 }
 
 func (p *PacRun) cancelPipelineRuns(ctx context.Context, prs *tektonv1.PipelineRunList, repo *v1alpha1.Repository, condition matchingCond) {

pkg/pipelineascode/cancel_pipelineruns_test.go

@@ -789,7 +789,7 @@ func TestCancelInProgressMatchingPR(t *testing.T) {
 			if len(tt.pipelineRuns) > 0 {
 				firstPr = tt.pipelineRuns[0]
 			}
-			err := pac.cancelInProgressMatchingPR(ctx, firstPr, tt.repo)
+			err := pac.cancelInProgressExceptMatchingPR(ctx, firstPr, tt.repo)
 			if tt.wantErrString != "" {
 				assert.ErrorContains(t, err, tt.wantErrString)
 				return

pkg/pipelineascode/pipelineascode.go

@@ -124,7 +124,7 @@ func (p *PacRun) Run(ctx context.Context) error {
 				}
 			}
 			p.manager.AddPipelineRun(pr)
-			if err := p.cancelInProgressMatchingPR(ctx, pr, repo); err != nil {
+			if err := p.cancelInProgressExceptMatchingPR(ctx, pr, repo); err != nil {
 				p.eventEmitter.EmitMessage(repo, zap.ErrorLevel, "RepositoryPipelineRun", fmt.Sprintf("error cancelling in progress pipelineRuns: %s", err))
 			}
 		}(match, i)