Merge pull request #240 from microsoft/stuartpa/bug-bash-feedback

Stuartpa/bug bash feedback

Author: stuartpa

cmd/modern/root.go

@@ -25,7 +25,7 @@ type Root struct {
 // It also provides usage examples for sqlcmd.
 func (c *Root) DefineCommand(...cmdparser.CommandOptions) {
 	// Example usage steps
-	steps := []string{"sqlcmd create mssql --using https://aka.ms/AdventureWorksLT.bak"}
+	steps := []string{"sqlcmd create mssql --accept-eula --using https://aka.ms/AdventureWorksLT.bak"}
 
 	if runtime.GOOS == "windows" {
 		steps = append(steps, "sqlcmd open ads")
@@ -39,8 +39,11 @@ func (c *Root) DefineCommand(...cmdparser.CommandOptions) {
 		Steps:       steps}}
 
 	commandOptions := cmdparser.CommandOptions{
-		Use:         "sqlcmd",
-		Short:       "sqlcmd: Install/Create/Query SQL Server, Azure SQL, and Tools",
+		Use: "sqlcmd",
+		Short: `sqlcmd: Install/Create/Query SQL Server, Azure SQL, and Tools
+
+Feedback:
+  https://github.com/microsoft/go-sqlcmd/issues/new`,
 		SubCommands: c.SubCommands(),
 		Examples:    examples,
 	}
@@ -86,6 +89,18 @@ func (c *Root) IsValidSubCommand(command string) bool {
 }
 
 func (c *Root) addGlobalFlags() {
+
+	// BUG:(stuartpa) - This is a temporary flag until we have migrated
+	// the kong impl to cobra.  sqlcmd -? will show the kong help (all the back-compat
+	// flags), sqlcmd --? will show the kong "did you mean one of" help.
+	var unused bool
+	c.AddFlag(cmdparser.FlagOptions{
+		Bool:      &unused,
+		Name:      "?",
+		Shorthand: "?",
+		Usage:     "help for backwards compatibility flags (-S, -U, -E etc.)",
+	})
+
 	c.AddFlag(cmdparser.FlagOptions{
 		String:        &c.configFilename,
 		DefaultString: config.DefaultFileName(),

cmd/modern/root/config.go

@@ -4,8 +4,10 @@
 package root
 
 import (
+	"fmt"
 	"github.com/microsoft/go-sqlcmd/cmd/modern/root/config"
 	"github.com/microsoft/go-sqlcmd/internal/cmdparser"
+	"github.com/microsoft/go-sqlcmd/internal/pal"
 )
 
 // Config defines the `sqlcmd config` sub-commands
@@ -20,6 +22,17 @@ func (c *Config) DefineCommand(...cmdparser.CommandOptions) {
 		Use:         "config",
 		Short:       `Modify sqlconfig files using subcommands like "sqlcmd config use-context mssql"`,
 		SubCommands: c.SubCommands(),
+		Examples: []cmdparser.ExampleOptions{
+			{
+				Description: "Add context for existing endpoint and user",
+				Steps: []string{
+					fmt.Sprintf("%s SQLCMD_PASSWORD=<password>", pal.CreateEnvVarKeyword()),
+					"sqlcmd config add-user --name sa1434 --username sa",
+					fmt.Sprintf("%s SQLCMD_PASSWORD=", pal.CreateEnvVarKeyword()),
+					"sqlcmd config add-endpoint --name ep1434 --address localhost --port 1434",
+					"sqlcmd config add-context --name mssql1434 --user sa1434 --endpoint ep1434"},
+			},
+		},
 	}
 
 	c.Cmd.DefineCommand(options)

cmd/modern/root/config/add-context.go

@@ -26,8 +26,10 @@ func (c *AddContext) DefineCommand(...cmdparser.CommandOptions) {
 		Short: "Add a context",
 		Examples: []cmdparser.ExampleOptions{
 			{
-				Description: "Add a default context",
-				Steps:       []string{"sqlcmd config add-context --name my-context"}},
+				Description: "Add a context for a local instance of SQL Server on port 1433 using trusted authentication",
+				Steps: []string{
+					"sqlcmd config add-endpoint --name localhost-1433",
+					"sqlcmd config add-context --name mssql --endpoint localhost-1433"}},
 		},
 		Run: c.run}
 
@@ -42,12 +44,12 @@ func (c *AddContext) DefineCommand(...cmdparser.CommandOptions) {
 	c.AddFlag(cmdparser.FlagOptions{
 		String: &c.endpointName,
 		Name:   "endpoint",
-		Usage:  "Name of endpoint this context will use, use `sqlcmd config get-endpoints` to see list"})
+		Usage:  "Name of endpoint this context will use"})
 
 	c.AddFlag(cmdparser.FlagOptions{
 		String: &c.userName,
 		Name:   "user",
-		Usage:  "Name of user this context will use, use `sqlcmd config get-users` to see list"})
+		Usage:  "Name of user this context will use"})
 }
 
 // run adds a context to the configuration and sets it as the current context. The

