Skip to content

Commit 39c18dd

Browse files
toddtreecetoddtreece
authored
Build: Rename build/info to build/buildinfo (#1405)
1 parent 0882e1c commit 39c18dd

File tree

7 files changed

+29
-29
lines changed

7 files changed

+29
-29
lines changed

‎backend/setup.go‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ import (
1515

1616
"github.com/grafana/grafana-plugin-sdk-go/backend/log"
1717
"github.com/grafana/grafana-plugin-sdk-go/backend/tracing"
18-
"github.com/grafana/grafana-plugin-sdk-go/build/info"
18+
"github.com/grafana/grafana-plugin-sdk-go/build/buildinfo"
1919
"github.com/grafana/grafana-plugin-sdk-go/internal/tracerprovider"
2020
)
2121

@@ -165,7 +165,7 @@ func getTracerCustomAttributes(pluginID string) []attribute.KeyValue {
165165
// Try to get plugin version from build info
166166
// If not available, fallback to environment variable
167167
var pluginVersion string
168-
buildInfo, err := info.GetBuildInfo()
168+
buildInfo, err := buildinfo.GetBuildInfo()
169169
if err != nil {
170170
Logger.Debug("Failed to get build info", "error", err)
171171
} else {
@@ -186,7 +186,7 @@ func getTracerCustomAttributes(pluginID string) []attribute.KeyValue {
186186
// SetupTracer sets up the global OTEL trace provider and tracer.
187187
func SetupTracer(pluginID string, tracingOpts tracing.Opts) error {
188188
// Set up tracing
189-
tracingCfg := getTracingConfig(info.GetBuildInfo)
189+
tracingCfg := getTracingConfig(buildinfo.GetBuildInfo)
190190
if tracingCfg.isEnabled() {
191191
// Append custom attributes to the default ones
192192
tracingOpts.CustomAttributes = append(getTracerCustomAttributes(pluginID), tracingOpts.CustomAttributes...)
@@ -244,7 +244,7 @@ func (c tracingConfig) isEnabled() bool {
244244
}
245245

246246
// getTracingConfig returns a new tracingConfig based on the current environment variables.
247-
func getTracingConfig(buildInfoGetter info.Getter) tracingConfig {
247+
func getTracingConfig(buildInfoGetter buildinfo.Getter) tracingConfig {
248248
var otelAddr, otelPropagation, samplerRemoteURL, samplerParamString string
249249
var samplerType tracerprovider.SamplerType
250250
var samplerParam float64
@@ -289,7 +289,7 @@ func getTracingConfig(buildInfoGetter info.Getter) tracingConfig {
289289
// remoteSamplerServiceName returns the service name for the remote tracing sampler.
290290
// It attempts to get it from the provided buildinfo getter. If unsuccessful or empty,
291291
// defaultRemoteSamplerServiceName is returned instead.
292-
func remoteSamplerServiceName(buildInfoGetter info.Getter) string {
292+
func remoteSamplerServiceName(buildInfoGetter buildinfo.Getter) string {
293293
// Use plugin id as service name, if possible. Otherwise, use a generic default value.
294294
bi, err := buildInfoGetter.GetInfo()
295295
if err != nil {

‎backend/setup_test.go‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import (
44
"testing"
55

66
"github.com/grafana/grafana-plugin-sdk-go/backend/tracing"
7-
"github.com/grafana/grafana-plugin-sdk-go/build/info"
7+
"github.com/grafana/grafana-plugin-sdk-go/build/buildinfo"
88
"github.com/grafana/grafana-plugin-sdk-go/internal/tracerprovider"
99
"github.com/stretchr/testify/require"
1010
"go.opentelemetry.io/otel"
@@ -15,7 +15,7 @@ func TestGetTracingConfig(t *testing.T) {
1515
name string
1616

1717
env map[string]string
18-
buildInfoGetter info.Getter
18+
buildInfoGetter buildinfo.Getter
1919

2020
expEnabled bool
2121
expCfg tracingConfig
@@ -94,8 +94,8 @@ func TestGetTracingConfig(t *testing.T) {
9494
PluginTracingSamplerParamEnv: "0.5",
9595
PluginTracingSamplerRemoteURL: "127.0.0.1:10001",
9696
},
97-
buildInfoGetter: info.GetterFunc(func() (info.Info, error) {
98-
return info.Info{PluginID: "my-example-datasource"}, nil
97+
buildInfoGetter: buildinfo.GetterFunc(func() (buildinfo.Info, error) {
98+
return buildinfo.Info{PluginID: "my-example-datasource"}, nil
9999
}),
100100
expEnabled: true,
101101
expCfg: tracingConfig{
@@ -117,7 +117,7 @@ func TestGetTracingConfig(t *testing.T) {
117117
t.Setenv(e, v)
118118
}
119119
if tc.buildInfoGetter == nil {
120-
tc.buildInfoGetter = info.GetBuildInfo
120+
tc.buildInfoGetter = buildinfo.GetBuildInfo
121121
}
122122
cfg := getTracingConfig(tc.buildInfoGetter)
123123
require.Equal(t, tc.expEnabled, cfg.isEnabled())

‎build/info/info.go‎ renamed to ‎build/buildinfo/info.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package info
1+
package buildinfo
22

33
import (
44
"encoding/json"
@@ -27,7 +27,7 @@ func (v Info) AppendFlags(flags map[string]string) {
2727

2828
out, err := json.Marshal(v)
2929
if err == nil {
30-
flags["github.com/grafana/grafana-plugin-sdk-go/build/info.buildInfoJSON"] = string(out)
30+
flags["github.com/grafana/grafana-plugin-sdk-go/build/buildinfo.buildInfoJSON"] = string(out)
3131
}
3232
}
3333

@@ -45,7 +45,7 @@ func (f GetterFunc) GetInfo() (Info, error) {
4545
}
4646

4747
// GetBuildInfo is the default InfoGetter that returns the build information that was compiled into the binary using:
48-
// -X `github.com/grafana/grafana-plugin-sdk-go/build/info.buildInfoJSON={...}`
48+
// -X `github.com/grafana/grafana-plugin-sdk-go/build/buildinfo.buildInfoJSON={...}`
4949
var GetBuildInfo = GetterFunc(func() (Info, error) {
5050
v := Info{}
5151
if buildInfoJSON == "" {

‎build/common.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ import (
1919
bra "github.com/unknwon/bra/cmd"
2020
"github.com/urfave/cli"
2121

22-
"github.com/grafana/grafana-plugin-sdk-go/build/info"
22+
"github.com/grafana/grafana-plugin-sdk-go/build/buildinfo"
2323
"github.com/grafana/grafana-plugin-sdk-go/build/utils"
2424
"github.com/grafana/grafana-plugin-sdk-go/internal"
2525
)
@@ -153,7 +153,7 @@ func getBuildBackendCmdInfo(cfg Config) (Config, []string, error) {
153153
"build", "-o", filepath.Join(outputPath, exePath),
154154
}
155155

156-
info := info.Info{
156+
info := buildinfo.Info{
157157
Time: now().UnixNano() / int64(time.Millisecond),
158158
}
159159
pluginID, err := internal.GetStringValueFromJSON(filepath.Join(pluginJSONPath, "plugin.json"), "id")

‎build/common_test.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ func Test_getBuildBackendCmdInfo(t *testing.T) {
153153
Env: map[string]string{"CGO_ENABLED": "0", "GOARCH": "arm64", "GOOS": "darwin"},
154154
PluginJSONPath: filepath.Join(tmpDir, "foobar-datasource"),
155155
},
156-
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"},
156+
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/buildinfo.buildInfoJSON={.*}'", "./pkg"},
157157
wantErr: assert.NoError,
158158
},
159159
{
@@ -174,7 +174,7 @@ func Test_getBuildBackendCmdInfo(t *testing.T) {
174174
Env: map[string]string{"CGO_ENABLED": "0", "GOARCH": "arm64", "GOOS": "darwin"},
175175
PluginJSONPath: filepath.Join(tmpDir, "foobar-app"),
176176
},
177-
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"},
177+
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/buildinfo.buildInfoJSON={.*}'", "./pkg"},
178178
wantErr: assert.NoError,
179179
},
180180
{
@@ -195,7 +195,7 @@ func Test_getBuildBackendCmdInfo(t *testing.T) {
195195
Env: map[string]string{"CGO_ENABLED": "0", "GOARCH": "amd64", "GOOS": "windows"},
196196
PluginJSONPath: filepath.Join(tmpDir, "foobarbaz-app"),
197197
},
198-
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"},
198+
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/buildinfo.buildInfoJSON={.*}'", "./pkg"},
199199
wantErr: assert.NoError,
200200
},
201201
}

‎build/info.go‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,19 @@ package build
33
import (
44
"time"
55

6-
"github.com/grafana/grafana-plugin-sdk-go/build/info"
6+
"github.com/grafana/grafana-plugin-sdk-go/build/buildinfo"
77
)
88

99
var now = time.Now // allow override for testing
1010

11-
// Deprecated: Use github.com/grafana/grafana-plugin-sdk-go/build/info.Info instead.
12-
type Info = info.Info
11+
// Deprecated: Use github.com/grafana/grafana-plugin-sdk-go/build/buildinfo.Info instead.
12+
type Info = buildinfo.Info
1313

14-
// Deprecated: Use github.com/grafana/grafana-plugin-sdk-go/build/info.Getter instead.
15-
type InfoGetter = info.Getter
14+
// Deprecated: Use github.com/grafana/grafana-plugin-sdk-go/build/buildinfo.Getter instead.
15+
type InfoGetter = buildinfo.Getter
1616

17-
// Deprecated: Use github.com/grafana/grafana-plugin-sdk-go/build/info.GetterFunc instead.
18-
type InfoGetterFunc = info.GetterFunc
17+
// Deprecated: Use github.com/grafana/grafana-plugin-sdk-go/build/buildinfo.GetterFunc instead.
18+
type InfoGetterFunc = buildinfo.GetterFunc
1919

20-
// Deprecated: Use github.com/grafana/grafana-plugin-sdk-go/build/info.GetBuildInfo instead.
21-
var GetBuildInfo = info.GetBuildInfo
20+
// Deprecated: Use github.com/grafana/grafana-plugin-sdk-go/build/buildinfo.GetBuildInfo instead.
21+
var GetBuildInfo = buildinfo.GetBuildInfo

‎internal/buildinfo/buildinfo.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import (
66
"flag"
77
"fmt"
88

9-
"github.com/grafana/grafana-plugin-sdk-go/build/info"
9+
"github.com/grafana/grafana-plugin-sdk-go/build/buildinfo"
1010
)
1111

1212
var (
@@ -27,7 +27,7 @@ func RunInfoMode() error {
2727
if !InfoModeEnabled() {
2828
return errors.New("build info mode not enabled")
2929
}
30-
bi, err := info.GetBuildInfo()
30+
bi, err := buildinfo.GetBuildInfo()
3131
if err != nil {
3232
return fmt.Errorf("get build info: %w", err)
3333
}

0 commit comments

Comments
 (0)