Plugins: Tidy up CLI code (#67813)

* more tidying * move some things around * more tidying * fix linter
2025-09-25 17:14:32 +08:00 · 2023-05-08 10:58:47 +02:00
parent 0fc9a47779
commit e0e2535c96
16 changed files with 307 additions and 298 deletions
--- a/pkg/plugins/plugins_test.go
+++ b/pkg/plugins/plugins_test.go
@ -0,0 +1,167 @@
+package plugins
+
+import (
+	"errors"
+	"io"
+	"os"
+	"strings"
+	"testing"
+
+	"github.com/google/go-cmp/cmp"
+	"github.com/grafana/grafana/pkg/services/org"
+	"github.com/stretchr/testify/require"
+)
+
+func Test_ReadPluginJSON(t *testing.T) {
+	tests := []struct {
+		name       string
+		pluginJSON func(t *testing.T) io.ReadCloser
+		expected   JSONData
+		err        error
+	}{
+		{
+			name: "Valid plugin",
+			pluginJSON: func(t *testing.T) io.ReadCloser {
+				reader, err := os.Open("manager/testdata/test-app/plugin.json")
+				require.NoError(t, err)
+				return reader
+			},
+			expected: JSONData{
+				ID:   "test-app",
+				Type: "app",
+				Name: "Test App",
+				Info: Info{
+					Author: InfoLink{
+						Name: "Test Inc.",
+						URL:  "http://test.com",
+					},
+					Description: "Official Grafana Test App & Dashboard bundle",
+					Version:     "1.0.0",
+					Links: []InfoLink{
+						{Name: "Project site", URL: "http://project.com"},
+						{Name: "License & Terms", URL: "http://license.com"},
+					},
+					Logos: Logos{
+						Small: "img/logo_small.png",
+						Large: "img/logo_large.png",
+					},
+					Screenshots: []Screenshots{
+						{Path: "img/screenshot1.png", Name: "img1"},
+						{Path: "img/screenshot2.png", Name: "img2"},
+					},
+					Updated: "2015-02-10",
+				},
+				Dependencies: Dependencies{
+					GrafanaVersion: "3.x.x",
+					Plugins: []Dependency{
+						{Type: "datasource", ID: "graphite", Name: "Graphite", Version: "1.0.0"},
+						{Type: "panel", ID: "graph", Name: "Graph", Version: "1.0.0"},
+					},
+				},
+				Includes: []*Includes{
+					{Name: "Nginx Connections", Path: "dashboards/connections.json", Type: "dashboard", Role: org.RoleViewer},
+					{Name: "Nginx Memory", Path: "dashboards/memory.json", Type: "dashboard", Role: org.RoleViewer},
+					{Name: "Nginx Panel", Type: "panel", Role: org.RoleViewer},
+					{Name: "Nginx Datasource", Type: "datasource", Role: org.RoleViewer},
+				},
+				Backend: false,
+			},
+		},
+		{
+			name: "Invalid plugin JSON",
+			pluginJSON: func(t *testing.T) io.ReadCloser {
+				reader, err := os.Open("manager/testdata/invalid-plugin-json/plugin.json")
+				require.NoError(t, err)
+				return reader
+			},
+			err: ErrInvalidPluginJSON,
+		},
+		{
+			name: "Default value overrides",
+			pluginJSON: func(t *testing.T) io.ReadCloser {
+				pJSON := `{
+					"id": "grafana-piechart-panel",
+					"name": "This will be overwritten",
+					"type": "panel",
+					"includes": [
+						{"type": "dashboard", "name": "Pie Charts", "path": "dashboards/demo.json"}
+					]
+				}`
+				return io.NopCloser(strings.NewReader(pJSON))
+			},
+			expected: JSONData{
+				ID:   "grafana-piechart-panel",
+				Type: "panel",
+				Name: "Pie Chart (old)",
+				Dependencies: Dependencies{
+					GrafanaVersion: "*",
+					Plugins:        []Dependency{},
+				},
+				Includes: []*Includes{
+					{Name: "Pie Charts", Path: "dashboards/demo.json", Type: "dashboard", Role: org.RoleViewer},
+				},
+			},
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			p := tt.pluginJSON(t)
+			got, err := ReadPluginJSON(p)
+			if tt.err != nil {
+				require.ErrorIs(t, err, tt.err)
+			}
+			if !cmp.Equal(got, tt.expected) {
+				t.Errorf("Unexpected pluginJSONData: %v", cmp.Diff(got, tt.expected))
+			}
+			require.NoError(t, p.Close())
+		})
+	}
+}
+
+func Test_validatePluginJSON(t *testing.T) {
+	type args struct {
+		data JSONData
+	}
+	tests := []struct {
+		name string
+		args args
+		err  error
+	}{
+		{
+			name: "Valid case",
+			args: args{
+				data: JSONData{
+					ID:   "grafana-plugin-id",
+					Type: DataSource,
+				},
+			},
+		},
+		{
+			name: "Invalid plugin ID",
+			args: args{
+				data: JSONData{
+					Type: Panel,
+				},
+			},
+			err: ErrInvalidPluginJSON,
+		},
+		{
+			name: "Invalid plugin type",
+			args: args{
+				data: JSONData{
+					ID:   "grafana-plugin-id",
+					Type: "test",
+				},
+			},
+			err: ErrInvalidPluginJSON,
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			if err := validatePluginJSON(tt.args.data); !errors.Is(err, tt.err) {
+				t.Errorf("validatePluginJSON() = %v, want %v", err, tt.err)
+			}
+		})
+	}
+}