Merge fc2d4e81f1 into 1f049e5ebd

CHANGELOG.md

@@ -8,6 +8,8 @@
 
 ## Changes since v7.15.3
 
+- [#3452](https://github.com/oauth2-proxy/oauth2-proxy/pull/3452) fix: resolve version from build info when not set via ldflags (so `go install`-ed binaries report a real version instead of `undefined`) (@Lrifton92)
+
 # V7.15.3
 
 ## Release Highlights

pkg/version/version.go

@@ -1,4 +1,38 @@
 package version
 
-// VERSION contains version information
+import "runtime/debug"
+
+// VERSION contains version information. It is set at build time via
+// -ldflags "-X github.com/oauth2-proxy/oauth2-proxy/v7/pkg/version.VERSION=<version>".
+// When the binary is built without those flags (for example via
+// `go install github.com/oauth2-proxy/oauth2-proxy/v7@latest`), it falls back
+// to the module version recorded in the build info so that `--version` still
+// reports a meaningful value instead of "undefined".
 var VERSION = "undefined"
+
+func init() {
+	VERSION = resolveVersion(VERSION, debug.ReadBuildInfo)
+}
+
+// resolveVersion returns ldflagsVersion when it has been explicitly set at
+// build time. Otherwise it derives the version from the module build info,
+// allowing `go install`-ed binaries to report a meaningful version.
+func resolveVersion(ldflagsVersion string, readBuildInfo func() (*debug.BuildInfo, bool)) string {
+	if ldflagsVersion != "" && ldflagsVersion != "undefined" {
+		return ldflagsVersion
+	}
+	if info, ok := readBuildInfo(); ok && info != nil {
+		// info.Main.Version is populated by the Go toolchain only for
+		// module-aware builds: it is the clean tag for an exact
+		// `@vX.Y.Z` install, or a synthesized pseudo-version
+		// (e.g. v7.15.4-0.20240115123456-abcdef123456) carrying the
+		// base version, commit timestamp and hash when built from
+		// commits on top of a release. A plain `go build` from a source
+		// checkout reports "(devel)", which we skip so release builds
+		// keep deferring to the ldflags value below.
+		if v := info.Main.Version; v != "" && v != "(devel)" {
+			return v
+		}
+	}
+	return ldflagsVersion
+}

pkg/version/version_test.go

@@ -0,0 +1,63 @@
+package version
+
+import (
+	"runtime/debug"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestResolveVersion(t *testing.T) {
+	testCases := []struct {
+		name           string
+		ldflagsVersion string
+		buildInfo      *debug.BuildInfo
+		buildInfoOK    bool
+		expected       string
+	}{
+		{
+			name:           "ldflags version takes precedence over build info",
+			ldflagsVersion: "v7.15.3",
+			buildInfo:      &debug.BuildInfo{Main: debug.Module{Version: "v7.15.0"}},
+			buildInfoOK:    true,
+			expected:       "v7.15.3",
+		},
+		{
+			name:           "falls back to build info version when undefined",
+			ldflagsVersion: "undefined",
+			buildInfo:      &debug.BuildInfo{Main: debug.Module{Version: "v7.15.3"}},
+			buildInfoOK:    true,
+			expected:       "v7.15.3",
+		},
+		{
+			name:           "keeps undefined when build info is unavailable",
+			ldflagsVersion: "undefined",
+			buildInfo:      nil,
+			buildInfoOK:    false,
+			expected:       "undefined",
+		},
+		{
+			name:           "keeps undefined for a (devel) build info version",
+			ldflagsVersion: "undefined",
+			buildInfo:      &debug.BuildInfo{Main: debug.Module{Version: "(devel)"}},
+			buildInfoOK:    true,
+			expected:       "undefined",
+		},
+		{
+			name:           "keeps undefined for an empty build info version",
+			ldflagsVersion: "undefined",
+			buildInfo:      &debug.BuildInfo{Main: debug.Module{Version: ""}},
+			buildInfoOK:    true,
+			expected:       "undefined",
+		},
+	}
+
+	for _, tc := range testCases {
+		t.Run(tc.name, func(t *testing.T) {
+			result := resolveVersion(tc.ldflagsVersion, func() (*debug.BuildInfo, bool) {
+				return tc.buildInfo, tc.buildInfoOK
+			})
+			assert.Equal(t, tc.expected, result)
+		})
+	}
+}