Skip to content

Go SDK: Validate that plugin is not using sdk forks #319

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
academo merged 1 commit into from
Apr 8, 2025
Merged

Go SDK: Validate that plugin is not using sdk forks #319

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions pkg/analysis/passes/osvscanner/osvscanner.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,10 @@ var scannerTypes = [...]string{
}

func run(pass *analysis.Pass) (interface{}, error) {
if os.Getenv("SKIP_OSV_SCANNER") != "" {
Copy link
Copy Markdown
Collaborator Author

@academo academo Apr 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

adding this for faster local tests

return nil, nil
}

archiveFilesPath, ok := pass.ResultOf[archive.Analyzer].(string)
if !ok || archiveFilesPath == "" {
return nil, nil
Expand Down
16 changes: 16 additions & 0 deletions pkg/analysis/passes/sdkusage/sdkusage.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ var (
goSdkNotUsed = &analysis.Rule{Name: "go-sdk-not-used", Severity: analysis.Error}
goModNotFound = &analysis.Rule{Name: "go-mod-not-found", Severity: analysis.Error}
goModError = &analysis.Rule{Name: "go-mod-error", Severity: analysis.Error}
goSdkReplaced = &analysis.Rule{Name: "go-sdk-replaced", Severity: analysis.Error}
goSdkOlderThanTwoMonths = &analysis.Rule{
Name: "go-sdk-older-than-2-months",
Severity: analysis.Warning,
Expand All @@ -39,6 +40,7 @@ var Analyzer = &analysis.Analyzer{
goSdkNotUsed,
goModNotFound,
goModError,
goSdkReplaced,
goSdkOlderThanTwoMonths,
goSdkOlderThanFiveMonths,
},
Expand Down Expand Up @@ -183,6 +185,20 @@ func run(pass *analysis.Pass) (interface{}, error) {
return nil, nil
}

// check if go sdk was replaced
for _, req := range goModParsed.Replace {
if req.Old.Path == "github.com/grafana/grafana-plugin-sdk-go" &&
req.New.Path != "github.com/grafana/grafana-plugin-sdk-go" {
pass.ReportResult(
pass.AnalyzerName,
goSdkNotUsed,
"Your plugin is using a custom or forked version of the Grafana Go SDK",
"Custom or forked version of Grafana Go SDK are not supported. Please use the latest Grafana Go SDK (github.com/grafana/grafana-plugin-sdk-go)",
)
return nil, nil
}
}

return nil, nil
}

Expand Down
56 changes: 50 additions & 6 deletions pkg/analysis/passes/sdkusage/sdkusage_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ func TestGoModNotFound(t *testing.T) {

pass := &analysis.Pass{
RootDir: filepath.Join("./"),
ResultOf: map[*analysis.Analyzer]interface{}{
ResultOf: map[*analysis.Analyzer]any{
sourcecode.Analyzer: filepath.Join("testdata", "nogomod"),
nestedmetadata.Analyzer: nestedmetadata.Metadatamap{
"plugin.json": meta,
Expand Down Expand Up @@ -58,7 +58,7 @@ func TestGoModNotParseable(t *testing.T) {

pass := &analysis.Pass{
RootDir: filepath.Join("./"),
ResultOf: map[*analysis.Analyzer]interface{}{
ResultOf: map[*analysis.Analyzer]any{
sourcecode.Analyzer: filepath.Join("testdata", "gomodwrong"),
nestedmetadata.Analyzer: nestedmetadata.Metadatamap{
"plugin.json": meta,
Expand Down Expand Up @@ -112,7 +112,7 @@ func TestValidGoMod(t *testing.T) {

pass := &analysis.Pass{
RootDir: filepath.Join("./"),
ResultOf: map[*analysis.Analyzer]interface{}{
ResultOf: map[*analysis.Analyzer]any{
sourcecode.Analyzer: filepath.Join("testdata", "validgomod"),
nestedmetadata.Analyzer: nestedmetadata.Metadatamap{
"plugin.json": meta,
Expand All @@ -138,7 +138,7 @@ func TestValidGoModWithNoGrafanaSdk(t *testing.T) {

pass := &analysis.Pass{
RootDir: filepath.Join("./"),
ResultOf: map[*analysis.Analyzer]interface{}{
ResultOf: map[*analysis.Analyzer]any{
sourcecode.Analyzer: filepath.Join("testdata", "nografanagosdk"),
nestedmetadata.Analyzer: nestedmetadata.Metadatamap{
"plugin.json": meta,
Expand Down Expand Up @@ -198,7 +198,7 @@ func TestTwoMonthsOldSdk(t *testing.T) {

pass := &analysis.Pass{
RootDir: filepath.Join("./"),
ResultOf: map[*analysis.Analyzer]interface{}{
ResultOf: map[*analysis.Analyzer]any{
sourcecode.Analyzer: filepath.Join("testdata", "sdk-2-months-old"),
nestedmetadata.Analyzer: nestedmetadata.Metadatamap{
"plugin.json": meta,
Expand Down Expand Up @@ -259,7 +259,7 @@ func TestFiveMonthsOld(t *testing.T) {

pass := &analysis.Pass{
RootDir: filepath.Join("./"),
ResultOf: map[*analysis.Analyzer]interface{}{
ResultOf: map[*analysis.Analyzer]any{
sourcecode.Analyzer: filepath.Join("testdata", "sdk-5-months-old"),
nestedmetadata.Analyzer: nestedmetadata.Metadatamap{
"plugin.json": meta,
Expand All @@ -278,3 +278,47 @@ func TestFiveMonthsOld(t *testing.T) {
interceptor.Diagnostics[0].Title,
)
}

func TestReplacedSdk(t *testing.T) {
httpmock.Activate()
defer httpmock.DeactivateAndReset()

// mock latest request
httpmock.RegisterResponder(
"GET",
"https://api.github.com/repos/grafana/grafana-plugin-sdk-go/releases/latest",
httpmock.NewStringResponder(
200,
`{ "tag_name": "v0.230.0", "published_at": "2024-05-09T10:03:16Z" }`,
),
)

var interceptor testpassinterceptor.TestPassInterceptor
pluginJsonContent := []byte(`{
"name": "my plugin name",
"backend": true,
"executable": "gx_plugin"
}`)
meta, err := testutils.JSONToMetadata(pluginJsonContent)
require.NoError(t, err)

pass := &analysis.Pass{
RootDir: filepath.Join("./"),
ResultOf: map[*analysis.Analyzer]any{
sourcecode.Analyzer: filepath.Join("testdata", "replaced-sdk"),
nestedmetadata.Analyzer: nestedmetadata.Metadatamap{
"plugin.json": meta,
},
},
Report: interceptor.ReportInterceptor(),
}

_, err = Analyzer.Run(pass)
require.NoError(t, err)
require.Len(t, interceptor.Diagnostics, 1)
require.Equal(
t,
"Your plugin is using a custom or forked version of the Grafana Go SDK",
interceptor.Diagnostics[0].Title,
)
}
9 changes: 9 additions & 0 deletions pkg/analysis/passes/sdkusage/testdata/replaced-sdk/go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
module github.com/grafana/grafana-testing-replaced-sdk-datasource

go 1.22

require (
github.com/grafana/grafana-plugin-sdk-go v0.260.3
)

replace github.com/grafana/grafana-plugin-sdk-go v0.260.3 => ./grafana-plugin-sdk-go
9 changes: 8 additions & 1 deletion pkg/runner/runner.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,8 @@ func Check(

seen[currentAnalyzer] = true

logme.DebugFln("Running analyzer %s", currentAnalyzer.Name)
Copy link
Copy Markdown
Collaborator Author

@academo academo Apr 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

adding this for local debugging


// run all the dependencies of the analyzer
for _, dep := range currentAnalyzer.Requires {
// if dependency returned error. This analyzer should return error too
Expand Down Expand Up @@ -99,7 +101,12 @@ func Check(
return diagnostics, nil
}

func initAnalyzers(analyzers []*analysis.Analyzer, cfg *Config, pluginId string, severityOverwrite analysis.Severity) {
func initAnalyzers(
Copy link
Copy Markdown
Collaborator Author

@academo academo Apr 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

linting

analyzers []*analysis.Analyzer,
cfg *Config,
pluginId string,
severityOverwrite analysis.Severity,
) {
for _, currentAnalyzer := range analyzers {
// Inherit global config file
analyzerEnabled := cfg.Global.Enabled
Expand Down