Home

Help

linkedin

login

Github

About me

Courses

Medium

Hello%20folks%2C%20though%20we%20are%20passing%20a%20critical%20time%20due%20to%20the%20COVID-19%20pandemic%20I%20hope%20you%20all%20are%20well%20and%20safe.%0A%0AIn%20software%20development%20one%20of%20the%20major%20%26%20critical%20parts%20is%20software%20testing.%20Testing%20can%20vary%20in%20type.%20Today%20you%20will%20learn%20how%20you%20can%20implement%20mock%20testing%20in%20your%20**Golang**%20project.%0A%0A%23%23%23%20What%20is%20the%20mock%20test%3F%0A%0AMock%20testing%20is%20an%20approach%20to%20unit%20testing%20that%20lets%20you%20make%20assertions%20about%20how%20the%20code%20under%20test%20is%20interacting%20with%20other%20system%20modules.%20In%20mock%20testing%2C%20the%20dependencies%20are%20replaced%20with%20objects%20that%20simulate%20the%20behaviour%20of%20the%20real%20ones.%20Mainly%20in%20mock%20testing%2C%20we%20simulate%20the%20behaviour%20of%20a%20third-party%20service%2C%20we%20are%20using%20in%20our%20project.%0A%0A%23%23%23%20How%20to%20mock%3F%0A%0AIn%20this%20project%2C%20I%20will%20use%20https%3A%2F%2Fgithub.com%2Fgolang%2Fmock%20library%20to%20implement%20mock%20testing.%20If%20you%20want%20you%20can%20use%20any%20other%20library%20as%20well.%20Now%20create%20a%20project%20and%20execute%20the%20following%20to%20include%20the%20libraries%20in%20your%20project%2C%0A%0A%60%60%60bash%0Ago%20get%20github.com%2Fgolang%2Fmock%2Fgomock%0Ago%20get%20github.com%2Fgolang%2Fmock%2Fmockgen%0Ago%20get%20github.com%2Fstretchr%2Ftestify%0A%60%60%60%0A%0A%60github.com%2Fstretchr%2Ftestify%60%20is%20a%20test%20assertion%20library.%0A%0ALet's%20say%20we%20have%20two%20micro-services%20%60mockingjay%60%20and%20%60user%60.%20In%20%60mockingjay%60%20we%20have%20integration%20with%20%60user%60%20service%2C%20so%20we%20will%20simulate%20the%20behaviour%20the%20of%20%60user%60%20service%20in%20%60mockingjay%60%20service.%0A%0ALet's%20have%20an%20%60interface%60%20defining%20the%20behaviour%20of%20%60user%60%20service.%0A%0A%60%60%60go%0Atype%20UserService%20interface%20%7B%0A%09CreateUser(name%2C%20email%20string)%20(*User%2C%20error)%0A%09UpdateUser(ID%2C%20name%2C%20email%20string)%20(*User%2C%20error)%0A%09GetUser(ID%20string)%20(*User%2C%20error)%0A%09DeleteUser(ID%20string)%20error%0A%7D%0A%60%60%60%0A%0AIn%20above%20interface%20we%20have%20defined%20the%20CRUD%20operations%20of%20user%20service.%0A%0A%60%60%60go%0Atype%20User%20struct%20%7B%0A%09ID%20%20%20%20string%0A%09Name%20%20string%0A%09Email%20string%0A%7D%0A%60%60%60%0A%0ANow%20the%20below%20code%20will%20generate%20mocks%20based%20on%20these%20definitions%2C%0A%0A%60%60%60bash%0A%2F%2Fgo%3Agenerate%20mockgen%20-source%3Duser_service.go%20-destination%20mocks%2Fmock_user_service.go%20-package%20mocks%20UserService%0A%60%60%60%0A%0ABelow%20is%20the%20project%20structure%2C%0A%0A!%5B%5D(https%3A%2F%2Fcdn.shopemaa.cloud%2F4f877f28-3e2a-47a4-a195-2689d1789ed3%2Fmedia%2F9f8f2f1b-3752-46fa-96df-95ab14baeaea-U2NyZWVuc2hvdC0yMDIxLTA3LTEwLWF0LTMuNDMuNDctUE0%3D.png)%0A%0ANow%20execute%20the%20below%20command%20to%20generate%20mocks%2C%0A%0A%60%60%60bash%0Ago%20generate%20.%2F...%0A%60%60%60%0A%0A!%5B%5D(https%3A%2F%2Fcdn.shopemaa.cloud%2F4f877f28-3e2a-47a4-a195-2689d1789ed3%2Fmedia%2F975369e6-deac-4bc7-b658-978f17b1226a-U2NyZWVuc2hvdC0yMDIxLTA3LTEwLWF0LTMuNDIuMTctUE0%3D.png)%0A%0AThen%20you%20will%20have%20%60mock_user_service.go%60%20generated%20with%20the%20mocks.%0A%0AIn%20this%20step%2C%20we%20will%20implement%20the%20test%20using%20Golang%20's%20testing%20feature.%0A%0A%60%60%60go%0Afunc%20Test_UserService_CreateUser(t%20*testing.T)%20%7B%0A%09%0A%7D%0A%60%60%60%0A%0AWith%20the%20above%20function%2C%20we%20will%20mock%20CreateUser%20function%2C%0ATo%20do%20that%20we%20have%20to%20add%20gomock%20Controller%2C%0A%0A%60%60%60go%0Afunc%20Test_UserService_CreateUser(t%20*testing.T)%20%7B%0A%09ctrl%20%3A%3D%20gomock.NewController(t)%0A%09defer%20ctrl.Finish()%0A%0A%7D%0A%60%60%60%0A%0AOkay%2C%20we%20have%20the%20basic%20structure.%20Now%20we%20will%20add%20user%20service%20mocking%2C%0A%0A%60%60%60go%0Afunc%20Test_UserService_CreateUser(t%20*testing.T)%20%7B%0A%09ctrl%20%3A%3D%20gomock.NewController(t)%0A%09defer%20ctrl.Finish()%0A%0A%09expectedID%20%3A%3D%20%221%22%0A%09expectedName%20%3A%3D%20%22Sakib%22%0A%09expectedEmail%20%3A%3D%20%22sakib%40liveklass.io%22%0A%09expectedUser%20%3A%3D%20%26User%7BID%3A%20expectedID%2C%20Name%3A%20expectedName%2C%20Email%3A%20expectedEmail%7D%0A%0A%09mockUserService%20%3A%3D%20mocks.NewMockUserService(ctrl)%0A%09mockUserService.EXPECT().CreateUser(expectedName%2C%20expectedEmail).Return(expectedUser%2C%20nil).Times(1)%0A%0A%7D%0A%60%60%60%0A%0AWith%20the%20above%2C%20we%20have%20defined%20that%20the%20CreateUser%20function%20will%20be%20called%20with%20those%20parameters%20and%20it%20will%20return%20User%20and%20error%20nil%20.%0A%0ANote%20that%2C%20with%20EXPECT%20function%20we%20are%20setting%20that%20we%20expect%20those%20parameters%20and%20results%20from%20that%20specific%20function.%20We%20can%20also%20define%20how%20many%20times%20the%20function%20will%20be%20called%20by%20Times%20function.%20You%20can%20check%20library%20%5Bdocumentation%5D(https%3A%2F%2Fgithub.com%2Fgolang%2Fmock)%20to%20learn%20more%20about%20it.%0A%0ANow%20finally%20we%20will%20call%20CreateUser%20function.%0A%0A%60%60%60go%0Afunc%20Test_UserService_CreateUser(t%20*testing.T)%20%7B%0A%09ctrl%20%3A%3D%20gomock.NewController(t)%0A%09defer%20ctrl.Finish()%0A%0A%09expectedID%20%3A%3D%20%221%22%0A%09expectedName%20%3A%3D%20%22Sakib%22%0A%09expectedEmail%20%3A%3D%20%22sakib%40liveklass.io%22%0A%09expectedUser%20%3A%3D%20%26services.User%7BID%3A%20expectedID%2C%20Name%3A%20expectedName%2C%20Email%3A%20expectedEmail%7D%0A%0A%09mockUserService%20%3A%3D%20NewMockUserService(ctrl)%0A%09mockUserService.EXPECT().CreateUser(expectedName%2C%20expectedEmail).Return(expectedUser%2C%20nil).Times(1)%0A%0A%09u%2C%20err%20%3A%3D%20mockUserService.CreateUser(expectedName%2C%20expectedEmail)%0A%09require.NoError(t%2C%20err)%0A%0A%09require.Equal(t%2C%20expectedUser.ID%2C%20u.ID)%0A%09require.Equal(t%2C%20expectedUser.Name%2C%20u.Name)%0A%09require.Equal(t%2C%20expectedUser.Email%2C%20u.Email)%0A%7D%0A%60%60%60%0A%0ARun%20tests%20by%20executing%2C%20%60go%20test%20.%2F...%60%0A%0A!%5B%5D(https%3A%2F%2Fcdn.shopemaa.cloud%2F4f877f28-3e2a-47a4-a195-2689d1789ed3%2Fmedia%2Fa03d9d60-541f-45b3-b1a3-0aa191f545f3-U2NyZWVuc2hvdC0yMDIxLTA3LTEwLWF0LTQuMTAuNDItUE0%3D.png)%0A%0AIf%20the%20test%20fails%2C%20it%20will%20show%20output%20like%20this%2C%0A%0A!%5B%5D(https%3A%2F%2Fcdn.shopemaa.cloud%2F4f877f28-3e2a-47a4-a195-2689d1789ed3%2Fmedia%2F939499a4-1f18-44ac-ab67-0de401b42b05-U2NyZWVuc2hvdC0yMDIxLTA3LTEwLWF0LTQuMTIuMjQtUE0%3D.png)%0A%0ANow%20following%20the%20same%2C%20try%20to%20implement%20test%20for%20other%20functions.%0A%0AGood%20luck.%20%F0%9F%A4%9E%0A%0ASource%20code%3A%20%5Bhttps%3A%2F%2Fgithub.com%2Fs4kibs4mi%2Fmockingjay%5D(https%3A%2F%2Fgithub.com%2Fs4kibs4mi%2Fmockingjay)

Golang: How to mock test

Learn with Sakib