public/grafana
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Plugins: Standardize Golang enum naming convention (#69449)

Browse Source 
* standardize enum pattern

* fix up
This commit is contained in:
Will Browne
2023-06-08 12:21:19 +02:00
committed by GitHub
parent 4db6679460
commit a221e1d226
31 changed files with 308 additions and 306 deletions
Download Patch File Download Diff File Expand all files Collapse all files
pkg/plugins/manager/installer.go
+1 -1
View File
@@ -124,7 +124,7 @@ func (m *PluginInstaller) Add(ctx context.Context, pluginID, version string, opt
pathsToScan = append(pathsToScan, depArchive.Path)
}
_, err = m.pluginLoader.Load(ctx, sources.NewLocalSource(plugins.External, pathsToScan))
_, err = m.pluginLoader.Load(ctx, sources.NewLocalSource(plugins.ClassExternal, pathsToScan))
if err != nil {
m.log.Error("Could not load plugins", "paths", pathsToScan, "err", err)
return err
pkg/plugins/manager/installer_test.go
+6 -6
View File
@@ -26,7 +26,7 @@ func TestPluginManager_Add_Remove(t *testing.T) {
)
// mock a plugin to be returned automatically by the plugin loader
pluginV1 := createPlugin(t, pluginID, plugins.External, true, true, func(plugin *plugins.Plugin) {
pluginV1 := createPlugin(t, pluginID, plugins.ClassExternal, true, true, func(plugin *plugins.Plugin) {
plugin.Info.Version = v1
})
mockZipV1 := &zip.ReadCloser{Reader: zip.Reader{File: []*zip.File{{
@@ -85,7 +85,7 @@ func TestPluginManager_Add_Remove(t *testing.T) {
zipNameV2 = "test-panel-2.0.0.zip"
)
// mock a plugin to be returned automatically by the plugin loader
pluginV2 := createPlugin(t, pluginID, plugins.External, true, true, func(plugin *plugins.Plugin) {
pluginV2 := createPlugin(t, pluginID, plugins.ClassExternal, true, true, func(plugin *plugins.Plugin) {
plugin.Info.Version = v2
})
@@ -93,7 +93,7 @@ func TestPluginManager_Add_Remove(t *testing.T) {
FileHeader: zip.FileHeader{Name: zipNameV2},
}}}}
loader.LoadFunc = func(ctx context.Context, src plugins.PluginSource) ([]*plugins.Plugin, error) {
require.Equal(t, plugins.External, src.PluginClass(ctx))
require.Equal(t, plugins.ClassExternal, src.PluginClass(ctx))
require.Equal(t, []string{zipNameV2}, src.PluginURIs(ctx))
return []*plugins.Plugin{pluginV2}, nil
}
@@ -153,8 +153,8 @@ func TestPluginManager_Add_Remove(t *testing.T) {
tcs := []struct {
class plugins.Class
}{
{class: plugins.Core},
{class: plugins.Bundled},
{class: plugins.ClassCore},
{class: plugins.ClassBundled},
}
for _, tc := range tcs {
@@ -190,7 +190,7 @@ func createPlugin(t *testing.T, pluginID string, class plugins.Class, managed, b
Class: class,
JSONData: plugins.JSONData{
ID: pluginID,
Type: plugins.DataSource,
Type: plugins.TypeDataSource,
Backend: backend,
},
}
pkg/plugins/manager/loader/assetpath/assetpath.go
+2 -2
View File
@@ -24,7 +24,7 @@ func ProvideService(cdn *pluginscdn.Service) *Service {
// Base returns the base path for the specified plugin.
func (s *Service) Base(pluginJSON plugins.JSONData, class plugins.Class, pluginDir string) (string, error) {
if class == plugins.Core {
if class == plugins.ClassCore {
return path.Join("public/app/plugins", string(pluginJSON.Type), filepath.Base(pluginDir)), nil
}
if s.cdn.PluginSupported(pluginJSON.ID) {
@@ -35,7 +35,7 @@ func (s *Service) Base(pluginJSON plugins.JSONData, class plugins.Class, pluginD
// Module returns the module.js path for the specified plugin.
func (s *Service) Module(pluginJSON plugins.JSONData, class plugins.Class, pluginDir string) (string, error) {
if class == plugins.Core {
if class == plugins.ClassCore {
return path.Join("app/plugins", string(pluginJSON.Type), filepath.Base(pluginDir), "module"), nil
}
if s.cdn.PluginSupported(pluginJSON.ID) {
pkg/plugins/manager/loader/assetpath/assetpath_test.go
+6 -6
View File
@@ -56,29 +56,29 @@ func TestService(t *testing.T) {
})
t.Run("Base", func(t *testing.T) {
base, err := svc.Base(jsonData["one"], plugins.External, extPath("one"))
base, err := svc.Base(jsonData["one"], plugins.ClassExternal, extPath("one"))
require.NoError(t, err)
require.Equal(t, "plugin-cdn/one/1.0.0/public/plugins/one", base)
base, err = svc.Base(jsonData["two"], plugins.External, extPath("two"))
base, err = svc.Base(jsonData["two"], plugins.ClassExternal, extPath("two"))
require.NoError(t, err)
require.Equal(t, "public/plugins/two", base)
base, err = svc.Base(jsonData["table-old"], plugins.Core, tableOldPath)
base, err = svc.Base(jsonData["table-old"], plugins.ClassCore, tableOldPath)
require.NoError(t, err)
require.Equal(t, "public/app/plugins/table-old", base)
})
t.Run("Module", func(t *testing.T) {
module, err := svc.Module(jsonData["one"], plugins.External, extPath("one"))
module, err := svc.Module(jsonData["one"], plugins.ClassExternal, extPath("one"))
require.NoError(t, err)
require.Equal(t, "plugin-cdn/one/1.0.0/public/plugins/one/module", module)
module, err = svc.Module(jsonData["two"], plugins.External, extPath("two"))
module, err = svc.Module(jsonData["two"], plugins.ClassExternal, extPath("two"))
require.NoError(t, err)
require.Equal(t, "plugins/two/module", module)
module, err = svc.Module(jsonData["table-old"], plugins.Core, tableOldPath)
module, err = svc.Module(jsonData["table-old"], plugins.ClassCore, tableOldPath)
require.NoError(t, err)
require.Equal(t, "app/plugins/table-old/module", module)
})
pkg/plugins/manager/loader/finder/local_test.go
+9 -9
View File
@@ -43,7 +43,7 @@ func TestFinder_Find(t *testing.T) {
Primary: plugins.FoundPlugin{
JSONData: plugins.JSONData{
ID: "test-datasource",
Type: plugins.DataSource,
Type: plugins.TypeDataSource,
Name: "Test",
Info: plugins.Info{
Author: plugins.InfoLink{
@@ -57,7 +57,7 @@ func TestFinder_Find(t *testing.T) {
GrafanaVersion: "*",
Plugins: []plugins.Dependency{},
},
State: plugins.AlphaRelease,
State: plugins.ReleaseStateAlpha,
Backend: true,
Executable: "test",
},
@@ -74,7 +74,7 @@ func TestFinder_Find(t *testing.T) {
Primary: plugins.FoundPlugin{
JSONData: plugins.JSONData{
ID: "test-app",
Type: plugins.DataSource,
Type: plugins.TypeDataSource,
Name: "Parent",
Info: plugins.Info{
Author: plugins.InfoLink{
@@ -96,7 +96,7 @@ func TestFinder_Find(t *testing.T) {
{
JSONData: plugins.JSONData{
ID: "test-app",
Type: plugins.DataSource,
Type: plugins.TypeDataSource,
Name: "Child",
Info: plugins.Info{
Author: plugins.InfoLink{
@@ -126,7 +126,7 @@ func TestFinder_Find(t *testing.T) {
Primary: plugins.FoundPlugin{
JSONData: plugins.JSONData{
ID: "test-app",
Type: plugins.App,
Type: plugins.TypeApp,
Name: "Test App",
Info: plugins.Info{
Author: plugins.InfoLink{
@@ -185,7 +185,7 @@ func TestFinder_Find(t *testing.T) {
Primary: plugins.FoundPlugin{
JSONData: plugins.JSONData{
ID: "test-app",
Type: plugins.DataSource,
Type: plugins.TypeDataSource,
Name: "Parent",
Info: plugins.Info{
Author: plugins.InfoLink{
@@ -207,7 +207,7 @@ func TestFinder_Find(t *testing.T) {
{
JSONData: plugins.JSONData{
ID: "test-app",
Type: plugins.DataSource,
Type: plugins.TypeDataSource,
Name: "Child",
Info: plugins.Info{
Author: plugins.InfoLink{
@@ -231,7 +231,7 @@ func TestFinder_Find(t *testing.T) {
Primary: plugins.FoundPlugin{
JSONData: plugins.JSONData{
ID: "test-datasource",
Type: plugins.DataSource,
Type: plugins.TypeDataSource,
Name: "Test",
Info: plugins.Info{
Author: plugins.InfoLink{
@@ -244,7 +244,7 @@ func TestFinder_Find(t *testing.T) {
GrafanaVersion: "*",
Plugins: []plugins.Dependency{},
},
State: plugins.AlphaRelease,
State: plugins.ReleaseStateAlpha,
Backend: true,
},
FS: mustNewStaticFSForTests(t, filepath.Join(testData, "invalid-v1-signature/plugin")),
pkg/plugins/manager/loader/initializer/initializer_test.go
+6 -6
View File
@@ -16,7 +16,7 @@ func TestInitializer_Initialize(t *testing.T) {
p := &plugins.Plugin{
JSONData: plugins.JSONData{
ID: "test",
Type: plugins.DataSource,
Type: plugins.TypeDataSource,
Includes: []*plugins.Includes{
{
Name: "Example dashboard",
@@ -25,7 +25,7 @@ func TestInitializer_Initialize(t *testing.T) {
},
Backend: true,
},
Class: plugins.Core,
Class: plugins.ClassCore,
}
i := &Initializer{
@@ -47,13 +47,13 @@ func TestInitializer_Initialize(t *testing.T) {
p := &plugins.Plugin{
JSONData: plugins.JSONData{
ID: "test",
Type: plugins.Renderer,
Type: plugins.TypeRenderer,
Dependencies: plugins.Dependencies{
GrafanaVersion: ">=8.x",
},
Backend: true,
},
Class: plugins.External,
Class: plugins.ClassExternal,
}
i := &Initializer{
@@ -75,13 +75,13 @@ func TestInitializer_Initialize(t *testing.T) {
p := &plugins.Plugin{
JSONData: plugins.JSONData{
ID: "test",
Type: plugins.SecretsManager,
Type: plugins.TypeSecretsManager,
Dependencies: plugins.Dependencies{
GrafanaVersion: ">=8.x",
},
Backend: true,
},
Class: plugins.External,
Class: plugins.ClassExternal,
}
i := &Initializer{
pkg/plugins/manager/loader/loader_test.go
+104 -103
View File
@@ -24,6 +24,7 @@ import (
"github.com/grafana/grafana/pkg/plugins/manager/signature/statickey"
"github.com/grafana/grafana/pkg/plugins/manager/sources"
"github.com/grafana/grafana/pkg/plugins/pluginscdn"
"github.com/grafana/grafana/pkg/services/org"
"github.com/grafana/grafana/pkg/setting"
)
@@ -71,14 +72,14 @@ func TestLoader_Load(t *testing.T) {
}{
{
name: "Load a Core plugin",
class: plugins.Core,
class: plugins.ClassCore,
cfg: &config.Cfg{},
pluginPaths: []string{filepath.Join(corePluginDir, "app/plugins/datasource/cloudwatch")},
want: []*plugins.Plugin{
{
JSONData: plugins.JSONData{
ID: "cloudwatch",
Type: "datasource",
Type: plugins.TypeDataSource,
Name: "CloudWatch",
Info: plugins.Info{
Author: plugins.InfoLink{
@@ -114,21 +115,21 @@ func TestLoader_Load(t *testing.T) {
BaseURL: "public/app/plugins/datasource/cloudwatch",
FS: mustNewStaticFSForTests(t, filepath.Join(corePluginDir, "app/plugins/datasource/cloudwatch")),
Signature: plugins.SignatureInternal,
Class: plugins.Core,
Signature: plugins.SignatureStatusInternal,
Class: plugins.ClassCore,
},
},
},
{
name: "Load a Bundled plugin",
class: plugins.Bundled,
class: plugins.ClassBundled,
cfg: &config.Cfg{},
pluginPaths: []string{"../testdata/valid-v2-signature"},
want: []*plugins.Plugin{
{
JSONData: plugins.JSONData{
ID: "test-datasource",
Type: "datasource",
Type: plugins.TypeDataSource,
Name: "Test",
Info: plugins.Info{
Author: plugins.InfoLink{
@@ -154,14 +155,14 @@ func TestLoader_Load(t *testing.T) {
BaseURL: "public/plugins/test-datasource",
FS: mustNewStaticFSForTests(t, filepath.Join(parentDir, "testdata/valid-v2-signature/plugin/")),
Signature: "valid",
SignatureType: plugins.GrafanaSignature,
SignatureType: plugins.SignatureTypeGrafana,
SignatureOrg: "Grafana Labs",
Class: plugins.Bundled,
Class: plugins.ClassBundled,
},
},
}, {
name: "Load plugin with symbolic links",
class: plugins.External,
class: plugins.ClassExternal,
cfg: &config.Cfg{},
pluginPaths: []string{"../testdata/symbolic-plugin-dirs"},
want: []*plugins.Plugin{
@@ -203,41 +204,41 @@ func TestLoader_Load(t *testing.T) {
Name: "Nginx Connections",
Path: "dashboards/connections.json",
Type: "dashboard",
Role: "Viewer",
Role: org.RoleViewer,
Slug: "nginx-connections",
},
{
Name: "Nginx Memory",
Path: "dashboards/memory.json",
Type: "dashboard",
Role: "Viewer",
Role: org.RoleViewer,
Slug: "nginx-memory",
},
{
Name: "Nginx Panel",
Type: "panel",
Role: "Viewer",
Type: string(plugins.TypePanel),
Role: org.RoleViewer,
Slug: "nginx-panel"},
{
Name: "Nginx Datasource",
Type: "datasource",
Role: "Viewer",
Type: string(plugins.TypeDataSource),
Role: org.RoleViewer,
Slug: "nginx-datasource",
},
},
},
Class: plugins.External,
Class: plugins.ClassExternal,
Module: "plugins/test-app/module",
BaseURL: "public/plugins/test-app",
FS: mustNewStaticFSForTests(t, filepath.Join(parentDir, "testdata/includes-symlinks")),
Signature: "valid",
SignatureType: plugins.GrafanaSignature,
SignatureType: plugins.SignatureTypeGrafana,
SignatureOrg: "Grafana Labs",
},
},
}, {
name: "Load an unsigned plugin (development)",
class: plugins.External,
class: plugins.ClassExternal,
cfg: &config.Cfg{
DevMode: true,
},
@@ -246,7 +247,7 @@ func TestLoader_Load(t *testing.T) {
{
JSONData: plugins.JSONData{
ID: "test-datasource",
Type: "datasource",
Type: plugins.TypeDataSource,
Name: "Test",
Info: plugins.Info{
Author: plugins.InfoLink{
@@ -264,9 +265,9 @@ func TestLoader_Load(t *testing.T) {
Plugins: []plugins.Dependency{},
},
Backend: true,
State: plugins.AlphaRelease,
State: plugins.ReleaseStateAlpha,
},
Class: plugins.External,
Class: plugins.ClassExternal,
Module: "plugins/test-datasource/module",
BaseURL: "public/plugins/test-datasource",
FS: mustNewStaticFSForTests(t, filepath.Join(parentDir, "testdata/unsigned-datasource/plugin")),
@@ -275,7 +276,7 @@ func TestLoader_Load(t *testing.T) {
},
}, {
name: "Load an unsigned plugin (production)",
class: plugins.External,
class: plugins.ClassExternal,
cfg: &config.Cfg{},
pluginPaths: []string{"../testdata/unsigned-datasource"},
want: []*plugins.Plugin{},
@@ -288,7 +289,7 @@ func TestLoader_Load(t *testing.T) {
},
{
name: "Load an unsigned plugin using PluginsAllowUnsigned config (production)",
class: plugins.External,
class: plugins.ClassExternal,
cfg: &config.Cfg{
PluginsAllowUnsigned: []string{"test-datasource"},
},
@@ -297,7 +298,7 @@ func TestLoader_Load(t *testing.T) {
{
JSONData: plugins.JSONData{
ID: "test-datasource",
Type: "datasource",
Type: plugins.TypeDataSource,
Name: "Test",
Info: plugins.Info{
Author: plugins.InfoLink{
@@ -315,19 +316,19 @@ func TestLoader_Load(t *testing.T) {
Plugins: []plugins.Dependency{},
},
Backend: true,
State: plugins.AlphaRelease,
State: plugins.ReleaseStateAlpha,
},
Class: plugins.External,
Class: plugins.ClassExternal,
Module: "plugins/test-datasource/module",
BaseURL: "public/plugins/test-datasource",
FS: mustNewStaticFSForTests(t, filepath.Join(parentDir, "testdata/unsigned-datasource/plugin")),
Signature: plugins.SignatureUnsigned,
Signature: plugins.SignatureStatusUnsigned,
},
},
},
{
name: "Load a plugin with v1 manifest should return signatureInvalid",
class: plugins.External,
class: plugins.ClassExternal,
cfg: &config.Cfg{},
pluginPaths: []string{"../testdata/lacking-files"},
want: []*plugins.Plugin{},
@@ -340,7 +341,7 @@ func TestLoader_Load(t *testing.T) {
},
{
name: "Load a plugin with v1 manifest using PluginsAllowUnsigned config (production) should return signatureInvali",
class: plugins.External,
class: plugins.ClassExternal,
cfg: &config.Cfg{
PluginsAllowUnsigned: []string{"test-datasource"},
},
@@ -355,7 +356,7 @@ func TestLoader_Load(t *testing.T) {
},
{
name: "Load a plugin with manifest which has a file not found in plugin folder",
class: plugins.External,
class: plugins.ClassExternal,
cfg: &config.Cfg{
PluginsAllowUnsigned: []string{"test-datasource"},
},
@@ -370,7 +371,7 @@ func TestLoader_Load(t *testing.T) {
},
{
name: "Load a plugin with file which is missing from the manifest",
class: plugins.External,
class: plugins.ClassExternal,
cfg: &config.Cfg{
PluginsAllowUnsigned: []string{"test-datasource"},
},
@@ -385,7 +386,7 @@ func TestLoader_Load(t *testing.T) {
},
{
name: "Load an app with includes",
class: plugins.External,
class: plugins.ClassExternal,
cfg: &config.Cfg{
PluginsAllowUnsigned: []string{"test-app"},
},
@@ -393,7 +394,7 @@ func TestLoader_Load(t *testing.T) {
want: []*plugins.Plugin{
{JSONData: plugins.JSONData{
ID: "test-app",
Type: "app",
Type: plugins.TypeApp,
Name: "Test App",
Info: plugins.Info{
Author: plugins.InfoLink{
@@ -418,15 +419,15 @@ func TestLoader_Load(t *testing.T) {
Plugins: []plugins.Dependency{},
},
Includes: []*plugins.Includes{
{Name: "Nginx Memory", Path: "dashboards/memory.json", Type: "dashboard", Role: "Viewer", Slug: "nginx-memory"},
{Name: "Root Page (react)", Type: "page", Role: "Viewer", Path: "/a/my-simple-app", DefaultNav: true, AddToNav: true, Slug: "root-page-react"},
{Name: "Nginx Memory", Path: "dashboards/memory.json", Type: "dashboard", Role: org.RoleViewer, Slug: "nginx-memory"},
{Name: "Root Page (react)", Type: "page", Role: org.RoleViewer, Path: "/a/my-simple-app", DefaultNav: true, AddToNav: true, Slug: "root-page-react"},
},
Backend: false,
},
DefaultNavURL: "/plugins/test-app/page/root-page-react",
FS: mustNewStaticFSForTests(t, filepath.Join(parentDir, "testdata/test-app-with-includes")),
Class: plugins.External,
Signature: plugins.SignatureUnsigned,
Class: plugins.ClassExternal,
Signature: plugins.SignatureStatusUnsigned,
Module: "plugins/test-app/module",
BaseURL: "public/plugins/test-app",
},
@@ -480,7 +481,7 @@ func TestLoader_Load_CustomSource(t *testing.T) {
expected := []*plugins.Plugin{{
JSONData: plugins.JSONData{
ID: "grafana-worldmap-panel",
Type: "panel",
Type: plugins.TypePanel,
Name: "Worldmap Panel",
Info: plugins.Info{
Version: "0.3.3",
@@ -514,8 +515,8 @@ func TestLoader_Load_CustomSource(t *testing.T) {
},
},
FS: mustNewStaticFSForTests(t, filepath.Join(parentDir, "testdata/cdn/plugin")),
Class: plugins.Bundled,
Signature: plugins.SignatureValid,
Class: plugins.ClassBundled,
Signature: plugins.SignatureStatusValid,
BaseURL: "plugin-cdn/grafana-worldmap-panel/0.3.3/public/plugins/grafana-worldmap-panel",
Module: "plugin-cdn/grafana-worldmap-panel/0.3.3/public/plugins/grafana-worldmap-panel/module",
}}
@@ -523,14 +524,14 @@ func TestLoader_Load_CustomSource(t *testing.T) {
l := newLoader(cfg)
got, err := l.Load(context.Background(), &fakes.FakePluginSource{
PluginClassFunc: func(ctx context.Context) plugins.Class {
return plugins.Bundled
return plugins.ClassBundled
},
PluginURIsFunc: func(ctx context.Context) []string {
return pluginPaths
},
DefaultSignatureFunc: func(ctx context.Context) (plugins.Signature, bool) {
return plugins.Signature{
Status: plugins.SignatureValid,
Status: plugins.SignatureStatusValid,
}, true
},
})
@@ -627,7 +628,7 @@ func TestLoader_Load_MultiplePlugins(t *testing.T) {
{
JSONData: plugins.JSONData{
ID: "test-datasource",
Type: "datasource",
Type: plugins.TypeDataSource,
Name: "Test",
Info: plugins.Info{
Author: plugins.InfoLink{
@@ -647,14 +648,14 @@ func TestLoader_Load_MultiplePlugins(t *testing.T) {
},
Backend: true,
Executable: "test",
State: plugins.AlphaRelease,
State: plugins.ReleaseStateAlpha,
},
Class: plugins.External,
Class: plugins.ClassExternal,
Module: "plugins/test-datasource/module",
BaseURL: "public/plugins/test-datasource",
FS: mustNewStaticFSForTests(t, filepath.Join(parentDir, "testdata/valid-v2-pvt-signature/plugin")),
Signature: "valid",
SignatureType: plugins.PrivateSignature,
SignatureType: plugins.SignatureTypePrivate,
SignatureOrg: "Will Browne",
},
},
@@ -685,7 +686,7 @@ func TestLoader_Load_MultiplePlugins(t *testing.T) {
got, err := l.Load(context.Background(), &fakes.FakePluginSource{
PluginClassFunc: func(ctx context.Context) plugins.Class {
return plugins.External
return plugins.ClassExternal
},
PluginURIsFunc: func(ctx context.Context) []string {
return tt.pluginPaths
@@ -733,7 +734,7 @@ func TestLoader_Load_RBACReady(t *testing.T) {
{
JSONData: plugins.JSONData{
ID: "test-app",
Type: "app",
Type: plugins.TypeApp,
Name: "Test App",
Info: plugins.Info{
Author: plugins.InfoLink{
@@ -772,9 +773,9 @@ func TestLoader_Load_RBACReady(t *testing.T) {
Backend: false,
},
FS: mustNewStaticFSForTests(t, pluginDir),
Class: plugins.External,
Signature: plugins.SignatureValid,
SignatureType: plugins.PrivateSignature,
Class: plugins.ClassExternal,
Signature: plugins.SignatureStatusValid,
SignatureType: plugins.SignatureTypePrivate,
SignatureOrg: "gabrielmabille",
Module: "plugins/test-app/module",
BaseURL: "public/plugins/test-app",
@@ -800,7 +801,7 @@ func TestLoader_Load_RBACReady(t *testing.T) {
got, err := l.Load(context.Background(), &fakes.FakePluginSource{
PluginClassFunc: func(ctx context.Context) plugins.Class {
return plugins.External
return plugins.ClassExternal
},
PluginURIsFunc: func(ctx context.Context) []string {
return tt.pluginPaths
@@ -842,7 +843,7 @@ func TestLoader_Load_Signature_RootURL(t *testing.T) {
{
JSONData: plugins.JSONData{
ID: "test-datasource",
Type: "datasource",
Type: plugins.TypeDataSource,
Name: "Test",
Info: plugins.Info{
Author: plugins.InfoLink{Name: "Will Browne", URL: "https://willbrowne.com"},
@@ -853,15 +854,15 @@ func TestLoader_Load_Signature_RootURL(t *testing.T) {
},
Version: "1.0.0",
},
State: plugins.AlphaRelease,
State: plugins.ReleaseStateAlpha,
Dependencies: plugins.Dependencies{GrafanaVersion: "*", Plugins: []plugins.Dependency{}},
Backend: true,
Executable: "test",
},
FS: mustNewStaticFSForTests(t, filepath.Join(parentDir, "/testdata/valid-v2-pvt-signature-root-url-uri/plugin")),
Class: plugins.External,
Signature: plugins.SignatureValid,
SignatureType: plugins.PrivateSignature,
Class: plugins.ClassExternal,
Signature: plugins.SignatureStatusValid,
SignatureType: plugins.SignatureTypePrivate,
SignatureOrg: "Will Browne",
Module: "plugins/test-datasource/module",
BaseURL: "public/plugins/test-datasource",
@@ -878,7 +879,7 @@ func TestLoader_Load_Signature_RootURL(t *testing.T) {
})
got, err := l.Load(context.Background(), &fakes.FakePluginSource{
PluginClassFunc: func(ctx context.Context) plugins.Class {
return plugins.External
return plugins.ClassExternal
},
PluginURIsFunc: func(ctx context.Context) []string {
return paths
@@ -904,7 +905,7 @@ func TestLoader_Load_DuplicatePlugins(t *testing.T) {
{
JSONData: plugins.JSONData{
ID: "test-app",
Type: "app",
Type: plugins.TypeApp,
Name: "Test App",
Info: plugins.Info{
Author: plugins.InfoLink{
@@ -935,17 +936,17 @@ func TestLoader_Load_DuplicatePlugins(t *testing.T) {
},
},
Includes: []*plugins.Includes{
{Name: "Nginx Connections", Path: "dashboards/connections.json", Type: "dashboard", Role: "Viewer", Slug: "nginx-connections"},
{Name: "Nginx Memory", Path: "dashboards/memory.json", Type: "dashboard", Role: "Viewer", Slug: "nginx-memory"},
{Name: "Nginx Panel", Type: "panel", Role: "Viewer", Slug: "nginx-panel"},
{Name: "Nginx Datasource", Type: "datasource", Role: "Viewer", Slug: "nginx-datasource"},
{Name: "Nginx Connections", Path: "dashboards/connections.json", Type: "dashboard", Role: org.RoleViewer, Slug: "nginx-connections"},
{Name: "Nginx Memory", Path: "dashboards/memory.json", Type: "dashboard", Role: org.RoleViewer, Slug: "nginx-memory"},
{Name: "Nginx Panel", Type: "panel", Role: org.RoleViewer, Slug: "nginx-panel"},
{Name: "Nginx Datasource", Type: "datasource", Role: org.RoleViewer, Slug: "nginx-datasource"},
},
Backend: false,
},
FS: mustNewStaticFSForTests(t, pluginDir),
Class: plugins.External,
Signature: plugins.SignatureValid,
SignatureType: plugins.GrafanaSignature,
Class: plugins.ClassExternal,
Signature: plugins.SignatureStatusValid,
SignatureType: plugins.SignatureTypeGrafana,
SignatureOrg: "Grafana Labs",
Module: "plugins/test-app/module",
BaseURL: "public/plugins/test-app",
@@ -962,7 +963,7 @@ func TestLoader_Load_DuplicatePlugins(t *testing.T) {
})
got, err := l.Load(context.Background(), &fakes.FakePluginSource{
PluginClassFunc: func(ctx context.Context) plugins.Class {
return plugins.External
return plugins.ClassExternal
},
PluginURIsFunc: func(ctx context.Context) []string {
return []string{pluginDir, pluginDir}
@@ -994,7 +995,7 @@ func TestLoader_Load_SkipUninitializedPlugins(t *testing.T) {
{
JSONData: plugins.JSONData{
ID: "test-app",
Type: "app",
Type: plugins.TypeApp,
Name: "Test App",
Info: plugins.Info{
Author: plugins.InfoLink{
@@ -1025,17 +1026,17 @@ func TestLoader_Load_SkipUninitializedPlugins(t *testing.T) {
},
},
Includes: []*plugins.Includes{
{Name: "Nginx Connections", Path: "dashboards/connections.json", Type: "dashboard", Role: "Viewer", Slug: "nginx-connections"},
{Name: "Nginx Memory", Path: "dashboards/memory.json", Type: "dashboard", Role: "Viewer", Slug: "nginx-memory"},
{Name: "Nginx Panel", Type: "panel", Role: "Viewer", Slug: "nginx-panel"},
{Name: "Nginx Datasource", Type: "datasource", Role: "Viewer", Slug: "nginx-datasource"},
{Name: "Nginx Connections", Path: "dashboards/connections.json", Type: "dashboard", Role: org.RoleViewer, Slug: "nginx-connections"},
{Name: "Nginx Memory", Path: "dashboards/memory.json", Type: "dashboard", Role: org.RoleViewer, Slug: "nginx-memory"},
{Name: "Nginx Panel", Type: "panel", Role: org.RoleViewer, Slug: "nginx-panel"},
{Name: "Nginx Datasource", Type: "datasource", Role: org.RoleViewer, Slug: "nginx-datasource"},
},
Backend: false,
},
FS: mustNewStaticFSForTests(t, pluginDir1),
Class: plugins.External,
Signature: plugins.SignatureValid,
SignatureType: plugins.GrafanaSignature,
Class: plugins.ClassExternal,
Signature: plugins.SignatureStatusValid,
SignatureType: plugins.SignatureTypeGrafana,
SignatureOrg: "Grafana Labs",
Module: "plugins/test-app/module",
BaseURL: "public/plugins/test-app",
@@ -1061,7 +1062,7 @@ func TestLoader_Load_SkipUninitializedPlugins(t *testing.T) {
})
got, err := l.Load(context.Background(), &fakes.FakePluginSource{
PluginClassFunc: func(ctx context.Context) plugins.Class {
return plugins.External
return plugins.ClassExternal
},
PluginURIsFunc: func(ctx context.Context) []string {
return []string{pluginDir1, pluginDir2}
@@ -1080,7 +1081,7 @@ func TestLoader_Load_SkipUninitializedPlugins(t *testing.T) {
func TestLoader_Load_Angular(t *testing.T) {
fakePluginSource := &fakes.FakePluginSource{
PluginClassFunc: func(ctx context.Context) plugins.Class {
return plugins.External
return plugins.ClassExternal
},
PluginURIsFunc: func(ctx context.Context) []string {
return []string{"../testdata/valid-v2-signature"}
@@ -1138,7 +1139,7 @@ func TestLoader_Load_NestedPlugins(t *testing.T) {
parent := &plugins.Plugin{
JSONData: plugins.JSONData{
ID: "test-datasource",
Type: "datasource",
Type: plugins.TypeDataSource,
Name: "Parent",
Info: plugins.Info{
Author: plugins.InfoLink{
@@ -1162,16 +1163,16 @@ func TestLoader_Load_NestedPlugins(t *testing.T) {
Module: "plugins/test-datasource/module",
BaseURL: "public/plugins/test-datasource",
FS: mustNewStaticFSForTests(t, filepath.Join(rootDir, "testdata/nested-plugins/parent")),
Signature: plugins.SignatureValid,
SignatureType: plugins.GrafanaSignature,
Signature: plugins.SignatureStatusValid,
SignatureType: plugins.SignatureTypeGrafana,
SignatureOrg: "Grafana Labs",
Class: plugins.External,
Class: plugins.ClassExternal,
}
child := &plugins.Plugin{
JSONData: plugins.JSONData{
ID: "test-panel",
Type: "panel",
Type: plugins.TypePanel,
Name: "Child",
Info: plugins.Info{
Author: plugins.InfoLink{
@@ -1194,10 +1195,10 @@ func TestLoader_Load_NestedPlugins(t *testing.T) {
Module: "plugins/test-panel/module",
BaseURL: "public/plugins/test-panel",
FS: mustNewStaticFSForTests(t, filepath.Join(rootDir, "testdata/nested-plugins/parent/nested")),
Signature: plugins.SignatureValid,
SignatureType: plugins.GrafanaSignature,
Signature: plugins.SignatureStatusValid,
SignatureType: plugins.SignatureTypeGrafana,
SignatureOrg: "Grafana Labs",
Class: plugins.External,
Class: plugins.ClassExternal,
}
parent.Children = []*plugins.Plugin{child}
@@ -1215,7 +1216,7 @@ func TestLoader_Load_NestedPlugins(t *testing.T) {
got, err := l.Load(context.Background(), &fakes.FakePluginSource{
PluginClassFunc: func(ctx context.Context) plugins.Class {
return plugins.External
return plugins.ClassExternal
},
PluginURIsFunc: func(ctx context.Context) []string {
return []string{"../testdata/nested-plugins"}
@@ -1238,7 +1239,7 @@ func TestLoader_Load_NestedPlugins(t *testing.T) {
t.Run("Load will exclude plugins that already exist", func(t *testing.T) {
got, err := l.Load(context.Background(), &fakes.FakePluginSource{
PluginClassFunc: func(ctx context.Context) plugins.Class {
return plugins.External
return plugins.ClassExternal
},
PluginURIsFunc: func(ctx context.Context) []string {
return []string{"../testdata/nested-plugins"}
@@ -1263,7 +1264,7 @@ func TestLoader_Load_NestedPlugins(t *testing.T) {
parent := &plugins.Plugin{
JSONData: plugins.JSONData{
ID: "myorgid-simple-app",
Type: "app",
Type: plugins.TypeApp,
Name: "Simple App",
Info: plugins.Info{
Author: plugins.InfoLink{
@@ -1292,7 +1293,7 @@ func TestLoader_Load_NestedPlugins(t *testing.T) {
Name: "Root Page (react)",
Path: "/a/myorgid-simple-app",
Type: "page",
Role: "Viewer",
Role: org.RoleViewer,
AddToNav: true,
DefaultNav: true,
Slug: "root-page-react",
@@ -1301,7 +1302,7 @@ func TestLoader_Load_NestedPlugins(t *testing.T) {
Name: "Root Page (Tab B)",
Path: "/a/myorgid-simple-app/?tab=b",
Type: "page",
Role: "Viewer",
Role: org.RoleViewer,
AddToNav: true,
Slug: "root-page-tab-b",
},
@@ -1309,7 +1310,7 @@ func TestLoader_Load_NestedPlugins(t *testing.T) {
Name: "React Config",
Path: "/plugins/myorgid-simple-app/?page=page2",
Type: "page",
Role: "Admin",
Role: org.RoleAdmin,
AddToNav: true,
Slug: "react-config",
},
@@ -1317,14 +1318,14 @@ func TestLoader_Load_NestedPlugins(t *testing.T) {
Name: "Streaming Example",
Path: "dashboards/streaming.json",
Type: "dashboard",
Role: "Viewer",
Role: org.RoleViewer,
Slug: "streaming-example",
},
{
Name: "Lots of Stats",
Path: "dashboards/stats.json",
Type: "dashboard",
Role: "Viewer",
Role: org.RoleViewer,
Slug: "lots-of-stats",
},
},
@@ -1334,16 +1335,16 @@ func TestLoader_Load_NestedPlugins(t *testing.T) {
BaseURL: "public/plugins/myorgid-simple-app",
FS: mustNewStaticFSForTests(t, filepath.Join(rootDir, "testdata/app-with-child/dist")),
DefaultNavURL: "/plugins/myorgid-simple-app/page/root-page-react",
Signature: plugins.SignatureValid,
SignatureType: plugins.GrafanaSignature,
Signature: plugins.SignatureStatusValid,
SignatureType: plugins.SignatureTypeGrafana,
SignatureOrg: "Grafana Labs",
Class: plugins.External,
Class: plugins.ClassExternal,
}
child := &plugins.Plugin{
JSONData: plugins.JSONData{
ID: "myorgid-simple-panel",
Type: "panel",
Type: plugins.TypePanel,
Name: "Grafana Panel Plugin Template",
Info: plugins.Info{
Author: plugins.InfoLink{
@@ -1372,10 +1373,10 @@ func TestLoader_Load_NestedPlugins(t *testing.T) {
BaseURL: "public/plugins/myorgid-simple-app",
FS: mustNewStaticFSForTests(t, filepath.Join(rootDir, "testdata/app-with-child/dist/child")),
IncludedInAppID: parent.ID,
Signature: plugins.SignatureValid,
SignatureType: plugins.GrafanaSignature,
Signature: plugins.SignatureStatusValid,
SignatureType: plugins.SignatureTypeGrafana,
SignatureOrg: "Grafana Labs",
Class: plugins.External,
Class: plugins.ClassExternal,
}
parent.Children = []*plugins.Plugin{child}
@@ -1392,7 +1393,7 @@ func TestLoader_Load_NestedPlugins(t *testing.T) {
})
got, err := l.Load(context.Background(), &fakes.FakePluginSource{
PluginClassFunc: func(ctx context.Context) plugins.Class {
return plugins.External
return plugins.ClassExternal
},
PluginURIsFunc: func(ctx context.Context) []string {
return []string{"../testdata/app-with-child"}
@@ -1420,10 +1421,10 @@ func Test_setPathsBasedOnApp(t *testing.T) {
}
parent := &plugins.Plugin{
JSONData: plugins.JSONData{
Type: plugins.App,
Type: plugins.TypeApp,
ID: "testdata-app",
},
Class: plugins.Core,
Class: plugins.ClassCore,
FS: fakes.NewFakePluginFiles("c:\\grafana\\public\\app\\plugins\\app\\testdata-app"),
BaseURL: "public/app/plugins/app/testdata-app",
}
pkg/plugins/manager/manager_integration_test.go
+4 -4
View File
@@ -228,7 +228,7 @@ func verifyCorePluginCatalogue(t *testing.T, ctx context.Context, ps *store.Serv
"test-app": {},
}
panels := ps.Plugins(ctx, plugins.Panel)
panels := ps.Plugins(ctx, plugins.TypePanel)
require.Equal(t, len(expPanels), len(panels))
for _, p := range panels {
p, exists := ps.Plugin(ctx, p.ID)
@@ -237,7 +237,7 @@ func verifyCorePluginCatalogue(t *testing.T, ctx context.Context, ps *store.Serv
require.Contains(t, expPanels, p.ID)
}
dataSources := ps.Plugins(ctx, plugins.DataSource)
dataSources := ps.Plugins(ctx, plugins.TypeDataSource)
require.Equal(t, len(expDataSources), len(dataSources))
for _, ds := range dataSources {
p, exists := ps.Plugin(ctx, ds.ID)
@@ -246,7 +246,7 @@ func verifyCorePluginCatalogue(t *testing.T, ctx context.Context, ps *store.Serv
require.Contains(t, expDataSources, ds.ID)
}
apps := ps.Plugins(ctx, plugins.App)
apps := ps.Plugins(ctx, plugins.TypeApp)
require.Equal(t, len(expApps), len(apps))
for _, app := range apps {
p, exists := ps.Plugin(ctx, app.ID)
@@ -262,7 +262,7 @@ func verifyBundledPlugins(t *testing.T, ctx context.Context, ps *store.Service)
t.Helper()
dsPlugins := make(map[string]struct{})
for _, p := range ps.Plugins(ctx, plugins.DataSource) {
for _, p := range ps.Plugins(ctx, plugins.TypeDataSource) {
dsPlugins[p.ID] = struct{}{}
}
pkg/plugins/manager/process/process_test.go
+2 -2
View File
@@ -44,7 +44,7 @@ func TestProcessManager_Start(t *testing.T) {
managed: true,
backend: true,
signatureError: &plugins.SignatureError{
SignatureStatus: plugins.SignatureUnsigned,
SignatureStatus: plugins.SignatureStatusUnsigned,
},
expectedStartCount: 0,
},
@@ -265,7 +265,7 @@ func createPlugin(t *testing.T, bp backendplugin.Plugin, cbs ...func(p *plugins.
t.Helper()
p := &plugins.Plugin{
Class: plugins.External,
Class: plugins.ClassExternal,
JSONData: plugins.JSONData{
ID: "test-datasource",
},
pkg/plugins/manager/signature/authorizer.go
+1 -1
View File
@@ -20,7 +20,7 @@ type UnsignedPluginAuthorizer struct {
}
func (u *UnsignedPluginAuthorizer) CanLoadPlugin(p *plugins.Plugin) bool {
if p.Signature != plugins.SignatureUnsigned {
if p.Signature != plugins.SignatureStatusUnsigned {
return true
}
pkg/plugins/manager/signature/manifest.go
+13 -13
View File
@@ -104,7 +104,7 @@ func (s *Signature) Calculate(ctx context.Context, src plugins.PluginSource, plu
if len(fsFiles) == 0 {
s.log.Warn("No plugin file information in directory", "pluginID", plugin.JSONData.ID)
return plugins.Signature{
Status: plugins.SignatureInvalid,
Status: plugins.SignatureStatusInvalid,
}, nil
}
@@ -113,13 +113,13 @@ func (s *Signature) Calculate(ctx context.Context, src plugins.PluginSource, plu
if errors.Is(err, plugins.ErrFileNotExist) {
s.log.Debug("Could not find a MANIFEST.txt", "id", plugin.JSONData.ID, "err", err)
return plugins.Signature{
Status: plugins.SignatureUnsigned,
Status: plugins.SignatureStatusUnsigned,
}, nil
}
s.log.Debug("Could not open MANIFEST.txt", "id", plugin.JSONData.ID, "err", err)
return plugins.Signature{
Status: plugins.SignatureInvalid,
Status: plugins.SignatureStatusInvalid,
}, nil
}
defer func() {
@@ -135,7 +135,7 @@ func (s *Signature) Calculate(ctx context.Context, src plugins.PluginSource, plu
if err != nil || len(byteValue) < 10 {
s.log.Debug("MANIFEST.TXT is invalid", "id", plugin.JSONData.ID)
return plugins.Signature{
Status: plugins.SignatureUnsigned,
Status: plugins.SignatureStatusUnsigned,
}, nil
}
@@ -143,20 +143,20 @@ func (s *Signature) Calculate(ctx context.Context, src plugins.PluginSource, plu
if err != nil {
s.log.Warn("Plugin signature invalid", "id", plugin.JSONData.ID, "err", err)
return plugins.Signature{
Status: plugins.SignatureInvalid,
Status: plugins.SignatureStatusInvalid,
}, nil
}
if !manifest.isV2() {
return plugins.Signature{
Status: plugins.SignatureInvalid,
Status: plugins.SignatureStatusInvalid,
}, nil
}
// Make sure the versions all match
if manifest.Plugin != plugin.JSONData.ID || manifest.Version != plugin.JSONData.Info.Version {
return plugins.Signature{
Status: plugins.SignatureModified,
Status: plugins.SignatureStatusModified,
}, nil
}
@@ -169,7 +169,7 @@ func (s *Signature) Calculate(ctx context.Context, src plugins.PluginSource, plu
s.log.Warn("Could not find root URL that matches running application URL", "plugin", plugin.JSONData.ID,
"appUrl", setting.AppUrl, "rootUrls", manifest.RootURLs)
return plugins.Signature{
Status: plugins.SignatureInvalid,
Status: plugins.SignatureStatusInvalid,
}, nil
}
}
@@ -181,7 +181,7 @@ func (s *Signature) Calculate(ctx context.Context, src plugins.PluginSource, plu
err = verifyHash(s.log, plugin, p, hash)
if err != nil {
return plugins.Signature{
Status: plugins.SignatureModified,
Status: plugins.SignatureStatusModified,
}, nil
}
@@ -195,7 +195,7 @@ func (s *Signature) Calculate(ctx context.Context, src plugins.PluginSource, plu
f = toSlash(f)
// Ignoring unsigned Chromium debug.log so it doesn't invalidate the signature for Renderer plugin running on Windows
if runningWindows && plugin.JSONData.Type == plugins.Renderer && f == "chrome-win/debug.log" {
if runningWindows && plugin.JSONData.Type == plugins.TypeRenderer && f == "chrome-win/debug.log" {
continue
}
@@ -210,13 +210,13 @@ func (s *Signature) Calculate(ctx context.Context, src plugins.PluginSource, plu
if len(unsignedFiles) > 0 {
s.log.Warn("The following files were not included in the signature", "plugin", plugin.JSONData.ID, "files", unsignedFiles)
return plugins.Signature{
Status: plugins.SignatureModified,
Status: plugins.SignatureStatusModified,
}, nil
}
s.log.Debug("Plugin signature valid", "id", plugin.JSONData.ID)
return plugins.Signature{
Status: plugins.SignatureValid,
Status: plugins.SignatureStatusValid,
Type: manifest.SignatureType,
SigningOrg: manifest.SignedByOrgName,
}, nil
@@ -273,7 +273,7 @@ func urlMatch(specs []string, target string, signatureType plugins.SignatureType
return true, nil
}
if signatureType != plugins.PrivateGlobSignature {
if signatureType != plugins.SignatureTypePrivateGlob {
continue
}
pkg/plugins/manager/signature/manifest_test.go
+16 -16
View File
@@ -118,7 +118,7 @@ khdr/tZ1PDgRxMqB/u+Vtbpl0xSxgblnrDOYMSI=
assert.Equal(t, int64(1605807018050), manifest.Time)
assert.Equal(t, "7e4d0c6a708866e7", manifest.KeyID)
assert.Equal(t, "2.0.0", manifest.ManifestVersion)
assert.Equal(t, plugins.PrivateSignature, manifest.SignatureType)
assert.Equal(t, plugins.SignatureTypePrivate, manifest.SignatureType)
assert.Equal(t, "willbrowne", manifest.SignedByOrg)
assert.Equal(t, "Will Browne", manifest.SignedByOrgName)
assert.Equal(t, []string{"http://localhost:3000/"}, manifest.RootURLs)
@@ -135,15 +135,15 @@ func TestCalculate(t *testing.T) {
{
appURL: "https://dev.grafana.com",
expectedSignature: plugins.Signature{
Status: plugins.SignatureValid,
Type: plugins.GrafanaSignature,
Status: plugins.SignatureStatusValid,
Type: plugins.SignatureTypeGrafana,
SigningOrg: "Grafana Labs",
},
},
{
appURL: "https://non.matching.url.com",
expectedSignature: plugins.Signature{
Status: plugins.SignatureInvalid,
Status: plugins.SignatureStatusInvalid,
},
},
}
@@ -165,7 +165,7 @@ func TestCalculate(t *testing.T) {
s := ProvideService(&config.Cfg{}, statickey.New())
sig, err := s.Calculate(context.Background(), &fakes.FakePluginSource{
PluginClassFunc: func(ctx context.Context) plugins.Class {
return plugins.External
return plugins.ClassExternal
},
}, plugins.FoundPlugin{
JSONData: plugins.JSONData{
@@ -193,12 +193,12 @@ func TestCalculate(t *testing.T) {
s := ProvideService(&config.Cfg{}, statickey.New())
sig, err := s.Calculate(context.Background(), &fakes.FakePluginSource{
PluginClassFunc: func(ctx context.Context) plugins.Class {
return plugins.External
return plugins.ClassExternal
},
}, plugins.FoundPlugin{
JSONData: plugins.JSONData{
ID: "test-renderer",
Type: plugins.Renderer,
Type: plugins.TypeRenderer,
Info: plugins.Info{
Version: "1.0.0",
},
@@ -207,8 +207,8 @@ func TestCalculate(t *testing.T) {
})
require.NoError(t, err)
require.Equal(t, plugins.Signature{
Status: plugins.SignatureValid,
Type: plugins.GrafanaSignature,
Status: plugins.SignatureStatusValid,
Type: plugins.SignatureTypeGrafana,
SigningOrg: "Grafana Labs",
}, sig)
})
@@ -261,12 +261,12 @@ func TestCalculate(t *testing.T) {
require.NoError(t, err)
sig, err := s.Calculate(context.Background(), &fakes.FakePluginSource{
PluginClassFunc: func(ctx context.Context) plugins.Class {
return plugins.External
return plugins.ClassExternal
},
}, plugins.FoundPlugin{
JSONData: plugins.JSONData{
ID: "myorgid-simple-app",
Type: plugins.App,
Type: plugins.TypeApp,
Info: plugins.Info{
Version: "%VERSION%",
},
@@ -275,8 +275,8 @@ func TestCalculate(t *testing.T) {
})
require.NoError(t, err)
require.Equal(t, plugins.Signature{
Status: plugins.SignatureValid,
Type: plugins.GrafanaSignature,
Status: plugins.SignatureStatusValid,
Type: plugins.SignatureTypeGrafana,
SigningOrg: "Grafana Labs",
}, sig)
})
@@ -545,7 +545,7 @@ func Test_urlMatch_privateGlob(t *testing.T) {
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got, err := urlMatch(tt.args.specs, tt.args.target, plugins.PrivateGlobSignature)
got, err := urlMatch(tt.args.specs, tt.args.target, plugins.SignatureTypePrivateGlob)
require.NoError(t, err)
require.Equal(t, tt.shouldMatch, got)
})
@@ -661,7 +661,7 @@ func Test_urlMatch_private(t *testing.T) {
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got, err := urlMatch(tt.args.specs, tt.args.target, plugins.PrivateSignature)
got, err := urlMatch(tt.args.specs, tt.args.target, plugins.SignatureTypePrivate)
require.NoError(t, err)
require.Equal(t, tt.shouldMatch, got)
})
@@ -741,7 +741,7 @@ func createV2Manifest(t *testing.T, cbs ...func(*PluginManifest)) *PluginManifes
"plugin.json": "55556b845e91935cc48fae3aa67baf0f22694c3f",
},
ManifestVersion: "2.0.0",
SignatureType: plugins.GrafanaSignature,
SignatureType: plugins.SignatureTypeGrafana,
SignedByOrg: "grafana",
SignedByOrgName: "grafana",
}
pkg/plugins/manager/signature/signature.go
+6 -6
View File
@@ -46,27 +46,27 @@ func (s *Validator) Validate(plugin *plugins.Plugin) *plugins.SignatureError {
}
switch plugin.Signature {
case plugins.SignatureUnsigned:
case plugins.SignatureStatusUnsigned:
if authorized := s.authorizer.CanLoadPlugin(plugin); !authorized {
s.log.Debug("Plugin is unsigned", "pluginID", plugin.ID)
return &plugins.SignatureError{
PluginID: plugin.ID,
SignatureStatus: plugins.SignatureUnsigned,
SignatureStatus: plugins.SignatureStatusUnsigned,
}
}
s.log.Warn("Permitting unsigned plugin. This is not recommended", "pluginID", plugin.ID)
return nil
case plugins.SignatureInvalid:
case plugins.SignatureStatusInvalid:
s.log.Debug("Plugin has an invalid signature", "pluginID", plugin.ID)
return &plugins.SignatureError{
PluginID: plugin.ID,
SignatureStatus: plugins.SignatureInvalid,
SignatureStatus: plugins.SignatureStatusInvalid,
}
case plugins.SignatureModified:
case plugins.SignatureStatusModified:
s.log.Debug("Plugin has a modified signature", "pluginID", plugin.ID)
return &plugins.SignatureError{
PluginID: plugin.ID,
SignatureStatus: plugins.SignatureModified,
SignatureStatus: plugins.SignatureStatusModified,
}
default:
s.log.Debug("Plugin has an unrecognized plugin signature state", "pluginID", plugin.ID, "signature",
pkg/plugins/manager/sources/source_local_disk.go
+2 -2
View File
@@ -28,9 +28,9 @@ func (s *LocalSource) PluginURIs(_ context.Context) []string {
func (s *LocalSource) DefaultSignature(_ context.Context) (plugins.Signature, bool) {
switch s.class {
case plugins.Core:
case plugins.ClassCore:
return plugins.Signature{
Status: plugins.SignatureInternal,
Status: plugins.SignatureStatusInternal,
}, true
default:
return plugins.Signature{}, false
pkg/plugins/manager/sources/sources.go
+3 -3
View File
@@ -26,9 +26,9 @@ func ProvideService(gCfg *setting.Cfg, cfg *config.Cfg) *Service {
func (s *Service) List(_ context.Context) []plugins.PluginSource {
return []plugins.PluginSource{
NewLocalSource(plugins.Core, corePluginPaths(s.gCfg.StaticRootPath)),
NewLocalSource(plugins.Bundled, []string{s.gCfg.BundledPluginsPath}),
NewLocalSource(plugins.External, append([]string{s.cfg.PluginsPath}, pluginFSPaths(s.cfg.PluginSettings)...)),
NewLocalSource(plugins.ClassCore, corePluginPaths(s.gCfg.StaticRootPath)),
NewLocalSource(plugins.ClassBundled, []string{s.gCfg.BundledPluginsPath}),
NewLocalSource(plugins.ClassExternal, append([]string{s.cfg.PluginsPath}, pluginFSPaths(s.cfg.PluginSettings)...)),
}
}
pkg/plugins/manager/sources/sources_test.go
+4 -4
View File
@@ -35,21 +35,21 @@ func TestSources_List(t *testing.T) {
require.Len(t, srcs, 3)
require.Equal(t, srcs[0].PluginClass(ctx), plugins.Core)
require.Equal(t, srcs[0].PluginClass(ctx), plugins.ClassCore)
require.Equal(t, srcs[0].PluginURIs(ctx), []string{"app/plugins/datasource", "app/plugins/panel"})
sig, exists := srcs[0].DefaultSignature(ctx)
require.True(t, exists)
require.Equal(t, plugins.SignatureInternal, sig.Status)
require.Equal(t, plugins.SignatureStatusInternal, sig.Status)
require.Equal(t, plugins.SignatureType(""), sig.Type)
require.Equal(t, "", sig.SigningOrg)
require.Equal(t, srcs[1].PluginClass(ctx), plugins.Bundled)
require.Equal(t, srcs[1].PluginClass(ctx), plugins.ClassBundled)
require.Equal(t, srcs[1].PluginURIs(ctx), []string{"path1"})
sig, exists = srcs[1].DefaultSignature(ctx)
require.False(t, exists)
require.Equal(t, plugins.Signature{}, sig)
require.Equal(t, srcs[2].PluginClass(ctx), plugins.External)
require.Equal(t, srcs[2].PluginClass(ctx), plugins.ClassExternal)
require.Equal(t, srcs[2].PluginURIs(ctx), []string{"path2", "path3"})
sig, exists = srcs[2].DefaultSignature(ctx)
require.False(t, exists)
pkg/plugins/manager/store/store_test.go
+24 -24
View File
@@ -25,7 +25,7 @@ func TestStore_ProvideService(t *testing.T) {
return []plugins.PluginSource{
&fakes.FakePluginSource{
PluginClassFunc: func(ctx context.Context) plugins.Class {
return plugins.Bundled
return plugins.ClassBundled
},
PluginURIsFunc: func(ctx context.Context) []string {
return []string{"path1"}
@@ -33,7 +33,7 @@ func TestStore_ProvideService(t *testing.T) {
},
&fakes.FakePluginSource{
PluginClassFunc: func(ctx context.Context) plugins.Class {
return plugins.External
return plugins.ClassExternal
},
PluginURIsFunc: func(ctx context.Context) []string {
return []string{"path2", "path3"}
@@ -71,11 +71,11 @@ func TestStore_Plugin(t *testing.T) {
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}}
p1 := &plugins.Plugin{JSONData: plugins.JSONData{ID: "a-test-datasource", Type: plugins.TypeDataSource}}
p2 := &plugins.Plugin{JSONData: plugins.JSONData{ID: "b-test-panel", Type: plugins.TypePanel}}
p3 := &plugins.Plugin{JSONData: plugins.JSONData{ID: "c-test-panel", Type: plugins.TypePanel}}
p4 := &plugins.Plugin{JSONData: plugins.JSONData{ID: "d-test-app", Type: plugins.TypeApp}}
p5 := &plugins.Plugin{JSONData: plugins.JSONData{ID: "e-test-panel", Type: plugins.TypePanel}}
p5.RegisterClient(&DecommissionedPlugin{})
ps := New(newFakePluginRegistry(map[string]*plugins.Plugin{
@@ -89,28 +89,28 @@ func TestStore_Plugins(t *testing.T) {
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)
pss = ps.Plugins(context.Background(), plugins.TypeApp)
require.Equal(t, pss, []plugins.PluginDTO{p4.ToDTO()})
pss = ps.Plugins(context.Background(), plugins.Panel)
pss = ps.Plugins(context.Background(), plugins.TypePanel)
require.Equal(t, pss, []plugins.PluginDTO{p2.ToDTO(), p3.ToDTO()})
pss = ps.Plugins(context.Background(), plugins.DataSource)
pss = ps.Plugins(context.Background(), plugins.TypeDataSource)
require.Equal(t, pss, []plugins.PluginDTO{p1.ToDTO()})
pss = ps.Plugins(context.Background(), plugins.DataSource, plugins.App, plugins.Panel)
pss = ps.Plugins(context.Background(), plugins.TypeDataSource, plugins.TypeApp, plugins.TypePanel)
require.Equal(t, pss, []plugins.PluginDTO{p1.ToDTO(), p2.ToDTO(), p3.ToDTO(), p4.ToDTO()})
})
}
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}, FS: fakes.NewFakePluginFiles("/some/dir")}
p2 := &plugins.Plugin{JSONData: plugins.JSONData{ID: "b-test-panel", Type: plugins.Panel}, FS: fakes.NewFakePluginFiles("/grafana/")}
p3 := &plugins.Plugin{JSONData: plugins.JSONData{ID: "c-test-secrets", Type: plugins.SecretsManager}, FS: fakes.NewFakePluginFiles("./secrets"), Class: plugins.Core}
p4 := &plugins.Plugin{JSONData: plugins.JSONData{ID: "d-test-datasource", Type: plugins.DataSource}, FS: fakes.NewFakePluginFiles("../test")}
p5 := &plugins.Plugin{JSONData: plugins.JSONData{ID: "e-test-app", Type: plugins.App}, FS: fakes.NewFakePluginFiles("any/path")}
p6 := &plugins.Plugin{JSONData: plugins.JSONData{ID: "f-test-app", Type: plugins.App}}
p1 := &plugins.Plugin{JSONData: plugins.JSONData{ID: "a-test-renderer", Type: plugins.TypeRenderer}, FS: fakes.NewFakePluginFiles("/some/dir")}
p2 := &plugins.Plugin{JSONData: plugins.JSONData{ID: "b-test-panel", Type: plugins.TypePanel}, FS: fakes.NewFakePluginFiles("/grafana/")}
p3 := &plugins.Plugin{JSONData: plugins.JSONData{ID: "c-test-secrets", Type: plugins.TypeSecretsManager}, FS: fakes.NewFakePluginFiles("./secrets"), Class: plugins.ClassCore}
p4 := &plugins.Plugin{JSONData: plugins.JSONData{ID: "d-test-datasource", Type: plugins.TypeDataSource}, FS: fakes.NewFakePluginFiles("../test")}
p5 := &plugins.Plugin{JSONData: plugins.JSONData{ID: "e-test-app", Type: plugins.TypeApp}, FS: fakes.NewFakePluginFiles("any/path")}
p6 := &plugins.Plugin{JSONData: plugins.JSONData{ID: "f-test-app", Type: plugins.TypeApp}}
p6.RegisterClient(&DecommissionedPlugin{})
ps := New(newFakePluginRegistry(map[string]*plugins.Plugin{
@@ -133,9 +133,9 @@ func TestStore_Routes(t *testing.T) {
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}}
p1 := &plugins.Plugin{JSONData: plugins.JSONData{ID: "test-renderer", Type: plugins.TypeRenderer}}
p2 := &plugins.Plugin{JSONData: plugins.JSONData{ID: "test-panel", Type: plugins.TypePanel}}
p3 := &plugins.Plugin{JSONData: plugins.JSONData{ID: "test-app", Type: plugins.TypeApp}}
ps := New(newFakePluginRegistry(map[string]*plugins.Plugin{
p1.ID: p1,
@@ -150,10 +150,10 @@ func TestStore_Renderer(t *testing.T) {
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}}
p1 := &plugins.Plugin{JSONData: plugins.JSONData{ID: "test-renderer", Type: plugins.TypeRenderer}}
p2 := &plugins.Plugin{JSONData: plugins.JSONData{ID: "test-panel", Type: plugins.TypePanel}}
p3 := &plugins.Plugin{JSONData: plugins.JSONData{ID: "test-secrets", Type: plugins.TypeSecretsManager}}
p4 := &plugins.Plugin{JSONData: plugins.JSONData{ID: "test-datasource", Type: plugins.TypeDataSource}}
ps := New(newFakePluginRegistry(map[string]*plugins.Plugin{
p1.ID: p1,