123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704 |
- // Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
- // See LICENSE.txt for license information.
- package api4
- import (
- "bytes"
- "encoding/base64"
- "encoding/json"
- "fmt"
- "io/ioutil"
- "net/http"
- "net/http/httptest"
- "os"
- "path/filepath"
- "sort"
- "strings"
- "testing"
- "time"
- "github.com/mattermost/mattermost-server/v5/model"
- "github.com/mattermost/mattermost-server/v5/plugin"
- "github.com/mattermost/mattermost-server/v5/testlib"
- "github.com/mattermost/mattermost-server/v5/utils"
- "github.com/mattermost/mattermost-server/v5/utils/fileutils"
- svg "github.com/h2non/go-is-svg"
- "github.com/stretchr/testify/assert"
- "github.com/stretchr/testify/require"
- )
- func TestPlugin(t *testing.T) {
- th := Setup(t)
- defer th.TearDown()
- th.TestForSystemAdminAndLocal(t, func(t *testing.T, client *model.Client4) {
- statesJson, err := json.Marshal(th.App.Config().PluginSettings.PluginStates)
- require.Nil(t, err)
- states := map[string]*model.PluginState{}
- json.Unmarshal(statesJson, &states)
- th.App.UpdateConfig(func(cfg *model.Config) {
- *cfg.PluginSettings.Enable = true
- *cfg.PluginSettings.EnableUploads = true
- *cfg.PluginSettings.AllowInsecureDownloadUrl = true
- })
- path, _ := fileutils.FindDir("tests")
- tarData, err := ioutil.ReadFile(filepath.Join(path, "testplugin.tar.gz"))
- require.NoError(t, err)
- // Install from URL
- testServer := httptest.NewServer(http.HandlerFunc(func(res http.ResponseWriter, req *http.Request) {
- res.WriteHeader(http.StatusOK)
- res.Write(tarData)
- }))
- defer func() { testServer.Close() }()
- url := testServer.URL
- manifest, resp := client.InstallPluginFromUrl(url, false)
- CheckNoError(t, resp)
- assert.Equal(t, "testplugin", manifest.Id)
- _, resp = client.InstallPluginFromUrl(url, false)
- CheckBadRequestStatus(t, resp)
- manifest, resp = client.InstallPluginFromUrl(url, true)
- CheckNoError(t, resp)
- assert.Equal(t, "testplugin", manifest.Id)
- // Stored in File Store: Install Plugin from URL case
- pluginStored, err := th.App.FileExists("./plugins/" + manifest.Id + ".tar.gz")
- assert.Nil(t, err)
- assert.True(t, pluginStored)
- ok, resp := client.RemovePlugin(manifest.Id)
- CheckNoError(t, resp)
- require.True(t, ok)
- t.Run("install plugin from URL with slow response time", func(t *testing.T) {
- if testing.Short() {
- t.Skip("skipping test to install plugin from a slow response server")
- }
- // Install from URL - slow server to simulate longer bundle download times
- slowTestServer := httptest.NewServer(http.HandlerFunc(func(res http.ResponseWriter, req *http.Request) {
- time.Sleep(60 * time.Second) // Wait longer than the previous default 30 seconds timeout
- res.WriteHeader(http.StatusOK)
- res.Write(tarData)
- }))
- defer func() { slowTestServer.Close() }()
- manifest, resp = client.InstallPluginFromUrl(slowTestServer.URL, true)
- CheckNoError(t, resp)
- assert.Equal(t, "testplugin", manifest.Id)
- })
- th.App.RemovePlugin(manifest.Id)
- th.App.UpdateConfig(func(cfg *model.Config) { *cfg.PluginSettings.Enable = false })
- _, resp = client.InstallPluginFromUrl(url, false)
- CheckNotImplementedStatus(t, resp)
- th.App.UpdateConfig(func(cfg *model.Config) { *cfg.PluginSettings.Enable = true })
- _, resp = th.Client.InstallPluginFromUrl(url, false)
- CheckForbiddenStatus(t, resp)
- _, resp = client.InstallPluginFromUrl("http://nodata", false)
- CheckBadRequestStatus(t, resp)
- th.App.UpdateConfig(func(cfg *model.Config) { *cfg.PluginSettings.AllowInsecureDownloadUrl = false })
- _, resp = client.InstallPluginFromUrl(url, false)
- CheckBadRequestStatus(t, resp)
- // Successful upload
- manifest, resp = client.UploadPlugin(bytes.NewReader(tarData))
- CheckNoError(t, resp)
- th.App.UpdateConfig(func(cfg *model.Config) { *cfg.PluginSettings.EnableUploads = true })
- manifest, resp = client.UploadPluginForced(bytes.NewReader(tarData))
- defer os.RemoveAll("plugins/testplugin")
- CheckNoError(t, resp)
- assert.Equal(t, "testplugin", manifest.Id)
- // Stored in File Store: Upload Plugin case
- pluginStored, err = th.App.FileExists("./plugins/" + manifest.Id + ".tar.gz")
- assert.Nil(t, err)
- assert.True(t, pluginStored)
- // Upload error cases
- _, resp = client.UploadPlugin(bytes.NewReader([]byte("badfile")))
- CheckBadRequestStatus(t, resp)
- th.App.UpdateConfig(func(cfg *model.Config) { *cfg.PluginSettings.Enable = false })
- _, resp = client.UploadPlugin(bytes.NewReader(tarData))
- CheckNotImplementedStatus(t, resp)
- th.App.UpdateConfig(func(cfg *model.Config) {
- *cfg.PluginSettings.Enable = true
- *cfg.PluginSettings.EnableUploads = false
- })
- _, resp = client.UploadPlugin(bytes.NewReader(tarData))
- CheckNotImplementedStatus(t, resp)
- _, resp = client.InstallPluginFromUrl(url, false)
- CheckNotImplementedStatus(t, resp)
- th.App.UpdateConfig(func(cfg *model.Config) { *cfg.PluginSettings.EnableUploads = true })
- _, resp = th.Client.UploadPlugin(bytes.NewReader(tarData))
- CheckForbiddenStatus(t, resp)
- // Successful gets
- pluginsResp, resp := client.GetPlugins()
- CheckNoError(t, resp)
- found := false
- for _, m := range pluginsResp.Inactive {
- if m.Id == manifest.Id {
- found = true
- }
- }
- assert.True(t, found)
- found = false
- for _, m := range pluginsResp.Active {
- if m.Id == manifest.Id {
- found = true
- }
- }
- assert.False(t, found)
- // Successful activate
- ok, resp = client.EnablePlugin(manifest.Id)
- CheckNoError(t, resp)
- assert.True(t, ok)
- pluginsResp, resp = client.GetPlugins()
- CheckNoError(t, resp)
- found = false
- for _, m := range pluginsResp.Active {
- if m.Id == manifest.Id {
- found = true
- }
- }
- assert.True(t, found)
- // Activate error case
- ok, resp = client.EnablePlugin("junk")
- CheckNotFoundStatus(t, resp)
- assert.False(t, ok)
- ok, resp = client.EnablePlugin("JUNK")
- CheckNotFoundStatus(t, resp)
- assert.False(t, ok)
- // Successful deactivate
- ok, resp = client.DisablePlugin(manifest.Id)
- CheckNoError(t, resp)
- assert.True(t, ok)
- pluginsResp, resp = client.GetPlugins()
- CheckNoError(t, resp)
- found = false
- for _, m := range pluginsResp.Inactive {
- if m.Id == manifest.Id {
- found = true
- }
- }
- assert.True(t, found)
- // Deactivate error case
- ok, resp = client.DisablePlugin("junk")
- CheckNotFoundStatus(t, resp)
- assert.False(t, ok)
- // Get error cases
- th.App.UpdateConfig(func(cfg *model.Config) { *cfg.PluginSettings.Enable = false })
- _, resp = client.GetPlugins()
- CheckNotImplementedStatus(t, resp)
- th.App.UpdateConfig(func(cfg *model.Config) { *cfg.PluginSettings.Enable = true })
- _, resp = th.Client.GetPlugins()
- CheckForbiddenStatus(t, resp)
- // Successful webapp get
- _, resp = client.EnablePlugin(manifest.Id)
- CheckNoError(t, resp)
- manifests, resp := th.Client.GetWebappPlugins()
- CheckNoError(t, resp)
- found = false
- for _, m := range manifests {
- if m.Id == manifest.Id {
- found = true
- }
- }
- assert.True(t, found)
- // Successful remove
- ok, resp = client.RemovePlugin(manifest.Id)
- CheckNoError(t, resp)
- assert.True(t, ok)
- // Remove error cases
- ok, resp = client.RemovePlugin(manifest.Id)
- CheckNotFoundStatus(t, resp)
- assert.False(t, ok)
- th.App.UpdateConfig(func(cfg *model.Config) { *cfg.PluginSettings.Enable = false })
- _, resp = client.RemovePlugin(manifest.Id)
- CheckNotImplementedStatus(t, resp)
- th.App.UpdateConfig(func(cfg *model.Config) { *cfg.PluginSettings.Enable = true })
- _, resp = th.Client.RemovePlugin(manifest.Id)
- CheckForbiddenStatus(t, resp)
- _, resp = client.RemovePlugin("bad.id")
- CheckNotFoundStatus(t, resp)
- })
- }
- func TestNotifyClusterPluginEvent(t *testing.T) {
- th := Setup(t)
- defer th.TearDown()
- testCluster := &testlib.FakeClusterInterface{}
- th.Server.Cluster = testCluster
- th.App.UpdateConfig(func(cfg *model.Config) {
- *cfg.PluginSettings.Enable = true
- *cfg.PluginSettings.EnableUploads = true
- })
- path, _ := fileutils.FindDir("tests")
- tarData, err := ioutil.ReadFile(filepath.Join(path, "testplugin.tar.gz"))
- require.NoError(t, err)
- testCluster.ClearMessages()
- // Successful upload
- manifest, resp := th.SystemAdminClient.UploadPlugin(bytes.NewReader(tarData))
- CheckNoError(t, resp)
- require.Equal(t, "testplugin", manifest.Id)
- // Stored in File Store: Upload Plugin case
- expectedPath := filepath.Join("./plugins", manifest.Id) + ".tar.gz"
- pluginStored, err := th.App.FileExists(expectedPath)
- require.Nil(t, err)
- require.True(t, pluginStored)
- messages := testCluster.GetMessages()
- expectedPluginData := model.PluginEventData{
- Id: manifest.Id,
- }
- expectedInstallMessage := &model.ClusterMessage{
- Event: model.CLUSTER_EVENT_INSTALL_PLUGIN,
- SendType: model.CLUSTER_SEND_RELIABLE,
- WaitForAllToSend: true,
- Data: expectedPluginData.ToJson(),
- }
- actualMessages := findClusterMessages(model.CLUSTER_EVENT_INSTALL_PLUGIN, messages)
- require.Equal(t, []*model.ClusterMessage{expectedInstallMessage}, actualMessages)
- // Upgrade
- testCluster.ClearMessages()
- manifest, resp = th.SystemAdminClient.UploadPluginForced(bytes.NewReader(tarData))
- CheckNoError(t, resp)
- require.Equal(t, "testplugin", manifest.Id)
- // Successful remove
- webSocketClient, err := th.CreateWebSocketSystemAdminClient()
- require.Nil(t, err)
- webSocketClient.Listen()
- defer webSocketClient.Close()
- done := make(chan bool)
- go func() {
- for {
- select {
- case resp := <-webSocketClient.EventChannel:
- if resp.EventType() == model.WEBSOCKET_EVENT_PLUGIN_STATUSES_CHANGED && len(resp.GetData()["plugin_statuses"].([]interface{})) == 0 {
- done <- true
- return
- }
- case <-time.After(5 * time.Second):
- done <- false
- return
- }
- }
- }()
- testCluster.ClearMessages()
- ok, resp := th.SystemAdminClient.RemovePlugin(manifest.Id)
- CheckNoError(t, resp)
- require.True(t, ok)
- result := <-done
- require.True(t, result, "plugin_statuses_changed websocket event was not received")
- messages = testCluster.GetMessages()
- expectedRemoveMessage := &model.ClusterMessage{
- Event: model.CLUSTER_EVENT_REMOVE_PLUGIN,
- SendType: model.CLUSTER_SEND_RELIABLE,
- WaitForAllToSend: true,
- Data: expectedPluginData.ToJson(),
- }
- actualMessages = findClusterMessages(model.CLUSTER_EVENT_REMOVE_PLUGIN, messages)
- require.Equal(t, []*model.ClusterMessage{expectedRemoveMessage}, actualMessages)
- pluginStored, err = th.App.FileExists(expectedPath)
- require.Nil(t, err)
- require.False(t, pluginStored)
- }
- func TestDisableOnRemove(t *testing.T) {
- path, _ := fileutils.FindDir("tests")
- tarData, err := ioutil.ReadFile(filepath.Join(path, "testplugin.tar.gz"))
- require.NoError(t, err)
- testCases := []struct {
- Description string
- Upgrade bool
- }{
- {
- "Remove without upgrading",
- false,
- },
- {
- "Remove after upgrading",
- true,
- },
- }
- th := Setup(t).InitBasic()
- defer th.TearDown()
- for _, tc := range testCases {
- t.Run(tc.Description, func(t *testing.T) {
- th.TestForSystemAdminAndLocal(t, func(t *testing.T, client *model.Client4) {
- th.App.UpdateConfig(func(cfg *model.Config) {
- *cfg.PluginSettings.Enable = true
- *cfg.PluginSettings.EnableUploads = true
- })
- // Upload
- manifest, resp := client.UploadPlugin(bytes.NewReader(tarData))
- CheckNoError(t, resp)
- require.Equal(t, "testplugin", manifest.Id)
- // Check initial status
- pluginsResp, resp := client.GetPlugins()
- CheckNoError(t, resp)
- require.Empty(t, pluginsResp.Active)
- require.Equal(t, pluginsResp.Inactive, []*model.PluginInfo{{
- Manifest: *manifest,
- }})
- // Enable plugin
- ok, resp := client.EnablePlugin(manifest.Id)
- CheckNoError(t, resp)
- require.True(t, ok)
- // Confirm enabled status
- pluginsResp, resp = client.GetPlugins()
- CheckNoError(t, resp)
- require.Empty(t, pluginsResp.Inactive)
- require.Equal(t, pluginsResp.Active, []*model.PluginInfo{{
- Manifest: *manifest,
- }})
- if tc.Upgrade {
- // Upgrade
- manifest, resp = client.UploadPluginForced(bytes.NewReader(tarData))
- CheckNoError(t, resp)
- require.Equal(t, "testplugin", manifest.Id)
- // Plugin should remain active
- pluginsResp, resp = client.GetPlugins()
- CheckNoError(t, resp)
- require.Empty(t, pluginsResp.Inactive)
- require.Equal(t, pluginsResp.Active, []*model.PluginInfo{{
- Manifest: *manifest,
- }})
- }
- // Remove plugin
- ok, resp = client.RemovePlugin(manifest.Id)
- CheckNoError(t, resp)
- require.True(t, ok)
- // Plugin should have no status
- pluginsResp, resp = client.GetPlugins()
- CheckNoError(t, resp)
- require.Empty(t, pluginsResp.Inactive)
- require.Empty(t, pluginsResp.Active)
- // Upload same plugin
- manifest, resp = client.UploadPlugin(bytes.NewReader(tarData))
- CheckNoError(t, resp)
- require.Equal(t, "testplugin", manifest.Id)
- // Plugin should be inactive
- pluginsResp, resp = client.GetPlugins()
- CheckNoError(t, resp)
- require.Empty(t, pluginsResp.Active)
- require.Equal(t, pluginsResp.Inactive, []*model.PluginInfo{{
- Manifest: *manifest,
- }})
- // Clean up
- ok, resp = client.RemovePlugin(manifest.Id)
- CheckNoError(t, resp)
- require.True(t, ok)
- })
- })
- }
- }
- func TestGetMarketplacePlugins(t *testing.T) {
- th := Setup(t)
- defer th.TearDown()
- th.App.UpdateConfig(func(cfg *model.Config) {
- *cfg.PluginSettings.Enable = true
- *cfg.PluginSettings.EnableUploads = true
- *cfg.PluginSettings.EnableMarketplace = false
- })
- t.Run("marketplace disabled", func(t *testing.T) {
- th.App.UpdateConfig(func(cfg *model.Config) {
- *cfg.PluginSettings.EnableMarketplace = false
- *cfg.PluginSettings.MarketplaceUrl = "invalid.com"
- })
- plugins, resp := th.SystemAdminClient.GetMarketplacePlugins(&model.MarketplacePluginFilter{})
- CheckNotImplementedStatus(t, resp)
- require.Nil(t, plugins)
- })
- t.Run("no server", func(t *testing.T) {
- th.App.UpdateConfig(func(cfg *model.Config) {
- *cfg.PluginSettings.EnableMarketplace = true
- *cfg.PluginSettings.MarketplaceUrl = "invalid.com"
- })
- plugins, resp := th.SystemAdminClient.GetMarketplacePlugins(&model.MarketplacePluginFilter{})
- CheckInternalErrorStatus(t, resp)
- require.Nil(t, plugins)
- })
- t.Run("no permission", func(t *testing.T) {
- th.App.UpdateConfig(func(cfg *model.Config) {
- *cfg.PluginSettings.EnableMarketplace = true
- *cfg.PluginSettings.MarketplaceUrl = "invalid.com"
- })
- plugins, resp := th.Client.GetMarketplacePlugins(&model.MarketplacePluginFilter{})
- CheckForbiddenStatus(t, resp)
- require.Nil(t, plugins)
- })
- t.Run("empty response from server", func(t *testing.T) {
- testServer := httptest.NewServer(http.HandlerFunc(func(res http.ResponseWriter, req *http.Request) {
- res.WriteHeader(http.StatusOK)
- json, err := json.Marshal([]*model.MarketplacePlugin{})
- require.NoError(t, err)
- res.Write(json)
- }))
- defer func() { testServer.Close() }()
- th.App.UpdateConfig(func(cfg *model.Config) {
- *cfg.PluginSettings.EnableMarketplace = true
- *cfg.PluginSettings.MarketplaceUrl = testServer.URL
- })
- plugins, resp := th.SystemAdminClient.GetMarketplacePlugins(&model.MarketplacePluginFilter{})
- CheckNoError(t, resp)
- require.Empty(t, plugins)
- })
- t.Run("verify server version is passed through", func(t *testing.T) {
- testServer := httptest.NewServer(http.HandlerFunc(func(res http.ResponseWriter, req *http.Request) {
- serverVersion, ok := req.URL.Query()["server_version"]
- require.True(t, ok)
- require.Len(t, serverVersion, 1)
- require.Equal(t, model.CurrentVersion, serverVersion[0])
- require.NotEqual(t, 0, len(serverVersion[0]))
- res.WriteHeader(http.StatusOK)
- json, err := json.Marshal([]*model.MarketplacePlugin{})
- require.NoError(t, err)
- res.Write(json)
- }))
- defer func() { testServer.Close() }()
- th.App.UpdateConfig(func(cfg *model.Config) {
- *cfg.PluginSettings.EnableMarketplace = true
- *cfg.PluginSettings.MarketplaceUrl = testServer.URL
- })
- plugins, resp := th.SystemAdminClient.GetMarketplacePlugins(&model.MarketplacePluginFilter{})
- CheckNoError(t, resp)
- require.Empty(t, plugins)
- })
- t.Run("verify EnterprisePlugins is false for TE", func(t *testing.T) {
- testServer := httptest.NewServer(http.HandlerFunc(func(res http.ResponseWriter, req *http.Request) {
- licenseType, ok := req.URL.Query()["enterprise_plugins"]
- require.True(t, ok)
- require.Len(t, licenseType, 1)
- require.Equal(t, "false", licenseType[0])
- res.WriteHeader(http.StatusOK)
- json, err := json.Marshal([]*model.MarketplacePlugin{})
- require.NoError(t, err)
- res.Write(json)
- }))
- defer func() { testServer.Close() }()
- th.App.UpdateConfig(func(cfg *model.Config) {
- *cfg.PluginSettings.EnableMarketplace = true
- *cfg.PluginSettings.MarketplaceUrl = testServer.URL
- })
- plugins, resp := th.SystemAdminClient.GetMarketplacePlugins(&model.MarketplacePluginFilter{})
- CheckNoError(t, resp)
- require.Empty(t, plugins)
- })
- t.Run("verify EnterprisePlugins is false for E10", func(t *testing.T) {
- testServer := httptest.NewServer(http.HandlerFunc(func(res http.ResponseWriter, req *http.Request) {
- licenseType, ok := req.URL.Query()["enterprise_plugins"]
- require.True(t, ok)
- require.Len(t, licenseType, 1)
- require.Equal(t, "false", licenseType[0])
- res.WriteHeader(http.StatusOK)
- json, err := json.Marshal([]*model.MarketplacePlugin{})
- require.NoError(t, err)
- res.Write(json)
- }))
- defer func() { testServer.Close() }()
- th.App.UpdateConfig(func(cfg *model.Config) {
- *cfg.PluginSettings.EnableMarketplace = true
- *cfg.PluginSettings.MarketplaceUrl = testServer.URL
- })
- l := model.NewTestLicense()
- // model.NewTestLicense generates a E20 license
- *l.Features.EnterprisePlugins = false
- th.App.Srv().SetLicense(l)
- plugins, resp := th.SystemAdminClient.GetMarketplacePlugins(&model.MarketplacePluginFilter{})
- CheckNoError(t, resp)
- require.Empty(t, plugins)
- })
- t.Run("verify EnterprisePlugins is false for E20", func(t *testing.T) {
- testServer := httptest.NewServer(http.HandlerFunc(func(res http.ResponseWriter, req *http.Request) {
- licenseType, ok := req.URL.Query()["enterprise_plugins"]
- require.True(t, ok)
- require.Len(t, licenseType, 1)
- require.Equal(t, "true", licenseType[0])
- res.WriteHeader(http.StatusOK)
- json, err := json.Marshal([]*model.MarketplacePlugin{})
- require.NoError(t, err)
- res.Write(json)
- }))
- defer func() { testServer.Close() }()
- th.App.UpdateConfig(func(cfg *model.Config) {
- *cfg.PluginSettings.EnableMarketplace = true
- *cfg.PluginSettings.MarketplaceUrl = testServer.URL
- })
- th.App.Srv().SetLicense(model.NewTestLicense("enterprise_plugins"))
- plugins, resp := th.SystemAdminClient.GetMarketplacePlugins(&model.MarketplacePluginFilter{})
- CheckNoError(t, resp)
- require.Empty(t, plugins)
- })
- }
- func TestGetInstalledMarketplacePlugins(t *testing.T) {
- samplePlugins := []*model.MarketplacePlugin{
- {
- BaseMarketplacePlugin: &model.BaseMarketplacePlugin{
- HomepageURL: "https://example.com/mattermost/mattermost-plugin-nps",
- IconData: "https://example.com/icon.svg",
- DownloadURL: "https://example.com/mattermost/mattermost-plugin-nps/releases/download/v1.0.4/com.mattermost.nps-1.0.4.tar.gz",
- Labels: []model.MarketplaceLabel{
- {
- Name: "someName",
- Description: "some Description",
- },
- },
- Manifest: &model.Manifest{
- Id: "com.mattermost.nps",
- Name: "User Satisfaction Surveys",
- Description: "This plugin sends quarterly user satisfaction surveys to gather feedback and help improve Mattermost.",
- Version: "1.0.4",
- MinServerVersion: "5.14.0",
- },
- },
- InstalledVersion: "",
- },
- }
- path, _ := fileutils.FindDir("tests")
- tarData, err := ioutil.ReadFile(filepath.Join(path, "testplugin.tar.gz"))
- require.NoError(t, err)
- t.Run("marketplace client returns not-installed plugin", func(t *testing.T) {
- th := Setup(t)
- defer th.TearDown()
- testServer := httptest.NewServer(http.HandlerFunc(func(res http.ResponseWriter, req *http.Request) {
- res.WriteHeader(http.StatusOK)
- json, err := json.Marshal(samplePlugins)
- require.NoError(t, err)
- res.Write(json)
- }))
- defer func() { testServer.Close() }()
- th.App.UpdateConfig(func(cfg *model.Config) {
- *cfg.PluginSettings.Enable = true
- *cfg.PluginSettings.EnableUploads = true
- *cfg.PluginSettings.EnableMarketplace = true
- *cfg.PluginSettings.MarketplaceUrl = testServer.URL
- })
- plugins, resp := th.SystemAdminClient.GetMarketplacePlugins(&model.MarketplacePluginFilter{})
- CheckNoError(t, resp)
- require.Equal(t, samplePlugins, plugins)
- manifest, resp := th.SystemAdminClient.UploadPlugin(bytes.NewReader(tarData))
- CheckNoError(t, resp)
- testIcon, err := ioutil.ReadFile(filepath.Join(path, "test.svg"))
- require.NoError(t, err)
- require.True(t, svg.Is(testIcon))
- testIconData := fmt.Sprintf("data:image/svg+xml;base64,%s", base64.StdEncoding.EncodeToString(testIcon))
- expectedPlugins := append(samplePlugins, &model.MarketplacePlugin{
- BaseMarketplacePlugin: &model.BaseMarketplacePlugin{
- HomepageURL: "https://example.com/homepage",
- IconData: testIconData,
- DownloadURL: "",
- ReleaseNotesURL: "https://example.com/releases/v0.0.1",
- Labels: []model.MarketplaceLabel{{
- Name: "Local",
- Description: "This plugin is not listed in the marketplace",
- }},
- Manifest: manifest,
- },
- InstalledVersion: manifest.Version,
- })
- sort.SliceStable(expectedPlugins, func(i, j int) bool {
- return strings.ToLower(expectedPlugins[i].Manifest.Name) < strings.ToLower(expectedPlugins[j].Manifest.Name)
- })
- plugins, resp = th.SystemAdminClient.GetMarketplacePlugins(&model.MarketplacePluginFilter{})
- CheckNoError(t, resp)
- require.Equal(t, expectedPlugins, plugins)
- ok, resp := th.SystemAdminClient.RemovePlugin(manifest.Id)
- CheckNoError(t, resp)
- assert.True(t, ok)
- plugins, resp = th.SystemAdminClient.GetMarketplacePlugins(&model.MarketplacePluginFilter{})
- CheckNoError(t, resp)
- require.Equal(t, samplePlugins, plugins)
- })
- t.Run("marketplace client returns installed plugin", func(t *testing.T) {
- th := Setup(t)
- defer th.TearDown()
- th.App.UpdateConfig(func(cfg *model.Config) {
- *cfg.PluginSettings.Enable = true
- *cfg.PluginSettings.EnableUploads = true
- *cfg.PluginSettings.EnableMarketplace = true
- })
- manifest, resp := th.SystemAdminClient.UploadPlugin(bytes.NewReader(tarData))
- CheckNoError(t, resp)
- newPlugin := &model.MarketplacePlugin{
- BaseMarketplacePlugin: &model.BaseMarketplacePlugin{
- HomepageURL: "HomepageURL",
- IconData: "IconData",
- DownloadURL: "DownloadURL",
- Manifest: manifest,
- },
- InstalledVersion: manifest.Version,
- }
- expectedPlugins := append(samplePlugins, newPlugin)
- sort.SliceStable(expectedPlugins, func(i, j int) bool {
- return strings.ToLower(expectedPlugins[i].Manifest.Name) < strings.ToLower(expectedPlugins[j].Manifest.Name)
- })
- testServer := httptest.NewServer(http.HandlerFunc(func(res http.ResponseWriter, req *http.Request) {
- res.WriteHeader(http.StatusOK)
- json, err := json.Marshal([]*model.MarketplacePlugin{samplePlugins[0], newPlugin})
- require.NoError(t, err)
- res.Write(json)
- }))
- defer func() { testServer.Close() }()
- th.App.UpdateConfig(func(cfg *model.Config) {
- *cfg.PluginSettings.MarketplaceUrl = testServer.URL
- })
- plugins, resp := th.SystemAdminClient.GetMarketplacePlugins(&model.MarketplacePluginFilter{})
- CheckNoError(t, resp)
- require.Equal(t, expectedPlugins, plugins)
- ok, resp := th.SystemAdminClient.RemovePlugin(manifest.Id)
- CheckNoError(t, resp)
- assert.True(t, ok)
- plugins, resp = th.SystemAdminClient.GetMarketplacePlugins(&model.MarketplacePluginFilter{})
- CheckNoError(t, resp)
- newPlugin.InstalledVersion = ""
- require.Equal(t, expectedPlugins, plugins)
- })
- }
- func TestSearchGetMarketplacePlugins(t *testing.T) {
- samplePlugins := []*model.MarketplacePlugin{
- {
- BaseMarketplacePlugin: &model.BaseMarketplacePlugin{
- HomepageURL: "example.com/mattermost/mattermost-plugin-nps",
- IconData: "Cjxzdmcgdmlld0JveD0nMCAwIDEwNSA5MycgeG1sbnM9J2h0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnJz4KPHBhdGggZD0nTTY2LDBoMzl2OTN6TTM4LDBoLTM4djkzek01MiwzNWwyNSw1OGgtMTZsLTgtMThoLTE4eicgZmlsbD0nI0VEMUMyNCcvPgo8L3N2Zz4K",
- DownloadURL: "example.com/mattermost/mattermost-plugin-nps/releases/download/v1.0.4/com.mattermost.nps-1.0.4.tar.gz",
- Manifest: &model.Manifest{
- Id: "com.mattermost.nps",
- Name: "User Satisfaction Surveys",
- Description: "This plugin sends quarterly user satisfaction surveys to gather feedback and help improve Mattermost.",
- Version: "1.0.4",
- MinServerVersion: "5.14.0",
- },
- },
- InstalledVersion: "",
- },
- }
- path, _ := fileutils.FindDir("tests")
- tarData, err := ioutil.ReadFile(filepath.Join(path, "testplugin.tar.gz"))
- require.NoError(t, err)
- tarDataV2, err := ioutil.ReadFile(filepath.Join(path, "testplugin2.tar.gz"))
- require.NoError(t, err)
- testIcon, err := ioutil.ReadFile(filepath.Join(path, "test.svg"))
- require.NoError(t, err)
- require.True(t, svg.Is(testIcon))
- testIconData := fmt.Sprintf("data:image/svg+xml;base64,%s", base64.StdEncoding.EncodeToString(testIcon))
- t.Run("search installed plugin", func(t *testing.T) {
- th := Setup(t).InitBasic()
- defer th.TearDown()
- testServer := httptest.NewServer(http.HandlerFunc(func(res http.ResponseWriter, req *http.Request) {
- res.WriteHeader(http.StatusOK)
- json, err := json.Marshal(samplePlugins)
- require.NoError(t, err)
- res.Write(json)
- }))
- defer func() { testServer.Close() }()
- th.App.UpdateConfig(func(cfg *model.Config) {
- *cfg.PluginSettings.Enable = true
- *cfg.PluginSettings.EnableUploads = true
- *cfg.PluginSettings.EnableMarketplace = true
- *cfg.PluginSettings.MarketplaceUrl = testServer.URL
- })
- plugins, resp := th.SystemAdminClient.GetMarketplacePlugins(&model.MarketplacePluginFilter{})
- CheckNoError(t, resp)
- require.Equal(t, samplePlugins, plugins)
- manifest, resp := th.SystemAdminClient.UploadPlugin(bytes.NewReader(tarData))
- CheckNoError(t, resp)
- plugin1 := &model.MarketplacePlugin{
- BaseMarketplacePlugin: &model.BaseMarketplacePlugin{
- HomepageURL: "https://example.com/homepage",
- IconData: testIconData,
- DownloadURL: "",
- ReleaseNotesURL: "https://example.com/releases/v0.0.1",
- Labels: []model.MarketplaceLabel{{
- Name: "Local",
- Description: "This plugin is not listed in the marketplace",
- }},
- Manifest: manifest,
- },
- InstalledVersion: manifest.Version,
- }
- expectedPlugins := append(samplePlugins, plugin1)
- manifest, resp = th.SystemAdminClient.UploadPlugin(bytes.NewReader(tarDataV2))
- CheckNoError(t, resp)
- plugin2 := &model.MarketplacePlugin{
- BaseMarketplacePlugin: &model.BaseMarketplacePlugin{
- IconData: testIconData,
- HomepageURL: "https://example.com/homepage",
- DownloadURL: "",
- ReleaseNotesURL: "https://example.com/releases/v1.2.3",
- Labels: []model.MarketplaceLabel{{
- Name: "Local",
- Description: "This plugin is not listed in the marketplace",
- }},
- Manifest: manifest,
- },
- InstalledVersion: manifest.Version,
- }
- expectedPlugins = append(expectedPlugins, plugin2)
- sort.SliceStable(expectedPlugins, func(i, j int) bool {
- return strings.ToLower(expectedPlugins[i].Manifest.Name) < strings.ToLower(expectedPlugins[j].Manifest.Name)
- })
- plugins, resp = th.SystemAdminClient.GetMarketplacePlugins(&model.MarketplacePluginFilter{})
- CheckNoError(t, resp)
- require.Equal(t, expectedPlugins, plugins)
- // Search for plugins from the server
- plugins, resp = th.SystemAdminClient.GetMarketplacePlugins(&model.MarketplacePluginFilter{Filter: "testplugin2"})
- CheckNoError(t, resp)
- require.Equal(t, []*model.MarketplacePlugin{plugin2}, plugins)
- plugins, resp = th.SystemAdminClient.GetMarketplacePlugins(&model.MarketplacePluginFilter{Filter: "a second plugin"})
- CheckNoError(t, resp)
- require.Equal(t, []*model.MarketplacePlugin{plugin2}, plugins)
- plugins, resp = th.SystemAdminClient.GetMarketplacePlugins(&model.MarketplacePluginFilter{Filter: "User Satisfaction Surveys"})
- CheckNoError(t, resp)
- require.Equal(t, samplePlugins, plugins)
- plugins, resp = th.SystemAdminClient.GetMarketplacePlugins(&model.MarketplacePluginFilter{Filter: "NOFILTER"})
- CheckNoError(t, resp)
- require.Nil(t, plugins)
- // cleanup
- ok, resp := th.SystemAdminClient.RemovePlugin(plugin1.Manifest.Id)
- CheckNoError(t, resp)
- assert.True(t, ok)
- ok, resp = th.SystemAdminClient.RemovePlugin(plugin2.Manifest.Id)
- CheckNoError(t, resp)
- assert.True(t, ok)
- })
- }
- func TestGetLocalPluginInMarketplace(t *testing.T) {
- th := Setup(t)
- defer th.TearDown()
- samplePlugins := []*model.MarketplacePlugin{
- {
- BaseMarketplacePlugin: &model.BaseMarketplacePlugin{
- HomepageURL: "https://example.com/mattermost/mattermost-plugin-nps",
- IconData: "https://example.com/icon.svg",
- DownloadURL: "www.github.com/example",
- Manifest: &model.Manifest{
- Id: "testplugin2",
- Name: "testplugin2",
- Description: "a second plugin",
- Version: "1.2.2",
- MinServerVersion: "",
- },
- },
- InstalledVersion: "",
- },
- }
- testServer := httptest.NewServer(http.HandlerFunc(func(res http.ResponseWriter, req *http.Request) {
- res.WriteHeader(http.StatusOK)
- json, err := json.Marshal([]*model.MarketplacePlugin{samplePlugins[0]})
- require.NoError(t, err)
- res.Write(json)
- }))
- defer testServer.Close()
- th.App.UpdateConfig(func(cfg *model.Config) {
- *cfg.PluginSettings.Enable = true
- *cfg.PluginSettings.EnableMarketplace = true
- *cfg.PluginSettings.MarketplaceUrl = testServer.URL
- })
- t.Run("Get plugins with EnableRemoteMarketplace enabled", func(t *testing.T) {
- th.App.UpdateConfig(func(cfg *model.Config) {
- *cfg.PluginSettings.EnableRemoteMarketplace = true
- })
- plugins, resp := th.SystemAdminClient.GetMarketplacePlugins(&model.MarketplacePluginFilter{})
- CheckNoError(t, resp)
- require.Len(t, plugins, len(samplePlugins))
- require.Equal(t, samplePlugins, plugins)
- })
- t.Run("get remote and local plugins", func(t *testing.T) {
- th.App.UpdateConfig(func(cfg *model.Config) {
- *cfg.PluginSettings.EnableRemoteMarketplace = true
- *cfg.PluginSettings.EnableUploads = true
- })
- // Upload one local plugin
- path, _ := fileutils.FindDir("tests")
- tarData, err := ioutil.ReadFile(filepath.Join(path, "testplugin.tar.gz"))
- require.NoError(t, err)
- manifest, resp := th.SystemAdminClient.UploadPlugin(bytes.NewReader(tarData))
- CheckNoError(t, resp)
- plugins, resp := th.SystemAdminClient.GetMarketplacePlugins(&model.MarketplacePluginFilter{})
- CheckNoError(t, resp)
- require.Len(t, plugins, 2)
- ok, resp := th.SystemAdminClient.RemovePlugin(manifest.Id)
- CheckNoError(t, resp)
- assert.True(t, ok)
- })
- t.Run("EnableRemoteMarketplace disabled", func(t *testing.T) {
- th.App.UpdateConfig(func(cfg *model.Config) {
- *cfg.PluginSettings.EnableRemoteMarketplace = false
- *cfg.PluginSettings.EnableUploads = true
- })
- // No marketplace plugins returned
- plugins, resp := th.SystemAdminClient.GetMarketplacePlugins(&model.MarketplacePluginFilter{})
- CheckNoError(t, resp)
- require.Len(t, plugins, 0)
- // Upload one local plugin
- path, _ := fileutils.FindDir("tests")
- tarData, err := ioutil.ReadFile(filepath.Join(path, "testplugin.tar.gz"))
- require.NoError(t, err)
- manifest, resp := th.SystemAdminClient.UploadPlugin(bytes.NewReader(tarData))
- CheckNoError(t, resp)
- testIcon, err := ioutil.ReadFile(filepath.Join(path, "test.svg"))
- require.NoError(t, err)
- require.True(t, svg.Is(testIcon))
- testIconData := fmt.Sprintf("data:image/svg+xml;base64,%s", base64.StdEncoding.EncodeToString(testIcon))
- newPlugin := &model.MarketplacePlugin{
- BaseMarketplacePlugin: &model.BaseMarketplacePlugin{
- IconData: testIconData,
- HomepageURL: "https://example.com/homepage",
- ReleaseNotesURL: "https://example.com/releases/v0.0.1",
- Manifest: manifest,
- },
- InstalledVersion: manifest.Version,
- }
- plugins, resp = th.SystemAdminClient.GetMarketplacePlugins(&model.MarketplacePluginFilter{})
- CheckNoError(t, resp)
- // Only get the local plugins
- require.Len(t, plugins, 1)
- require.Equal(t, newPlugin, plugins[0])
- ok, resp := th.SystemAdminClient.RemovePlugin(manifest.Id)
- CheckNoError(t, resp)
- assert.True(t, ok)
- })
- t.Run("local_only true", func(t *testing.T) {
- th.App.UpdateConfig(func(cfg *model.Config) {
- *cfg.PluginSettings.EnableRemoteMarketplace = true
- *cfg.PluginSettings.EnableUploads = true
- })
- // Upload one local plugin
- path, _ := fileutils.FindDir("tests")
- tarData, err := ioutil.ReadFile(filepath.Join(path, "testplugin.tar.gz"))
- require.NoError(t, err)
- manifest, resp := th.SystemAdminClient.UploadPlugin(bytes.NewReader(tarData))
- CheckNoError(t, resp)
- testIcon, err := ioutil.ReadFile(filepath.Join(path, "test.svg"))
- require.NoError(t, err)
- require.True(t, svg.Is(testIcon))
- testIconData := fmt.Sprintf("data:image/svg+xml;base64,%s", base64.StdEncoding.EncodeToString(testIcon))
- newPlugin := &model.MarketplacePlugin{
- BaseMarketplacePlugin: &model.BaseMarketplacePlugin{
- Manifest: manifest,
- IconData: testIconData,
- HomepageURL: "https://example.com/homepage",
- ReleaseNotesURL: "https://example.com/releases/v0.0.1",
- Labels: []model.MarketplaceLabel{{
- Name: "Local",
- Description: "This plugin is not listed in the marketplace",
- }},
- },
- InstalledVersion: manifest.Version,
- }
- plugins, resp := th.SystemAdminClient.GetMarketplacePlugins(&model.MarketplacePluginFilter{LocalOnly: true})
- CheckNoError(t, resp)
- require.Len(t, plugins, 1)
- require.Equal(t, newPlugin, plugins[0])
- ok, resp := th.SystemAdminClient.RemovePlugin(manifest.Id)
- CheckNoError(t, resp)
- assert.True(t, ok)
- })
- }
- func TestGetPrepackagedPluginInMarketplace(t *testing.T) {
- th := Setup(t)
- defer th.TearDown()
- marketplacePlugins := []*model.MarketplacePlugin{
- {
- BaseMarketplacePlugin: &model.BaseMarketplacePlugin{
- HomepageURL: "https://example.com/mattermost/mattermost-plugin-nps",
- IconData: "https://example.com/icon.svg",
- DownloadURL: "www.github.com/example",
- Manifest: &model.Manifest{
- Id: "marketplace.test",
- Name: "marketplacetest",
- Description: "a marketplace plugin",
- Version: "0.1.2",
- MinServerVersion: "",
- },
- },
- InstalledVersion: "",
- },
- }
- testServer := httptest.NewServer(http.HandlerFunc(func(res http.ResponseWriter, req *http.Request) {
- res.WriteHeader(http.StatusOK)
- json, err := json.Marshal([]*model.MarketplacePlugin{marketplacePlugins[0]})
- require.NoError(t, err)
- res.Write(json)
- }))
- defer testServer.Close()
- th.App.UpdateConfig(func(cfg *model.Config) {
- *cfg.PluginSettings.Enable = true
- *cfg.PluginSettings.EnableMarketplace = true
- *cfg.PluginSettings.MarketplaceUrl = testServer.URL
- })
- prepackagePlugin := &plugin.PrepackagedPlugin{
- Manifest: &model.Manifest{
- Version: "0.0.1",
- Id: "prepackaged.test",
- },
- }
- env := th.App.GetPluginsEnvironment()
- env.SetPrepackagedPlugins([]*plugin.PrepackagedPlugin{prepackagePlugin})
- t.Run("get remote and prepackaged plugins", func(t *testing.T) {
- th.App.UpdateConfig(func(cfg *model.Config) {
- *cfg.PluginSettings.EnableRemoteMarketplace = true
- *cfg.PluginSettings.EnableUploads = true
- })
- plugins, resp := th.SystemAdminClient.GetMarketplacePlugins(&model.MarketplacePluginFilter{})
- CheckNoError(t, resp)
- expectedPlugins := marketplacePlugins
- expectedPlugins = append(expectedPlugins, &model.MarketplacePlugin{
- BaseMarketplacePlugin: &model.BaseMarketplacePlugin{
- Manifest: prepackagePlugin.Manifest,
- },
- })
- require.ElementsMatch(t, expectedPlugins, plugins)
- require.Len(t, plugins, 2)
- })
- t.Run("EnableRemoteMarketplace disabled", func(t *testing.T) {
- th.App.UpdateConfig(func(cfg *model.Config) {
- *cfg.PluginSettings.EnableRemoteMarketplace = false
- *cfg.PluginSettings.EnableUploads = true
- })
- // No marketplace plugins returned
- plugins, resp := th.SystemAdminClient.GetMarketplacePlugins(&model.MarketplacePluginFilter{})
- CheckNoError(t, resp)
- // Only returns the prepackaged plugins
- require.Len(t, plugins, 1)
- require.Equal(t, prepackagePlugin.Manifest, plugins[0].Manifest)
- })
- t.Run("get prepackaged plugin if newer", func(t *testing.T) {
- th.App.UpdateConfig(func(cfg *model.Config) {
- *cfg.PluginSettings.EnableRemoteMarketplace = true
- *cfg.PluginSettings.EnableUploads = true
- })
- manifest := &model.Manifest{
- Version: "1.2.3",
- Id: "marketplace.test",
- }
- newerPrepackagePlugin := &plugin.PrepackagedPlugin{
- Manifest: manifest,
- }
- env := th.App.GetPluginsEnvironment()
- env.SetPrepackagedPlugins([]*plugin.PrepackagedPlugin{newerPrepackagePlugin})
- plugins, resp := th.SystemAdminClient.GetMarketplacePlugins(&model.MarketplacePluginFilter{})
- CheckNoError(t, resp)
- require.Len(t, plugins, 1)
- require.Equal(t, newerPrepackagePlugin.Manifest, plugins[0].Manifest)
- })
- }
- func TestInstallMarketplacePlugin(t *testing.T) {
- th := Setup(t).InitBasic()
- defer th.TearDown()
- th.App.UpdateConfig(func(cfg *model.Config) {
- *cfg.PluginSettings.Enable = true
- *cfg.PluginSettings.EnableUploads = true
- *cfg.PluginSettings.EnableMarketplace = false
- })
- path, _ := fileutils.FindDir("tests")
- signatureFilename := "testplugin2.tar.gz.sig"
- signatureFileReader, err := os.Open(filepath.Join(path, signatureFilename))
- require.Nil(t, err)
- sigFile, err := ioutil.ReadAll(signatureFileReader)
- require.Nil(t, err)
- pluginSignature := base64.StdEncoding.EncodeToString(sigFile)
- tarData, err := ioutil.ReadFile(filepath.Join(path, "testplugin2.tar.gz"))
- require.NoError(t, err)
- pluginServer := httptest.NewServer(http.HandlerFunc(func(res http.ResponseWriter, req *http.Request) {
- res.WriteHeader(http.StatusOK)
- res.Write(tarData)
- }))
- defer pluginServer.Close()
- samplePlugins := []*model.MarketplacePlugin{
- {
- BaseMarketplacePlugin: &model.BaseMarketplacePlugin{
- HomepageURL: "https://example.com/mattermost/mattermost-plugin-nps",
- IconData: "https://example.com/icon.svg",
- DownloadURL: pluginServer.URL,
- Manifest: &model.Manifest{
- Id: "testplugin2",
- Name: "testplugin2",
- Description: "a second plugin",
- Version: "1.2.2",
- MinServerVersion: "",
- },
- },
- InstalledVersion: "",
- },
- {
- BaseMarketplacePlugin: &model.BaseMarketplacePlugin{
- HomepageURL: "https://example.com/mattermost/mattermost-plugin-nps",
- IconData: "https://example.com/icon.svg",
- DownloadURL: pluginServer.URL,
- Manifest: &model.Manifest{
- Id: "testplugin2",
- Name: "testplugin2",
- Description: "a second plugin",
- Version: "1.2.3",
- MinServerVersion: "",
- },
- Signature: pluginSignature,
- },
- InstalledVersion: "",
- },
- }
- request := &model.InstallMarketplacePluginRequest{Id: "", Version: ""}
- t.Run("marketplace disabled", func(t *testing.T) {
- th.App.UpdateConfig(func(cfg *model.Config) {
- *cfg.PluginSettings.EnableMarketplace = false
- *cfg.PluginSettings.MarketplaceUrl = "invalid.com"
- })
- plugin, resp := th.SystemAdminClient.InstallMarketplacePlugin(request)
- CheckNotImplementedStatus(t, resp)
- require.Nil(t, plugin)
- })
- t.Run("RequirePluginSignature enabled", func(t *testing.T) {
- th.App.UpdateConfig(func(cfg *model.Config) {
- *cfg.PluginSettings.Enable = true
- *cfg.PluginSettings.RequirePluginSignature = true
- })
- manifest, resp := th.SystemAdminClient.UploadPlugin(bytes.NewReader(tarData))
- CheckNotImplementedStatus(t, resp)
- require.Nil(t, manifest)
- manifest, resp = th.SystemAdminClient.InstallPluginFromUrl("some_url", true)
- CheckNotImplementedStatus(t, resp)
- require.Nil(t, manifest)
- })
- t.Run("no server", func(t *testing.T) {
- th.App.UpdateConfig(func(cfg *model.Config) {
- *cfg.PluginSettings.EnableMarketplace = true
- *cfg.PluginSettings.MarketplaceUrl = "invalid.com"
- })
- plugin, resp := th.SystemAdminClient.InstallMarketplacePlugin(request)
- CheckInternalErrorStatus(t, resp)
- require.Nil(t, plugin)
- })
- t.Run("no permission", func(t *testing.T) {
- th.App.UpdateConfig(func(cfg *model.Config) {
- *cfg.PluginSettings.EnableMarketplace = true
- *cfg.PluginSettings.MarketplaceUrl = "invalid.com"
- })
- plugin, resp := th.Client.InstallMarketplacePlugin(request)
- CheckForbiddenStatus(t, resp)
- require.Nil(t, plugin)
- })
- t.Run("plugin not found on the server", func(t *testing.T) {
- testServer := httptest.NewServer(http.HandlerFunc(func(res http.ResponseWriter, req *http.Request) {
- res.WriteHeader(http.StatusOK)
- json, err := json.Marshal([]*model.MarketplacePlugin{})
- require.NoError(t, err)
- res.Write(json)
- }))
- defer testServer.Close()
- th.App.UpdateConfig(func(cfg *model.Config) {
- *cfg.PluginSettings.EnableMarketplace = true
- *cfg.PluginSettings.MarketplaceUrl = testServer.URL
- })
- pRequest := &model.InstallMarketplacePluginRequest{Id: "some_plugin_id", Version: "0.0.1"}
- plugin, resp := th.SystemAdminClient.InstallMarketplacePlugin(pRequest)
- CheckInternalErrorStatus(t, resp)
- require.Nil(t, plugin)
- })
- t.Run("plugin not verified", func(t *testing.T) {
- testServer := httptest.NewServer(http.HandlerFunc(func(res http.ResponseWriter, req *http.Request) {
- res.WriteHeader(http.StatusOK)
- json, err := json.Marshal([]*model.MarketplacePlugin{samplePlugins[0]})
- require.NoError(t, err)
- res.Write(json)
- }))
- defer testServer.Close()
- th.App.UpdateConfig(func(cfg *model.Config) {
- *cfg.PluginSettings.EnableMarketplace = true
- *cfg.PluginSettings.MarketplaceUrl = testServer.URL
- *cfg.PluginSettings.AllowInsecureDownloadUrl = true
- })
- pRequest := &model.InstallMarketplacePluginRequest{Id: "testplugin2", Version: "1.2.2"}
- plugin, resp := th.SystemAdminClient.InstallMarketplacePlugin(pRequest)
- CheckInternalErrorStatus(t, resp)
- require.Nil(t, plugin)
- })
- t.Run("verify, install and remove plugin", func(t *testing.T) {
- testServer := httptest.NewServer(http.HandlerFunc(func(res http.ResponseWriter, req *http.Request) {
- serverVersion := req.URL.Query().Get("server_version")
- require.NotEmpty(t, serverVersion)
- require.Equal(t, model.CurrentVersion, serverVersion)
- res.WriteHeader(http.StatusOK)
- json, err := json.Marshal([]*model.MarketplacePlugin{samplePlugins[1]})
- require.NoError(t, err)
- res.Write(json)
- }))
- defer testServer.Close()
- th.App.UpdateConfig(func(cfg *model.Config) {
- *cfg.PluginSettings.EnableMarketplace = true
- *cfg.PluginSettings.EnableRemoteMarketplace = true
- *cfg.PluginSettings.MarketplaceUrl = testServer.URL
- })
- key, err := os.Open(filepath.Join(path, "development-private-key.asc"))
- require.NoError(t, err)
- appErr := th.App.AddPublicKey("pub_key", key)
- require.Nil(t, appErr)
- pRequest := &model.InstallMarketplacePluginRequest{Id: "testplugin2", Version: "1.2.3"}
- manifest, resp := th.SystemAdminClient.InstallMarketplacePlugin(pRequest)
- CheckNoError(t, resp)
- require.NotNil(t, manifest)
- require.Equal(t, "testplugin2", manifest.Id)
- require.Equal(t, "1.2.3", manifest.Version)
- filePath := filepath.Join("plugins", "testplugin2.tar.gz.sig")
- savedSigFile, err := th.App.ReadFile(filePath)
- require.Nil(t, err)
- require.EqualValues(t, sigFile, savedSigFile)
- ok, resp := th.SystemAdminClient.RemovePlugin(manifest.Id)
- CheckNoError(t, resp)
- assert.True(t, ok)
- exists, err := th.App.FileExists(filePath)
- require.Nil(t, err)
- require.False(t, exists)
- appErr = th.App.DeletePublicKey("pub_key")
- require.Nil(t, appErr)
- })
- t.Run("verify EnterprisePlugins is false for TE", func(t *testing.T) {
- requestHandled := false
- testServer := httptest.NewServer(http.HandlerFunc(func(res http.ResponseWriter, req *http.Request) {
- licenseType, ok := req.URL.Query()["enterprise_plugins"]
- require.True(t, ok)
- require.Len(t, licenseType, 1)
- require.Equal(t, "false", licenseType[0])
- res.WriteHeader(http.StatusOK)
- json, err := json.Marshal([]*model.MarketplacePlugin{samplePlugins[0]})
- require.NoError(t, err)
- _, err = res.Write(json)
- require.NoError(t, err)
- requestHandled = true
- }))
- defer func() { testServer.Close() }()
- th.App.UpdateConfig(func(cfg *model.Config) {
- *cfg.PluginSettings.EnableMarketplace = true
- *cfg.PluginSettings.EnableRemoteMarketplace = true
- *cfg.PluginSettings.MarketplaceUrl = testServer.URL
- })
- // The content of the request is irrelevant. This test only cares about enterprise_plugins.
- pRequest := &model.InstallMarketplacePluginRequest{}
- manifest, resp := th.SystemAdminClient.InstallMarketplacePlugin(pRequest)
- CheckInternalErrorStatus(t, resp)
- require.Nil(t, manifest)
- assert.True(t, requestHandled)
- })
- t.Run("verify EnterprisePlugins is false for E10", func(t *testing.T) {
- requestHandled := false
- testServer := httptest.NewServer(http.HandlerFunc(func(res http.ResponseWriter, req *http.Request) {
- licenseType, ok := req.URL.Query()["enterprise_plugins"]
- require.True(t, ok)
- require.Len(t, licenseType, 1)
- require.Equal(t, "false", licenseType[0])
- res.WriteHeader(http.StatusOK)
- json, err := json.Marshal([]*model.MarketplacePlugin{})
- require.NoError(t, err)
- _, err = res.Write(json)
- require.NoError(t, err)
- requestHandled = true
- }))
- defer func() { testServer.Close() }()
- th.App.UpdateConfig(func(cfg *model.Config) {
- *cfg.PluginSettings.EnableMarketplace = true
- *cfg.PluginSettings.EnableRemoteMarketplace = true
- *cfg.PluginSettings.MarketplaceUrl = testServer.URL
- })
- l := model.NewTestLicense()
- // model.NewTestLicense generates a E20 license
- *l.Features.EnterprisePlugins = false
- th.App.Srv().SetLicense(l)
- // The content of the request is irrelevant. This test only cares about enterprise_plugins.
- pRequest := &model.InstallMarketplacePluginRequest{}
- manifest, resp := th.SystemAdminClient.InstallMarketplacePlugin(pRequest)
- CheckInternalErrorStatus(t, resp)
- require.Nil(t, manifest)
- assert.True(t, requestHandled)
- })
- t.Run("verify EnterprisePlugins is true for E20", func(t *testing.T) {
- requestHandled := false
- testServer := httptest.NewServer(http.HandlerFunc(func(res http.ResponseWriter, req *http.Request) {
- licenseType, ok := req.URL.Query()["enterprise_plugins"]
- require.True(t, ok)
- require.Len(t, licenseType, 1)
- require.Equal(t, "true", licenseType[0])
- res.WriteHeader(http.StatusOK)
- json, err := json.Marshal([]*model.MarketplacePlugin{})
- require.NoError(t, err)
- _, err = res.Write(json)
- require.NoError(t, err)
- requestHandled = true
- }))
- defer func() { testServer.Close() }()
- th.App.UpdateConfig(func(cfg *model.Config) {
- *cfg.PluginSettings.EnableMarketplace = true
- *cfg.PluginSettings.MarketplaceUrl = testServer.URL
- })
- th.App.Srv().SetLicense(model.NewTestLicense("enterprise_plugins"))
- // The content of the request is irrelevant. This test only cares about enterprise_plugins.
- pRequest := &model.InstallMarketplacePluginRequest{}
- manifest, resp := th.SystemAdminClient.InstallMarketplacePlugin(pRequest)
- CheckInternalErrorStatus(t, resp)
- require.Nil(t, manifest)
- assert.True(t, requestHandled)
- })
- t.Run("install prepackaged and remote plugins through marketplace", func(t *testing.T) {
- prepackagedPluginsDir := "prepackaged_plugins"
- os.RemoveAll(prepackagedPluginsDir)
- err := os.Mkdir(prepackagedPluginsDir, os.ModePerm)
- require.NoError(t, err)
- defer os.RemoveAll(prepackagedPluginsDir)
- prepackagedPluginsDir, found := fileutils.FindDir(prepackagedPluginsDir)
- require.True(t, found, "failed to find prepackaged plugins directory")
- err = utils.CopyFile(filepath.Join(path, "testplugin.tar.gz"), filepath.Join(prepackagedPluginsDir, "testplugin.tar.gz"))
- require.NoError(t, err)
- err = utils.CopyFile(filepath.Join(path, "testplugin.tar.gz.asc"), filepath.Join(prepackagedPluginsDir, "testplugin.tar.gz.sig"))
- require.NoError(t, err)
- th := SetupConfig(t, func(cfg *model.Config) {
- // Disable auto-installing prepackaged plugins
- *cfg.PluginSettings.AutomaticPrepackagedPlugins = false
- }).InitBasic()
- defer th.TearDown()
- pluginSignatureFile, err := os.Open(filepath.Join(path, "testplugin.tar.gz.asc"))
- require.Nil(t, err)
- pluginSignatureData, err := ioutil.ReadAll(pluginSignatureFile)
- require.Nil(t, err)
- key, err := os.Open(filepath.Join(path, "development-private-key.asc"))
- require.NoError(t, err)
- appErr := th.App.AddPublicKey("pub_key", key)
- require.Nil(t, appErr)
- testServer := httptest.NewServer(http.HandlerFunc(func(res http.ResponseWriter, req *http.Request) {
- serverVersion := req.URL.Query().Get("server_version")
- require.NotEmpty(t, serverVersion)
- require.Equal(t, model.CurrentVersion, serverVersion)
- res.WriteHeader(http.StatusOK)
- json, err := json.Marshal([]*model.MarketplacePlugin{samplePlugins[1]})
- require.NoError(t, err)
- res.Write(json)
- }))
- defer testServer.Close()
- th.App.UpdateConfig(func(cfg *model.Config) {
- *cfg.PluginSettings.EnableMarketplace = true
- *cfg.PluginSettings.EnableRemoteMarketplace = false
- *cfg.PluginSettings.MarketplaceUrl = testServer.URL
- *cfg.PluginSettings.AllowInsecureDownloadUrl = false
- })
- env := th.App.GetPluginsEnvironment()
- pluginsResp, resp := th.SystemAdminClient.GetPlugins()
- CheckNoError(t, resp)
- require.Len(t, pluginsResp.Active, 0)
- require.Len(t, pluginsResp.Inactive, 0)
- // Should fail to install unknown prepackaged plugin
- pRequest := &model.InstallMarketplacePluginRequest{Id: "testplugin", Version: "0.0.2"}
- manifest, resp := th.SystemAdminClient.InstallMarketplacePlugin(pRequest)
- CheckInternalErrorStatus(t, resp)
- require.Nil(t, manifest)
- plugins := env.PrepackagedPlugins()
- require.Len(t, plugins, 1)
- require.Equal(t, "testplugin", plugins[0].Manifest.Id)
- require.Equal(t, pluginSignatureData, plugins[0].Signature)
- pluginsResp, resp = th.SystemAdminClient.GetPlugins()
- CheckNoError(t, resp)
- require.Len(t, pluginsResp.Active, 0)
- require.Len(t, pluginsResp.Inactive, 0)
- pRequest = &model.InstallMarketplacePluginRequest{Id: "testplugin", Version: "0.0.1"}
- manifest1, resp := th.SystemAdminClient.InstallMarketplacePlugin(pRequest)
- CheckNoError(t, resp)
- require.NotNil(t, manifest1)
- require.Equal(t, "testplugin", manifest1.Id)
- require.Equal(t, "0.0.1", manifest1.Version)
- pluginsResp, resp = th.SystemAdminClient.GetPlugins()
- CheckNoError(t, resp)
- require.Len(t, pluginsResp.Active, 0)
- require.Equal(t, pluginsResp.Inactive, []*model.PluginInfo{{
- Manifest: *manifest1,
- }})
- // Try to install remote marketplace plugin
- pRequest = &model.InstallMarketplacePluginRequest{Id: "testplugin2", Version: "1.2.3"}
- manifest, resp = th.SystemAdminClient.InstallMarketplacePlugin(pRequest)
- CheckInternalErrorStatus(t, resp)
- require.Nil(t, manifest)
- // Enable remote marketplace
- th.App.UpdateConfig(func(cfg *model.Config) {
- *cfg.PluginSettings.EnableMarketplace = true
- *cfg.PluginSettings.EnableRemoteMarketplace = true
- *cfg.PluginSettings.MarketplaceUrl = testServer.URL
- *cfg.PluginSettings.AllowInsecureDownloadUrl = true
- })
- pRequest = &model.InstallMarketplacePluginRequest{Id: "testplugin2", Version: "1.2.3"}
- manifest2, resp := th.SystemAdminClient.InstallMarketplacePlugin(pRequest)
- CheckNoError(t, resp)
- require.NotNil(t, manifest2)
- require.Equal(t, "testplugin2", manifest2.Id)
- require.Equal(t, "1.2.3", manifest2.Version)
- pluginsResp, resp = th.SystemAdminClient.GetPlugins()
- CheckNoError(t, resp)
- require.Len(t, pluginsResp.Active, 0)
- require.ElementsMatch(t, pluginsResp.Inactive, []*model.PluginInfo{
- {
- Manifest: *manifest1,
- },
- {
- Manifest: *manifest2,
- },
- })
- // Clean up
- ok, resp := th.SystemAdminClient.RemovePlugin(manifest1.Id)
- CheckNoError(t, resp)
- assert.True(t, ok)
- ok, resp = th.SystemAdminClient.RemovePlugin(manifest2.Id)
- CheckNoError(t, resp)
- assert.True(t, ok)
- appErr = th.App.DeletePublicKey("pub_key")
- require.Nil(t, appErr)
- })
- t.Run("missing prepackaged and remote plugin signatures", func(t *testing.T) {
- prepackagedPluginsDir := "prepackaged_plugins"
- os.RemoveAll(prepackagedPluginsDir)
- err := os.Mkdir(prepackagedPluginsDir, os.ModePerm)
- require.NoError(t, err)
- defer os.RemoveAll(prepackagedPluginsDir)
- prepackagedPluginsDir, found := fileutils.FindDir(prepackagedPluginsDir)
- require.True(t, found, "failed to find prepackaged plugins directory")
- err = utils.CopyFile(filepath.Join(path, "testplugin.tar.gz"), filepath.Join(prepackagedPluginsDir, "testplugin.tar.gz"))
- require.NoError(t, err)
- th := SetupConfig(t, func(cfg *model.Config) {
- // Disable auto-installing prepackged plugins
- *cfg.PluginSettings.AutomaticPrepackagedPlugins = false
- }).InitBasic()
- defer th.TearDown()
- key, err := os.Open(filepath.Join(path, "development-private-key.asc"))
- require.NoError(t, err)
- appErr := th.App.AddPublicKey("pub_key", key)
- require.Nil(t, appErr)
- testServer := httptest.NewServer(http.HandlerFunc(func(res http.ResponseWriter, req *http.Request) {
- serverVersion := req.URL.Query().Get("server_version")
- require.NotEmpty(t, serverVersion)
- require.Equal(t, model.CurrentVersion, serverVersion)
- mPlugins := []*model.MarketplacePlugin{samplePlugins[0]}
- require.Empty(t, mPlugins[0].Signature)
- res.WriteHeader(http.StatusOK)
- json, err := json.Marshal(mPlugins)
- require.NoError(t, err)
- res.Write(json)
- }))
- defer testServer.Close()
- th.App.UpdateConfig(func(cfg *model.Config) {
- *cfg.PluginSettings.EnableMarketplace = true
- *cfg.PluginSettings.EnableRemoteMarketplace = true
- *cfg.PluginSettings.MarketplaceUrl = testServer.URL
- *cfg.PluginSettings.AllowInsecureDownloadUrl = true
- })
- env := th.App.GetPluginsEnvironment()
- plugins := env.PrepackagedPlugins()
- require.Len(t, plugins, 1)
- require.Equal(t, "testplugin", plugins[0].Manifest.Id)
- require.Empty(t, plugins[0].Signature)
- pluginsResp, resp := th.SystemAdminClient.GetPlugins()
- CheckNoError(t, resp)
- require.Len(t, pluginsResp.Active, 0)
- require.Len(t, pluginsResp.Inactive, 0)
- pRequest := &model.InstallMarketplacePluginRequest{Id: "testplugin", Version: "0.0.1"}
- manifest, resp := th.SystemAdminClient.InstallMarketplacePlugin(pRequest)
- CheckInternalErrorStatus(t, resp)
- require.Nil(t, manifest)
- pluginsResp, resp = th.SystemAdminClient.GetPlugins()
- CheckNoError(t, resp)
- require.Len(t, pluginsResp.Active, 0)
- require.Len(t, pluginsResp.Inactive, 0)
- pRequest = &model.InstallMarketplacePluginRequest{Id: "testplugin2", Version: "1.2.3"}
- manifest, resp = th.SystemAdminClient.InstallMarketplacePlugin(pRequest)
- CheckInternalErrorStatus(t, resp)
- require.Nil(t, manifest)
- pluginsResp, resp = th.SystemAdminClient.GetPlugins()
- CheckNoError(t, resp)
- require.Len(t, pluginsResp.Active, 0)
- require.Len(t, pluginsResp.Inactive, 0)
- // Clean up
- appErr = th.App.DeletePublicKey("pub_key")
- require.Nil(t, appErr)
- })
- }
- func findClusterMessages(event string, msgs []*model.ClusterMessage) []*model.ClusterMessage {
- var result []*model.ClusterMessage
- for _, msg := range msgs {
- if msg.Event == event {
- result = append(result, msg)
- }
- }
- return result
- }
|