abstract channel from events

Author: Brian Mendoza

controller/linodeobjectstoragebucket_controller_test.go

@@ -184,9 +184,9 @@ var _ = Describe("lifecycle", Ordered, Label("bucket", "lifecycle"), func() {
 			Expect(key.StringData.AccessKeyRO).To(Equal("access-key-1"))
 			Expect(key.StringData.SecretKeyRO).To(Equal("secret-key-1"))
 
-			Expect(<-mck.Events()).To(ContainSubstring("Object storage keys assigned"))
-			Expect(<-mck.Events()).To(ContainSubstring("Object storage keys stored in secret"))
-			Expect(<-mck.Events()).To(ContainSubstring("Object storage bucket synced"))
+			Expect(mck.Events()).To(ContainSubstring("Object storage keys assigned"))
+			Expect(mck.Events()).To(ContainSubstring("Object storage keys stored in secret"))
+			Expect(mck.Events()).To(ContainSubstring("Object storage bucket synced"))
 
 			logOutput := mck.Logs()
 			Expect(logOutput).To(ContainSubstring("Reconciling apply"))
@@ -252,7 +252,7 @@ var _ = Describe("lifecycle", Ordered, Label("bucket", "lifecycle"), func() {
 					Expect(k8sClient.Get(ctx, objectKey, &obj)).To(Succeed())
 					Expect(*obj.Status.LastKeyGeneration).To(Equal(1))
 
-					Expect(<-mck.Events()).To(ContainSubstring("Object storage keys assigned"))
+					Expect(mck.Events()).To(ContainSubstring("Object storage keys assigned"))
 
 					logOutput := mck.Logs()
 					Expect(logOutput).To(ContainSubstring("Reconciling apply"))
@@ -308,9 +308,9 @@ var _ = Describe("lifecycle", Ordered, Label("bucket", "lifecycle"), func() {
 					Expect(key.StringData.AccessKeyRO).To(Equal("access-key-3"))
 					Expect(key.StringData.SecretKeyRO).To(Equal("secret-key-3"))
 
-					Expect(<-mck.Events()).To(ContainSubstring("Object storage keys retrieved"))
-					Expect(<-mck.Events()).To(ContainSubstring("Object storage keys stored in secret"))
-					Expect(<-mck.Events()).To(ContainSubstring("Object storage bucket synced"))
+					Expect(mck.Events()).To(ContainSubstring("Object storage keys retrieved"))
+					Expect(mck.Events()).To(ContainSubstring("Object storage keys stored in secret"))
+					Expect(mck.Events()).To(ContainSubstring("Object storage bucket synced"))
 
 					logOutput := mck.Logs()
 					Expect(logOutput).To(ContainSubstring("Reconciling apply"))
@@ -348,7 +348,7 @@ var _ = Describe("lifecycle", Ordered, Label("bucket", "lifecycle"), func() {
 					Expect(err).NotTo(HaveOccurred())
 					Expect(apierrors.IsNotFound(k8sClient.Get(ctx, objectKey, &obj))).To(BeTrue())
 
-					Expect(<-mck.Events()).To(ContainSubstring("Object storage keys revoked"))
+					Expect(mck.Events()).To(ContainSubstring("Object storage keys revoked"))
 
 					logOutput := mck.Logs()
 					Expect(logOutput).To(ContainSubstring("Reconciling delete"))
@@ -456,7 +456,7 @@ var _ = Describe("errors", Label("bucket", "errors"), func() {
 					bScope.Client = mck.K8sClient
 					err := reconciler.reconcileApply(ctx, &bScope)
 					Expect(err.Error()).To(ContainSubstring("api error"))
-					Expect(<-mck.Events()).To(ContainSubstring("api error"))
+					Expect(mck.Events()).To(ContainSubstring("api error"))
 					Expect(mck.Logs()).To(ContainSubstring("Failed to ensure access key secret exists"))
 				}),
 			),
@@ -485,8 +485,8 @@ var _ = Describe("errors", Label("bucket", "errors"), func() {
 					bScope.Client = mck.K8sClient
 					err := reconciler.reconcileApply(ctx, &bScope)
 					Expect(err.Error()).To(ContainSubstring("secret creation error"))
-					Expect(<-mck.Events()).To(ContainSubstring("keys retrieved"))
-					Expect(<-mck.Events()).To(ContainSubstring("secret creation error"))
+					Expect(mck.Events()).To(ContainSubstring("keys retrieved"))
+					Expect(mck.Events()).To(ContainSubstring("secret creation error"))
 					Expect(mck.Logs()).To(ContainSubstring("Failed to apply key secret"))
 				}),
 			),
@@ -504,8 +504,8 @@ var _ = Describe("errors", Label("bucket", "errors"), func() {
 					bScope.Client = mck.K8sClient
 					err := reconciler.reconcileApply(ctx, &bScope)
 					Expect(err.Error()).To(ContainSubstring("no kind is registered"))
-					Expect(<-mck.Events()).To(ContainSubstring("keys retrieved"))
-					Expect(<-mck.Events()).To(ContainSubstring("no kind is registered"))
+					Expect(mck.Events()).To(ContainSubstring("keys retrieved"))
+					Expect(mck.Events()).To(ContainSubstring("no kind is registered"))
 					Expect(mck.Logs()).To(ContainSubstring("Failed to generate key secret"))
 				}),
 			),
@@ -522,7 +522,7 @@ var _ = Describe("errors", Label("bucket", "errors"), func() {
 			bScope.Client = mck.K8sClient
 			err := reconciler.reconcileDelete(ctx, &bScope)
 			Expect(err.Error()).To(ContainSubstring("failed to remove finalizer from bucket"))
-			Expect(<-mck.Events()).To(ContainSubstring("failed to remove finalizer from bucket"))
+			Expect(mck.Events()).To(ContainSubstring("failed to remove finalizer from bucket"))
 		}),
 	))
 })

mock/mocktest/controller_suite.go

@@ -65,7 +65,8 @@ func (cs *ctlrSuite) Run(paths []path) {
 				mck.logs = cs.logs
 			})
 
