Build: Move build info to new package (#1399)

Author: toddtreece

backend/setup.go

@@ -15,7 +15,7 @@ import (
 
 	"github.com/grafana/grafana-plugin-sdk-go/backend/log"
 	"github.com/grafana/grafana-plugin-sdk-go/backend/tracing"
-	"github.com/grafana/grafana-plugin-sdk-go/build"
+	"github.com/grafana/grafana-plugin-sdk-go/build/info"
 	"github.com/grafana/grafana-plugin-sdk-go/internal/tracerprovider"
 )
 
@@ -165,7 +165,7 @@ func getTracerCustomAttributes(pluginID string) []attribute.KeyValue {
 	// Try to get plugin version from build info
 	// If not available, fallback to environment variable
 	var pluginVersion string
-	buildInfo, err := build.GetBuildInfo()
+	buildInfo, err := info.GetBuildInfo()
 	if err != nil {
 		Logger.Debug("Failed to get build info", "error", err)
 	} else {
@@ -186,7 +186,7 @@ func getTracerCustomAttributes(pluginID string) []attribute.KeyValue {
 // SetupTracer sets up the global OTEL trace provider and tracer.
 func SetupTracer(pluginID string, tracingOpts tracing.Opts) error {
 	// Set up tracing
-	tracingCfg := getTracingConfig(build.GetBuildInfo)
+	tracingCfg := getTracingConfig(info.GetBuildInfo)
 	if tracingCfg.isEnabled() {
 		// Append custom attributes to the default ones
 		tracingOpts.CustomAttributes = append(getTracerCustomAttributes(pluginID), tracingOpts.CustomAttributes...)
@@ -244,7 +244,7 @@ func (c tracingConfig) isEnabled() bool {
 }
 
 // getTracingConfig returns a new tracingConfig based on the current environment variables.
-func getTracingConfig(buildInfoGetter build.InfoGetter) tracingConfig {
+func getTracingConfig(buildInfoGetter info.Getter) tracingConfig {
 	var otelAddr, otelPropagation, samplerRemoteURL, samplerParamString string
 	var samplerType tracerprovider.SamplerType
 	var samplerParam float64
@@ -289,7 +289,7 @@ func getTracingConfig(buildInfoGetter build.InfoGetter) tracingConfig {
 // remoteSamplerServiceName returns the service name for the remote tracing sampler.
 // It attempts to get it from the provided buildinfo getter. If unsuccessful or empty,
 // defaultRemoteSamplerServiceName is returned instead.
-func remoteSamplerServiceName(buildInfoGetter build.InfoGetter) string {
+func remoteSamplerServiceName(buildInfoGetter info.Getter) string {
 	// Use plugin id as service name, if possible. Otherwise, use a generic default value.
 	bi, err := buildInfoGetter.GetInfo()
 	if err != nil {

backend/setup_test.go

@@ -4,7 +4,7 @@ import (
 	"testing"
 
 	"github.com/grafana/grafana-plugin-sdk-go/backend/tracing"
-	"github.com/grafana/grafana-plugin-sdk-go/build"
+	"github.com/grafana/grafana-plugin-sdk-go/build/info"
 	"github.com/grafana/grafana-plugin-sdk-go/internal/tracerprovider"
 	"github.com/stretchr/testify/require"
 	"go.opentelemetry.io/otel"
@@ -15,7 +15,7 @@ func TestGetTracingConfig(t *testing.T) {
 		name string
 
 		env             map[string]string
-		buildInfoGetter build.InfoGetter
+		buildInfoGetter info.Getter
 
 		expEnabled bool
 		expCfg     tracingConfig
@@ -94,8 +94,8 @@ func TestGetTracingConfig(t *testing.T) {
 				PluginTracingSamplerParamEnv:                 "0.5",
 				PluginTracingSamplerRemoteURL:                "127.0.0.1:10001",
 			},
-			buildInfoGetter: build.InfoGetterFunc(func() (build.Info, error) {
-				return build.Info{PluginID: "my-example-datasource"}, nil
+			buildInfoGetter: info.GetterFunc(func() (info.Info, error) {
+				return info.Info{PluginID: "my-example-datasource"}, nil
 			}),
 			expEnabled: true,
 			expCfg: tracingConfig{
@@ -117,7 +117,7 @@ func TestGetTracingConfig(t *testing.T) {
 				t.Setenv(e, v)
 			}
 			if tc.buildInfoGetter == nil {
-				tc.buildInfoGetter = build.GetBuildInfo
+				tc.buildInfoGetter = info.GetBuildInfo
 			}
 			cfg := getTracingConfig(tc.buildInfoGetter)
 			require.Equal(t, tc.expEnabled, cfg.isEnabled())

build/common.go

@@ -19,6 +19,7 @@ import (
 	bra "github.com/unknwon/bra/cmd"
 	"github.com/urfave/cli"
 
+	"github.com/grafana/grafana-plugin-sdk-go/build/info"
 	"github.com/grafana/grafana-plugin-sdk-go/build/utils"
 	"github.com/grafana/grafana-plugin-sdk-go/experimental/e2e"
 	ca "github.com/grafana/grafana-plugin-sdk-go/experimental/e2e/certificate_authority"
@@ -157,7 +158,7 @@ func getBuildBackendCmdInfo(cfg Config) (Config, []string, error) {
 		"build", "-o", filepath.Join(outputPath, exePath),
 	}
 
-	info := Info{
+	info := info.Info{
 		Time: now().UnixNano() / int64(time.Millisecond),
 	}
 	pluginID, err := internal.GetStringValueFromJSON(filepath.Join(pluginJSONPath, "plugin.json"), "id")
@@ -172,7 +173,7 @@ func getBuildBackendCmdInfo(cfg Config) (Config, []string, error) {
 	args = append(args, "-tags", "arrow_json_stdlib")
 
 	flags := make(map[string]string, 10)
-	info.appendFlags(flags)
+	info.AppendFlags(flags)
 
 	if cfg.CustomVars != nil {
 		for k, v := range cfg.CustomVars {

build/common_test.go

@@ -153,7 +153,7 @@ func Test_getBuildBackendCmdInfo(t *testing.T) {
 				Env:            map[string]string{"CGO_ENABLED": "0", "GOARCH": "arm64", "GOOS": "darwin"},
 				PluginJSONPath: filepath.Join(tmpDir, "foobar-datasource"),
 			},
-			expectedArgs: []string{"build", "-o", filepath.Join(defaultOutputBinaryPath, "gpx_foo_darwin_arm64"), "-tags", "arrow_json_stdlib", "-ldflags", "-w -s -extldflags \"-static\" -X 'github.com/grafana/grafana-plugin-sdk-go/build.buildInfoJSON={.*}'", "./pkg"},
+			expectedArgs: []string{"build", "-o", filepath.Join(defaultOutputBinaryPath, "gpx_foo_darwin_arm64"), "-tags", "arrow_json_stdlib", "-ldflags", "-w -s -extldflags \"-static\" -X 'github.com/grafana/grafana-plugin-sdk-go/build/info.buildInfoJSON={.*}'", "./pkg"},
 			wantErr:      assert.NoError,
 		},
 		{
@@ -174,7 +174,7 @@ func Test_getBuildBackendCmdInfo(t *testing.T) {
 				Env:            map[string]string{"CGO_ENABLED": "0", "GOARCH": "arm64", "GOOS": "darwin"},
 				PluginJSONPath: filepath.Join(tmpDir, "foobar-app"),
 			},
-			expectedArgs: []string{"build", "-o", filepath.Join(defaultOutputBinaryPath, defaultNestedDataSourcePath, "gpx_foo_darwin_arm64"), "-tags", "arrow_json_stdlib", "-ldflags", "-w -s -extldflags \"-static\" -X 'github.com/grafana/grafana-plugin-sdk-go/build.buildInfoJSON={.*}'", "./pkg"},
+			expectedArgs: []string{"build", "-o", filepath.Join(defaultOutputBinaryPath, defaultNestedDataSourcePath, "gpx_foo_darwin_arm64"), "-tags", "arrow_json_stdlib", "-ldflags", "-w -s -extldflags \"-static\" -X 'github.com/grafana/grafana-plugin-sdk-go/build/info.buildInfoJSON={.*}'", "./pkg"},
 			wantErr:      assert.NoError,
 		},
 		{
@@ -195,7 +195,7 @@ func Test_getBuildBackendCmdInfo(t *testing.T) {
 				Env:            map[string]string{"CGO_ENABLED": "0", "GOARCH": "amd64", "GOOS": "windows"},
 				PluginJSONPath: filepath.Join(tmpDir, "foobarbaz-app"),
 			},
-			expectedArgs: []string{"build", "-o", filepath.Join(defaultOutputBinaryPath, "gpx_foobarbaz_windows_amd64.exe"), "-tags", "arrow_json_stdlib", "-ldflags", "-w -s -extldflags \"-static\" -X 'github.com/grafana/grafana-plugin-sdk-go/build.buildInfoJSON={.*}'", "./pkg"},
+			expectedArgs: []string{"build", "-o", filepath.Join(defaultOutputBinaryPath, "gpx_foobarbaz_windows_amd64.exe"), "-tags", "arrow_json_stdlib", "-ldflags", "-w -s -extldflags \"-static\" -X 'github.com/grafana/grafana-plugin-sdk-go/build/info.buildInfoJSON={.*}'", "./pkg"},
 			wantErr:      assert.NoError,
 		},
 	}

build/info.go

@@ -1,60 +1,21 @@
 package build
 
 import (
-	"encoding/json"
-	"fmt"
 	"time"
-)
-
-// set from -X
-var buildInfoJSON string
-
-// exposed for testing.
-var now = time.Now
 
-// Info See also PluginBuildInfo in https://github.com/grafana/grafana/blob/master/pkg/plugins/models.go
-type Info struct {
-	Time     int64  `json:"time,omitempty"`
-	PluginID string `json:"pluginID,omitempty"`
-	Version  string `json:"version,omitempty"`
-}
-
-// this will append build flags -- the keys are picked to match existing
-// grafana build flags from bra
-func (v Info) appendFlags(flags map[string]string) {
-	if v.PluginID != "" {
-		flags["main.pluginID"] = v.PluginID
-	}
-	if v.Version != "" {
-		flags["main.version"] = v.Version
-	}
+	"github.com/grafana/grafana-plugin-sdk-go/build/info"
+)
 
-	out, err := json.Marshal(v)
-	if err == nil {
-		flags["github.com/grafana/grafana-plugin-sdk-go/build.buildInfoJSON"] = string(out)
-	}
-}
+var now = time.Now // allow override for testing
 
-// InfoGetter is an interface with a method for returning the build info.
-type InfoGetter interface {
-	// GetInfo returns the build info.
-	GetInfo() (Info, error)
-}
+// Deprecated: Use github.com/grafana/grafana-plugin-sdk-go/build/info.Info instead.
+type Info = info.Info
 
-// InfoGetterFunc can be used to adapt ordinary functions into types satisfying the InfoGetter interface .
-type InfoGetterFunc func() (Info, error)
+// Deprecated: Use github.com/grafana/grafana-plugin-sdk-go/build/info.Getter instead.
+type InfoGetter = info.Getter
 
-func (f InfoGetterFunc) GetInfo() (Info, error) {
-	return f()
-}
+// Deprecated: Use github.com/grafana/grafana-plugin-sdk-go/build/info.GetterFunc instead.
+type InfoGetterFunc = info.GetterFunc
 
-// GetBuildInfo is the default InfoGetter that returns the build information that was compiled into the binary using:
-// -X `github.com/grafana/grafana-plugin-sdk-go/build.buildInfoJSON={...}`
-var GetBuildInfo = InfoGetterFunc(func() (Info, error) {
-	v := Info{}
-	if buildInfoJSON == "" {
-		return v, fmt.Errorf("build info was now set when this was compiled")
-	}
-	err := json.Unmarshal([]byte(buildInfoJSON), &v)
-	return v, err
-})
+// Deprecated: Use github.com/grafana/grafana-plugin-sdk-go/build/info.GetBuildInfo instead.
+var GetBuildInfo = info.GetBuildInfo

build/info/info.go

@@ -0,0 +1,56 @@
+package info
+
+import (
+	"encoding/json"
+	"fmt"
+)
+
+// set from -X
+var buildInfoJSON string
+
+// Info See also PluginBuildInfo in https://github.com/grafana/grafana/blob/master/pkg/plugins/models.go
+type Info struct {
+	Time     int64  `json:"time,omitempty"`
+	PluginID string `json:"pluginID,omitempty"`
+	Version  string `json:"version,omitempty"`
+}
+
+// this will append build flags -- the keys are picked to match existing
+// grafana build flags from bra
+func (v Info) AppendFlags(flags map[string]string) {
+	if v.PluginID != "" {
+		flags["main.pluginID"] = v.PluginID
+	}
+	if v.Version != "" {
+		flags["main.version"] = v.Version
+	}
+
+	out, err := json.Marshal(v)
+	if err == nil {
+		flags["github.com/grafana/grafana-plugin-sdk-go/build/info.buildInfoJSON"] = string(out)
+	}
+}
+
+// Getter is an interface with a method for returning the build info.
+type Getter interface {
+	// GetInfo returns the build info.
+	GetInfo() (Info, error)
+}
+
+// GetterFunc can be used to adapt ordinary functions into types satisfying the InfoGetter interface .
+type GetterFunc func() (Info, error)
+
+func (f GetterFunc) GetInfo() (Info, error) {
+	return f()
+}
+
+// GetBuildInfo is the default InfoGetter that returns the build information that was compiled into the binary using:
+// -X `github.com/grafana/grafana-plugin-sdk-go/build/info.buildInfoJSON={...}`
+var GetBuildInfo = GetterFunc(func() (Info, error) {
+	v := Info{}
+	if buildInfoJSON == "" {
+		return v, fmt.Errorf("build info was now set when this was compiled")
+	}
+	err := json.Unmarshal([]byte(buildInfoJSON), &v)
+	return v, err
+})

internal/buildinfo/buildinfo.go

@@ -6,7 +6,7 @@ import (
 	"flag"
 	"fmt"
 
-	"github.com/grafana/grafana-plugin-sdk-go/build"
+	"github.com/grafana/grafana-plugin-sdk-go/build/info"
 )
 
 var (
@@ -27,7 +27,7 @@ func RunInfoMode() error {
 	if !InfoModeEnabled() {
 		return errors.New("build info mode not enabled")
 	}
-	bi, err := build.GetBuildInfo()
+	bi, err := info.GetBuildInfo()
 	if err != nil {
 		return fmt.Errorf("get build info: %w", err)
 	}