GH-10438 - Rewrite existing plugin API tests to exclusively te… (#13302)

app/plugin_api_tests/basic_config.go

@@ -0,0 +1,47 @@
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+
+package plugin_api_tests
+
+import "reflect"
+
+type BasicConfig struct {
+	BasicChannelId       string
+	BasicChannelName     string
+	BasicPostId          string
+	BasicPostMessage     string
+	BasicTeamDisplayName string
+	BasicTeamId          string
+	BasicTeamName        string
+	BasicUser2Email      string
+	BasicUser2Id         string
+	BasicUserEmail       string
+	BasicUserId          string
+}
+
+func IsEmpty(object interface{}) bool {
+
+	// get nil case out of the way
+	if object == nil {
+		return true
+	}
+
+	objValue := reflect.ValueOf(object)
+
+	switch objValue.Kind() {
+	// collection types are empty when they have no element
+	case reflect.Array, reflect.Chan, reflect.Map, reflect.Slice:
+		return objValue.Len() == 0
+	// pointers are empty if nil or if the value they point to is empty
+	case reflect.Ptr:
+		if objValue.IsNil() {
+			return true
+		}
+		deref := objValue.Elem().Interface()
+		return IsEmpty(deref)
+	// for all other types, compare against the zero value
+	default:
+		zero := reflect.Zero(objValue.Type())
+		return reflect.DeepEqual(object, zero.Interface())
+	}
+}

app/plugin_api_tests/manual.test_load_configuration_defaults_plugin/main.go

@@ -0,0 +1,48 @@
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+
+package main
+
+import (
+	"github.com/mattermost/mattermost-server/v5/app/plugin_api_tests"
+	"github.com/mattermost/mattermost-server/v5/model"
+	"github.com/mattermost/mattermost-server/v5/plugin"
+)
+
+type configuration struct {
+	plugin_api_tests.BasicConfig
+	MyStringSetting string
+	MyIntSetting    int
+	MyBoolSetting   bool
+}
+
+type MyPlugin struct {
+	plugin.MattermostPlugin
+
+	configuration configuration
+}
+
+func (p *MyPlugin) OnConfigurationChange() error {
+	if err := p.API.LoadPluginConfiguration(&p.configuration); err != nil {
+		return err
+	}
+
+	return nil
+}
+
+func (p *MyPlugin) MessageWillBePosted(c *plugin.Context, post *model.Post) (*model.Post, string) {
+	if p.configuration.MyStringSetting != "override" {
+		return nil, "MyStringSetting has invalid value"
+	}
+	if p.configuration.MyIntSetting != 35 {
+		return nil, "MyIntSetting has invalid value"
+	}
+	if !p.configuration.MyBoolSetting {
+		return nil, "MyBoolSetting has invalid value"
+	}
+	return nil, "OK"
+}
+
+func main() {
+	plugin.ClientMain(&MyPlugin{})
+}

app/plugin_api_tests/manual.test_load_configuration_plugin/main.go

@@ -0,0 +1,51 @@
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+
+package main
+
+import (
+	"fmt"
+
+	"github.com/mattermost/mattermost-server/v5/app/plugin_api_tests"
+	"github.com/mattermost/mattermost-server/v5/model"
+	"github.com/mattermost/mattermost-server/v5/plugin"
+)
+
+type configuration struct {
+	plugin_api_tests.BasicConfig
+
+	MyStringSetting string
+	MyIntSetting    int
+	MyBoolSetting   bool
+}
+
+type MyPlugin struct {
+	plugin.MattermostPlugin
+
+	configuration configuration
+}
+
+func (p *MyPlugin) OnConfigurationChange() error {
+	if err := p.API.LoadPluginConfiguration(&p.configuration); err != nil {
+		return err
+	}
+
+	return nil
+}
+
+func (p *MyPlugin) MessageWillBePosted(c *plugin.Context, post *model.Post) (*model.Post, string) {
+	if p.configuration.MyStringSetting != "str" {
+		return nil, "MyStringSetting has invalid value"
+	}
+	if p.configuration.MyIntSetting != 32 {
+		return nil, fmt.Sprintf("MyIntSetting has invalid value %v != %v", p.configuration.MyIntSetting, 32)
+	}
+	if !p.configuration.MyBoolSetting {
+		return nil, "MyBoolSetting has invalid value"
+	}
+	return nil, "OK"
+}
+
+func main() {
+	plugin.ClientMain(&MyPlugin{})
+}

app/plugin_api_tests/test_bots_plugin/main.go

@@ -0,0 +1,130 @@
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+
+package main
+
+import (
+	"github.com/mattermost/mattermost-server/v5/app/plugin_api_tests"
+	"github.com/mattermost/mattermost-server/v5/model"
+	"github.com/mattermost/mattermost-server/v5/plugin"
+)
+
+type MyPlugin struct {
+	plugin.MattermostPlugin
+	configuration plugin_api_tests.BasicConfig
+}
+
+func (p *MyPlugin) OnConfigurationChange() error {
+	if err := p.API.LoadPluginConfiguration(&p.configuration); err != nil {
+		return err
+	}
+	return nil
+}
+
+func (p *MyPlugin) MessageWillBePosted(c *plugin.Context, post *model.Post) (*model.Post, string) {
+	createdBot, err := p.API.CreateBot(&model.Bot{
+		Username:    "bot",
+		Description: "a plugin bot",
+	})
+
+	if err != nil {
+		return nil, err.Error() + "failed to create bot"
+	}
+
+	fetchedBot, err := p.API.GetBot(createdBot.UserId, false)
+	if err != nil {
+		return nil, err.Error() + "failed to get bot"
+	}
+	if fetchedBot.Description != "a plugin bot" {
+		return nil, "GetBot did not return the expected bot Description"
+	}
+	if fetchedBot.OwnerId != "test_bots_plugin" {
+		return nil, "GetBot did not return the expected bot OwnerId"
+	}
+
+	updatedDescription := createdBot.Description + ", updated"
+	patchedBot, err := p.API.PatchBot(createdBot.UserId, &model.BotPatch{
+		Description: &updatedDescription,
+	})
+	if err != nil {
+		return nil, err.Error() + "failed to patch bot"
+	}
+
+	fetchedBot, err = p.API.GetBot(patchedBot.UserId, false)
+	if err != nil {
+		return nil, err.Error() + "failed to get bot"
+	}
+
+	if fetchedBot.UserId != patchedBot.UserId {
+		return nil, "GetBot did not return the expected bot"
+	}
+	if fetchedBot.Description != "a plugin bot, updated" {
+		return nil, "GetBot did not return the updated bot Description"
+	}
+
+	fetchedBots, err := p.API.GetBots(&model.BotGetOptions{
+		Page:           0,
+		PerPage:        1,
+		OwnerId:        "",
+		IncludeDeleted: false,
+	})
+	if err != nil {
+		return nil, err.Error() + "failed to get bots"
+	}
+
+	if len(fetchedBots) != 1 {
+		return nil, "GetBots did not return a single bot"
+	}
+
+	if fetchedBot.UserId != fetchedBots[0].UserId {
+		return nil, "GetBots did not return the expected bot"
+	}
+	if _, err = p.API.UpdateBotActive(fetchedBot.UserId, false); err != nil {
+		return nil, err.Error() + "failed to disable bot"
+	}
+
+	// TODO: investigate why the following code panics
+	/*
+		if fetchedBot, err = p.API.GetBot(patchedBot.UserId, false); err == nil {
+			return nil, "expected not to find disabled bot"
+		}
+		if _, err = p.API.UpdateBotActive(fetchedBot.UserId, true); err != nil {
+			return nil, err.Error() + "failed to disable bot"
+		}
+		if fetchedBot, err = p.API.GetBot(patchedBot.UserId, false); err != nil {
+			return nil, err.Error() + "failed to get bot after enabling"
+		}
+		if fetchedBot.UserId != patchedBot.UserId {
+			return nil, "GetBot did not return the expected bot after enabling"
+		}
+		if err = p.API.PermanentDeleteBot(patchedBot.UserId); err != nil {
+			return nil, err.Error() + "failed to delete bot"
+		}
+
+		if _, err = p.API.GetBot(patchedBot.UserId, false); err == nil {
+			return nil, err.Error() + "found bot after permanently deleting"
+		}
+		createdBotWithOverriddenCreator, err := p.API.CreateBot(&model.Bot{
+			Username:    "bot",
+			Description: "a plugin bot",
+			OwnerId:     "abc123",
+		})
+		if err != nil {
+			return nil, err.Error() + "failed to create bot with overridden creator"
+		}
+		if fetchedBot, err = p.API.GetBot(createdBotWithOverriddenCreator.UserId, false); err != nil {
+			return nil, err.Error() + "failed to get bot"
+		}
+		if fetchedBot.Description != "a plugin bot" {
+			return nil, "GetBot did not return the expected bot Description"
+		}
+		if fetchedBot.OwnerId != "abc123" {
+			return nil, "GetBot did not return the expected bot OwnerId"
+		}
+	*/
+	return nil, "OK"
+}
+
+func main() {
+	plugin.ClientMain(&MyPlugin{})
+}

app/plugin_api_tests/test_call_log_api_plugin/main.go

@@ -0,0 +1,30 @@
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+
+package main
+
+import (
+	"github.com/mattermost/mattermost-server/v5/model"
+	"github.com/mattermost/mattermost-server/v5/plugin"
+	"github.com/pkg/errors"
+)
+
+type PluginUsingLogAPI struct {
+	plugin.MattermostPlugin
+}
+
+type Foo struct {
+	bar float64
+}
+
+func main() {
+	plugin.ClientMain(&PluginUsingLogAPI{})
+}
+
+func (p *PluginUsingLogAPI) MessageWillBePosted(c *plugin.Context, post *model.Post) (*model.Post, string) {
+	p.API.LogDebug("LogDebug", "one", 1, "two", "two", "foo", Foo{bar: 3.1416})
+	p.API.LogInfo("LogInfo", "one", 1, "two", "two", "foo", Foo{bar: 3.1416})
+	p.API.LogWarn("LogWarn", "one", 1, "two", "two", "foo", Foo{bar: 3.1416})
+	p.API.LogError("LogError", "error", errors.WithStack(errors.New("boom!")))
+	return nil, "OK"
+}

app/plugin_api_tests/test_get_bundle_path_plugin/main.go

@@ -0,0 +1,40 @@
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+
+package main
+
+import (
+	"fmt"
+	"path/filepath"
+
+	"github.com/mattermost/mattermost-server/v5/app/plugin_api_tests"
+	"github.com/mattermost/mattermost-server/v5/model"
+	"github.com/mattermost/mattermost-server/v5/plugin"
+)
+
+type MyPlugin struct {
+	plugin.MattermostPlugin
+	configuration plugin_api_tests.BasicConfig
+}
+
+func (p *MyPlugin) OnConfigurationChange() error {
+	if err := p.API.LoadPluginConfiguration(&p.configuration); err != nil {
+		return err
+	}
+	return nil
+}
+
+func (p *MyPlugin) MessageWillBePosted(c *plugin.Context, post *model.Post) (*model.Post, string) {
+	bundlePath, err := p.API.GetBundlePath()
+	if err != nil {
+		return nil, err.Error() + "failed get bundle path"
+	} else if bundlePathFromConfig, _ := filepath.Abs(filepath.Join(*p.API.GetConfig().PluginSettings.Directory, "test_get_bundle_path_plugin")); bundlePathFromConfig != bundlePath {
+		return nil, fmt.Sprintf("Invalid bundle path returned: %v vs %v", bundlePathFromConfig, bundlePath)
+	}
+
+	return nil, "OK"
+}
+
+func main() {
+	plugin.ClientMain(&MyPlugin{})
+}

app/plugin_api_tests/test_get_channels_for_team_for_user_plugin/main.go

@@ -0,0 +1,45 @@
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+
+package main
+
+import (
+	"github.com/mattermost/mattermost-server/v5/app/plugin_api_tests"
+	"github.com/mattermost/mattermost-server/v5/model"
+	"github.com/mattermost/mattermost-server/v5/plugin"
+)
+
+type MyPlugin struct {
+	plugin.MattermostPlugin
+	configuration plugin_api_tests.BasicConfig
+}
+
+func (p *MyPlugin) OnConfigurationChange() error {
+	if err := p.API.LoadPluginConfiguration(&p.configuration); err != nil {
+		return err
+	}
+	return nil
+}
+
+func (p *MyPlugin) MessageWillBePosted(c *plugin.Context, post *model.Post) (*model.Post, string) {
+
+	channels, err := p.API.GetChannelsForTeamForUser(p.configuration.BasicTeamId, p.configuration.BasicUserId, false)
+	if err != nil {
+		return nil, err.Error()
+	}
+	if len(channels) != 3 {
+		return nil, "Returned invalid number of channels"
+	}
+	channels, err = p.API.GetChannelsForTeamForUser("invalidid", p.configuration.BasicUserId, false)
+	if err == nil {
+		return nil, "Expected to get an error while retrieving channels for invalid id"
+	}
+	if len(channels) != 0 {
+		return nil, "Returned invalid number of channels"
+	}
+	return nil, "OK"
+}
+
+func main() {
+	plugin.ClientMain(&MyPlugin{})
+}

app/plugin_api_tests/test_get_direct_channel_plugin/main.go

@@ -0,0 +1,53 @@
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+
+package main
+
+import (
+	"github.com/mattermost/mattermost-server/v5/app/plugin_api_tests"
+	"github.com/mattermost/mattermost-server/v5/model"
+	"github.com/mattermost/mattermost-server/v5/plugin"
+)
+
+type MyPlugin struct {
+	plugin.MattermostPlugin
+	configuration plugin_api_tests.BasicConfig
+}
+
+func (p *MyPlugin) OnConfigurationChange() error {
+	if err := p.API.LoadPluginConfiguration(&p.configuration); err != nil {
+		return err
+	}
+	return nil
+}
+
+func (p *MyPlugin) MessageWillBePosted(c *plugin.Context, post *model.Post) (*model.Post, string) {
+	dm1, err := p.API.GetDirectChannel(p.configuration.BasicUserId, p.configuration.BasicUser2Id)
+	if err != nil {
+		return nil, err.Error()
+	}
+	if plugin_api_tests.IsEmpty(dm1) {
+		return nil, "dm1 is empty"
+	}
+
+	dm2, err := p.API.GetDirectChannel(p.configuration.BasicUserId, p.configuration.BasicUserId)
+	if err != nil {
+		return nil, err.Error()
+	}
+	if plugin_api_tests.IsEmpty(dm2) {
+		return nil, "dm2 is empty"
+	}
+
+	dm3, err := p.API.GetDirectChannel(p.configuration.BasicUserId, model.NewId())
+	if err == nil {
+		return nil, "Expected to get error while fetching incorrect channel"
+	}
+	if !plugin_api_tests.IsEmpty(dm3) {
+		return nil, "dm3 is NOT empty"
+	}
+	return nil, "OK"
+}
+
+func main() {
+	plugin.ClientMain(&MyPlugin{})
+}

app/plugin_api_tests/test_get_profile_image_plugin/main.go

@@ -0,0 +1,45 @@
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+
+package main
+
+import (
+	"github.com/mattermost/mattermost-server/v5/app/plugin_api_tests"
+	"github.com/mattermost/mattermost-server/v5/model"
+	"github.com/mattermost/mattermost-server/v5/plugin"
+)
+
+type MyPlugin struct {
+	plugin.MattermostPlugin
+	configuration plugin_api_tests.BasicConfig
+}
+
+func (p *MyPlugin) OnConfigurationChange() error {
+	if err := p.API.LoadPluginConfiguration(&p.configuration); err != nil {
+		return err
+	}
+	return nil
+}
+
+func (p *MyPlugin) MessageWillBePosted(c *plugin.Context, post *model.Post) (*model.Post, string) {
+
+	// check existing user first
+	data, err := p.API.GetProfileImage(p.configuration.BasicUserId)
+	if err != nil {
+		return nil, err.Error()
+	}
+	if plugin_api_tests.IsEmpty(data) {
+		return nil, "GetProfileImage return empty"
+	}
+
+	// then unknown user
+	data, err = p.API.GetProfileImage(model.NewId())
+	if err == nil || data != nil {
+		return nil, "GetProfileImage should've returned an error"
+	}
+	return nil, "OK"
+}
+
+func main() {
+	plugin.ClientMain(&MyPlugin{})
+}

app/plugin_api_tests/test_member_channels_plugin/main.go

@@ -0,0 +1,40 @@
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+
+package main
+
+import (
+	"github.com/mattermost/mattermost-server/v5/app/plugin_api_tests"
+	"github.com/mattermost/mattermost-server/v5/model"
+	"github.com/mattermost/mattermost-server/v5/plugin"
+)
+
+type MyPlugin struct {
+	plugin.MattermostPlugin
+	configuration plugin_api_tests.BasicConfig
+}
+
+func (p *MyPlugin) OnConfigurationChange() error {
+	if err := p.API.LoadPluginConfiguration(&p.configuration); err != nil {
+		return err
+	}
+	return nil
+}
+
+func (p *MyPlugin) MessageWillBePosted(c *plugin.Context, post *model.Post) (*model.Post, string) {
+	channelMembers, err := p.API.GetChannelMembersForUser(p.configuration.BasicTeamId, p.configuration.BasicUserId, 0, 10)
+
+	if err != nil {
+		return nil, err.Error() + "failed to get channel members"
+	} else if len(channelMembers) != 3 {
+		return nil, "Invalid number of channel members"
+	} else if channelMembers[0].UserId != p.configuration.BasicUserId {
+		return nil, "Invalid user id returned"
+	}
+
+	return nil, "OK"
+}
+
+func main() {
+	plugin.ClientMain(&MyPlugin{})
+}

app/plugin_api_tests/test_members_plugin/main.go

@@ -0,0 +1,38 @@
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+
+package main
+
+import (
+	"github.com/mattermost/mattermost-server/v5/app/plugin_api_tests"
+	"github.com/mattermost/mattermost-server/v5/model"
+	"github.com/mattermost/mattermost-server/v5/plugin"
+)
+
+type MyPlugin struct {
+	plugin.MattermostPlugin
+	configuration plugin_api_tests.BasicConfig
+}
+
+func (p *MyPlugin) OnConfigurationChange() error {
+	if err := p.API.LoadPluginConfiguration(&p.configuration); err != nil {
+		return err
+	}
+	return nil
+}
+
+func (p *MyPlugin) MessageWillBePosted(c *plugin.Context, post *model.Post) (*model.Post, string) {
+	teamMembers, err := p.API.GetTeamMembersForUser(p.configuration.BasicUserId, 0, 10)
+	if err != nil {
+		return nil, err.Error() + "failed to get team members"
+	} else if len(teamMembers) != 1 {
+		return nil, "Invalid number of team members"
+	} else if teamMembers[0].UserId != p.configuration.BasicUserId || teamMembers[0].TeamId != p.configuration.BasicTeamId {
+		return nil, "Invalid user or team id returned"
+	}
+	return nil, "OK"
+}
+
+func main() {
+	plugin.ClientMain(&MyPlugin{})
+}

app/plugin_api_tests/test_search_channels_plugin/main.go

@@ -0,0 +1,47 @@
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+
+package main
+
+import (
+	"github.com/mattermost/mattermost-server/v5/app/plugin_api_tests"
+	"github.com/mattermost/mattermost-server/v5/model"
+	"github.com/mattermost/mattermost-server/v5/plugin"
+)
+
+type MyPlugin struct {
+	plugin.MattermostPlugin
+	configuration plugin_api_tests.BasicConfig
+}
+
+func (p *MyPlugin) OnConfigurationChange() error {
+	if err := p.API.LoadPluginConfiguration(&p.configuration); err != nil {
+		return err
+	}
+	return nil
+}
+
+func (p *MyPlugin) MessageWillBePosted(c *plugin.Context, post *model.Post) (*model.Post, string) {
+
+	channels, err := p.API.SearchChannels(p.configuration.BasicTeamId, p.configuration.BasicChannelName)
+	if err != nil {
+		return nil, err.Error()
+	}
+	if len(channels) != 1 {
+		return nil, "Returned invalid number of channels"
+	}
+
+	channels, err = p.API.SearchChannels("invalidid", p.configuration.BasicChannelName)
+	if err != nil {
+		return nil, err.Error()
+	}
+	if len(channels) != 0 {
+		return nil, "Returned invalid number of channels"
+	}
+
+	return nil, "OK"
+}
+
+func main() {
+	plugin.ClientMain(&MyPlugin{})
+}

app/plugin_api_tests/test_search_posts_in_team_plugin/main.go

@@ -0,0 +1,73 @@
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+
+package main
+
+import (
+	"fmt"
+
+	"github.com/mattermost/mattermost-server/v5/app/plugin_api_tests"
+	"github.com/mattermost/mattermost-server/v5/model"
+	"github.com/mattermost/mattermost-server/v5/plugin"
+)
+
+type MyPlugin struct {
+	plugin.MattermostPlugin
+	configuration plugin_api_tests.BasicConfig
+}
+
+func (p *MyPlugin) OnConfigurationChange() error {
+	if err := p.API.LoadPluginConfiguration(&p.configuration); err != nil {
+		return err
+	}
+	return nil
+}
+
+func (p *MyPlugin) MessageWillBePosted(c *plugin.Context, post *model.Post) (*model.Post, string) {
+	testCases := []struct {
+		description      string
+		teamID           string
+		params           []*model.SearchParams
+		expectedPostsLen int
+	}{
+		{
+			"nil params",
+			p.configuration.BasicTeamId,
+			nil,
+			0,
+		},
+		{
+			"empty params",
+			p.configuration.BasicTeamId,
+			[]*model.SearchParams{},
+			0,
+		},
+		{
+			"doesn't match any posts",
+			p.configuration.BasicTeamId,
+			model.ParseSearchParams("bad message", 0),
+			0,
+		},
+		{
+			"matched posts",
+			p.configuration.BasicTeamId,
+			model.ParseSearchParams(p.configuration.BasicPostMessage, 0),
+			1,
+		},
+	}
+
+	for _, testCase := range testCases {
+		posts, err := p.API.SearchPostsInTeam(testCase.teamID, testCase.params)
+		if err != nil {
+			return nil, fmt.Sprintf("%v: %v", testCase.description, err.Error())
+		}
+		if testCase.expectedPostsLen != len(posts) {
+			return nil, fmt.Sprintf("%v: invalid number of posts: %v != %v", testCase.description, testCase.expectedPostsLen, len(posts))
+		}
+	}
+	return nil, "OK"
+}
+
+func main() {
+	plugin.ClientMain(&MyPlugin{})
+}

app/plugin_api_tests/test_search_teams_plugin/main.go

@@ -0,0 +1,64 @@
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+
+package main
+
+import (
+	"fmt"
+
+	"github.com/mattermost/mattermost-server/v5/app/plugin_api_tests"
+	"github.com/mattermost/mattermost-server/v5/model"
+	"github.com/mattermost/mattermost-server/v5/plugin"
+)
+
+type MyPlugin struct {
+	plugin.MattermostPlugin
+	configuration plugin_api_tests.BasicConfig
+}
+
+func (p *MyPlugin) OnConfigurationChange() error {
+	if err := p.API.LoadPluginConfiguration(&p.configuration); err != nil {
+		return err
+	}
+	return nil
+}
+
+func (p *MyPlugin) MessageWillBePosted(c *plugin.Context, post *model.Post) (*model.Post, string) {
+	teams, err := p.API.SearchTeams(p.configuration.BasicTeamName)
+	if err != nil {
+		return nil, "search failed: " + err.Message
+	}
+	if len(teams) != 1 {
+		return nil, fmt.Sprintf("search failed, wrong number of teams: %v", len(teams))
+	}
+
+	teams, err = p.API.SearchTeams(p.configuration.BasicTeamDisplayName)
+	if err != nil {
+		return nil, "search failed: " + err.Message
+	}
+	if len(teams) != 1 {
+		return nil, fmt.Sprintf("search failed, wrong number of teams: %v", len(teams))
+	}
+
+	teams, err = p.API.SearchTeams(p.configuration.BasicTeamName[:3])
+
+	if err != nil {
+		return nil, "search failed: " + err.Message
+	}
+	if len(teams) != 1 {
+		return nil, fmt.Sprintf("search failed, wrong number of teams: %v", len(teams))
+	}
+
+	teams, err = p.API.SearchTeams("not found")
+	if err != nil {
+		return nil, "search failed: " + err.Message
+	}
+	if len(teams) != 0 {
+		return nil, fmt.Sprintf("search failed, wrong number of teams: %v", len(teams))
+	}
+	return nil, "OK"
+}
+
+func main() {
+	plugin.ClientMain(&MyPlugin{})
+}

app/plugin_api_tests/test_send_mail_plugin/main.go

@@ -0,0 +1,68 @@
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+
+package main
+
+import (
+	"fmt"
+	"strings"
+
+	"github.com/mattermost/mattermost-server/v5/app/plugin_api_tests"
+	"github.com/mattermost/mattermost-server/v5/model"
+	"github.com/mattermost/mattermost-server/v5/plugin"
+	"github.com/mattermost/mattermost-server/v5/services/mailservice"
+)
+
+type MyPlugin struct {
+	plugin.MattermostPlugin
+	configuration plugin_api_tests.BasicConfig
+}
+
+func (p *MyPlugin) OnConfigurationChange() error {
+	if err := p.API.LoadPluginConfiguration(&p.configuration); err != nil {
+		return err
+	}
+	return nil
+}
+
+func (p *MyPlugin) MessageWillBePosted(c *plugin.Context, post *model.Post) (*model.Post, string) {
+	to := p.configuration.BasicUserEmail
+	subject := "testing plugin api sending email"
+	body := "this is a test."
+
+	if err := p.API.SendMail(to, subject, body); err != nil {
+		return nil, err.Error()
+	}
+
+	// Check if we received the email
+	var resultsMailbox mailservice.JSONMessageHeaderInbucket
+	if errMail := mailservice.RetryInbucket(5, func() error {
+		var err error
+		resultsMailbox, err = mailservice.GetMailBox(to)
+		return err
+	}); errMail != nil {
+		return nil, errMail.Error()
+	}
+	if len(resultsMailbox) == 0 {
+		return nil, fmt.Sprintf("No mailbox results. Should be %v", len(resultsMailbox))
+	}
+	if !strings.ContainsAny(resultsMailbox[len(resultsMailbox)-1].To[0], to) {
+		return nil, "Result doesn't contain recipient"
+	}
+
+	resultsEmail, err1 := mailservice.GetMessageFromMailbox(to, resultsMailbox[len(resultsMailbox)-1].ID)
+	if err1 != nil {
+		return nil, err1.Error()
+	}
+	if resultsEmail.Subject != subject {
+		return nil, fmt.Sprintf("subject differs: %v vs %s", resultsEmail.Subject, subject)
+	}
+	if resultsEmail.Body.Text != body {
+		return nil, fmt.Sprintf("body differs: %v vs %s", resultsEmail.Body.Text, body)
+	}
+	return nil, "OK"
+}
+
+func main() {
+	plugin.ClientMain(&MyPlugin{})
+}

app/plugin_api_tests/test_set_profile_image_plugin/main.go

@@ -0,0 +1,71 @@
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+
+package main
+
+import (
+	"bytes"
+	"fmt"
+	"image"
+	"image/color"
+	"image/png"
+
+	"github.com/mattermost/mattermost-server/v5/app/plugin_api_tests"
+	"github.com/mattermost/mattermost-server/v5/model"
+	"github.com/mattermost/mattermost-server/v5/plugin"
+)
+
+type MyPlugin struct {
+	plugin.MattermostPlugin
+	configuration plugin_api_tests.BasicConfig
+}
+
+func (p *MyPlugin) OnConfigurationChange() error {
+	if err := p.API.LoadPluginConfiguration(&p.configuration); err != nil {
+		return err
+	}
+	return nil
+}
+
+func (p *MyPlugin) MessageWillBePosted(c *plugin.Context, post *model.Post) (*model.Post, string) {
+
+	// Create an 128 x 128 image
+	img := image.NewRGBA(image.Rect(0, 0, 128, 128))
+	// Draw a red dot at (2, 3)
+	img.Set(2, 3, color.RGBA{255, 0, 0, 255})
+	buf := new(bytes.Buffer)
+	if err := png.Encode(buf, img); err != nil {
+		return nil, err.Error()
+	}
+
+	dataBytes := buf.Bytes()
+
+	// Set the user profile image
+	if err := p.API.SetProfileImage(p.configuration.BasicUserId, dataBytes); err != nil {
+		return nil, err.Error()
+	}
+
+	// Get the user profile image to check
+	imageProfile, err := p.API.GetProfileImage(p.configuration.BasicUserId)
+	if err != nil {
+		return nil, err.Error()
+	}
+	if plugin_api_tests.IsEmpty(imageProfile) {
+		return nil, "profile image is empty"
+	}
+
+	colorful := color.NRGBA{255, 0, 0, 255}
+	byteReader := bytes.NewReader(imageProfile)
+	img2, _, err2 := image.Decode(byteReader)
+	if err2 != nil {
+		return nil, err.Error()
+	}
+	if img2.At(2, 3) != colorful {
+		return nil, fmt.Sprintf("color mismatch %v != %v", img2.At(2, 3), colorful)
+	}
+	return nil, "OK"
+}
+
+func main() {
+	plugin.ClientMain(&MyPlugin{})
+}

app/plugin_api_tests/test_update_user_active_plugin/main.go

@@ -0,0 +1,77 @@
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+
+package main
+
+import (
+	"github.com/mattermost/mattermost-server/v5/app/plugin_api_tests"
+	"github.com/mattermost/mattermost-server/v5/model"
+	"github.com/mattermost/mattermost-server/v5/plugin"
+)
+
+type MyPlugin struct {
+	plugin.MattermostPlugin
+	configuration plugin_api_tests.BasicConfig
+}
+
+func (p *MyPlugin) OnConfigurationChange() error {
+	if err := p.API.LoadPluginConfiguration(&p.configuration); err != nil {
+		return err
+	}
+	return nil
+}
+
+func (p *MyPlugin) MessageWillBePosted(c *plugin.Context, post *model.Post) (*model.Post, string) {
+	uid := p.configuration.BasicUserId
+	if err := p.API.UpdateUserActive(uid, true); err != nil {
+		return nil, err.Error()
+	}
+
+	user, err := p.API.GetUser(uid)
+	if err != nil {
+		return nil, err.Error()
+	}
+
+	if int64(0) != user.DeleteAt {
+		return nil, "DeleteAt value is not 0"
+	}
+
+	if err = p.API.UpdateUserActive(uid, false); err != nil {
+		return nil, err.Error()
+	}
+
+	user, err = p.API.GetUser(uid)
+	if err != nil {
+		return nil, err.Error()
+	}
+	if user == nil {
+		return nil, "GetUser returned nil"
+	}
+
+	if int64(0) == user.DeleteAt {
+		return nil, "DeleteAt value is 0"
+	}
+
+	if err = p.API.UpdateUserActive(uid, true); err != nil {
+		return nil, err.Error()
+	}
+
+	if err = p.API.UpdateUserActive(uid, true); err != nil {
+		return nil, err.Error()
+	}
+
+	user, err = p.API.GetUser(uid)
+	if err != nil {
+		return nil, err.Error()
+	}
+
+	if int64(0) != user.DeleteAt {
+		return nil, "DeleteAt value is not 0"
+	}
+
+	return nil, "OK"
+}
+
+func main() {
+	plugin.ClientMain(&MyPlugin{})
+}

app/plugin_api_tests/test_update_user_status_plugin/main.go

@@ -0,0 +1,58 @@
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+
+package main
+
+import (
+	"fmt"
+
+	"github.com/mattermost/mattermost-server/v5/app/plugin_api_tests"
+	"github.com/mattermost/mattermost-server/v5/model"
+	"github.com/mattermost/mattermost-server/v5/plugin"
+)
+
+type MyPlugin struct {
+	plugin.MattermostPlugin
+	configuration plugin_api_tests.BasicConfig
+}
+
+func (p *MyPlugin) OnConfigurationChange() error {
+	if err := p.API.LoadPluginConfiguration(&p.configuration); err != nil {
+		return err
+	}
+	return nil
+}
+
+func (p *MyPlugin) MessageWillBePosted(c *plugin.Context, post *model.Post) (*model.Post, string) {
+	uid := p.configuration.BasicUserId
+
+	statuses := []string{model.STATUS_ONLINE, model.STATUS_AWAY, model.STATUS_DND, model.STATUS_OFFLINE}
+
+	for _, s := range statuses {
+		status, err := p.API.UpdateUserStatus(uid, s)
+		if err != nil {
+			return nil, err.Error()
+		}
+		if status == nil {
+			return nil, "Status was expected, got nil"
+		}
+		if s != status.Status {
+			return nil, fmt.Sprintf("Invalid status returned: %v != %v", s, status.Status)
+		}
+
+	}
+
+	status, err := p.API.UpdateUserStatus(uid, "notrealstatus")
+	if err == nil {
+		return nil, "Expected to get an error while updating invalid user status"
+	}
+	if status != nil {
+		return nil, "Status was expected to be nil, got: " + status.Status
+	}
+
+	return nil, "OK"
+}
+
+func main() {
+	plugin.ClientMain(&MyPlugin{})
+}