Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add mocks and unit tests to http and msgraph packages #2

Merged
merged 14 commits into from
Nov 21, 2019
Merged

Add mocks and unit tests to http and msgraph packages #2

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
a47b74c
command + http framework
Oct 31, 2019
b3a9a25
Got a 404 on the hardcoded Mattermost Org - no Outlook
Nov 2, 2019
8529c6a
`/msoffice viewcal` works on a personal account
Nov 2, 2019
9cd3e7a
PR feedback
Nov 9, 2019
8b794c6
Add mocks and unit tests to http and msgraph packages
Nov 12, 2019
a00e44b
Update http.go and plugin.go with upstream/dev branch
Nov 12, 2019
5cb1074
Fix merge conflicts from upstream/master branch
Nov 13, 2019
711ccb8
Address PR review comments
Nov 13, 2019
476552b
Migrate mocks to use gomock
Nov 14, 2019
2f2e12b
Use getUserRequest for oauth connect tests
Nov 14, 2019
d5a13b4
Refactor how mocks are built for tests
Nov 17, 2019
b37ce85
Refactor test case mocks, fix minor nitpicks
Nov 19, 2019
0633721
Create mocks in test run function and pass to tc struct after setup
Nov 20, 2019
5d62a39
Move redundant test case fields to testing block
Nov 21, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
179 changes: 140 additions & 39 deletions server/http/test_http/oauth2_complete_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package testhttp

