refactor: add ExpectEventsNumber param and improve test output

* Added ExpectEventsNumber field to TestOpts struct to allow for specific
  number of expected events
* Fixed range loops to use idiomatic Go syntax (range without index when unused)
* Enhanced event logging to provide more details on test failures
* Updated tests to use the new ExpectEventsNumber parameter

Signed-off-by: Chmouel Boudjnah <chmouel@redhat.com>

Author: chmouel

test/gitea_params_test.go

@@ -406,8 +406,9 @@ func TestGiteaParamsChangedFilesCEL(t *testing.T) {
 			"modified.txt":             "testdata/changed_files_modified",
 			"renamed.txt":              "testdata/changed_files_renamed",
 		},
-		CheckForStatus: "success",
-		ExpectEvents:   false,
+		CheckForStatus:     "success",
+		ExpectEvents:       false,
+		ExpectEventsNumber: 1,
 		FileChanges: []scm.FileChange{
 			{
 				FileName:   "deleted.txt",

test/pkg/gitea/test.go

@@ -31,6 +31,7 @@ import (
 )
 
 type TestOpts struct {
+	ExpectEventsNumber    int
 	TargetRepoName        string
 	StatusOnlyLatest      bool
 	OnOrg                 bool
@@ -202,7 +203,7 @@ func TestPR(t *testing.T, topts *TestOpts) (context.Context, func()) {
 	topts.SHA = scm.PushFilesToRefGit(t, scmOpts, entries)
 
 	topts.ParamsRun.Clients.Log.Infof("Creating PullRequest")
-	for i := 0; i < 5; i++ {
+	for i := range 5 {
 		if topts.PullRequest, _, err = topts.GiteaCNX.Client.CreatePullRequest(topts.Opts.Organization, repoInfo.Name, gitea.CreatePullRequestOption{
 			Title: "Test Pull Request - " + topts.TargetRefName,
 			Head:  topts.TargetRefName,
@@ -249,7 +250,14 @@ func TestPR(t *testing.T, topts *TestOpts) (context.Context, func()) {
 		}
 		assert.Assert(t, len(events.Items) != 0, "events expected in case of failure but got 0")
 	} else if !topts.SkipEventsCheck {
-		assert.Assert(t, len(events.Items) == 0, fmt.Sprintf("no events expected but got %v in %v ns, items: %+v", len(events.Items), topts.TargetNS, events.Items))
+		if len(events.Items) != topts.ExpectEventsNumber {
+			topts.ParamsRun.Clients.Log.Infof("%d events expected in case of failure but got %d", topts.ExpectEventsNumber, len(events.Items))
+			for event := range events.Items {
+				em := events.Items[event]
+				topts.ParamsRun.Clients.Log.Infof("Event: Reason: %s Type: %s ReportingInstance: %s Message: %s", em.Reason, em.Type, em.ReportingInstance, em.Message)
+			}
+			t.Fail()
+		}
 	}
 	return ctx, cleanup
 }
@@ -356,7 +364,7 @@ func NewPR(t *testing.T, topts *TestOpts) func() {
 		// so adds a sleep for that case eg. TestGiteaBadYaml
 		if len(events.Items) == 0 {
 			// loop 30 times over a 5 second period and try to get any events
-			for i := 0; i < 30; i++ {
+			for range 30 {
 				events, err = topts.ParamsRun.Clients.Kube.CoreV1().Events(topts.TargetNS).List(ctx, metav1.ListOptions{
 					LabelSelector: fmt.Sprintf("%s=%s", keys.Repository, formatting.CleanValueKubernetes(topts.TargetNS)),
 				})
@@ -369,7 +377,14 @@ func NewPR(t *testing.T, topts *TestOpts) func() {
 		}
 		assert.Assert(t, len(events.Items) != 0, "events expected in case of failure but got 0")
 	} else if !topts.SkipEventsCheck {
-		assert.Assert(t, len(events.Items) == 1, fmt.Sprintf("no events expected but got %v in %v ns, items: %+v", len(events.Items), topts.TargetNS, events.Items))
+		if len(events.Items) != topts.ExpectEventsNumber {
+			topts.ParamsRun.Clients.Log.Infof("%d events expected in case of failure but got %d", topts.ExpectEventsNumber, len(events.Items))
+			for event := range events.Items {
+				em := events.Items[event]
+				topts.ParamsRun.Clients.Log.Infof("Event: Reason: %s Type: %s ReportingInstance: %s Message: %s", em.Reason, em.Type, em.ReportingInstance, em.Message)
+			}
+			t.Fail()
+		}
 	}
 	return cleanup
 }