Add sqlcmd use

Author: stuartpa

cmd/modern/root.go

@@ -68,6 +68,7 @@ func (c *Root) SubCommands() []cmdparser.Command {
 		cmdparser.New[*root.Start](dependencies),
 		cmdparser.New[*root.Stop](dependencies),
 		cmdparser.New[*root.Uninstall](dependencies),
+		cmdparser.New[*root.Use](dependencies),
 	}
 
 	// BUG(stuartpa): - Add Linux support

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

@@ -11,11 +11,12 @@ import (
 	"github.com/microsoft/go-sqlcmd/internal/tools"
 	"net/url"
 	"os"
-	"path"
 	"path/filepath"
 	"runtime"
 	"strings"
 
+	"github.com/microsoft/go-sqlcmd/pkg/mssqlcontainer"
+
 	"github.com/microsoft/go-sqlcmd/cmd/modern/root/open"
 
 	"github.com/microsoft/go-sqlcmd/cmd/modern/sqlconfig"
@@ -224,7 +225,7 @@ func (c *MssqlBase) AddFlags(
 		String:        &c.usingDatabaseUrl,
 		DefaultString: "",
 		Name:          "using",
-		Usage:         "Download (into container) and attach database (.bak) from URL",
+		Usage:         "Download and use database from .bak/.bacpac/.mdf/.7z URL",
 	})
 
 	addFlag(cmdparser.FlagOptions{
@@ -514,18 +515,16 @@ func (c *MssqlBase) validateUsingUrlExists() {
 	if u.Path == "" {
 		output.FatalfWithHints(
 			[]string{
-				"--using URL must have a path to .bak or .bacpac file",
+				"--using URL must have a path to .bak, .bacpac or .mdf (.7z) file",
 			},
 			"%q is not a valid URL for --using flag", c.usingDatabaseUrl)
 	}
 
-	// At the moment we only support attaching .bak files, but we should
-	// support .bacpacs and .mdfs in the future
 	_, f := filepath.Split(u.Path)
-	if filepath.Ext(f) != ".bak" && filepath.Ext(f) != ".bacpac" {
+	if filepath.Ext(f) != ".bak" && filepath.Ext(f) != ".bacpac" && filepath.Ext(f) != ".mdf" && filepath.Ext(f) != ".7z" {
 		output.FatalfWithHints(
 			[]string{
-				"--using file URL must be a .bak or .bacpac file",
+				"--using file URL must be a .bak, .bacpac, or .mdf (.7z) file",
 			},
 			"Invalid --using file type, extension %q is not supported", filepath.Ext(f))
 	}
@@ -582,47 +581,22 @@ CHECK_POLICY=OFF`
 	}
 }
 
-func getDbNameAsIdentifier(dbName string) string {
-	escapedDbNAme := strings.ReplaceAll(dbName, "'", "''")
-	return strings.ReplaceAll(escapedDbNAme, "]", "]]")
-}
-
-func getDbNameAsNonIdentifier(dbName string) string {
-	return strings.ReplaceAll(dbName, "]", "]]")
-}
-
-// parseDbName returns the databaseName from --using arg
-// It sets database name to the specified database name
-// or in absence of it, it is set to the filename without
-// extension.
-func parseDbName(usingDbUrl string) string {
-	u, _ := url.Parse(usingDbUrl)
-	dbToken := path.Base(u.Path)
-	if dbToken != "." && dbToken != "/" {
-		lastIdx := strings.LastIndex(dbToken, ".bak")
-		if lastIdx == -1 {
-			lastIdx = strings.LastIndex(dbToken, ".bacpac")
-		}
-		if lastIdx != -1 {
-			//Get file name without extension
-			fileName := dbToken[0:lastIdx]
-			lastIdx += 5
-			if lastIdx >= len(dbToken) {
-				return fileName
-			}
-			//Return database name if it was specified
-			return dbToken[lastIdx:]
-		}
-	}
-	return ""
-}
-
 func extractUrl(usingArg string) string {
 	urlEndIdx := strings.LastIndex(usingArg, ".bak")
+	if urlEndIdx == -1 {
+		urlEndIdx = strings.LastIndex(usingArg, ".mdf")
+	}
 	if urlEndIdx != -1 {
 		return usingArg[0:(urlEndIdx + 4)]
 	}
 
+	if urlEndIdx == -1 {
+		urlEndIdx = strings.LastIndex(usingArg, ".7z")
+		if urlEndIdx != -1 {
+			return usingArg[0:(urlEndIdx + 3)]
+		}
+	}
+
 	if urlEndIdx == -1 {
 		urlEndIdx = strings.LastIndex(usingArg, ".bacpac")
 		if urlEndIdx != -1 {
@@ -639,111 +613,15 @@ func (c *MssqlBase) downloadAndRestoreDb(
 	userName string,
 	password string,
 ) {
-	output := c.Cmd.Output()
-	databaseName := parseDbName(c.usingDatabaseUrl)
-	databaseUrl := extractUrl(c.usingDatabaseUrl)
-
-	_, file := filepath.Split(databaseUrl)
-
-	// Download file from URL into container
-	output.Infof("Downloading %s", file)
-
-	temporaryFolder := "/var/opt/mssql/backup"
-
-	controller.DownloadFile(
+	mssqlcontainer.DownloadAndRestoreDb(
+		controller,
 		containerId,
-		databaseUrl,
-		temporaryFolder,
-	)
-
-	dbNameAsIdentifier := getDbNameAsIdentifier(databaseName)
-	dbNameAsNonIdentifier := getDbNameAsNonIdentifier(databaseName)
-
-	u, err := url.Parse(databaseUrl)
-	c.CheckErr(err)
-
-	_, f := filepath.Split(u.Path)
-	if filepath.Ext(f) == ".bak" {
-		// Restore database from file
-		output.Infof("Restoring database %s", databaseName)
-
-		text := `SET NOCOUNT ON;
-
--- Build a SQL Statement to restore any .bak file to the Linux filesystem
-DECLARE @sql NVARCHAR(max)
-
--- This table definition works since SQL Server 2017, therefore 
--- works for all SQL Server containers (which started in 2017)
-DECLARE @fileListTable TABLE (
-    [LogicalName]           NVARCHAR(128),
-    [PhysicalName]          NVARCHAR(260),
-    [Type]                  CHAR(1),
-    [FileGroupName]         NVARCHAR(128),
-    [Size]                  NUMERIC(20,0),
-    [MaxSize]               NUMERIC(20,0),
-    [FileID]                BIGINT,
-    [CreateLSN]             NUMERIC(25,0),
-    [DropLSN]               NUMERIC(25,0),
-    [UniqueID]              UNIQUEIDENTIFIER,
-    [ReadOnlyLSN]           NUMERIC(25,0),
-    [ReadWriteLSN]          NUMERIC(25,0),
-    [BackupSizeInBytes]     BIGINT,
-    [SourceBlockSize]       INT,
-    [FileGroupID]           INT,
-    [LogGroupGUID]          UNIQUEIDENTIFIER,
-    [DifferentialBaseLSN]   NUMERIC(25,0),
-    [DifferentialBaseGUID]  UNIQUEIDENTIFIER,
-    [IsReadOnly]            BIT,
-    [IsPresent]             BIT,
-    [TDEThumbprint]         VARBINARY(32),
-    [SnapshotURL]           NVARCHAR(360)
-)
-
-INSERT INTO @fileListTable
-EXEC('RESTORE FILELISTONLY FROM DISK = ''%s/%s''')
-SET @sql = 'RESTORE DATABASE [%s] FROM DISK = ''%s/%s'' WITH '
-SELECT @sql = @sql + char(13) + ' MOVE ''' + LogicalName + ''' TO ''/var/opt/mssql/' + LogicalName + '.' + RIGHT(PhysicalName,CHARINDEX('\',PhysicalName)) + ''','
-FROM @fileListTable
-WHERE IsPresent = 1
-SET @sql = SUBSTRING(@sql, 1, LEN(@sql)-1)
-EXEC(@sql)`
-
-		c.query(fmt.Sprintf(text, temporaryFolder, file, dbNameAsIdentifier, temporaryFolder, file))
-	} else if filepath.Ext(f) == ".bacpac" {
-		// sqlpackage /a:import /SourceFile:DaasMM.bacpac
-		//	/tu:"joey"
-		//	/tp:"6%oO3L#X%d%8hAH5E*y6plD6#IV1$PEESS$ZAhC8uL#@Q@40e3"
-		//	/tsn:"localhost,1433"
-		//	/tdn:"db1"
-
-		controller.DownloadFile(
-			containerId,
-			"https://aka.ms/sqlpackage-linux",
-			"/tmp",
-		)
-
-		controller.RunCmdInContainer(containerId, []string{"apt-get", "update"})
-		controller.RunCmdInContainer(containerId, []string{"apt-get", "install", "-y", "unzip"})
-		controller.RunCmdInContainer(containerId, []string{"unzip", "/tmp/sqlpackage-linux", "-d", "/opt/sqlpackage"})
-		controller.RunCmdInContainer(containerId, []string{"chmod", "+x", "/opt/sqlpackage/sqlpackage"})
-		//controller.RunCmdInContainer(containerId, []string{"echo", `'export PATH="$PATH:/opt/sqlpackage"' >> ~/.bash_profile`})
-		//controller.RunCmdInContainer(containerId, []string{"source", "~/.bash_profile"})
-		controller.RunCmdInContainer(containerId, []string{
-			"/opt/sqlpackage/sqlpackage",
-			"/a:import",
-			"/SourceFile:" + temporaryFolder + "/" + file,
-			"/tu:" + userName,
-			"/tp:" + password,
-			"/tsn:127.0.0.1,1433",
-			"/tdn:" + dbNameAsIdentifier,
-			"/TargetTrustServerCertificate:true"})
-	}
-
-	alterDefaultDb := fmt.Sprintf(
-		"ALTER LOGIN [%s] WITH DEFAULT_DATABASE = [%s]",
+		c.usingDatabaseUrl,
 		userName,
-		dbNameAsNonIdentifier)
-	c.query(alterDefaultDb)
+		password,
+		c.query,
+		c.Cmd.Output(),
+	)
 }
 
 func (c *MssqlBase) downloadImage(

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

@@ -6,45 +6,6 @@ import (
 	"github.com/stretchr/testify/assert"
 )
 
-func TestGetDbNameIfExists(t *testing.T) {
-
-	type test struct {
-		input                   string
-		expectedIdentifierOp    string
-		expectedNonIdentifierOp string
-	}
-
-	tests := []test{
-		// Positive Testcases
-		// Database name specified
-		{"https://example.com/my%20random%20bac%27kp%5Dack.bak,myDbName", "myDbName", "myDbName"},
-		{"https://example.com/my%20random%20bac%27kp%5Dack.bak,myDb Name", "myDb Name", "myDb Name"},
-		{"https://example.com/my%20random%20bac%27kp%5Dack.bak,myDb Na,me", "myDb Na,me", "myDb Na,me"},
-		{"https://example.com/my%20random%20bac%27kp%5Dack.bak,[myDb Na,me]", "[myDb Na,me]]", "[myDb Na,me]]"},
-		{"https://example.com/my%20random%20bac%27kp%5Dack.bak,[myDb Na'me]", "[myDb Na''me]]", "[myDb Na'me]]"},
-		{"https://example.com/my%20random%20bac%27kp%5Dack.bak,[myDb ,Nam,e]", "[myDb ,Nam,e]]", "[myDb ,Nam,e]]"},
-
-		// Delimiter between filename and databaseName is part of the filename
-		// Decoded filename: my random .bak bac'kp]ack.bak
-		{"https://example.com/my%20random%20.bak%20bac%27kp%5Dack.bak,[myDb ,Nam,e]", "[myDb ,Nam,e]]", "[myDb ,Nam,e]]"},
-
-		// Database name not specified
-		{"https://example.com/my%20random%20.bak%20bac%27kp%5Dack.bak", "my random .bak bac''kp]]ack", "my random .bak bac'kp]]ack"},
-		{"https://example.com/my%20random%20.bak%20bac%27kp%5Dack.bak,", "my random .bak bac''kp]]ack", "my random .bak bac'kp]]ack"},
-
-		//Negative Testcases
-		{"https://example.com,myDbName", "", ""},
-	}
-
-	for _, testcase := range tests {
-		dbname := parseDbName(testcase.input)
-		dbnameAsIdentifier := getDbNameAsIdentifier(dbname)
-		dbnameAsNonIdentifier := getDbNameAsNonIdentifier(dbname)
-		assert.Equal(t, testcase.expectedIdentifierOp, dbnameAsIdentifier, "Unexpected database name as identifier")
-		assert.Equal(t, testcase.expectedNonIdentifierOp, dbnameAsNonIdentifier, "Unexpected database name as non-identifier")
-	}
-}
-
 func TestExtractUrl(t *testing.T) {
 	type test struct {
 		inputURL    string

cmd/modern/root/use.go

@@ -0,0 +1,85 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+package root
+
+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/sql"
+	"github.com/microsoft/go-sqlcmd/pkg/mssqlcontainer"
+)
+
+type Use struct {
+	cmdparser.Cmd
+
+	url string
+
+	sql sql.Sql
+}
+
+func (c *Use) DefineCommand(...cmdparser.CommandOptions) {
+	options := cmdparser.CommandOptions{
+		Use:   "use",
+		Short: "Download (into container) and use database",
+		Examples: []cmdparser.ExampleOptions{
+			{
+				Description: "Download AdventureWorksLT into container for current context, set as default database",
+				Steps:       []string{`sqlcmd use https://aka.ms/AdventureWorksLT.bak`}},
+		},
+		Run:                        c.run,
+		FirstArgAlternativeForFlag: &cmdparser.AlternativeForFlagOptions{Flag: "url", Value: &c.url},
+	}
+
+	c.Cmd.DefineCommand(options)
+
+	c.AddFlag(cmdparser.FlagOptions{
+		String: &c.url,
+		Name:   "url",
+		Usage:  "Name of context to set as current context"})
+}
+
+func (c *Use) run() {
+	output := c.Output()
+
+	if config.CurrentContextName() == "" {
+		output.FatalfWithHintExamples([][]string{
+			{"To view available contexts", "sqlcmd config get-contexts"},
+		}, "No current context")
+	}
+	if config.CurrentContextEndpointHasContainer() {
+		controller := container.NewController()
+		id := config.ContainerId()
+
+		if !controller.ContainerRunning(id) {
+			output.FatalfWithHintExamples([][]string{
+				{"Start container for current context", "sqlcmd start"},
+			}, "Container for current context is not running")
+		}
+
+		endpoint, user := config.CurrentContext()
+
+		c.sql = sql.New(sql.SqlOptions{UnitTesting: false})
+		c.sql.Connect(endpoint, user, sql.ConnectOptions{Interactive: false})
+
+		mssqlcontainer.DownloadAndRestoreDb(
+			controller,
+			id,
+			c.url,
+			user.BasicAuth.Username,
+			user.BasicAuth.Password,
+			c.query,
+			c.Cmd.Output(),
+		)
+
+	} else {
+		output.FatalfWithHintExamples([][]string{
+			{"Create new context with a sql container ", "sqlcmd create mssql"},
+		}, "Current context does not have a container")
+	}
+}
+
+func (c *Use) query(commandText string) {
+	c.sql.Query(commandText)
+}

internal/output/output.go

@@ -214,6 +214,11 @@ func (o Output) maskSecrets(text string) string {
 	// Mask password from T/SQL e.g. ALTER LOGIN [sa] WITH PASSWORD = N'foo';
 	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
 }