Plugins: Update renderer plugin source (#80643)
* rework renderer plugin source * add tests
This commit is contained in:
@@ -19,22 +19,16 @@ import (
|
||||
"github.com/grafana/grafana/pkg/plugins/manager/registry"
|
||||
"github.com/grafana/grafana/pkg/plugins/manager/signature"
|
||||
"github.com/grafana/grafana/pkg/plugins/manager/sources"
|
||||
"github.com/grafana/grafana/pkg/services/featuremgmt"
|
||||
"github.com/grafana/grafana/pkg/services/rendering"
|
||||
)
|
||||
|
||||
func ProvideService(cfg *config.Cfg, registry registry.Service, licensing plugins.Licensing,
|
||||
features featuremgmt.FeatureToggles) (*Manager, error) {
|
||||
l, err := createLoader(cfg, registry, licensing, features)
|
||||
func ProvideService(cfg *config.Cfg, registry registry.Service, licensing plugins.Licensing) (*Manager, error) {
|
||||
l, err := createLoader(cfg, registry, licensing)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
return &Manager{
|
||||
cfg: cfg,
|
||||
loader: l,
|
||||
log: log.New("plugins.renderer"),
|
||||
}, nil
|
||||
return NewManager(cfg, l), nil
|
||||
}
|
||||
|
||||
type Manager struct {
|
||||
@@ -45,6 +39,14 @@ type Manager struct {
|
||||
renderer *Plugin
|
||||
}
|
||||
|
||||
func NewManager(cfg *config.Cfg, loader loader.Service) *Manager {
|
||||
return &Manager{
|
||||
cfg: cfg,
|
||||
loader: loader,
|
||||
log: log.New("renderer.manager"),
|
||||
}
|
||||
}
|
||||
|
||||
type Plugin struct {
|
||||
plugin *plugins.Plugin
|
||||
|
||||
@@ -77,22 +79,29 @@ func (m *Manager) Renderer(ctx context.Context) (rendering.Plugin, bool) {
|
||||
return m.renderer, true
|
||||
}
|
||||
|
||||
ps, err := m.loader.Load(ctx, sources.NewLocalSource(plugins.ClassExternal, []string{m.cfg.PluginsPath}))
|
||||
srcs, err := sources.DirAsLocalSources(m.cfg.PluginsPath, plugins.ClassExternal)
|
||||
if err != nil {
|
||||
m.log.Error("Failed to load renderer plugin", "error", err)
|
||||
m.log.Error("Failed to get renderer plugin sources", "error", err)
|
||||
return nil, false
|
||||
}
|
||||
|
||||
if len(ps) >= 1 {
|
||||
m.renderer = &Plugin{plugin: ps[0]}
|
||||
return m.renderer, true
|
||||
for _, src := range srcs {
|
||||
ps, err := m.loader.Load(ctx, src)
|
||||
if err != nil {
|
||||
m.log.Error("Failed to load renderer plugin", "error", err)
|
||||
return nil, false
|
||||
}
|
||||
|
||||
if len(ps) >= 1 {
|
||||
m.renderer = &Plugin{plugin: ps[0]}
|
||||
return m.renderer, true
|
||||
}
|
||||
}
|
||||
|
||||
return nil, false
|
||||
}
|
||||
|
||||
func createLoader(cfg *config.Cfg, pr registry.Service, l plugins.Licensing,
|
||||
features featuremgmt.FeatureToggles) (loader.Service, error) {
|
||||
func createLoader(cfg *config.Cfg, pr registry.Service, l plugins.Licensing) (loader.Service, error) {
|
||||
d := discovery.New(cfg, discovery.Opts{
|
||||
FindFilterFuncs: []discovery.FindFilterFunc{
|
||||
discovery.NewPermittedPluginTypesFilterStep([]plugins.Type{plugins.TypeRenderer}),
|
||||
|
||||
@@ -0,0 +1,82 @@
|
||||
package renderer
|
||||
|
||||
import (
|
||||
"context"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"github.com/stretchr/testify/require"
|
||||
|
||||
"github.com/grafana/grafana/pkg/plugins"
|
||||
"github.com/grafana/grafana/pkg/plugins/config"
|
||||
"github.com/grafana/grafana/pkg/plugins/manager/fakes"
|
||||
)
|
||||
|
||||
func TestRenderer(t *testing.T) {
|
||||
t.Run("Test Renderer will treat directories under plugins path as individual sources", func(t *testing.T) {
|
||||
testdataDir := filepath.Join("testdata", "plugins")
|
||||
|
||||
numLoaded := 0
|
||||
numUnloaded := 0
|
||||
loader := &fakes.FakeLoader{
|
||||
LoadFunc: func(ctx context.Context, src plugins.PluginSource) ([]*plugins.Plugin, error) {
|
||||
require.True(t, src.PluginClass(ctx) == plugins.ClassExternal)
|
||||
require.Len(t, src.PluginURIs(ctx), 1)
|
||||
require.True(t, strings.HasPrefix(src.PluginURIs(ctx)[0], testdataDir))
|
||||
|
||||
numLoaded++
|
||||
return []*plugins.Plugin{}, nil
|
||||
},
|
||||
UnloadFunc: func(_ context.Context, _ *plugins.Plugin) (*plugins.Plugin, error) {
|
||||
numUnloaded++
|
||||
return nil, nil
|
||||
},
|
||||
}
|
||||
cfg := &config.Cfg{
|
||||
PluginsPath: filepath.Join(testdataDir),
|
||||
}
|
||||
|
||||
m := NewManager(cfg, loader)
|
||||
|
||||
r, exists := m.Renderer(context.Background())
|
||||
require.False(t, exists)
|
||||
require.Equal(t, 4, numLoaded)
|
||||
require.Equal(t, 0, numUnloaded)
|
||||
require.Nil(t, r)
|
||||
})
|
||||
|
||||
t.Run("Test Renderer load all directories until a plugin is returned", func(t *testing.T) {
|
||||
testdataDir := filepath.Join("testdata", "plugins")
|
||||
|
||||
numLoaded := 0
|
||||
numUnloaded := 0
|
||||
p := &plugins.Plugin{
|
||||
JSONData: plugins.JSONData{ID: "test"},
|
||||
}
|
||||
loader := &fakes.FakeLoader{
|
||||
LoadFunc: func(ctx context.Context, src plugins.PluginSource) ([]*plugins.Plugin, error) {
|
||||
numLoaded++
|
||||
if strings.HasPrefix(src.PluginURIs(ctx)[0], filepath.Join(testdataDir, "renderer")) {
|
||||
return []*plugins.Plugin{p}, nil
|
||||
}
|
||||
return []*plugins.Plugin{}, nil
|
||||
},
|
||||
UnloadFunc: func(_ context.Context, _ *plugins.Plugin) (*plugins.Plugin, error) {
|
||||
numUnloaded++
|
||||
return nil, nil
|
||||
},
|
||||
}
|
||||
cfg := &config.Cfg{
|
||||
PluginsPath: filepath.Join(testdataDir),
|
||||
}
|
||||
|
||||
m := NewManager(cfg, loader)
|
||||
|
||||
r, exists := m.Renderer(context.Background())
|
||||
require.True(t, exists)
|
||||
require.Equal(t, 3, numLoaded)
|
||||
require.Equal(t, 0, numUnloaded)
|
||||
require.NotNil(t, r)
|
||||
})
|
||||
}
|
||||
@@ -0,0 +1,3 @@
|
||||
{
|
||||
"type": "app"
|
||||
}
|
||||
+3
@@ -0,0 +1,3 @@
|
||||
{
|
||||
"type": "datasource"
|
||||
}
|
||||
+3
@@ -0,0 +1,3 @@
|
||||
{
|
||||
"type": "renderer"
|
||||
}
|
||||
+3
@@ -0,0 +1,3 @@
|
||||
{
|
||||
"type": "secretsmanager"
|
||||
}
|
||||
Reference in New Issue
Block a user