Skip to content

sqlcmd quote around DB name #268

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dzsquared wants to merge 1 commit into
base: master
Choose a base branch
from
Open

sqlcmd quote around DB name #268

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions __tests__/AzureSqlAction.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,10 +55,12 @@ describe('AzureSqlAction tests', () => {
describe('sql script action tests for different auth types', () => {
// Format: [test case description, connection string, expected sqlcmd arguments]
const testCases = [
['SQL login', 'Server=testServer.database.windows.net;Database=testDB;User Id=testUser;Password=placeholder', '-S testServer.database.windows.net,1433 -d testDB -U "testUser" -i "./TestFile.sql" -t 20'],
['AAD password', 'Server=testServer.database.windows.net;Database=testDB;Authentication=Active Directory Password;User Id=testAADUser;Password=placeholder', '-S testServer.database.windows.net,1433 -d testDB --authentication-method=ActiveDirectoryPassword -U "testAADUser" -i "./TestFile.sql" -t 20'],
['AAD service principal', 'Server=testServer.database.windows.net;Database=testDB;Authentication=Active Directory Service Principal;User Id=appId;Password=placeholder', '-S testServer.database.windows.net,1433 -d testDB --authentication-method=ActiveDirectoryServicePrincipal -U "appId" -i "./TestFile.sql" -t 20'],
['AAD default', 'Server=testServer.database.windows.net;Database=testDB;Authentication=Active Directory Default;', '-S testServer.database.windows.net,1433 -d testDB --authentication-method=ActiveDirectoryDefault -i "./TestFile.sql" -t 20']
['SQL login', 'Server=testServer.database.windows.net;Database=testDB;User Id=testUser;Password=placeholder', '-S testServer.database.windows.net,1433 -d "testDB" -U "testUser" -i "./TestFile.sql" -t 20'],
['AAD password', 'Server=testServer.database.windows.net;Database=testDB;Authentication=Active Directory Password;User Id=testAADUser;Password=placeholder', '-S testServer.database.windows.net,1433 -d "testDB" --authentication-method=ActiveDirectoryPassword -U "testAADUser" -i "./TestFile.sql" -t 20'],
['AAD service principal', 'Server=testServer.database.windows.net;Database=testDB;Authentication=Active Directory Service Principal;User Id=appId;Password=placeholder', '-S testServer.database.windows.net,1433 -d "testDB" --authentication-method=ActiveDirectoryServicePrincipal -U "appId" -i "./TestFile.sql" -t 20'],
['AAD default', 'Server=testServer.database.windows.net;Database=testDB;Authentication=Active Directory Default;', '-S testServer.database.windows.net,1433 -d "testDB" --authentication-method=ActiveDirectoryDefault -i "./TestFile.sql" -t 20'],
['SQL login (DB has space)', 'Server=testServer.database.windows.net;Database=test DB;User Id=testUser;Password=placeholder', '-S testServer.database.windows.net,1433 -d "test DB" -U "testUser" -i "./TestFile.sql" -t 20'],
['SQL login (DB has quote)', 'Server=testServer.database.windows.net;Database=test"DB;User Id=testUser;Password=placeholder', '-S testServer.database.windows.net,1433 -d "test\\"DB" -U "testUser" -i "./TestFile.sql" -t 20']
];

it.each(testCases)('%s', async (testCase, connectionString, expectedSqlCmdCall) => {
Expand Down Expand Up @@ -88,8 +90,8 @@ describe('AzureSqlAction tests', () => {
describe('sql script action tests for different port numbers', () => {
// Format: [test case description, connection string, expected sqlcmd arguments]
const testCases = [
['Default port', 'Server=testServer.database.windows.net;Database=testDB;User Id=testUser;Password=placeholder', '-S testServer.database.windows.net,1433 -d testDB -U "testUser" -i "./TestFile.sql" -t 20'],
['Custom port', 'Server=testServer.database.windows.net,1234;Database=testDB;User Id=testUser;Password=placeholder', '-S testServer.database.windows.net,1234 -d testDB -U "testUser" -i "./TestFile.sql" -t 20']
['Default port', 'Server=testServer.database.windows.net;Database=testDB;User Id=testUser;Password=placeholder', '-S testServer.database.windows.net,1433 -d "testDB" -U "testUser" -i "./TestFile.sql" -t 20'],
['Custom port', 'Server=testServer.database.windows.net,1234;Database=testDB;User Id=testUser;Password=placeholder', '-S testServer.database.windows.net,1234 -d "testDB" -U "testUser" -i "./TestFile.sql" -t 20']
];

it.each(testCases)('%s', async (testCase, connectionString, expectedSqlCmdCall) => {
Expand Down
2 changes: 1 addition & 1 deletion lib/main.js
View file
Open in desktop

Large diffs are not rendered by default.

9 changes: 9 additions & 0 deletions src/SqlConnectionConfig.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,15 @@ export default class SqlConnectionConfig {
return result;
}

/**
* Returns the database name enclosed by quotes for use in sqlcmd commands.
* Escapes any quotes in the database name with \"
*/
public get QuotedDatabaseName(): string {
let dbName = this.Database.replace(/"/g, '\\"');
return `"${dbName}"`;
}

/**
* The basic format of a connection string includes a series of keyword/value pairs separated by semicolons.
* The equal sign (=) connects each keyword and its value. (Ex: Key1=Val1;Key2=Val2)
Expand Down
4 changes: 2 additions & 2 deletions src/SqlUtils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ export default class SqlUtils {
* @returns A ConnectionResult object indicating success/failure, the connection on success, or the error on failure.
*/
private static async tryConnection(config: SqlConnectionConfig, useMaster?: boolean): Promise<ConnectionResult> {
const database = useMaster ? "master" : config.Database;
const database = useMaster ? "master" : config.QuotedDatabaseName;

let sqlCmdError = '';
try {
Expand Down Expand Up @@ -120,7 +120,7 @@ export default class SqlUtils {
}

if (!database) {
database = connectionConfig.Database;
database = connectionConfig.QuotedDatabaseName;
}

let sqlcmdCall = `"${sqlCmdPath}" -S ${connectionConfig.Server},${connectionConfig.Port ?? 1433} -d ${database}`;
Expand Down
Loading