mirror of
https://github.com/grafana/grafana.git
synced 2025-07-31 05:02:35 +08:00
Plugins: Create single point of entry for adding / removing plugins (#55463)
* split out plugin manager * remove whitespace * fix tests * split up tests * updating naming conventions * simplify manager * tidy * explorations * fix build * tidy * fix tests * add logger helper * pass the tests * tidying * fix tests * tidy and re-add test * store depends on loader * enrich tests * fix test * undo gomod changes
This commit is contained in:
Will Browne
223
pkg/plugins/manager/installer_test.go
Normal file
223
pkg/plugins/manager/installer_test.go
Normal file
@ -0,0 +1,223 @@
|
||||
package manager
|
||||
|
||||
import (
|
||||
"archive/zip"
|
||||
"context"
|
||||
"fmt"
|
||||
"testing"
|
||||
|
||||
"github.com/grafana/grafana/pkg/infra/log"
|
||||
"github.com/grafana/grafana/pkg/plugins"
|
||||
"github.com/grafana/grafana/pkg/plugins/manager/fakes"
|
||||
"github.com/grafana/grafana/pkg/plugins/repo"
|
||||
"github.com/grafana/grafana/pkg/plugins/storage"
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
|
||||
const testPluginID = "test-plugin"
|
||||
|
||||
func TestPluginManager_Add_Remove(t *testing.T) {
|
||||
t.Run("Adding a new plugin", func(t *testing.T) {
|
||||
const (
|
||||
pluginID, v1 = "test-panel", "1.0.0"
|
||||
zipNameV1 = "test-panel-1.0.0.zip"
|
||||
pluginDirV1 = "/data/plugin/test-panel-1.0.0"
|
||||
)
|
||||
|
||||
// mock a plugin to be returned automatically by the plugin loader
|
||||
pluginV1 := createPlugin(t, pluginID, plugins.External, true, true, func(plugin *plugins.Plugin) {
|
||||
plugin.Info.Version = v1
|
||||
plugin.PluginDir = pluginDirV1
|
||||
})
|
||||
mockZipV1 := &zip.ReadCloser{Reader: zip.Reader{File: []*zip.File{{
|
||||
FileHeader: zip.FileHeader{Name: zipNameV1},
|
||||
}}}}
|
||||
|
||||
var loadedPaths []string
|
||||
loader := &fakes.FakeLoader{
|
||||
LoadFunc: func(_ context.Context, _ plugins.Class, paths []string) ([]*plugins.Plugin, error) {
|
||||
loadedPaths = append(loadedPaths, paths...)
|
||||
require.Equal(t, []string{zipNameV1}, paths)
|
||||
return []*plugins.Plugin{pluginV1}, nil
|
||||
},
|
||||
}
|
||||
|
||||
pluginRepo := &fakes.FakePluginRepo{
|
||||
GetPluginArchiveFunc: func(_ context.Context, id, version string, _ repo.CompatOpts) (*repo.PluginArchive, error) {
|
||||
require.Equal(t, pluginID, id)
|
||||
require.Equal(t, v1, version)
|
||||
return &repo.PluginArchive{
|
||||
File: mockZipV1,
|
||||
}, nil
|
||||
},
|
||||
}
|
||||
|
||||
fs := &fakes.FakePluginStorage{
|
||||
AddFunc: func(_ context.Context, id string, z *zip.ReadCloser) (*storage.ExtractedPluginArchive, error) {
|
||||
require.Equal(t, pluginID, id)
|
||||
require.Equal(t, mockZipV1, z)
|
||||
return &storage.ExtractedPluginArchive{
|
||||
Path: zipNameV1,
|
||||
}, nil
|
||||
},
|
||||
RegisterFunc: func(_ context.Context, pluginID, pluginDir string) error {
|
||||
require.Equal(t, pluginV1.ID, pluginID)
|
||||
require.Equal(t, pluginV1.PluginDir, pluginDir)
|
||||
return nil
|
||||
},
|
||||
Store: map[string]struct{}{},
|
||||
}
|
||||
|
||||
inst := New(fakes.NewFakePluginRegistry(), loader, pluginRepo, fs)
|
||||
err := inst.Add(context.Background(), pluginID, v1, plugins.CompatOpts{})
|
||||
require.NoError(t, err)
|
||||
|
||||
t.Run("Won't add if already exists", func(t *testing.T) {
|
||||
inst.pluginRegistry = &fakes.FakePluginRegistry{
|
||||
Store: map[string]*plugins.Plugin{
|
||||
pluginID: pluginV1,
|
||||
},
|
||||
}
|
||||
|
||||
err = inst.Add(context.Background(), pluginID, v1, plugins.CompatOpts{})
|
||||
require.Equal(t, plugins.DuplicateError{
|
||||
PluginID: pluginV1.ID,
|
||||
ExistingPluginDir: pluginV1.PluginDir,
|
||||
}, err)
|
||||
})
|
||||
|
||||
t.Run("Update plugin to different version", func(t *testing.T) {
|
||||
const (
|
||||
v2 = "2.0.0"
|
||||
zipNameV2 = "test-panel-2.0.0.zip"
|
||||
pluginDirV2 = "/data/plugin/test-panel-2.0.0"
|
||||
)
|
||||
// mock a plugin to be returned automatically by the plugin loader
|
||||
pluginV2 := createPlugin(t, pluginID, plugins.External, true, true, func(plugin *plugins.Plugin) {
|
||||
plugin.Info.Version = v2
|
||||
plugin.PluginDir = pluginDirV2
|
||||
})
|
||||
|
||||
mockZipV2 := &zip.ReadCloser{Reader: zip.Reader{File: []*zip.File{{
|
||||
FileHeader: zip.FileHeader{Name: zipNameV2},
|
||||
}}}}
|
||||
loader.LoadFunc = func(_ context.Context, class plugins.Class, paths []string) ([]*plugins.Plugin, error) {
|
||||
require.Equal(t, plugins.External, class)
|
||||
require.Equal(t, []string{zipNameV2}, paths)
|
||||
return []*plugins.Plugin{pluginV2}, nil
|
||||
}
|
||||
pluginRepo.GetPluginDownloadOptionsFunc = func(_ context.Context, pluginID, version string, _ repo.CompatOpts) (*repo.PluginDownloadOptions, error) {
|
||||
return &repo.PluginDownloadOptions{
|
||||
PluginZipURL: "https://grafanaplugins.com",
|
||||
}, nil
|
||||
}
|
||||
pluginRepo.GetPluginArchiveByURLFunc = func(_ context.Context, pluginZipURL string, _ repo.CompatOpts) (*repo.PluginArchive, error) {
|
||||
require.Equal(t, "https://grafanaplugins.com", pluginZipURL)
|
||||
return &repo.PluginArchive{
|
||||
File: mockZipV2,
|
||||
}, nil
|
||||
}
|
||||
fs.AddFunc = func(_ context.Context, pluginID string, z *zip.ReadCloser) (*storage.ExtractedPluginArchive, error) {
|
||||
require.Equal(t, pluginV1.ID, pluginID)
|
||||
require.Equal(t, mockZipV2, z)
|
||||
return &storage.ExtractedPluginArchive{
|
||||
Path: zipNameV2,
|
||||
}, nil
|
||||
}
|
||||
fs.RegisterFunc = func(_ context.Context, pluginID, pluginDir string) error {
|
||||
require.Equal(t, pluginV2.ID, pluginID)
|
||||
require.Equal(t, pluginV2.PluginDir, pluginDir)
|
||||
return nil
|
||||
}
|
||||
|
||||
err = inst.Add(context.Background(), pluginID, v2, plugins.CompatOpts{})
|
||||
require.NoError(t, err)
|
||||
})
|
||||
|
||||
t.Run("Removing an existing plugin", func(t *testing.T) {
|
||||
inst.pluginRegistry = &fakes.FakePluginRegistry{
|
||||
Store: map[string]*plugins.Plugin{
|
||||
pluginID: pluginV1,
|
||||
},
|
||||
}
|
||||
|
||||
var unloadedPlugins []string
|
||||
inst.pluginLoader = &fakes.FakeLoader{
|
||||
UnloadFunc: func(_ context.Context, id string) error {
|
||||
unloadedPlugins = append(unloadedPlugins, id)
|
||||
return nil
|
||||
},
|
||||
}
|
||||
|
||||
err = inst.Remove(context.Background(), pluginID)
|
||||
require.NoError(t, err)
|
||||
|
||||
require.Equal(t, []string{pluginID}, unloadedPlugins)
|
||||
|
||||
t.Run("Won't remove if not exists", func(t *testing.T) {
|
||||
inst.pluginRegistry = fakes.NewFakePluginRegistry()
|
||||
|
||||
err = inst.Remove(context.Background(), pluginID)
|
||||
require.Equal(t, plugins.ErrPluginNotInstalled, err)
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
t.Run("Can't update core or bundled plugin", func(t *testing.T) {
|
||||
tcs := []struct {
|
||||
class plugins.Class
|
||||
}{
|
||||
{class: plugins.Core},
|
||||
{class: plugins.Bundled},
|
||||
}
|
||||
|
||||
for _, tc := range tcs {
|
||||
p := createPlugin(t, testPluginID, tc.class, true, true, func(plugin *plugins.Plugin) {
|
||||
plugin.Info.Version = "1.0.0"
|
||||
})
|
||||
|
||||
reg := &fakes.FakePluginRegistry{
|
||||
Store: map[string]*plugins.Plugin{
|
||||
testPluginID: p,
|
||||
},
|
||||
}
|
||||
|
||||
pm := New(reg, &fakes.FakeLoader{}, &fakes.FakePluginRepo{}, &fakes.FakePluginStorage{})
|
||||
err := pm.Add(context.Background(), p.ID, "3.2.0", plugins.CompatOpts{})
|
||||
require.ErrorIs(t, err, plugins.ErrInstallCorePlugin)
|
||||
|
||||
err = pm.Add(context.Background(), testPluginID, "", plugins.CompatOpts{})
|
||||
require.Equal(t, plugins.ErrInstallCorePlugin, err)
|
||||
|
||||
t.Run(fmt.Sprintf("Can't uninstall %s plugin", tc.class), func(t *testing.T) {
|
||||
err = pm.Remove(context.Background(), p.ID)
|
||||
require.Equal(t, plugins.ErrUninstallCorePlugin, err)
|
||||
})
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
func createPlugin(t *testing.T, pluginID string, class plugins.Class, managed, backend bool, cbs ...func(*plugins.Plugin)) *plugins.Plugin {
|
||||
t.Helper()
|
||||
|
||||
p := &plugins.Plugin{
|
||||
Class: class,
|
||||
JSONData: plugins.JSONData{
|
||||
ID: pluginID,
|
||||
Type: plugins.DataSource,
|
||||
Backend: backend,
|
||||
},
|
||||
}
|
||||
p.SetLogger(log.NewNopLogger())
|
||||
p.RegisterClient(&fakes.FakePluginClient{
|
||||
ID: pluginID,
|
||||
Managed: managed,
|
||||
Log: p.Logger(),
|
||||
})
|
||||
|
||||
for _, cb := range cbs {
|
||||
cb(p)
|
||||
}
|
||||
|
||||
return p
|
||||
}
|
||||
Reference in New Issue
Block a user