mirror of https://github.com/grafana/grafana.git
301 lines
7.4 KiB
Go
301 lines
7.4 KiB
Go
package pfs
|
|
|
|
import (
|
|
"archive/zip"
|
|
"io/fs"
|
|
"os"
|
|
"path/filepath"
|
|
"sort"
|
|
"testing"
|
|
|
|
"github.com/google/go-cmp/cmp"
|
|
"github.com/grafana/grafana/pkg/cuectx"
|
|
"github.com/stretchr/testify/require"
|
|
)
|
|
|
|
func TestParsePluginTestdata(t *testing.T) {
|
|
type tt struct {
|
|
tfs fs.FS
|
|
// TODO could remove this by getting rid of inconsistent subdirs
|
|
subpath string
|
|
skip string
|
|
err error
|
|
// TODO could remove this by expecting that dirname == id
|
|
rootid string
|
|
}
|
|
tab := map[string]tt{
|
|
"app-with-child": {
|
|
rootid: "myorgid-simple-app",
|
|
subpath: "dist",
|
|
skip: "schema violation, weirdness in info.version field",
|
|
},
|
|
"duplicate-plugins": {
|
|
rootid: "test-app",
|
|
subpath: "nested",
|
|
skip: "schema violation, dependencies don't follow naming constraints",
|
|
},
|
|
"includes-symlinks": {
|
|
skip: "schema violation, dependencies don't follow naming constraints",
|
|
},
|
|
"installer": {
|
|
rootid: "test-datasource",
|
|
subpath: "plugin",
|
|
},
|
|
"invalid-plugin-json": {
|
|
rootid: "test-app",
|
|
err: ErrInvalidRootFile,
|
|
},
|
|
"invalid-v1-signature": {
|
|
rootid: "test-datasource",
|
|
subpath: "plugin",
|
|
},
|
|
"invalid-v2-extra-file": {
|
|
rootid: "test-datasource",
|
|
subpath: "plugin",
|
|
},
|
|
"invalid-v2-missing-file": {
|
|
rootid: "test-datasource",
|
|
subpath: "plugin",
|
|
},
|
|
"lacking-files": {
|
|
rootid: "test-datasource",
|
|
subpath: "plugin",
|
|
},
|
|
"nested-plugins": {
|
|
rootid: "test-datasource",
|
|
subpath: "parent",
|
|
},
|
|
"non-pvt-with-root-url": {
|
|
rootid: "test-datasource",
|
|
subpath: "plugin",
|
|
},
|
|
"renderer-added-file": {
|
|
rootid: "test-renderer",
|
|
subpath: "plugin",
|
|
},
|
|
"symbolic-plugin-dirs": {
|
|
skip: "io/fs-based scanner will not traverse symlinks; caller of ParsePluginFS() must do it",
|
|
},
|
|
"test-app": {
|
|
skip: "schema violation, dependencies don't follow naming constraints",
|
|
rootid: "test-app",
|
|
},
|
|
"test-app-with-includes": {
|
|
rootid: "test-app",
|
|
skip: "has a 'page'-type include which isn't a known part of spec",
|
|
},
|
|
"test-app-with-roles": {
|
|
rootid: "test-app",
|
|
},
|
|
"unsigned-datasource": {
|
|
rootid: "test-datasource",
|
|
subpath: "plugin",
|
|
},
|
|
"unsigned-panel": {
|
|
rootid: "test-panel",
|
|
subpath: "plugin",
|
|
},
|
|
"valid-v2-pvt-signature": {
|
|
rootid: "test-datasource",
|
|
subpath: "plugin",
|
|
},
|
|
"valid-v2-pvt-signature-root-url-uri": {
|
|
rootid: "test-datasource",
|
|
subpath: "plugin",
|
|
},
|
|
"valid-v2-signature": {
|
|
rootid: "test-datasource",
|
|
subpath: "plugin",
|
|
},
|
|
"plugin-with-dist": {
|
|
rootid: "test-datasource",
|
|
subpath: "plugin",
|
|
},
|
|
"no-rootfile": {
|
|
err: ErrNoRootFile,
|
|
},
|
|
"valid-model-panel": {},
|
|
"valid-model-datasource": {},
|
|
"missing-kind-datasource": {},
|
|
"panel-conflicting-joinschema": {
|
|
err: ErrInvalidLineage,
|
|
skip: "TODO implement BindOption in thema, SatisfiesJoinSchema, then use it here",
|
|
},
|
|
"panel-does-not-follow-slot-joinschema": {
|
|
err: ErrInvalidLineage,
|
|
skip: "TODO implement BindOption in thema, SatisfiesJoinSchema, then use it here",
|
|
},
|
|
"pluginRootWithDist": {
|
|
err: ErrNoRootFile,
|
|
skip: "This folder is used to test multiple plugins in the same folder",
|
|
},
|
|
"name-mismatch-panel": {
|
|
err: ErrInvalidGrafanaPluginInstance,
|
|
},
|
|
"disallowed-cue-import": {
|
|
err: ErrDisallowedCUEImport,
|
|
},
|
|
"cdn": {
|
|
rootid: "grafana-worldmap-panel",
|
|
subpath: "plugin",
|
|
},
|
|
"external-registration": {
|
|
rootid: "grafana-test-datasource",
|
|
},
|
|
"oauth-external-registration": {
|
|
rootid: "grafana-test-datasource",
|
|
},
|
|
}
|
|
|
|
staticRootPath, err := filepath.Abs(filepath.Join("..", "manager", "testdata"))
|
|
require.NoError(t, err)
|
|
dfs := os.DirFS(staticRootPath)
|
|
ents, err := fs.ReadDir(dfs, ".")
|
|
require.NoError(t, err)
|
|
|
|
// Ensure table test and dir list are ==
|
|
var dirs, tts []string
|
|
for k := range tab {
|
|
tts = append(tts, k)
|
|
}
|
|
for _, ent := range ents {
|
|
dirs = append(dirs, ent.Name())
|
|
}
|
|
sort.Strings(tts)
|
|
sort.Strings(dirs)
|
|
if !cmp.Equal(tts, dirs) {
|
|
t.Fatalf("table test map (-) and pkg/plugins/manager/testdata dirs (+) differ: %s", cmp.Diff(tts, dirs))
|
|
}
|
|
|
|
for _, ent := range ents {
|
|
tst := tab[ent.Name()]
|
|
tst.tfs, err = fs.Sub(dfs, filepath.Join(ent.Name(), tst.subpath))
|
|
require.NoError(t, err)
|
|
tab[ent.Name()] = tst
|
|
}
|
|
|
|
lib := cuectx.GrafanaThemaRuntime()
|
|
for name, otst := range tab {
|
|
tst := otst // otherwise var is shadowed within func by looping
|
|
t.Run(name, func(t *testing.T) {
|
|
if tst.skip != "" {
|
|
t.Skip(tst.skip)
|
|
}
|
|
|
|
pp, err := ParsePluginFS(tst.tfs, lib)
|
|
if tst.err == nil {
|
|
require.NoError(t, err, "unexpected error while parsing plugin tree")
|
|
} else {
|
|
require.Error(t, err)
|
|
t.Logf("%T %s", err, err)
|
|
require.ErrorIs(t, err, tst.err, "unexpected error type while parsing plugin tree")
|
|
return
|
|
}
|
|
|
|
if tst.rootid == "" {
|
|
tst.rootid = name
|
|
}
|
|
|
|
require.Equal(t, tst.rootid, pp.Properties.Id, "expected plugin id and actual plugin id differ")
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestParseTreeZips(t *testing.T) {
|
|
type tt struct {
|
|
tfs fs.FS
|
|
// TODO could remove this by getting rid of inconsistent subdirs
|
|
subpath string
|
|
skip string
|
|
err error
|
|
// TODO could remove this by expecting that dirname == id
|
|
rootid string
|
|
}
|
|
|
|
tab := map[string]tt{
|
|
"grafana-simple-json-datasource-ec18fa4da8096a952608a7e4c7782b4260b41bcf.zip": {
|
|
skip: "binary plugin",
|
|
},
|
|
"plugin-with-absolute-member.zip": {
|
|
skip: "not actually a plugin, no plugin.json?",
|
|
},
|
|
"plugin-with-absolute-symlink-dir.zip": {
|
|
skip: "not actually a plugin, no plugin.json?",
|
|
},
|
|
"plugin-with-absolute-symlink.zip": {
|
|
skip: "not actually a plugin, no plugin.json?",
|
|
},
|
|
"plugin-with-parent-member.zip": {
|
|
skip: "not actually a plugin, no plugin.json?",
|
|
},
|
|
"plugin-with-symlink-dir.zip": {
|
|
skip: "not actually a plugin, no plugin.json?",
|
|
},
|
|
"plugin-with-symlink.zip": {
|
|
skip: "not actually a plugin, no plugin.json?",
|
|
},
|
|
"plugin-with-symlinks.zip": {
|
|
subpath: "test-app",
|
|
rootid: "test-app",
|
|
},
|
|
}
|
|
|
|
staticRootPath, err := filepath.Abs(filepath.Join("..", "storage", "testdata"))
|
|
require.NoError(t, err)
|
|
ents, err := os.ReadDir(staticRootPath)
|
|
require.NoError(t, err)
|
|
|
|
// Ensure table test and dir list are ==
|
|
var dirs, tts []string
|
|
for k := range tab {
|
|
tts = append(tts, k)
|
|
}
|
|
for _, ent := range ents {
|
|
dirs = append(dirs, ent.Name())
|
|
}
|
|
sort.Strings(tts)
|
|
sort.Strings(dirs)
|
|
if !cmp.Equal(tts, dirs) {
|
|
t.Fatalf("table test map (-) and pkg/plugins/installer/testdata dirs (+) differ: %s", cmp.Diff(tts, dirs))
|
|
}
|
|
|
|
for _, ent := range ents {
|
|
tst := tab[ent.Name()]
|
|
r, err := zip.OpenReader(filepath.Join(staticRootPath, ent.Name()))
|
|
require.NoError(t, err)
|
|
defer r.Close() //nolint:errcheck
|
|
if tst.subpath != "" {
|
|
tst.tfs, err = fs.Sub(r, tst.subpath)
|
|
require.NoError(t, err)
|
|
} else {
|
|
tst.tfs = r
|
|
}
|
|
|
|
tab[ent.Name()] = tst
|
|
}
|
|
|
|
lib := cuectx.GrafanaThemaRuntime()
|
|
for name, otst := range tab {
|
|
tst := otst // otherwise var is shadowed within func by looping
|
|
t.Run(name, func(t *testing.T) {
|
|
if tst.skip != "" {
|
|
t.Skip(tst.skip)
|
|
}
|
|
|
|
pp, err := ParsePluginFS(tst.tfs, lib)
|
|
if tst.err == nil {
|
|
require.NoError(t, err, "unexpected error while parsing plugin fs")
|
|
} else {
|
|
require.ErrorIs(t, err, tst.err, "unexpected error type while parsing plugin fs")
|
|
return
|
|
}
|
|
|
|
if tst.rootid == "" {
|
|
tst.rootid = name
|
|
}
|
|
|
|
require.Equal(t, tst.rootid, pp.Properties.Id, "expected plugin id and actual plugin id differ")
|
|
})
|
|
}
|
|
}
|