fix

pkg/reconciler/events/k8sevent/events.go

@@ -0,0 +1,76 @@
+/*
+Copyright 2021 The Tekton Authors
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+	http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+package k8sevent
+
+import (
+	"fmt"
+	"regexp"
+	"testing"
+	"time"
+)
+
+// CheckEventsOrdered checks that the events received via the given chan are the same as wantEvents,
+// in the same order.
+func CheckEventsOrdered(t *testing.T, eventChan chan string, testName string, wantEvents []string) error {
+	t.Helper()
+	// Sleep 50ms to make sure events have delivered
+	time.Sleep(50 * time.Millisecond)
+	err := eventsFromChannel(eventChan, wantEvents)
+	if err != nil {
+		return fmt.Errorf("error in test %s: %v", testName, err)
+	}
+	return nil
+}
+
+// eventsFromChannel takes a chan of string, a test name, and a list of events that a test
+// expects to receive. The events must be received in the same order they appear in the
+// wantEvents list. Any extra or too few received events are considered errors.
+func eventsFromChannel(c chan string, wantEvents []string) error {
+	// We get events from a channel, so the timeout is here to avoid waiting
+	// on the channel forever if fewer than expected events are received.
+	// We only hit the timeout in case of failure of the test, so the actual value
+	// of the timeout is not so relevant, it's only used when tests are going to fail.
+	// on the channel forever if fewer than expected events are received
+	timer := time.NewTimer(10 * time.Millisecond)
+	foundEvents := []string{}
+	for ii := 0; ii < len(wantEvents)+1; ii++ {
+		// We loop over all the events that we expect. Once they are all received
+		// we exit the loop. If we never receive enough events, the timeout takes us
+		// out of the loop.
+		select {
+		case event := <-c:
+			foundEvents = append(foundEvents, event)
+			if ii > len(wantEvents)-1 {
+				return fmt.Errorf("received event \"%s\" but not more expected", event)
+			}
+			wantEvent := wantEvents[ii]
+			matching, err := regexp.MatchString(wantEvent, event)
+			if err == nil {
+				if !matching {
+					return fmt.Errorf("expected event \"%s\" but got \"%s\" instead", wantEvent, event)
+				}
+			} else {
+				return fmt.Errorf("something went wrong matching the event: %s", err)
+			}
+		case <-timer.C:
+			if len(foundEvents) != len(wantEvents) {
+				return fmt.Errorf("received %d events but %d expected. Found events: %#v", len(foundEvents), len(wantEvents), foundEvents)
+			}
+			return nil
+		}
+	}
+	return nil
+}