CLOUDP-100237: Propose homebrew update command on version update alert (#863)

Author: fmenezes

internal/cli/root/builder.go

@@ -17,7 +17,12 @@ package root
 import (
 	"fmt"
 	"io"
+	"os"
+	"os/exec"
+	"path/filepath"
 	"runtime"
+	"strings"
+	"time"
 
 	"github.com/Masterminds/semver/v3"
 	"github.com/mongodb/mongocli/internal/cli"
@@ -36,7 +41,7 @@ import (
 )
 
 type BuilderOpts struct {
-	store store.VersionDescriber
+	store store.ReleaseVersionDescriber
 }
 
 // rootBuilder conditionally adds children commands as needed.
@@ -139,18 +144,67 @@ func (opts *BuilderOpts) hasNewVersionAvailable() (newVersionAvailable bool, new
 		return false, "", err
 	}
 
-	svLatestVersion, err := semver.NewVersion(latestVersion)
+	svLatestVersion, err := semver.NewVersion(latestVersion.Version)
 	if err != nil {
 		return false, "", err
 	}
 
-	if svCurrentVersion.Compare(svLatestVersion) < 0 {
-		return true, latestVersion, nil
+	if svCurrentVersion.Compare(svLatestVersion) < 0 && (!isHomebrew() || isAtLeast24HoursPast(latestVersion.PublishedAt)) {
+		return true, latestVersion.Version, nil
 	}
 
 	return false, "", nil
 }
 
+func isAtLeast24HoursPast(t time.Time) bool {
+	return !t.IsZero() && time.Since(t) >= time.Hour*24
+}
+
+func isHomebrew() bool {
+	brewFormulaPath, err := homebrewFormulaPath()
+	if err != nil {
+		return false
+	}
+
+	executablePath, err := executableCurrentPath()
+	if err != nil {
+		return false
+	}
+
+	return strings.HasPrefix(executablePath, brewFormulaPath)
+}
+
+func homebrewFormulaPath() (string, error) {
+	formula := config.ToolName
+	brewFormulaPathBytes, err := exec.Command("brew", "--prefix", "--installed", formula).Output()
+	if err != nil {
+		return "", err
+	}
+
+	brewFormulaPath := strings.TrimSpace(string(brewFormulaPathBytes))
+
+	brewFormulaPath, err = filepath.EvalSymlinks(brewFormulaPath)
+	if err != nil {
+		return "", err
+	}
+
+	return brewFormulaPath, nil
+}
+
+func executableCurrentPath() (string, error) {
+	executablePath, err := os.Executable()
+	if err != nil {
+		return "", err
+	}
+
+	executablePath, err = filepath.EvalSymlinks(executablePath)
+	if err != nil {
+		return "", err
+	}
+
+	return executablePath, nil
+}
+
 func shouldSkipPrintNewVersion(w io.Writer) bool {
 	return config.SkipUpdateCheck() || !cli.IsTerminal(w)
 }
@@ -161,13 +215,20 @@ func (opts *BuilderOpts) printNewVersionAvailable(w io.Writer) error {
 		return err
 	}
 	if newVersionAvailable {
+		var upgradeInstructions string
+		if isHomebrew() {
+			upgradeInstructions = `To upgrade, run "brew update && brew upgrade mongocli".`
+		} else {
+			upgradeInstructions = `To upgrade, see: https://dochub.mongodb.org/core/mongocli-install.`
+		}
+
 		newVersionTemplate := `
 A new version of %s is available '%s'!
-To upgrade, see: https://dochub.mongodb.org/core/mongocli-install.
+%s
 
 To disable this alert, run "mongocli config set skip_update_check true".
 `
-		_, err = fmt.Fprintf(w, newVersionTemplate, config.ToolName, latestVersion)
+		_, err = fmt.Fprintf(w, newVersionTemplate, config.ToolName, latestVersion, upgradeInstructions)
 		return err
 	}
 	return nil

internal/cli/root/builder_test.go

@@ -21,9 +21,11 @@ import (
 	"bytes"
 	"fmt"
 	"testing"
+	"time"
 
 	"github.com/golang/mock/gomock"
 	"github.com/mongodb/mongocli/internal/mocks"
+	"github.com/mongodb/mongocli/internal/store"
 	"github.com/mongodb/mongocli/internal/version"
 )
 
@@ -124,22 +126,22 @@ func TestBuilder(t *testing.T) {
 func TestOutputOpts_printNewVersionAvailable(t *testing.T) {
 	tests := []struct {
 		currentVersion string
-		latestVersion  string
+		latestVersion  *store.ReleaseInformation
 		wantPrint      bool
 	}{
 		{
 			currentVersion: "v1.0.0",
-			latestVersion:  "v2.0.0",
+			latestVersion:  &store.ReleaseInformation{Version: "v2.0.0", PublishedAt: time.Now()},
 			wantPrint:      true,
 		},
 		{
 			currentVersion: "v1.0.0",
-			latestVersion:  "v1.0.0",
+			latestVersion:  &store.ReleaseInformation{Version: "v1.0.0", PublishedAt: time.Now()},
 			wantPrint:      false,
 		},
 		{
 			currentVersion: "v1.0.0-123",
-			latestVersion:  "v1.0.0",
+			latestVersion:  &store.ReleaseInformation{Version: "v1.0.0", PublishedAt: time.Now()},
 			wantPrint:      false,
 		},
 	}
@@ -153,7 +155,7 @@ func TestOutputOpts_printNewVersionAvailable(t *testing.T) {
 			}()
 
 			ctrl := gomock.NewController(t)
-			mockStore := mocks.NewMockVersionDescriber(ctrl)
+			mockStore := mocks.NewMockReleaseVersionDescriber(ctrl)
 			defer ctrl.Finish()
 
 			mockStore.
@@ -178,7 +180,7 @@ A new version of mongocli is available '%v'!
 To upgrade, see: https://dochub.mongodb.org/core/mongocli-install.
 
 To disable this alert, run "mongocli config set skip_update_check true".
-`, tt.latestVersion)
+`, tt.latestVersion.Version)
 			}
 
 			if got := bufOut.String(); got != want {

internal/mocks/.keep

@@ -16,22 +16,31 @@ package store
 
 import (
 	"context"
+	"time"
 
 	"github.com/google/go-github/v38/github"
 )
 
-//go:generate mockgen -destination=../mocks/mock_version.go -package=mocks github.com/mongodb/mongocli/internal/store VersionDescriber
+//go:generate mockgen -destination=../mocks/mock_release_version.go -package=mocks github.com/mongodb/mongocli/internal/store ReleaseVersionDescriber
 
-type VersionDescriber interface {
-	LatestVersion() (string, error)
+type ReleaseVersionDescriber interface {
+	LatestVersion() (*ReleaseInformation, error)
+}
+
+type ReleaseInformation struct {
+	Version     string
+	PublishedAt time.Time
 }
 
 // LatestVersion encapsulates the logic to manage different cloud providers.
-func (s *Store) LatestVersion() (string, error) {
+func (s *Store) LatestVersion() (*ReleaseInformation, error) {
 	client := github.NewClient(nil)
 	release, _, err := client.Repositories.GetLatestRelease(context.Background(), "mongodb", "mongocli")
 	if err != nil {
-		return "", err
+		return nil, err
 	}
-	return release.GetTagName(), nil
+	return &ReleaseInformation{
+		Version:     release.GetTagName(),
+		PublishedAt: release.PublishedAt.Time,
+	}, nil
 }