Add e2e for pass-arguments-to-gitops-comments

The feature gets test on on-comment and when using /test explicitly.

We test all different argument parsing, we had to refactor the tests to
accept golden files to use that for comparison which is a bit better
than regexp in some case.

Signed-off-by: Chmouel Boudjnah <[email protected]>

Author: chmouel

test/gitea_access_control_test.go

@@ -259,9 +259,7 @@ func TestGiteaACLCommentsAllowing(t *testing.T) {
 			tgitea.WaitForPullRequestCommentMatch(t, topts)
 			tgitea.WaitForStatus(t, topts, topts.PullRequest.Head.Sha, "", false)
 			// checking the pod log to make sure /test <prname> works
-			err = twait.RegexpMatchingInPodLog(context.Background(), topts.ParamsRun, topts.TargetNS,
-				"pipelinesascode.tekton.dev/event-type=pull_request",
-				"step-task", *regexp.MustCompile(".*MOTO"), 2)
+			err = twait.RegexpMatchingInPodLog(context.Background(), topts.ParamsRun, topts.TargetNS, "pipelinesascode.tekton.dev/event-type=pull_request", "step-task", *regexp.MustCompile(".*MOTO"), "", 2)
 			assert.NilError(t, err, "Error while checking the logs of the pods")
 		})
 	}

test/gitops_commands_test.go renamed to test/gitea_gitops_commands_test.go

@@ -1,5 +1,4 @@
 //go:build e2e
-// +build e2e
 
 package test
 
