reorganize

Author: cgsdev0

cmd/login.go

@@ -2,6 +2,7 @@ package cmd
 
 import (
 	"bufio"
+	"errors"
 	"fmt"
 	"os"
 	"regexp"
@@ -13,10 +14,12 @@ import (
 )
 
 var loginCmd = &cobra.Command{
-	Use:     "login",
-	Aliases: []string{"auth", "authenticate", "signin"},
-	Short:   "Authenticate the CLI with your account",
-	Run: func(cmd *cobra.Command, args []string) {
+	Use:          "login",
+	Aliases:      []string{"auth", "authenticate", "signin"},
+	Short:        "Authenticate the CLI with your account",
+	SilenceUsage: true,
+	PreRun:       requireUpdated,
+	RunE: func(cmd *cobra.Command, args []string) error {
 		// TODO: check if the logo fits screen width
 		// fmt.Print(logo)
 		fmt.Print("Welcome to the boot.dev CLI!\n\n")
@@ -28,23 +31,33 @@ var loginCmd = &cobra.Command{
 		reader := bufio.NewReader(os.Stdin)
 		fmt.Print("\nPaste your login code: ")
 		text, err := reader.ReadString('\n')
-		cobra.CheckErr(err)
+
+		if err != nil {
+			return err
+		}
 
 		re := regexp.MustCompile(`[^A-Za-z0-9_-]`)
 		text = re.ReplaceAllString(text, "")
 		creds, err := api.LoginWithCode(text)
-		cobra.CheckErr(err)
+		if err != nil {
+			return err
+		}
+
 		if creds.AccessToken == "" || creds.RefreshToken == "" {
-			cobra.CheckErr("invalid credentials received")
+			return errors.New("invalid credentials received")
 		}
 
 		viper.Set("access_token", creds.AccessToken)
 		viper.Set("refresh_token", creds.RefreshToken)
 		viper.Set("last_refresh", time.Now().Unix())
 
 		err = viper.WriteConfig()
-		cobra.CheckErr(err)
+		if err != nil {
+			return err
+		}
+
 		fmt.Println("Logged in successfully!")
+		return nil
 	},
 }
 

cmd/logout.go

@@ -26,12 +26,14 @@ func logout() {
 }
 
 var logoutCmd = &cobra.Command{
-	Use:     "logout",
-	Aliases: []string{"signout"},
-	Short:   "Disconnect the CLI from your account",
-	PreRun:  requireAuth,
-	Run: func(cmd *cobra.Command, args []string) {
+	Use:          "logout",
+	Aliases:      []string{"signout"},
+	Short:        "Disconnect the CLI from your account",
+	PreRun:       requireAuth,
+	SilenceUsage: true,
+	RunE: func(cmd *cobra.Command, args []string) error {
 		logout()
+		return nil
 	},
 }
 

cmd/root.go

@@ -1,13 +1,14 @@
 package cmd
 
 import (
+	"context"
 	"fmt"
 	"os"
 	"path"
 	"time"
 
-	"github.com/bootdotdev/bootdev/checks"
 	api "github.com/bootdotdev/bootdev/client"
+	"github.com/bootdotdev/bootdev/version"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 )
@@ -42,13 +43,11 @@ const logo string = `
 
 // Execute adds all child commands to the root command and sets flags appropriately.
 // This is called by main.main(). It only needs to happen once to the rootCmd.
-func Execute() {
-	err := checks.PromptUpdateIfNecessary(rootCmd.Version)
-	cobra.CheckErr(err)
-	err = rootCmd.Execute()
-	if err != nil {
-		os.Exit(1)
-	}
+func Execute() error {
+	info := version.FetchUpdateInfo(rootCmd.Version)
+	defer info.PromptUpdateIfAvailable()
+	ctx := version.WithContext(context.Background(), &info)
+	return rootCmd.ExecuteContext(ctx)
 }
 
 func init() {
@@ -90,10 +89,25 @@ func initConfig() {
 	viper.AutomaticEnv() // read in environment variables that match
 }
 
-func promptLoginAndExitIf(condition bool) {
-	if condition {
-		fmt.Println("You must be logged in to use that command.")
-		fmt.Println("Please run 'bootdev login' first.")
+// Chain multiple commands together.
+func compose(commands ...func(cmd *cobra.Command, args []string)) func(cmd *cobra.Command, args []string) {
+	return func(cmd *cobra.Command, args []string) {
+		for _, command := range commands {
+			command(cmd, args)
+		}
+	}
+}
+
+// Call this function at the beginning of a command handler
+// if you want to require the user to update their CLI first.
+func requireUpdated(cmd *cobra.Command, args []string) {
+	info := version.FromContext(cmd.Context())
+	if info == nil || info.FailedToFetch != nil {
+		fmt.Fprintln(os.Stderr, "Failed to fetch update info. Are you online?")
+		os.Exit(1)
+	}
+	if info.IsUpdateRequired {
+		info.PromptUpdateIfAvailable()
 		os.Exit(1)
 	}
 }
@@ -103,6 +117,14 @@ func promptLoginAndExitIf(condition bool) {
 // automatically refresh the tokens, if necessary, and prompt
 // the user to re-login if anything goes wrong.
 func requireAuth(cmd *cobra.Command, args []string) {
+	promptLoginAndExitIf := func(condition bool) {
+		if condition {
+			fmt.Fprintln(os.Stderr, "You must be logged in to use that command.")
+			fmt.Fprintln(os.Stderr, "Please run 'bootdev login' first.")
+			os.Exit(1)
+		}
+	}
+
 	access_token := viper.GetString("access_token")
 	promptLoginAndExitIf(access_token == "")
 

cmd/run.go

@@ -16,19 +16,23 @@ func init() {
 // runCmd represents the run command
 var runCmd = &cobra.Command{
 	Use:    "run UUID",
-	Args:   cobra.MatchAll(cobra.ExactArgs(1)),
+	Args:   cobra.ExactArgs(1),
 	Short:  "Run an assignment without submitting",
-	PreRun: requireAuth,
-	Run: func(cmd *cobra.Command, args []string) {
+	PreRun: compose(requireUpdated, requireAuth),
+	RunE: func(cmd *cobra.Command, args []string) error {
+		cmd.SilenceUsage = true
 		assignmentUUID := args[0]
 		assignment, err := api.FetchAssignment(assignmentUUID)
-		cobra.CheckErr(err)
+		if err != nil {
+			return err
+		}
 		if assignment.Assignment.Type == "type_http_tests" {
 			results, finalBaseURL := checks.HttpTest(*assignment, &runBaseURL)
 			printResults(results, assignment, finalBaseURL)
 			cobra.CheckErr(err)
 		} else {
 			cobra.CheckErr("unsupported assignment type")
 		}
+		return nil
 	},
 }

cmd/submit.go

@@ -21,7 +21,7 @@ var submitCmd = &cobra.Command{
 	Use:    "submit UUID",
 	Args:   cobra.MatchAll(cobra.ExactArgs(1)),
 	Short:  "Submit an assignment",
-	PreRun: requireAuth,
+	PreRun: compose(requireUpdated, requireAuth),
 	Run: func(cmd *cobra.Command, args []string) {
 		assignmentUUID := args[0]
 		assignment, err := api.FetchAssignment(assignmentUUID)

main.go

@@ -1,7 +1,14 @@
 package main
 
-import "github.com/bootdotdev/bootdev/cmd"
+import (
+	"os"
+
+	"github.com/bootdotdev/bootdev/cmd"
+)
 
 func main() {
-	cmd.Execute()
+	err := cmd.Execute()
+	if err != nil {
+		os.Exit(1)
+	}
 }

version/context.go

@@ -0,0 +1,17 @@
+package version
+
+import "context"
+
+var ContextKey = struct{ string }{"version"}
+
+func WithContext(ctx context.Context, version *VersionInfo) context.Context {
+	return context.WithValue(ctx, ContextKey, version)
+}
+
+func FromContext(ctx context.Context) *VersionInfo {
+	if c, ok := ctx.Value(ContextKey).(*VersionInfo); ok {
+		return c
+	}
+
+	return nil
+}

checks/version.go renamed to version/version.go

@@ -1,4 +1,4 @@
-package checks
+package version
 
 import (
 	"encoding/json"
@@ -19,23 +19,37 @@ type GHTag struct {
 	Name string `json:"name"`
 }
 
-func PromptUpdateIfNecessary(currentVersion string) error {
+type VersionInfo struct {
+	CurrentVersion   string
+	LatestVersion    string
+	IsOutdated       bool
+	IsUpdateRequired bool
+	FailedToFetch    error
+}
+
+func FetchUpdateInfo(currentVersion string) VersionInfo {
 	latest, err := getLatestVersion()
 	if err != nil {
-		return err
+		return VersionInfo{
+			FailedToFetch: err,
+		}
 	}
 	isUpdateRequired := isUpdateRequired(currentVersion, latest)
 	isOutdated := isOutdated(currentVersion, latest)
+	return VersionInfo{
+		IsUpdateRequired: isUpdateRequired,
+		IsOutdated:       isOutdated,
+		CurrentVersion:   currentVersion,
+		LatestVersion:    latest,
+	}
+}
 
-	if isOutdated {
+func (v *VersionInfo) PromptUpdateIfAvailable() {
+	if v.IsOutdated {
 		fmt.Fprintln(os.Stderr, "A new version of the bootdev CLI is available!")
 		fmt.Fprintln(os.Stderr, "Please run the following command to update:")
 		fmt.Fprintf(os.Stderr, "  go install github.com/%s/%s@latest\n\n", repoOwner, repoName)
-		if isUpdateRequired {
-			os.Exit(1)
-		}
 	}
-	return nil
 }
 
 // Returns true if the current version is older than the latest.