-			// Flush the channel if any events were not consumed.
+			// Flush the channel if any events were not consumed
+			// i.e. Mock.Events was never called
 			for len(cs.recorder.Events) > 0 {
 				<-cs.recorder.Events
 			}

mock/mocktest/mock.go

@@ -2,6 +2,7 @@ package mocktest
 
 import (
 	"bytes"
+	"strings"
 
 	"go.uber.org/mock/gomock"
 	"k8s.io/client-go/tools/record"
@@ -14,23 +15,44 @@ type Mock struct {
 	gomock.TestReporter
 	mock.MockClients
 
-	recorder *record.FakeRecorder
-	logs     *bytes.Buffer
+	endOfPath bool
+	recorder  *record.FakeRecorder
+	events    string
+	logs      *bytes.Buffer
 }
 
-// Events returns a channel for receiving event strings for a single test path.
-func (m Mock) Events() <-chan string {
+// Events a string of all recorded events for a single test path.
+func (m *Mock) Events() string {
 	if m.recorder == nil {
-		panic("events are only available in a ControllerTestSuite")
+		panic("unexpected call to Events() outside of a ControllerTestSuite")
 	}
 
-	return m.recorder.Events
+	if !m.endOfPath {
+		panic("unexpected call to Events() prior to Result node")
+	}
+
+	if m.events != "" {
+		return m.events
+	}
+
+	var sb strings.Builder
+	for len(m.recorder.Events) > 0 {
+		sb.WriteString(<-m.recorder.Events)
+	}
+
+	m.events = sb.String()
+
+	return m.events
 }
 
 // Logs returns a string of all log output written during a single test path.
-func (m Mock) Logs() string {
+func (m *Mock) Logs() string {
 	if m.logs == nil {
-		panic("logs are only available in a ControllerTestSuite")
+		panic("unexpected call to Events() outside of a ControllerTestSuite")
+	}
+
+	if !m.endOfPath {
+		panic("unexpected call to Events() prior to Result node")
 	}
 
 	return m.logs.String()

mock/mocktest/path_run.go

@@ -19,6 +19,10 @@ func (p path) Run(ctx context.Context, mck Mock) {
 	for _, c := range p.calls {
 		evalFn(ctx, mck, fn(c))
 	}
+
+	mckPtr := &mck
+	mckPtr.endOfPath = true
+
 	evalFn(ctx, mck, fn(p.result))
 }