Merge pull request #45 from ActiDoo/codex/fix-clusterrebootd-version-output

Fix version command to report release build

Author: msander

Makefile

@@ -14,6 +14,8 @@ GOOS ?= $(PACKAGE_GOOS)
 GOARCH ?= $(shell go env GOARCH 2>/dev/null || echo amd64)
 LDFLAGS ?= -s -w
 VERSION ?= $(shell go run ./cmd/$(BINARY_NAME) version 2>/dev/null || echo 0.0.0-dev)
+VERSION_PKG := github.com/clusterrebootd/clusterrebootd/pkg/version
+GO_LDFLAGS := $(LDFLAGS) -X $(VERSION_PKG).Version=$(VERSION)
 SYFT ?= syft
 COSIGN ?= cosign
 SBOM_FORMAT ?= cyclonedx-json
@@ -30,7 +32,7 @@ all: build
 build:
 	@echo "==> Building $(BINARY_NAME) ($(GOOS)/$(GOARCH))"
 	@mkdir -p $(DIST_DIR)/$(GOOS)_$(GOARCH)
-	CGO_ENABLED=$(CGO_ENABLED) GOOS=$(GOOS) GOARCH=$(GOARCH) go build -trimpath -ldflags "$(LDFLAGS)" -o $(DIST_DIR)/$(GOOS)_$(GOARCH)/$(BINARY_NAME) ./cmd/$(BINARY_NAME)
+	CGO_ENABLED=$(CGO_ENABLED) GOOS=$(GOOS) GOARCH=$(GOARCH) go build -trimpath -ldflags "$(GO_LDFLAGS)" -o $(DIST_DIR)/$(GOOS)_$(GOARCH)/$(BINARY_NAME) ./cmd/$(BINARY_NAME)
 	@cp $(DIST_DIR)/$(GOOS)_$(GOARCH)/$(BINARY_NAME) $(BINARY_PATH)
 
 clean:

pkg/version/version.go

@@ -1,3 +1,80 @@
 package version
 
-const Version = "0.1.0-dev"
+import (
+	"runtime/debug"
+	"strings"
+)
+
+const defaultVersion = "0.1.0-dev"
+
+// Version holds the semantic version for the running binary.
+// It defaults to a development marker but can be overridden at
+// build time via -ldflags "-X github.com/clusterrebootd/clusterrebootd/pkg/version.Version=<value>".
+var Version = defaultVersion
+
+var readBuildInfo = debug.ReadBuildInfo
+
+func init() {
+	Version = deriveVersion(Version)
+}
+
+func deriveVersion(current string) string {
+	if current != "" && current != defaultVersion {
+		return current
+	}
+
+	info, ok := readBuildInfo()
+	if !ok || info == nil {
+		return current
+	}
+
+	if v := sanitizeModuleVersion(info.Main.Version); v != "" {
+		return v
+	}
+
+	if v := deriveFromSettings(info.Settings); v != "" {
+		return v
+	}
+
+	return current
+}
+
+func sanitizeModuleVersion(v string) string {
+	v = strings.TrimSpace(v)
+	switch v {
+	case "", "(devel)":
+		return ""
+	default:
+		return v
+	}
+}
+
+func deriveFromSettings(settings []debug.BuildSetting) string {
+	var (
+		revision string
+		modified bool
+	)
+
+	for _, setting := range settings {
+		switch setting.Key {
+		case "vcs.revision":
+			revision = strings.TrimSpace(setting.Value)
+		case "vcs.modified":
+			modified = setting.Value == "true"
+		}
+	}
+
+	if revision == "" {
+		return ""
+	}
+
+	if len(revision) > 12 {
+		revision = revision[:12]
+	}
+
+	if modified {
+		revision += "-dirty"
+	}
+
+	return "devel+" + revision
+}

pkg/version/version_test.go

@@ -0,0 +1,48 @@
+package version
+
+import (
+	"runtime/debug"
+	"testing"
+)
+
+func TestDeriveVersionPreservesOverride(t *testing.T) {
+	t.Cleanup(func() { readBuildInfo = debug.ReadBuildInfo })
+	readBuildInfo = func() (*debug.BuildInfo, bool) {
+		t.Fatalf("unexpected call to readBuildInfo")
+		return nil, false
+	}
+
+	const override = "1.2.3"
+	if got := deriveVersion(override); got != override {
+		t.Fatalf("expected override %q to be preserved, got %q", override, got)
+	}
+}
+
+func TestDeriveVersionUsesModuleVersion(t *testing.T) {
+	t.Cleanup(func() { readBuildInfo = debug.ReadBuildInfo })
+	readBuildInfo = func() (*debug.BuildInfo, bool) {
+		return &debug.BuildInfo{
+			Main: debug.Module{Version: "v1.4.0"},
+		}, true
+	}
+
+	if got := deriveVersion(defaultVersion); got != "v1.4.0" {
+		t.Fatalf("expected module version to be used, got %q", got)
+	}
+}
+
+func TestDeriveVersionUsesRevisionFallback(t *testing.T) {
+	t.Cleanup(func() { readBuildInfo = debug.ReadBuildInfo })
+	readBuildInfo = func() (*debug.BuildInfo, bool) {
+		return &debug.BuildInfo{
+			Settings: []debug.BuildSetting{
+				{Key: "vcs.revision", Value: "abcdef1234567890"},
+				{Key: "vcs.modified", Value: "true"},
+			},
+		}, true
+	}
+
+	if got := deriveVersion(defaultVersion); got != "devel+abcdef123456-dirty" {
+		t.Fatalf("expected revision fallback, got %q", got)
+	}
+}