From e3dec086e63165221c21a59eb2a53dfa543e9ef5 Mon Sep 17 00:00:00 2001 From: Maisem Ali Date: Wed, 15 May 2024 12:59:44 -0400 Subject: [PATCH] version: add Info func to expose EmbeddedInfo To be used to in a different repo. Updates tailscale/corp#1297 Signed-off-by: Maisem Ali --- version/version.go | 53 ++++++++++++++++++++++++++++------------------ 1 file changed, 32 insertions(+), 21 deletions(-) diff --git a/version/version.go b/version/version.go index 424ac47db..c3e6f296d 100644 --- a/version/version.go +++ b/version/version.go @@ -77,7 +77,7 @@ func Long() string { if !bi.valid { return strings.TrimSpace(tailscaleroot.VersionDotTxt) + "-ERR-BuildInfo" } - return fmt.Sprintf("%s-dev%s-t%s%s", strings.TrimSpace(tailscaleroot.VersionDotTxt), bi.commitDate, bi.commitAbbrev(), dirtyString()) + return fmt.Sprintf("%s-dev%s-t%s%s", strings.TrimSpace(tailscaleroot.VersionDotTxt), bi.CommitDate, bi.commitAbbrev(), dirtyString()) }) } @@ -97,47 +97,58 @@ func Short() string { if !bi.valid { return strings.TrimSpace(tailscaleroot.VersionDotTxt) + "-ERR-BuildInfo" } - return strings.TrimSpace(tailscaleroot.VersionDotTxt) + "-dev" + bi.commitDate + return strings.TrimSpace(tailscaleroot.VersionDotTxt) + "-dev" + bi.CommitDate }) } -type embeddedInfo struct { +// Info returns information about the version embedded in the binary. +// If the version information is not present, the second return value is false. +func Info() (EmbeddedInfo, bool) { + ei := getEmbeddedInfo() + if !ei.valid { + return EmbeddedInfo{}, false + } + return ei, true +} + +// EmbeddedInfo contains information about the version embedded in the binary. +type EmbeddedInfo struct { valid bool - commit string - commitDate string - dirty bool + Commit string + CommitDate string + Dirty bool } -func (i embeddedInfo) commitAbbrev() string { - if len(i.commit) >= 9 { - return i.commit[:9] +func (i EmbeddedInfo) commitAbbrev() string { + if len(i.Commit) >= 9 { + return i.Commit[:9] } - return i.commit + return i.Commit } -var getEmbeddedInfo = lazy.SyncFunc(func() embeddedInfo { +var getEmbeddedInfo = lazy.SyncFunc(func() EmbeddedInfo { bi, ok := debug.ReadBuildInfo() if !ok { - return embeddedInfo{} + return EmbeddedInfo{} } - ret := embeddedInfo{valid: true} + ret := EmbeddedInfo{valid: true} for _, s := range bi.Settings { switch s.Key { case "vcs.revision": - ret.commit = s.Value + ret.Commit = s.Value case "vcs.time": if len(s.Value) >= len("yyyy-mm-dd") { - ret.commitDate = s.Value[:len("yyyy-mm-dd")] - ret.commitDate = strings.ReplaceAll(ret.commitDate, "-", "") + ret.CommitDate = s.Value[:len("yyyy-mm-dd")] + ret.CommitDate = strings.ReplaceAll(ret.CommitDate, "-", "") } case "vcs.modified": - ret.dirty = s.Value == "true" + ret.Dirty = s.Value == "true" } } - if ret.commit == "" || ret.commitDate == "" { + if ret.Commit == "" || ret.CommitDate == "" { // Build info is present in the binary, but has no useful data. Act as // if it's missing. - return embeddedInfo{} + return EmbeddedInfo{} } return ret }) @@ -146,14 +157,14 @@ func gitCommit() string { if gitCommitStamp != "" { return gitCommitStamp } - return getEmbeddedInfo().commit + return getEmbeddedInfo().Commit } func gitDirty() bool { if gitDirtyStamp { return true } - return getEmbeddedInfo().dirty + return getEmbeddedInfo().Dirty } func dirtyString() string {