Switch cfanalytics mocks from hand-rolled to gomock

- mockToggle
- mockUI

Signed-off-by: Anthony Emengo <[email protected]>

Author: dgodd

src/code.cloudfoundry.org/cfdev/cfanalytics/cfanalytics.go

@@ -10,20 +10,25 @@ import (
 	analytics "gopkg.in/segmentio/analytics-go.v3"
 )
 
-const START_BEGIN = "start_begin"
-const START_END = "start_end"
-const STOP = "stop"
-const ERROR = "error"
-const UNINSTALL = "uninstall"
+const (
+	START_BEGIN = "start_begin"
+	START_END   = "start_end"
+	STOP        = "stop"
+	ERROR       = "error"
+	UNINSTALL   = "uninstall"
+)
 
 //go:generate mockgen -package mocks -destination mocks/analytics_client.go gopkg.in/segmentio/analytics-go.v3 Client
 
+//go:generate mockgen -package mocks -destination mocks/toggle.go code.cloudfoundry.org/cfdev/cfanalytics Toggle
 type Toggle interface {
 	Defined() bool
 	Get() bool
 	Set(value bool) error
 	GetProps() map[string]interface{}
 }
+
+//go:generate mockgen -package mocks -destination mocks/ui.go code.cloudfoundry.org/cfdev/cfanalytics UI
 type UI interface {
 	Ask(prompt string) (answer string)
 }

src/code.cloudfoundry.org/cfdev/cfanalytics/cfanalytics_test.go

@@ -14,119 +14,93 @@ import (
 	analytics "gopkg.in/segmentio/analytics-go.v3"
 )
 
-type MockUI struct {
-	WasCalled bool
-	Return    string
-}
-
-func (m *MockUI) Ask(prompt string) string {
-	if prompt == `
-CF Dev collects anonymous usage data to help us improve your user experience. We intend to share these anonymous usage analytics with user community by publishing quarterly reports at :
-
-https://github.com/pivotal-cf/cfdev/wiki/Telemetry
-
-Are you ok with CF Dev periodically capturing anonymized telemetry [y/N]?` {
-		m.WasCalled = true
-	}
-
-	return m.Return
-}
-
-type MockToggle struct {
-	defined   bool
-	val       bool
-	props     map[string]interface{}
-	SetCalled bool
-}
-
-func (t *MockToggle) Defined() bool                    { return t.defined }
-func (t *MockToggle) Get() bool                        { return t.val }
-func (t *MockToggle) Set(v bool) error                 { t.val = v; t.SetCalled = true; return nil }
-func (t *MockToggle) GetProps() map[string]interface{} { return t.props }
-
 var _ = Describe("Analytics", func() {
 	var (
 		mockController *gomock.Controller
 		mockClient     *mocks.MockClient
-
-		mockToggle *MockToggle
-		exitChan   chan struct{}
-		mockUI     MockUI
-		subject    *cfanalytics.Analytics
+		mockToggle     *mocks.MockToggle
+		mockUI         *mocks.MockUI
+		exitChan       chan struct{}
+		subject        *cfanalytics.Analytics
 	)
 	BeforeEach(func() {
 		mockController = gomock.NewController(GinkgoT())
 		mockClient = mocks.NewMockClient(mockController)
-
-		mockToggle = &MockToggle{}
+		mockToggle = mocks.NewMockToggle(mockController)
+		mockUI = mocks.NewMockUI(mockController)
 		exitChan = make(chan struct{}, 1)
-		mockUI = MockUI{WasCalled: false}
-		subject = cfanalytics.New(mockToggle, mockClient, "4.5.6-unit-test", exitChan, &mockUI)
+		subject = cfanalytics.New(mockToggle, mockClient, "4.5.6-unit-test", exitChan, mockUI)
 	})
 	AfterEach(func() {
 		mockController.Finish()
 	})
 
 	Describe("PromptOptIn", func() {
 		Context("When user has NOT yet answered optin prompt", func() {
-			BeforeEach(func() { mockToggle.defined = false })
+			BeforeEach(func() {
+				mockToggle.EXPECT().Defined().Return(false).AnyTimes()
+			})
 			It("prompts user", func() {
+				mockToggle.EXPECT().Set(gomock.Any()).AnyTimes()
+				mockUI.EXPECT().Ask(gomock.Any()).Do(func(prompt string) {
+					Expect(prompt).To(ContainSubstring("Are you ok with CF Dev periodically capturing anonymized telemetry [y/N]?"))
+				})
 				Expect(subject.PromptOptIn()).To(Succeed())
-				Expect(mockUI.WasCalled).To(Equal(true))
 			})
 			for _, answer := range []string{"yes", "y", "yEs"} {
 				Context("user answers "+answer, func() {
-					BeforeEach(func() { mockUI.Return = answer })
+					BeforeEach(func() { mockUI.EXPECT().Ask(gomock.Any()).Return(answer) })
 					It("saves optin", func() {
+						mockToggle.EXPECT().Set(true)
+
 						Expect(subject.PromptOptIn()).To(Succeed())
-						Expect(mockToggle.SetCalled).To(Equal(true))
-						Expect(mockToggle.val).To(Equal(true))
 					})
 				})
 			}
 			for _, answer := range []string{"no", "N", "anything", ""} {
 				Context("user answers "+answer, func() {
-					BeforeEach(func() { mockUI.Return = answer })
+					BeforeEach(func() { mockUI.EXPECT().Ask(gomock.Any()).Return(answer) })
 					It("saves optout", func() {
+						mockToggle.EXPECT().Set(false)
+
 						Expect(subject.PromptOptIn()).To(Succeed())
-						Expect(mockToggle.SetCalled).To(Equal(true))
-						Expect(mockToggle.val).To(Equal(false))
 					})
 				})
 			}
 			Context("user hits ctrl-c", func() {
 				BeforeEach(func() {
-					mockUI.Return = ""
+					mockUI.EXPECT().Ask(gomock.Any()).Return("")
 					exitChan <- struct{}{}
 				})
 				It("does not write set a value on toggle", func() {
 					Expect(subject.PromptOptIn()).To(MatchError("Exit while waiting for telemetry prompt"))
-					Expect(mockToggle.SetCalled).To(Equal(false))
 				})
 			})
 		})
 		Context("When user has answered optin prompt", func() {
-			BeforeEach(func() { mockToggle.defined = true })
+			BeforeEach(func() {
+				mockToggle.EXPECT().Defined().AnyTimes().Return(true)
+			})
 			It("does not ask again", func() {
 				Expect(subject.PromptOptIn()).To(Succeed())
-				Expect(mockUI.WasCalled).To(Equal(false))
-				Expect(mockToggle.SetCalled).To(Equal(false))
 			})
 		})
 	})
 	Describe("Event", func() {
 		Context("opt out", func() {
-			BeforeEach(func() { mockToggle.val = false })
+			BeforeEach(func() {
+				mockToggle.EXPECT().Get().AnyTimes().Return(false)
+			})
 			It("does nothing and succeeds", func() {
 				Expect(subject.Event("anevent", map[string]interface{}{"mykey": "myval"})).To(Succeed())
 			})
 		})
 		Context("opt in", func() {
 			BeforeEach(func() {
-				mockToggle.val = true
-				mockToggle.props = map[string]interface{}{
+				mockToggle.EXPECT().Get().AnyTimes().Return(true)
+				mockToggle.EXPECT().GetProps().AnyTimes().Return(map[string]interface{}{
 					"type": "cf.1.2.3.iso",
-				}
+				})
 			})
 			It("sends identity and event to segmentio", func() {
 				uuid, _ := machineid.ProtectedID("cfdev")