package store import ( "context" "testing" "github.com/stretchr/testify/require" "github.com/grafana/grafana/pkg/plugins" "github.com/grafana/grafana/pkg/plugins/backendplugin" "github.com/grafana/grafana/pkg/plugins/config" "github.com/grafana/grafana/pkg/plugins/manager/fakes" "github.com/grafana/grafana/pkg/setting" ) func TestStore_ProvideService(t *testing.T) { t.Run("Plugin sources are added in order", func(t *testing.T) { var addedPaths []string l := &fakes.FakeLoader{ LoadFunc: func(ctx context.Context, class plugins.Class, paths []string) ([]*plugins.Plugin, error) { addedPaths = append(addedPaths, paths...) return nil, nil }, } cfg := &setting.Cfg{ BundledPluginsPath: "path1", } pCfg := &config.Cfg{ PluginsPath: "path2", PluginSettings: setting.PluginSettings{ "blah": map[string]string{ "path": "path3", }, }, } _, err := ProvideService(cfg, pCfg, fakes.NewFakePluginRegistry(), l) require.NoError(t, err) require.Equal(t, []string{"app/plugins/datasource", "app/plugins/panel", "path1", "path2", "path3"}, addedPaths) }) } func TestStore_Plugin(t *testing.T) { t.Run("Plugin returns all non-decommissioned plugins", func(t *testing.T) { p1 := &plugins.Plugin{JSONData: plugins.JSONData{ID: "test-datasource"}} p1.RegisterClient(&DecommissionedPlugin{}) p2 := &plugins.Plugin{JSONData: plugins.JSONData{ID: "test-panel"}} ps := New(newFakePluginRegistry(map[string]*plugins.Plugin{ p1.ID: p1, p2.ID: p2, })) p, exists := ps.Plugin(context.Background(), p1.ID) require.False(t, exists) require.Equal(t, plugins.PluginDTO{}, p) p, exists = ps.Plugin(context.Background(), p2.ID) require.True(t, exists) require.Equal(t, p, p2.ToDTO()) }) } func TestStore_Plugins(t *testing.T) { t.Run("Plugin returns all non-decommissioned plugins by type", func(t *testing.T) { p1 := &plugins.Plugin{JSONData: plugins.JSONData{ID: "a-test-datasource", Type: plugins.DataSource}} p2 := &plugins.Plugin{JSONData: plugins.JSONData{ID: "b-test-panel", Type: plugins.Panel}} p3 := &plugins.Plugin{JSONData: plugins.JSONData{ID: "c-test-panel", Type: plugins.Panel}} p4 := &plugins.Plugin{JSONData: plugins.JSONData{ID: "d-test-app", Type: plugins.App}} p5 := &plugins.Plugin{JSONData: plugins.JSONData{ID: "e-test-panel", Type: plugins.Panel}} p5.RegisterClient(&DecommissionedPlugin{}) ps := New(newFakePluginRegistry(map[string]*plugins.Plugin{ p1.ID: p1, p2.ID: p2, p3.ID: p3, p4.ID: p4, p5.ID: p5, })) pss := ps.Plugins(context.Background()) require.Equal(t, pss, []plugins.PluginDTO{p1.ToDTO(), p2.ToDTO(), p3.ToDTO(), p4.ToDTO()}) pss = ps.Plugins(context.Background(), plugins.App) require.Equal(t, pss, []plugins.PluginDTO{p4.ToDTO()}) pss = ps.Plugins(context.Background(), plugins.Panel) require.Equal(t, pss, []plugins.PluginDTO{p2.ToDTO(), p3.ToDTO()}) pss = ps.Plugins(context.Background(), plugins.DataSource) require.Equal(t, pss, []plugins.PluginDTO{p1.ToDTO()}) pss = ps.Plugins(context.Background(), plugins.DataSource, plugins.App, plugins.Panel) require.Equal(t, pss, []plugins.PluginDTO{p1.ToDTO(), p2.ToDTO(), p3.ToDTO(), p4.ToDTO()}) }) } func TestStore_Routes(t *testing.T) { t.Run("Routes returns all static routes for non-decommissioned plugins", func(t *testing.T) { p1 := &plugins.Plugin{JSONData: plugins.JSONData{ID: "a-test-renderer", Type: plugins.Renderer}, PluginDir: "/some/dir"} p2 := &plugins.Plugin{JSONData: plugins.JSONData{ID: "b-test-panel", Type: plugins.Panel}, PluginDir: "/grafana/"} p3 := &plugins.Plugin{JSONData: plugins.JSONData{ID: "c-test-secrets", Type: plugins.SecretsManager}, PluginDir: "./secrets", Class: plugins.Core} p4 := &plugins.Plugin{JSONData: plugins.JSONData{ID: "d-test-datasource", Type: plugins.DataSource}, PluginDir: "../test"} p5 := &plugins.Plugin{JSONData: plugins.JSONData{ID: "e-test-app", Type: plugins.App}} p6 := &plugins.Plugin{JSONData: plugins.JSONData{ID: "f-test-app", Type: plugins.App}} p6.RegisterClient(&DecommissionedPlugin{}) ps := New(newFakePluginRegistry(map[string]*plugins.Plugin{ p1.ID: p1, p2.ID: p2, p3.ID: p3, p4.ID: p4, p5.ID: p5, p6.ID: p6, })) sr := func(p *plugins.Plugin) *plugins.StaticRoute { return &plugins.StaticRoute{PluginID: p.ID, Directory: p.PluginDir} } rs := ps.Routes() require.Equal(t, []*plugins.StaticRoute{sr(p1), sr(p2), sr(p4), sr(p5)}, rs) }) } func TestStore_Renderer(t *testing.T) { t.Run("Renderer returns a single (non-decommissioned) renderer plugin", func(t *testing.T) { p1 := &plugins.Plugin{JSONData: plugins.JSONData{ID: "test-renderer", Type: plugins.Renderer}} p2 := &plugins.Plugin{JSONData: plugins.JSONData{ID: "test-panel", Type: plugins.Panel}} p3 := &plugins.Plugin{JSONData: plugins.JSONData{ID: "test-app", Type: plugins.App}} ps := New(newFakePluginRegistry(map[string]*plugins.Plugin{ p1.ID: p1, p2.ID: p2, p3.ID: p3, })) r := ps.Renderer(context.Background()) require.Equal(t, p1, r) }) } func TestStore_SecretsManager(t *testing.T) { t.Run("Renderer returns a single (non-decommissioned) secrets manager plugin", func(t *testing.T) { p1 := &plugins.Plugin{JSONData: plugins.JSONData{ID: "test-renderer", Type: plugins.Renderer}} p2 := &plugins.Plugin{JSONData: plugins.JSONData{ID: "test-panel", Type: plugins.Panel}} p3 := &plugins.Plugin{JSONData: plugins.JSONData{ID: "test-secrets", Type: plugins.SecretsManager}} p4 := &plugins.Plugin{JSONData: plugins.JSONData{ID: "test-datasource", Type: plugins.DataSource}} ps := New(newFakePluginRegistry(map[string]*plugins.Plugin{ p1.ID: p1, p2.ID: p2, p3.ID: p3, p4.ID: p4, })) r := ps.SecretsManager(context.Background()) require.Equal(t, p3, r) }) } func TestStore_availablePlugins(t *testing.T) { t.Run("Decommissioned plugins are excluded from availablePlugins", func(t *testing.T) { p1 := &plugins.Plugin{JSONData: plugins.JSONData{ID: "test-datasource"}} p1.RegisterClient(&DecommissionedPlugin{}) p2 := &plugins.Plugin{JSONData: plugins.JSONData{ID: "test-app"}} ps := New( newFakePluginRegistry(map[string]*plugins.Plugin{ p1.ID: p1, p2.ID: p2, }), ) aps := ps.availablePlugins(context.Background()) require.Len(t, aps, 1) require.Equal(t, p2, aps[0]) }) } type DecommissionedPlugin struct { backendplugin.Plugin } func (p *DecommissionedPlugin) Decommission() error { return nil } func (p *DecommissionedPlugin) IsDecommissioned() bool { return true } type fakePluginRegistry struct { store map[string]*plugins.Plugin } func newFakePluginRegistry(m map[string]*plugins.Plugin) *fakePluginRegistry { return &fakePluginRegistry{ store: m, } } func (f *fakePluginRegistry) Plugin(_ context.Context, id string) (*plugins.Plugin, bool) { p, exists := f.store[id] return p, exists } func (f *fakePluginRegistry) Plugins(_ context.Context) []*plugins.Plugin { var res []*plugins.Plugin for _, p := range f.store { res = append(res, p) } return res } func (f *fakePluginRegistry) Add(_ context.Context, p *plugins.Plugin) error { f.store[p.ID] = p return nil } func (f *fakePluginRegistry) Remove(_ context.Context, id string) error { delete(f.store, id) return nil }