cmd/modern/root/config/add-user.go

@@ -4,7 +4,9 @@
 package config
 
 import (
+	"fmt"
 	"github.com/microsoft/go-sqlcmd/cmd/modern/sqlconfig"
+	"github.com/microsoft/go-sqlcmd/internal/pal"
 	"os"
 
 	"github.com/microsoft/go-sqlcmd/internal/cmdparser"
@@ -30,8 +32,10 @@ func (c *AddUser) DefineCommand(...cmdparser.CommandOptions) {
 			{
 				Description: "Add a user",
 				Steps: []string{
-					`SET SQLCMD_PASSWORD="AComp!exPa$$w0rd"`,
-					"sqlcmd config add-user --name my-user --name user1"},
+					fmt.Sprintf(`%s SQLCMD_PASSWORD=<password>`, pal.CreateEnvVarKeyword()),
+					"sqlcmd config add-user --name my-user --username user1",
+					fmt.Sprintf(`%s SQLCMD_PASSWORD=`, pal.CreateEnvVarKeyword()),
+				},
 			},
 		},
 		Run: c.run}

cmd/modern/root/config/add-user_windows.go

@@ -9,6 +9,6 @@ func (c *AddUser) encryptPasswordFlag() {
 	c.AddFlag(cmdparser.FlagOptions{
 		Bool:  &c.encryptPassword,
 		Name:  "encrypt-password",
-		Usage: "Encode the password",
+		Usage: "Encrypt the password",
 	})
 }

cmd/modern/root/config/delete-context.go

@@ -64,7 +64,7 @@ func (c *DeleteContext) run() {
 
 		if c.cascade {
 			config.DeleteEndpoint(context.Endpoint)
-			if *context.ContextDetails.User != "" {
+			if context.ContextDetails.User != nil && *context.ContextDetails.User != "" {
 				config.DeleteUser(*context.ContextDetails.User)
 			}
 		}

cmd/modern/root/config/view.go

@@ -21,15 +21,15 @@ func (c *View) DefineCommand(...cmdparser.CommandOptions) {
 		Short: "Display merged sqlconfig settings or a specified sqlconfig file",
 		Examples: []cmdparser.ExampleOptions{
 			{
-				Description: "Show merged sqlconfig settings",
+				Description: "Show sqlconfig settings, with REDACTED authentication data",
 				Steps:       []string{"sqlcmd config view"},
 			},
 			{
-				Description: "Show merged sqlconfig settings and raw authentication data",
+				Description: "Show sqlconfig settings and raw authentication data",
 				Steps:       []string{"sqlcmd config view --raw"},
 			},
 		},
-		Aliases: []string{"use", "change-context", "set-context"},
+		Aliases: []string{"show"},
 		Run:     c.run,
 	}
 

cmd/modern/root/open/ads_windows.go

@@ -77,6 +77,13 @@ func (c *Ads) removePreviousCredential() {
 
 // writeCredential stores the current instance's credential in the Windows Credential Manager
 func (c *Ads) writeCredential() {
+	output := c.Output()
+
 	err := credman.WriteCredential(&c.credential, credman.CredTypeGeneric)
-	c.CheckErr(err)
+	if err != nil {
+		output.FatalfErrorWithHints(
+			err,
+			[]string{"A 'Not enough memory resources are available' error can be caused by too many credentials already stored in Windows Credential Manager"},
+			"Failed to write credential to Windows Credential Manager")
+	}
 }

cmd/modern/root/uninstall.go

@@ -5,7 +5,6 @@ package root
 
 import (
 	"fmt"
-	"path/filepath"
 	"strings"
 
 	"github.com/microsoft/go-sqlcmd/internal/cmdparser"
@@ -158,7 +157,7 @@ func (c *Uninstall) userDatabaseSafetyCheck(controller *container.Controller, id
 				output.FatalfWithHints([]string{
 					fmt.Sprintf(
 						"If the database is mounted, run `sqlcmd query \"use master; DROP DATABASE [%s]\"`",
-						strings.TrimSuffix(filepath.Base(databaseFile), ".mdf")),
+						"<database_name>"),
 					"Pass in the flag --force to override this safety check for user (non-system) databases"},
 					"Unable to continue, a user (non-system) database (%s) is present", databaseFile)
 			}

cmd/modern/sqlconfig/sqlconfig.go

@@ -31,7 +31,7 @@ type Endpoint struct {
 
 type ContextDetails struct {
 	Endpoint string  `mapstructure:"endpoint"`
-	User     *string `mapstructure:"user,omitempty"`
+	User     *string `mapstructure:"user,omitempty" yaml:"user,omitempty"`
 }
 
 type Context struct {