ckaczor/azuredatastudio
1
0
Fork 0
mirror of https://github.com/ckaczor/azuredatastudio.git synced 2026-02-16 10:58:30 -05:00
Code Issues Packages Projects Releases Wiki Activity

update new workspace validation to throw errors to make code more reusable (#13856)

Browse Source
This commit is contained in:
Kim Santiago
2020-12-18 13:32:42 -08:00
committed by GitHub
parent 0b8b6064ed
commit c7303803ba
4 changed files with 18 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
extensions/data-workspace/src/dialogs/dialogBase.ts
View File

@@ -161,30 +161,25 @@ export abstract class DialogBase {
} }
} }
public async validateNewWorkspace(sameFolderAsNewProject: boolean): Promise<boolean> { public async validateNewWorkspace(sameFolderAsNewProject: boolean): Promise<void> {
// workspace file should end in .code-workspace // workspace file should end in .code-workspace
const workspaceValid = this.workspaceInputBox!.value!.endsWith(constants.WorkspaceFileExtension); const workspaceValid = this.workspaceInputBox!.value!.endsWith(constants.WorkspaceFileExtension);
if (!workspaceValid) { if (!workspaceValid) {
this.showErrorMessage(constants.WorkspaceFileInvalidError(this.workspaceInputBox!.value!)); throw new Error(constants.WorkspaceFileInvalidError(this.workspaceInputBox!.value!));
return false;
} }
// if the workspace file is not going to be in the same folder as the newly created project, then check that it's a valid folder // if the workspace file is not going to be in the same folder as the newly created project, then check that it's a valid folder
if (!sameFolderAsNewProject) { if (!sameFolderAsNewProject) {
const workspaceParentDirectoryExists = await directoryExist(path.dirname(this.workspaceInputBox!.value!)); const workspaceParentDirectoryExists = await directoryExist(path.dirname(this.workspaceInputBox!.value!));
if (!workspaceParentDirectoryExists) { if (!workspaceParentDirectoryExists) {
this.showErrorMessage(constants.WorkspaceParentDirectoryNotExistError(path.dirname(this.workspaceInputBox!.value!))); throw new Error(constants.WorkspaceParentDirectoryNotExistError(path.dirname(this.workspaceInputBox!.value!)));
return false;
} }
} }
// workspace file should not be an existing workspace file // workspace file should not be an existing workspace file
const workspaceFileExists = await fileExist(this.workspaceInputBox!.value!); const workspaceFileExists = await fileExist(this.workspaceInputBox!.value!);
if (workspaceFileExists) { if (workspaceFileExists) {
this.showErrorMessage(constants.WorkspaceFileAlreadyExistsError(this.workspaceInputBox!.value!)); throw new Error(constants.WorkspaceFileAlreadyExistsError(this.workspaceInputBox!.value!));
return false;
} }
return true;
} }
} }

6
extensions/data-workspace/src/dialogs/newProjectDialog.ts
View File

@@ -43,9 +43,9 @@ export class NewProjectDialog extends DialogBase {
return false; return false;
} }
const sameFolderAsNewProject = path.join(this.model.location, this.model.name) === path.dirname(this.workspaceInputBox!.value!); if (this.workspaceInputBox!.enabled) {
if (this.workspaceInputBox!.enabled && !await this.validateNewWorkspace(sameFolderAsNewProject)) { const sameFolderAsNewProject = path.join(this.model.location, this.model.name) === path.dirname(this.workspaceInputBox!.value!);
return false; await this.validateNewWorkspace(sameFolderAsNewProject);
} }
return true; return true;

19
extensions/data-workspace/src/dialogs/openExistingDialog.ts
View File

