Add minimal unit test

Author: apoorvdeshmukh

cmd/sqlcmd/main.go

@@ -201,9 +201,10 @@ func setConnect(connect *sqlcmd.ConnectSettings, args *SQLCmdArguments, vars *sq
 	connect.ErrorSeverityLevel = args.ErrorSeverityLevel
 }
 
-type allocConsole func(historyFile string) sqlcmd.Console
-
-var consoleAllocator allocConsole = console.NewConsole
+func IsConsoleInitializationRequired(connect *sqlcmd.ConnectSettings, args *SQLCmdArguments) bool {
+	iactive := args.InputFile == nil && args.Query == ""
+	return iactive || connect.RequiresPassword()
+}
 
 func run(vars *sqlcmd.Variables, args *SQLCmdArguments) (int, error) {
 	wd, err := os.Getwd()
@@ -214,8 +215,8 @@ func run(vars *sqlcmd.Variables, args *SQLCmdArguments) (int, error) {
 	var connectConfig sqlcmd.ConnectSettings
 	setConnect(&connectConfig, args, vars)
 	var line sqlcmd.Console = nil
-	if connectConfig.RequiresPassword() {
-		line = consoleAllocator("")
+	if IsConsoleInitializationRequired(&connectConfig, args) {
+		line = console.NewConsole("")
 		defer line.Close()
 	}
 
@@ -232,7 +233,7 @@ func run(vars *sqlcmd.Variables, args *SQLCmdArguments) (int, error) {
 		return 1, err
 	}
 
-	setConnect(&s.Connect, args, vars)
+	s.Connect = &connectConfig
 	s.Format = sqlcmd.NewSQLCmdDefaultFormatter(false)
 	if args.OutputFile != "" {
 		err = s.RunCommand(s.Cmd["OUT"], []string{args.OutputFile})
@@ -268,7 +269,6 @@ func run(vars *sqlcmd.Variables, args *SQLCmdArguments) (int, error) {
 	}
 
 	iactive := args.InputFile == nil && args.Query == ""
-
 	if iactive || s.Query != "" {
 		err = s.Run(once, false)
 	} else {

cmd/sqlcmd/main_test.go

@@ -9,7 +9,6 @@ import (
 	"testing"
 
 	"github.com/alecthomas/kong"
-	"github.com/microsoft/go-sqlcmd/pkg/console"
 	"github.com/microsoft/go-sqlcmd/pkg/sqlcmd"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
@@ -328,67 +327,28 @@ func TestMissingInputFile(t *testing.T) {
 	assert.Equal(t, 1, exitCode, "exitCode")
 }
 
-func TestPasswordPrompt(t *testing.T) {
-
-	prompted := false
-	consoleAllocator = func(historyFile string) sqlcmd.Console {
-		console := &testConsole{
-			OnPasswordPrompt: func(prompt string) ([]byte, error) {
-				assert.Equal(t, "Password:", prompt, "Incorrect password prompt")
-				prompted = true
-				return []byte{}, nil
-			},
-			OnReadLine: func() (string, error) {
-				assert.Fail(t, "ReadLine should not be called")
-				return "", nil
-			},
-		}
-		return console
-	}
-
-	args = newArguments()
+func TestConditionsForPasswordPrompt(t *testing.T) {
+	args := newArguments()
 	if canTestAzureAuth() {
 		args.UseAad = true
 	}
-	args.InputFile = []string{"testdata/select100.sql"}
+	args.InputFile = []string{"testdata/missingFile.sql"}
+	args.DisableCmdAndWarn = true
 	vars := sqlcmd.InitializeVariables(!args.DisableCmdAndWarn)
 	setVars(vars, &args)
+	var connectConfig sqlcmd.ConnectSettings
+	setConnect(&connectConfig, &args, vars)
+	assert.Equal(t, false, IsConsoleInitializationRequired(&connectConfig, &args), "Console initialization was not required")
+	assert.Equal(t, false, connectConfig.RequiresPassword() && connectConfig.Password == "", "Expected value for password prompt condition did not match")
 
-	exitCode, err := run(vars, &args)
-	assert.False(t, prompted, "Password prompt was not expected")
-	assert.NoError(t, err, "run")
-	assert.Equal(t, 0, exitCode, "exitCode")
-
+	args.InputFile = []string{"testdata/missingFile.sql"}
 	args.UserName = "someuser"
-	os.Setenv("SQLCMDPASSWORD", "")
 	vars = sqlcmd.InitializeVariables(!args.DisableCmdAndWarn)
 	setVars(vars, &args)
-	exitCode, err = run(vars, &args)
-	assert.True(t, prompted, "Password prompt not displayed for -U")
-	assert.Error(t, err, "run")
-	assert.Equal(t, 1, exitCode, "exitCode")
-	consoleAllocator = console.NewConsole
-}
-
-type testConsole struct {
-	PromptText       string
-	OnPasswordPrompt func(prompt string) ([]byte, error)
-	OnReadLine       func() (string, error)
-}
-
-func (tc *testConsole) Readline() (string, error) {
-	return tc.OnReadLine()
-}
-
-func (tc *testConsole) ReadPassword(prompt string) ([]byte, error) {
-	return tc.OnPasswordPrompt(prompt)
-}
-
-func (tc *testConsole) SetPrompt(s string) {
-	tc.PromptText = s
-}
-
-func (tc *testConsole) Close() {
+	setConnect(&connectConfig, &args, vars)
+	connectConfig.Password = ""
+	assert.Equal(t, true, IsConsoleInitializationRequired(&connectConfig, &args), "Console initialization was not required")
+	assert.Equal(t, true, connectConfig.RequiresPassword() && connectConfig.Password == "", "Expected value for password prompt condition did not match")
 }
 
 // Assuming public Azure, use AAD when SQLCMDUSER environment variable is not set

pkg/sqlcmd/commands.go

@@ -339,7 +339,7 @@ func connectCommand(s *Sqlcmd, args []string, line uint) error {
 	}
 	connect.AuthenticationMethod = arguments.AuthenticationMethod
 	// If no user name is provided we switch to integrated auth
-	_ = s.ConnectDb(&connect, s.lineIo == nil)
+	_ = s.ConnectDb(connect, s.lineIo == nil)
 	// ConnectDb prints connection errors already, and failure to connect is not fatal even with -b option
 	return nil
 }

pkg/sqlcmd/commands_test.go

@@ -167,7 +167,7 @@ func TestConnectCommand(t *testing.T) {
 	err := connectCommand(s, []string{"someserver -U someuser"}, 1)
 	assert.NoError(t, err, "connectCommand with valid arguments doesn't return an error on connect failure")
 	assert.True(t, prompted, "connectCommand with user name and no password should prompt for password")
-	assert.NotEqual(t, "someserver", s.Connect.ServerName, "On error, sqlCmd.Connect does not copy inputs")
+	assert.Equal(t, "someserver", s.Connect.ServerName, "servername should match with the input parameter")
 
 	err = connectCommand(s, []string{}, 2)
 	assert.EqualError(t, err, InvalidCommandError("CONNECT", 2).Error(), ":Connect with no arguments should return an error")

pkg/sqlcmd/sqlcmd.go

@@ -62,7 +62,7 @@ type Sqlcmd struct {
 	batch            *Batch
 	// Exitcode is returned to the operating system when the process exits
 	Exitcode int
-	Connect  ConnectSettings
+	Connect  *ConnectSettings
 	vars     *Variables
 	Format   Formatter
 	Query    string
@@ -79,6 +79,7 @@ func New(l Console, workingDirectory string, vars *Variables) *Sqlcmd {
 		workingDirectory: workingDirectory,
 		vars:             vars,
 		Cmd:              newCommands(),
+		Connect:          &ConnectSettings{},
 	}
 	s.batch = NewBatch(s.scanNext, s.Cmd)
 	mssql.SetContextLogger(s)
@@ -213,7 +214,7 @@ func (s *Sqlcmd) SetError(e io.WriteCloser) {
 func (s *Sqlcmd) ConnectDb(connect *ConnectSettings, nopw bool) error {
 	newConnection := connect != nil
 	if connect == nil {
-		connect = &s.Connect
+		connect = s.Connect
 	}
 
 	var connector driver.Connector
@@ -259,7 +260,7 @@ func (s *Sqlcmd) ConnectDb(connect *ConnectSettings, nopw bool) error {
 		s.vars.Set(SQLCMDUSER, u.Username)
 	}
 	if newConnection {
-		s.Connect = *connect
+		s.Connect = connect
 	}
 	if s.batch != nil {
 		s.batch.batchline = 1

pkg/sqlcmd/sqlcmd_test.go

@@ -366,10 +366,10 @@ func TestPromptForPasswordPositive(t *testing.T) {
 	v := InitializeVariables(true)
 	s := New(console, "", v)
 	// attempt without password prompt
-	err := s.ConnectDb(&c, true)
+	err := s.ConnectDb(c, true)
 	assert.False(t, prompted, "ConnectDb with nopw=true should not prompt for password")
 	assert.Error(t, err, "ConnectDb with nopw==true and no password provided")
-	err = s.ConnectDb(&c, false)
+	err = s.ConnectDb(c, false)
 	assert.True(t, prompted, "ConnectDb with !nopw should prompt for password")
 	assert.NoError(t, err, "ConnectDb with !nopw and valid password returned from prompt")
 	if s.Connect.Password != password {
@@ -505,7 +505,7 @@ func canTestAzureAuth() bool {
 	return strings.Contains(server, ".database.windows.net") && userName == ""
 }
 
-func newConnect(t testing.TB) ConnectSettings {
+func newConnect(t testing.TB) *ConnectSettings {
 	t.Helper()
 	connect := ConnectSettings{
 		UserName:   os.Getenv(SQLCMDUSER),
@@ -517,5 +517,5 @@ func newConnect(t testing.TB) ConnectSettings {
 		t.Log("Using ActiveDirectoryDefault")
 		connect.AuthenticationMethod = azuread.ActiveDirectoryDefault
 	}
-	return connect
+	return &connect
 }