mirror of
https://github.com/grafana/grafana.git
synced 2025-07-30 21:42:37 +08:00
Plugins: Split plugin manager into smaller components (#54384)
* split out plugin manager * remove whitespace * fix tests * split up tests * updating naming conventions * simplify manager * tidy * add more fakes * testing time * add query verif to int test * renaming * add process tests * tidy up manager tests * add extra case to int test * add more coverage to store and process tests * remove comment * fix capatilization * init on provide * remove addfromsource from API
This commit is contained in:
@ -7,6 +7,8 @@ import (
|
|||||||
)
|
)
|
||||||
|
|
||||||
type fakePluginManager struct {
|
type fakePluginManager struct {
|
||||||
|
plugins.Manager
|
||||||
|
|
||||||
plugins map[string]fakePlugin
|
plugins map[string]fakePlugin
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -34,8 +34,12 @@ import (
|
|||||||
"github.com/grafana/grafana/pkg/plugins"
|
"github.com/grafana/grafana/pkg/plugins"
|
||||||
"github.com/grafana/grafana/pkg/plugins/backendplugin/coreplugin"
|
"github.com/grafana/grafana/pkg/plugins/backendplugin/coreplugin"
|
||||||
"github.com/grafana/grafana/pkg/plugins/manager"
|
"github.com/grafana/grafana/pkg/plugins/manager"
|
||||||
|
"github.com/grafana/grafana/pkg/plugins/manager/client"
|
||||||
|
pluginDashboards "github.com/grafana/grafana/pkg/plugins/manager/dashboards"
|
||||||
"github.com/grafana/grafana/pkg/plugins/manager/loader"
|
"github.com/grafana/grafana/pkg/plugins/manager/loader"
|
||||||
|
processManager "github.com/grafana/grafana/pkg/plugins/manager/process"
|
||||||
"github.com/grafana/grafana/pkg/plugins/manager/registry"
|
"github.com/grafana/grafana/pkg/plugins/manager/registry"
|
||||||
|
managerStore "github.com/grafana/grafana/pkg/plugins/manager/store"
|
||||||
"github.com/grafana/grafana/pkg/plugins/plugincontext"
|
"github.com/grafana/grafana/pkg/plugins/plugincontext"
|
||||||
"github.com/grafana/grafana/pkg/plugins/repo"
|
"github.com/grafana/grafana/pkg/plugins/repo"
|
||||||
"github.com/grafana/grafana/pkg/services/accesscontrol"
|
"github.com/grafana/grafana/pkg/services/accesscontrol"
|
||||||
@ -176,12 +180,17 @@ var wireSet = wire.NewSet(
|
|||||||
wire.Bind(new(repo.Service), new(*repo.Manager)),
|
wire.Bind(new(repo.Service), new(*repo.Manager)),
|
||||||
manager.ProvideService,
|
manager.ProvideService,
|
||||||
wire.Bind(new(plugins.Manager), new(*manager.PluginManager)),
|
wire.Bind(new(plugins.Manager), new(*manager.PluginManager)),
|
||||||
wire.Bind(new(plugins.Client), new(*manager.PluginManager)),
|
client.ProvideService,
|
||||||
wire.Bind(new(plugins.Store), new(*manager.PluginManager)),
|
wire.Bind(new(plugins.Client), new(*client.Service)),
|
||||||
wire.Bind(new(plugins.DashboardFileStore), new(*manager.PluginManager)),
|
managerStore.ProvideService,
|
||||||
wire.Bind(new(plugins.StaticRouteResolver), new(*manager.PluginManager)),
|
wire.Bind(new(plugins.Store), new(*managerStore.Service)),
|
||||||
wire.Bind(new(plugins.RendererManager), new(*manager.PluginManager)),
|
wire.Bind(new(plugins.RendererManager), new(*managerStore.Service)),
|
||||||
wire.Bind(new(plugins.SecretsPluginManager), new(*manager.PluginManager)),
|
wire.Bind(new(plugins.SecretsPluginManager), new(*managerStore.Service)),
|
||||||
|
wire.Bind(new(plugins.StaticRouteResolver), new(*managerStore.Service)),
|
||||||
|
pluginDashboards.ProvideFileStoreManager,
|
||||||
|
wire.Bind(new(pluginDashboards.FileStore), new(*pluginDashboards.FileStoreManager)),
|
||||||
|
processManager.ProvideService,
|
||||||
|
wire.Bind(new(processManager.Service), new(*processManager.Manager)),
|
||||||
coreplugin.ProvideCoreRegistry,
|
coreplugin.ProvideCoreRegistry,
|
||||||
loader.ProvideService,
|
loader.ProvideService,
|
||||||
wire.Bind(new(loader.Service), new(*loader.Loader)),
|
wire.Bind(new(loader.Service), new(*loader.Loader)),
|
||||||
|
@ -2,7 +2,6 @@ package plugins
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
"io"
|
|
||||||
|
|
||||||
"github.com/grafana/grafana-plugin-sdk-go/backend"
|
"github.com/grafana/grafana-plugin-sdk-go/backend"
|
||||||
|
|
||||||
@ -24,6 +23,11 @@ type Manager interface {
|
|||||||
Remove(ctx context.Context, pluginID string) error
|
Remove(ctx context.Context, pluginID string) error
|
||||||
}
|
}
|
||||||
|
|
||||||
|
type PluginSource struct {
|
||||||
|
Class Class
|
||||||
|
Paths []string
|
||||||
|
}
|
||||||
|
|
||||||
type CompatOpts struct {
|
type CompatOpts struct {
|
||||||
GrafanaVersion string
|
GrafanaVersion string
|
||||||
OS string
|
OS string
|
||||||
@ -70,33 +74,3 @@ type PluginLoaderAuthorizer interface {
|
|||||||
// CanLoadPlugin confirms if a plugin is authorized to load
|
// CanLoadPlugin confirms if a plugin is authorized to load
|
||||||
CanLoadPlugin(plugin *Plugin) bool
|
CanLoadPlugin(plugin *Plugin) bool
|
||||||
}
|
}
|
||||||
|
|
||||||
// ListPluginDashboardFilesArgs list plugin dashboard files argument model.
|
|
||||||
type ListPluginDashboardFilesArgs struct {
|
|
||||||
PluginID string
|
|
||||||
}
|
|
||||||
|
|
||||||
// GetPluginDashboardFilesArgs list plugin dashboard files result model.
|
|
||||||
type ListPluginDashboardFilesResult struct {
|
|
||||||
FileReferences []string
|
|
||||||
}
|
|
||||||
|
|
||||||
// GetPluginDashboardFileContentsArgs get plugin dashboard file content argument model.
|
|
||||||
type GetPluginDashboardFileContentsArgs struct {
|
|
||||||
PluginID string
|
|
||||||
FileReference string
|
|
||||||
}
|
|
||||||
|
|
||||||
// GetPluginDashboardFileContentsResult get plugin dashboard file content result model.
|
|
||||||
type GetPluginDashboardFileContentsResult struct {
|
|
||||||
Content io.ReadCloser
|
|
||||||
}
|
|
||||||
|
|
||||||
// DashboardFileStore is the interface for plugin dashboard file storage.
|
|
||||||
type DashboardFileStore interface {
|
|
||||||
// ListPluginDashboardFiles lists plugin dashboard files.
|
|
||||||
ListPluginDashboardFiles(ctx context.Context, args *ListPluginDashboardFilesArgs) (*ListPluginDashboardFilesResult, error)
|
|
||||||
|
|
||||||
// GetPluginDashboardFileContents gets the referenced plugin dashboard file content.
|
|
||||||
GetPluginDashboardFileContents(ctx context.Context, args *GetPluginDashboardFileContentsArgs) (*GetPluginDashboardFileContentsResult, error)
|
|
||||||
}
|
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
package manager
|
package client
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
@ -7,12 +7,26 @@ import (
|
|||||||
|
|
||||||
"github.com/grafana/grafana-plugin-sdk-go/backend"
|
"github.com/grafana/grafana-plugin-sdk-go/backend"
|
||||||
|
|
||||||
|
"github.com/grafana/grafana/pkg/plugins"
|
||||||
"github.com/grafana/grafana/pkg/plugins/backendplugin"
|
"github.com/grafana/grafana/pkg/plugins/backendplugin"
|
||||||
"github.com/grafana/grafana/pkg/plugins/backendplugin/instrumentation"
|
"github.com/grafana/grafana/pkg/plugins/backendplugin/instrumentation"
|
||||||
|
"github.com/grafana/grafana/pkg/plugins/manager/registry"
|
||||||
)
|
)
|
||||||
|
|
||||||
func (m *PluginManager) QueryData(ctx context.Context, req *backend.QueryDataRequest) (*backend.QueryDataResponse, error) {
|
var _ plugins.Client = (*Service)(nil)
|
||||||
plugin, exists := m.plugin(ctx, req.PluginContext.PluginID)
|
|
||||||
|
type Service struct {
|
||||||
|
pluginRegistry registry.Service
|
||||||
|
}
|
||||||
|
|
||||||
|
func ProvideService(pluginRegistry registry.Service) *Service {
|
||||||
|
return &Service{
|
||||||
|
pluginRegistry: pluginRegistry,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *Service) QueryData(ctx context.Context, req *backend.QueryDataRequest) (*backend.QueryDataResponse, error) {
|
||||||
|
plugin, exists := s.plugin(ctx, req.PluginContext.PluginID)
|
||||||
if !exists {
|
if !exists {
|
||||||
return nil, backendplugin.ErrPluginNotRegistered
|
return nil, backendplugin.ErrPluginNotRegistered
|
||||||
}
|
}
|
||||||
@ -47,8 +61,8 @@ func (m *PluginManager) QueryData(ctx context.Context, req *backend.QueryDataReq
|
|||||||
return resp, err
|
return resp, err
|
||||||
}
|
}
|
||||||
|
|
||||||
func (m *PluginManager) CallResource(ctx context.Context, req *backend.CallResourceRequest, sender backend.CallResourceResponseSender) error {
|
func (s *Service) CallResource(ctx context.Context, req *backend.CallResourceRequest, sender backend.CallResourceResponseSender) error {
|
||||||
p, exists := m.plugin(ctx, req.PluginContext.PluginID)
|
p, exists := s.plugin(ctx, req.PluginContext.PluginID)
|
||||||
if !exists {
|
if !exists {
|
||||||
return backendplugin.ErrPluginNotRegistered
|
return backendplugin.ErrPluginNotRegistered
|
||||||
}
|
}
|
||||||
@ -66,8 +80,8 @@ func (m *PluginManager) CallResource(ctx context.Context, req *backend.CallResou
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (m *PluginManager) CollectMetrics(ctx context.Context, req *backend.CollectMetricsRequest) (*backend.CollectMetricsResult, error) {
|
func (s *Service) CollectMetrics(ctx context.Context, req *backend.CollectMetricsRequest) (*backend.CollectMetricsResult, error) {
|
||||||
p, exists := m.plugin(ctx, req.PluginContext.PluginID)
|
p, exists := s.plugin(ctx, req.PluginContext.PluginID)
|
||||||
if !exists {
|
if !exists {
|
||||||
return nil, backendplugin.ErrPluginNotRegistered
|
return nil, backendplugin.ErrPluginNotRegistered
|
||||||
}
|
}
|
||||||
@ -84,8 +98,8 @@ func (m *PluginManager) CollectMetrics(ctx context.Context, req *backend.Collect
|
|||||||
return resp, nil
|
return resp, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (m *PluginManager) CheckHealth(ctx context.Context, req *backend.CheckHealthRequest) (*backend.CheckHealthResult, error) {
|
func (s *Service) CheckHealth(ctx context.Context, req *backend.CheckHealthRequest) (*backend.CheckHealthResult, error) {
|
||||||
p, exists := m.plugin(ctx, req.PluginContext.PluginID)
|
p, exists := s.plugin(ctx, req.PluginContext.PluginID)
|
||||||
if !exists {
|
if !exists {
|
||||||
return nil, backendplugin.ErrPluginNotRegistered
|
return nil, backendplugin.ErrPluginNotRegistered
|
||||||
}
|
}
|
||||||
@ -111,8 +125,8 @@ func (m *PluginManager) CheckHealth(ctx context.Context, req *backend.CheckHealt
|
|||||||
return resp, nil
|
return resp, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (m *PluginManager) SubscribeStream(ctx context.Context, req *backend.SubscribeStreamRequest) (*backend.SubscribeStreamResponse, error) {
|
func (s *Service) SubscribeStream(ctx context.Context, req *backend.SubscribeStreamRequest) (*backend.SubscribeStreamResponse, error) {
|
||||||
plugin, exists := m.plugin(ctx, req.PluginContext.PluginID)
|
plugin, exists := s.plugin(ctx, req.PluginContext.PluginID)
|
||||||
if !exists {
|
if !exists {
|
||||||
return nil, backendplugin.ErrPluginNotRegistered
|
return nil, backendplugin.ErrPluginNotRegistered
|
||||||
}
|
}
|
||||||
@ -120,8 +134,8 @@ func (m *PluginManager) SubscribeStream(ctx context.Context, req *backend.Subscr
|
|||||||
return plugin.SubscribeStream(ctx, req)
|
return plugin.SubscribeStream(ctx, req)
|
||||||
}
|
}
|
||||||
|
|
||||||
func (m *PluginManager) PublishStream(ctx context.Context, req *backend.PublishStreamRequest) (*backend.PublishStreamResponse, error) {
|
func (s *Service) PublishStream(ctx context.Context, req *backend.PublishStreamRequest) (*backend.PublishStreamResponse, error) {
|
||||||
plugin, exists := m.plugin(ctx, req.PluginContext.PluginID)
|
plugin, exists := s.plugin(ctx, req.PluginContext.PluginID)
|
||||||
if !exists {
|
if !exists {
|
||||||
return nil, backendplugin.ErrPluginNotRegistered
|
return nil, backendplugin.ErrPluginNotRegistered
|
||||||
}
|
}
|
||||||
@ -129,11 +143,25 @@ func (m *PluginManager) PublishStream(ctx context.Context, req *backend.PublishS
|
|||||||
return plugin.PublishStream(ctx, req)
|
return plugin.PublishStream(ctx, req)
|
||||||
}
|
}
|
||||||
|
|
||||||
func (m *PluginManager) RunStream(ctx context.Context, req *backend.RunStreamRequest, sender *backend.StreamSender) error {
|
func (s *Service) RunStream(ctx context.Context, req *backend.RunStreamRequest, sender *backend.StreamSender) error {
|
||||||
plugin, exists := m.plugin(ctx, req.PluginContext.PluginID)
|
plugin, exists := s.plugin(ctx, req.PluginContext.PluginID)
|
||||||
if !exists {
|
if !exists {
|
||||||
return backendplugin.ErrPluginNotRegistered
|
return backendplugin.ErrPluginNotRegistered
|
||||||
}
|
}
|
||||||
|
|
||||||
return plugin.RunStream(ctx, req, sender)
|
return plugin.RunStream(ctx, req, sender)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// plugin finds a plugin with `pluginID` from the registry that is not decommissioned
|
||||||
|
func (s *Service) plugin(ctx context.Context, pluginID string) (*plugins.Plugin, bool) {
|
||||||
|
p, exists := s.pluginRegistry.Plugin(ctx, pluginID)
|
||||||
|
if !exists {
|
||||||
|
return nil, false
|
||||||
|
}
|
||||||
|
|
||||||
|
if p.IsDecommissioned() {
|
||||||
|
return nil, false
|
||||||
|
}
|
||||||
|
|
||||||
|
return p, true
|
||||||
|
}
|
@ -1,4 +1,4 @@
|
|||||||
package manager
|
package dashboards
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
@ -12,13 +12,25 @@ import (
|
|||||||
"github.com/grafana/grafana/pkg/util"
|
"github.com/grafana/grafana/pkg/util"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
var _ FileStore = (*FileStoreManager)(nil)
|
||||||
|
|
||||||
|
type FileStoreManager struct {
|
||||||
|
pluginStore plugins.Store
|
||||||
|
}
|
||||||
|
|
||||||
|
func ProvideFileStoreManager(pluginStore plugins.Store) *FileStoreManager {
|
||||||
|
return &FileStoreManager{
|
||||||
|
pluginStore: pluginStore,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
var openDashboardFile = func(name string) (fs.File, error) {
|
var openDashboardFile = func(name string) (fs.File, error) {
|
||||||
// Wrapping in filepath.Clean to properly handle
|
// Wrapping in filepath.Clean to properly handle
|
||||||
// gosec G304 Potential file inclusion via variable rule.
|
// gosec G304 Potential file inclusion via variable rule.
|
||||||
return os.Open(filepath.Clean(name))
|
return os.Open(filepath.Clean(name))
|
||||||
}
|
}
|
||||||
|
|
||||||
func (m *PluginManager) ListPluginDashboardFiles(ctx context.Context, args *plugins.ListPluginDashboardFilesArgs) (*plugins.ListPluginDashboardFilesResult, error) {
|
func (m *FileStoreManager) ListPluginDashboardFiles(ctx context.Context, args *ListPluginDashboardFilesArgs) (*ListPluginDashboardFilesResult, error) {
|
||||||
if args == nil {
|
if args == nil {
|
||||||
return nil, fmt.Errorf("args cannot be nil")
|
return nil, fmt.Errorf("args cannot be nil")
|
||||||
}
|
}
|
||||||
@ -27,7 +39,7 @@ func (m *PluginManager) ListPluginDashboardFiles(ctx context.Context, args *plug
|
|||||||
return nil, fmt.Errorf("args.PluginID cannot be empty")
|
return nil, fmt.Errorf("args.PluginID cannot be empty")
|
||||||
}
|
}
|
||||||
|
|
||||||
plugin, exists := m.Plugin(ctx, args.PluginID)
|
plugin, exists := m.pluginStore.Plugin(ctx, args.PluginID)
|
||||||
if !exists {
|
if !exists {
|
||||||
return nil, plugins.NotFoundError{PluginID: args.PluginID}
|
return nil, plugins.NotFoundError{PluginID: args.PluginID}
|
||||||
}
|
}
|
||||||
@ -37,12 +49,12 @@ func (m *PluginManager) ListPluginDashboardFiles(ctx context.Context, args *plug
|
|||||||
references = append(references, include.Path)
|
references = append(references, include.Path)
|
||||||
}
|
}
|
||||||
|
|
||||||
return &plugins.ListPluginDashboardFilesResult{
|
return &ListPluginDashboardFilesResult{
|
||||||
FileReferences: references,
|
FileReferences: references,
|
||||||
}, nil
|
}, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (m *PluginManager) GetPluginDashboardFileContents(ctx context.Context, args *plugins.GetPluginDashboardFileContentsArgs) (*plugins.GetPluginDashboardFileContentsResult, error) {
|
func (m *FileStoreManager) GetPluginDashboardFileContents(ctx context.Context, args *GetPluginDashboardFileContentsArgs) (*GetPluginDashboardFileContentsResult, error) {
|
||||||
if args == nil {
|
if args == nil {
|
||||||
return nil, fmt.Errorf("args cannot be nil")
|
return nil, fmt.Errorf("args cannot be nil")
|
||||||
}
|
}
|
||||||
@ -55,7 +67,7 @@ func (m *PluginManager) GetPluginDashboardFileContents(ctx context.Context, args
|
|||||||
return nil, fmt.Errorf("args.FileReference cannot be empty")
|
return nil, fmt.Errorf("args.FileReference cannot be empty")
|
||||||
}
|
}
|
||||||
|
|
||||||
plugin, exists := m.Plugin(ctx, args.PluginID)
|
plugin, exists := m.pluginStore.Plugin(ctx, args.PluginID)
|
||||||
if !exists {
|
if !exists {
|
||||||
return nil, plugins.NotFoundError{PluginID: args.PluginID}
|
return nil, plugins.NotFoundError{PluginID: args.PluginID}
|
||||||
}
|
}
|
||||||
@ -84,9 +96,7 @@ func (m *PluginManager) GetPluginDashboardFileContents(ctx context.Context, args
|
|||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
return &plugins.GetPluginDashboardFileContentsResult{
|
return &GetPluginDashboardFileContentsResult{
|
||||||
Content: file,
|
Content: file,
|
||||||
}, nil
|
}, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
var _ plugins.DashboardFileStore = &PluginManager{}
|
|
@ -1,4 +1,4 @@
|
|||||||
package manager
|
package dashboards
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
@ -18,18 +18,18 @@ func TestDashboardFileStore(t *testing.T) {
|
|||||||
t.Run("ListPluginDashboardFiles", func(t *testing.T) {
|
t.Run("ListPluginDashboardFiles", func(t *testing.T) {
|
||||||
testCases := []struct {
|
testCases := []struct {
|
||||||
name string
|
name string
|
||||||
args *plugins.ListPluginDashboardFilesArgs
|
args *ListPluginDashboardFilesArgs
|
||||||
}{
|
}{
|
||||||
{
|
{
|
||||||
name: "nil args should return error",
|
name: "nil args should return error",
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "empty args.PluginID should return error",
|
name: "empty args.PluginID should return error",
|
||||||
args: &plugins.ListPluginDashboardFilesArgs{},
|
args: &ListPluginDashboardFilesArgs{},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "args.PluginID with only space should return error",
|
name: "args.PluginID with only space should return error",
|
||||||
args: &plugins.ListPluginDashboardFilesArgs{PluginID: " \t "},
|
args: &ListPluginDashboardFilesArgs{PluginID: " \t "},
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -45,28 +45,28 @@ func TestDashboardFileStore(t *testing.T) {
|
|||||||
t.Run("GetPluginDashboardFileContents", func(t *testing.T) {
|
t.Run("GetPluginDashboardFileContents", func(t *testing.T) {
|
||||||
testCases := []struct {
|
testCases := []struct {
|
||||||
name string
|
name string
|
||||||
args *plugins.GetPluginDashboardFileContentsArgs
|
args *GetPluginDashboardFileContentsArgs
|
||||||
}{
|
}{
|
||||||
{
|
{
|
||||||
name: "nil args should return error",
|
name: "nil args should return error",
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "empty args.PluginID should return error",
|
name: "empty args.PluginID should return error",
|
||||||
args: &plugins.GetPluginDashboardFileContentsArgs{},
|
args: &GetPluginDashboardFileContentsArgs{},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "args.PluginID with only space should return error",
|
name: "args.PluginID with only space should return error",
|
||||||
args: &plugins.GetPluginDashboardFileContentsArgs{PluginID: " "},
|
args: &GetPluginDashboardFileContentsArgs{PluginID: " "},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "empty args.FileReference should return error",
|
name: "empty args.FileReference should return error",
|
||||||
args: &plugins.GetPluginDashboardFileContentsArgs{
|
args: &GetPluginDashboardFileContentsArgs{
|
||||||
PluginID: "pluginWithDashboards",
|
PluginID: "pluginWithDashboards",
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "args.FileReference with only space should return error",
|
name: "args.FileReference with only space should return error",
|
||||||
args: &plugins.GetPluginDashboardFileContentsArgs{
|
args: &GetPluginDashboardFileContentsArgs{
|
||||||
PluginID: "pluginWithDashboard",
|
PluginID: "pluginWithDashboard",
|
||||||
FileReference: " \t",
|
FileReference: " \t",
|
||||||
},
|
},
|
||||||
@ -85,7 +85,7 @@ func TestDashboardFileStore(t *testing.T) {
|
|||||||
|
|
||||||
t.Run("Plugin without dashboards", func(t *testing.T) {
|
t.Run("Plugin without dashboards", func(t *testing.T) {
|
||||||
t.Run("Should return zero file references", func(t *testing.T) {
|
t.Run("Should return zero file references", func(t *testing.T) {
|
||||||
res, err := m.ListPluginDashboardFiles(context.Background(), &plugins.ListPluginDashboardFilesArgs{
|
res, err := m.ListPluginDashboardFiles(context.Background(), &ListPluginDashboardFilesArgs{
|
||||||
PluginID: "pluginWithoutDashboards",
|
PluginID: "pluginWithoutDashboards",
|
||||||
})
|
})
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
@ -94,7 +94,7 @@ func TestDashboardFileStore(t *testing.T) {
|
|||||||
})
|
})
|
||||||
|
|
||||||
t.Run("Should return file not found error when trying to get non-existing plugin dashboard file content", func(t *testing.T) {
|
t.Run("Should return file not found error when trying to get non-existing plugin dashboard file content", func(t *testing.T) {
|
||||||
res, err := m.GetPluginDashboardFileContents(context.Background(), &plugins.GetPluginDashboardFileContentsArgs{
|
res, err := m.GetPluginDashboardFileContents(context.Background(), &GetPluginDashboardFileContentsArgs{
|
||||||
PluginID: "pluginWithoutDashboards",
|
PluginID: "pluginWithoutDashboards",
|
||||||
FileReference: "dashboards/dash2.json",
|
FileReference: "dashboards/dash2.json",
|
||||||
})
|
})
|
||||||
@ -106,7 +106,7 @@ func TestDashboardFileStore(t *testing.T) {
|
|||||||
|
|
||||||
t.Run("Plugin with dashboards", func(t *testing.T) {
|
t.Run("Plugin with dashboards", func(t *testing.T) {
|
||||||
t.Run("Should return two file references", func(t *testing.T) {
|
t.Run("Should return two file references", func(t *testing.T) {
|
||||||
res, err := m.ListPluginDashboardFiles(context.Background(), &plugins.ListPluginDashboardFilesArgs{
|
res, err := m.ListPluginDashboardFiles(context.Background(), &ListPluginDashboardFilesArgs{
|
||||||
PluginID: "pluginWithDashboards",
|
PluginID: "pluginWithDashboards",
|
||||||
})
|
})
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
@ -136,7 +136,7 @@ func TestDashboardFileStore(t *testing.T) {
|
|||||||
})
|
})
|
||||||
|
|
||||||
t.Run("Should return file not found error when trying to get non-existing plugin dashboard file content", func(t *testing.T) {
|
t.Run("Should return file not found error when trying to get non-existing plugin dashboard file content", func(t *testing.T) {
|
||||||
res, err := m.GetPluginDashboardFileContents(context.Background(), &plugins.GetPluginDashboardFileContentsArgs{
|
res, err := m.GetPluginDashboardFileContents(context.Background(), &GetPluginDashboardFileContentsArgs{
|
||||||
PluginID: "pluginWithDashboards",
|
PluginID: "pluginWithDashboards",
|
||||||
FileReference: "dashboards/dash3.json",
|
FileReference: "dashboards/dash3.json",
|
||||||
})
|
})
|
||||||
@ -146,7 +146,7 @@ func TestDashboardFileStore(t *testing.T) {
|
|||||||
})
|
})
|
||||||
|
|
||||||
t.Run("Should return file content for dashboards/dash1.json", func(t *testing.T) {
|
t.Run("Should return file content for dashboards/dash1.json", func(t *testing.T) {
|
||||||
res, err := m.GetPluginDashboardFileContents(context.Background(), &plugins.GetPluginDashboardFileContentsArgs{
|
res, err := m.GetPluginDashboardFileContents(context.Background(), &GetPluginDashboardFileContentsArgs{
|
||||||
PluginID: "pluginWithDashboards",
|
PluginID: "pluginWithDashboards",
|
||||||
FileReference: "dashboards/dash1.json",
|
FileReference: "dashboards/dash1.json",
|
||||||
})
|
})
|
||||||
@ -160,7 +160,7 @@ func TestDashboardFileStore(t *testing.T) {
|
|||||||
})
|
})
|
||||||
|
|
||||||
t.Run("Should return file content for dashboards/dash2.json", func(t *testing.T) {
|
t.Run("Should return file content for dashboards/dash2.json", func(t *testing.T) {
|
||||||
res, err := m.GetPluginDashboardFileContents(context.Background(), &plugins.GetPluginDashboardFileContentsArgs{
|
res, err := m.GetPluginDashboardFileContents(context.Background(), &GetPluginDashboardFileContentsArgs{
|
||||||
PluginID: "pluginWithDashboards",
|
PluginID: "pluginWithDashboards",
|
||||||
FileReference: "dashboards/dash2.json",
|
FileReference: "dashboards/dash2.json",
|
||||||
})
|
})
|
||||||
@ -174,7 +174,7 @@ func TestDashboardFileStore(t *testing.T) {
|
|||||||
})
|
})
|
||||||
|
|
||||||
t.Run("Should return error when trying to read relative file", func(t *testing.T) {
|
t.Run("Should return error when trying to read relative file", func(t *testing.T) {
|
||||||
res, err := m.GetPluginDashboardFileContents(context.Background(), &plugins.GetPluginDashboardFileContentsArgs{
|
res, err := m.GetPluginDashboardFileContents(context.Background(), &GetPluginDashboardFileContentsArgs{
|
||||||
PluginID: "pluginWithDashboards",
|
PluginID: "pluginWithDashboards",
|
||||||
FileReference: "dashboards/../dash2.json",
|
FileReference: "dashboards/../dash2.json",
|
||||||
})
|
})
|
||||||
@ -186,12 +186,12 @@ func TestDashboardFileStore(t *testing.T) {
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
func setupPluginDashboardsForTest(t *testing.T) *PluginManager {
|
func setupPluginDashboardsForTest(t *testing.T) *FileStoreManager {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
|
|
||||||
return &PluginManager{
|
return &FileStoreManager{
|
||||||
pluginRegistry: &fakePluginRegistry{
|
pluginStore: &fakePluginStore{
|
||||||
store: map[string]*plugins.Plugin{
|
plugins: map[string]plugins.PluginDTO{
|
||||||
"pluginWithoutDashboards": {
|
"pluginWithoutDashboards": {
|
||||||
JSONData: plugins.JSONData{
|
JSONData: plugins.JSONData{
|
||||||
Includes: []*plugins.Includes{
|
Includes: []*plugins.Includes{
|
||||||
@ -223,3 +223,20 @@ func setupPluginDashboardsForTest(t *testing.T) *PluginManager {
|
|||||||
},
|
},
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
type fakePluginStore struct {
|
||||||
|
plugins map[string]plugins.PluginDTO
|
||||||
|
}
|
||||||
|
|
||||||
|
func (pr fakePluginStore) Plugin(_ context.Context, pluginID string) (plugins.PluginDTO, bool) {
|
||||||
|
p, exists := pr.plugins[pluginID]
|
||||||
|
return p, exists
|
||||||
|
}
|
||||||
|
|
||||||
|
func (pr fakePluginStore) Plugins(_ context.Context, _ ...plugins.Type) []plugins.PluginDTO {
|
||||||
|
var result []plugins.PluginDTO
|
||||||
|
for _, v := range pr.plugins {
|
||||||
|
result = append(result, v)
|
||||||
|
}
|
||||||
|
return result
|
||||||
|
}
|
35
pkg/plugins/manager/dashboards/ifaces.go
Normal file
35
pkg/plugins/manager/dashboards/ifaces.go
Normal file
@ -0,0 +1,35 @@
|
|||||||
|
package dashboards
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"io"
|
||||||
|
)
|
||||||
|
|
||||||
|
// FileStore is the interface for plugin dashboard file storage.
|
||||||
|
type FileStore interface {
|
||||||
|
// ListPluginDashboardFiles lists plugin dashboard files.
|
||||||
|
ListPluginDashboardFiles(ctx context.Context, args *ListPluginDashboardFilesArgs) (*ListPluginDashboardFilesResult, error)
|
||||||
|
// GetPluginDashboardFileContents gets the referenced plugin dashboard file content.
|
||||||
|
GetPluginDashboardFileContents(ctx context.Context, args *GetPluginDashboardFileContentsArgs) (*GetPluginDashboardFileContentsResult, error)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ListPluginDashboardFilesArgs list plugin dashboard files argument model.
|
||||||
|
type ListPluginDashboardFilesArgs struct {
|
||||||
|
PluginID string
|
||||||
|
}
|
||||||
|
|
||||||
|
// ListPluginDashboardFilesResult list plugin dashboard files result model.
|
||||||
|
type ListPluginDashboardFilesResult struct {
|
||||||
|
FileReferences []string
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetPluginDashboardFileContentsArgs get plugin dashboard file content argument model.
|
||||||
|
type GetPluginDashboardFileContentsArgs struct {
|
||||||
|
PluginID string
|
||||||
|
FileReference string
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetPluginDashboardFileContentsResult get plugin dashboard file content result model.
|
||||||
|
type GetPluginDashboardFileContentsResult struct {
|
||||||
|
Content io.ReadCloser
|
||||||
|
}
|
260
pkg/plugins/manager/fakes/fakes.go
Normal file
260
pkg/plugins/manager/fakes/fakes.go
Normal file
@ -0,0 +1,260 @@
|
|||||||
|
package fakes
|
||||||
|
|
||||||
|
import (
|
||||||
|
"archive/zip"
|
||||||
|
"context"
|
||||||
|
"sync"
|
||||||
|
|
||||||
|
"github.com/grafana/grafana-plugin-sdk-go/backend"
|
||||||
|
|
||||||
|
"github.com/grafana/grafana/pkg/infra/log"
|
||||||
|
"github.com/grafana/grafana/pkg/plugins"
|
||||||
|
"github.com/grafana/grafana/pkg/plugins/backendplugin"
|
||||||
|
"github.com/grafana/grafana/pkg/plugins/repo"
|
||||||
|
"github.com/grafana/grafana/pkg/plugins/storage"
|
||||||
|
)
|
||||||
|
|
||||||
|
type FakeLoader struct {
|
||||||
|
LoadFunc func(_ context.Context, _ plugins.Class, paths []string, _ map[string]struct{}) ([]*plugins.Plugin, error)
|
||||||
|
|
||||||
|
LoadedPaths []string
|
||||||
|
}
|
||||||
|
|
||||||
|
func (l *FakeLoader) Load(ctx context.Context, class plugins.Class, paths []string, ignore map[string]struct{}) ([]*plugins.Plugin, error) {
|
||||||
|
if l.LoadFunc != nil {
|
||||||
|
return l.LoadFunc(ctx, class, paths, ignore)
|
||||||
|
}
|
||||||
|
|
||||||
|
l.LoadedPaths = append(l.LoadedPaths, paths...)
|
||||||
|
|
||||||
|
return nil, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
type FakePluginClient struct {
|
||||||
|
ID string
|
||||||
|
Managed bool
|
||||||
|
Log log.Logger
|
||||||
|
|
||||||
|
startCount int
|
||||||
|
stopCount int
|
||||||
|
exited bool
|
||||||
|
decommissioned bool
|
||||||
|
backend.CollectMetricsHandlerFunc
|
||||||
|
backend.CheckHealthHandlerFunc
|
||||||
|
backend.QueryDataHandlerFunc
|
||||||
|
backend.CallResourceHandlerFunc
|
||||||
|
mutex sync.RWMutex
|
||||||
|
|
||||||
|
backendplugin.Plugin
|
||||||
|
}
|
||||||
|
|
||||||
|
func (pc *FakePluginClient) PluginID() string {
|
||||||
|
return pc.ID
|
||||||
|
}
|
||||||
|
|
||||||
|
func (pc *FakePluginClient) Logger() log.Logger {
|
||||||
|
return pc.Log
|
||||||
|
}
|
||||||
|
|
||||||
|
func (pc *FakePluginClient) Start(_ context.Context) error {
|
||||||
|
pc.mutex.Lock()
|
||||||
|
defer pc.mutex.Unlock()
|
||||||
|
pc.exited = false
|
||||||
|
pc.startCount++
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (pc *FakePluginClient) Stop(_ context.Context) error {
|
||||||
|
pc.mutex.Lock()
|
||||||
|
defer pc.mutex.Unlock()
|
||||||
|
pc.stopCount++
|
||||||
|
pc.exited = true
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (pc *FakePluginClient) IsManaged() bool {
|
||||||
|
return pc.Managed
|
||||||
|
}
|
||||||
|
|
||||||
|
func (pc *FakePluginClient) Exited() bool {
|
||||||
|
pc.mutex.RLock()
|
||||||
|
defer pc.mutex.RUnlock()
|
||||||
|
return pc.exited
|
||||||
|
}
|
||||||
|
|
||||||
|
func (pc *FakePluginClient) Decommission() error {
|
||||||
|
pc.mutex.Lock()
|
||||||
|
defer pc.mutex.Unlock()
|
||||||
|
pc.decommissioned = true
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (pc *FakePluginClient) IsDecommissioned() bool {
|
||||||
|
pc.mutex.RLock()
|
||||||
|
defer pc.mutex.RUnlock()
|
||||||
|
return pc.decommissioned
|
||||||
|
}
|
||||||
|
|
||||||
|
func (pc *FakePluginClient) CollectMetrics(ctx context.Context, req *backend.CollectMetricsRequest) (*backend.CollectMetricsResult, error) {
|
||||||
|
if pc.CollectMetricsHandlerFunc != nil {
|
||||||
|
return pc.CollectMetricsHandlerFunc(ctx, req)
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil, backendplugin.ErrMethodNotImplemented
|
||||||
|
}
|
||||||
|
|
||||||
|
func (pc *FakePluginClient) CheckHealth(ctx context.Context, req *backend.CheckHealthRequest) (*backend.CheckHealthResult, error) {
|
||||||
|
if pc.CheckHealthHandlerFunc != nil {
|
||||||
|
return pc.CheckHealthHandlerFunc(ctx, req)
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil, backendplugin.ErrMethodNotImplemented
|
||||||
|
}
|
||||||
|
|
||||||
|
func (pc *FakePluginClient) QueryData(ctx context.Context, req *backend.QueryDataRequest) (*backend.QueryDataResponse, error) {
|
||||||
|
if pc.QueryDataHandlerFunc != nil {
|
||||||
|
return pc.QueryDataHandlerFunc(ctx, req)
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil, backendplugin.ErrMethodNotImplemented
|
||||||
|
}
|
||||||
|
|
||||||
|
func (pc *FakePluginClient) CallResource(ctx context.Context, req *backend.CallResourceRequest, sender backend.CallResourceResponseSender) error {
|
||||||
|
if pc.CallResourceHandlerFunc != nil {
|
||||||
|
return pc.CallResourceHandlerFunc(ctx, req, sender)
|
||||||
|
}
|
||||||
|
|
||||||
|
return backendplugin.ErrMethodNotImplemented
|
||||||
|
}
|
||||||
|
|
||||||
|
func (pc *FakePluginClient) SubscribeStream(_ context.Context, _ *backend.SubscribeStreamRequest) (*backend.SubscribeStreamResponse, error) {
|
||||||
|
return nil, backendplugin.ErrMethodNotImplemented
|
||||||
|
}
|
||||||
|
|
||||||
|
func (pc *FakePluginClient) PublishStream(_ context.Context, _ *backend.PublishStreamRequest) (*backend.PublishStreamResponse, error) {
|
||||||
|
return nil, backendplugin.ErrMethodNotImplemented
|
||||||
|
}
|
||||||
|
|
||||||
|
func (pc *FakePluginClient) RunStream(_ context.Context, _ *backend.RunStreamRequest, _ *backend.StreamSender) error {
|
||||||
|
return backendplugin.ErrMethodNotImplemented
|
||||||
|
}
|
||||||
|
|
||||||
|
type FakePluginRegistry struct {
|
||||||
|
Store map[string]*plugins.Plugin
|
||||||
|
}
|
||||||
|
|
||||||
|
func NewFakePluginRegistry() *FakePluginRegistry {
|
||||||
|
return &FakePluginRegistry{
|
||||||
|
Store: make(map[string]*plugins.Plugin),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
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
|
||||||
|
}
|
||||||
|
|
||||||
|
type FakePluginRepo struct {
|
||||||
|
GetPluginArchiveFunc func(_ context.Context, pluginID, version string, _ repo.CompatOpts) (*repo.PluginArchive, error)
|
||||||
|
GetPluginArchiveByURLFunc func(_ context.Context, archiveURL string, _ repo.CompatOpts) (*repo.PluginArchive, error)
|
||||||
|
GetPluginDownloadOptionsFunc func(_ context.Context, pluginID, version string, _ repo.CompatOpts) (*repo.PluginDownloadOptions, error)
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetPluginArchive fetches the requested plugin archive.
|
||||||
|
func (r *FakePluginRepo) GetPluginArchive(ctx context.Context, pluginID, version string, opts repo.CompatOpts) (*repo.PluginArchive, error) {
|
||||||
|
if r.GetPluginArchiveFunc != nil {
|
||||||
|
return r.GetPluginArchiveFunc(ctx, pluginID, version, opts)
|
||||||
|
}
|
||||||
|
|
||||||
|
return &repo.PluginArchive{}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetPluginArchiveByURL fetches the requested plugin from the specified URL.
|
||||||
|
func (r *FakePluginRepo) GetPluginArchiveByURL(ctx context.Context, archiveURL string, opts repo.CompatOpts) (*repo.PluginArchive, error) {
|
||||||
|
if r.GetPluginArchiveByURLFunc != nil {
|
||||||
|
return r.GetPluginArchiveByURLFunc(ctx, archiveURL, opts)
|
||||||
|
}
|
||||||
|
|
||||||
|
return &repo.PluginArchive{}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetPluginDownloadOptions fetches information for downloading the requested plugin.
|
||||||
|
func (r *FakePluginRepo) GetPluginDownloadOptions(ctx context.Context, pluginID, version string, opts repo.CompatOpts) (*repo.PluginDownloadOptions, error) {
|
||||||
|
if r.GetPluginDownloadOptionsFunc != nil {
|
||||||
|
return r.GetPluginDownloadOptionsFunc(ctx, pluginID, version, opts)
|
||||||
|
}
|
||||||
|
return &repo.PluginDownloadOptions{}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
type FakePluginStorage struct {
|
||||||
|
AddFunc func(_ context.Context, pluginID string, z *zip.ReadCloser) (*storage.ExtractedPluginArchive, error)
|
||||||
|
RemoveFunc func(_ context.Context, pluginID string) error
|
||||||
|
Added map[string]string
|
||||||
|
Removed map[string]int
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *FakePluginStorage) Add(ctx context.Context, pluginID string, z *zip.ReadCloser) (*storage.ExtractedPluginArchive, error) {
|
||||||
|
s.Added[pluginID] = z.File[0].Name
|
||||||
|
if s.AddFunc != nil {
|
||||||
|
return s.AddFunc(ctx, pluginID, z)
|
||||||
|
}
|
||||||
|
return &storage.ExtractedPluginArchive{}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *FakePluginStorage) Remove(ctx context.Context, pluginID string) error {
|
||||||
|
s.Removed[pluginID]++
|
||||||
|
if s.RemoveFunc != nil {
|
||||||
|
return s.RemoveFunc(ctx, pluginID)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
type FakeProcessManager struct {
|
||||||
|
StartFunc func(_ context.Context, pluginID string) error
|
||||||
|
StopFunc func(_ context.Context, pluginID string) error
|
||||||
|
Started map[string]int
|
||||||
|
Stopped map[string]int
|
||||||
|
}
|
||||||
|
|
||||||
|
func NewFakeProcessManager() *FakeProcessManager {
|
||||||
|
return &FakeProcessManager{
|
||||||
|
Started: make(map[string]int),
|
||||||
|
Stopped: make(map[string]int),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (m *FakeProcessManager) Start(ctx context.Context, pluginID string) error {
|
||||||
|
m.Started[pluginID]++
|
||||||
|
if m.StartFunc != nil {
|
||||||
|
return m.StartFunc(ctx, pluginID)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (m *FakeProcessManager) Stop(ctx context.Context, pluginID string) error {
|
||||||
|
m.Stopped[pluginID]++
|
||||||
|
if m.StopFunc != nil {
|
||||||
|
return m.StopFunc(ctx, pluginID)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
@ -2,16 +2,14 @@ package manager
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
"errors"
|
"fmt"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"sync"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"github.com/grafana/grafana/pkg/infra/log"
|
"github.com/grafana/grafana/pkg/infra/log"
|
||||||
"github.com/grafana/grafana/pkg/plugins"
|
"github.com/grafana/grafana/pkg/plugins"
|
||||||
"github.com/grafana/grafana/pkg/plugins/backendplugin"
|
|
||||||
"github.com/grafana/grafana/pkg/plugins/logger"
|
"github.com/grafana/grafana/pkg/plugins/logger"
|
||||||
"github.com/grafana/grafana/pkg/plugins/manager/loader"
|
"github.com/grafana/grafana/pkg/plugins/manager/loader"
|
||||||
|
"github.com/grafana/grafana/pkg/plugins/manager/process"
|
||||||
"github.com/grafana/grafana/pkg/plugins/manager/registry"
|
"github.com/grafana/grafana/pkg/plugins/manager/registry"
|
||||||
"github.com/grafana/grafana/pkg/plugins/repo"
|
"github.com/grafana/grafana/pkg/plugins/repo"
|
||||||
"github.com/grafana/grafana/pkg/plugins/storage"
|
"github.com/grafana/grafana/pkg/plugins/storage"
|
||||||
@ -19,251 +17,229 @@ import (
|
|||||||
)
|
)
|
||||||
|
|
||||||
var _ plugins.Manager = (*PluginManager)(nil)
|
var _ plugins.Manager = (*PluginManager)(nil)
|
||||||
var _ plugins.Client = (*PluginManager)(nil)
|
|
||||||
var _ plugins.Store = (*PluginManager)(nil)
|
|
||||||
var _ plugins.StaticRouteResolver = (*PluginManager)(nil)
|
|
||||||
var _ plugins.RendererManager = (*PluginManager)(nil)
|
|
||||||
var _ plugins.SecretsPluginManager = (*PluginManager)(nil)
|
|
||||||
|
|
||||||
type PluginManager struct {
|
type PluginManager struct {
|
||||||
cfg *plugins.Cfg
|
cfg *plugins.Cfg
|
||||||
|
pluginSources []plugins.PluginSource
|
||||||
|
pluginRepo repo.Service
|
||||||
|
pluginStorage storage.Manager
|
||||||
|
processManager process.Service
|
||||||
pluginRegistry registry.Service
|
pluginRegistry registry.Service
|
||||||
pluginLoader loader.Service
|
pluginLoader loader.Service
|
||||||
pluginRepo repo.Service
|
|
||||||
pluginSources []PluginSource
|
|
||||||
pluginStorage storage.Manager
|
|
||||||
pluginsMu sync.RWMutex
|
|
||||||
log log.Logger
|
log log.Logger
|
||||||
}
|
}
|
||||||
|
|
||||||
type PluginSource struct {
|
|
||||||
Class plugins.Class
|
|
||||||
Paths []string
|
|
||||||
}
|
|
||||||
|
|
||||||
func ProvideService(grafanaCfg *setting.Cfg, pluginRegistry registry.Service, pluginLoader loader.Service,
|
func ProvideService(grafanaCfg *setting.Cfg, pluginRegistry registry.Service, pluginLoader loader.Service,
|
||||||
pluginRepo repo.Service) (*PluginManager, error) {
|
pluginRepo repo.Service) (*PluginManager, error) {
|
||||||
pm := New(plugins.FromGrafanaCfg(grafanaCfg), pluginRegistry, []PluginSource{
|
pm := New(plugins.FromGrafanaCfg(grafanaCfg), pluginRegistry, pluginSources(grafanaCfg), pluginLoader,
|
||||||
{Class: plugins.Core, Paths: corePluginPaths(grafanaCfg)},
|
pluginRepo, storage.FileSystem(logger.NewLogger("plugin.fs"), grafanaCfg.PluginsPath),
|
||||||
{Class: plugins.Bundled, Paths: []string{grafanaCfg.BundledPluginsPath}},
|
process.NewManager(pluginRegistry),
|
||||||
{Class: plugins.External, Paths: append([]string{grafanaCfg.PluginsPath}, pluginSettingPaths(grafanaCfg)...)},
|
)
|
||||||
}, pluginLoader, pluginRepo, storage.FileSystem(logger.NewLogger("plugin.fs"), grafanaCfg.PluginsPath))
|
if err := pm.Init(context.Background()); err != nil {
|
||||||
if err := pm.Init(); err != nil {
|
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
return pm, nil
|
return pm, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func New(cfg *plugins.Cfg, pluginRegistry registry.Service, pluginSources []PluginSource, pluginLoader loader.Service,
|
func New(cfg *plugins.Cfg, pluginRegistry registry.Service, pluginSources []plugins.PluginSource,
|
||||||
pluginRepo repo.Service, pluginFs storage.Manager) *PluginManager {
|
pluginLoader loader.Service, pluginRepo repo.Service, pluginStorage storage.Manager,
|
||||||
|
processManager process.Service) *PluginManager {
|
||||||
return &PluginManager{
|
return &PluginManager{
|
||||||
cfg: cfg,
|
cfg: cfg,
|
||||||
pluginLoader: pluginLoader,
|
|
||||||
pluginSources: pluginSources,
|
pluginSources: pluginSources,
|
||||||
pluginRegistry: pluginRegistry,
|
|
||||||
pluginRepo: pluginRepo,
|
pluginRepo: pluginRepo,
|
||||||
pluginStorage: pluginFs,
|
pluginLoader: pluginLoader,
|
||||||
|
pluginRegistry: pluginRegistry,
|
||||||
|
processManager: processManager,
|
||||||
|
pluginStorage: pluginStorage,
|
||||||
log: log.New("plugin.manager"),
|
log: log.New("plugin.manager"),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func (m *PluginManager) Init() error {
|
func (m *PluginManager) Init(ctx context.Context) error {
|
||||||
for _, ps := range m.pluginSources {
|
for _, ps := range m.pluginSources {
|
||||||
err := m.loadPlugins(context.Background(), ps.Class, ps.Paths...)
|
if err := m.loadPlugins(ctx, ps.Class, ps.Paths...); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (m *PluginManager) Add(ctx context.Context, pluginID, version string, opts plugins.CompatOpts) error {
|
||||||
|
compatOpts := repo.NewCompatOpts(opts.GrafanaVersion, opts.OS, opts.Arch)
|
||||||
|
|
||||||
|
var pluginArchive *repo.PluginArchive
|
||||||
|
if plugin, exists := m.plugin(ctx, pluginID); exists {
|
||||||
|
if !plugin.IsExternalPlugin() {
|
||||||
|
return plugins.ErrInstallCorePlugin
|
||||||
|
}
|
||||||
|
|
||||||
|
if plugin.Info.Version == version {
|
||||||
|
return plugins.DuplicateError{
|
||||||
|
PluginID: plugin.ID,
|
||||||
|
ExistingPluginDir: plugin.PluginDir,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// get plugin update information to confirm if target update is possible
|
||||||
|
dlOpts, err := m.pluginRepo.GetPluginDownloadOptions(ctx, pluginID, version, compatOpts)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
// if existing plugin version is the same as the target update version
|
||||||
|
if dlOpts.Version == plugin.Info.Version {
|
||||||
|
return plugins.DuplicateError{
|
||||||
|
PluginID: plugin.ID,
|
||||||
|
ExistingPluginDir: plugin.PluginDir,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if dlOpts.PluginZipURL == "" && dlOpts.Version == "" {
|
||||||
|
return fmt.Errorf("could not determine update options for %s", pluginID)
|
||||||
|
}
|
||||||
|
|
||||||
|
// remove existing installation of plugin
|
||||||
|
err = m.Remove(ctx, plugin.ID)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
if dlOpts.PluginZipURL != "" {
|
||||||
|
pluginArchive, err = m.pluginRepo.GetPluginArchiveByURL(ctx, dlOpts.PluginZipURL, compatOpts)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
pluginArchive, err = m.pluginRepo.GetPluginArchive(ctx, pluginID, dlOpts.Version, compatOpts)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
var err error
|
||||||
|
pluginArchive, err = m.pluginRepo.GetPluginArchive(ctx, pluginID, version, compatOpts)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
extractedArchive, err := m.pluginStorage.Add(ctx, pluginID, pluginArchive.File)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
// download dependency plugins
|
||||||
|
pathsToScan := []string{extractedArchive.Path}
|
||||||
|
for _, dep := range extractedArchive.Dependencies {
|
||||||
|
m.log.Info("Fetching %s dependencies...", dep.ID)
|
||||||
|
d, err := m.pluginRepo.GetPluginArchive(ctx, dep.ID, dep.Version, compatOpts)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("%v: %w", fmt.Sprintf("failed to download plugin %s from repository", dep.ID), err)
|
||||||
|
}
|
||||||
|
|
||||||
|
depArchive, err := m.pluginStorage.Add(ctx, dep.ID, d.File)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
pathsToScan = append(pathsToScan, depArchive.Path)
|
||||||
|
}
|
||||||
|
|
||||||
|
err = m.loadPlugins(context.Background(), plugins.External, pathsToScan...)
|
||||||
|
if err != nil {
|
||||||
|
m.log.Error("Could not load plugins", "paths", pathsToScan, "err", err)
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (m *PluginManager) Run(ctx context.Context) error {
|
func (m *PluginManager) Remove(ctx context.Context, pluginID string) error {
|
||||||
<-ctx.Done()
|
plugin, exists := m.plugin(ctx, pluginID)
|
||||||
m.shutdown(ctx)
|
if !exists {
|
||||||
return ctx.Err()
|
return plugins.ErrPluginNotInstalled
|
||||||
|
}
|
||||||
|
|
||||||
|
if !plugin.IsExternalPlugin() {
|
||||||
|
return plugins.ErrUninstallCorePlugin
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := m.unregisterAndStop(ctx, plugin); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
return m.pluginStorage.Remove(ctx, plugin.ID)
|
||||||
}
|
}
|
||||||
|
|
||||||
func (m *PluginManager) loadPlugins(ctx context.Context, class plugins.Class, paths ...string) error {
|
// plugin finds a plugin with `pluginID` from the registry that is not decommissioned
|
||||||
if len(paths) == 0 {
|
func (m *PluginManager) plugin(ctx context.Context, pluginID string) (*plugins.Plugin, bool) {
|
||||||
return nil
|
p, exists := m.pluginRegistry.Plugin(ctx, pluginID)
|
||||||
|
if !exists {
|
||||||
|
return nil, false
|
||||||
}
|
}
|
||||||
|
|
||||||
var pluginPaths []string
|
if p.IsDecommissioned() {
|
||||||
for _, p := range paths {
|
return nil, false
|
||||||
if p != "" {
|
|
||||||
pluginPaths = append(pluginPaths, p)
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
loadedPlugins, err := m.pluginLoader.Load(ctx, class, pluginPaths, m.registeredPlugins(ctx))
|
return p, true
|
||||||
|
}
|
||||||
|
|
||||||
|
func (m *PluginManager) loadPlugins(ctx context.Context, class plugins.Class, pluginPaths ...string) error {
|
||||||
|
registeredPlugins := make(map[string]struct{})
|
||||||
|
for _, p := range m.pluginRegistry.Plugins(ctx) {
|
||||||
|
registeredPlugins[p.ID] = struct{}{}
|
||||||
|
}
|
||||||
|
|
||||||
|
loadedPlugins, err := m.pluginLoader.Load(ctx, class, pluginPaths, registeredPlugins)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
m.log.Error("Could not load plugins", "paths", pluginPaths, "err", err)
|
m.log.Error("Could not load plugins", "paths", pluginPaths, "err", err)
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
for _, p := range loadedPlugins {
|
for _, p := range loadedPlugins {
|
||||||
if err := m.registerAndStart(context.Background(), p); err != nil {
|
if err = m.registerAndStart(context.Background(), p); err != nil {
|
||||||
m.log.Error("Could not start plugin", "pluginId", p.ID, "err", err)
|
m.log.Error("Could not start plugin", "pluginID", p.ID, "err", err)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (m *PluginManager) Renderer() *plugins.Plugin {
|
|
||||||
for _, p := range m.availablePlugins(context.TODO()) {
|
|
||||||
if p.IsRenderer() {
|
|
||||||
return p
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (m *PluginManager) SecretsManager() *plugins.Plugin {
|
|
||||||
for _, p := range m.availablePlugins(context.TODO()) {
|
|
||||||
if p.IsSecretsManager() {
|
|
||||||
return p
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (m *PluginManager) Routes() []*plugins.StaticRoute {
|
|
||||||
staticRoutes := make([]*plugins.StaticRoute, 0)
|
|
||||||
|
|
||||||
for _, p := range m.availablePlugins(context.TODO()) {
|
|
||||||
if p.StaticRoute() != nil {
|
|
||||||
staticRoutes = append(staticRoutes, p.StaticRoute())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return staticRoutes
|
|
||||||
}
|
|
||||||
|
|
||||||
func (m *PluginManager) registerAndStart(ctx context.Context, p *plugins.Plugin) error {
|
func (m *PluginManager) registerAndStart(ctx context.Context, p *plugins.Plugin) error {
|
||||||
if err := m.pluginRegistry.Add(ctx, p); err != nil {
|
if err := m.pluginRegistry.Add(ctx, p); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
return m.processManager.Start(ctx, p.ID)
|
||||||
if !p.IsCorePlugin() {
|
|
||||||
m.log.Info("Plugin registered", "pluginId", p.ID)
|
|
||||||
}
|
|
||||||
|
|
||||||
return m.start(ctx, p)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func (m *PluginManager) unregisterAndStop(ctx context.Context, p *plugins.Plugin) error {
|
func (m *PluginManager) unregisterAndStop(ctx context.Context, p *plugins.Plugin) error {
|
||||||
m.log.Debug("Stopping plugin process", "pluginId", p.ID)
|
m.log.Debug("Stopping plugin process", "pluginID", p.ID)
|
||||||
m.pluginsMu.Lock()
|
|
||||||
defer m.pluginsMu.Unlock()
|
|
||||||
|
|
||||||
if err := p.Decommission(); err != nil {
|
if err := m.processManager.Stop(ctx, p.ID); err != nil {
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := p.Stop(ctx); err != nil {
|
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
if err := m.pluginRegistry.Remove(ctx, p.ID); err != nil {
|
if err := m.pluginRegistry.Remove(ctx, p.ID); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
m.log.Debug("Plugin unregistered", "pluginID", p.ID)
|
||||||
m.log.Debug("Plugin unregistered", "pluginId", p.ID)
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// start starts a backend plugin process
|
func pluginSources(cfg *setting.Cfg) []plugins.PluginSource {
|
||||||
func (m *PluginManager) start(ctx context.Context, p *plugins.Plugin) error {
|
return []plugins.PluginSource{
|
||||||
if !p.IsManaged() || !p.Backend || p.SignatureError != nil {
|
{Class: plugins.Core, Paths: corePluginPaths(cfg)},
|
||||||
return nil
|
{Class: plugins.Bundled, Paths: []string{cfg.BundledPluginsPath}},
|
||||||
|
{Class: plugins.External, Paths: append([]string{cfg.PluginsPath}, pluginSettingPaths(cfg)...)},
|
||||||
}
|
}
|
||||||
|
|
||||||
if _, exists := m.pluginRegistry.Plugin(ctx, p.ID); !exists {
|
|
||||||
return backendplugin.ErrPluginNotRegistered
|
|
||||||
}
|
|
||||||
|
|
||||||
if p.IsCorePlugin() {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := startPluginAndRestartKilledProcesses(ctx, p); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
p.Logger().Debug("Successfully started backend plugin process")
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func startPluginAndRestartKilledProcesses(ctx context.Context, p *plugins.Plugin) error {
|
|
||||||
if err := p.Start(ctx); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
go func(ctx context.Context, p *plugins.Plugin) {
|
|
||||||
if err := restartKilledProcess(ctx, p); err != nil {
|
|
||||||
p.Logger().Error("Attempt to restart killed plugin process failed", "error", err)
|
|
||||||
}
|
|
||||||
}(ctx, p)
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func restartKilledProcess(ctx context.Context, p *plugins.Plugin) error {
|
|
||||||
ticker := time.NewTicker(time.Second * 1)
|
|
||||||
|
|
||||||
for {
|
|
||||||
select {
|
|
||||||
case <-ctx.Done():
|
|
||||||
if err := ctx.Err(); err != nil && !errors.Is(err, context.Canceled) {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
case <-ticker.C:
|
|
||||||
if p.IsDecommissioned() {
|
|
||||||
p.Logger().Debug("Plugin decommissioned")
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
if !p.Exited() {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
p.Logger().Debug("Restarting plugin")
|
|
||||||
if err := p.Start(ctx); err != nil {
|
|
||||||
p.Logger().Error("Failed to restart plugin", "error", err)
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
p.Logger().Debug("Plugin restarted")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// shutdown stops all backend plugin processes
|
|
||||||
func (m *PluginManager) shutdown(ctx context.Context) {
|
|
||||||
var wg sync.WaitGroup
|
|
||||||
for _, p := range m.availablePlugins(ctx) {
|
|
||||||
wg.Add(1)
|
|
||||||
go func(p backendplugin.Plugin, ctx context.Context) {
|
|
||||||
defer wg.Done()
|
|
||||||
p.Logger().Debug("Stopping plugin")
|
|
||||||
if err := p.Stop(ctx); err != nil {
|
|
||||||
p.Logger().Error("Failed to stop plugin", "error", err)
|
|
||||||
}
|
|
||||||
p.Logger().Debug("Plugin stopped")
|
|
||||||
}(p, ctx)
|
|
||||||
}
|
|
||||||
wg.Wait()
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// corePluginPaths provides a list of the Core plugin paths which need to be scanned on init()
|
// corePluginPaths provides a list of the Core plugin paths which need to be scanned on init()
|
||||||
func corePluginPaths(cfg *setting.Cfg) []string {
|
func corePluginPaths(cfg *setting.Cfg) []string {
|
||||||
datasourcePaths := filepath.Join(cfg.StaticRootPath, "app/plugins/datasource")
|
datasourcePaths := filepath.Join(cfg.StaticRootPath, "app/plugins/datasource")
|
||||||
panelsPath := filepath.Join(cfg.StaticRootPath, "app/plugins/panel")
|
panelsPath := filepath.Join(cfg.StaticRootPath, "app/plugins/panel")
|
||||||
|
|
||||||
return []string{datasourcePaths, panelsPath}
|
return []string{datasourcePaths, panelsPath}
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -277,6 +253,5 @@ func pluginSettingPaths(cfg *setting.Cfg) []string {
|
|||||||
}
|
}
|
||||||
pluginSettingDirs = append(pluginSettingDirs, path)
|
pluginSettingDirs = append(pluginSettingDirs, path)
|
||||||
}
|
}
|
||||||
|
|
||||||
return pluginSettingDirs
|
return pluginSettingDirs
|
||||||
}
|
}
|
||||||
|
@ -2,24 +2,29 @@ package manager
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
|
"encoding/json"
|
||||||
"net/http"
|
"net/http"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"strings"
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
"github.com/stretchr/testify/assert"
|
|
||||||
"github.com/stretchr/testify/require"
|
"github.com/stretchr/testify/require"
|
||||||
"go.opentelemetry.io/otel/trace"
|
"go.opentelemetry.io/otel/trace"
|
||||||
"gopkg.in/ini.v1"
|
"gopkg.in/ini.v1"
|
||||||
|
|
||||||
|
"github.com/grafana/grafana-plugin-sdk-go/backend"
|
||||||
"github.com/grafana/grafana-plugin-sdk-go/backend/httpclient"
|
"github.com/grafana/grafana-plugin-sdk-go/backend/httpclient"
|
||||||
|
|
||||||
"github.com/grafana/grafana/pkg/infra/tracing"
|
"github.com/grafana/grafana/pkg/infra/tracing"
|
||||||
"github.com/grafana/grafana/pkg/plugins"
|
"github.com/grafana/grafana/pkg/plugins"
|
||||||
"github.com/grafana/grafana/pkg/plugins/backendplugin/coreplugin"
|
"github.com/grafana/grafana/pkg/plugins/backendplugin/coreplugin"
|
||||||
"github.com/grafana/grafana/pkg/plugins/backendplugin/provider"
|
"github.com/grafana/grafana/pkg/plugins/backendplugin/provider"
|
||||||
|
"github.com/grafana/grafana/pkg/plugins/manager/client"
|
||||||
"github.com/grafana/grafana/pkg/plugins/manager/loader"
|
"github.com/grafana/grafana/pkg/plugins/manager/loader"
|
||||||
"github.com/grafana/grafana/pkg/plugins/manager/registry"
|
"github.com/grafana/grafana/pkg/plugins/manager/registry"
|
||||||
"github.com/grafana/grafana/pkg/plugins/manager/signature"
|
"github.com/grafana/grafana/pkg/plugins/manager/signature"
|
||||||
|
"github.com/grafana/grafana/pkg/plugins/manager/store"
|
||||||
"github.com/grafana/grafana/pkg/services/featuremgmt"
|
"github.com/grafana/grafana/pkg/services/featuremgmt"
|
||||||
"github.com/grafana/grafana/pkg/services/licensing"
|
"github.com/grafana/grafana/pkg/services/licensing"
|
||||||
"github.com/grafana/grafana/pkg/services/searchV2"
|
"github.com/grafana/grafana/pkg/services/searchV2"
|
||||||
@ -42,7 +47,7 @@ import (
|
|||||||
"github.com/grafana/grafana/pkg/tsdb/testdatasource"
|
"github.com/grafana/grafana/pkg/tsdb/testdatasource"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestPluginManager_int_init(t *testing.T) {
|
func TestIntegrationPluginManager_Run(t *testing.T) {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
|
|
||||||
staticRootPath, err := filepath.Abs("../../../public/")
|
staticRootPath, err := filepath.Abs("../../../public/")
|
||||||
@ -59,9 +64,12 @@ func TestPluginManager_int_init(t *testing.T) {
|
|||||||
BundledPluginsPath: bundledPluginsPath,
|
BundledPluginsPath: bundledPluginsPath,
|
||||||
IsFeatureToggleEnabled: features.IsEnabled,
|
IsFeatureToggleEnabled: features.IsEnabled,
|
||||||
PluginSettings: map[string]map[string]string{
|
PluginSettings: map[string]map[string]string{
|
||||||
"plugin.datasource-id": {
|
"plugin.test-app": {
|
||||||
"path": "testdata/test-app",
|
"path": "testdata/test-app",
|
||||||
},
|
},
|
||||||
|
"plugin.test-panel": {
|
||||||
|
"not": "included",
|
||||||
|
},
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -92,17 +100,46 @@ func TestPluginManager_int_init(t *testing.T) {
|
|||||||
coreRegistry := coreplugin.ProvideCoreRegistry(am, cw, cm, es, grap, idb, lk, otsdb, pr, tmpo, td, pg, my, ms, graf)
|
coreRegistry := coreplugin.ProvideCoreRegistry(am, cw, cm, es, grap, idb, lk, otsdb, pr, tmpo, td, pg, my, ms, graf)
|
||||||
|
|
||||||
pmCfg := plugins.FromGrafanaCfg(cfg)
|
pmCfg := plugins.FromGrafanaCfg(cfg)
|
||||||
pm, err := ProvideService(cfg, registry.NewInMemory(), loader.New(pmCfg, license, signature.NewUnsignedAuthorizer(pmCfg),
|
reg := registry.ProvideService()
|
||||||
|
pm, err := ProvideService(cfg, reg, loader.New(pmCfg, license, signature.NewUnsignedAuthorizer(pmCfg),
|
||||||
provider.ProvideService(coreRegistry)), nil)
|
provider.ProvideService(coreRegistry)), nil)
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
|
ps := store.ProvideService(reg)
|
||||||
|
|
||||||
ctx := context.Background()
|
ctx := context.Background()
|
||||||
verifyCorePluginCatalogue(t, ctx, pm)
|
verifyCorePluginCatalogue(t, ctx, ps)
|
||||||
verifyBundledPlugins(t, ctx, pm)
|
verifyBundledPlugins(t, ctx, ps)
|
||||||
verifyPluginStaticRoutes(t, ctx, pm)
|
verifyPluginStaticRoutes(t, ctx, ps)
|
||||||
|
verifyBackendProcesses(t, pm.pluginRegistry.Plugins(ctx))
|
||||||
|
verifyPluginQuery(t, ctx, client.ProvideService(reg))
|
||||||
}
|
}
|
||||||
|
|
||||||
func verifyCorePluginCatalogue(t *testing.T, ctx context.Context, pm *PluginManager) {
|
func verifyPluginQuery(t *testing.T, ctx context.Context, c plugins.Client) {
|
||||||
|
now := time.Unix(1661420870, 0)
|
||||||
|
req := &backend.QueryDataRequest{
|
||||||
|
PluginContext: backend.PluginContext{
|
||||||
|
PluginID: "testdata",
|
||||||
|
},
|
||||||
|
Queries: []backend.DataQuery{
|
||||||
|
{
|
||||||
|
RefID: "A",
|
||||||
|
TimeRange: backend.TimeRange{
|
||||||
|
From: now.Add(-5 * time.Minute),
|
||||||
|
To: now,
|
||||||
|
},
|
||||||
|
JSON: json.RawMessage(`{"scenarioId":"csv_metric_values","stringInput":"1,20,90,30,5,0"}`),
|
||||||
|
},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
resp, err := c.QueryData(ctx, req)
|
||||||
|
require.NoError(t, err)
|
||||||
|
payload, err := resp.MarshalJSON()
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.JSONEq(t, `{"results":{"A":{"frames":[{"schema":{"refId":"A","fields":[{"name":"time","type":"time","typeInfo":{"frame":"time.Time"}},{"name":"A-series","type":"number","typeInfo":{"frame":"int64","nullable":true}}]},"data":{"values":[[1661420570000,1661420630000,1661420690000,1661420750000,1661420810000,1661420870000],[1,20,90,30,5,0]]}}]}}}`, string(payload))
|
||||||
|
}
|
||||||
|
|
||||||
|
func verifyCorePluginCatalogue(t *testing.T, ctx context.Context, ps *store.Service) {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
|
|
||||||
expPanels := map[string]struct{}{
|
expPanels := map[string]struct{}{
|
||||||
@ -168,78 +205,85 @@ func verifyCorePluginCatalogue(t *testing.T, ctx context.Context, pm *PluginMana
|
|||||||
"test-app": {},
|
"test-app": {},
|
||||||
}
|
}
|
||||||
|
|
||||||
panels := pm.Plugins(ctx, plugins.Panel)
|
panels := ps.Plugins(ctx, plugins.Panel)
|
||||||
assert.Equal(t, len(expPanels), len(panels))
|
require.Equal(t, len(expPanels), len(panels))
|
||||||
for _, p := range panels {
|
for _, p := range panels {
|
||||||
p, exists := pm.Plugin(ctx, p.ID)
|
p, exists := ps.Plugin(ctx, p.ID)
|
||||||
require.NotEqual(t, plugins.PluginDTO{}, p)
|
require.NotEqual(t, plugins.PluginDTO{}, p)
|
||||||
assert.True(t, exists)
|
require.True(t, exists)
|
||||||
assert.Contains(t, expPanels, p.ID)
|
require.Contains(t, expPanels, p.ID)
|
||||||
assert.Contains(t, pm.registeredPlugins(ctx), p.ID)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
dataSources := pm.Plugins(ctx, plugins.DataSource)
|
dataSources := ps.Plugins(ctx, plugins.DataSource)
|
||||||
assert.Equal(t, len(expDataSources), len(dataSources))
|
require.Equal(t, len(expDataSources), len(dataSources))
|
||||||
for _, ds := range dataSources {
|
for _, ds := range dataSources {
|
||||||
p, exists := pm.Plugin(ctx, ds.ID)
|
p, exists := ps.Plugin(ctx, ds.ID)
|
||||||
require.NotEqual(t, plugins.PluginDTO{}, p)
|
require.NotEqual(t, plugins.PluginDTO{}, p)
|
||||||
assert.True(t, exists)
|
require.True(t, exists)
|
||||||
assert.Contains(t, expDataSources, ds.ID)
|
require.Contains(t, expDataSources, ds.ID)
|
||||||
assert.Contains(t, pm.registeredPlugins(ctx), ds.ID)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
apps := pm.Plugins(ctx, plugins.App)
|
apps := ps.Plugins(ctx, plugins.App)
|
||||||
assert.Equal(t, len(expApps), len(apps))
|
require.Equal(t, len(expApps), len(apps))
|
||||||
for _, app := range apps {
|
for _, app := range apps {
|
||||||
p, exists := pm.Plugin(ctx, app.ID)
|
p, exists := ps.Plugin(ctx, app.ID)
|
||||||
require.NotEqual(t, plugins.PluginDTO{}, p)
|
require.True(t, exists)
|
||||||
assert.True(t, exists)
|
require.NotNil(t, p)
|
||||||
assert.Contains(t, expApps, app.ID)
|
require.Contains(t, expApps, app.ID)
|
||||||
assert.Contains(t, pm.registeredPlugins(ctx), app.ID)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
assert.Equal(t, len(expPanels)+len(expDataSources)+len(expApps), len(pm.Plugins(ctx)))
|
require.Equal(t, len(expPanels)+len(expDataSources)+len(expApps), len(ps.Plugins(ctx)))
|
||||||
}
|
}
|
||||||
|
|
||||||
func verifyBundledPlugins(t *testing.T, ctx context.Context, pm *PluginManager) {
|
func verifyBundledPlugins(t *testing.T, ctx context.Context, ps *store.Service) {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
|
|
||||||
dsPlugins := make(map[string]struct{})
|
dsPlugins := make(map[string]struct{})
|
||||||
for _, p := range pm.Plugins(ctx, plugins.DataSource) {
|
for _, p := range ps.Plugins(ctx, plugins.DataSource) {
|
||||||
dsPlugins[p.ID] = struct{}{}
|
dsPlugins[p.ID] = struct{}{}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
inputPlugin, exists := ps.Plugin(ctx, "input")
|
||||||
|
require.True(t, exists)
|
||||||
|
require.NotEqual(t, plugins.PluginDTO{}, inputPlugin)
|
||||||
|
require.NotNil(t, dsPlugins["input"])
|
||||||
|
|
||||||
pluginRoutes := make(map[string]*plugins.StaticRoute)
|
pluginRoutes := make(map[string]*plugins.StaticRoute)
|
||||||
for _, r := range pm.Routes() {
|
for _, r := range ps.Routes() {
|
||||||
pluginRoutes[r.PluginID] = r
|
pluginRoutes[r.PluginID] = r
|
||||||
}
|
}
|
||||||
|
|
||||||
inputPlugin, exists := pm.Plugin(ctx, "input")
|
|
||||||
require.NotEqual(t, plugins.PluginDTO{}, inputPlugin)
|
|
||||||
assert.True(t, exists)
|
|
||||||
assert.NotNil(t, dsPlugins["input"])
|
|
||||||
|
|
||||||
for _, pluginID := range []string{"input"} {
|
for _, pluginID := range []string{"input"} {
|
||||||
assert.Contains(t, pluginRoutes, pluginID)
|
require.Contains(t, pluginRoutes, pluginID)
|
||||||
assert.True(t, strings.HasPrefix(pluginRoutes[pluginID].Directory, inputPlugin.PluginDir))
|
require.True(t, strings.HasPrefix(pluginRoutes[pluginID].Directory, inputPlugin.PluginDir))
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func verifyPluginStaticRoutes(t *testing.T, ctx context.Context, pm *PluginManager) {
|
func verifyPluginStaticRoutes(t *testing.T, ctx context.Context, ps *store.Service) {
|
||||||
routes := make(map[string]*plugins.StaticRoute)
|
routes := make(map[string]*plugins.StaticRoute)
|
||||||
for _, route := range pm.Routes() {
|
for _, route := range ps.Routes() {
|
||||||
routes[route.PluginID] = route
|
routes[route.PluginID] = route
|
||||||
}
|
}
|
||||||
|
|
||||||
assert.Len(t, routes, 2)
|
require.Len(t, routes, 2)
|
||||||
|
|
||||||
inputPlugin, _ := pm.Plugin(ctx, "input")
|
inputPlugin, _ := ps.Plugin(ctx, "input")
|
||||||
assert.NotNil(t, routes["input"])
|
require.NotNil(t, routes["input"])
|
||||||
assert.Equal(t, routes["input"].Directory, inputPlugin.PluginDir)
|
require.Equal(t, routes["input"].Directory, inputPlugin.PluginDir)
|
||||||
|
|
||||||
testAppPlugin, _ := pm.Plugin(ctx, "test-app")
|
testAppPlugin, _ := ps.Plugin(ctx, "test-app")
|
||||||
assert.Contains(t, routes, "test-app")
|
require.Contains(t, routes, "test-app")
|
||||||
assert.Equal(t, routes["test-app"].Directory, testAppPlugin.PluginDir)
|
require.Equal(t, routes["test-app"].Directory, testAppPlugin.PluginDir)
|
||||||
|
}
|
||||||
|
|
||||||
|
func verifyBackendProcesses(t *testing.T, ps []*plugins.Plugin) {
|
||||||
|
for _, p := range ps {
|
||||||
|
if p.Backend {
|
||||||
|
pc, exists := p.Client()
|
||||||
|
require.True(t, exists)
|
||||||
|
require.NotNil(t, pc)
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
type fakeTracer struct {
|
type fakeTracer struct {
|
||||||
|
File diff suppressed because it is too large
Load Diff
10
pkg/plugins/manager/process/ifaces.go
Normal file
10
pkg/plugins/manager/process/ifaces.go
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
package process
|
||||||
|
|
||||||
|
import "context"
|
||||||
|
|
||||||
|
type Service interface {
|
||||||
|
// Start executes a backend plugin process.
|
||||||
|
Start(ctx context.Context, pluginID string) error
|
||||||
|
// Stop terminates a backend plugin process.
|
||||||
|
Stop(ctx context.Context, pluginID string) error
|
||||||
|
}
|
145
pkg/plugins/manager/process/process.go
Normal file
145
pkg/plugins/manager/process/process.go
Normal file
@ -0,0 +1,145 @@
|
|||||||
|
package process
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"sync"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/grafana/grafana/pkg/infra/log"
|
||||||
|
"github.com/grafana/grafana/pkg/plugins"
|
||||||
|
"github.com/grafana/grafana/pkg/plugins/backendplugin"
|
||||||
|
"github.com/grafana/grafana/pkg/plugins/manager/registry"
|
||||||
|
)
|
||||||
|
|
||||||
|
var _ Service = (*Manager)(nil)
|
||||||
|
|
||||||
|
type Manager struct {
|
||||||
|
pluginRegistry registry.Service
|
||||||
|
|
||||||
|
mu sync.Mutex
|
||||||
|
log log.Logger
|
||||||
|
}
|
||||||
|
|
||||||
|
func ProvideService(pluginRegistry registry.Service) *Manager {
|
||||||
|
return NewManager(pluginRegistry)
|
||||||
|
}
|
||||||
|
|
||||||
|
func NewManager(pluginRegistry registry.Service) *Manager {
|
||||||
|
return &Manager{
|
||||||
|
pluginRegistry: pluginRegistry,
|
||||||
|
log: log.New("plugin.process.manager"),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (m *Manager) Run(ctx context.Context) error {
|
||||||
|
<-ctx.Done()
|
||||||
|
m.shutdown(ctx)
|
||||||
|
return ctx.Err()
|
||||||
|
}
|
||||||
|
|
||||||
|
func (m *Manager) Start(ctx context.Context, pluginID string) error {
|
||||||
|
p, exists := m.pluginRegistry.Plugin(ctx, pluginID)
|
||||||
|
if !exists {
|
||||||
|
return backendplugin.ErrPluginNotRegistered
|
||||||
|
}
|
||||||
|
|
||||||
|
if !p.IsManaged() || !p.Backend || p.SignatureError != nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
if p.IsCorePlugin() {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
m.log.Info("Plugin registered", "pluginID", p.ID)
|
||||||
|
m.mu.Lock()
|
||||||
|
if err := startPluginAndRestartKilledProcesses(ctx, p); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
p.Logger().Debug("Successfully started backend plugin process")
|
||||||
|
m.mu.Unlock()
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (m *Manager) Stop(ctx context.Context, pluginID string) error {
|
||||||
|
p, exists := m.pluginRegistry.Plugin(ctx, pluginID)
|
||||||
|
if !exists {
|
||||||
|
return backendplugin.ErrPluginNotRegistered
|
||||||
|
}
|
||||||
|
m.log.Debug("Stopping plugin process", "pluginID", p.ID)
|
||||||
|
m.mu.Lock()
|
||||||
|
defer m.mu.Unlock()
|
||||||
|
|
||||||
|
if err := p.Decommission(); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := p.Stop(ctx); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// shutdown stops all backend plugin processes
|
||||||
|
func (m *Manager) shutdown(ctx context.Context) {
|
||||||
|
var wg sync.WaitGroup
|
||||||
|
for _, p := range m.pluginRegistry.Plugins(ctx) {
|
||||||
|
wg.Add(1)
|
||||||
|
go func(p backendplugin.Plugin, ctx context.Context) {
|
||||||
|
defer wg.Done()
|
||||||
|
p.Logger().Debug("Stopping plugin")
|
||||||
|
if err := p.Stop(ctx); err != nil {
|
||||||
|
p.Logger().Error("Failed to stop plugin", "error", err)
|
||||||
|
}
|
||||||
|
p.Logger().Debug("Plugin stopped")
|
||||||
|
}(p, ctx)
|
||||||
|
}
|
||||||
|
wg.Wait()
|
||||||
|
}
|
||||||
|
|
||||||
|
func startPluginAndRestartKilledProcesses(ctx context.Context, p *plugins.Plugin) error {
|
||||||
|
if err := p.Start(ctx); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
go func(ctx context.Context, p *plugins.Plugin) {
|
||||||
|
if err := restartKilledProcess(ctx, p); err != nil {
|
||||||
|
p.Logger().Error("Attempt to restart killed plugin process failed", "error", err)
|
||||||
|
}
|
||||||
|
}(ctx, p)
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func restartKilledProcess(ctx context.Context, p *plugins.Plugin) error {
|
||||||
|
ticker := time.NewTicker(time.Second * 1)
|
||||||
|
|
||||||
|
for {
|
||||||
|
select {
|
||||||
|
case <-ctx.Done():
|
||||||
|
if err := ctx.Err(); err != nil && !errors.Is(err, context.Canceled) {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
case <-ticker.C:
|
||||||
|
if p.IsDecommissioned() {
|
||||||
|
p.Logger().Debug("Plugin decommissioned")
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
if !p.Exited() {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
p.Logger().Debug("Restarting plugin")
|
||||||
|
if err := p.Start(ctx); err != nil {
|
||||||
|
p.Logger().Error("Failed to restart plugin", "error", err)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
p.Logger().Debug("Plugin restarted")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
300
pkg/plugins/manager/process/process_test.go
Normal file
300
pkg/plugins/manager/process/process_test.go
Normal file
@ -0,0 +1,300 @@
|
|||||||
|
package process
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"sync"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/grafana/grafana/pkg/infra/log"
|
||||||
|
"github.com/grafana/grafana/pkg/plugins"
|
||||||
|
"github.com/grafana/grafana/pkg/plugins/backendplugin"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestProcessManager_Start(t *testing.T) {
|
||||||
|
t.Run("Plugin not found in registry", func(t *testing.T) {
|
||||||
|
m := NewManager(newFakePluginRegistry(map[string]*plugins.Plugin{}))
|
||||||
|
err := m.Start(context.Background(), "non-existing-datasource")
|
||||||
|
require.ErrorIs(t, err, backendplugin.ErrPluginNotRegistered)
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("Cannot start a core plugin", func(t *testing.T) {
|
||||||
|
pluginID := "core-datasource"
|
||||||
|
|
||||||
|
bp := newFakeBackendPlugin(true)
|
||||||
|
p := createPlugin(t, bp, func(plugin *plugins.Plugin) {
|
||||||
|
plugin.ID = pluginID
|
||||||
|
plugin.Class = plugins.Core
|
||||||
|
plugin.Backend = true
|
||||||
|
})
|
||||||
|
|
||||||
|
m := NewManager(newFakePluginRegistry(map[string]*plugins.Plugin{
|
||||||
|
pluginID: p,
|
||||||
|
}))
|
||||||
|
err := m.Start(context.Background(), pluginID)
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.True(t, p.Exited())
|
||||||
|
require.Zero(t, bp.startCount)
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("Plugin state determines process start", func(t *testing.T) {
|
||||||
|
tcs := []struct {
|
||||||
|
name string
|
||||||
|
managed bool
|
||||||
|
backend bool
|
||||||
|
signatureError *plugins.SignatureError
|
||||||
|
expectedStartCount int
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "Unmanaged backend plugin will not be started",
|
||||||
|
managed: false,
|
||||||
|
backend: true,
|
||||||
|
expectedStartCount: 0,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "Managed non-backend plugin will not be started",
|
||||||
|
managed: false,
|
||||||
|
backend: true,
|
||||||
|
expectedStartCount: 0,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "Managed backend plugin with signature error will not be started",
|
||||||
|
managed: true,
|
||||||
|
backend: true,
|
||||||
|
signatureError: &plugins.SignatureError{
|
||||||
|
SignatureStatus: plugins.SignatureUnsigned,
|
||||||
|
},
|
||||||
|
expectedStartCount: 0,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "Managed backend plugin with no signature errors will be started",
|
||||||
|
managed: true,
|
||||||
|
backend: true,
|
||||||
|
expectedStartCount: 1,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
for _, tc := range tcs {
|
||||||
|
t.Run(tc.name, func(t *testing.T) {
|
||||||
|
bp := newFakeBackendPlugin(tc.managed)
|
||||||
|
p := createPlugin(t, bp, func(plugin *plugins.Plugin) {
|
||||||
|
plugin.Backend = tc.backend
|
||||||
|
plugin.SignatureError = tc.signatureError
|
||||||
|
})
|
||||||
|
|
||||||
|
m := NewManager(newFakePluginRegistry(map[string]*plugins.Plugin{
|
||||||
|
p.ID: p,
|
||||||
|
}))
|
||||||
|
|
||||||
|
err := m.Start(context.Background(), p.ID)
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.Equal(t, tc.expectedStartCount, bp.startCount)
|
||||||
|
|
||||||
|
if tc.expectedStartCount > 0 {
|
||||||
|
require.True(t, !p.Exited())
|
||||||
|
} else {
|
||||||
|
require.True(t, p.Exited())
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestProcessManager_Stop(t *testing.T) {
|
||||||
|
t.Run("Plugin not found in registry", func(t *testing.T) {
|
||||||
|
m := NewManager(newFakePluginRegistry(map[string]*plugins.Plugin{}))
|
||||||
|
err := m.Stop(context.Background(), "non-existing-datasource")
|
||||||
|
require.ErrorIs(t, err, backendplugin.ErrPluginNotRegistered)
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Run("Can stop a running plugin", func(t *testing.T) {
|
||||||
|
pluginID := "test-datasource"
|
||||||
|
|
||||||
|
bp := newFakeBackendPlugin(true)
|
||||||
|
p := createPlugin(t, bp, func(plugin *plugins.Plugin) {
|
||||||
|
plugin.ID = pluginID
|
||||||
|
plugin.Backend = true
|
||||||
|
})
|
||||||
|
|
||||||
|
m := NewManager(newFakePluginRegistry(map[string]*plugins.Plugin{
|
||||||
|
pluginID: p,
|
||||||
|
}))
|
||||||
|
err := m.Stop(context.Background(), pluginID)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
require.True(t, p.IsDecommissioned())
|
||||||
|
require.True(t, bp.decommissioned)
|
||||||
|
require.True(t, p.Exited())
|
||||||
|
require.Equal(t, 1, bp.stopCount)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestProcessManager_ManagedBackendPluginLifecycle(t *testing.T) {
|
||||||
|
bp := newFakeBackendPlugin(true)
|
||||||
|
p := createPlugin(t, bp, func(plugin *plugins.Plugin) {
|
||||||
|
plugin.Backend = true
|
||||||
|
})
|
||||||
|
|
||||||
|
m := NewManager(newFakePluginRegistry(map[string]*plugins.Plugin{
|
||||||
|
p.ID: p,
|
||||||
|
}))
|
||||||
|
|
||||||
|
err := m.Start(context.Background(), p.ID)
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.Equal(t, 1, bp.startCount)
|
||||||
|
|
||||||
|
t.Run("When plugin process is killed, the process is restarted", func(t *testing.T) {
|
||||||
|
pCtx := context.Background()
|
||||||
|
cCtx, cancel := context.WithCancel(pCtx)
|
||||||
|
var wgRun sync.WaitGroup
|
||||||
|
wgRun.Add(1)
|
||||||
|
var runErr error
|
||||||
|
go func() {
|
||||||
|
runErr = m.Run(cCtx)
|
||||||
|
wgRun.Done()
|
||||||
|
}()
|
||||||
|
|
||||||
|
var wgKill sync.WaitGroup
|
||||||
|
wgKill.Add(1)
|
||||||
|
go func() {
|
||||||
|
bp.kill() // manually kill process
|
||||||
|
for {
|
||||||
|
if !bp.Exited() {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
wgKill.Done()
|
||||||
|
}()
|
||||||
|
wgKill.Wait()
|
||||||
|
require.True(t, !p.Exited())
|
||||||
|
require.Equal(t, 2, bp.startCount)
|
||||||
|
require.Equal(t, 0, bp.stopCount)
|
||||||
|
|
||||||
|
t.Run("When context is cancelled the plugin is stopped", func(t *testing.T) {
|
||||||
|
cancel()
|
||||||
|
wgRun.Wait()
|
||||||
|
require.ErrorIs(t, runErr, context.Canceled)
|
||||||
|
require.True(t, p.Exited())
|
||||||
|
require.Equal(t, 2, bp.startCount)
|
||||||
|
require.Equal(t, 1, bp.stopCount)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
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
|
||||||
|
}
|
||||||
|
|
||||||
|
type fakeBackendPlugin struct {
|
||||||
|
managed bool
|
||||||
|
|
||||||
|
startCount int
|
||||||
|
stopCount int
|
||||||
|
decommissioned bool
|
||||||
|
running bool
|
||||||
|
|
||||||
|
mutex sync.RWMutex
|
||||||
|
backendplugin.Plugin
|
||||||
|
}
|
||||||
|
|
||||||
|
func newFakeBackendPlugin(managed bool) *fakeBackendPlugin {
|
||||||
|
return &fakeBackendPlugin{
|
||||||
|
managed: managed,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (p *fakeBackendPlugin) Start(_ context.Context) error {
|
||||||
|
p.mutex.Lock()
|
||||||
|
defer p.mutex.Unlock()
|
||||||
|
p.running = true
|
||||||
|
p.startCount++
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (p *fakeBackendPlugin) Stop(_ context.Context) error {
|
||||||
|
p.mutex.Lock()
|
||||||
|
defer p.mutex.Unlock()
|
||||||
|
p.running = false
|
||||||
|
p.stopCount++
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (p *fakeBackendPlugin) Decommission() error {
|
||||||
|
p.mutex.Lock()
|
||||||
|
defer p.mutex.Unlock()
|
||||||
|
p.decommissioned = true
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (p *fakeBackendPlugin) IsDecommissioned() bool {
|
||||||
|
p.mutex.RLock()
|
||||||
|
defer p.mutex.RUnlock()
|
||||||
|
return p.decommissioned
|
||||||
|
}
|
||||||
|
|
||||||
|
func (p *fakeBackendPlugin) IsManaged() bool {
|
||||||
|
p.mutex.RLock()
|
||||||
|
defer p.mutex.RUnlock()
|
||||||
|
return p.managed
|
||||||
|
}
|
||||||
|
|
||||||
|
func (p *fakeBackendPlugin) Exited() bool {
|
||||||
|
p.mutex.RLock()
|
||||||
|
defer p.mutex.RUnlock()
|
||||||
|
return !p.running
|
||||||
|
}
|
||||||
|
|
||||||
|
func (p *fakeBackendPlugin) kill() {
|
||||||
|
p.mutex.Lock()
|
||||||
|
defer p.mutex.Unlock()
|
||||||
|
p.running = false
|
||||||
|
}
|
||||||
|
|
||||||
|
func createPlugin(t *testing.T, bp backendplugin.Plugin, cbs ...func(p *plugins.Plugin)) *plugins.Plugin {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
p := &plugins.Plugin{
|
||||||
|
Class: plugins.External,
|
||||||
|
JSONData: plugins.JSONData{
|
||||||
|
ID: "test-datasource",
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
p.SetLogger(log.NewNopLogger())
|
||||||
|
p.RegisterClient(bp)
|
||||||
|
|
||||||
|
for _, cb := range cbs {
|
||||||
|
cb(p)
|
||||||
|
}
|
||||||
|
|
||||||
|
return p
|
||||||
|
}
|
@ -1,176 +0,0 @@
|
|||||||
package manager
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"fmt"
|
|
||||||
|
|
||||||
"github.com/grafana/grafana/pkg/plugins"
|
|
||||||
"github.com/grafana/grafana/pkg/plugins/repo"
|
|
||||||
)
|
|
||||||
|
|
||||||
func (m *PluginManager) Plugin(ctx context.Context, pluginID string) (plugins.PluginDTO, bool) {
|
|
||||||
p, exists := m.plugin(ctx, pluginID)
|
|
||||||
if !exists {
|
|
||||||
return plugins.PluginDTO{}, false
|
|
||||||
}
|
|
||||||
|
|
||||||
return p.ToDTO(), true
|
|
||||||
}
|
|
||||||
|
|
||||||
func (m *PluginManager) Plugins(ctx context.Context, pluginTypes ...plugins.Type) []plugins.PluginDTO {
|
|
||||||
// if no types passed, assume all
|
|
||||||
if len(pluginTypes) == 0 {
|
|
||||||
pluginTypes = plugins.PluginTypes
|
|
||||||
}
|
|
||||||
|
|
||||||
var requestedTypes = make(map[plugins.Type]struct{})
|
|
||||||
for _, pt := range pluginTypes {
|
|
||||||
requestedTypes[pt] = struct{}{}
|
|
||||||
}
|
|
||||||
|
|
||||||
pluginsList := make([]plugins.PluginDTO, 0)
|
|
||||||
for _, p := range m.availablePlugins(ctx) {
|
|
||||||
if _, exists := requestedTypes[p.Type]; exists {
|
|
||||||
pluginsList = append(pluginsList, p.ToDTO())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return pluginsList
|
|
||||||
}
|
|
||||||
|
|
||||||
// plugin finds a plugin with `pluginID` from the registry that is not decommissioned
|
|
||||||
func (m *PluginManager) plugin(ctx context.Context, pluginID string) (*plugins.Plugin, bool) {
|
|
||||||
p, exists := m.pluginRegistry.Plugin(ctx, pluginID)
|
|
||||||
if !exists || p.IsDecommissioned() {
|
|
||||||
return nil, false
|
|
||||||
}
|
|
||||||
|
|
||||||
return p, true
|
|
||||||
}
|
|
||||||
|
|
||||||
// availablePlugins returns all non-decommissioned plugins from the registry
|
|
||||||
func (m *PluginManager) availablePlugins(ctx context.Context) []*plugins.Plugin {
|
|
||||||
var res []*plugins.Plugin
|
|
||||||
for _, p := range m.pluginRegistry.Plugins(ctx) {
|
|
||||||
if !p.IsDecommissioned() {
|
|
||||||
res = append(res, p)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return res
|
|
||||||
}
|
|
||||||
|
|
||||||
// registeredPlugins returns all registered plugins from the registry
|
|
||||||
func (m *PluginManager) registeredPlugins(ctx context.Context) map[string]struct{} {
|
|
||||||
pluginsByID := make(map[string]struct{})
|
|
||||||
for _, p := range m.pluginRegistry.Plugins(ctx) {
|
|
||||||
pluginsByID[p.ID] = struct{}{}
|
|
||||||
}
|
|
||||||
|
|
||||||
return pluginsByID
|
|
||||||
}
|
|
||||||
|
|
||||||
func (m *PluginManager) Add(ctx context.Context, pluginID, version string, opts plugins.CompatOpts) error {
|
|
||||||
compatOpts := repo.NewCompatOpts(opts.GrafanaVersion, opts.OS, opts.Arch)
|
|
||||||
|
|
||||||
var pluginArchive *repo.PluginArchive
|
|
||||||
if plugin, exists := m.plugin(ctx, pluginID); exists {
|
|
||||||
if !plugin.IsExternalPlugin() {
|
|
||||||
return plugins.ErrInstallCorePlugin
|
|
||||||
}
|
|
||||||
|
|
||||||
if plugin.Info.Version == version {
|
|
||||||
return plugins.DuplicateError{
|
|
||||||
PluginID: plugin.ID,
|
|
||||||
ExistingPluginDir: plugin.PluginDir,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// get plugin update information to confirm if target update is possible
|
|
||||||
dlOpts, err := m.pluginRepo.GetPluginDownloadOptions(ctx, pluginID, version, compatOpts)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
// if existing plugin version is the same as the target update version
|
|
||||||
if dlOpts.Version == plugin.Info.Version {
|
|
||||||
return plugins.DuplicateError{
|
|
||||||
PluginID: plugin.ID,
|
|
||||||
ExistingPluginDir: plugin.PluginDir,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if dlOpts.PluginZipURL == "" && dlOpts.Version == "" {
|
|
||||||
return fmt.Errorf("could not determine update options for %s", pluginID)
|
|
||||||
}
|
|
||||||
|
|
||||||
// remove existing installation of plugin
|
|
||||||
err = m.Remove(ctx, plugin.ID)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
if dlOpts.PluginZipURL != "" {
|
|
||||||
pluginArchive, err = m.pluginRepo.GetPluginArchiveByURL(ctx, dlOpts.PluginZipURL, compatOpts)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
pluginArchive, err = m.pluginRepo.GetPluginArchive(ctx, pluginID, dlOpts.Version, compatOpts)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
var err error
|
|
||||||
pluginArchive, err = m.pluginRepo.GetPluginArchive(ctx, pluginID, version, compatOpts)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
extractedArchive, err := m.pluginStorage.Add(ctx, pluginID, pluginArchive.File)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
// download dependency plugins
|
|
||||||
pathsToScan := []string{extractedArchive.Path}
|
|
||||||
for _, dep := range extractedArchive.Dependencies {
|
|
||||||
m.log.Info("Fetching %s dependencies...", dep.ID)
|
|
||||||
d, err := m.pluginRepo.GetPluginArchive(ctx, dep.ID, dep.Version, compatOpts)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("%v: %w", fmt.Sprintf("failed to download plugin %s from repository", dep.ID), err)
|
|
||||||
}
|
|
||||||
|
|
||||||
depArchive, err := m.pluginStorage.Add(ctx, dep.ID, d.File)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
pathsToScan = append(pathsToScan, depArchive.Path)
|
|
||||||
}
|
|
||||||
|
|
||||||
err = m.loadPlugins(context.Background(), plugins.External, pathsToScan...)
|
|
||||||
if err != nil {
|
|
||||||
m.log.Error("Could not load plugins", "paths", pathsToScan, "err", err)
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (m *PluginManager) Remove(ctx context.Context, pluginID string) error {
|
|
||||||
plugin, exists := m.plugin(ctx, pluginID)
|
|
||||||
if !exists {
|
|
||||||
return plugins.ErrPluginNotInstalled
|
|
||||||
}
|
|
||||||
|
|
||||||
if !plugin.IsExternalPlugin() {
|
|
||||||
return plugins.ErrUninstallCorePlugin
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := m.unregisterAndStop(ctx, plugin); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
return m.pluginStorage.Remove(ctx, plugin.ID)
|
|
||||||
}
|
|
111
pkg/plugins/manager/store/store.go
Normal file
111
pkg/plugins/manager/store/store.go
Normal file
@ -0,0 +1,111 @@
|
|||||||
|
package store
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"sort"
|
||||||
|
|
||||||
|
"github.com/grafana/grafana/pkg/plugins"
|
||||||
|
"github.com/grafana/grafana/pkg/plugins/manager/registry"
|
||||||
|
)
|
||||||
|
|
||||||
|
var _ plugins.Store = (*Service)(nil)
|
||||||
|
var _ plugins.RendererManager = (*Service)(nil)
|
||||||
|
var _ plugins.SecretsPluginManager = (*Service)(nil)
|
||||||
|
|
||||||
|
type Service struct {
|
||||||
|
pluginRegistry registry.Service
|
||||||
|
}
|
||||||
|
|
||||||
|
func ProvideService(pluginRegistry registry.Service) *Service {
|
||||||
|
return &Service{
|
||||||
|
pluginRegistry: pluginRegistry,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *Service) Plugin(ctx context.Context, pluginID string) (plugins.PluginDTO, bool) {
|
||||||
|
p, exists := s.plugin(ctx, pluginID)
|
||||||
|
if !exists {
|
||||||
|
return plugins.PluginDTO{}, false
|
||||||
|
}
|
||||||
|
|
||||||
|
return p.ToDTO(), true
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *Service) Plugins(ctx context.Context, pluginTypes ...plugins.Type) []plugins.PluginDTO {
|
||||||
|
// if no types passed, assume all
|
||||||
|
if len(pluginTypes) == 0 {
|
||||||
|
pluginTypes = plugins.PluginTypes
|
||||||
|
}
|
||||||
|
|
||||||
|
var requestedTypes = make(map[plugins.Type]struct{})
|
||||||
|
for _, pt := range pluginTypes {
|
||||||
|
requestedTypes[pt] = struct{}{}
|
||||||
|
}
|
||||||
|
|
||||||
|
pluginsList := make([]plugins.PluginDTO, 0)
|
||||||
|
for _, p := range s.availablePlugins(ctx) {
|
||||||
|
if _, exists := requestedTypes[p.Type]; exists {
|
||||||
|
pluginsList = append(pluginsList, p.ToDTO())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return pluginsList
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *Service) Renderer() *plugins.Plugin {
|
||||||
|
for _, p := range s.availablePlugins(context.TODO()) {
|
||||||
|
if p.IsRenderer() {
|
||||||
|
return p
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *Service) SecretsManager() *plugins.Plugin {
|
||||||
|
for _, p := range s.availablePlugins(context.TODO()) {
|
||||||
|
if p.IsSecretsManager() {
|
||||||
|
return p
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// plugin finds a plugin with `pluginID` from the registry that is not decommissioned
|
||||||
|
func (s *Service) plugin(ctx context.Context, pluginID string) (*plugins.Plugin, bool) {
|
||||||
|
p, exists := s.pluginRegistry.Plugin(ctx, pluginID)
|
||||||
|
if !exists {
|
||||||
|
return nil, false
|
||||||
|
}
|
||||||
|
|
||||||
|
if p.IsDecommissioned() {
|
||||||
|
return nil, false
|
||||||
|
}
|
||||||
|
|
||||||
|
return p, true
|
||||||
|
}
|
||||||
|
|
||||||
|
// availablePlugins returns all non-decommissioned plugins from the registry sorted by alphabetic order on `plugin.ID`
|
||||||
|
func (s *Service) availablePlugins(ctx context.Context) []*plugins.Plugin {
|
||||||
|
var res []*plugins.Plugin
|
||||||
|
for _, p := range s.pluginRegistry.Plugins(ctx) {
|
||||||
|
if !p.IsDecommissioned() {
|
||||||
|
res = append(res, p)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
sort.SliceStable(res, func(i, j int) bool {
|
||||||
|
return res[i].ID < res[j].ID
|
||||||
|
})
|
||||||
|
return res
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *Service) Routes() []*plugins.StaticRoute {
|
||||||
|
staticRoutes := make([]*plugins.StaticRoute, 0)
|
||||||
|
|
||||||
|
for _, p := range s.availablePlugins(context.TODO()) {
|
||||||
|
if p.StaticRoute() != nil {
|
||||||
|
staticRoutes = append(staticRoutes, p.StaticRoute())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return staticRoutes
|
||||||
|
}
|
207
pkg/plugins/manager/store/store_test.go
Normal file
207
pkg/plugins/manager/store/store_test.go
Normal file
@ -0,0 +1,207 @@
|
|||||||
|
package store
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
|
||||||
|
"github.com/grafana/grafana/pkg/plugins"
|
||||||
|
"github.com/grafana/grafana/pkg/plugins/backendplugin"
|
||||||
|
)
|
||||||
|
|
||||||
|
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 := ProvideService(
|
||||||
|
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 := ProvideService(
|
||||||
|
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_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}}
|
||||||
|
p4 := &plugins.Plugin{JSONData: plugins.JSONData{ID: "test-datasource", Type: plugins.DataSource}}
|
||||||
|
p4.RegisterClient(&DecommissionedPlugin{})
|
||||||
|
|
||||||
|
ps := ProvideService(
|
||||||
|
newFakePluginRegistry(map[string]*plugins.Plugin{
|
||||||
|
p1.ID: p1,
|
||||||
|
p2.ID: p2,
|
||||||
|
p3.ID: p3,
|
||||||
|
p4.ID: p4,
|
||||||
|
}),
|
||||||
|
)
|
||||||
|
|
||||||
|
r := ps.Renderer()
|
||||||
|
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 := ProvideService(
|
||||||
|
newFakePluginRegistry(map[string]*plugins.Plugin{
|
||||||
|
p1.ID: p1,
|
||||||
|
p2.ID: p2,
|
||||||
|
p3.ID: p3,
|
||||||
|
p4.ID: p4,
|
||||||
|
}),
|
||||||
|
)
|
||||||
|
|
||||||
|
r := ps.SecretsManager()
|
||||||
|
require.Equal(t, p3, r)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
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 := ProvideService(
|
||||||
|
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_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 := ProvideService(
|
||||||
|
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
|
||||||
|
}
|
@ -206,7 +206,6 @@ func (p *Plugin) Start(ctx context.Context) error {
|
|||||||
if p.client == nil {
|
if p.client == nil {
|
||||||
return fmt.Errorf("could not start plugin %s as no plugin client exists", p.ID)
|
return fmt.Errorf("could not start plugin %s as no plugin client exists", p.ID)
|
||||||
}
|
}
|
||||||
|
|
||||||
return p.client.Start(ctx)
|
return p.client.Start(ctx)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -8,7 +8,6 @@ import (
|
|||||||
uss "github.com/grafana/grafana/pkg/infra/usagestats/service"
|
uss "github.com/grafana/grafana/pkg/infra/usagestats/service"
|
||||||
"github.com/grafana/grafana/pkg/infra/usagestats/statscollector"
|
"github.com/grafana/grafana/pkg/infra/usagestats/statscollector"
|
||||||
"github.com/grafana/grafana/pkg/models"
|
"github.com/grafana/grafana/pkg/models"
|
||||||
"github.com/grafana/grafana/pkg/plugins/manager"
|
|
||||||
"github.com/grafana/grafana/pkg/registry"
|
"github.com/grafana/grafana/pkg/registry"
|
||||||
"github.com/grafana/grafana/pkg/services/alerting"
|
"github.com/grafana/grafana/pkg/services/alerting"
|
||||||
"github.com/grafana/grafana/pkg/services/cleanup"
|
"github.com/grafana/grafana/pkg/services/cleanup"
|
||||||
@ -34,7 +33,7 @@ import (
|
|||||||
|
|
||||||
func ProvideBackgroundServiceRegistry(
|
func ProvideBackgroundServiceRegistry(
|
||||||
httpServer *api.HTTPServer, ng *ngalert.AlertNG, cleanup *cleanup.CleanUpService, live *live.GrafanaLive,
|
httpServer *api.HTTPServer, ng *ngalert.AlertNG, cleanup *cleanup.CleanUpService, live *live.GrafanaLive,
|
||||||
pushGateway *pushhttp.Gateway, notifications *notifications.NotificationService, pm *manager.PluginManager,
|
pushGateway *pushhttp.Gateway, notifications *notifications.NotificationService,
|
||||||
rendering *rendering.RenderingService, tokenService models.UserTokenBackgroundService, tracing tracing.Tracer,
|
rendering *rendering.RenderingService, tokenService models.UserTokenBackgroundService, tracing tracing.Tracer,
|
||||||
provisioning *provisioning.ProvisioningServiceImpl, alerting *alerting.AlertEngine, usageStats *uss.UsageStats,
|
provisioning *provisioning.ProvisioningServiceImpl, alerting *alerting.AlertEngine, usageStats *uss.UsageStats,
|
||||||
statsCollector *statscollector.Service, grafanaUpdateChecker *updatechecker.GrafanaService,
|
statsCollector *statscollector.Service, grafanaUpdateChecker *updatechecker.GrafanaService,
|
||||||
@ -58,7 +57,6 @@ func ProvideBackgroundServiceRegistry(
|
|||||||
tokenService,
|
tokenService,
|
||||||
provisioning,
|
provisioning,
|
||||||
alerting,
|
alerting,
|
||||||
pm,
|
|
||||||
grafanaUpdateChecker,
|
grafanaUpdateChecker,
|
||||||
pluginsUpdateChecker,
|
pluginsUpdateChecker,
|
||||||
metrics,
|
metrics,
|
||||||
|
@ -35,8 +35,12 @@ import (
|
|||||||
"github.com/grafana/grafana/pkg/plugins"
|
"github.com/grafana/grafana/pkg/plugins"
|
||||||
"github.com/grafana/grafana/pkg/plugins/backendplugin/coreplugin"
|
"github.com/grafana/grafana/pkg/plugins/backendplugin/coreplugin"
|
||||||
"github.com/grafana/grafana/pkg/plugins/manager"
|
"github.com/grafana/grafana/pkg/plugins/manager"
|
||||||
|
"github.com/grafana/grafana/pkg/plugins/manager/client"
|
||||||
|
pluginDashboards "github.com/grafana/grafana/pkg/plugins/manager/dashboards"
|
||||||
"github.com/grafana/grafana/pkg/plugins/manager/loader"
|
"github.com/grafana/grafana/pkg/plugins/manager/loader"
|
||||||
|
processManager "github.com/grafana/grafana/pkg/plugins/manager/process"
|
||||||
"github.com/grafana/grafana/pkg/plugins/manager/registry"
|
"github.com/grafana/grafana/pkg/plugins/manager/registry"
|
||||||
|
managerStore "github.com/grafana/grafana/pkg/plugins/manager/store"
|
||||||
"github.com/grafana/grafana/pkg/plugins/plugincontext"
|
"github.com/grafana/grafana/pkg/plugins/plugincontext"
|
||||||
"github.com/grafana/grafana/pkg/plugins/repo"
|
"github.com/grafana/grafana/pkg/plugins/repo"
|
||||||
"github.com/grafana/grafana/pkg/services/accesscontrol"
|
"github.com/grafana/grafana/pkg/services/accesscontrol"
|
||||||
@ -171,12 +175,17 @@ var wireBasicSet = wire.NewSet(
|
|||||||
wire.Bind(new(repo.Service), new(*repo.Manager)),
|
wire.Bind(new(repo.Service), new(*repo.Manager)),
|
||||||
manager.ProvideService,
|
manager.ProvideService,
|
||||||
wire.Bind(new(plugins.Manager), new(*manager.PluginManager)),
|
wire.Bind(new(plugins.Manager), new(*manager.PluginManager)),
|
||||||
wire.Bind(new(plugins.Client), new(*manager.PluginManager)),
|
client.ProvideService,
|
||||||
wire.Bind(new(plugins.Store), new(*manager.PluginManager)),
|
wire.Bind(new(plugins.Client), new(*client.Service)),
|
||||||
wire.Bind(new(plugins.DashboardFileStore), new(*manager.PluginManager)),
|
managerStore.ProvideService,
|
||||||
wire.Bind(new(plugins.StaticRouteResolver), new(*manager.PluginManager)),
|
wire.Bind(new(plugins.Store), new(*managerStore.Service)),
|
||||||
wire.Bind(new(plugins.RendererManager), new(*manager.PluginManager)),
|
wire.Bind(new(plugins.RendererManager), new(*managerStore.Service)),
|
||||||
wire.Bind(new(plugins.SecretsPluginManager), new(*manager.PluginManager)),
|
wire.Bind(new(plugins.SecretsPluginManager), new(*managerStore.Service)),
|
||||||
|
wire.Bind(new(plugins.StaticRouteResolver), new(*managerStore.Service)),
|
||||||
|
pluginDashboards.ProvideFileStoreManager,
|
||||||
|
wire.Bind(new(pluginDashboards.FileStore), new(*pluginDashboards.FileStoreManager)),
|
||||||
|
processManager.ProvideService,
|
||||||
|
wire.Bind(new(processManager.Service), new(*processManager.Manager)),
|
||||||
coreplugin.ProvideCoreRegistry,
|
coreplugin.ProvideCoreRegistry,
|
||||||
loader.ProvideService,
|
loader.ProvideService,
|
||||||
wire.Bind(new(loader.Service), new(*loader.Loader)),
|
wire.Bind(new(loader.Service), new(*loader.Loader)),
|
||||||
|
@ -7,12 +7,12 @@ import (
|
|||||||
"github.com/grafana/grafana/pkg/components/simplejson"
|
"github.com/grafana/grafana/pkg/components/simplejson"
|
||||||
"github.com/grafana/grafana/pkg/infra/log"
|
"github.com/grafana/grafana/pkg/infra/log"
|
||||||
"github.com/grafana/grafana/pkg/models"
|
"github.com/grafana/grafana/pkg/models"
|
||||||
"github.com/grafana/grafana/pkg/plugins"
|
pluginDashboardsManager "github.com/grafana/grafana/pkg/plugins/manager/dashboards"
|
||||||
"github.com/grafana/grafana/pkg/services/dashboards"
|
"github.com/grafana/grafana/pkg/services/dashboards"
|
||||||
"github.com/grafana/grafana/pkg/services/plugindashboards"
|
"github.com/grafana/grafana/pkg/services/plugindashboards"
|
||||||
)
|
)
|
||||||
|
|
||||||
func ProvideService(pluginDashboardStore plugins.DashboardFileStore, dashboardPluginService dashboards.PluginService) *Service {
|
func ProvideService(pluginDashboardStore pluginDashboardsManager.FileStore, dashboardPluginService dashboards.PluginService) *Service {
|
||||||
return &Service{
|
return &Service{
|
||||||
pluginDashboardStore: pluginDashboardStore,
|
pluginDashboardStore: pluginDashboardStore,
|
||||||
dashboardPluginService: dashboardPluginService,
|
dashboardPluginService: dashboardPluginService,
|
||||||
@ -21,7 +21,7 @@ func ProvideService(pluginDashboardStore plugins.DashboardFileStore, dashboardPl
|
|||||||
}
|
}
|
||||||
|
|
||||||
type Service struct {
|
type Service struct {
|
||||||
pluginDashboardStore plugins.DashboardFileStore
|
pluginDashboardStore pluginDashboardsManager.FileStore
|
||||||
dashboardPluginService dashboards.PluginService
|
dashboardPluginService dashboards.PluginService
|
||||||
logger log.Logger
|
logger log.Logger
|
||||||
}
|
}
|
||||||
@ -31,7 +31,7 @@ func (s Service) ListPluginDashboards(ctx context.Context, req *plugindashboards
|
|||||||
return nil, fmt.Errorf("req cannot be nil")
|
return nil, fmt.Errorf("req cannot be nil")
|
||||||
}
|
}
|
||||||
|
|
||||||
listArgs := &plugins.ListPluginDashboardFilesArgs{
|
listArgs := &pluginDashboardsManager.ListPluginDashboardFilesArgs{
|
||||||
PluginID: req.PluginID,
|
PluginID: req.PluginID,
|
||||||
}
|
}
|
||||||
listResp, err := s.pluginDashboardStore.ListPluginDashboardFiles(ctx, listArgs)
|
listResp, err := s.pluginDashboardStore.ListPluginDashboardFiles(ctx, listArgs)
|
||||||
@ -106,7 +106,7 @@ func (s Service) LoadPluginDashboard(ctx context.Context, req *plugindashboards.
|
|||||||
return nil, fmt.Errorf("req cannot be nil")
|
return nil, fmt.Errorf("req cannot be nil")
|
||||||
}
|
}
|
||||||
|
|
||||||
args := &plugins.GetPluginDashboardFileContentsArgs{
|
args := &pluginDashboardsManager.GetPluginDashboardFileContentsArgs{
|
||||||
PluginID: req.PluginID,
|
PluginID: req.PluginID,
|
||||||
FileReference: req.Reference,
|
FileReference: req.Reference,
|
||||||
}
|
}
|
||||||
|
@ -11,6 +11,7 @@ import (
|
|||||||
"github.com/grafana/grafana/pkg/components/simplejson"
|
"github.com/grafana/grafana/pkg/components/simplejson"
|
||||||
"github.com/grafana/grafana/pkg/models"
|
"github.com/grafana/grafana/pkg/models"
|
||||||
"github.com/grafana/grafana/pkg/plugins"
|
"github.com/grafana/grafana/pkg/plugins"
|
||||||
|
"github.com/grafana/grafana/pkg/plugins/manager/dashboards"
|
||||||
"github.com/grafana/grafana/pkg/services/plugindashboards"
|
"github.com/grafana/grafana/pkg/services/plugindashboards"
|
||||||
"github.com/stretchr/testify/require"
|
"github.com/stretchr/testify/require"
|
||||||
)
|
)
|
||||||
@ -169,7 +170,7 @@ type pluginDashboardStoreMock struct {
|
|||||||
pluginDashboardFiles map[string]map[string][]byte
|
pluginDashboardFiles map[string]map[string][]byte
|
||||||
}
|
}
|
||||||
|
|
||||||
func (m pluginDashboardStoreMock) ListPluginDashboardFiles(ctx context.Context, args *plugins.ListPluginDashboardFilesArgs) (*plugins.ListPluginDashboardFilesResult, error) {
|
func (m pluginDashboardStoreMock) ListPluginDashboardFiles(ctx context.Context, args *dashboards.ListPluginDashboardFilesArgs) (*dashboards.ListPluginDashboardFilesResult, error) {
|
||||||
if dashboardFiles, exists := m.pluginDashboardFiles[args.PluginID]; exists {
|
if dashboardFiles, exists := m.pluginDashboardFiles[args.PluginID]; exists {
|
||||||
references := []string{}
|
references := []string{}
|
||||||
|
|
||||||
@ -179,7 +180,7 @@ func (m pluginDashboardStoreMock) ListPluginDashboardFiles(ctx context.Context,
|
|||||||
|
|
||||||
sort.Strings(references)
|
sort.Strings(references)
|
||||||
|
|
||||||
return &plugins.ListPluginDashboardFilesResult{
|
return &dashboards.ListPluginDashboardFilesResult{
|
||||||
FileReferences: references,
|
FileReferences: references,
|
||||||
}, nil
|
}, nil
|
||||||
}
|
}
|
||||||
@ -187,11 +188,11 @@ func (m pluginDashboardStoreMock) ListPluginDashboardFiles(ctx context.Context,
|
|||||||
return nil, plugins.NotFoundError{PluginID: args.PluginID}
|
return nil, plugins.NotFoundError{PluginID: args.PluginID}
|
||||||
}
|
}
|
||||||
|
|
||||||
func (m pluginDashboardStoreMock) GetPluginDashboardFileContents(ctx context.Context, args *plugins.GetPluginDashboardFileContentsArgs) (*plugins.GetPluginDashboardFileContentsResult, error) {
|
func (m pluginDashboardStoreMock) GetPluginDashboardFileContents(ctx context.Context, args *dashboards.GetPluginDashboardFileContentsArgs) (*dashboards.GetPluginDashboardFileContentsResult, error) {
|
||||||
if dashboardFiles, exists := m.pluginDashboardFiles[args.PluginID]; exists {
|
if dashboardFiles, exists := m.pluginDashboardFiles[args.PluginID]; exists {
|
||||||
if content, exists := dashboardFiles[args.FileReference]; exists {
|
if content, exists := dashboardFiles[args.FileReference]; exists {
|
||||||
r := bytes.NewReader(content)
|
r := bytes.NewReader(content)
|
||||||
return &plugins.GetPluginDashboardFileContentsResult{
|
return &dashboards.GetPluginDashboardFileContentsResult{
|
||||||
Content: io.NopCloser(r),
|
Content: io.NopCloser(r),
|
||||||
}, nil
|
}, nil
|
||||||
}
|
}
|
||||||
|
Reference in New Issue
Block a user