Skip to content

Commit 60ac355

Browse files
authored
Add testing.T arg to test-only helpers (#6574)
mutable_stat_util.go is surprisingly mixed in its purpose, though it is not documented as such in any way I can see. So, since these kinda-dubious copy-helpers are in here but are not clearly test-only, I've added a testing.T arg to make it clear and prevent their use elsewhere. More cleanup should happen in this file, but they're all quite semantically different so I'm breaking it up.
1 parent b22774a commit 60ac355

10 files changed

+328
-322
lines changed

service/history/engine/engineimpl/history_engine2_test.go

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,7 @@ func (s *engine2Suite) TestRecordDecisionTaskStartedSuccessStickyExpired() {
178178
test.AddWorkflowExecutionStartedEvent(msBuilder, we, "wType", tl, []byte("input"), 100, 200, identity)
179179
di := test.AddDecisionTaskScheduledEvent(msBuilder)
180180

181-
ms := execution.CreatePersistenceMutableState(msBuilder)
181+
ms := execution.CreatePersistenceMutableState(s.T(), msBuilder)
182182

183183
gwmsResponse := &p.GetWorkflowExecutionResponse{State: ms}
184184

@@ -252,7 +252,7 @@ func (s *engine2Suite) TestRecordDecisionTaskStartedSuccessStickyEnabled() {
252252
test.AddWorkflowExecutionStartedEvent(msBuilder, we, "wType", tl, []byte("input"), 100, 200, identity)
253253
di := test.AddDecisionTaskScheduledEvent(msBuilder)
254254

255-
ms := execution.CreatePersistenceMutableState(msBuilder)
255+
ms := execution.CreatePersistenceMutableState(s.T(), msBuilder)
256256

257257
gwmsResponse := &p.GetWorkflowExecutionResponse{State: ms}
258258

@@ -376,7 +376,7 @@ func (s *engine2Suite) TestRecordDecisionTaskStartedIfTaskAlreadyStarted() {
376376
tl := "testTaskList"
377377

378378
msBuilder := s.createExecutionStartedState(workflowExecution, tl, identity, true)
379-
ms := execution.CreatePersistenceMutableState(msBuilder)
379+
ms := execution.CreatePersistenceMutableState(s.T(), msBuilder)
380380
gwmsResponse := &p.GetWorkflowExecutionResponse{State: ms}
381381
s.mockExecutionMgr.On("GetWorkflowExecution", mock.Anything, mock.Anything).Return(gwmsResponse, nil).Once()
382382

@@ -412,7 +412,7 @@ func (s *engine2Suite) TestRecordDecisionTaskStartedIfTaskAlreadyCompleted() {
412412
msBuilder := s.createExecutionStartedState(workflowExecution, tl, identity, true)
413413
test.AddDecisionTaskCompletedEvent(msBuilder, int64(2), int64(3), nil, identity)
414414

415-
ms := execution.CreatePersistenceMutableState(msBuilder)
415+
ms := execution.CreatePersistenceMutableState(s.T(), msBuilder)
416416
gwmsResponse := &p.GetWorkflowExecutionResponse{State: ms}
417417

418418
s.mockExecutionMgr.On("GetWorkflowExecution", mock.Anything, mock.Anything).Return(gwmsResponse, nil).Once()
@@ -448,14 +448,14 @@ func (s *engine2Suite) TestRecordDecisionTaskStartedConflictOnUpdate() {
448448

449449
msBuilder := s.createExecutionStartedState(workflowExecution, tl, identity, false)
450450

451-
ms := execution.CreatePersistenceMutableState(msBuilder)
451+
ms := execution.CreatePersistenceMutableState(s.T(), msBuilder)
452452
gwmsResponse := &p.GetWorkflowExecutionResponse{State: ms}
453453

454454
s.mockExecutionMgr.On("GetWorkflowExecution", mock.Anything, mock.Anything).Return(gwmsResponse, nil).Once()
455455
s.mockHistoryV2Mgr.On("AppendHistoryNodes", mock.Anything, mock.Anything).Return(&p.AppendHistoryNodesResponse{}, nil).Once()
456456
s.mockExecutionMgr.On("UpdateWorkflowExecution", mock.Anything, mock.Anything).Return(nil, &p.ConditionFailedError{}).Once()
457457

458-
ms2 := execution.CreatePersistenceMutableState(msBuilder)
458+
ms2 := execution.CreatePersistenceMutableState(s.T(), msBuilder)
459459
gwmsResponse2 := &p.GetWorkflowExecutionResponse{State: ms2}
460460

461461
s.mockExecutionMgr.On("GetWorkflowExecution", mock.Anything, mock.Anything).Return(gwmsResponse2, nil).Once()
@@ -496,15 +496,15 @@ func (s *engine2Suite) TestRecordDecisionTaskRetrySameRequest() {
496496
requestID := "testRecordDecisionTaskRetrySameRequestID"
497497

498498
msBuilder := s.createExecutionStartedState(workflowExecution, tl, identity, false)
499-
ms := execution.CreatePersistenceMutableState(msBuilder)
499+
ms := execution.CreatePersistenceMutableState(s.T(), msBuilder)
500500
gwmsResponse := &p.GetWorkflowExecutionResponse{State: ms}
501501

502502
s.mockExecutionMgr.On("GetWorkflowExecution", mock.Anything, mock.Anything).Return(gwmsResponse, nil).Once()
503503
s.mockHistoryV2Mgr.On("AppendHistoryNodes", mock.Anything, mock.Anything).Return(&p.AppendHistoryNodesResponse{}, nil).Once()
504504
s.mockExecutionMgr.On("UpdateWorkflowExecution", mock.Anything, mock.Anything).Return(nil, &p.ConditionFailedError{}).Once()
505505

506506
startedEventID := test.AddDecisionTaskStartedEventWithRequestID(msBuilder, int64(2), requestID, tl, identity)
507-
ms2 := execution.CreatePersistenceMutableState(msBuilder)
507+
ms2 := execution.CreatePersistenceMutableState(s.T(), msBuilder)
508508
gwmsResponse2 := &p.GetWorkflowExecutionResponse{State: ms2}
509509
s.mockExecutionMgr.On("GetWorkflowExecution", mock.Anything, mock.Anything).Return(gwmsResponse2, nil).Once()
510510

@@ -541,15 +541,15 @@ func (s *engine2Suite) TestRecordDecisionTaskRetryDifferentRequest() {
541541
requestID := "testRecordDecisionTaskRetrySameRequestID"
542542

543543
msBuilder := s.createExecutionStartedState(workflowExecution, tl, identity, false)
544-
ms := execution.CreatePersistenceMutableState(msBuilder)
544+
ms := execution.CreatePersistenceMutableState(s.T(), msBuilder)
545545
gwmsResponse := &p.GetWorkflowExecutionResponse{State: ms}
546546
s.mockExecutionMgr.On("GetWorkflowExecution", mock.Anything, mock.Anything).Return(gwmsResponse, nil).Once()
547547
s.mockHistoryV2Mgr.On("AppendHistoryNodes", mock.Anything, mock.Anything).Return(&p.AppendHistoryNodesResponse{}, nil).Once()
548548
s.mockExecutionMgr.On("UpdateWorkflowExecution", mock.Anything, mock.Anything).Return(nil, &p.ConditionFailedError{}).Once()
549549

550550
// Add event.
551551
test.AddDecisionTaskStartedEventWithRequestID(msBuilder, int64(2), "some_other_req", tl, identity)
552-
ms2 := execution.CreatePersistenceMutableState(msBuilder)
552+
ms2 := execution.CreatePersistenceMutableState(s.T(), msBuilder)
553553
gwmsResponse2 := &p.GetWorkflowExecutionResponse{State: ms2}
554554
s.mockExecutionMgr.On("GetWorkflowExecution", mock.Anything, mock.Anything).Return(gwmsResponse2, nil).Once()
555555

@@ -585,7 +585,7 @@ func (s *engine2Suite) TestRecordDecisionTaskStartedMaxAttemptsExceeded() {
585585

586586
msBuilder := s.createExecutionStartedState(workflowExecution, tl, identity, false)
587587
for i := 0; i < workflow.ConditionalRetryCount; i++ {
588-
ms := execution.CreatePersistenceMutableState(msBuilder)
588+
ms := execution.CreatePersistenceMutableState(s.T(), msBuilder)
589589
gwmsResponse := &p.GetWorkflowExecutionResponse{State: ms}
590590

591591
s.mockExecutionMgr.On("GetWorkflowExecution", mock.Anything, mock.Anything).Return(gwmsResponse, nil).Once()
@@ -626,7 +626,7 @@ func (s *engine2Suite) TestRecordDecisionTaskSuccess() {
626626
identity := "testIdentity"
627627

628628
msBuilder := s.createExecutionStartedState(workflowExecution, tl, identity, false)
629-
ms := execution.CreatePersistenceMutableState(msBuilder)
629+
ms := execution.CreatePersistenceMutableState(s.T(), msBuilder)
630630
gwmsResponse := &p.GetWorkflowExecutionResponse{State: ms}
631631
s.mockExecutionMgr.On("GetWorkflowExecution", mock.Anything, mock.Anything).Return(gwmsResponse, nil).Once()
632632
s.mockHistoryV2Mgr.On("AppendHistoryNodes", mock.Anything, mock.Anything).Return(&p.AppendHistoryNodesResponse{}, nil).Once()
@@ -726,7 +726,7 @@ func (s *engine2Suite) TestRecordActivityTaskStartedSuccess() {
726726
scheduledEvent, _ := test.AddActivityTaskScheduledEvent(msBuilder, decisionCompletedEvent.ID, activityID,
727727
activityType, tl, activityInput, 100, 10, 1, 5)
728728

729-
ms1 := execution.CreatePersistenceMutableState(msBuilder)
729+
ms1 := execution.CreatePersistenceMutableState(s.T(), msBuilder)
730730
gwmsResponse1 := &p.GetWorkflowExecutionResponse{State: ms1}
731731

732732
s.mockExecutionMgr.On("GetWorkflowExecution", mock.Anything, mock.Anything).Return(gwmsResponse1, nil).Once()
@@ -771,7 +771,7 @@ func (s *engine2Suite) TestRecordActivityTaskStartedResurrected() {
771771
scheduledEvent, _ := test.AddActivityTaskScheduledEvent(msBuilder, decisionCompletedEvent.ID, "activity1_id", "activity_type1", tl, []byte("input1"), 100, 10, 1, 5)
772772

773773
// Use mutable state snapshot before start/completion of the activity (to indicate resurrected state)
774-
msSnapshot := execution.CreatePersistenceMutableState(msBuilder)
774+
msSnapshot := execution.CreatePersistenceMutableState(s.T(), msBuilder)
775775

776776
startedEvent := test.AddActivityTaskStartedEvent(msBuilder, scheduledEvent.ID, identity)
777777
test.AddActivityTaskCompletedEvent(msBuilder, scheduledEvent.ID, startedEvent.ID, nil, identity)
@@ -814,7 +814,7 @@ func (s *engine2Suite) TestRecordActivityTaskStartedStaleState() {
814814

815815
msBuilder := s.createExecutionStartedState(workflowExecution, tl, identity, true)
816816

817-
ms1 := execution.CreatePersistenceMutableState(msBuilder)
817+
ms1 := execution.CreatePersistenceMutableState(s.T(), msBuilder)
818818
gwmsResponse1 := &p.GetWorkflowExecutionResponse{State: ms1}
819819

820820
s.mockExecutionMgr.On("GetWorkflowExecution", mock.Anything, mock.Anything).Return(gwmsResponse1, nil).Times(workflow.ConditionalRetryCount)
@@ -850,7 +850,7 @@ func (s *engine2Suite) TestRecordActivityTaskStartedActivityNotPending() {
850850

851851
msBuilder := s.createExecutionStartedState(workflowExecution, tl, identity, true)
852852

853-
ms1 := execution.CreatePersistenceMutableState(msBuilder)
853+
ms1 := execution.CreatePersistenceMutableState(s.T(), msBuilder)
854854
gwmsResponse1 := &p.GetWorkflowExecutionResponse{State: ms1}
855855

856856
s.mockExecutionMgr.On("GetWorkflowExecution", mock.Anything, mock.Anything).Return(gwmsResponse1, nil).Once()
@@ -893,7 +893,7 @@ func (s *engine2Suite) TestRecordActivityTaskStartedActivityAlreadyStarted() {
893893
scheduledEvent, _ := test.AddActivityTaskScheduledEvent(msBuilder, decisionCompletedEvent.ID, activityID,
894894
activityType, tl, activityInput, 100, 10, 1, 5)
895895

896-
ms1 := execution.CreatePersistenceMutableState(msBuilder)
896+
ms1 := execution.CreatePersistenceMutableState(s.T(), msBuilder)
897897
gwmsResponse1 := &p.GetWorkflowExecutionResponse{State: ms1}
898898

899899
s.mockExecutionMgr.On("GetWorkflowExecution", mock.Anything, mock.Anything).Return(gwmsResponse1, nil).Once()
@@ -987,7 +987,7 @@ func (s *engine2Suite) TestRequestCancelWorkflowExecutionSuccess() {
987987
tl := "testTaskList"
988988

989989
msBuilder := s.createExecutionStartedState(workflowExecution, tl, identity, false)
990-
ms1 := execution.CreatePersistenceMutableState(msBuilder)
990+
ms1 := execution.CreatePersistenceMutableState(s.T(), msBuilder)
991991
gwmsResponse1 := &p.GetWorkflowExecutionResponse{State: ms1}
992992

993993
s.mockExecutionMgr.On("GetWorkflowExecution", mock.Anything, mock.Anything).Return(gwmsResponse1, nil).Once()
@@ -1023,7 +1023,7 @@ func (s *engine2Suite) TestRequestCancelWorkflowExecutionDuplicateRequestError()
10231023
tl := "testTaskList"
10241024

10251025
msBuilder := s.createExecutionStartedState(workflowExecution, tl, identity, false)
1026-
ms1 := execution.CreatePersistenceMutableState(msBuilder)
1026+
ms1 := execution.CreatePersistenceMutableState(s.T(), msBuilder)
10271027
gwmsResponse1 := &p.GetWorkflowExecutionResponse{State: ms1}
10281028

10291029
s.mockExecutionMgr.On("GetWorkflowExecution", mock.Anything, mock.Anything).Return(gwmsResponse1, nil).Once()
@@ -1059,7 +1059,7 @@ func (s *engine2Suite) TestRequestCancelWorkflowExecutionAlreadyCancelled_Succes
10591059
msBuilder.GetExecutionInfo().CloseStatus = p.WorkflowCloseStatusCanceled
10601060
msBuilder.GetExecutionInfo().CancelRequested = true
10611061
msBuilder.GetExecutionInfo().CancelRequestID = cancelRequestID
1062-
ms1 := execution.CreatePersistenceMutableState(msBuilder)
1062+
ms1 := execution.CreatePersistenceMutableState(s.T(), msBuilder)
10631063
gwmsResponse1 := &p.GetWorkflowExecutionResponse{State: ms1}
10641064

10651065
s.mockExecutionMgr.On("GetWorkflowExecution", mock.Anything, mock.Anything).Return(gwmsResponse1, nil).Once()
@@ -1093,7 +1093,7 @@ func (s *engine2Suite) TestRequestCancelWorkflowExecutionAlreadyCancelled_Fail()
10931093
msBuilder.GetExecutionInfo().State = p.WorkflowStateCompleted
10941094
msBuilder.GetExecutionInfo().CancelRequested = true
10951095
msBuilder.GetExecutionInfo().CancelRequestID = cancelRequestID
1096-
ms1 := execution.CreatePersistenceMutableState(msBuilder)
1096+
ms1 := execution.CreatePersistenceMutableState(s.T(), msBuilder)
10971097
gwmsResponse1 := &p.GetWorkflowExecutionResponse{State: ms1}
10981098

10991099
s.mockExecutionMgr.On("GetWorkflowExecution", mock.Anything, mock.Anything).Return(gwmsResponse1, nil).Once()
@@ -1125,7 +1125,7 @@ func (s *engine2Suite) TestRequestCancelWorkflowExecutionFail() {
11251125

11261126
msBuilder := s.createExecutionStartedState(workflowExecution, tl, identity, false)
11271127
msBuilder.GetExecutionInfo().State = p.WorkflowStateCompleted
1128-
ms1 := execution.CreatePersistenceMutableState(msBuilder)
1128+
ms1 := execution.CreatePersistenceMutableState(s.T(), msBuilder)
11291129
gwmsResponse1 := &p.GetWorkflowExecutionResponse{State: ms1}
11301130

11311131
s.mockExecutionMgr.On("GetWorkflowExecution", mock.Anything, mock.Anything).Return(gwmsResponse1, nil).Once()
@@ -1202,7 +1202,7 @@ func (s *engine2Suite) TestRespondDecisionTaskCompletedRecordMarkerDecision() {
12021202
},
12031203
}}
12041204

1205-
ms := execution.CreatePersistenceMutableState(msBuilder)
1205+
ms := execution.CreatePersistenceMutableState(s.T(), msBuilder)
12061206
gwmsResponse := &p.GetWorkflowExecutionResponse{State: ms}
12071207

12081208
s.mockExecutionMgr.On("GetWorkflowExecution", mock.Anything, mock.Anything).Return(gwmsResponse, nil).Once()
@@ -1729,7 +1729,7 @@ func (s *engine2Suite) TestSignalWithStartWorkflowExecution_JustSignal() {
17291729
runID,
17301730
constants.TestLocalDomainEntry,
17311731
)
1732-
ms := execution.CreatePersistenceMutableState(msBuilder)
1732+
ms := execution.CreatePersistenceMutableState(s.T(), msBuilder)
17331733
gwmsResponse := &p.GetWorkflowExecutionResponse{State: ms}
17341734
gceResponse := &p.GetCurrentExecutionResponse{RunID: runID}
17351735

@@ -1773,7 +1773,7 @@ func (s *engine2Suite) TestSignalWithStartWorkflowExecution_JustSignal_Duplicate
17731773
runID,
17741774
constants.TestLocalDomainEntry,
17751775
)
1776-
ms := execution.CreatePersistenceMutableState(msBuilder)
1776+
ms := execution.CreatePersistenceMutableState(s.T(), msBuilder)
17771777
gwmsResponse := &p.GetWorkflowExecutionResponse{State: ms}
17781778
gceResponse := &p.GetCurrentExecutionResponse{RunID: runID}
17791779

@@ -1815,7 +1815,7 @@ func (s *engine2Suite) TestSignalWithStartWorkflowExecution_JustSignal_Duplicate
18151815
runID,
18161816
constants.TestLocalDomainEntry,
18171817
)
1818-
ms := execution.CreatePersistenceMutableState(msBuilder)
1818+
ms := execution.CreatePersistenceMutableState(s.T(), msBuilder)
18191819
gwmsResponse := &p.GetWorkflowExecutionResponse{State: ms}
18201820
gceResponse := &p.GetCurrentExecutionResponse{RunID: runID}
18211821

@@ -2054,7 +2054,7 @@ func (s *engine2Suite) TestSignalWithStartWorkflowExecution_WorkflowNotRunning()
20542054
runID,
20552055
constants.TestLocalDomainEntry,
20562056
)
2057-
ms := execution.CreatePersistenceMutableState(msBuilder)
2057+
ms := execution.CreatePersistenceMutableState(s.T(), msBuilder)
20582058
ms.ExecutionInfo.State = p.WorkflowStateCompleted
20592059
gwmsResponse := &p.GetWorkflowExecutionResponse{State: ms}
20602060
gceResponse := &p.GetCurrentExecutionResponse{RunID: runID}
@@ -2106,7 +2106,7 @@ func (s *engine2Suite) TestSignalWithStartWorkflowExecution_Start_DuplicateReque
21062106
runID,
21072107
constants.TestLocalDomainEntry,
21082108
)
2109-
ms := execution.CreatePersistenceMutableState(msBuilder)
2109+
ms := execution.CreatePersistenceMutableState(s.T(), msBuilder)
21102110
ms.ExecutionInfo.State = p.WorkflowStateCompleted
21112111
gwmsResponse := &p.GetWorkflowExecutionResponse{State: ms}
21122112
gceResponse := &p.GetCurrentExecutionResponse{RunID: runID}
@@ -2164,7 +2164,7 @@ func (s *engine2Suite) TestSignalWithStartWorkflowExecution_Start_DuplicateReque
21642164
runID,
21652165
constants.TestLocalDomainEntry,
21662166
)
2167-
ms := execution.CreatePersistenceMutableState(msBuilder)
2167+
ms := execution.CreatePersistenceMutableState(s.T(), msBuilder)
21682168
ms.ExecutionInfo.State = p.WorkflowStateCompleted
21692169
gwmsResponse := &p.GetWorkflowExecutionResponse{State: ms}
21702170
gceResponse := &p.GetCurrentExecutionResponse{RunID: runID}
@@ -2213,7 +2213,7 @@ func (s *engine2Suite) TestSignalWithStartWorkflowExecution_Start_WorkflowAlread
22132213
runID,
22142214
constants.TestLocalDomainEntry,
22152215
)
2216-
ms := execution.CreatePersistenceMutableState(msBuilder)
2216+
ms := execution.CreatePersistenceMutableState(s.T(), msBuilder)
22172217
ms.ExecutionInfo.State = p.WorkflowStateCompleted
22182218
gwmsResponse := &p.GetWorkflowExecutionResponse{State: ms}
22192219
gceResponse := &p.GetCurrentExecutionResponse{RunID: runID}

service/history/engine/engineimpl/history_engine3_eventsv2_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ func (s *engine3Suite) TestRecordDecisionTaskStartedSuccessStickyEnabled() {
172172
test.AddWorkflowExecutionStartedEvent(msBuilder, we, "wType", tl, []byte("input"), 100, 200, identity)
173173
di := test.AddDecisionTaskScheduledEvent(msBuilder)
174174

175-
ms := execution.CreatePersistenceMutableState(msBuilder)
175+
ms := execution.CreatePersistenceMutableState(s.T(), msBuilder)
176176

177177
gwmsResponse := &p.GetWorkflowExecutionResponse{State: ms}
178178

@@ -326,7 +326,7 @@ func (s *engine3Suite) TestSignalWithStartWorkflowExecution_JustSignal() {
326326
runID,
327327
constants.TestLocalDomainEntry,
328328
)
329-
ms := execution.CreatePersistenceMutableState(msBuilder)
329+
ms := execution.CreatePersistenceMutableState(s.T(), msBuilder)
330330
gwmsResponse := &p.GetWorkflowExecutionResponse{State: ms}
331331
gceResponse := &p.GetCurrentExecutionResponse{RunID: runID}
332332

0 commit comments

Comments
 (0)