@@ -37,17 +37,13 @@ export class OpenExistingDialog extends DialogBase {
try { try {
// the selected location should be an existing directory // the selected location should be an existing directory
if (this._targetTypeRadioCardGroup?.selectedCardId === constants.Project) { if (this._targetTypeRadioCardGroup?.selectedCardId === constants.Project) {
if (!await this.validateFile(this._projectFile, constants.Project.toLowerCase())) { await this.validateFile(this._projectFile, constants.Project.toLowerCase());
return false;
}
if (this.workspaceInputBox!.enabled && !await this.validateNewWorkspace(false)) { if (this.workspaceInputBox!.enabled) {
return false; await this.validateNewWorkspace(false);
} }
} else if (this._targetTypeRadioCardGroup?.selectedCardId === constants.Workspace) { } else if (this._targetTypeRadioCardGroup?.selectedCardId === constants.Workspace) {
if (!await this.validateFile(this._workspaceFile, constants.Workspace.toLowerCase())) { await this.validateFile(this._workspaceFile, constants.Workspace.toLowerCase());
return false;
}
} }
return true; return true;
@@ -58,14 +54,11 @@ export class OpenExistingDialog extends DialogBase {
} }
} }
public async validateFile(file: string, fileType: string) { public async validateFile(file: string, fileType: string): Promise<void> {
const fileExists = await fileExist(file); const fileExists = await fileExist(file);
if (!fileExists) { if (!fileExists) {
this.showErrorMessage(constants.FileNotExistError(fileType, file)); throw new Error(constants.FileNotExistError(fileType, file));
return false;
} }
return true;
} }
async onComplete(): Promise<void> { async onComplete(): Promise<void> {

13
extensions/data-workspace/src/test/dialogs/dialogBase.test.ts
View File

@@ -35,15 +35,13 @@ suite('DialogBase - workspace validation', function (): void {
test('Should validate new workspace location missing file extension', async function (): Promise<void> { test('Should validate new workspace location missing file extension', async function (): Promise<void> {
dialog.workspaceInputBox!.value = 'test'; dialog.workspaceInputBox!.value = 'test';
should.equal(await dialog.validateNewWorkspace(false), false, 'Validation should fail because workspace does not end in .code-workspace'); await should(dialog.validateNewWorkspace(false)).be.rejectedWith(constants.WorkspaceFileInvalidError(dialog.workspaceInputBox!.value));
should.equal(dialog.getErrorMessage().text, constants.WorkspaceFileInvalidError(dialog.workspaceInputBox!.value));
}); });
test('Should validate new workspace location with invalid location', async function (): Promise<void> { test('Should validate new workspace location with invalid location', async function (): Promise<void> {
// use invalid folder // use invalid folder
dialog.workspaceInputBox!.value = 'invalidLocation/test.code-workspace'; dialog.workspaceInputBox!.value = 'invalidLocation/test.code-workspace';
should.equal(await dialog.validateNewWorkspace(false), false, 'Validation should fail because the folder is invalid'); await should(dialog.validateNewWorkspace(false)).be.rejectedWith(constants.WorkspaceParentDirectoryNotExistError(path.dirname(dialog.workspaceInputBox!.value)));
should.equal(dialog.getErrorMessage().text, constants.WorkspaceParentDirectoryNotExistError(path.dirname(dialog.workspaceInputBox!.value)));
}); });
test('Should validate new workspace location that already exists', async function (): Promise<void> { test('Should validate new workspace location that already exists', async function (): Promise<void> {
@@ -52,18 +50,17 @@ suite('DialogBase - workspace validation', function (): void {
fileExistStub.resolves(true); fileExistStub.resolves(true);
const existingWorkspaceFilePath = path.join(os.tmpdir(), `${dialog.model.name}.code-workspace`); const existingWorkspaceFilePath = path.join(os.tmpdir(), `${dialog.model.name}.code-workspace`);
dialog.workspaceInputBox!.value = existingWorkspaceFilePath; dialog.workspaceInputBox!.value = existingWorkspaceFilePath;
should.equal(await dialog.validateNewWorkspace(false), false, 'Validation should fail because the selected workspace file already exists'); await should(dialog.validateNewWorkspace(false)).be.rejectedWith(constants.WorkspaceFileAlreadyExistsError(existingWorkspaceFilePath));
should.equal(dialog.getErrorMessage().text, constants.WorkspaceFileAlreadyExistsError(existingWorkspaceFilePath));
}); });
test('Should validate new workspace location that is valid', async function (): Promise<void> { test('Should validate new workspace location that is valid', async function (): Promise<void> {
// same folder as the project should be valid even if the project folder isn't created yet // same folder as the project should be valid even if the project folder isn't created yet
dialog.workspaceInputBox!.value = path.join(dialog.model.location, dialog.model.name, 'test.code-workspace'); dialog.workspaceInputBox!.value = path.join(dialog.model.location, dialog.model.name, 'test.code-workspace');
should.equal(await dialog.validateNewWorkspace(true), true, `Validation should pass if the file location is the same folder as the project. Error was: ${dialog.getErrorMessage()?.text}`); await should(dialog.validateNewWorkspace(true)).not.be.rejected();
// a workspace not in the same folder as the project should also be valid // a workspace not in the same folder as the project should also be valid
dialog.workspaceInputBox!.value = path.join(os.tmpdir(), `TestWorkspace_${new Date().getTime()}.code-workspace`); dialog.workspaceInputBox!.value = path.join(os.tmpdir(), `TestWorkspace_${new Date().getTime()}.code-workspace`);
should.equal(await dialog.validateNewWorkspace(false), true, `Validation should pass because the parent directory exists, workspace filepath is unique, and the file extension is correct. Error was: ${dialog.getErrorMessage()?.text}`); await should(dialog.validateNewWorkspace(false)).not.be.rejected();
}); });
}); });