feat(STONEINTG-1253): add workflow type annotation to snapshot

Add a new annotation "test.appstudio.openshift.io/integration-workflow"
to snapshots created from build pipelines. The annotation value is set
to "push" or "pull-request" based on the PipelineRun's event type.

Signed-off-by: Josh Everett <[email protected]>

Author: Josh-Everett

gitops/snapshot.go

@@ -111,6 +111,9 @@ const (
 	// BuildPipelineLastBuiltTime contains the time of the last built pipelineRun
 	BuildPipelineLastBuiltTime = "test.appstudio.openshift.io/lastbuilttime"
 
+	// IntegrationWorkflowAnnotation contains the workflow type that triggered the snapshot (push or pull-request)
+	IntegrationWorkflowAnnotation = "test.appstudio.openshift.io/integration-workflow"
+
 	// BuildPipelineRunPrefix contains the build pipeline run related labels and annotations
 	BuildPipelineRunPrefix = "build.appstudio"
 
@@ -189,6 +192,12 @@ const (
 	// PipelineAsCodeMergeRequestType is the type of merge request event which triggered the pipelinerun in build service
 	PipelineAsCodeMergeRequestType = "merge request"
 
+	// IntegrationWorkflowPushValue is the value for push workflow snapshots
+	IntegrationWorkflowPushValue = "push"
+
+	// IntegrationWorkflowPullRequestValue is the value for pull request workflow snapshots
+	IntegrationWorkflowPullRequestValue = "pull-request"
+
 	// PipelineAsCodeGitHubProviderType is the git provider type for a GitHub event which triggered the pipelinerun in build service.
 	PipelineAsCodeGitHubProviderType = "github"
 

internal/controller/buildpipeline/buildpipeline_adapter.go

@@ -570,6 +570,13 @@ func (a *Adapter) prepareSnapshotForPipelineRun(pipelineRun *tektonv1.PipelineRu
 		snapshot.Annotations[gitops.BuildPipelineRunStartTime] = strconv.FormatInt(pipelineRun.Status.StartTime.Unix(), 10)
 	}
 
+	// Set the integration workflow annotation based on the PipelineRun type
+	if tekton.IsPLRCreatedByPACPushEvent(pipelineRun) {
+		snapshot.Annotations[gitops.IntegrationWorkflowAnnotation] = gitops.IntegrationWorkflowPushValue
+	} else {
+		snapshot.Annotations[gitops.IntegrationWorkflowAnnotation] = gitops.IntegrationWorkflowPullRequestValue
+	}
+
 	return snapshot, nil
 }
 

internal/controller/buildpipeline/buildpipeline_adapter_test.go

@@ -717,6 +717,34 @@ var _ = Describe("Pipeline Adapter", Ordered, func() {
 			Expect(found).To(BeFalse())
 		})
 
+		It("ensures integration workflow annotation is set to 'pull-request' for pr events", func() {
+			// default buildPipelineRun already has event-type set to pull_request
+			snapshot, err := adapter.prepareSnapshotForPipelineRun(buildPipelineRun, hasComp, hasApp)
+			Expect(err).ToNot(HaveOccurred())
+			Expect(snapshot).ToNot(BeNil())
+
+			annotation, found := snapshot.GetAnnotations()[gitops.IntegrationWorkflowAnnotation]
+			Expect(found).To(BeTrue())
+			Expect(annotation).To(Equal(gitops.IntegrationWorkflowPullRequestValue))
+			Expect(annotation).To(Equal("pull-request"))
+		})
+
+		It("ensures integration workflow annotation is set to 'push' for push events", func() {
+			// copy buildPipelineRun and modify it to be a push event
+			pushPipelineRun := buildPipelineRun.DeepCopy()
+			pushPipelineRun.Labels["pipelinesascode.tekton.dev/event-type"] = "push"
+			delete(pushPipelineRun.Labels, "pipelinesascode.tekton.dev/pull-request")
+
+			snapshot, err := adapter.prepareSnapshotForPipelineRun(pushPipelineRun, hasComp, hasApp)
+			Expect(err).ToNot(HaveOccurred())
+			Expect(snapshot).ToNot(BeNil())
+
+			annotation, found := snapshot.GetAnnotations()[gitops.IntegrationWorkflowAnnotation]
+			Expect(found).To(BeTrue())
+			Expect(annotation).To(Equal(gitops.IntegrationWorkflowPushValue))
+			Expect(annotation).To(Equal("push"))
+		})
+
 		It("ensure snapshot will not be created in instance when chains is incomplete", func() {
 			var buf bytes.Buffer
 			log := helpers.IntegrationLogger{Logger: buflogr.NewWithBuffer(&buf)}