Saving changes

Author: stuartpa

cmd/modern/main.go

@@ -95,9 +95,7 @@ func initializeEnvVars() {
 				os.Setenv("SQLCMDPASSWORD", password)
 			}
 		}
-
 	}
-
 }
 
 // isFirstArgModernCliSubCommand is TEMPORARY code, to be removed when

cmd/modern/root.go

@@ -67,15 +67,10 @@ func (c *Root) SubCommands() []cmdparser.Command {
 		cmdparser.New[*root.Query](dependencies),
 		cmdparser.New[*root.Start](dependencies),
 		cmdparser.New[*root.Stop](dependencies),
+		cmdparser.New[*root.Use](dependencies),
 		cmdparser.New[*root.Uninstall](dependencies),
 	}
 
-	// If the current context is a container, then add the "use" sub-command, so
-	// databases can be added to the already existing container.
-	if config.CurrentContextEndpointHasContainer() {
-		subCommands = append(subCommands, cmdparser.New[*root.Use](dependencies))
-	}
-
 	// BUG(stuartpa): - Add Linux support
 	if runtime.GOOS == "windows" || runtime.GOOS == "darwin" {
 		subCommands = append(subCommands, cmdparser.New[*root.Open](dependencies))

cmd/modern/root/install/mssql-base.go

@@ -5,7 +5,6 @@ package install
 
 import (
 	"fmt"
-	"github.com/microsoft/go-sqlcmd/pkg/mssqlcontainer/ingest/mechanism"
 	"runtime"
 	"strings"
 
@@ -21,6 +20,7 @@ import (
 	"github.com/microsoft/go-sqlcmd/internal/sql"
 	"github.com/microsoft/go-sqlcmd/internal/tools"
 	"github.com/microsoft/go-sqlcmd/pkg/mssqlcontainer/ingest"
+	"github.com/microsoft/go-sqlcmd/pkg/mssqlcontainer/ingest/mechanism"
 	"github.com/spf13/viper"
 )
 
@@ -350,15 +350,17 @@ func (c *MssqlBase) createContainer(imageName string, contextName string) {
 
 	// Save the config now, so user can uninstall/delete, even if mssql in the container
 	// fails to start
-	config.AddContextWithContainer(
-		contextName,
-		imageName,
-		c.port,
-		containerId,
-		userName,
-		password,
-		c.passwordEncryption,
-	)
+
+	contextOptions := config.ContextOptions{
+		ImageName:          imageName,
+		PortNumber:         c.port,
+		ContainerId:        containerId,
+		Username:           userName,
+		Password:           password,
+		PasswordEncryption: c.passwordEncryption,
+	}
+
+	config.AddContextWithContainer(contextName, contextOptions)
 
 	output.Infof(
 		"Created context %q in \"%s\", configuring user account...",
@@ -378,11 +380,11 @@ func (c *MssqlBase) createContainer(imageName string, contextName string) {
 	//
 	// For Unit Testing we use the Docker Hello World container, which
 	// starts much faster than the SQL Server container!
+	sqlOptions := sql.SqlOptions{}
 	if c.errorLogEntryToWaitFor == "Hello from Docker!" {
-		c.sql = sql.New(sql.SqlOptions{UnitTesting: true})
-	} else {
-		c.sql = sql.New(sql.SqlOptions{UnitTesting: false})
+		sqlOptions.UnitTesting = true
 	}
+	c.sql = sql.New(sqlOptions)
 
 	saUser := &sqlconfig.User{
 		AuthenticationType: "basic",

cmd/modern/root/use.go

@@ -51,15 +51,17 @@ func (c *Use) DefineCommand(...cmdparser.CommandOptions) {
 }
 
 func (c *Use) run() {
-	output := c.Output()
+	output := useOutput{output: c.Output()}
 
 	controller := container.NewController()
 	id := config.ContainerId()
 
+	if !config.CurrentContextEndpointHasContainer() {
+		output.FatalNoContainerInCurrentContext()
+	}
+
 	if !controller.ContainerRunning(id) {
-		output.FatalfWithHintExamples([][]string{
-			{"Start container for current context", "sqlcmd start"},
-		}, "Container for current context is not running")
+		output.FatalContainerNotRunning()
 	}
 
 	endpoint, user := config.CurrentContext()
@@ -72,16 +74,14 @@ func (c *Use) run() {
 	})
 
 	if !useDatabase.SourceFileExists() {
-		output.FatalfWithHints(
-			[]string{fmt.Sprintf("File does not exist at URL %q", c.url)},
-			"Unable to download file to container")
+		output.FatalDatabaseSourceFileNotExist(c.url)
 	}
 
 	// Copy source file (e.g. .bak/.bacpac etc.) for database to be made available to container
 	useDatabase.CopyToContainer(id)
 
 	if useDatabase.IsExtractionNeeded() {
-		output.Infof("Extracting files from %q", useDatabase.UrlFilename())
+		output.output.Infof("Extracting files from %q", useDatabase.UrlFilename())
 		useDatabase.Extract()
 	}
 

cmd/modern/root/use_output.go

@@ -0,0 +1,29 @@
+package root
+
+import (
+	"fmt"
+	"github.com/microsoft/go-sqlcmd/internal/output"
+)
+
+type useOutput struct {
+	*output.Output
+	output *output.Output
+}
+
+func (u *useOutput) FatalNoContainerInCurrentContext() {
+	u.output.FatalfWithHintExamples([][]string{
+		{"Create a context with a container", "sqlcmd create mssql"},
+	}, "Current context does not have a container")
+}
+
+func (u *useOutput) FatalContainerNotRunning() {
+	u.output.FatalfWithHintExamples([][]string{
+		{"Start container for current context", "sqlcmd start"},
+	}, "Container for current context is not running")
+}
+
+func (u *useOutput) FatalDatabaseSourceFileNotExist(url string) {
+	u.output.FatalfWithHints(
+		[]string{fmt.Sprintf("File does not exist at URL %q", url)},
+		"Unable to download file to container")
+}

internal/cmdparser/cmd.go

@@ -87,7 +87,7 @@ func (c *Cmd) AddFlag(options FlagOptions) {
 	}
 
 	if options.Hidden {
-		c.command.Flags().MarkHidden(options.Name)
+		c.command.PersistentFlags().MarkHidden(options.Name)
 	}
 }
 

internal/config/config.go

@@ -92,47 +92,42 @@ func IsEmpty() (isEmpty bool) {
 // requested. The updated configuration is saved to file.
 func AddContextWithContainer(
 	contextName string,
-	imageName string,
-	portNumber int,
-	containerId string,
-	username string,
-	password string,
-	passwordEncryption string,
+	options ContextOptions,
 ) {
-	if containerId == "" {
+	if options.ContainerId == "" {
 		panic("containerId must be provided")
 	}
-	if imageName == "" {
+	if options.ImageName == "" {
 		panic("imageName must be provided")
 	}
-	if portNumber == 0 {
+	if options.PortNumber == 0 {
 		panic("portNumber must be non-zero")
 	}
-	if username == "" {
+	if options.Username == "" {
 		panic("username must be provided")
 	}
-	if password == "" {
+	if options.Password == "" {
 		panic("password must be provided")
 	}
 	if contextName == "" {
 		panic("contextName must be provided")
 	}
 
-	contextName = FindUniqueContextName(contextName, username)
+	contextName = FindUniqueContextName(contextName, options.Username)
 	endPointName := FindUniqueEndpointName(contextName)
-	userName := username + "@" + contextName
+	userName := options.Username + "@" + contextName
 
 	config.CurrentContext = contextName
 
 	config.Endpoints = append(config.Endpoints, Endpoint{
 		AssetDetails: &AssetDetails{
 			ContainerDetails: &ContainerDetails{
-				Id:    containerId,
-				Image: imageName},
+				Id:    options.ContainerId,
+				Image: options.ImageName},
 		},
 		EndpointDetails: EndpointDetails{
 			Address: "127.0.0.1",
-			Port:    portNumber,
+			Port:    options.PortNumber,
 		},
 		Name: endPointName,
 	})
@@ -148,9 +143,9 @@ func AddContextWithContainer(
 	user := User{
 		AuthenticationType: "basic",
 		BasicAuth: &BasicAuthDetails{
-			Username:           username,
-			PasswordEncryption: passwordEncryption,
-			Password:           encryptCallback(password, passwordEncryption),
+			Username:           options.Username,
+			PasswordEncryption: options.PasswordEncryption,
+			Password:           encryptCallback(options.Password, options.PasswordEncryption),
 		},
 		Name: userName,
 	}

internal/config/config_test.go

@@ -131,7 +131,16 @@ func TestConfig(t *testing.T) {
 			ContainerId()
 			RemoveCurrentContext()
 			RemoveCurrentContext()
-			AddContextWithContainer("context", "imageName", 1433, "containerId", "user", "password", "none")
+
+			options := ContextOptions{
+				ImageName:          "imageName",
+				PortNumber:         1433,
+				ContainerId:        "containerId",
+				Username:           "user",
+				Password:           "password",
+				PasswordEncryption: "none",
+			}
+			AddContextWithContainer("context", options)
 			RemoveCurrentContext()
 			DeleteEndpoint("endpoint")
 			DeleteContext("context")
@@ -324,7 +333,15 @@ func TestAddContextWithContainerPanic(t *testing.T) {
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
 			assert.Panics(t, func() {
-				AddContextWithContainer(tt.args.contextName, tt.args.imageName, tt.args.portNumber, tt.args.containerId, tt.args.username, tt.args.password, tt.args.passwordEncryption)
+				options := ContextOptions{
+					ImageName:          tt.args.imageName,
+					PortNumber:         tt.args.portNumber,
+					ContainerId:        tt.args.containerId,
+					Username:           tt.args.username,
+					Password:           tt.args.password,
+					PasswordEncryption: tt.args.passwordEncryption,
+				}
+				AddContextWithContainer(tt.args.contextName, options)
 			})
 		})
 	}

internal/config/endpoint-container.go

@@ -43,7 +43,7 @@ func CurrentContextEndpointHasContainer() (exists bool) {
 	currentContextName := config.CurrentContext
 
 	if currentContextName == "" {
-		panic("currentContextName must not be empty")
+		return false
 	}
 
 	for _, c := range config.Contexts {

internal/config/types.go

@@ -0,0 +1,10 @@
+package config
+
+type ContextOptions struct {
+	ImageName          string
+	PortNumber         int
+	ContainerId        string
+	Username           string
+	Password           string
+	PasswordEncryption string
+}