opensource/grafana
1
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-08-02 14:52:16 +08:00
Code Issues Packages Projects Releases Wiki Activity

Backend: Migrate to using non-global configuration (#31856)

Browse Source 
Signed-off-by: Arve Knudsen <arve.knudsen@gmail.com>
This commit is contained in:
Arve Knudsen
2021-03-10 12:41:29 +01:00
committed by GitHub
parent bac1721546
commit 47f13abf7a
19 changed files with 241 additions and 260 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
pkg/plugins/app_plugin.go
View File

@ -77,13 +77,14 @@ func (app *AppPlugin) Load(decoder *json.Decoder, base *PluginBase, backendPlugi
return app, nil
}
func (app *AppPlugin) InitApp(panels map[string]*PanelPlugin, dataSources map[string]*DataSourcePlugin) []*PluginStaticRoute {
staticRoutes := app.InitFrontendPlugin()
func (app *AppPlugin) InitApp(panels map[string]*PanelPlugin, dataSources map[string]*DataSourcePlugin,
cfg *setting.Cfg) []*PluginStaticRoute {
staticRoutes := app.InitFrontendPlugin(cfg)
// check if we have child panels
for _, panel := range panels {
if strings.HasPrefix(panel.PluginDir, app.PluginDir) {
panel.setPathsBasedOnApp(app)
panel.setPathsBasedOnApp(app, cfg)
app.FoundChildPlugins = append(app.FoundChildPlugins, &PluginInclude{
Name: panel.Name,
Id: panel.Id,
@ -95,7 +96,7 @@ func (app *AppPlugin) InitApp(panels map[string]*PanelPlugin, dataSources map[st
// check if we have child datasources
for _, ds := range dataSources {
if strings.HasPrefix(ds.PluginDir, app.PluginDir) {
ds.setPathsBasedOnApp(app)
ds.setPathsBasedOnApp(app, cfg)
app.FoundChildPlugins = append(app.FoundChildPlugins, &PluginInclude{
Name: ds.Name,
Id: ds.Id,
@ -110,10 +111,10 @@ func (app *AppPlugin) InitApp(panels map[string]*PanelPlugin, dataSources map[st
include.Slug = slug.Make(include.Name)
}
if include.Type == "page" && include.DefaultNav {
app.DefaultNavUrl = setting.AppSubUrl + "/plugins/" + app.Id + "/page/" + include.Slug
app.DefaultNavUrl = cfg.AppSubURL + "/plugins/" + app.Id + "/page/" + include.Slug
}
if include.Type == "dashboard" && include.DefaultNav {
app.DefaultNavUrl = setting.AppSubUrl + "/dashboard/db/" + include.Slug
app.DefaultNavUrl = cfg.AppSubURL + "/dashboard/db/" + include.Slug
}
}

18
pkg/plugins/frontend_plugin.go
View File

@ -14,9 +14,9 @@ type FrontendPluginBase struct {
PluginBase
}
func (fp *FrontendPluginBase) InitFrontendPlugin() []*PluginStaticRoute {
func (fp *FrontendPluginBase) InitFrontendPlugin(cfg *setting.Cfg) []*PluginStaticRoute {
var staticRoutes []*PluginStaticRoute
if isExternalPlugin(fp.PluginDir) {
if isExternalPlugin(fp.PluginDir, cfg) {
staticRoutes = []*PluginStaticRoute{
{
Directory: fp.PluginDir,
@ -25,7 +25,7 @@ func (fp *FrontendPluginBase) InitFrontendPlugin() []*PluginStaticRoute {
}
}
fp.handleModuleDefaults()
fp.handleModuleDefaults(cfg)
fp.Info.Logos.Small = getPluginLogoUrl(fp.Type, fp.Info.Logos.Small, fp.BaseUrl)
fp.Info.Logos.Large = getPluginLogoUrl(fp.Type, fp.Info.Logos.Large, fp.BaseUrl)
@ -45,20 +45,20 @@ func getPluginLogoUrl(pluginType, path, baseUrl string) string {
return evalRelativePluginUrlPath(path, baseUrl)
}
func (fp *FrontendPluginBase) setPathsBasedOnApp(app *AppPlugin) {
func (fp *FrontendPluginBase) setPathsBasedOnApp(app *AppPlugin, cfg *setting.Cfg) {
appSubPath := strings.ReplaceAll(strings.Replace(fp.PluginDir, app.PluginDir, "", 1), "\\", "/")
fp.IncludedInAppId = app.Id
fp.BaseUrl = app.BaseUrl
if isExternalPlugin(app.PluginDir) {
if isExternalPlugin(app.PluginDir, cfg) {
fp.Module = util.JoinURLFragments("plugins/"+app.Id, appSubPath) + "/module"
} else {
fp.Module = util.JoinURLFragments("app/plugins/app/"+app.Id, appSubPath) + "/module"
}
}
func (fp *FrontendPluginBase) handleModuleDefaults() {
if isExternalPlugin(fp.PluginDir) {
func (fp *FrontendPluginBase) handleModuleDefaults(cfg *setting.Cfg) {
if isExternalPlugin(fp.PluginDir, cfg) {
fp.Module = path.Join("plugins", fp.Id, "module")
fp.BaseUrl = path.Join("public/plugins", fp.Id)
return
@ -75,8 +75,8 @@ func (fp *FrontendPluginBase) handleModuleDefaults() {
fp.BaseUrl = path.Join("public/app/plugins", fp.Type, currentDir)
}
func isExternalPlugin(pluginDir string) bool {
return !strings.Contains(pluginDir, setting.StaticRootPath)
func isExternalPlugin(pluginDir string, cfg *setting.Cfg) bool {
return !strings.Contains(pluginDir, cfg.StaticRootPath)
}
func evalRelativePluginUrlPath(pathStr string, baseUrl string) string {

3
pkg/plugins/frontend_plugin_test.go
View File

@ -26,7 +26,8 @@ func TestFrontendPlugin(t *testing.T) {
},
},
}
fp.setPathsBasedOnApp(app)
cfg := setting.NewCfg()
fp.setPathsBasedOnApp(app, cfg)
So(fp.Module, ShouldEqual, "app/plugins/app/testdata/datasources/datasource/module")
})

8
pkg/plugins/manager/manager.go
View File

@ -130,22 +130,22 @@ func (pm *PluginManager) Init() error {
}
for _, panel := range Panels {
staticRoutes := panel.InitFrontendPlugin()
staticRoutes := panel.InitFrontendPlugin(pm.Cfg)
StaticRoutes = append(StaticRoutes, staticRoutes...)
}
for _, ds := range DataSources {
staticRoutes := ds.InitFrontendPlugin()
staticRoutes := ds.InitFrontendPlugin(pm.Cfg)
StaticRoutes = append(StaticRoutes, staticRoutes...)
}
for _, app := range Apps {
staticRoutes := app.InitApp(Panels, DataSources)
staticRoutes := app.InitApp(Panels, DataSources, pm.Cfg)
StaticRoutes = append(StaticRoutes, staticRoutes...)
}
if Renderer != nil {
staticRoutes := Renderer.InitFrontendPlugin()
staticRoutes := Renderer.InitFrontendPlugin(pm.Cfg)
StaticRoutes = append(StaticRoutes, staticRoutes...)
}

190
pkg/plugins/manager/manager_test.go
View File

@ -18,34 +18,14 @@ import (
)
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",
},
pm := createManager(t, func(pm *PluginManager) {
pm.Cfg.PluginSettings = setting.PluginSettings{
"nginx-app": map[string]string{
"path": "testdata/test-app",
},
},
}
}
})
err := pm.Init()
require.NoError(t, err)
@ -59,9 +39,9 @@ func TestPluginManager_Init(t *testing.T) {
})
t.Run("With external back-end plugin lacking signature", func(t *testing.T) {
pm := &PluginManager{
Cfg: &setting.Cfg{PluginsPath: "testdata/unsigned"},
}
pm := createManager(t, func(pm *PluginManager) {
pm.Cfg.PluginsPath = "testdata/unsigned"
})
err := pm.Init()
require.NoError(t, err)
@ -69,13 +49,10 @@ func TestPluginManager_Init(t *testing.T) {
})
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{},
}
pm := createManager(t, func(pm *PluginManager) {
pm.Cfg.PluginsPath = "testdata/unsigned"
pm.Cfg.PluginsAllowUnsigned = []string{"test"}
})
err := pm.Init()
require.NoError(t, err)
@ -83,11 +60,9 @@ func TestPluginManager_Init(t *testing.T) {
})
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",
},
}
pm := createManager(t, func(pm *PluginManager) {
pm.Cfg.PluginsPath = "testdata/invalid-v1-signature"
})
err := pm.Init()
require.NoError(t, err)
@ -96,12 +71,10 @@ func TestPluginManager_Init(t *testing.T) {
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,
}
pm := createManager(t, func(pm *PluginManager) {
pm.Cfg.PluginsPath = "testdata/lacking-files"
pm.BackendPluginManager = fm
})
err := pm.Init()
require.NoError(t, err)
@ -110,12 +83,10 @@ func TestPluginManager_Init(t *testing.T) {
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,
}
pm := createManager(t, func(pm *PluginManager) {
pm.Cfg.PluginsPath = "testdata/behind-feature-flag"
pm.BackendPluginManager = &fm
})
err := pm.Init()
require.NoError(t, err)
@ -124,11 +95,9 @@ func TestPluginManager_Init(t *testing.T) {
})
t.Run("With nested plugin duplicating parent", func(t *testing.T) {
pm := &PluginManager{
Cfg: &setting.Cfg{
PluginsPath: "testdata/duplicate-plugins",
},
}
pm := createManager(t, func(pm *PluginManager) {
pm.Cfg.PluginsPath = "testdata/duplicate-plugins"
})
err := pm.Init()
require.NoError(t, err)
@ -137,26 +106,23 @@ func TestPluginManager_Init(t *testing.T) {
})
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{},
}
pm := createManager(t, func(manager *PluginManager) {
manager.Cfg.PluginsPath = "testdata/valid-v2-signature"
})
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, plugins.PluginSignatureValid, Plugins[pluginId].Signature)
assert.Equal(t, plugins.GrafanaType, Plugins[pluginId].SignatureType)
assert.Equal(t, "Grafana Labs", Plugins[pluginId].SignatureOrg)
assert.False(t, Plugins[pluginId].IsCorePlugin)
const 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, plugins.PluginSignatureValid, Plugins[pluginID].Signature)
assert.Equal(t, plugins.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) {
@ -166,11 +132,9 @@ func TestPluginManager_Init(t *testing.T) {
})
setting.AppUrl = "http://localhost:1234"
pm := &PluginManager{
Cfg: &setting.Cfg{
PluginsPath: "testdata/valid-v2-pvt-signature",
},
}
pm := createManager(t, func(pm *PluginManager) {
pm.Cfg.PluginsPath = "testdata/valid-v2-pvt-signature"
})
err := pm.Init()
require.NoError(t, err)
@ -185,26 +149,23 @@ func TestPluginManager_Init(t *testing.T) {
})
setting.AppUrl = "http://localhost:3000/"
pm := &PluginManager{
Cfg: &setting.Cfg{
PluginsPath: "testdata/valid-v2-pvt-signature",
},
BackendPluginManager: &fakeBackendPluginManager{},
}
pm := createManager(t, func(pm *PluginManager) {
pm.Cfg.PluginsPath = "testdata/valid-v2-pvt-signature"
})
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, plugins.PluginSignatureValid, Plugins[pluginId].Signature)
assert.Equal(t, plugins.PrivateType, Plugins[pluginId].SignatureType)
assert.Equal(t, "Will Browne", Plugins[pluginId].SignatureOrg)
assert.False(t, Plugins[pluginId].IsCorePlugin)
const 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, plugins.PluginSignatureValid, Plugins[pluginID].Signature)
assert.Equal(t, plugins.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) {
@ -214,12 +175,9 @@ func TestPluginManager_Init(t *testing.T) {
})
setting.AppUrl = "http://localhost:3000/"
pm := &PluginManager{
Cfg: &setting.Cfg{
PluginsPath: "testdata/invalid-v2-signature",
},
BackendPluginManager: &fakeBackendPluginManager{},
}
pm := createManager(t, func(pm *PluginManager) {
pm.Cfg.PluginsPath = "testdata/invalid-v2-signature"
})
err := pm.Init()
require.NoError(t, err)
assert.Equal(t, []error{fmt.Errorf(`plugin "test"'s signature has been modified`)}, pm.scanningErrors)
@ -233,12 +191,9 @@ func TestPluginManager_Init(t *testing.T) {
})
setting.AppUrl = "http://localhost:3000/"
pm := &PluginManager{
Cfg: &setting.Cfg{
PluginsPath: "testdata/invalid-v2-signature-2",
},
BackendPluginManager: &fakeBackendPluginManager{},
}
pm := createManager(t, func(pm *PluginManager) {
pm.Cfg.PluginsPath = "testdata/invalid-v2-signature-2"
})
err := pm.Init()
require.NoError(t, err)
assert.Equal(t, []error{fmt.Errorf(`plugin "test"'s signature has been modified`)}, pm.scanningErrors)
@ -291,3 +246,24 @@ func (f *fakeBackendPluginManager) CheckHealth(ctx context.Context, pCtx backend
func (f *fakeBackendPluginManager) CallResource(pluginConfig backend.PluginContext, ctx *models.ReqContext, path string) {
}
func createManager(t *testing.T, cbs ...func(*PluginManager)) *PluginManager {
t.Helper()
staticRootPath, err := filepath.Abs("../../../public/")
require.NoError(t, err)
pm := &PluginManager{
Cfg: &setting.Cfg{
Raw: ini.Empty(),
Env: setting.Prod,
StaticRootPath: staticRootPath,
},
BackendPluginManager: &fakeBackendPluginManager{},
}
for _, cb := range cbs {
cb(pm)
}
return pm
}