@@ -11,6 +10,7 @@ import (
 	"testing"
 	"time"
 
+	"github.com/openshift-pipelines/pipelines-as-code/pkg/apis/pipelinesascode/v1alpha1"
 	"github.com/openshift-pipelines/pipelines-as-code/pkg/opscomments"
 	"github.com/openshift-pipelines/pipelines-as-code/pkg/params/triggertype"
 	"github.com/openshift-pipelines/pipelines-as-code/test/pkg/cctx"
@@ -55,6 +55,20 @@ func TestGiteaOnCommentAnnotation(t *testing.T) {
 	ctx := context.Background()
 	topts := &tgitea.TestOpts{
 		TargetRefName: names.SimpleNameGenerator.RestrictLengthWithRandomSuffix("pac-e2e-test"),
+		RepoCRParams: &[]v1alpha1.Params{
+			{
+				Name:  "custom1",
+				Value: "foo",
+			},
+			{
+				Name:  "custom2",
+				Value: "bar",
+			},
+			{
+				Name:  "custom3",
+				Value: "moto",
+			},
+		},
 	}
 	triggerComment := "/hello-world"
 	topts.TargetNS = topts.TargetRefName
@@ -94,10 +108,19 @@ func TestGiteaOnCommentAnnotation(t *testing.T) {
 	assert.Equal(t, *repo.Status[len(repo.Status)-1].EventType, opscomments.OnCommentEventType.String(), "should have a on comment event type")
 
 	last := repo.Status[len(repo.Status)-1]
-	err = twait.RegexpMatchingInPodLog(context.Background(),
-		topts.ParamsRun,
-		topts.TargetNS,
-		fmt.Sprintf("tekton.dev/pipelineRun=%s", last.PipelineRunName), "step-task", *regexp.MustCompile(triggerComment), 2)
+	err = twait.RegexpMatchingInPodLog(context.Background(), topts.ParamsRun, topts.TargetNS, fmt.Sprintf("tekton.dev/pipelineRun=%s", last.PipelineRunName), "step-task", *regexp.MustCompile(triggerComment), "", 2)
+	assert.NilError(t, err)
+
+	tgitea.PostCommentOnPullRequest(t, topts, fmt.Sprintf(`%s revision=main custom1=thisone custom2="another one" custom3="a \"quote\""`, triggerComment))
+	waitOpts.MinNumberStatus = 4
+	repo, err = twait.UntilRepositoryUpdated(context.Background(), topts.ParamsRun.Clients, waitOpts)
+	assert.NilError(t, err)
+	assert.Equal(t, len(repo.Status), waitOpts.MinNumberStatus, fmt.Sprintf("should have only %d status", waitOpts.MinNumberStatus))
+	assert.Equal(t, *repo.Status[len(repo.Status)-1].EventType, opscomments.OnCommentEventType.String(), "should have a on comment event type")
+	// now we should have only 3 status, the last one is the on comment match with an argument redefining the revision which is a standard parameter
+
+	last = repo.Status[len(repo.Status)-1]
+	err = twait.RegexpMatchingInPodLog(context.Background(), topts.ParamsRun, topts.TargetNS, fmt.Sprintf("tekton.dev/pipelineRun=%s", last.PipelineRunName), "step-task", regexp.Regexp{}, t.Name(), 2)
 	assert.NilError(t, err)
 }
 
@@ -108,6 +131,12 @@ func TestGiteaTestPipelineRunExplicitelyWithTestComment(t *testing.T) {
 	ctx := context.Background()
 	topts := &tgitea.TestOpts{
 		TargetRefName: names.SimpleNameGenerator.RestrictLengthWithRandomSuffix("pac-e2e-test"),
+		RepoCRParams: &[]v1alpha1.Params{
+			{
+				Name:  "custom",
+				Value: "foo",
+			},
+		},
 	}
 	topts.TargetNS = topts.TargetRefName
 	topts.ParamsRun, topts.Opts, topts.GiteaCNX, err = tgitea.Setup(ctx)
@@ -124,7 +153,7 @@ func TestGiteaTestPipelineRunExplicitelyWithTestComment(t *testing.T) {
 	_, f := tgitea.TestPR(t, topts)
 	defer f()
 	targetPrName := "no-match"
-	tgitea.PostCommentOnPullRequest(t, topts, "/test "+targetPrName)
+	tgitea.PostCommentOnPullRequest(t, topts, fmt.Sprintf("/test %s custom=awesome", targetPrName))
 	tgitea.WaitForStatus(t, topts, "heads/"+topts.TargetRefName, "", false)
 	waitOpts := twait.Opts{
 		RepoName:        topts.TargetNS,
@@ -139,6 +168,10 @@ func TestGiteaTestPipelineRunExplicitelyWithTestComment(t *testing.T) {
 	assert.Equal(t, *repo.Status[0].EventType, opscomments.TestSingleCommentEventType.String(), "should have a test comment event in status")
 	assert.Assert(t, strings.HasPrefix(repo.Status[0].PipelineRunName, targetPrName+"-"),
 		"we didn't target the proper pipelinerun, we tested: %s", repo.Status[0].PipelineRunName)
+
+	last := repo.Status[len(repo.Status)-1]
+	err = twait.RegexpMatchingInPodLog(context.Background(), topts.ParamsRun, topts.TargetNS, fmt.Sprintf("tekton.dev/pipelineRun=%s", last.PipelineRunName), "step-task", *regexp.MustCompile("custom is awesome"), "", 2)
+	assert.NilError(t, err)
 }
 
 func TestGiteaRetestAll(t *testing.T) {

test/gitea_params_test.go

@@ -187,13 +187,9 @@ func TestGiteaParamsOnRepoCR(t *testing.T) {
 	assert.NilError(t, err)
 	assert.Assert(t, len(repo.Status) != 0)
 	assert.NilError(t,
-		twait.RegexpMatchingInPodLog(context.Background(),
-			topts.ParamsRun,
-			topts.TargetNS,
-			fmt.Sprintf("tekton.dev/pipelineRun=%s,tekton.dev/pipelineTask=params",
-				repo.Status[0].PipelineRunName),
-			"step-test-params-value", *regexp.MustCompile(
-				"I am the most Kawaī params\nSHHHHHHH\nFollow me on my ig #nofilter\n{{ no_match }}\nHey I show up from a payload match\n{{ secret_nothere }}"), 2))
+		twait.RegexpMatchingInPodLog(context.Background(), topts.ParamsRun, topts.TargetNS, fmt.Sprintf("tekton.dev/pipelineRun=%s,tekton.dev/pipelineTask=params",
+			repo.Status[0].PipelineRunName), "step-test-params-value", *regexp.MustCompile(
+			"I am the most Kawaī params\nSHHHHHHH\nFollow me on my ig #nofilter\n{{ no_match }}\nHey I show up from a payload match\n{{ secret_nothere }}"), "", 2))
 }
 
 // TestGiteaParamsBodyHeadersCEL Test that we can access the pull request body and headers in params
@@ -223,12 +219,8 @@ func TestGiteaParamsBodyHeadersCEL(t *testing.T) {
 	// check the output logs if the CEL body headers has expanded  properly
 	output := `Look mum I know that we are acting on a pull_request
 my email is a true beauty and like groot, I AM pac`
-	err = twait.RegexpMatchingInPodLog(context.Background(),
-		topts.ParamsRun,
-		topts.TargetNS,
-		fmt.Sprintf("tekton.dev/pipelineRun=%s,tekton.dev/pipelineTask=cel-pullrequest-params",
-			repo.Status[0].PipelineRunName),
-		"step-test-cel-params-value", *regexp.MustCompile(output), 2)
+	err = twait.RegexpMatchingInPodLog(context.Background(), topts.ParamsRun, topts.TargetNS, fmt.Sprintf("tekton.dev/pipelineRun=%s,tekton.dev/pipelineTask=cel-pullrequest-params",
+		repo.Status[0].PipelineRunName), "step-test-cel-params-value", *regexp.MustCompile(output), "", 2)
 	assert.NilError(t, err)
 
 	// Merge the pull request so we can generate a push event and wait that it is updated
@@ -266,12 +258,7 @@ my email is a true beauty and like groot, I AM pac`
 	// push matching the expanded CEL body and headers values
 	output = `Look mum I know that we are acting on a push
 my email is a true beauty and you can call me pacman`
-	err = twait.RegexpMatchingInPodLog(context.Background(),
-		topts.ParamsRun,
-		topts.TargetNS,
-		fmt.Sprintf("tekton.dev/pipelineRun=%s,tekton.dev/pipelineTask=cel-push-params",
-			sortedstatus[0].PipelineRunName),
-		"step-test-cel-params-value", *regexp.MustCompile(output), 2)
+	err = twait.RegexpMatchingInPodLog(context.Background(), topts.ParamsRun, topts.TargetNS, fmt.Sprintf("tekton.dev/pipelineRun=%s,tekton.dev/pipelineTask=cel-push-params", sortedstatus[0].PipelineRunName), "step-test-cel-params-value", *regexp.MustCompile(output), "", 2)
 	assert.NilError(t, err)
 }
 

test/github_incoming_test.go

@@ -169,10 +169,7 @@ func verifyIncomingWebhook(t *testing.T, randomedString string, entries map[stri
 	}
 	assert.Assert(t, prName == "pipelinerun-incoming")
 
-	err = wait.RegexpMatchingInPodLog(context.Background(),
-		runcnx, randomedString,
-		"pipelinesascode.tekton.dev/event-type=incoming",
-		"step-task", *regexp.MustCompile(".*It's a Bird... It's a Plane... It's Superman"), 2)
+	err = wait.RegexpMatchingInPodLog(context.Background(), runcnx, randomedString, "pipelinesascode.tekton.dev/event-type=incoming", "step-task", *regexp.MustCompile(".*It's a Bird... It's a Plane... It's Superman"), "", 2)
 	assert.NilError(t, err, "Error while checking the logs of the pods")
 }
 

test/github_pullrequest_test_comment_test.go

@@ -90,13 +90,6 @@ func TestGithubSecondOnCommentAnnotation(t *testing.T) {
 	assert.Assert(t, repo.Status[len(repo.Status)-1].Conditions[0].Status == corev1.ConditionTrue)
 	lastPrName := repo.Status[len(repo.Status)-1].PipelineRunName
 
-	err = twait.RegexpMatchingInPodLog(
-		context.Background(),
-		g.Cnx,
-		g.TargetNamespace,
-		fmt.Sprintf("tekton.dev/pipelineRun=%s", lastPrName),
-		"step-task",
-		*regexp.MustCompile(triggerComment),
-		2)
+	err = twait.RegexpMatchingInPodLog(context.Background(), g.Cnx, g.TargetNamespace, fmt.Sprintf("tekton.dev/pipelineRun=%s", lastPrName), "step-task", *regexp.MustCompile(triggerComment), "", 2)
 	assert.NilError(t, err)
 }

test/gitlab_merge_request_test.go

@@ -206,14 +206,7 @@ func TestGitlabOnComment(t *testing.T) {
 	assert.Assert(t, repo.Status[len(repo.Status)-1].Conditions[0].Status == corev1.ConditionTrue)
 	lastPrName := repo.Status[len(repo.Status)-1].PipelineRunName
 
-	err = twait.RegexpMatchingInPodLog(
-		context.Background(),
-		runcnx,
-		targetNS,
-		fmt.Sprintf("tekton.dev/pipelineRun=%s", lastPrName),
-		"step-task",
-		*regexp.MustCompile(triggerComment),
-		2)
+	err = twait.RegexpMatchingInPodLog(context.Background(), runcnx, targetNS, fmt.Sprintf("tekton.dev/pipelineRun=%s", lastPrName), "step-task", *regexp.MustCompile(triggerComment), "", 2)
 	assert.NilError(t, err)
 }
 

test/pkg/wait/logs.go

@@ -36,19 +36,31 @@ func RegexpMatchingInControllerLog(ctx context.Context, clients *params.Run, reg
 	return fmt.Errorf("could not find a match using the labelSelector: %s in container %s for regexp: %s", labelselector, containerName, reg.String())
 }
 
-func RegexpMatchingInPodLog(ctx context.Context, clients *params.Run, ns, labelselector, containerName string, reg regexp.Regexp, maxNumberOfLoop int) error {
+func RegexpMatchingInPodLog(ctx context.Context, clients *params.Run, ns, labelselector, containerName string, reg regexp.Regexp, goldenFile string, maxNumberOfLoop int) error {
 	var err error
 	output := ""
-	clients.Clients.Log.Infof("looking for regexp %s in namespace: %s for label %s and container %s", reg.String(), ns, labelselector, containerName)
+	if goldenFile != "" {
+		goldenFile = strings.ReplaceAll(fmt.Sprintf("%s.golden", goldenFile), "/", "-")
+	}
+	if reg.String() != "" {
+		clients.Clients.Log.Infof("looking for regexp %s in namespace: %s for label %s and container %s", reg.String(), ns, labelselector, containerName)
+	} else {
+		clients.Clients.Log.Infof("looking for matching content of file %s in namespace: %s for label %s and container %s", goldenFile, ns, labelselector, containerName)
+	}
+
 	for i := 0; i <= maxNumberOfLoop; i++ {
 		output, err = tlogs.GetPodLog(ctx, clients.Clients.Kube.CoreV1(), ns, labelselector, containerName, github.Int64(10))
 		if err != nil {
 			return err
 		}
-
-		if reg.MatchString(output) {
-			clients.Clients.Log.Infof("matched regexp in labelSelector/container %s:%s",
-				labelselector, containerName)
+		if goldenFile != "" {
+			if golden.String(output, goldenFile)().Success() {
+				clients.Clients.Log.Infof("matched file content %s in labelSelector/container %s:%s", goldenFile, labelselector, containerName)
+				return nil
+			}
+		} else if reg.MatchString(output) {
+			clients.Clients.Log.Infof("matched regexp %s in labelSelector/container %s:%s",
+				reg.String(), labelselector, containerName)
 			return nil
 		}
 		time.Sleep(5 * time.Second)

test/testdata/TestGiteaOnCommentAnnotation.golden

@@ -0,0 +1,6 @@
+The comment is:
+/hello-world revision=main custom1=thisone custom2="another one" custom3="a \"quote\""
+The revision is main
+The custom1 value is thisone
+The custom2 value is another one
+The custom3 value is a quote

test/testdata/pipelinerun-nomatch.yaml

@@ -14,4 +14,6 @@ spec:
           steps:
             - name: task
               image: registry.access.redhat.com/ubi9/ubi-micro
-              command: ["/bin/echo", "NO MATCH"]
+              script: |
+                echo "custom is {{ custom }}"
+                echo "NO MATCH"

test/testdata/pipelinerun-on-comment-annotation.yaml

@@ -20,3 +20,7 @@ spec:
                 cat <<EOF
                 {{ trigger_comment }}
                 EOF
+                echo "The revision is {{ revision }}"
+                echo "The custom1 value is {{ custom1 }}"
+                echo "The custom2 value is {{ custom2 }}"
+                echo "The custom3 value is {{ custom3 }}"