// Copyright (c) 2016-present Mattermost, Inc. All Rights Reserved. // See License.txt for license information. package app import ( "io/ioutil" "os" "path/filepath" "strings" "time" "testing" "github.com/mattermost/mattermost-server/config" "github.com/mattermost/mattermost-server/mlog" "github.com/mattermost/mattermost-server/model" "github.com/mattermost/mattermost-server/utils" "github.com/stretchr/testify/require" ) type TestHelper struct { App *App Server *Server BasicTeam *model.Team BasicUser *model.User BasicUser2 *model.User BasicChannel *model.Channel BasicPost *model.Post SystemAdminUser *model.User tempWorkspace string } func setupTestHelper(enterprise bool, tb testing.TB) *TestHelper { store := mainHelper.GetStore() store.DropAllTables() memoryStore, err := config.NewMemoryStoreWithOptions(&config.MemoryStoreOptions{IgnoreEnvironmentOverrides: true}) if err != nil { panic("failed to initialize memory store: " + err.Error()) } var options []Option options = append(options, ConfigStore(memoryStore)) options = append(options, StoreOverride(mainHelper.Store)) options = append(options, SetLogger(mlog.NewTestingLogger(tb))) s, err := NewServer(options...) if err != nil { panic(err) } th := &TestHelper{ App: s.FakeApp(), Server: s, } th.App.UpdateConfig(func(cfg *model.Config) { *cfg.TeamSettings.MaxUsersPerTeam = 50 }) th.App.UpdateConfig(func(cfg *model.Config) { *cfg.RateLimitSettings.Enable = false }) prevListenAddress := *th.App.Config().ServiceSettings.ListenAddress th.App.UpdateConfig(func(cfg *model.Config) { *cfg.ServiceSettings.ListenAddress = ":0" }) serverErr := th.Server.Start() if serverErr != nil { panic(serverErr) } th.App.UpdateConfig(func(cfg *model.Config) { *cfg.ServiceSettings.ListenAddress = prevListenAddress }) th.App.Srv.Store.MarkSystemRanUnitTests() th.App.UpdateConfig(func(cfg *model.Config) { *cfg.TeamSettings.EnableOpenServer = true }) // Disable strict password requirements for test th.App.UpdateConfig(func(cfg *model.Config) { *cfg.PasswordSettings.MinimumLength = 5 *cfg.PasswordSettings.Lowercase = false *cfg.PasswordSettings.Uppercase = false *cfg.PasswordSettings.Symbol = false *cfg.PasswordSettings.Number = false }) if enterprise { th.App.SetLicense(model.NewTestLicense()) } else { th.App.SetLicense(nil) } if th.tempWorkspace == "" { dir, err := ioutil.TempDir("", "apptest") if err != nil { panic(err) } th.tempWorkspace = dir } pluginDir := filepath.Join(th.tempWorkspace, "plugins") webappDir := filepath.Join(th.tempWorkspace, "webapp") th.App.InitPlugins(pluginDir, webappDir) return th } func SetupEnterprise(tb testing.TB) *TestHelper { return setupTestHelper(true, tb) } func Setup(tb testing.TB) *TestHelper { return setupTestHelper(false, tb) } func (me *TestHelper) InitBasic() *TestHelper { me.SystemAdminUser = me.CreateUser() me.App.UpdateUserRoles(me.SystemAdminUser.Id, model.SYSTEM_USER_ROLE_ID+" "+model.SYSTEM_ADMIN_ROLE_ID, false) me.SystemAdminUser, _ = me.App.GetUser(me.SystemAdminUser.Id) me.BasicTeam = me.CreateTeam() me.BasicUser = me.CreateUser() me.LinkUserToTeam(me.BasicUser, me.BasicTeam) me.BasicUser2 = me.CreateUser() me.LinkUserToTeam(me.BasicUser2, me.BasicTeam) me.BasicChannel = me.CreateChannel(me.BasicTeam) me.BasicPost = me.CreatePost(me.BasicChannel) return me } func (me *TestHelper) MakeEmail() string { return "success_" + model.NewId() + "@simulator.amazonses.com" } func (me *TestHelper) CreateTeam() *model.Team { id := model.NewId() team := &model.Team{ DisplayName: "dn_" + id, Name: "name" + id, Email: "success+" + id + "@simulator.amazonses.com", Type: model.TEAM_OPEN, } utils.DisableDebugLogForTest() var err *model.AppError if team, err = me.App.CreateTeam(team); err != nil { mlog.Error(err.Error()) time.Sleep(time.Second) panic(err) } utils.EnableDebugLogForTest() return team } func (me *TestHelper) CreateUser() *model.User { return me.CreateUserOrGuest(false) } func (me *TestHelper) CreateGuest() *model.User { return me.CreateUserOrGuest(true) } func (me *TestHelper) CreateUserOrGuest(guest bool) *model.User { id := model.NewId() user := &model.User{ Email: "success+" + id + "@simulator.amazonses.com", Username: "un_" + id, Nickname: "nn_" + id, Password: "Password1", EmailVerified: true, } utils.DisableDebugLogForTest() var err *model.AppError if guest { if user, err = me.App.CreateGuest(user); err != nil { mlog.Error(err.Error()) time.Sleep(time.Second) panic(err) } } else { if user, err = me.App.CreateUser(user); err != nil { mlog.Error(err.Error()) time.Sleep(time.Second) panic(err) } } utils.EnableDebugLogForTest() return user } func (me *TestHelper) CreateChannel(team *model.Team) *model.Channel { return me.createChannel(team, model.CHANNEL_OPEN) } func (me *TestHelper) CreatePrivateChannel(team *model.Team) *model.Channel { return me.createChannel(team, model.CHANNEL_PRIVATE) } func (me *TestHelper) createChannel(team *model.Team, channelType string) *model.Channel { id := model.NewId() channel := &model.Channel{ DisplayName: "dn_" + id, Name: "name_" + id, Type: channelType, TeamId: team.Id, CreatorId: me.BasicUser.Id, } utils.DisableDebugLogForTest() var err *model.AppError if channel, err = me.App.CreateChannel(channel, true); err != nil { mlog.Error(err.Error()) time.Sleep(time.Second) panic(err) } utils.EnableDebugLogForTest() return channel } func (me *TestHelper) createChannelWithAnotherUser(team *model.Team, channelType, userId string) *model.Channel { id := model.NewId() channel := &model.Channel{ DisplayName: "dn_" + id, Name: "name_" + id, Type: channelType, TeamId: team.Id, CreatorId: userId, } utils.DisableDebugLogForTest() var err *model.AppError if channel, err = me.App.CreateChannel(channel, true); err != nil { mlog.Error(err.Error()) time.Sleep(time.Second) panic(err) } utils.EnableDebugLogForTest() return channel } func (me *TestHelper) CreateDmChannel(user *model.User) *model.Channel { utils.DisableDebugLogForTest() var err *model.AppError var channel *model.Channel if channel, err = me.App.GetOrCreateDirectChannel(me.BasicUser.Id, user.Id); err != nil { mlog.Error(err.Error()) time.Sleep(time.Second) panic(err) } utils.EnableDebugLogForTest() return channel } func (me *TestHelper) CreateGroupChannel(user1 *model.User, user2 *model.User) *model.Channel { utils.DisableDebugLogForTest() var err *model.AppError var channel *model.Channel if channel, err = me.App.CreateGroupChannel([]string{me.BasicUser.Id, user1.Id, user2.Id}, me.BasicUser.Id); err != nil { mlog.Error(err.Error()) time.Sleep(time.Second) panic(err) } utils.EnableDebugLogForTest() return channel } func (me *TestHelper) CreatePost(channel *model.Channel) *model.Post { id := model.NewId() post := &model.Post{ UserId: me.BasicUser.Id, ChannelId: channel.Id, Message: "message_" + id, CreateAt: model.GetMillis() - 10000, } utils.DisableDebugLogForTest() var err *model.AppError if post, err = me.App.CreatePost(post, channel, false); err != nil { mlog.Error(err.Error()) time.Sleep(time.Second) panic(err) } utils.EnableDebugLogForTest() return post } func (me *TestHelper) CreateMessagePost(channel *model.Channel, message string) *model.Post { post := &model.Post{ UserId: me.BasicUser.Id, ChannelId: channel.Id, Message: message, CreateAt: model.GetMillis() - 10000, } utils.DisableDebugLogForTest() var err *model.AppError if post, err = me.App.CreatePost(post, channel, false); err != nil { mlog.Error(err.Error()) time.Sleep(time.Second) panic(err) } utils.EnableDebugLogForTest() return post } func (me *TestHelper) LinkUserToTeam(user *model.User, team *model.Team) { utils.DisableDebugLogForTest() err := me.App.JoinUserToTeam(team, user, "") if err != nil { mlog.Error(err.Error()) time.Sleep(time.Second) panic(err) } utils.EnableDebugLogForTest() } func (me *TestHelper) AddUserToChannel(user *model.User, channel *model.Channel) *model.ChannelMember { utils.DisableDebugLogForTest() member, err := me.App.AddUserToChannel(user, channel) if err != nil { mlog.Error(err.Error()) time.Sleep(time.Second) panic(err) } utils.EnableDebugLogForTest() return member } func (me *TestHelper) CreateScheme() (*model.Scheme, []*model.Role) { utils.DisableDebugLogForTest() scheme, err := me.App.CreateScheme(&model.Scheme{ DisplayName: "Test Scheme Display Name", Name: model.NewId(), Description: "Test scheme description", Scope: model.SCHEME_SCOPE_TEAM, }) if err != nil { panic(err) } roleNames := []string{ scheme.DefaultTeamAdminRole, scheme.DefaultTeamUserRole, scheme.DefaultTeamGuestRole, scheme.DefaultChannelAdminRole, scheme.DefaultChannelUserRole, scheme.DefaultChannelGuestRole, } var roles []*model.Role for _, roleName := range roleNames { role, err := me.App.GetRoleByName(roleName) if err != nil { panic(err) } roles = append(roles, role) } utils.EnableDebugLogForTest() return scheme, roles } func (me *TestHelper) CreateGroup() *model.Group { id := model.NewId() group := &model.Group{ DisplayName: "dn_" + id, Name: "name" + id, Source: model.GroupSourceLdap, Description: "description_" + id, RemoteId: model.NewId(), } utils.DisableDebugLogForTest() var err *model.AppError if group, err = me.App.CreateGroup(group); err != nil { mlog.Error(err.Error()) time.Sleep(time.Second) panic(err) } utils.EnableDebugLogForTest() return group } func (me *TestHelper) CreateEmoji() *model.Emoji { utils.DisableDebugLogForTest() emoji, err := me.App.Srv.Store.Emoji().Save(&model.Emoji{ CreatorId: me.BasicUser.Id, Name: model.NewRandomString(10), }) if err != nil { panic(err) } utils.EnableDebugLogForTest() return emoji } func (me *TestHelper) AddReactionToPost(post *model.Post, user *model.User, emojiName string) *model.Reaction { utils.DisableDebugLogForTest() reaction, err := me.App.SaveReactionForPost(&model.Reaction{ UserId: user.Id, PostId: post.Id, EmojiName: emojiName, }) if err != nil { panic(err) } utils.EnableDebugLogForTest() return reaction } func (me *TestHelper) ShutdownApp() { done := make(chan bool) go func() { me.Server.Shutdown() close(done) }() select { case <-done: case <-time.After(30 * time.Second): // panic instead of t.Fatal to terminate all tests in this package, otherwise the // still running App could spuriously fail subsequent tests. panic("failed to shutdown App within 30 seconds") } } func (me *TestHelper) TearDown() { me.ShutdownApp() if err := recover(); err != nil { panic(err) } if me.tempWorkspace != "" { os.RemoveAll(me.tempWorkspace) } } func (me *TestHelper) ResetRoleMigration() { sqlSupplier := mainHelper.GetSqlSupplier() if _, err := sqlSupplier.GetMaster().Exec("DELETE from Roles"); err != nil { panic(err) } mainHelper.GetClusterInterface().SendClearRoleCacheMessage() if _, err := sqlSupplier.GetMaster().Exec("DELETE from Systems where Name = :Name", map[string]interface{}{"Name": ADVANCED_PERMISSIONS_MIGRATION_KEY}); err != nil { panic(err) } } func (me *TestHelper) ResetEmojisMigration() { sqlSupplier := mainHelper.GetSqlSupplier() if _, err := sqlSupplier.GetMaster().Exec("UPDATE Roles SET Permissions=REPLACE(Permissions, ' create_emojis', '') WHERE builtin=True"); err != nil { panic(err) } if _, err := sqlSupplier.GetMaster().Exec("UPDATE Roles SET Permissions=REPLACE(Permissions, ' delete_emojis', '') WHERE builtin=True"); err != nil { panic(err) } if _, err := sqlSupplier.GetMaster().Exec("UPDATE Roles SET Permissions=REPLACE(Permissions, ' delete_others_emojis', '') WHERE builtin=True"); err != nil { panic(err) } mainHelper.GetClusterInterface().SendClearRoleCacheMessage() if _, err := sqlSupplier.GetMaster().Exec("DELETE from Systems where Name = :Name", map[string]interface{}{"Name": EMOJIS_PERMISSIONS_MIGRATION_KEY}); err != nil { panic(err) } } func (me *TestHelper) CheckTeamCount(t *testing.T, expected int64) { teamCount, err := me.App.Srv.Store.Team().AnalyticsTeamCount() require.Nil(t, err, "Failed to get team count.") require.Equalf(t, teamCount, expected, "Unexpected number of teams. Expected: %v, found: %v", expected, teamCount) } func (me *TestHelper) CheckChannelsCount(t *testing.T, expected int64) { count, err := me.App.Srv.Store.Channel().AnalyticsTypeCount("", model.CHANNEL_OPEN) require.Nilf(t, err, "Failed to get channel count.") require.Equalf(t, count, expected, "Unexpected number of channels. Expected: %v, found: %v", expected, count) } func (me *TestHelper) SetupTeamScheme() *model.Scheme { scheme := model.Scheme{ Name: model.NewId(), DisplayName: model.NewId(), Scope: model.SCHEME_SCOPE_TEAM, } if scheme, err := me.App.CreateScheme(&scheme); err == nil { return scheme } else { panic(err) } } func (me *TestHelper) SetupChannelScheme() *model.Scheme { scheme := model.Scheme{ Name: model.NewId(), DisplayName: model.NewId(), Scope: model.SCHEME_SCOPE_CHANNEL, } if scheme, err := me.App.CreateScheme(&scheme); err == nil { return scheme } else { panic(err) } } func (me *TestHelper) SetupPluginAPI() *PluginAPI { manifest := &model.Manifest{ Id: "pluginid", } return NewPluginAPI(me.App, manifest) } func (me *TestHelper) RemovePermissionFromRole(permission string, roleName string) { utils.DisableDebugLogForTest() role, err1 := me.App.GetRoleByName(roleName) if err1 != nil { utils.EnableDebugLogForTest() panic(err1) } var newPermissions []string for _, p := range role.Permissions { if p != permission { newPermissions = append(newPermissions, p) } } if strings.Join(role.Permissions, " ") == strings.Join(newPermissions, " ") { utils.EnableDebugLogForTest() return } role.Permissions = newPermissions _, err2 := me.App.UpdateRole(role) if err2 != nil { utils.EnableDebugLogForTest() panic(err2) } utils.EnableDebugLogForTest() } func (me *TestHelper) AddPermissionToRole(permission string, roleName string) { utils.DisableDebugLogForTest() role, err1 := me.App.GetRoleByName(roleName) if err1 != nil { utils.EnableDebugLogForTest() panic(err1) } for _, existingPermission := range role.Permissions { if existingPermission == permission { utils.EnableDebugLogForTest() return } } role.Permissions = append(role.Permissions, permission) _, err2 := me.App.UpdateRole(role) if err2 != nil { utils.EnableDebugLogForTest() panic(err2) } utils.EnableDebugLogForTest() }