Add use command, with local/remote files and attach support

Author: stuartpa

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

@@ -8,18 +8,15 @@ import (
 	"runtime"
 	"strings"
 
-	"github.com/microsoft/go-sqlcmd/cmd/modern/root/open"
 	"github.com/microsoft/go-sqlcmd/cmd/modern/sqlconfig"
 	"github.com/microsoft/go-sqlcmd/internal/cmdparser"
-	"github.com/microsoft/go-sqlcmd/internal/cmdparser/dependency"
 	"github.com/microsoft/go-sqlcmd/internal/config"
 	"github.com/microsoft/go-sqlcmd/internal/container"
 	"github.com/microsoft/go-sqlcmd/internal/localizer"
 	"github.com/microsoft/go-sqlcmd/internal/output"
 	"github.com/microsoft/go-sqlcmd/internal/pal"
 	"github.com/microsoft/go-sqlcmd/internal/secret"
 	"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"
@@ -246,20 +243,6 @@ func (c *MssqlBase) AddFlags(
 		Name:          "use-mechanism",
 		Usage:         localizer.Sprintf("Mechanism to use to bring database online (%s)", strings.Join(mechanism.Mechanisms(), ",")),
 	})
-
-	addFlag(cmdparser.FlagOptions{
-		String:        &c.openTool,
-		DefaultString: "",
-		Name:          "open",
-		Usage:         localizer.Sprintf("Open tool e.g. ads"),
-	})
-
-	addFlag(cmdparser.FlagOptions{
-		String:        &c.openFile,
-		DefaultString: "",
-		Name:          "open-file",
-		Usage:         localizer.Sprintf("Open file in tool e.g. https://aks.ms/adventureworks-demo.sql"),
-	})
 }
 
 // Run checks that the end-user license agreement has been accepted,
@@ -401,11 +384,6 @@ func (c *MssqlBase) createContainer(imageName string, contextName string) {
 		}
 		useDatabase.CopyToContainer(containerId)
 
-		if useDatabase.IsExtractionNeeded() {
-			output.Infof("Extracting files from %q archive", useDatabase.UrlFilename())
-			useDatabase.Extract()
-		}
-
 		output.Infof("Bringing database %q online", useDatabase.DatabaseName())
 		useDatabase.BringOnline(c.sql.Query, contextOptions.Username, contextOptions.Password)
 	}
@@ -440,41 +418,6 @@ func (c *MssqlBase) createContainer(imageName string, contextName string) {
 				c.port),
 		)
 	}