import (
"errors"
"fmt"
"net/http"
"net/url"
"testing"
Expand Down Expand Up @@ -62,8 +63,8 @@ func TestOAuth2Complete(t *testing.T) {
name: "unauthorized user",
handler: shttp.Handler{
Config: config,
UserStore: user.NewStore(getMockKVStore(ctrl, []byte{}, nil)),
OAuth2StateStore: getMockOAuth2StateStore(ctrl, nil),
UserStore: user.NewStore(getMockKVStore(ctrl, &mockKVStoreConfig{})),
OAuth2StateStore: getMockOAuth2StateStore(ctrl, &mockOAuth2StateStoreConfig{}),
API: api,
},
r: &http.Request{},
Expand All @@ -76,8 +77,8 @@ func TestOAuth2Complete(t *testing.T) {
name: "missing authorization code",
handler: shttp.Handler{
Config: config,
UserStore: user.NewStore(getMockKVStore(ctrl, []byte{}, nil)),
OAuth2StateStore: getMockOAuth2StateStore(ctrl, nil),
UserStore: user.NewStore(getMockKVStore(ctrl, &mockKVStoreConfig{})),
OAuth2StateStore: getMockOAuth2StateStore(ctrl, &mockOAuth2StateStoreConfig{}),
API: api,
},
r: getUserRequest("fake@mattermost.com", "code="),
Expand All @@ -89,10 +90,14 @@ func TestOAuth2Complete(t *testing.T) {
{
name: "missing state",
handler: shttp.Handler{
Config: config,
UserStore: user.NewStore(getMockKVStore(ctrl, []byte{}, nil)),
OAuth2StateStore: getMockOAuth2StateStore(ctrl, errors.New("unable to verify state")),
API: api,
Config: config,
UserStore: user.NewStore(getMockKVStore(ctrl, &mockKVStoreConfig{})),
OAuth2StateStore: getMockOAuth2StateStore(ctrl, &mockOAuth2StateStoreConfig{
verifyKey: "",
verifyErr: errors.New("unable to verify state"),
maxTimesVerify: 1,
}),
API: api,
},
r: getUserRequest("fake@mattermost.com", "code=fakecode&state="),
w: defaultMockResponseWriter(),
Expand All @@ -103,10 +108,14 @@ func TestOAuth2Complete(t *testing.T) {
{
name: "user state not authorized",
handler: shttp.Handler{
Config: config,
UserStore: user.NewStore(getMockKVStore(ctrl, []byte{}, nil)),
OAuth2StateStore: getMockOAuth2StateStore(ctrl, nil),
API: api,
Config: config,
UserStore: user.NewStore(getMockKVStore(ctrl, &mockKVStoreConfig{})),
OAuth2StateStore: getMockOAuth2StateStore(ctrl, &mockOAuth2StateStoreConfig{
verifyKey: "user_nomatch@mattermost.com",
verifyErr: nil,
maxTimesVerify: 1,
}),
API: api,
},
r: getUserRequest("fake@mattermost.com", "code=fakecode&state=user_nomatch@mattermost.com"),
w: defaultMockResponseWriter(),
Expand All @@ -117,10 +126,14 @@ func TestOAuth2Complete(t *testing.T) {
{
name: "unable to exchange auth code for token",
handler: shttp.Handler{
Config: config,
UserStore: user.NewStore(getMockKVStore(ctrl, []byte{}, nil)),
OAuth2StateStore: getMockOAuth2StateStore(ctrl, nil),
API: api,
Config: config,
UserStore: user.NewStore(getMockKVStore(ctrl, &mockKVStoreConfig{})),
OAuth2StateStore: getMockOAuth2StateStore(ctrl, &mockOAuth2StateStoreConfig{
verifyKey: "user_fake@mattermost.com",
verifyErr: nil,
maxTimesVerify: 1,
}),
API: api,
},
r: getUserRequest("fake@mattermost.com", "code=fakecode&state=user_fake@mattermost.com"),
w: defaultMockResponseWriter(),
Expand All @@ -131,10 +144,14 @@ func TestOAuth2Complete(t *testing.T) {
{
name: "microsoft graph api client unable to get user info",
handler: shttp.Handler{
Config: config,
UserStore: user.NewStore(getMockKVStore(ctrl, []byte{}, nil)),
OAuth2StateStore: getMockOAuth2StateStore(ctrl, nil),
API: api,
Config: config,
UserStore: user.NewStore(getMockKVStore(ctrl, &mockKVStoreConfig{})),
OAuth2StateStore: getMockOAuth2StateStore(ctrl, &mockOAuth2StateStoreConfig{
verifyKey: "user_fake@mattermost.com",
verifyErr: nil,
maxTimesVerify: 1,
}),
API: api,
},
r: getUserRequest("fake@mattermost.com", "code=fakecode&state=user_fake@mattermost.com"),
w: defaultMockResponseWriter(),
Expand All @@ -148,10 +165,19 @@ func TestOAuth2Complete(t *testing.T) {
{
name: "UserStore unable to store user info",
handler: shttp.Handler{
Config: config,
UserStore: user.NewStore(getMockKVStore(ctrl, []byte{}, errors.New("forced kvstore error"))),
OAuth2StateStore: getMockOAuth2StateStore(ctrl, nil),
API: api,
Config: config,
UserStore: user.NewStore(getMockKVStore(ctrl, &mockKVStoreConfig{
useStoreAnyKey: true,
useStoreAnyValue: true,
storeErr: errors.New("forced kvstore error"),
maxTimesStore: 1,
})),
OAuth2StateStore: getMockOAuth2StateStore(ctrl, &mockOAuth2StateStoreConfig{
verifyKey: "user_fake@mattermost.com",
verifyErr: nil,
maxTimesVerify: 1,
}),
API: api,
},
r: getUserRequest("fake@mattermost.com", "code=fakecode&state=user_fake@mattermost.com"),
w: defaultMockResponseWriter(),
Expand All @@ -162,11 +188,27 @@ func TestOAuth2Complete(t *testing.T) {
{
name: "successfully completed oauth2 login",
handler: shttp.Handler{
Config: config,
UserStore: user.NewStore(getMockKVStore(ctrl, []byte{}, nil)),
OAuth2StateStore: getMockOAuth2StateStore(ctrl, nil),
BotPoster: getMockBotPoster(ctrl, nil),
API: api,
Config: config,
UserStore: user.NewStore(getMockKVStore(ctrl, &mockKVStoreConfig{
useStoreAnyKey: true,
useStoreAnyValue: true,
storeErr: nil,
maxTimesStore: 2,
})),
OAuth2StateStore: getMockOAuth2StateStore(ctrl, &mockOAuth2StateStoreConfig{
verifyKey: "user_fake@mattermost.com",
verifyErr: nil,
maxTimesVerify: 1,
}),
BotPoster: getMockBotPoster(ctrl, &mockBotPosterConfig{
userID: "fake@mattermost.com",
channelID: "",
message: getBotPosterMessage("displayName-value"),
postType: "custom_TODO",
err: nil,
maxTimesDirect: 1,
}),
API: api,
},
r: getUserRequest("fake@mattermost.com", "code=fakecode&state=user_fake@mattermost.com"),
w: defaultMockResponseWriter(),
Expand Down Expand Up @@ -271,24 +313,83 @@ func statusOKGraphAPIResponderFunc() {
httpmock.RegisterResponder("GET", meRequestURL, meResponder)
}

func getMockBotPoster(ctrl *gomock.Controller, err error) utils.BotPoster {
func getBotPosterMessage(displayName string) string {
return fmt.Sprintf("### Welcome to the Microsoft Office plugin!\n"+
"Here is some info to prove we got you logged in\n"+
"Name: %s \n", displayName)
}

type mockBotPosterConfig struct {
cpurta marked this conversation as resolved.
Show resolved Hide resolved
userID string
channelID string
message string
postType string
err error
maxTimesDirect int
maxTimesEphemeral int
}

func getMockBotPoster(ctrl *gomock.Controller, config *mockBotPosterConfig) utils.BotPoster {
m := mock_utils.NewMockBotPoster(ctrl)
m.EXPECT().PostDirect(gomock.Any(), gomock.Any(), gomock.Any()).Return(err).AnyTimes()
m.EXPECT().PostEphemeral(gomock.Any(), gomock.Any(), gomock.Any()).AnyTimes()
m.EXPECT().PostDirect(config.userID, config.message, config.postType).Return(config.err).MaxTimes(config.maxTimesDirect)
m.EXPECT().PostEphemeral(config.userID, config.channelID, config.message).MaxTimes(config.maxTimesEphemeral)
return m
}

func getMockKVStore(ctrl *gomock.Controller, bytes []byte, err error) kvstore.KVStore {
type mockKVStoreConfig struct {
bytes []byte
loadKey string
loadBytes []byte
loadErr error
useStoreAnyKey bool
useStoreAnyValue bool
storeKey string
storeValue []byte
storeErr error
deleteKey string
deleteErr error
maxTimesLoad int
maxTimesStore int
maxTimesDelete int
}

func getMockKVStore(ctrl *gomock.Controller, config *mockKVStoreConfig) kvstore.KVStore {
m := mock_kvstore.NewMockKVStore(ctrl)
m.EXPECT().Load(gomock.Any()).Return(bytes, err).AnyTimes()
m.EXPECT().Store(gomock.Any(), gomock.Any()).Return(err).AnyTimes()
m.EXPECT().Delete(gomock.Any()).Return(err).AnyTimes()
m.EXPECT().Load(config.loadKey).Return(config.loadBytes, config.loadErr).MaxTimes(config.maxTimesLoad)

if config.useStoreAnyValue {
if config.useStoreAnyKey {
m.EXPECT().Store(gomock.Any(), gomock.Any()).Return(config.storeErr).MaxTimes(config.maxTimesStore)
cpurta marked this conversation as resolved.
Show resolved Hide resolved
} else {
m.EXPECT().Store(config.storeKey, gomock.Any()).Return(config.storeErr).MaxTimes(config.maxTimesStore)
}
} else {
m.EXPECT().Store(config.storeKey, config.storeValue).Return(config.storeErr).MaxTimes(config.maxTimesStore)
}

m.EXPECT().Delete(config.deleteKey).Return(config.deleteErr).MaxTimes(config.maxTimesDelete)

return m
}

func getMockOAuth2StateStore(ctrl *gomock.Controller, err error) user.OAuth2StateStore {
type mockOAuth2StateStoreConfig struct {
useAnyStoreKey bool
storeKey string
verifyKey string
storeErr error
verifyErr error
maxTimesStore int
maxTimesVerify int
}

func getMockOAuth2StateStore(ctrl *gomock.Controller, config *mockOAuth2StateStoreConfig) user.OAuth2StateStore {
m := mock_user.NewMockOAuth2StateStore(ctrl)
m.EXPECT().Store(gomock.Any()).Return(err).AnyTimes()
m.EXPECT().Verify(gomock.Any()).Return(err).AnyTimes()
if config.useAnyStoreKey {
m.EXPECT().Store(gomock.Any()).Return(config.storeErr).MaxTimes(config.maxTimesStore)
} else {
m.EXPECT().Store(config.storeKey).Return(config.storeErr).MaxTimes(config.maxTimesStore)
}

m.EXPECT().Verify(config.verifyKey).Return(config.verifyErr).MaxTimes(config.maxTimesVerify)
return m
}
22 changes: 15 additions & 7 deletions server/http/test_http/oauth2_connect_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ func TestOAuth2Connect(t *testing.T) {
w: defaultMockResponseWriter(),
handler: shttp.Handler{
Config: &config.Config{},
UserStore: user.NewStore(getMockKVStore(ctrl, []byte{}, nil)),
UserStore: user.NewStore(getMockKVStore(ctrl, &mockKVStoreConfig{})),
OAuth2StateStore: mock_user.NewMockOAuth2StateStore(ctrl),
},
expectedHTTPResponse: "Not authorized\n",
Expand All @@ -42,9 +42,13 @@ func TestOAuth2Connect(t *testing.T) {
r: getUserRequest("fake@mattermost.com", ""),
w: defaultMockResponseWriter(),
handler: shttp.Handler{
Config: &config.Config{},
UserStore: user.NewStore(getMockKVStore(ctrl, []byte{}, nil)),
OAuth2StateStore: getMockOAuth2StateStore(ctrl, errors.New("unable to store state")),
Config: &config.Config{},
UserStore: user.NewStore(getMockKVStore(ctrl, &mockKVStoreConfig{})),
OAuth2StateStore: getMockOAuth2StateStore(ctrl, &mockOAuth2StateStoreConfig{
useAnyStoreKey: true,
storeErr: errors.New("unable to store state"),
maxTimesStore: 1,
}),
},
expectedHTTPResponse: "{\"error\":\"An internal error has occurred. Check app server logs for details.\",\"details\":\"unable to store state\"}",
expectedHTTPCode: http.StatusInternalServerError,
Expand All @@ -54,9 +58,13 @@ func TestOAuth2Connect(t *testing.T) {
r: getUserRequest("fake@mattermost.com", ""),
w: defaultMockResponseWriter(),
handler: shttp.Handler{
Config: &config.Config{},
UserStore: user.NewStore(getMockKVStore(ctrl, []byte{}, nil)),
OAuth2StateStore: getMockOAuth2StateStore(ctrl, nil),
Config: &config.Config{},
UserStore: user.NewStore(getMockKVStore(ctrl, &mockKVStoreConfig{})),
OAuth2StateStore: getMockOAuth2StateStore(ctrl, &mockOAuth2StateStoreConfig{
useAnyStoreKey: true,
storeErr: nil,
maxTimesStore: 1,
}),
},
expectedHTTPResponse: "",
expectedHTTPCode: http.StatusFound,
Expand Down