Unexpected method call issue with golang mock unit testing

[SajaiPrathap070]

Hello,
I am using Golang "github.com/stretchr/testify/mock" for unit testing with validator library and I am facing error (an unexpected method call) when using query parameters.

Since Iam new, I dont know how to fix the unexpected method call error.

Please check the below code and help me in fixing this issue.

This is my struct:

type MainCategory struct {
	ID          primitive.ObjectID `bson:"_id,omitempty" json:"id"`
	Title       string             `bson:"title" json:"title" validate:"required"`
	SubTitle    string             `bson:"sub_title" json:"sub_title" validate:"required"`
	Description string             `bson:"dsc" json:"dsc"`
	ImageUrl    string             `bson:"url" json:"url"`
}

This is my service interface:

type CategoryService interface {
	UpdateMainCategory(mainCategoryID string, mainCategory mongodb.MainCategory) (int64, error)
}

This is my Unit test:

type dbCategoriesMock struct {
	mock.Mock
}

func (m *dbCategoriesMock) UpdateMainCategory(mainCategoryID string, mainCategory mongodb.MainCategory) (int64, error) {
	args := m.Called(mainCategoryID, mainCategory)
	return args.Get(0).(int64), args.Error(1)
}

func TestMainCategoryHandlers_UpdateMainCategories(t *testing.T) {

	var testCases = []struct {
		name        string
		whenId      string
		whenPayload string
		dBWhen      mongodb.MainCategory
		dBReturn    int64
		dBError     error
		expect      string
		expectError string
	}{
		{
			name:        "ok, happyCase",
			whenId:      "000000000000000000000000",
			whenPayload: `{"id": "000000000000000000000000", "title": "Nutritionist", "sub_title": "subtitle", "dsc": "description", "url": "url"}`,
			dBWhen:      mongodb.MainCategory{ID: primitive.ObjectID{000000000000000000000000}, Title: "Nutritionist", SubTitle: "subtitle", Description: "description", ImageUrl: "url"},
			dBReturn:    999,
			expect:      `{"code":200, "msg":"999"}`,
		},
		{ //title field int instead of string
			name:        "UnHappyCase-1",
			whenId:      "000000000000000000000000",
			whenPayload: `{"id": "000000000000000000000000", "title": 1 , "sub_title": "subtitle", "dsc": "description", "url": "url"}`,
			dBWhen:      mongodb.MainCategory{ID: primitive.ObjectID{000000000000000000000000}, Title: "Nutritionist", SubTitle: "subtitle", Description: "description", ImageUrl: "url"},
			dBReturn:    999,
			expect:      `{"code":400, "msg":"Request model is not formed correctly!"}`,
		},
		{ //subtitle field is empty
			name:        "UnHappyCase-2",
			whenId:      "000000000000000000000000",
			whenPayload: `{"id": "000000000000000000000000", "title": "Nutritionist" , "sub_title": "", "dsc": "description", "url": "url"}`,
			dBWhen:      mongodb.MainCategory{ID: primitive.ObjectID{000000000000000000000000}, Title: "Nutritionist", SubTitle: "subtitle", Description: "description", ImageUrl: "url"},
			dBReturn:    999,
			expect:      `{"code":400, "msg":"Required field is empty!"}`,
		},
	}
	for _, tc := range testCases {

		t.Run(tc.name, func(t *testing.T) {

			idCheck, err := primitive.ObjectIDFromHex(tc.whenId) //converting tc.whenID from string to primitive.ObjectID

			if tc.dBWhen.ID != idCheck { //to check for cases where ID doesn't exist
				tc.dBReturn = 0
			}

			database := new(dbCategoriesMock)
			database.On("UpdateMainCategory", tc.dBWhen).Return(tc.dBReturn, tc.dBError)

			req := httptest.NewRequest(http.MethodPut, fmt.Sprintf("/categories/put/main/?mainCategoryId=%s", tc.whenId), strings.NewReader(tc.whenPayload))
			req.Header.Set(echo.HeaderContentType, echo.MIMEApplicationJSON)
			rec := httptest.NewRecorder()
			e := echo.New()
			c := e.NewContext(req, rec)
			e.Validator = &handler.CustomValidator{Validator: validator.New()} //for custom validator
			h := handler.CategoriesHandlers{Service: database}
			err = h.UpdateMainCategory(c)

			assert.JSONEq(t, tc.expect, string(rec.Body.Bytes()))
			if tc.expectError != "" {
				assert.EqualError(t, err, tc.expectError)
			} else {
				assert.NoError(t, err)
			}
		})
}

And this is my error result.

=== RUN   TestMainCategoryHandlers_UpdateMainCategories
=== RUN   TestMainCategoryHandlers_UpdateMainCategories/ok,_happyCase
--- FAIL: TestMainCategoryHandlers_UpdateMainCategories (0.00s)
    --- FAIL: TestMainCategoryHandlers_UpdateMainCategories/ok,_happyCase (0.00s)
panic: 

mock: Unexpected Method Call
-----------------------------

UpdateMainCategory(string,mongodb.MainCategory)
		0: "000000000000000000000000"
		1: mongodb.MainCategory{ID:primitive.ObjectID{0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0}, Title:"Nutritionist", SubTitle:"subtitle", Description:"description", ImageUrl:"url"}

The closest call I have is: 

UpdateMainCategory(mongodb.MainCategory)
		0: mongodb.MainCategory{ID:primitive.ObjectID{0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0}, Title:"Nutritionist", SubTitle:"subtitle", Description:"description", ImageUrl:"url"}

Provided 1 arguments, mocked for 2 arguments
Diff: 0: FAIL:  (string=000000000000000000000000) != (mongodb.MainCategory={ObjectID("000000000000000000000000") Nutritionist subtitle description url})
	1: FAIL:  (mongodb.MainCategory={ObjectID("000000000000000000000000") Nutritionist subtitle description url}) != (Missing) [recovered]
	panic: 

mock: Unexpected Method Call
-----------------------------

UpdateMainCategory(string,mongodb.MainCategory)
		0: "000000000000000000000000"
		1: mongodb.MainCategory{ID:primitive.ObjectID{0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0}, Title:"Nutritionist", SubTitle:"subtitle", Description:"description", ImageUrl:"url"}

The closest call I have is: 

UpdateMainCategory(mongodb.MainCategory)
		0: mongodb.MainCategory{ID:primitive.ObjectID{0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0}, Title:"Nutritionist", SubTitle:"subtitle", Description:"description", ImageUrl:"url"}

Provided 1 arguments, mocked for 2 arguments
Diff: 0: FAIL:  (string=000000000000000000000000) != (mongodb.MainCategory={ObjectID("000000000000000000000000") Nutritionist subtitle description url})
	1: FAIL:  (mongodb.MainCategory={ObjectID("000000000000000000000000") Nutritionist subtitle description url}) != (Missing)

goroutine 7 [running]:
testing.tRunner.func1.2(0xfee540, 0xc0002b4690)
	C:/Users/sajai/go/go1.16.7/src/testing/testing.go:1143 +0x345
testing.tRunner.func1(0xc0002a8180)
	C:/Users/sajai/go/go1.16.7/src/testing/testing.go:1146 +0x4b6
panic(0xfee540, 0xc0002b4690)
	C:/Users/sajai/go/go1.16.7/src/runtime/panic.go:965 +0x1c7
github.com/stretchr/testify/mock.(*Mock).fail(0xc0000693b0, 0x10d9f5e, 0x6f, 0xc00010ea00, 0x4, 0x4)
	C:/Users/sajai/go/pkg/mod/github.com/stretchr/[email protected]/mock/mock.go:254 +0x185
github.com/stretchr/testify/mock.(*Mock).MethodCalled(0xc0000693b0, 0x11fd080, 0x12, 0xc00022ea60, 0x2, 0x2, 0xc000069630, 0x5, 0x5)
	C:/Users/sajai/go/pkg/mod/github.com/stretchr/[email protected]/mock/mock.go:411 +0x66b
github.com/stretchr/testify/mock.(*Mock).Called(0xc0000693b0, 0xc00022ea60, 0x2, 0x2, 0xf5b868, 0xc00002fb60, 0x1174fd0)
	C:/Users/sajai/go/pkg/mod/github.com/stretchr/[email protected]/mock/mock.go:383 +0x1b8
go.microservice.template/consultation/src/api/rest/handler/unitTest.(*dbCategoriesMock).UpdateMainCategory(0xc0000693b0, 0xc000020989, 0x18, 0x0, 0x0, 0xc000112ce0, 0xc, 0xc000112cd8, 0x8, 0xc000112cf0, ...)
	C:/Users/sajai/GolandProjects/go_microservice-template/microservices/consultation/src/api/rest/handler/unitTest/CategoriesHandler_test.go:35 +0x11b
go.microservice.template/consultation/src/api/rest/handler.(*CategoriesHandlers).UpdateMainCategory(0xc00006df50, 0x117fe10, 0xc000267900, 0x14c3940, 0xc000252768)
	C:/Users/sajai/GolandProjects/go_microservice-template/microservices/consultation/src/api/rest/handler/CategoriesHandler.go:107 +0x535
go.microservice.template/consultation/src/api/rest/handler/unitTest.TestMainCategoryHandlers_UpdateMainCategories.func1(0xc0002a8180)
	C:/Users/sajai/GolandProjects/go_microservice-template/microservices/consultation/src/api/rest/handler/unitTest/CategoriesHandler_test.go:237 +0x6e6
testing.tRunner(0xc0002a8180, 0xc00020bb40)
	C:/Users/sajai/go/go1.16.7/src/testing/testing.go:1193 +0xef
created by testing.(*T).Run
	C:/Users/sajai/go/go1.16.7/src/testing/testing.go:1238 +0x2b3


Process finished with the exit code 1

[aldas]

I think that the problem is that
UpdateMainCategory(mainCategoryID string, mainCategory mongodb.MainCategory) (int64, error) takes 2 arguments

but mock prepares for one
database.On("UpdateMainCategory", tc.dBWhen).Return(tc.dBReturn, tc.dBError)

[SajaiPrathap070]

Thanks a lot. It is working.