Add --version flag to cluster-compare and helpers

Signed-off-by: Jim Ramsay <[email protected]>
openshift · Jan 7, 2025 · b059aaf · b059aaf
1 parent a217c8d
commit b059aaf
Show file tree

Hide file tree

Showing 8 changed files with 40 additions and 7 deletions.
diff --git a/Makefile b/Makefile
@@ -13,6 +13,20 @@ GO_BUILD_FLAGS_DARWIN :=-tags 'include_gcs include_oss containers_image_openpgp'
 GO_BUILD_FLAGS_WINDOWS :=-tags 'include_gcs include_oss containers_image_openpgp'
 GO_BUILD_FLAGS_LINUX_CROSS :=-tags 'include_gcs include_oss containers_image_openpgp'
 
+# Inject a version and date via ldflags for the '--version' flag
+# Upstream builds get their ldflags set via goreleaser automatically
+ifneq ($(strip $(OS_GIT_VERSION)),)
+	# Downstream builds should have this set:
+	#   OS_GIT_VERSION=4.19.0-202412190006.p0.ga217c8d.assembly.stream.el9
+	# So use it verbatim for the version string
+	BUILD_VERSION ?= $(OS_GIT_VERSION)
+else
+	# For manual builds, use 'git describe' based on the latest tag
+	BUILD_VERSION ?= $(shell git describe --tag | sed -e 's/^v//')
+endif
+BUILD_DATE ?= $(shell date --rfc-3339=seconds)
+GO_LDFLAGS := -ldflags="-X 'main.version=$(BUILD_VERSION)' -X 'main.date=$(BUILD_DATE)'"
+
 OUTPUT_DIR :=_output
 GO_BUILD_BINDIR ?=$(OUTPUT_DIR)/bin
 CROSS_BUILD_BINDIR ?=$(OUTPUT_DIR)/bin
@@ -42,7 +56,7 @@ endif
 .PHONY: build
 build:
 	mkdir -p $(GO_BUILD_BINDIR)
-	GOOS=$(GOOS) GOARCH=$(GOARCH) go build -mod=vendor $(GO_BUILD_FLAGS) -o $(GO_BUILD_BINDIR)/kubectl-cluster_compare ./cmd/kubectl-cluster_compare.go
+	GOOS=$(GOOS) GOARCH=$(GOARCH) go build -mod=vendor $(GO_BUILD_FLAGS) $(GO_LDFLAGS) -o $(GO_BUILD_BINDIR)/kubectl-cluster_compare ./cmd/kubectl-cluster_compare.go
 
 # Install the plugin and completion script in /usr/local/bin
 .PHONY: install
@@ -63,11 +77,11 @@ test-report-creator:
 
 .PHONY: build-report-creator
 build-report-creator:
-	go build ./addon-tools/report-creator/report-creator.go
+	go build $(GO_LDFLAGS) ./addon-tools/report-creator/report-creator.go
 
 .PHONY: build-helm-convert
 build-helm-convert:
-	go build ./addon-tools/helm-convert/helm-convert.go
+	go build $(GO_LDFLAGS) ./addon-tools/helm-convert/helm-convert.go
 
 .PHONY: test-helm-convert
 test-helm-convert:

diff --git a/addon-tools/helm-convert/helm-convert.go b/addon-tools/helm-convert/helm-convert.go
@@ -7,8 +7,14 @@ import (
 	"github.com/openshift/kube-compare/addon-tools/helm-convert/convert"
 )
 
+var (
+	version = "unreleased"
+	date    = "unknown"
+)
+
 func main() {
 	cmd := convert.NewCmd()
+	cmd.Version = fmt.Sprintf("%s (%s)", version, date)
 	if err := cmd.Execute(); err != nil {
 		_, _ = fmt.Fprintf(os.Stderr, "There was an error: '%s'", err)
 		os.Exit(1)

diff --git a/addon-tools/report-creator/report-creator.go b/addon-tools/report-creator/report-creator.go
@@ -7,8 +7,14 @@ import (
 	"github.com/openshift/kube-compare/addon-tools/report-creator/report"
 )
 
+var (
+	version = "unreleased"
+	date    = "unknown"
+)
+
 func main() {
 	cmd := report.NewCmd()
+	cmd.Version = fmt.Sprintf("%s (%s)", version, date)
 	if err := cmd.Execute(); err != nil {
 		_, _ = fmt.Fprintf(os.Stderr, "There was an error: '%s'", err)
 		os.Exit(1)

diff --git a/cmd/kubectl-cluster_compare.go b/cmd/kubectl-cluster_compare.go
@@ -3,6 +3,7 @@
 package main
 
 import (
+	"fmt"
 	"os"
 
 	"github.com/openshift/kube-compare/pkg/compare"
@@ -11,11 +12,17 @@ import (
 	kcmdutil "k8s.io/kubectl/pkg/cmd/util"
 )
 
+var (
+	version = "unreleased"
+	date    = "unknown"
+)
+
 func main() {
 	ioStreams := genericiooptions.IOStreams{In: os.Stdin, Out: os.Stdout, ErrOut: os.Stderr}
 	configFlags := genericclioptions.NewConfigFlags(true)
 	f := kcmdutil.NewFactory(configFlags)
 	compareCmd := compare.NewCmd(f, ioStreams)
+	compareCmd.Version = fmt.Sprintf("%s (%s)", version, date)
 	if err := compareCmd.Execute(); err != nil {
 		os.Exit(1)
 	}

diff --git a/pkg/compare/compare.go b/pkg/compare/compare.go
@@ -151,7 +151,7 @@ func NewCmd(f kcmdutil.Factory, streams genericiooptions.IOStreams) *cobra.Comma
 	}
 
 	cmd := &cobra.Command{
-		Use:                   "compare -r <Reference File>",
+		Use:                   "cluster-compare -r <Reference File>",
 		DisableFlagsInUseLine: true,
 		Short:                 i18n.T("Compare a reference configuration and a set of cluster configuration CRs."),
 		Long:                  compareLong,

diff --git a/pkg/compare/testdata/NoInput/localerr.golden b/pkg/compare/testdata/NoInput/localerr.golden
@@ -1,3 +1,3 @@
 error: "Reference config file is required"
-See 'compare -h' for help and examples
+See 'cluster-compare -h' for help and examples
 error code:2
diff --git a/pkg/compare/testdata/UserOverride/localfailOutputerr.golden b/pkg/compare/testdata/UserOverride/localfailOutputerr.golden
@@ -1,3 +1,3 @@
 error: Requested user override generation but no entires for which template to generate overrides for
-See 'compare -h' for help and examples
+See 'cluster-compare -h' for help and examples
 error code:2
diff --git a/pkg/compare/testdata/UserOverride/localnoReasonGenerateerr.golden b/pkg/compare/testdata/UserOverride/localnoReasonGenerateerr.golden
@@ -1,3 +1,3 @@
 error: Reason required when generating overrides
-See 'compare -h' for help and examples
+See 'cluster-compare -h' for help and examples
 error code:2