Merge pull request #484 from feichashao/build_version

Feat: Get version from build info

Author: openshift-merge-bot[bot]

Makefile

@@ -118,6 +118,8 @@ mock-gen:
 	mockgen -destination=./pkg/jira/mocks/jiraMock.go -package=mocks github.com/openshift/backplane-cli/pkg/jira IssueServiceInterface
 	mockgen -destination=./pkg/healthcheck/mocks/networkMock.go -package=mocks github.com/openshift/backplane-cli/pkg/healthcheck NetworkInterface
 	mockgen -destination=./pkg/healthcheck/mocks/httpClientMock.go -package=mocks github.com/openshift/backplane-cli/pkg/healthcheck HTTPClient
+	mockgen -destination=./pkg/info/mocks/infoMock.go -package=mocks github.com/openshift/backplane-cli/pkg/info InfoService
+	mockgen -destination=./pkg/info/mocks/buildInfoMock.go -package=mocks github.com/openshift/backplane-cli/pkg/info BuildInfoService
 
 .PHONY: build-image
 build-image:

cmd/ocm-backplane/version/version.go

@@ -19,7 +19,7 @@ var VersionCmd = &cobra.Command{
 
 func runVersion(cmd *cobra.Command, argv []string) error {
 	// Print the version
-	_, _ = fmt.Fprintf(os.Stdout, "%s\n", info.Version)
+	_, _ = fmt.Fprintf(os.Stdout, "%s\n", info.DefaultInfoService.GetVersion())
 
 	return nil
 }

pkg/info/buildInfo.go

@@ -0,0 +1,17 @@
+package info
+
+import "runtime/debug"
+
+type BuildInfoService interface {
+	// return the BuildInfo from Go build
+	GetBuildInfo() (info *debug.BuildInfo, ok bool)
+}
+
+type DefaultBuildInfoServiceImpl struct {
+}
+
+func (b *DefaultBuildInfoServiceImpl) GetBuildInfo() (info *debug.BuildInfo, ok bool) {
+	return debug.ReadBuildInfo()
+}
+
+var DefaultBuildInfoService BuildInfoService = &DefaultBuildInfoServiceImpl{}

pkg/info/info.go

@@ -4,6 +4,7 @@ package info
 
 import (
 	"fmt"
+	"strings"
 )
 
 const (
@@ -57,3 +58,28 @@ var (
 
 	UpstreamREADMETagged = fmt.Sprintf(UpstreamREADMETemplate, Version)
 )
+
+type InfoService interface {
+	// get the current binary version from available sources
+	GetVersion() string
+}
+
+type DefaultInfoServiceImpl struct {
+}
+
+func (i *DefaultInfoServiceImpl) GetVersion() string {
+	// If the Version is set by Goreleaser, return it directly.
+	if Version != "" {
+		return Version
+	}
+
+	// otherwise, return the build info from Go build if available.
+	buildInfo, available := DefaultBuildInfoService.GetBuildInfo()
+	if available {
+		return strings.TrimLeft(buildInfo.Main.Version, "v")
+	}
+
+	return "unknown"
+}
+
+var DefaultInfoService InfoService = &DefaultInfoServiceImpl{}

pkg/info/info_suite_test.go

@@ -0,0 +1,13 @@
+package info_test
+
+import (
+	"testing"
+
+	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/gomega"
+)
+
+func TestInfo(t *testing.T) {
+	RegisterFailHandler(Fail)
+	RunSpecs(t, "Info Service Suite")
+}

pkg/info/info_test.go

@@ -0,0 +1,54 @@
+package info_test
+
+import (
+	"runtime/debug"
+
+	"github.com/golang/mock/gomock"
+	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/gomega"
+	"github.com/openshift/backplane-cli/pkg/info"
+	infoMock "github.com/openshift/backplane-cli/pkg/info/mocks"
+)
+
+var _ = Describe("Info", func() {
+	var (
+		mockCtrl             *gomock.Controller
+		mockBuildInfoService *infoMock.MockBuildInfoService
+	)
+
+	BeforeEach(func() {
+		mockCtrl = gomock.NewController(GinkgoT())
+		mockBuildInfoService = infoMock.NewMockBuildInfoService(mockCtrl)
+		info.DefaultBuildInfoService = mockBuildInfoService
+	})
+
+	AfterEach(func() {
+		mockCtrl.Finish()
+	})
+
+	Context("When getting build version", func() {
+		It("Should return the pre-set Version is available", func() {
+			info.Version = "whatever"
+
+			version := info.DefaultInfoService.GetVersion()
+			Expect(version).To(Equal("whatever"))
+		})
+		It("Should return a version when go bulid info is available and there is no pre-set Version", func() {
+			info.Version = ""
+			mockBuildInfoService.EXPECT().GetBuildInfo().Return(&debug.BuildInfo{
+				Main: debug.Module{
+					Version: "v1.2.3",
+				},
+			}, true).Times(1)
+
+			version := info.DefaultInfoService.GetVersion()
+			Expect(version).To(Equal("1.2.3"))
+		})
+		It("Should return an unknown when no way to determine version", func() {
+			info.Version = ""
+			mockBuildInfoService.EXPECT().GetBuildInfo().Return(nil, false).Times(1)
+			version := info.DefaultInfoService.GetVersion()
+			Expect(version).To(Equal("unknown"))
+		})
+	})
+})

pkg/info/mocks/buildInfoMock.go

@@ -249,13 +249,14 @@ func CheckBackplaneVersion(cmd *cobra.Command) {
 	// GitHub API keeps the v prefix in front which causes mismatch with info.Version
 	latestVersion := strings.TrimLeft(latestVersionTag.TagName, "v")
 
+	currentVersion := info.DefaultInfoService.GetVersion()
 	// Check if the local version is already up-to-date
-	if latestVersion == info.Version {
-		logger.WithField("Current version", info.Version).Info("Already up-to-date")
+	if latestVersion == currentVersion {
+		logger.WithField("Current version", currentVersion).Info("Already up-to-date")
 		return
 	}
 
-	logger.WithField("Current version", info.Version).WithField("Latest version", latestVersion).Warn("Your Backplane CLI is not up to date. Please run the command 'ocm backplane upgrade' to upgrade to the latest version")
+	logger.WithField("Current version", currentVersion).WithField("Latest version", latestVersion).Warn("Your Backplane CLI is not up to date. Please run the command 'ocm backplane upgrade' to upgrade to the latest version")
 }
 
 // CheckValidPrompt checks that the stdin and stderr are valid for prompt