fix(STONEINTG-871): include an optional ITS (#1745)

Signed-off-by: nbyrne <nbyrne@redhat.com>
Co-authored-by: Kasem Alem <kalem@redhat.com>

Author: NigelByrne1

pkg/clients/integration/integration_test_scenarios.go

@@ -68,6 +68,64 @@ func (i *IntegrationController) CreateIntegrationTestScenario(itsName, applicati
 	return integrationTestScenario, nil
 }
 
+// CreateOptionalIntegrationTestScenario creates a beta1 version integrationTestScenario with optional: true label.
+// This function is identical to CreateIntegrationTestScenario except it sets the optional label to "true".
+func (i *IntegrationController) CreateOptionalIntegrationTestScenario(itsName, applicationName, namespace, gitURL, revision, pathInRepo, kind string, contexts []string) (*integrationv1beta2.IntegrationTestScenario, error) {
+	if itsName == "" {
+		itsName = "my-integration-test-" + util.GenerateRandomString(4)
+	}
+
+	params := []integrationv1beta2.ResolverParameter{
+		{
+			Name:  "url",
+			Value: gitURL,
+		},
+		{
+			Name:  "revision",
+			Value: revision,
+		},
+		{
+			Name:  "pathInRepo",
+			Value: pathInRepo,
+		},
+	}
+
+	integrationTestScenario := &integrationv1beta2.IntegrationTestScenario{
+		ObjectMeta: metav1.ObjectMeta{
+			Name:      itsName,
+			Namespace: namespace,
+			Labels:    map[string]string{"test.appstudio.openshift.io/optional": "true"}, // NEW: Sets optional to true
+		},
+		Spec: integrationv1beta2.IntegrationTestScenarioSpec{
+			Application: applicationName,
+			ResolverRef: integrationv1beta2.ResolverRef{
+				Resolver: "git",
+				Params:   params,
+			},
+			Contexts: []integrationv1beta2.TestContext{},
+		},
+	}
+
+	// Add kind parameter if provided and is "pipelineRun"
+	if strings.EqualFold(kind, "pipelineRun") {
+		integrationTestScenario.Spec.ResolverRef.ResourceKind = "pipelinerun"
+
+	}
+
+	if len(contexts) > 0 {
+		for _, testContext := range contexts {
+			integrationTestScenario.Spec.Contexts = append(integrationTestScenario.Spec.Contexts,
+				integrationv1beta2.TestContext{Name: testContext, Description: testContext})
+		}
+	}
+
+	err := i.KubeRest().Create(context.Background(), integrationTestScenario)
+	if err != nil {
+		return nil, err
+	}
+	return integrationTestScenario, nil
+}
+
 // Get return the status from the Application Custom Resource object.
 func (i *IntegrationController) GetIntegrationTestScenarios(applicationName, namespace string) (*[]integrationv1beta2.IntegrationTestScenario, error) {
 	opts := []client.ListOption{

pkg/constants/constants.go

@@ -252,6 +252,7 @@ const (
 	CheckrunConclusionSuccess = "success"
 	CheckrunConclusionFailure = "failure"
 	CheckrunStatusCompleted   = "completed"
+	CheckrunConclusionNeutral = "neutral"
 
 	DockerBuild                   BuildPipelineType = "docker-build"
 	DockerBuildOciTA              BuildPipelineType = "docker-build-oci-ta"

tests/integration-service/status-reporting-to-pullrequest.go

@@ -15,6 +15,7 @@ import (
 
 	appstudioApi "github.com/konflux-ci/application-api/api/v1alpha1"
 	integrationv1beta2 "github.com/konflux-ci/integration-service/api/v1beta2"
+	intgteststat "github.com/konflux-ci/integration-service/pkg/integrationteststatus"
 	"github.com/konflux-ci/operator-toolkit/metadata"
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
@@ -33,7 +34,7 @@ var _ = framework.IntegrationServiceSuiteDescribe("Status Reporting of Integrati
 	var snapshot *appstudioApi.Snapshot
 	var component *appstudioApi.Component
 	var pipelineRun, testPipelinerun, failedPipelineRun *tektonv1.PipelineRun
-	var integrationTestScenarioPass, integrationTestScenarioFail *integrationv1beta2.IntegrationTestScenario
+	var integrationTestScenarioPass, integrationTestScenarioFail, integrationTestScenarioOptional *integrationv1beta2.IntegrationTestScenario
 	var applicationName, componentName, componentBaseBranchName, pacBranchName, testNamespace string
 	var mergeResult *github.PullRequestMergeResult
 	var labels, annotations map[string]string
@@ -69,6 +70,8 @@ var _ = framework.IntegrationServiceSuiteDescribe("Status Reporting of Integrati
 			Expect(err).ShouldNot(HaveOccurred())
 			integrationTestScenarioFail, err = f.AsKubeAdmin.IntegrationController.CreateIntegrationTestScenario("", applicationName, testNamespace, gitURL, revision, pathInRepoFail, "", []string{})
 			Expect(err).ShouldNot(HaveOccurred())
+			integrationTestScenarioOptional, err = f.AsKubeAdmin.IntegrationController.CreateOptionalIntegrationTestScenario("", applicationName, testNamespace, gitURL, revision, pathInRepoFail, "", []string{})
+			Expect(err).ShouldNot(HaveOccurred())
 
 			Eventually(func() error {
 				pipelineRun, err = f.AsKubeAdmin.HasController.GetComponentPipelineRunWithType(componentName, applicationName, testNamespace, "build", "", "")
@@ -168,13 +171,19 @@ var _ = framework.IntegrationServiceSuiteDescribe("Status Reporting of Integrati
 				Expect(err).ToNot(HaveOccurred())
 				Expect(testPipelinerun.Labels[snapshotAnnotation]).To(ContainSubstring(snapshot.Name))
 				Expect(testPipelinerun.Labels[scenarioAnnotation]).To(ContainSubstring(integrationTestScenarioFail.Name))
+
+				testPipelinerun, err = f.AsKubeDeveloper.IntegrationController.WaitForIntegrationPipelineToGetStarted(integrationTestScenarioOptional.Name, snapshot.Name, testNamespace)
+				Expect(err).ToNot(HaveOccurred())
+				Expect(testPipelinerun.Labels[snapshotAnnotation]).To(ContainSubstring(snapshot.Name))
+				Expect(testPipelinerun.Labels[scenarioAnnotation]).To(ContainSubstring(integrationTestScenarioOptional.Name))
 			})
 		})
 
 		When("Integration PipelineRuns are created", func() {
 			It("should eventually complete successfully", func() {
 				Expect(f.AsKubeAdmin.IntegrationController.WaitForIntegrationPipelineToBeFinished(integrationTestScenarioPass, snapshot, testNamespace)).To(Succeed(), fmt.Sprintf("Error when waiting for an integration pipelinerun for snapshot %s/%s to finish", testNamespace, snapshot.GetName()))
 				Expect(f.AsKubeAdmin.IntegrationController.WaitForIntegrationPipelineToBeFinished(integrationTestScenarioFail, snapshot, testNamespace)).To(Succeed(), fmt.Sprintf("Error when waiting for an integration pipelinerun for snapshot %s/%s to finish", testNamespace, snapshot.GetName()))
+				Expect(f.AsKubeAdmin.IntegrationController.WaitForIntegrationPipelineToBeFinished(integrationTestScenarioOptional, snapshot, testNamespace)).To(Succeed(), fmt.Sprintf("Error when waiting for an integration pipelinerun for snapshot %s/%s to finish", testNamespace, snapshot.GetName()))
 			})
 		})
 
@@ -201,6 +210,29 @@ var _ = framework.IntegrationServiceSuiteDescribe("Status Reporting of Integrati
 				Expect(f.AsKubeAdmin.CommonController.Github.GetCheckRunConclusion(integrationTestScenarioFail.Name, componentRepoNameForStatusReporting, prHeadSha, prNumber)).To(Equal(constants.CheckrunConclusionFailure))
 			})
 
+			It("eventually leads to the status reported at Checks tab for the optional Integration PipelineRun", func() {
+				Expect(f.AsKubeAdmin.CommonController.Github.GetCheckRunConclusion(integrationTestScenarioOptional.Name, componentRepoNameForStatusReporting, prHeadSha, prNumber)).To(Equal(constants.CheckrunConclusionNeutral))
+			})
+
+			It("checks if the optional Integration Test Scenario status is reported in the Snapshot", func() {
+				Eventually(func() error {
+					snapshot, err = f.AsKubeAdmin.IntegrationController.GetSnapshot(snapshot.Name, "", "", testNamespace)
+					Expect(err).ShouldNot(HaveOccurred())
+
+					statusDetail, err := f.AsKubeDeveloper.IntegrationController.GetIntegrationTestStatusDetailFromSnapshot(snapshot, integrationTestScenarioOptional.Name)
+					Expect(err).ToNot(HaveOccurred())
+
+					if statusDetail.Status != intgteststat.IntegrationTestStatusTestFail {
+						return fmt.Errorf("test status doesn't have expected value %s", intgteststat.IntegrationTestStatusTestFail)
+					}
+					return nil
+				}, shortTimeout, constants.PipelineRunPollingInterval).Should(Succeed())
+			})
+
+			It("checks if the finalizer was removed from the optional Integration PipelineRun", func() {
+				Expect(f.AsKubeDeveloper.IntegrationController.WaitForFinalizerToGetRemovedFromIntegrationPipeline(integrationTestScenarioOptional, snapshot, testNamespace)).To(Succeed())
+			})
+
 			It("merging the PR, expected to succeed ", func() {
 				Eventually(func() error {
 					mergeResult, err = f.AsKubeAdmin.CommonController.Github.MergePullRequest(componentRepoNameForStatusReporting, prNumber)