-
-	if c.openTool == "ads" {
-		ads := open.Ads{}
-		ads.SetCrossCuttingConcerns(dependency.Options{
-			EndOfLine: pal.LineBreak(),
-			Output:    c.Output(),
-		})
-
-		user := &sqlconfig.User{
-			AuthenticationType: "basic",
-			BasicAuth: &sqlconfig.BasicAuthDetails{
-				Username:           contextOptions.Username,
-				PasswordEncryption: c.passwordEncryption,
-				Password:           secret.Encode(contextOptions.Password, c.passwordEncryption)},
-			Name: contextOptions.Username}
-
-		ads.PersistCredentialForAds(endpoint.EndpointDetails.Address, endpoint, user)
-
-		output := c.Output()
-		args := []string{"-r", fmt.Sprintf("--server=%s", fmt.Sprintf(
-			"%s,%d",
-			"127.0.0.1",
-			c.port))}
-
-		args = append(args, fmt.Sprintf("--user=%s",
-			strings.Replace(contextOptions.Username, `"`, `\"`, -1)))
-
-		tool := tools.NewTool("ads")
-		if !tool.IsInstalled() {
-			output.Fatalf(tool.HowToInstall())
-		}
-
-		_, err := tool.Run(args)
-		c.CheckErr(err)
-	}
 }
 
 func (c *MssqlBase) verifyUseSourceFileExists(

cmd/modern/root/open/ads.go

@@ -46,7 +46,7 @@ func (c *Ads) run() {
 	// If basic auth is used, we need to persist the password in the OS in a way
 	// that ADS can access it.  The method used is OS specific.
 	if user != nil && user.AuthenticationType == "basic" {
-		c.PersistCredentialForAds(endpoint.EndpointDetails.Address, endpoint, user)
+		c.persistCredentialForAds(endpoint.EndpointDetails.Address, endpoint, user)
 		c.launchAds(endpoint.EndpointDetails.Address, endpoint.EndpointDetails.Port, user.BasicAuth.Username)
 	} else {
 		c.launchAds(endpoint.EndpointDetails.Address, endpoint.EndpointDetails.Port, "")
@@ -75,7 +75,6 @@ func (c *Ads) launchAds(host string, port int, username string) {
 				port)),
 	}
 
-	// If a username is specified, use that (basic auth), otherwise use integrated auth
 	if username != "" {
 
 		// Here's a fun SQL Server behavior  - it allows you to create database

cmd/modern/root/open/ads_windows.go

@@ -28,9 +28,9 @@ func (c *Ads) displayPreLaunchInfo() {
 	output.Infof("Press Ctrl+C to exit this process...")
 }
 
-// PersistCredentialForAds stores a SQL password in the Windows Credential Manager
+// persistCredentialForAds stores a SQL password in the Windows Credential Manager
 // for the given hostname and endpoint.
-func (c *Ads) PersistCredentialForAds(
+func (c *Ads) persistCredentialForAds(
 	hostname string,
 	endpoint sqlconfig.Endpoint,
 	user *sqlconfig.User,

cmd/modern/root/open/ads_windows_test.go

@@ -27,7 +27,7 @@ func TestPersistCredentialForAds(t *testing.T) {
 			PasswordEncryption: "none",
 		},
 	}
-	ads.PersistCredentialForAds("localhost", sqlconfig.Endpoint{
+	ads.persistCredentialForAds("localhost", sqlconfig.Endpoint{
 		EndpointDetails: sqlconfig.EndpointDetails{
 			Port: 1433,
 		},

cmd/modern/root/use.go

@@ -8,9 +8,12 @@ import (
 	"github.com/microsoft/go-sqlcmd/internal/cmdparser"
 	"github.com/microsoft/go-sqlcmd/internal/config"
 	"github.com/microsoft/go-sqlcmd/internal/container"
+	"github.com/microsoft/go-sqlcmd/internal/localizer"
 	"github.com/microsoft/go-sqlcmd/internal/secret"
 	"github.com/microsoft/go-sqlcmd/internal/sql"
 	"github.com/microsoft/go-sqlcmd/pkg/mssqlcontainer/ingest"
+	"github.com/microsoft/go-sqlcmd/pkg/mssqlcontainer/ingest/mechanism"
+	"strings"
 )
 
 type Use struct {
@@ -48,7 +51,7 @@ func (c *Use) DefineCommand(...cmdparser.CommandOptions) {
 		String:        &c.useMechanism,
 		DefaultString: "",
 		Name:          "use-mechanism",
-		Usage:         "Mechanism to use to bring database online (attach, restore, dacfx)",
+		Usage:         localizer.Sprintf("Mechanism to use to bring database online (%s)", strings.Join(mechanism.Mechanisms(), ",")),
 	})
 }
 
@@ -81,12 +84,7 @@ func (c *Use) run() {
 
 	// 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())
-		useDatabase.Extract()
-	}
-
+	
 	output.output.Infof("Bringing %q online using %q method",
 		useDatabase.DatabaseName(),
 		useDatabase.OnlineMethod(),

internal/cmdparser/options.go

@@ -13,22 +13,19 @@ type AlternativeForFlagOptions struct {
 	Value *string
 }
 
-// FlagOptions type represents options for defining a flag for a command-line
-// interface. The Name and Shorthand fields specify the long and short names
-// for the flag, respectively. The Usage field is a string that describes how the
-// flag should be used. The String, DefaultString, Int, DefaultInt, Bool, and
-// DefaultBool fields are used to specify the type and default value of the flag,
-// if it is a string, int, or bool type. The String and Int fields should be pointers
-// to the variables that will store the flag's value, and the Bool field should be
-// a pointer to a bool variable that will be set to true if the flag is present. The
-// DefaultString, DefaultInt, and DefaultBool fields are the default values to
-// use if the flag is not provided by the user.
+// FlagOptions type represents options for defining a flag for a CLI. The Name
+// and Shorthand fields specify the long and short names for the flag, respectively.
+// The Usage field is a string that describes how the flag should be used. If you
+// want the flag hidden from the --help, see the Hidden field to true.
+// The String, DefaultString, Int, DefaultInt, Bool, and  DefaultBool fields are
+// used to specify the type and default value of the flag, use only one of these pairs
+// (the one that match the type for the flag value).
 type FlagOptions struct {
-	Name      string
-	Shorthand string
-	Usage     string
+	Name      string // e.g. --database
+	Shorthand string // e.g. -d
+	Usage     string // e.g. "The database to connect to"
 
-	Hidden bool
+	Hidden bool // hide the flag from help (use for deprecated flags)
 
 	String        *string
 	DefaultString string

internal/container/controller.go

@@ -8,7 +8,6 @@ import (
 	"bufio"
 	"bytes"
 	"context"
-	"fmt"
 	"github.com/docker/docker/api/types"
 	"github.com/docker/docker/api/types/container"
 	"github.com/docker/docker/api/types/filters"
@@ -289,11 +288,6 @@ func (c Controller) DownloadFile(id string, src string, destFolder string) {
 	c.RunCmdInContainer(id, cmd, ExecOptions{})
 }
 
-type ExecOptions struct {
-	User string
-	Env  []string
-}
-
 func (c Controller) RunCmdInContainer(
 	id string,
 	cmd []string,
@@ -339,7 +333,6 @@ func (c Controller) RunCmdInContainer(
 	stderr, err := io.ReadAll(&errBuf)
 	checkErr(err)
 
-	trace(fmt.Sprintf("Err: %v", err))
 	trace("Stdout: " + string(stdout))
 	trace("Stderr: " + string(stderr))
 

internal/container/types.go

@@ -10,3 +10,8 @@ type RunOptions struct {
 	Command         []string
 	UnitTestFailure bool
 }
+
+type ExecOptions struct {
+	User string
+	Env  []string
+}

internal/output/output.go

@@ -215,10 +215,6 @@ func (o Output) maskSecrets(text string) string {
 	r := regexp.MustCompile(`(PASSWORD.*\s?=.*\s?N?')(.*)(')`)
 	text = r.ReplaceAllString(text, "$1********$3")
 
-	// Mask password from sqlpackage.exe command line e.g. /TargetPassword:foo
-	r = regexp.MustCompile(`(/TargetPassword:)(.*)`)
-	text = r.ReplaceAllString(text, "$1********$3")
-
 	return text
 }