package plugins import ( "context" "errors" "fmt" "path/filepath" "testing" "github.com/grafana/grafana-plugin-sdk-go/backend" "github.com/grafana/grafana/pkg/models" "github.com/grafana/grafana/pkg/plugins/backendplugin" "github.com/grafana/grafana/pkg/setting" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" "gopkg.in/ini.v1" ) func TestPluginManager_Init(t *testing.T) { staticRootPath, err := filepath.Abs("../../public/") require.NoError(t, err) origRootPath := setting.StaticRootPath origRaw := setting.Raw origEnv := setting.Env t.Cleanup(func() { setting.StaticRootPath = origRootPath setting.Raw = origRaw setting.Env = origEnv }) setting.StaticRootPath = staticRootPath setting.Raw = ini.Empty() setting.Env = setting.Prod t.Run("Base case", func(t *testing.T) { pm := &PluginManager{ Cfg: &setting.Cfg{ Raw: ini.Empty(), Env: setting.Prod, StaticRootPath: staticRootPath, PluginSettings: setting.PluginSettings{ "nginx-app": map[string]string{ "path": "testdata/test-app", }, }, }, } err := pm.Init() require.NoError(t, err) assert.Empty(t, pm.scanningErrors) assert.Greater(t, len(DataSources), 1) assert.Greater(t, len(Panels), 1) assert.Equal(t, "app/plugins/datasource/graphite/module", DataSources["graphite"].Module) assert.NotEmpty(t, Apps) assert.Equal(t, "public/plugins/test-app/img/logo_large.png", Apps["test-app"].Info.Logos.Large) assert.Equal(t, "public/plugins/test-app/img/screenshot2.png", Apps["test-app"].Info.Screenshots[1].Path) }) t.Run("With external back-end plugin lacking signature", func(t *testing.T) { pm := &PluginManager{ Cfg: &setting.Cfg{PluginsPath: "testdata/unsigned"}, } err := pm.Init() require.NoError(t, err) assert.Equal(t, []error{fmt.Errorf(`plugin "test" is unsigned`)}, pm.scanningErrors) }) t.Run("With external unsigned back-end plugin and configuration disabling signature check of this plugin", func(t *testing.T) { pm := &PluginManager{ Cfg: &setting.Cfg{ PluginsPath: "testdata/unsigned", PluginsAllowUnsigned: []string{"test"}, }, BackendPluginManager: &fakeBackendPluginManager{}, } err := pm.Init() require.NoError(t, err) assert.Empty(t, pm.scanningErrors) }) t.Run("With external back-end plugin with invalid v1 signature", func(t *testing.T) { pm := &PluginManager{ Cfg: &setting.Cfg{ PluginsPath: "testdata/invalid-v1-signature", }, } err := pm.Init() require.NoError(t, err) assert.Equal(t, []error{fmt.Errorf(`plugin "test" has an invalid signature`)}, pm.scanningErrors) }) t.Run("With external back-end plugin lacking files listed in manifest", func(t *testing.T) { fm := &fakeBackendPluginManager{} pm := &PluginManager{ Cfg: &setting.Cfg{ PluginsPath: "testdata/lacking-files", }, BackendPluginManager: fm, } err := pm.Init() require.NoError(t, err) assert.Equal(t, []error{fmt.Errorf(`plugin "test"'s signature has been modified`)}, pm.scanningErrors) }) t.Run("Transform plugins should be ignored when expressions feature is off", func(t *testing.T) { fm := fakeBackendPluginManager{} pm := &PluginManager{ Cfg: &setting.Cfg{ PluginsPath: "testdata/behind-feature-flag", }, BackendPluginManager: &fm, } err := pm.Init() require.NoError(t, err) assert.Empty(t, pm.scanningErrors) assert.Empty(t, fm.registeredPlugins) }) t.Run("With nested plugin duplicating parent", func(t *testing.T) { pm := &PluginManager{ Cfg: &setting.Cfg{ PluginsPath: "testdata/duplicate-plugins", }, } err := pm.Init() require.NoError(t, err) assert.Len(t, pm.scanningErrors, 1) assert.True(t, errors.Is(pm.scanningErrors[0], duplicatePluginError{})) }) t.Run("With external back-end plugin with valid v2 signature", func(t *testing.T) { pm := &PluginManager{ Cfg: &setting.Cfg{ PluginsPath: "testdata/valid-v2-signature", }, BackendPluginManager: &fakeBackendPluginManager{}, } err := pm.Init() require.NoError(t, err) require.Empty(t, pm.scanningErrors) pluginId := "test" assert.NotNil(t, Plugins[pluginId]) assert.Equal(t, "datasource", Plugins[pluginId].Type) assert.Equal(t, "Test", Plugins[pluginId].Name) assert.Equal(t, pluginId, Plugins[pluginId].Id) assert.Equal(t, "1.0.0", Plugins[pluginId].Info.Version) assert.Equal(t, pluginSignatureValid, Plugins[pluginId].Signature) assert.Equal(t, grafanaType, Plugins[pluginId].SignatureType) assert.Equal(t, "Grafana Labs", Plugins[pluginId].SignatureOrg) assert.False(t, Plugins[pluginId].IsCorePlugin) }) t.Run("With back-end plugin with invalid v2 private signature (mismatched root URL)", func(t *testing.T) { origAppURL := setting.AppUrl t.Cleanup(func() { setting.AppUrl = origAppURL }) setting.AppUrl = "http://localhost:1234" pm := &PluginManager{ Cfg: &setting.Cfg{ PluginsPath: "testdata/valid-v2-pvt-signature", }, } err := pm.Init() require.NoError(t, err) assert.Equal(t, []error{fmt.Errorf(`plugin "test" has an invalid signature`)}, pm.scanningErrors) assert.Nil(t, Plugins[("test")]) }) t.Run("With back-end plugin with valid v2 private signature", func(t *testing.T) { origAppURL := setting.AppUrl t.Cleanup(func() { setting.AppUrl = origAppURL }) setting.AppUrl = "http://localhost:3000/" pm := &PluginManager{ Cfg: &setting.Cfg{ PluginsPath: "testdata/valid-v2-pvt-signature", }, BackendPluginManager: &fakeBackendPluginManager{}, } err := pm.Init() require.NoError(t, err) require.Empty(t, pm.scanningErrors) pluginId := "test" assert.NotNil(t, Plugins[pluginId]) assert.Equal(t, "datasource", Plugins[pluginId].Type) assert.Equal(t, "Test", Plugins[pluginId].Name) assert.Equal(t, pluginId, Plugins[pluginId].Id) assert.Equal(t, "1.0.0", Plugins[pluginId].Info.Version) assert.Equal(t, pluginSignatureValid, Plugins[pluginId].Signature) assert.Equal(t, privateType, Plugins[pluginId].SignatureType) assert.Equal(t, "Will Browne", Plugins[pluginId].SignatureOrg) assert.False(t, Plugins[pluginId].IsCorePlugin) }) t.Run("With back-end plugin with modified v2 signature (missing file from plugin dir)", func(t *testing.T) { origAppURL := setting.AppUrl t.Cleanup(func() { setting.AppUrl = origAppURL }) setting.AppUrl = "http://localhost:3000/" pm := &PluginManager{ Cfg: &setting.Cfg{ PluginsPath: "testdata/invalid-v2-signature", }, BackendPluginManager: &fakeBackendPluginManager{}, } err := pm.Init() require.NoError(t, err) assert.Equal(t, []error{fmt.Errorf(`plugin "test"'s signature has been modified`)}, pm.scanningErrors) assert.Nil(t, Plugins[("test")]) }) t.Run("With back-end plugin with modified v2 signature (unaccounted file in plugin dir)", func(t *testing.T) { origAppURL := setting.AppUrl t.Cleanup(func() { setting.AppUrl = origAppURL }) setting.AppUrl = "http://localhost:3000/" pm := &PluginManager{ Cfg: &setting.Cfg{ PluginsPath: "testdata/invalid-v2-signature-2", }, BackendPluginManager: &fakeBackendPluginManager{}, } err := pm.Init() require.NoError(t, err) assert.Equal(t, []error{fmt.Errorf(`plugin "test"'s signature has been modified`)}, pm.scanningErrors) assert.Nil(t, Plugins[("test")]) }) } func TestPluginManager_IsBackendOnlyPlugin(t *testing.T) { pluginScanner := &PluginScanner{} type testCase struct { name string isBackendOnly bool } for _, c := range []testCase{ {name: "renderer", isBackendOnly: true}, {name: "app", isBackendOnly: false}, } { t.Run(fmt.Sprintf("Plugin %s", c.name), func(t *testing.T) { result := pluginScanner.IsBackendOnlyPlugin(c.name) assert.Equal(t, c.isBackendOnly, result) }) } } type fakeBackendPluginManager struct { registeredPlugins []string } func (f *fakeBackendPluginManager) Register(pluginID string, factory backendplugin.PluginFactoryFunc) error { f.registeredPlugins = append(f.registeredPlugins, pluginID) return nil } func (f *fakeBackendPluginManager) StartPlugin(ctx context.Context, pluginID string) error { return nil } func (f *fakeBackendPluginManager) CollectMetrics(ctx context.Context, pluginID string) (*backend.CollectMetricsResult, error) { return nil, nil } func (f *fakeBackendPluginManager) CheckHealth(ctx context.Context, pCtx backend.PluginContext) (*backend.CheckHealthResult, error) { return nil, nil } func (f *fakeBackendPluginManager) CallResource(pluginConfig backend.PluginContext, ctx *models.ReqContext, path string) { }