Misc UI improvements (#1159)

Author: deliahu

cli/cmd/completion.go

@@ -75,7 +75,8 @@ to enable cortex shell completion:
 
 Note: this will also add the "cx" alias for cortex for convenience
 `,
-	Args: cobra.ExactArgs(1),
+	Args:      cobra.ExactArgs(1),
+	ValidArgs: []string{"bash", "zsh"},
 	Run: func(cmd *cobra.Command, args []string) {
 		switch args[0] {
 		case "bash":

cli/cmd/deploy.go

@@ -74,6 +74,15 @@ var _deployCmd = &cobra.Command{
 		}
 
 		configPath := getConfigPath(args)
+
+		deployDir := s.EnsureSuffix(filepath.Dir(files.UserRelToAbsPath(configPath)), "/")
+		if deployDir == _homeDir {
+			exit.Error(ErrorDeployFromTopLevelDir("home", env.Provider))
+		}
+		if deployDir == "/" {
+			exit.Error(ErrorDeployFromTopLevelDir("root", env.Provider))
+		}
+
 		var deployResponse schema.DeployResponse
 		if env.Provider == types.AWSProviderType {
 			deploymentBytes, err := getDeploymentBytes(env.Provider, configPath)

cli/cmd/errors.go

@@ -22,6 +22,7 @@ import (
 	"runtime"
 	"strings"
 
+	"github.com/cortexlabs/cortex/pkg/consts"
 	"github.com/cortexlabs/cortex/pkg/lib/errors"
 	s "github.com/cortexlabs/cortex/pkg/lib/strings"
 	"github.com/cortexlabs/cortex/pkg/lib/urls"
@@ -76,6 +77,8 @@ const (
 	ErrClusterConfigOrPromptsRequired       = "cli.cluster_config_or_prompts_required"
 	ErrClusterAccessConfigOrPromptsRequired = "cli.cluster_access_config_or_prompts_required"
 	ErrShellCompletionNotSupported          = "cli.shell_completion_not_supported"
+	ErrNoTerminalWidth                      = "cli.no_terminal_width"
+	ErrDeployFromTopLevelDir                = "cli.deploy_from_top_level_dir"
 )
 
 func ErrorInvalidProvider(providerStr string) error {
@@ -317,6 +320,24 @@ func ErrorClusterAccessConfigOrPromptsRequired() error {
 func ErrorShellCompletionNotSupported(shell string) error {
 	return errors.WithStack(&errors.Error{
 		Kind:    ErrShellCompletionNotSupported,
-		Message: fmt.Sprintf("shell completion for %s is not supported", shell),
+		Message: fmt.Sprintf("shell completion for %s is not supported (only bash and zsh are supported)", shell),
+	})
+}
+
+func ErrorNoTerminalWidth() error {
+	return errors.WithStack(&errors.Error{
+		Kind:    ErrNoTerminalWidth,
+		Message: "unable to determine terminal width; please re-run the command without the `--watch` flag",
+	})
+}
+
+func ErrorDeployFromTopLevelDir(genericDirName string, providerType types.ProviderType) error {
+	targetStr := "cluster"
+	if providerType == types.LocalProviderType {
+		targetStr = "API container"
+	}
+	return errors.WithStack(&errors.Error{
+		Kind:    ErrDeployFromTopLevelDir,
+		Message: fmt.Sprintf("cannot deploy from your %s directory - when deploying your API, cortex sends all files in your project directory (i.e. the directory which contains cortex.yaml) to your %s (see https://docs.cortex.dev/v/%s/deployments/predictors#project-files); therefore it is recommended to create a subdirectory for your project files", genericDirName, targetStr, consts.CortexVersionMinor),
 	})
 }

cli/cmd/lib_cluster_config.go

@@ -169,6 +169,7 @@ func getInstallClusterConfig(awsCreds AWSCredentials, envName string, disallowPr
 
 	err = clusterConfig.Validate(awsClient)
 	if err != nil {
+		err = errors.Append(err, fmt.Sprintf("\n\ncluster configuration schema can be found here: https://docs.cortex.dev/v/%s/cluster-management/config", consts.CortexVersionMinor))
 		if _flagClusterConfig != "" {
 			err = errors.Wrap(err, _flagClusterConfig)
 		}
@@ -234,6 +235,7 @@ func getConfigureClusterConfig(cachedClusterConfig clusterconfig.Config, awsCred
 
 	err = userClusterConfig.Validate(awsClient)
 	if err != nil {
+		err = errors.Append(err, fmt.Sprintf("\n\ncluster configuration schema can be found here: https://docs.cortex.dev/v/%s/cluster-management/config", consts.CortexVersionMinor))
 		if _flagClusterConfig != "" {
 			err = errors.Wrap(err, _flagClusterConfig)
 		}

cli/cmd/lib_watch.go

@@ -73,6 +73,9 @@ func rerun(f func() (string, error)) {
 			nextStrSlice := strings.Split(nextStr, "\n")
 
 			terminalWidth := getTerminalWidth()
+			if terminalWidth <= 0 {
+				exit.Error(ErrorNoTerminalWidth())
+			}
 
 			nextNumLines := 0
 			for _, strLine := range nextStrSlice {

cli/cmd/root.go

@@ -41,6 +41,7 @@ var (
 	_emailPath     string
 	_debugPath     string
 	_cwd           string
+	_homeDir       string
 )
 
 type commandType int
@@ -63,6 +64,7 @@ func init() {
 		err := errors.Wrap(err, "unable to determine home directory")
 		exit.Error(err)
 	}
+	_homeDir = s.EnsureSuffix(homeDir, "/")
 
 	_localDir = filepath.Join(homeDir, ".cortex")
 	err = os.MkdirAll(_localDir, os.ModePerm)

cli/local/deploy.go

@@ -17,9 +17,11 @@ limitations under the License.
 package local
 
 import (
+	"fmt"
 	"path/filepath"
 
 	"github.com/cortexlabs/cortex/cli/types/cliconfig"
+	"github.com/cortexlabs/cortex/pkg/consts"
 	"github.com/cortexlabs/cortex/pkg/lib/aws"
 	"github.com/cortexlabs/cortex/pkg/lib/docker"
 	"github.com/cortexlabs/cortex/pkg/lib/errors"
@@ -65,6 +67,7 @@ func Deploy(env cliconfig.Environment, absoluteConfigPath string, projectFileLis
 
 	err = ValidateLocalAPIs(apiConfigs, projectFiles, awsClient)
 	if err != nil {
+		err = errors.Append(err, fmt.Sprintf("\n\napi configuration schema can be found here: https://docs.cortex.dev/v/%s/deployments/api-configuration", consts.CortexVersionMinor))
 		return schema.DeployResponse{}, err
 	}
 

pkg/operator/endpoints/deploy.go

@@ -17,8 +17,10 @@ limitations under the License.
 package endpoints
 
 import (
+	"fmt"
 	"net/http"
 
+	"github.com/cortexlabs/cortex/pkg/consts"
 	"github.com/cortexlabs/cortex/pkg/lib/errors"
 	"github.com/cortexlabs/cortex/pkg/lib/files"
 	"github.com/cortexlabs/cortex/pkg/lib/hash"
@@ -73,6 +75,7 @@ func Deploy(w http.ResponseWriter, r *http.Request) {
 
 	err = operator.ValidateClusterAPIs(apiConfigs, projectFiles)
 	if err != nil {
+		err = errors.Append(err, fmt.Sprintf("\n\napi configuration schema can be found here: https://docs.cortex.dev/v/%s/deployments/api-configuration", consts.CortexVersionMinor))
 		respondError(w, r, err)
 		return
 	}

pkg/operator/endpoints/errors.go

@@ -75,7 +75,7 @@ func ErrorAuthInvalid() error {
 func ErrorAuthOtherAccount() error {
 	return errors.WithStack(&errors.Error{
 		Kind:    ErrAuthOtherAccount,
-		Message: "AWS account associated with CLI AWS credentials differs from account associated with cluster AWS credentials; run `cortex env configure` to configure your environment with credentials for any IAM user in the same AWS account as your cluster",
+		Message: "the AWS account associated with your CLI's AWS credentials differs from the AWS account associated with your cluster's AWS credentials; run `cortex env configure` to configure your environment with credentials for any IAM user in the same AWS account as your cluster",
 	})
 }
 

pkg/types/clusterconfig/errors.go

@@ -112,10 +112,10 @@ func ErrorIncompatibleSpotInstanceTypeInf(suggested aws.InstanceMetadata) error
 	})
 }
 
-func ErrorSpotPriceGreaterThanTargetOnDemand(suggestedSpotPrice float64, target aws.InstanceMetadata, suggested aws.InstanceMetadata) error {
+func ErrorSpotPriceGreaterThanTargetOnDemand(spotPrice float64, target aws.InstanceMetadata, suggested aws.InstanceMetadata) error {
 	return errors.WithStack(&errors.Error{
 		Kind:    ErrSpotPriceGreaterThanTargetOnDemand,
-		Message: fmt.Sprintf("%s will not be allocated because its current spot price is $%g which is greater than %s's on-demand price of $%g", suggested.Type, suggestedSpotPrice, target.Type, target.Price),
+		Message: fmt.Sprintf("%s will not be allocated because its current spot price is $%g which is greater than %s's on-demand price of $%g", suggested.Type, spotPrice, target.Type, target.Price),
 	})
 }
 
@@ -136,7 +136,7 @@ func ErrorInstanceTypeNotSupported(instanceType string) error {
 func ErrorConfiguredWhenSpotIsNotEnabled(configKey string) error {
 	return errors.WithStack(&errors.Error{
 		Kind:    ErrConfiguredWhenSpotIsNotEnabled,
-		Message: fmt.Sprintf("%s cannot be specified unless spot is enabled", configKey),
+		Message: fmt.Sprintf("%s cannot be specified unless spot is enabled (to enable spot instances, set `%s: true` in your cluster configuration file)", configKey, SpotKey),
 	})
 }