VsCode Tasks PR1 : Introducing default build property with create project quickpics (#26315)

* introducing default build property with create project quickpics

* modified test

Author: ssreerama

extensions/data-workspace/src/common/constants.ts

@@ -57,6 +57,7 @@ export const SdkStyleProject = localize('dataworkspace.sdkStyleProject', "SDK-st
 export const LearnMore = localize('dataworkspace.learnMore', "Learn More");
 export const YesRecommended = localize('dataworkspace.yesRecommended', "Yes (Recommended)");
 export const No = localize('dataworkspace.no', "No");
+export const Yes = localize('dataworkspace.yes', "Yes");
 export const SdkLearnMorePlaceholder = localize('dataworkspace.sdkLearnMorePlaceholder', "Click \"Learn More\" button for more information about SDK-style projects");
 export const Default = localize('dataworkspace.default', "Default");
 export const SelectTargetPlatform = localize('dataworkspace.selectTargetPlatform', "Select Target Platform");
@@ -69,6 +70,7 @@ export const reservedWindowsFilenameErrorMessage = localize('reservedWindowsFile
 export const reservedValueErrorMessage = localize('reservedValueErrorMessage', "Reserved file name. Choose another name and try again");
 export const trailingWhitespaceErrorMessage = localize('trailingWhitespaceErrorMessage', "File name cannot start or end with whitespace");
 export const tooLongFilenameErrorMessage = localize('tooLongFilenameErrorMessage', "File name cannot be over 255 characters");
+export const confirmCreateProjectWithBuildTaskDialogName = localize('confirmCreateProjectWithBuildTaskDialogName', "Do you want to configure SQL project build as the default build configuration for this folder?");
 
 //Open Existing Dialog
 export const OpenExistingDialogTitle = localize('dataworkspace.openExistingDialogTitle', "Open Existing Project");

extensions/data-workspace/src/common/interfaces.ts

@@ -75,8 +75,9 @@ export interface IWorkspaceService {
 	 * @param projectTypeId The project type id
 	 * @param projectTargetPlatform The target platform of the project
 	 * @param sdkStyleProject Whether or not the project is SDK-style
+	 * @param configureDefaultBuild Whether or not to configure the default build
 	 */
-	createProject(name: string, location: vscode.Uri, projectTypeId: string, projectTargetPlatform?: string, sdkStyleProject?: boolean): Promise<vscode.Uri>;
+	createProject(name: string, location: vscode.Uri, projectTypeId: string, projectTargetPlatform?: string, sdkStyleProject?: boolean, configureDefaultBuild?: boolean): Promise<vscode.Uri>;
 
 	/**
 	 * Clones git repository and adds projects to workspace

extensions/data-workspace/src/dataworkspace.d.ts

@@ -99,8 +99,9 @@ declare module 'dataworkspace' {
 		 * @param projectTypeId the identifier of the selected project type
 		 * @param projectTargetPlatform the target platform of the project
 		 * @param sdkStyleProject whether or not a project is SDK-style
+		 * @param configureDefaultBuild whether or not to configure default build
 		 */
-		createProject(name: string, location: vscode.Uri, projectTypeId: string, projectTargetPlatform?: string, sdkStyleProject?: boolean): Promise<vscode.Uri>;
+		createProject(name: string, location: vscode.Uri, projectTypeId: string, projectTargetPlatform?: string, sdkStyleProject?: boolean, configureDefaultBuild?: boolean): Promise<vscode.Uri>;
 
 		/**
 		 * Gets the project data corresponding to the project file, to be placed in the dashboard container
@@ -189,6 +190,11 @@ declare module 'dataworkspace' {
 		 * Location where clicking on the Learn More to know more about project type will go
 		 */
 		readonly learnMoreUrl?: string
+
+		/**
+		 * Whether or not the project has a default build configuration
+		 */
+		readonly configureDefaultBuild?: boolean;
 	}
 
 	/**

extensions/data-workspace/src/dialogs/newProjectDialog.ts

@@ -24,6 +24,7 @@ class NewProjectDialogModel {
 	location: string = '';
 	targetPlatform?: string;
 	sdkStyleProject?: boolean;
+	configureDefaultBuild: boolean = false;
 }
 
 export async function openSpecificProjectNewProjectDialog(projectType: IProjectType, workspaceService: WorkspaceService): Promise<vscode.Uri | undefined> {
@@ -90,7 +91,7 @@ export class NewProjectDialog extends DialogBase {
 				.withAdditionalProperties({ projectFileExtension: this.model.projectFileExtension, projectTemplateId: this.model.projectTypeId })
 				.send();
 
-			this.projectUri = await this.workspaceService.createProject(this.model.name, vscode.Uri.file(this.model.location), this.model.projectTypeId, this.model.targetPlatform, this.model.sdkStyleProject);
+			this.projectUri = await this.workspaceService.createProject(this.model.name, vscode.Uri.file(this.model.location), this.model.projectTypeId, this.model.targetPlatform, this.model.sdkStyleProject, this.model.configureDefaultBuild);
 			this.newProjectDialogComplete?.resolve();
 		}
 		catch (err) {

extensions/data-workspace/src/dialogs/newProjectQuickpick.ts

@@ -175,7 +175,17 @@ export async function createNewProjectWithQuickpick(workspaceService: WorkspaceS
 		}
 	}
 
-	await workspaceService.createProject(projectName, vscode.Uri.file(projectLocation), projectType.id, targetPlatform, sdkStyle);
+	// 8. Configure Sql project default build or not
+	let configureDefaultBuild = await vscode.window.showQuickPick(
+		[constants.Yes, constants.No],
+		{ title: constants.confirmCreateProjectWithBuildTaskDialogName, ignoreFocusOut: true }
+	);
+
+	if (!configureDefaultBuild) {
+		// User cancelled
+		return;
+	}
+	await workspaceService.createProject(projectName, vscode.Uri.file(projectLocation), projectType.id, targetPlatform, sdkStyle, configureDefaultBuild === constants.Yes);
 
 	// Add info message with 'learn more' button if project type has a link
 	// for user to learn more about the project type

extensions/data-workspace/src/services/workspaceService.ts

@@ -227,10 +227,10 @@ export class WorkspaceService implements IWorkspaceService {
 		return ProjectProviderRegistry.getProviderByProjectExtension(projectType);
 	}
 
-	async createProject(name: string, location: vscode.Uri, projectTypeId: string, projectTargetVersion?: string, sdkStyleProject?: boolean): Promise<vscode.Uri> {
+	async createProject(name: string, location: vscode.Uri, projectTypeId: string, projectTargetVersion?: string, sdkStyleProject?: boolean, configureDefaultBuild?: boolean): Promise<vscode.Uri> {
 		const provider = ProjectProviderRegistry.getProviderByProjectType(projectTypeId);
 		if (provider) {
-			const projectFile = await provider.createProject(name, location, projectTypeId, projectTargetVersion, sdkStyleProject);
+			const projectFile = await provider.createProject(name, location, projectTypeId, projectTargetVersion, sdkStyleProject, configureDefaultBuild);
 			await this.addProjectsToWorkspace([projectFile]);
 			this._onDidWorkspaceProjectsChange.fire();
 			return projectFile;

extensions/data-workspace/src/test/workspaceService.test.ts

@@ -323,4 +323,54 @@ suite('WorkspaceService', function (): void {
 		should.strictEqual(updateWorkspaceFoldersStub.calledOnce, true, 'updateWorkspaceFolders should have been called');
 		onWorkspaceProjectsChangedDisposable.dispose();
 	});
+
+	test('createProject uses values from QuickPick', async () => {
+		// Arrange: Create a new instance of WorkspaceService
+		const service = new WorkspaceService();
+
+		// Arrange: Stub createProject to observe its call and return a fixed URI
+		const createProjectStub = sinon.stub(service, 'createProject').resolves(vscode.Uri.file('/tmp/TestProject'));
+
+		// Arrange: Prepare the QuickPick items to simulate user selections
+		const quickPickItems = [
+			{ label: 'Select Database Project Type', value: 'SQL Server Database', picked: true },
+			{ label: 'Enter Project Name', value: 'TestProject', picked: true },
+			{ label: 'Select Project Location', value: '/tmp/TestProject', picked: true },
+			{ label: 'Select Target Platform', value: 'SQL Server', picked: true },
+			{ label: 'SDK-style project', value: constants.YesRecommended, picked: true },
+			{ label: constants.confirmCreateProjectWithBuildTaskDialogName, value: constants.Yes, picked: true },
+		];
+
+		// Arrange: Stub showQuickPick to return each item in order for each call
+		const quickPickStub = sinon.stub(vscode.window, 'showQuickPick');
+		quickPickItems.forEach((item, idx) => {
+			quickPickStub.onCall(idx).resolves(item);
+		});
+
+		// Act: Call createProject directly with values from the simulated QuickPick selections
+		const projectUri = await service.createProject(
+			quickPickItems[1].value, // Project name
+			vscode.Uri.file(quickPickItems[2].value), // Project location as URI
+			quickPickItems[0].value, // Project type ID
+			quickPickItems[3].value, // Target platform
+			quickPickItems[4].picked, // SDK-style project flag
+			quickPickItems[5].picked  // Configure default build flag
+		);
+
+		// Assert: createProject should have been called once
+		should.strictEqual(createProjectStub.calledOnce, true, 'createProject should have been called once');
+		// Assert: The returned URI path should match the expected path
+		should.strictEqual(projectUri.path, '/tmp/TestProject', 'project URI should match the expected path');
+		// Assert: The arguments passed to createProject should match the simulated QuickPick selections
+		const callArgs = createProjectStub.getCall(0).args;
+		should.strictEqual(callArgs[0], quickPickItems[1].value, 'name should match');
+		should.strictEqual(callArgs[1].path, quickPickItems[2].value, 'location should match');
+		should.strictEqual(callArgs[2], quickPickItems[0].value, 'projectTypeId should match QuickPick label');
+		should.strictEqual(callArgs[3], quickPickItems[3].value, 'projectTargetVersion should match');
+		should.strictEqual(callArgs[4], true, 'sdkStyleProject should match');
+		should.strictEqual(callArgs[5], true, 'configureDefaultBuild should be true');
+
+		// Cleanup: Restore the stubbed showQuickPick method
+		quickPickStub.restore();
+	});
 });