Load profile support for sql project deploy (#10948)

* load database name from profile.xml

* load sqlcmd variables from profile

* Add warning text

* add tests

* fix file filter for windows

* add comments

* show SQLCMD variables in a table

* reset dialog before testing readPublishProfile callback

extensions/sql-database-projects/src/test/baselines/baselines.ts

@@ -19,6 +19,7 @@ export let SSDTUpdatedProjectAfterSystemDbUpdateBaselineWindows: string;
 export let SSDTUpdatedProjectAfterSystemDbUpdateBaseline: string;
 export let SSDTProjectBaselineWithCleanTarget: string;
 export let SSDTProjectBaselineWithCleanTargetAfterUpdate: string;
+export let publishProfileBaseline: string;
 
 const baselineFolderPath = __dirname;
 
@@ -35,6 +36,7 @@ export async function loadBaselines() {
 	SSDTUpdatedProjectAfterSystemDbUpdateBaseline = await loadBaseline(baselineFolderPath, 'SSDTUpdatedProjectAfterSystemDbUpdateBaseline.xml');
 	SSDTProjectBaselineWithCleanTarget = await loadBaseline(baselineFolderPath, 'SSDTProjectBaselineWithCleanTarget.xml');
 	SSDTProjectBaselineWithCleanTargetAfterUpdate = await loadBaseline(baselineFolderPath, 'SSDTProjectBaselineWithCleanTargetAfterUpdate.xml');
+	publishProfileBaseline = await loadBaseline(baselineFolderPath, 'publishProfileBaseline.publish.xml');
 }
 
 async function loadBaseline(baselineFolderPath: string, fileName: string): Promise<string> {

extensions/sql-database-projects/src/test/baselines/publishProfileBaseline.publish.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project ToolsVersion="15.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+  <PropertyGroup>
+    <IncludeCompositeObjects>True</IncludeCompositeObjects>
+    <TargetDatabaseName>targetDb</TargetDatabaseName>
+    <DeployScriptFileName>DatabaseProject1.sql</DeployScriptFileName>
+    <ProfileVersionNumber>1</ProfileVersionNumber>
+  </PropertyGroup>
+  <ItemGroup>
+    <SqlCmdVariable Include="ProdDatabaseName">
+      <DefaultValue>MyProdDatabase</DefaultValue>
+      <Value>$(SqlCmdVar__1)</Value>
+    </SqlCmdVariable>
+  </ItemGroup>
+</Project>

extensions/sql-database-projects/src/test/projectController.test.ts

@@ -117,6 +117,7 @@ describe.skip('ProjectsController: project controller operations', function ():
 
 			const deployHoller = 'hello from callback for deploy()';
 			const generateHoller = 'hello from callback for generateScript()';
+			const profileHoller = 'hello from callback for readPublishProfile()';
 
 			let holler = 'nothing';
 
@@ -131,6 +132,13 @@ describe.skip('ProjectsController: project controller operations', function ():
 				holler = deployHoller;
 				return undefined;
 			});
+			projController.setup(x => x.readPublishProfile(TypeMoq.It.isAny())).returns(async () => {
+				holler = profileHoller;
+				return {
+					databaseName: '',
+					sqlCmdVariables: {}
+				};
+			});
 
 			projController.setup(x => x.executionCallback(TypeMoq.It.isAny(), TypeMoq.It.is((_): _ is IGenerateScriptProfile => true))).returns(async () => {
 				holler = generateHoller;
@@ -146,6 +154,22 @@ describe.skip('ProjectsController: project controller operations', function ():
 			await dialog.generateScriptClick();
 
 			should(holler).equal(generateHoller, 'executionCallback() is supposed to have been setup and called for GenerateScript scenario');
+
+			dialog = await projController.object.deployProject(proj);
+			await projController.object.readPublishProfile(vscode.Uri.parse('test'));
+
+			should(holler).equal(profileHoller, 'executionCallback() is supposed to have been setup and called for ReadPublishProfile scenario');
+		});
+
+		it('Should read database name and SQLCMD variables from publish profile', async function (): Promise<void> {
+			await baselines.loadBaselines();
+			let profilePath = await testUtils.createTestFile(baselines.publishProfileBaseline, 'publishProfile.publish.xml');
+			const projController = new ProjectsController(testContext.apiWrapper.object, new SqlDatabaseProjectTreeViewProvider());
+
+			let result = await projController.readPublishProfile(vscode.Uri.parse(profilePath));
+			should(result.databaseName).equal('targetDb');
+			should(Object.keys(result.sqlCmdVariables).length).equal(1);
+			should(result.sqlCmdVariables['ProdDatabaseName']).equal('MyProdDatabase');
 		});
 	});
 });

extensions/sql-database-projects/src/test/testUtils.ts

@@ -49,7 +49,7 @@ export async function generateTestFolderPath(): Promise<string> {
 	return folderPath;
 }
 
-async function createTestFile(contents: string, fileName: string, folderPath?: string): Promise<string> {
+export async function createTestFile(contents: string, fileName: string, folderPath?: string): Promise<string> {
 	folderPath = folderPath ?? await generateTestFolderPath();
 	const filePath = path.join(folderPath, fileName);