Use gomock for logger (#1322)

temporalio · Feb 24, 2021 · 1e7528b · 1e7528b
1 parent 0a955bd
commit 1e7528b
Show file tree

Hide file tree

Showing 5 changed files with 172 additions and 86 deletions.
diff --git a/common/log/interface.go b/common/log/interface.go
@@ -22,6 +22,8 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 // THE SOFTWARE.
 
+//go:generate mockgen -copyright_file ../../LICENSE -package $GOPACKAGE -source $GOFILE -destination interfaces_mock.go
+
 package log
 
 import (

diff --git a/common/log/interfaces_mock.go b/common/log/interfaces_mock.go
diff --git a/common/log/mockLogger.go b/common/log/mockLogger.go
diff --git a/service/worker/archiver/handler_test.go b/service/worker/archiver/handler_test.go
@@ -73,18 +73,17 @@ func (s *handlerSuite) SetupTest() {
 	s.controller = gomock.NewController(s.T())
 	handlerTestMetrics = metrics.NewMockClient(s.controller)
 	handlerTestMetrics.EXPECT().StartTimer(gomock.Any(), gomock.Any()).Return(metrics.NopStopwatch()).AnyTimes()
-	handlerTestLogger = &log.MockLogger{}
-	handlerTestLogger.On("WithTags", mock.Anything).Return(handlerTestLogger)
+	handlerTestLogger = log.NewMockLogger(s.controller)
+	handlerTestLogger.EXPECT().WithTags(gomock.Any()).Return(handlerTestLogger).AnyTimes()
 }
 
 func (s *handlerSuite) TearDownTest() {
-	handlerTestLogger.AssertExpectations(s.T())
 }
 
 func (s *handlerSuite) TestHandleHistoryRequest_UploadFails_NonRetryableError() {
 	handlerTestMetrics.EXPECT().IncCounter(metrics.ArchiverScope, metrics.ArchiverUploadFailedAllRetriesCount)
 	handlerTestMetrics.EXPECT().IncCounter(metrics.ArchiverScope, metrics.ArchiverDeleteSuccessCount)
-	handlerTestLogger.On("Error", mock.Anything, mock.Anything).Once()
+	handlerTestLogger.EXPECT().Error(gomock.Any(), gomock.Any())
 
 	env := s.NewTestWorkflowEnvironment()
 	s.registerWorkflows(env)
@@ -100,7 +99,7 @@ func (s *handlerSuite) TestHandleHistoryRequest_UploadFails_NonRetryableError()
 func (s *handlerSuite) TestHandleHistoryRequest_UploadFails_ExpireRetryTimeout() {
 	handlerTestMetrics.EXPECT().IncCounter(metrics.ArchiverScope, metrics.ArchiverUploadFailedAllRetriesCount)
 	handlerTestMetrics.EXPECT().IncCounter(metrics.ArchiverScope, metrics.ArchiverDeleteSuccessCount)
-	handlerTestLogger.On("Error", mock.Anything, mock.Anything).Once()
+	handlerTestLogger.EXPECT().Error(gomock.Any(), gomock.Any())
 
 	timeoutErr := temporal.NewTimeoutError(enumspb.TIMEOUT_TYPE_START_TO_CLOSE, nil)
 	env := s.NewTestWorkflowEnvironment()
@@ -132,7 +131,7 @@ func (s *handlerSuite) TestHandleHistoryRequest_UploadSuccess() {
 func (s *handlerSuite) TestHandleHistoryRequest_DeleteFails_NonRetryableError() {
 	handlerTestMetrics.EXPECT().IncCounter(metrics.ArchiverScope, metrics.ArchiverUploadSuccessCount)
 	handlerTestMetrics.EXPECT().IncCounter(metrics.ArchiverScope, metrics.ArchiverDeleteFailedAllRetriesCount)
-	handlerTestLogger.On("Error", mock.Anything, mock.Anything).Once()
+	handlerTestLogger.EXPECT().Error(gomock.Any(), gomock.Any())
 
 	env := s.NewTestWorkflowEnvironment()
 	s.registerWorkflows(env)
@@ -171,7 +170,7 @@ func (s *handlerSuite) TestHandleHistoryRequest_DeleteFailsThenSucceeds() {
 
 func (s *handlerSuite) TestHandleVisibilityRequest_Fail() {
 	handlerTestMetrics.EXPECT().IncCounter(metrics.ArchiverScope, metrics.ArchiverHandleVisibilityFailedAllRetiresCount)
-	handlerTestLogger.On("Error", mock.Anything, mock.Anything).Once()
+	handlerTestLogger.EXPECT().Error(gomock.Any(), gomock.Any())
 
 	env := s.NewTestWorkflowEnvironment()
 	s.registerWorkflows(env)

diff --git a/service/worker/archiver/pump_test.go b/service/worker/archiver/pump_test.go
@@ -30,7 +30,6 @@ import (
 	"time"
 
 	"github.com/golang/mock/gomock"
-	"github.com/stretchr/testify/mock"
 	"github.com/stretchr/testify/suite"
 	"go.temporal.io/sdk/testsuite"
 	"go.temporal.io/sdk/workflow"
@@ -65,11 +64,10 @@ func (s *pumpSuite) SetupTest() {
 	s.controller = gomock.NewController(s.T())
 	pumpTestMetrics = metrics.NewMockClient(s.controller)
 	pumpTestMetrics.EXPECT().StartTimer(gomock.Any(), gomock.Any()).Return(metrics.NopStopwatch())
-	pumpTestLogger = &log.MockLogger{}
+	pumpTestLogger = log.NewMockLogger(s.controller)
 }
 
 func (s *pumpSuite) TearDownTest() {
-	pumpTestLogger.AssertExpectations(s.T())
 }
 
 func (s *pumpSuite) TestPumpRun_CarryoverLargerThanLimit() {
@@ -152,7 +150,7 @@ func (s *pumpSuite) TestPumpRun_SignalsAndCarryover() {
 func (s *pumpSuite) TestPumpRun_SignalChannelClosedUnexpectedly() {
 	pumpTestMetrics.EXPECT().UpdateGauge(metrics.ArchiverPumpScope, metrics.ArchiverBacklogSizeGauge, float64(0))
 	pumpTestMetrics.EXPECT().IncCounter(metrics.ArchiverPumpScope, metrics.ArchiverPumpSignalChannelClosedCount)
-	pumpTestLogger.On("Error", mock.Anything, mock.Anything).Once()
+	pumpTestLogger.EXPECT().Error(gomock.Any(), gomock.Any())
 
 	env := s.NewTestWorkflowEnvironment()
 	s.registerWorkflows(env)