KaneAI - World’s First E2E Software Testing Agent.Book a Demo Join TestMu Conference

Automation Advisor
Mock
gomock
prepareDoAndReturnCall

How to use prepareDoAndReturnCall method of gomock Package

Best Mock code snippet using gomock.prepareDoAndReturnCall

call_test.go

Source:call_test.go

...76	}77	c.Do(doFunc)78	return c79}80func prepareDoAndReturnCall(doFunc, callFunc interface{}) *Call {81	tr := &mockTestReporter{}82	c := &Call{83		t:          tr,84		methodType: reflect.TypeOf(callFunc),85	}86	c.DoAndReturn(doFunc)87	return c88}89type testCase struct {90	description string91	doFunc      interface{}92	callFunc    interface{}93	args        []interface{}94	expectPanic bool95}96var testCases []testCase = []testCase{97	{98		description: "argument to Do is not a function",99		doFunc:      "meow",100		callFunc:    func(x int, y int) {},101		args:        []interface{}{0, 1},102		expectPanic: true,103	}, {104		description: "argument to Do is not a function",105		doFunc:      "meow",106		callFunc: func(x int, y int) bool {107			return true108		},109		args:        []interface{}{0, 1},110		expectPanic: true,111	}, {112		description: "number of args for Do func don't match Call func",113		doFunc:      func(x int) {},114		callFunc:    func(x int, y int) {},115		args:        []interface{}{0, 1},116		expectPanic: false,117	}, {118		description: "number of args for Do func don't match Call func",119		doFunc: func(x int) bool {120			return true121		},122		callFunc: func(x int, y int) bool {123			return true124		},125		args:        []interface{}{0, 1},126		expectPanic: false,127	}, {128		description: "arg type for Do func incompatible with Call func",129		doFunc:      func(x int) {},130		callFunc:    func(x string) {},131		args:        []interface{}{"meow"},132		expectPanic: true,133	}, {134		description: "arg type for Do func incompatible with Call func",135		doFunc: func(x int) bool {136			return true137		},138		callFunc: func(x string) bool {139			return true140		},141		args:        []interface{}{"meow"},142		expectPanic: true,143	}, {144		description: "Do func(int) Call func(int)",145		doFunc:      func(x int) {},146		callFunc:    func(x int) {},147		args:        []interface{}{0},148	}, {149		description: "Do func(int) Call func(interface{})",150		doFunc:      func(x int) {},151		callFunc:    func(x interface{}) {},152		args:        []interface{}{0},153	}, {154		description: "Do func(int) bool Call func(int) bool",155		doFunc: func(x int) bool {156			return true157		},158		callFunc: func(x int) bool {159			return true160		},161		args: []interface{}{0},162	}, {163		description: "Do func(int) bool Call func(interface{}) bool",164		doFunc: func(x int) bool {165			return true166		},167		callFunc: func(x interface{}) bool {168			return true169		},170		args: []interface{}{0},171	}, {172		description: "Do func(string) Call func([]byte)",173		doFunc:      func(x string) {},174		callFunc:    func(x []byte) {},175		args:        []interface{}{[]byte("meow")},176		expectPanic: true,177	}, {178		description: "Do func(string) bool Call func([]byte) bool",179		doFunc: func(x string) bool {180			return true181		},182		callFunc: func(x []byte) bool {183			return true184		},185		args:        []interface{}{[]byte("meow")},186		expectPanic: true,187	}, {188		description: "Do func(map[int]string) Call func(map[interface{}]int)",189		doFunc:      func(x map[int]string) {},190		callFunc:    func(x map[interface{}]int) {},191		args:        []interface{}{map[interface{}]int{"meow": 0}},192		expectPanic: true,193	}, {194		description: "Do func(map[int]string) Call func(map[interface{}]interface{})",195		doFunc:      func(x map[int]string) {},196		callFunc:    func(x map[interface{}]interface{}) {},197		args:        []interface{}{map[interface{}]interface{}{"meow": "meow"}},198		expectPanic: true,199	}, {200		description: "Do func(map[int]string) bool Call func(map[interface{}]int) bool",201		doFunc: func(x map[int]string) bool {202			return true203		},204		callFunc: func(x map[interface{}]int) bool {205			return true206		},207		args:        []interface{}{map[interface{}]int{"meow": 0}},208		expectPanic: true,209	}, {210		description: "Do func(map[int]string) bool Call func(map[interface{}]interface{}) bool",211		doFunc: func(x map[int]string) bool {212			return true213		},214		callFunc: func(x map[interface{}]interface{}) bool {215			return true216		},217		args:        []interface{}{map[interface{}]interface{}{"meow": "meow"}},218		expectPanic: true,219	}, {220		description: "Do func([]string) Call func([]interface{})",221		doFunc:      func(x []string) {},222		callFunc:    func(x []interface{}) {},223		args:        []interface{}{[]interface{}{0}},224		expectPanic: true,225	}, {226		description: "Do func([]string) Call func([]int)",227		doFunc:      func(x []string) {},228		callFunc:    func(x []int) {},229		args:        []interface{}{[]int{0, 1}},230		expectPanic: true,231	}, {232		description: "Do func([]int) Call func([]int)",233		doFunc:      func(x []int) {},234		callFunc:    func(x []int) {},235		args:        []interface{}{[]int{0, 1}},236	}, {237		description: "Do func([]int) Call func([]interface{})",238		doFunc:      func(x []int) {},239		callFunc:    func(x []interface{}) {},240		args:        []interface{}{[]interface{}{0}},241		expectPanic: true,242	}, {243		description: "Do func([]int) Call func(...interface{})",244		doFunc:      func(x []int) {},245		callFunc:    func(x ...interface{}) {},246		args:        []interface{}{0, 1},247		expectPanic: true,248	}, {249		description: "Do func([]int) Call func(...int)",250		doFunc:      func(x []int) {},251		callFunc:    func(x ...int) {},252		args:        []interface{}{0, 1},253		expectPanic: true,254	}, {255		description: "Do func([]string) bool Call func([]interface{}) bool",256		doFunc: func(x []string) bool {257			return true258		},259		callFunc: func(x []interface{}) bool {260			return true261		},262		args:        []interface{}{[]interface{}{0}},263		expectPanic: true,264	}, {265		description: "Do func([]string) bool Call func([]int) bool",266		doFunc: func(x []string) bool {267			return true268		},269		callFunc: func(x []int) bool {270			return true271		},272		args:        []interface{}{[]int{0, 1}},273		expectPanic: true,274	}, {275		description: "Do func([]int) bool Call func([]int) bool",276		doFunc: func(x []int) bool {277			return true278		},279		callFunc: func(x []int) bool {280			return true281		},282		args: []interface{}{[]int{0, 1}},283	}, {284		description: "Do func([]int) bool Call func([]interface{}) bool",285		doFunc: func(x []int) bool {286			return true287		},288		callFunc: func(x []interface{}) bool {289			return true290		},291		args:        []interface{}{[]interface{}{0}},292		expectPanic: true,293	}, {294		description: "Do func([]int) bool Call func(...interface{}) bool",295		doFunc: func(x []int) bool {296			return true297		},298		callFunc: func(x ...interface{}) bool {299			return true300		},301		args:        []interface{}{0, 1},302		expectPanic: true,303	}, {304		description: "Do func([]int) bool Call func(...int) bool",305		doFunc: func(x []int) bool {306			return true307		},308		callFunc: func(x ...int) bool {309			return true310		},311		args:        []interface{}{0, 1},312		expectPanic: true,313	}, {314		description: "Do func(...int) Call func([]int)",315		doFunc:      func(x ...int) {},316		callFunc:    func(x []int) {},317		args:        []interface{}{[]int{0, 1}},318		expectPanic: true,319	}, {320		description: "Do func(...int) Call func([]interface{})",321		doFunc:      func(x ...int) {},322		callFunc:    func(x []interface{}) {},323		args:        []interface{}{[]interface{}{0, 1}},324		expectPanic: true,325	}, {326		description: "Do func(...int) Call func(...interface{})",327		doFunc:      func(x ...int) {},328		callFunc:    func(x ...interface{}) {},329		args:        []interface{}{0, 1},330	}, {331		description: "Do func(...int) bool Call func(...int) bool",332		doFunc: func(x ...int) bool {333			return true334		},335		callFunc: func(x ...int) bool {336			return true337		},338		args: []interface{}{0, 1},339	}, {340		description: "Do func(...int) bool Call func([]int) bool",341		doFunc: func(x ...int) bool {342			return true343		},344		callFunc: func(x []int) bool {345			return true346		},347		args:        []interface{}{[]int{0, 1}},348		expectPanic: true,349	}, {350		description: "Do func(...int) bool Call func([]interface{}) bool",351		doFunc: func(x ...int) bool {352			return true353		},354		callFunc: func(x []interface{}) bool {355			return true356		},357		args:        []interface{}{[]interface{}{0, 1}},358		expectPanic: true,359	}, {360		description: "Do func(...int) bool Call func(...interface{}) bool",361		doFunc: func(x ...int) bool {362			return true363		},364		callFunc: func(x ...interface{}) bool {365			return true366		},367		args: []interface{}{0, 1},368	}, {369		description: "Do func(...int) Call func(...int)",370		doFunc:      func(x ...int) {},371		callFunc:    func(x ...int) {},372		args:        []interface{}{0, 1},373	}, {374		description: "Do func(foo); foo implements interface X Call func(interface X)",375		doFunc:      func(x foo) {},376		callFunc:    func(x fmt.Stringer) {},377		args:        []interface{}{foo{}},378	}, {379		description: "Do func(b); b does not implement interface X Call func(interface X)",380		doFunc:      func(x b) {},381		callFunc:    func(x fmt.Stringer) {},382		args:        []interface{}{foo{}},383		expectPanic: true,384	}, {385		description: "Do func(b) Call func(a); a and b are not aliases",386		doFunc:      func(x b) {},387		callFunc:    func(x a) {},388		args:        []interface{}{a{}},389		expectPanic: true,390	}, {391		description: "Do func(foo) bool; foo implements interface X Call func(interface X) bool",392		doFunc: func(x foo) bool {393			return true394		},395		callFunc: func(x fmt.Stringer) bool {396			return true397		},398		args: []interface{}{foo{}},399	}, {400		description: "Do func(b) bool; b does not implement interface X Call func(interface X) bool",401		doFunc: func(x b) bool {402			return true403		},404		callFunc: func(x fmt.Stringer) bool {405			return true406		},407		args:        []interface{}{foo{}},408		expectPanic: true,409	}, {410		description: "Do func(b) bool Call func(a) bool; a and b are not aliases",411		doFunc: func(x b) bool {412			return true413		},414		callFunc: func(x a) bool {415			return true416		},417		args:        []interface{}{a{}},418		expectPanic: true,419	}, {420		description: "Do func(bool) b Call func(bool) a; a and b are not aliases",421		doFunc: func(x bool) b {422			return b{}423		},424		callFunc: func(x bool) a {425			return a{}426		},427		args: []interface{}{true},428	},429}430func TestCall_Do(t *testing.T) {431	for _, tc := range testCases {432		t.Run(tc.description, func(t *testing.T) {433			c := prepareDoCall(tc.doFunc, tc.callFunc)434			if len(c.actions) != 1 {435				t.Errorf("expected %d actions but got %d", 1, len(c.actions))436			}437			action := c.actions[0]438			if tc.expectPanic {439				defer func() {440					if r := recover(); r == nil {441						t.Error("expected Do to panic")442					}443				}()444			}445			action(tc.args)446		})447	}448}449func TestCall_Do_NumArgValidation(t *testing.T) {450	tests := []struct {451		name       string452		methodType reflect.Type453		doFn       interface{}454		args       []interface{}455		wantErr    bool456	}{457		{458			name:       "too few",459			methodType: reflect.TypeOf(func(one, two string) {}),460			doFn:       func(one string) {},461			args:       []interface{}{"too", "few"},462			wantErr:    true,463		},464		{465			name:       "too many",466			methodType: reflect.TypeOf(func(one, two string) {}),467			doFn:       func(one, two, three string) {},468			args:       []interface{}{"too", "few"},469			wantErr:    true,470		},471		{472			name:       "just right",473			methodType: reflect.TypeOf(func(one, two string) {}),474			doFn:       func(one string, two string) {},475			args:       []interface{}{"just", "right"},476			wantErr:    false,477		},478	}479	for _, tt := range tests {480		t.Run(tt.name, func(t *testing.T) {481			tr := &mockTestReporter{}482			call := &Call{483				t:          tr,484				methodType: tt.methodType,485			}486			call.Do(tt.doFn)487			call.actions[0](tt.args)488			if tt.wantErr && tr.fatalCalls != 1 {489				t.Fatalf("expected call to fail")490			}491			if !tt.wantErr && tr.fatalCalls != 0 {492				t.Fatalf("expected call to pass")493			}494		})495	}496}497func TestCall_DoAndReturn_NumArgValidation(t *testing.T) {498	tests := []struct {499		name       string500		methodType reflect.Type501		doFn       interface{}502		args       []interface{}503		wantErr    bool504	}{505		{506			name:       "too few",507			methodType: reflect.TypeOf(func(one, two string) string { return "" }),508			doFn:       func(one string) {},509			args:       []interface{}{"too", "few"},510			wantErr:    true,511		},512		{513			name:       "too many",514			methodType: reflect.TypeOf(func(one, two string) string { return "" }),515			doFn:       func(one, two, three string) string { return "" },516			args:       []interface{}{"too", "few"},517			wantErr:    true,518		},519		{520			name:       "just right",521			methodType: reflect.TypeOf(func(one, two string) string { return "" }),522			doFn:       func(one string, two string) string { return "" },523			args:       []interface{}{"just", "right"},524			wantErr:    false,525		},526	}527	for _, tt := range tests {528		t.Run(tt.name, func(t *testing.T) {529			tr := &mockTestReporter{}530			call := &Call{531				t:          tr,532				methodType: tt.methodType,533			}534			call.DoAndReturn(tt.doFn)535			call.actions[0](tt.args)536			if tt.wantErr && tr.fatalCalls != 1 {537				t.Fatalf("expected call to fail")538			}539			if !tt.wantErr && tr.fatalCalls != 0 {540				t.Fatalf("expected call to pass")541			}542		})543	}544}545func TestCall_DoAndReturn(t *testing.T) {546	for _, tc := range testCases {547		t.Run(tc.description, func(t *testing.T) {548			c := prepareDoAndReturnCall(tc.doFunc, tc.callFunc)549			if len(c.actions) != 1 {550				t.Errorf("expected %d actions but got %d", 1, len(c.actions))551			}552			action := c.actions[0]553			if tc.expectPanic {554				defer func() {555					if r := recover(); r == nil {556						t.Error("expected DoAndReturn to panic")557					}558				}()559			}560			action(tc.args)561		})562	}...

prepareDoAndReturnCall

Using AI Code Generation

1func (m *MockClient) PrepareDoAndReturnCall() *gomock.Call {2    m.ctrl.T.Helper()3    return m.ctrl.RecordCallWithMethodType(m, "PrepareDoAndReturn", reflect.TypeOf((*MockClient)(nil).PrepareDoAndReturn))4}5func (m *MockClient) PrepareDoAndReturnCall() *gomock.Call {6    m.ctrl.T.Helper()7    return m.ctrl.RecordCallWithMethodType(m, "PrepareDoAndReturn", reflect.TypeOf((*MockClient)(nil).PrepareDoAndReturn))8}

prepareDoAndReturnCall

Using AI Code Generation

1func (m *MockClient) PrepareDoAndReturnCall() *gomock.Call {2    m.ctrl.T.Helper()3    return m.ctrl.RecordCallWithMethodType(m, "PrepareDoAndReturn", reflect.TypeOf((*MockClient)(nil).PrepareDoAndReturn))4}5func (m *MockClient) PrepareDoAndReturn() {6    m.ctrl.T.Helper()7    m.ctrl.Call(m, "PrepareDoAndReturn")8}9func (m *MockClient) PrepareDoAndReturn() {10    m.ctrl.T.Helper()11    m.ctrl.Call(m, "PrepareDoAndReturn")12}13func (m *MockClient) PrepareDoAndReturn() {14    m.ctrl.T.Helper()15    m.ctrl.Call(m, "PrepareDoAndReturn")16}17func (m *MockClient) PrepareDoAndReturn() {18    m.ctrl.T.Helper()19    m.ctrl.Call(m, "PrepareDoAndReturn")20}21func (m *MockClient) PrepareDoAndReturn() {22    m.ctrl.T.Helper()23    m.ctrl.Call(m, "PrepareDoAndReturn")24}25func (m *MockClient) PrepareDoAndReturn() {26    m.ctrl.T.Helper()27    m.ctrl.Call(m, "PrepareDoAndReturn")28}29func (m *MockClient) PrepareDoAndReturn() {30    m.ctrl.T.Helper()31    m.ctrl.Call(m, "PrepareDoAndReturn")32}33func (m *MockClient) PrepareDoAndReturn() {34    m.ctrl.T.Helper()35    m.ctrl.Call(m, "PrepareDoAndReturn")36}

prepareDoAndReturnCall

Using AI Code Generation

1func (m *MockMyService) PrepareDoAndReturnCall() *gomock.Call {2	m.ctrl.T.Helper()3	return m.ctrl.RecordCallWithMethodType(m, "PrepareDoAndReturn", reflect.TypeOf((*MockMyService)(nil).PrepareDoAndReturn))4}5func (m *MockMyService) PrepareDoAndReturn() {6	m.ctrl.T.Helper()7	m.ctrl.Call(m, "PrepareDoAndReturn")8}9func (m *MockMyService) PrepareDoAndReturn() {10	m.ctrl.T.Helper()11	m.ctrl.Call(m, "PrepareDoAndReturn")12}13func (m *MockMyService) PrepareDoAndReturn() {14	m.ctrl.T.Helper()15	m.ctrl.Call(m, "PrepareDoAndReturn")16}17func (m *MockMyService) PrepareDoAndReturn() {18	m.ctrl.T.Helper()19	m.ctrl.Call(m, "PrepareDoAndReturn")20}21func (m *MockMyService) PrepareDoAndReturn() {22	m.ctrl.T.Helper()23	m.ctrl.Call(m, "PrepareDoAndReturn")24}25func (m *MockMyService) PrepareDoAndReturn() {26	m.ctrl.T.Helper()27	m.ctrl.Call(m, "PrepareDoAndReturn")28}29func (m *MockMyService) PrepareDoAndReturn() {30	m.ctrl.T.Helper()31	m.ctrl.Call(m, "PrepareDoAndReturn")32}33func (m *MockMyService) PrepareDoAndReturn() {34	m.ctrl.T.Helper()35	m.ctrl.Call(m, "PrepareDoAndReturn")36}

prepareDoAndReturnCall

Using AI Code Generation

1import (2func TestPrepareDoAndReturnCall(t *testing.T) {3	ctrl := gomock.NewController(t)4	defer ctrl.Finish()5	mock := NewMockInterface(ctrl)6	mock.EXPECT().DoSomething().DoAndReturn(func() string {7	})8	assert.Equal(t, "Hello", mock.DoSomething())9}10import (11func TestPrepareDoAndReturnCall(t *testing.T) {12	ctrl := gomock.NewController(t)13	defer ctrl.Finish()14	mock := NewMockInterface(ctrl)15	mock.EXPECT().DoSomething().DoAndReturn(func() string {16	})17	assert.Equal(t, "Hello", mock.DoSomething())18}19import "fmt"20type Foo struct {21}22func NewFoo(name string) *Foo {23    return &Foo{name}24}25func main() {26    foo := NewFoo("bar")27    fmt.Println(foo.name)28}29import (30func TestNewFoo(t *testing.T) {31    ctrl := gomock.NewController(t)32    defer ctrl.Finish()33    mock := NewMockFoo(ctrl)34    mock.EXPECT().NewFoo("bar").DoAndReturn(func() *Foo {35        return &Foo{"bar"}36    })37    foo := NewFoo("bar")38    assert.Equal(t, "bar", foo.name)39}40cannot use mock (type *MockFoo) as type *Foo in argument to NewFoo41import "fmt"42type Foo struct {

prepareDoAndReturnCall

Using AI Code Generation

1func TestDoAndReturn(t *testing.T) {2    mockCtrl := gomock.NewController(t)3    defer mockCtrl.Finish()4    mock := NewMockFoo(mockCtrl)5    mock.EXPECT().DoSomething().DoAndReturn(func() {6        fmt.Println("Do something")7    })8    mock.DoSomething()9}10func (m *MockFoo) DoSomething() {11    m.ctrl.T.Helper()12    m.ctrl.Call(m, "DoSomething")13}14func (mr *_MockFooRecorder) DoSomething() *gomock.Call {15    return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "DoSomething", reflect.TypeOf((*MockFoo)(nil).DoSomething))16}17func (m *MockFoo) DoSomething() {18    m.ctrl.T.Helper()19    m.ctrl.Call(m, "DoSomething")20}21func (mr *_MockFooRecorder) DoSomething() *gomock.Call {22    return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "DoSomething", reflect.TypeOf((*MockFoo)(nil).DoSomething))23}24func (m *MockFoo) DoSomething() {25    m.ctrl.T.Helper()26    m.ctrl.Call(m, "DoSomething")27}28func (mr *_MockFooRecorder) DoSomething() *gomock.Call {29    return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "DoSomething", reflect.TypeOf((*MockFoo)(nil).DoSomething))30}31func (m *MockFoo) DoSomething() {32    m.ctrl.T.Helper()33    m.ctrl.Call(m, "DoSomething")34}

prepareDoAndReturnCall

Using AI Code Generation

1func (m *MockClient) PrepareDoAndReturnCall() *gomock.Call {2	return m.ctrl.RecordCall(m, "DoAndReturn")3}4func (m *MockClient) DoAndReturn() {5	m.ctrl.Call(m, "DoAndReturn")6}7func (m *MockClient) DoAndReturn() {8	m.ctrl.Call(m, "DoAndReturn")9}10func (m *MockClient) DoAndReturn() {11	m.ctrl.Call(m, "DoAndReturn")12}13func (m *MockClient) DoAndReturn() {14	m.ctrl.Call(m, "DoAndReturn")15}16func (m *MockClient) DoAndReturn() {17	m.ctrl.Call(m, "DoAndReturn")18}19func (m *MockClient) DoAndReturn() {20	m.ctrl.Call(m, "DoAndReturn")21}22func (m *MockClient) DoAndReturn() {23	m.ctrl.Call(m, "DoAndReturn")24}25func (m *MockClient) DoAndReturn() {26	m.ctrl.Call(m, "DoAndReturn")27}28func (m *MockClient) DoAndReturn() {29	m.ctrl.Call(m, "DoAndReturn")30}31func (m *MockClient) DoAndReturn() {32	m.ctrl.Call(m, "DoAndReturn")33}34func (m *MockClient) DoAndReturn() {35	m.ctrl.Call(m,

Automation Testing Tutorials

Learn to execute automation testing from scratch with LambdaTest Learning Hub. Right from setting up the prerequisites to run your first automation test, to following best practices and diving deeper into advanced test scenarios. LambdaTest Learning Hubs compile a list of step-by-step guides to help you be proficient with different test automation frameworks i.e. Selenium, Cypress, TestNG etc.