mirror of
https://github.com/mattermost/mattermost.git
synced 2025-02-25 18:55:24 -06:00
Add some tests for plugin hooks used by MS Teams plugin automute (#26144)
* Confirm that plugins can trigger their own PreferencesHaveChanged hook * Add tests for ChannelHasBeenCreated hook * Convert new tests to use assert.Eventually * Add tests for UserHasJoinedChannel hook * Bypass linter for a case where t.Fatal is needed
This commit is contained in:
Harrison Healey
GitHub
parent
3bf8574b0d
commit
4ac345cc56
@ -12,6 +12,7 @@ import (
|
||||
"net/http/httptest"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"sync"
|
||||
"testing"
|
||||
"time"
|
||||
@ -1708,4 +1709,421 @@ func TestHookPreferencesHaveChanged(t *testing.T) {
|
||||
mockAPI.AssertCalled(t, "LogDebug", "category=test_category name=test_name_1 value=test_value_1")
|
||||
mockAPI.AssertCalled(t, "LogDebug", "category=test_category name=test_name_2 value=test_value_2")
|
||||
})
|
||||
|
||||
t.Run("should be called when preferences are changed by plugin code", func(t *testing.T) {
|
||||
th := Setup(t).InitBasic()
|
||||
defer th.TearDown()
|
||||
|
||||
// Setup plugin
|
||||
pluginCode := `
|
||||
package main
|
||||
|
||||
import (
|
||||
"github.com/mattermost/mattermost/server/public/plugin"
|
||||
"github.com/mattermost/mattermost/server/public/model"
|
||||
)
|
||||
|
||||
const (
|
||||
userID = "` + th.BasicUser.Id + `"
|
||||
)
|
||||
|
||||
type MyPlugin struct {
|
||||
plugin.MattermostPlugin
|
||||
}
|
||||
|
||||
func (p *MyPlugin) PreferencesHaveChanged(c *plugin.Context, preferences []model.Preference) {
|
||||
// Note that plugin hooks can trigger themselves, and this test sets a preference to trigger that
|
||||
// it has run, so be careful not to introduce an infinite loop here
|
||||
|
||||
if len(preferences) == 1 && preferences[0].Category == "test_category" && preferences[0].Name == "test_name" {
|
||||
if preferences[0].Value == "test_value_first" {
|
||||
appErr := p.API.UpdatePreferencesForUser(userID, []model.Preference{
|
||||
{
|
||||
UserId: userID,
|
||||
Category: "test_category",
|
||||
Name: "test_name",
|
||||
Value: "test_value_second",
|
||||
},
|
||||
})
|
||||
if appErr != nil {
|
||||
panic("error setting preference to second value")
|
||||
}
|
||||
} else if preferences[0].Value == "test_value_second" {
|
||||
appErr := p.API.UpdatePreferencesForUser(userID, []model.Preference{
|
||||
{
|
||||
UserId: userID,
|
||||
Category: "test_category",
|
||||
Name: "test_name",
|
||||
Value: "test_value_third",
|
||||
},
|
||||
})
|
||||
if appErr != nil {
|
||||
panic("error setting preference to third value")
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func main() {
|
||||
plugin.ClientMain(&MyPlugin{})
|
||||
}
|
||||
`
|
||||
pluginID := "testplugin"
|
||||
pluginManifest := `{"id": "testplugin", "server": {"executable": "backend.exe"}}`
|
||||
|
||||
setupPluginAPITest(t, pluginCode, pluginManifest, pluginID, th.App, th.Context)
|
||||
|
||||
// Confirm plugin is actually running
|
||||
require.True(t, th.App.GetPluginsEnvironment().IsActive(pluginID))
|
||||
|
||||
appErr := th.App.UpdatePreferences(th.Context, th.BasicUser.Id, model.Preferences{
|
||||
{
|
||||
UserId: th.BasicUser.Id,
|
||||
Category: "test_category",
|
||||
Name: "test_name",
|
||||
Value: "test_value_first",
|
||||
},
|
||||
})
|
||||
require.Nil(t, appErr)
|
||||
|
||||
assert.EventuallyWithT(t, func(t *assert.CollectT) {
|
||||
preference, appErr := th.App.GetPreferenceByCategoryAndNameForUser(th.Context, th.BasicUser.Id, "test_category", "test_name")
|
||||
|
||||
require.Nil(t, appErr)
|
||||
assert.Equal(t, "test_value_third", preference.Value)
|
||||
}, 1*time.Second, 10*time.Millisecond)
|
||||
})
|
||||
}
|
||||
|
||||
func TestChannelHasBeenCreated(t *testing.T) {
|
||||
getPluginCode := func(th *TestHelper) string {
|
||||
return `
|
||||
package main
|
||||
|
||||
import (
|
||||
"github.com/mattermost/mattermost/server/public/plugin"
|
||||
"github.com/mattermost/mattermost/server/public/model"
|
||||
)
|
||||
|
||||
const (
|
||||
adminUserID = "` + th.SystemAdminUser.Id + `"
|
||||
)
|
||||
|
||||
type MyPlugin struct {
|
||||
plugin.MattermostPlugin
|
||||
}
|
||||
|
||||
func (p *MyPlugin) ChannelHasBeenCreated(c *plugin.Context, channel *model.Channel) {
|
||||
_, appErr := p.API.CreatePost(&model.Post{
|
||||
UserId: adminUserID,
|
||||
ChannelId: channel.Id,
|
||||
Message: "ChannelHasBeenCreated has been called for " + channel.Id,
|
||||
})
|
||||
if appErr != nil {
|
||||
panic(appErr)
|
||||
}
|
||||
}
|
||||
|
||||
func main() {
|
||||
plugin.ClientMain(&MyPlugin{})
|
||||
}
|
||||
`
|
||||
}
|
||||
pluginID := "testplugin"
|
||||
pluginManifest := `{"id": "testplugin", "server": {"executable": "backend.exe"}}`
|
||||
|
||||
t.Run("should call hook when a regular channel is created", func(t *testing.T) {
|
||||
th := Setup(t).InitBasic()
|
||||
defer th.TearDown()
|
||||
|
||||
// Setup plugin
|
||||
setupPluginAPITest(t, getPluginCode(th), pluginManifest, pluginID, th.App, th.Context)
|
||||
|
||||
user1 := th.CreateUser()
|
||||
|
||||
channel, appErr := th.App.CreateChannel(th.Context, &model.Channel{
|
||||
CreatorId: user1.Id,
|
||||
TeamId: th.BasicTeam.Id,
|
||||
Name: "test_channel",
|
||||
Type: model.ChannelTypeOpen,
|
||||
}, false)
|
||||
require.Nil(t, appErr)
|
||||
require.NotNil(t, channel)
|
||||
|
||||
assert.EventuallyWithT(t, func(t *assert.CollectT) {
|
||||
posts, appErr := th.App.GetPosts(channel.Id, 0, 1)
|
||||
|
||||
require.Nil(t, appErr)
|
||||
|
||||
post := posts.Posts[posts.Order[0]]
|
||||
assert.Equal(t, channel.Id, post.ChannelId)
|
||||
assert.Equal(t, "ChannelHasBeenCreated has been called for "+channel.Id, post.Message)
|
||||
}, 1*time.Second, 10*time.Millisecond)
|
||||
})
|
||||
|
||||
t.Run("should call hook when a DM is created", func(t *testing.T) {
|
||||
th := Setup(t).InitBasic()
|
||||
defer th.TearDown()
|
||||
|
||||
// Setup plugin
|
||||
setupPluginAPITest(t, getPluginCode(th), pluginManifest, pluginID, th.App, th.Context)
|
||||
|
||||
user1 := th.CreateUser()
|
||||
user2 := th.CreateUser()
|
||||
|
||||
channel, appErr := th.App.GetOrCreateDirectChannel(th.Context, user1.Id, user2.Id)
|
||||
require.Nil(t, appErr)
|
||||
require.NotNil(t, channel)
|
||||
|
||||
assert.EventuallyWithT(t, func(t *assert.CollectT) {
|
||||
posts, appErr := th.App.GetPosts(channel.Id, 0, 1)
|
||||
|
||||
require.Nil(t, appErr)
|
||||
|
||||
post := posts.Posts[posts.Order[0]]
|
||||
assert.Equal(t, channel.Id, post.ChannelId)
|
||||
assert.Equal(t, "ChannelHasBeenCreated has been called for "+channel.Id, post.Message)
|
||||
}, 1*time.Second, 10*time.Millisecond)
|
||||
})
|
||||
|
||||
t.Run("should call hook when a GM is created", func(t *testing.T) {
|
||||
t.Skip("Currently broken due to MM-56776")
|
||||
|
||||
th := Setup(t).InitBasic()
|
||||
defer th.TearDown()
|
||||
|
||||
// Setup plugin
|
||||
setupPluginAPITest(t, getPluginCode(th), pluginManifest, pluginID, th.App, th.Context)
|
||||
|
||||
user1 := th.CreateUser()
|
||||
user2 := th.CreateUser()
|
||||
user3 := th.CreateUser()
|
||||
|
||||
channel, appErr := th.App.CreateGroupChannel(th.Context, []string{user1.Id, user2.Id, user3.Id}, user1.Id)
|
||||
require.Nil(t, appErr)
|
||||
require.NotNil(t, channel)
|
||||
|
||||
assert.EventuallyWithT(t, func(t *assert.CollectT) {
|
||||
posts, appErr := th.App.GetPosts(channel.Id, 0, 1)
|
||||
|
||||
require.Nil(t, appErr)
|
||||
|
||||
post := posts.Posts[posts.Order[0]]
|
||||
assert.Equal(t, channel.Id, post.ChannelId)
|
||||
assert.Equal(t, "ChannelHasBeenCreated has been called for "+channel.Id, post.Message)
|
||||
}, 1*time.Second, 10*time.Millisecond)
|
||||
})
|
||||
}
|
||||
|
||||
func TestUserHasJoinedChannel(t *testing.T) {
|
||||
getPluginCode := func(th *TestHelper) string {
|
||||
return `
|
||||
package main
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
"github.com/mattermost/mattermost/server/public/plugin"
|
||||
"github.com/mattermost/mattermost/server/public/model"
|
||||
)
|
||||
|
||||
const (
|
||||
adminUserID = "` + th.SystemAdminUser.Id + `"
|
||||
)
|
||||
|
||||
type MyPlugin struct {
|
||||
plugin.MattermostPlugin
|
||||
}
|
||||
|
||||
func (p *MyPlugin) UserHasJoinedChannel(c *plugin.Context, channelMember *model.ChannelMember, actor *model.User) {
|
||||
message := fmt.Sprintf("Test: User %s joined %s", channelMember.UserId, channelMember.ChannelId)
|
||||
if actor != nil && actor.Id != channelMember.UserId {
|
||||
message = fmt.Sprintf("Test: User %s added to %s by %s", channelMember.UserId, channelMember.ChannelId, actor.Id)
|
||||
}
|
||||
|
||||
_, appErr := p.API.CreatePost(&model.Post{
|
||||
UserId: adminUserID,
|
||||
ChannelId: channelMember.ChannelId,
|
||||
Message: message,
|
||||
})
|
||||
if appErr != nil {
|
||||
panic(appErr)
|
||||
}
|
||||
}
|
||||
|
||||
func main() {
|
||||
plugin.ClientMain(&MyPlugin{})
|
||||
}
|
||||
`
|
||||
}
|
||||
pluginID := "testplugin"
|
||||
pluginManifest := `{"id": "testplugin", "server": {"executable": "backend.exe"}}`
|
||||
|
||||
t.Run("should call hook when a user joins an existing channel", func(t *testing.T) {
|
||||
th := Setup(t).InitBasic()
|
||||
defer th.TearDown()
|
||||
|
||||
user1 := th.CreateUser()
|
||||
th.LinkUserToTeam(user1, th.BasicTeam)
|
||||
user2 := th.CreateUser()
|
||||
th.LinkUserToTeam(user2, th.BasicTeam)
|
||||
|
||||
channel, appErr := th.App.CreateChannel(th.Context, &model.Channel{
|
||||
CreatorId: user1.Id,
|
||||
TeamId: th.BasicTeam.Id,
|
||||
Name: "test_channel",
|
||||
Type: model.ChannelTypeOpen,
|
||||
}, false)
|
||||
require.Nil(t, appErr)
|
||||
require.NotNil(t, channel)
|
||||
|
||||
// Setup plugin after creating the channel
|
||||
setupPluginAPITest(t, getPluginCode(th), pluginManifest, pluginID, th.App, th.Context)
|
||||
|
||||
_, appErr = th.App.AddChannelMember(th.Context, user2.Id, channel, ChannelMemberOpts{
|
||||
UserRequestorID: user2.Id,
|
||||
})
|
||||
require.Nil(t, appErr)
|
||||
|
||||
assert.EventuallyWithT(t, func(t *assert.CollectT) {
|
||||
posts, appErr := th.App.GetPosts(channel.Id, 0, 1)
|
||||
|
||||
require.Nil(t, appErr)
|
||||
|
||||
assert.Equal(t, fmt.Sprintf("Test: User %s joined %s", user2.Id, channel.Id), posts.Posts[posts.Order[0]].Message)
|
||||
}, 1*time.Second, 10*time.Millisecond)
|
||||
})
|
||||
|
||||
t.Run("should call hook when a user is added to an existing channel", func(t *testing.T) {
|
||||
th := Setup(t).InitBasic()
|
||||
defer th.TearDown()
|
||||
|
||||
user1 := th.CreateUser()
|
||||
th.LinkUserToTeam(user1, th.BasicTeam)
|
||||
user2 := th.CreateUser()
|
||||
th.LinkUserToTeam(user2, th.BasicTeam)
|
||||
|
||||
channel, appErr := th.App.CreateChannel(th.Context, &model.Channel{
|
||||
CreatorId: user1.Id,
|
||||
TeamId: th.BasicTeam.Id,
|
||||
Name: "test_channel",
|
||||
Type: model.ChannelTypeOpen,
|
||||
}, false)
|
||||
require.Nil(t, appErr)
|
||||
require.NotNil(t, channel)
|
||||
|
||||
// Setup plugin after creating the channel
|
||||
setupPluginAPITest(t, getPluginCode(th), pluginManifest, pluginID, th.App, th.Context)
|
||||
|
||||
_, appErr = th.App.AddChannelMember(th.Context, user2.Id, channel, ChannelMemberOpts{
|
||||
UserRequestorID: user1.Id,
|
||||
})
|
||||
require.Nil(t, appErr)
|
||||
|
||||
assert.EventuallyWithT(t, func(t *assert.CollectT) {
|
||||
posts, appErr := th.App.GetPosts(channel.Id, 0, 1)
|
||||
|
||||
require.Nil(t, appErr)
|
||||
|
||||
assert.Equal(t, fmt.Sprintf("Test: User %s added to %s by %s", user2.Id, channel.Id, user1.Id), posts.Posts[posts.Order[0]].Message)
|
||||
}, 1*time.Second, 10*time.Millisecond)
|
||||
})
|
||||
|
||||
t.Run("should not call hook when a regular channel is created", func(t *testing.T) {
|
||||
th := Setup(t).InitBasic()
|
||||
defer th.TearDown()
|
||||
|
||||
// Setup plugin
|
||||
setupPluginAPITest(t, getPluginCode(th), pluginManifest, pluginID, th.App, th.Context)
|
||||
|
||||
user1 := th.CreateUser()
|
||||
|
||||
channel, appErr := th.App.CreateChannel(th.Context, &model.Channel{
|
||||
CreatorId: user1.Id,
|
||||
TeamId: th.BasicTeam.Id,
|
||||
Name: "test_channel",
|
||||
Type: model.ChannelTypeOpen,
|
||||
}, false)
|
||||
require.Nil(t, appErr)
|
||||
require.NotNil(t, channel)
|
||||
|
||||
// Wait for async plugin hooks to be run
|
||||
time.Sleep(time.Second / 2)
|
||||
|
||||
posts, appErr := th.App.GetPosts(channel.Id, 0, 10)
|
||||
|
||||
require.Nil(t, appErr)
|
||||
|
||||
for _, postID := range posts.Order {
|
||||
post := posts.Posts[postID]
|
||||
|
||||
if strings.HasPrefix(post.Message, "Test: ") {
|
||||
t.Log("Plugin message found:", post.Message)
|
||||
t.FailNow()
|
||||
}
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("should not call hook when a DM is created", func(t *testing.T) {
|
||||
th := Setup(t).InitBasic()
|
||||
defer th.TearDown()
|
||||
|
||||
// Setup plugin
|
||||
setupPluginAPITest(t, getPluginCode(th), pluginManifest, pluginID, th.App, th.Context)
|
||||
|
||||
user1 := th.CreateUser()
|
||||
user2 := th.CreateUser()
|
||||
|
||||
channel, appErr := th.App.GetOrCreateDirectChannel(th.Context, user1.Id, user2.Id)
|
||||
require.Nil(t, appErr)
|
||||
require.NotNil(t, channel)
|
||||
|
||||
// Wait for async plugin hooks to be run
|
||||
time.Sleep(time.Second / 2)
|
||||
|
||||
posts, appErr := th.App.GetPosts(channel.Id, 0, 10)
|
||||
|
||||
require.Nil(t, appErr)
|
||||
|
||||
for _, postID := range posts.Order {
|
||||
post := posts.Posts[postID]
|
||||
|
||||
if strings.HasPrefix(post.Message, "Test: ") {
|
||||
t.Log("Plugin message found:", post.Message)
|
||||
t.FailNow()
|
||||
}
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("should not call hook when a GM is created", func(t *testing.T) {
|
||||
th := Setup(t).InitBasic()
|
||||
defer th.TearDown()
|
||||
|
||||
// Setup plugin
|
||||
setupPluginAPITest(t, getPluginCode(th), pluginManifest, pluginID, th.App, th.Context)
|
||||
|
||||
user1 := th.CreateUser()
|
||||
user2 := th.CreateUser()
|
||||
user3 := th.CreateUser()
|
||||
|
||||
channel, appErr := th.App.CreateGroupChannel(th.Context, []string{user1.Id, user2.Id, user3.Id}, user1.Id)
|
||||
require.Nil(t, appErr)
|
||||
require.NotNil(t, channel)
|
||||
|
||||
// Wait for async plugin hooks to be run
|
||||
time.Sleep(time.Second / 2)
|
||||
|
||||
posts, appErr := th.App.GetPosts(channel.Id, 0, 10)
|
||||
|
||||
require.Nil(t, appErr)
|
||||
|
||||
for _, postID := range posts.Order {
|
||||
post := posts.Posts[postID]
|
||||
|
||||
if strings.HasPrefix(post.Message, "Test: ") {
|
||||
t.Log("Plugin message found:", post.Message)
|
||||
t.FailNow()
|
||||
}
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
Loading…
Reference in New Issue
Block a user