Handle non-relative target paths

winstliu · winstliu · commit b27b9fff6b64 · 2022-05-25T23:04:28.000-07:00
diff --git a/src/assets.ts b/src/assets.ts
@@ -162,6 +162,11 @@ export class AssetGenerator {
         }
 
         const relativeTargetPath = path.relative(this.workspaceFolder.uri.fsPath, this.startupProject.TargetPath);
+        if (relativeTargetPath === this.startupProject.TargetPath) {
+            // This can happen if, for example, the workspace folder and the target path
+            // are on completely different drives.
+            return this.startupProject.TargetPath;
+        }
         return path.join('${workspaceFolder}', relativeTargetPath);
     }
 
@@ -170,6 +175,8 @@ export class AssetGenerator {
             throw new Error("Startup project not set");
         }
 
+        // Startup project will always be a child of the workspace folder,
+        // so the special check above isn't necessary.
         const relativeProjectPath = path.relative(this.workspaceFolder.uri.fsPath, this.startupProject.Path);
         return path.join('${workspaceFolder}', path.dirname(relativeProjectPath));
     }
diff --git a/test/featureTests/assets.test.ts b/test/featureTests/assets.test.ts
@@ -108,7 +108,7 @@ suite("Asset generation: csproj", () => {
 
         test(`Create launch.json for NET ${version} project opened in workspace with shortname '${shortName}'`, () => {
             let rootPath = path.resolve('testRoot');
-            let info = createMSBuildWorkspaceInformation(path.join(rootPath, 'testApp.csproj'), 'testApp', shortName, /*isExe*/ true);
+            let info = createMSBuildWorkspaceInformation(path.join(rootPath, 'testApp.csproj'), 'testApp', shortName, /*targetPath*/ undefined, /*isExe*/ true);
             let generator = new AssetGenerator(info, createMockWorkspaceFolder(rootPath));
             generator.setStartupProject(0);
             let launchJson = parse(generator.createLaunchJsonConfigurations(ProgramLaunchType.Console), undefined, { disallowComments: true });
@@ -129,9 +129,25 @@ suite("Asset generation: csproj", () => {
         checkProgramPath(rootPath, programPath, info.MsBuild.Projects[0].TargetPath);
     });
 
+    test("Create launch.json for project opened in workspace with non-relative output path", function() {
+        if (process.platform !== "win32") {
+            this.skip();
+        }
+
+        let rootPath = path.resolve('testRoot');
+        let differentDrive = rootPath.startsWith('C:') ? 'D:' : 'C:';
+        let info = createMSBuildWorkspaceInformation(path.join(rootPath, 'testApp.csproj'), 'testApp', 'netcoreapp1.0', `${differentDrive}\\output.dll`);
+        let generator = new AssetGenerator(info, createMockWorkspaceFolder(rootPath));
+        generator.setStartupProject(0);
+        let launchJson = parse(generator.createLaunchJsonConfigurations(ProgramLaunchType.Console), undefined, { disallowComments: true });
+        let programPath: string = launchJson[0].program;
+
+        checkProgramPath(rootPath, programPath, info.MsBuild.Projects[0].TargetPath);
+    });
+
     test("Create launch.json for Blazor web assembly standalone project opened in workspace", () => {
         const rootPath = path.resolve('testRoot');
-        const info = createMSBuildWorkspaceInformation(path.join(rootPath, 'testApp.csproj'), 'testApp', 'netstandard2.1', /*isExe*/ true, /*isWebProject*/ true, /*isBlazorWebAssemblyStandalone*/ true);
+        const info = createMSBuildWorkspaceInformation(path.join(rootPath, 'testApp.csproj'), 'testApp', 'netstandard2.1', /*targetPath*/ undefined, /*isExe*/ true, /*isWebProject*/ true, /*isBlazorWebAssemblyStandalone*/ true);
         const generator = new AssetGenerator(info, createMockWorkspaceFolder(rootPath));
         generator.setStartupProject(0);
         const launchJson = parse(generator.createLaunchJsonConfigurations(ProgramLaunchType.BlazorWebAssemblyStandalone), undefined, { disallowComments: true });
@@ -143,7 +159,7 @@ suite("Asset generation: csproj", () => {
 
     test("Create launch.json for nested Blazor web assembly standalone project opened in workspace", () => {
         let rootPath = path.resolve('testRoot');
-        let info = createMSBuildWorkspaceInformation(path.join(rootPath, 'nested', 'testApp.csproj'), 'testApp', 'netstandard2.1', /*isExe*/ true, /*isWebProject*/ true, /*isBlazorWebAssemblyStandalone*/ true);
+        let info = createMSBuildWorkspaceInformation(path.join(rootPath, 'nested', 'testApp.csproj'), 'testApp', 'netstandard2.1', /*targetPath*/ undefined, /*isExe*/ true, /*isWebProject*/ true, /*isBlazorWebAssemblyStandalone*/ true);
         let generator = new AssetGenerator(info, createMockWorkspaceFolder(rootPath));
         generator.setStartupProject(0);
         let launchJson = parse(generator.createLaunchJsonConfigurations(ProgramLaunchType.BlazorWebAssemblyStandalone), undefined, { disallowComments: true });
@@ -155,7 +171,7 @@ suite("Asset generation: csproj", () => {
 
     test("Create launch.json for Blazor web assembly hosted project opened in workspace", () => {
         const rootPath = path.resolve('testRoot');
-        const info = createMSBuildWorkspaceInformation(path.join(rootPath, 'testApp.csproj'), 'testApp', 'netcoreapp3.0', /*isExe*/ true, /*isWebProject*/ true, /*isBlazorWebAssemblyStandalone*/ false, /*isBlazorWebAssemblyHosted*/ true);
+        const info = createMSBuildWorkspaceInformation(path.join(rootPath, 'testApp.csproj'), 'testApp', 'netcoreapp3.0', /*targetPath*/ undefined, /*isExe*/ true, /*isWebProject*/ true, /*isBlazorWebAssemblyStandalone*/ false, /*isBlazorWebAssemblyHosted*/ true);
         const generator = new AssetGenerator(info, createMockWorkspaceFolder(rootPath));
         generator.setStartupProject(0);
         const launchJson = parse(generator.createLaunchJsonConfigurations(ProgramLaunchType.BlazorWebAssemblyHosted), undefined, { disallowComments: true });
@@ -172,7 +188,7 @@ suite("Asset generation: csproj", () => {
 
     test("Create launch.json for nested Blazor web assembly hosted project opened in workspace", () => {
         let rootPath = path.resolve('testRoot');
-        let info = createMSBuildWorkspaceInformation(path.join(rootPath, 'nested', 'testApp.csproj'), 'testApp', 'netcoreapp3.0', /*isExe*/ true, /*isWebProject*/ true, /*isBlazorWebAssemblyStandalone*/ false, /*isBlazorWebAssemblyHosted*/ true);
+        let info = createMSBuildWorkspaceInformation(path.join(rootPath, 'nested', 'testApp.csproj'), 'testApp', 'netcoreapp3.0', /*targetPath*/ undefined, /*isExe*/ true, /*isWebProject*/ true, /*isBlazorWebAssemblyStandalone*/ false, /*isBlazorWebAssemblyHosted*/ true);
         let generator = new AssetGenerator(info, createMockWorkspaceFolder(rootPath));
         generator.setStartupProject(0);
         let launchJson = parse(generator.createLaunchJsonConfigurations(ProgramLaunchType.BlazorWebAssemblyHosted), undefined, { disallowComments: true });
@@ -189,7 +205,7 @@ suite("Asset generation: csproj", () => {
 
     test("Create launch.json for web project opened in workspace", () => {
         let rootPath = path.resolve('testRoot');
-        let info = createMSBuildWorkspaceInformation(path.join(rootPath, 'testApp.csproj'), 'testApp', 'netcoreapp1.0', /*isExe*/ true, /*isWebProject*/ true);
+        let info = createMSBuildWorkspaceInformation(path.join(rootPath, 'testApp.csproj'), 'testApp', 'netcoreapp1.0', /*targetPath*/ undefined, /*isExe*/ true, /*isWebProject*/ true);
         let generator = new AssetGenerator(info, createMockWorkspaceFolder(rootPath));
         generator.setStartupProject(0);
         let launchJson = parse(generator.createLaunchJsonConfigurations(ProgramLaunchType.Web), undefined, { disallowComments: true });
@@ -200,7 +216,7 @@ suite("Asset generation: csproj", () => {
 
     test("Create launch.json for nested web project opened in workspace", () => {
         let rootPath = path.resolve('testRoot');
-        let info = createMSBuildWorkspaceInformation(path.join(rootPath, 'nested', 'testApp.csproj'), 'testApp', 'netcoreapp1.0', /*isExe*/ true, /*isWebProject*/ true);
+        let info = createMSBuildWorkspaceInformation(path.join(rootPath, 'nested', 'testApp.csproj'), 'testApp', 'netcoreapp1.0', /*targetPath*/ undefined, /*isExe*/ true, /*isWebProject*/ true);
         let generator = new AssetGenerator(info, createMockWorkspaceFolder(rootPath));
         generator.setStartupProject(0);
         let launchJson = parse(generator.createLaunchJsonConfigurations(ProgramLaunchType.Web), undefined, { disallowComments: true });
@@ -291,7 +307,7 @@ suite("Asset generation: csproj", () => {
 
     test("createLaunchJsonConfigurationsArray removes comments", () => {
         let rootPath = path.resolve('testRoot');
-        let info = createMSBuildWorkspaceInformation(path.join(rootPath, 'testApp.csproj'), 'testApp', 'netcoreapp1.0', /*isExe*/ true, /*isWebProject*/ true);
+        let info = createMSBuildWorkspaceInformation(path.join(rootPath, 'testApp.csproj'), 'testApp', 'netcoreapp1.0', /*targetPath*/ undefined, /*isExe*/ true, /*isWebProject*/ true);
         let generator = new AssetGenerator(info, createMockWorkspaceFolder(rootPath));
         generator.setStartupProject(0);
         let launchConfigurations: vscode.DebugConfiguration[] = generator.createLaunchJsonConfigurationsArray(ProgramLaunchType.Web);
@@ -309,8 +325,12 @@ suite("Asset generation: csproj", () => {
 });
 
 function checkProgramPath(rootPath: string, programPath: string, targetPath: string): void {
-    programPath.should.startWith('${workspaceFolder}/');
-    programPath.should.equal(targetPath.replace(rootPath, '${workspaceFolder}').replaceAll(path.win32.sep, path.posix.sep));
+    if (path.relative(rootPath, targetPath) !== targetPath) {
+        programPath.should.startWith('${workspaceFolder}/');
+        programPath.should.equal(targetPath.replace(rootPath, '${workspaceFolder}').replaceAll(path.win32.sep, path.posix.sep));
+    } else {
+        programPath.should.equal(targetPath.replaceAll(path.win32.sep, path.posix.sep));
+    }
 }
 
 function createMockWorkspaceFolder(rootPath: string): vscode.WorkspaceFolder {
@@ -321,7 +341,7 @@ function createMockWorkspaceFolder(rootPath: string): vscode.WorkspaceFolder {
     };
 }
 
-function createMSBuildWorkspaceInformation(projectPath: string, assemblyName: string, targetFrameworkShortName: string, isExe: boolean = true, isWebProject: boolean = false, isBlazorWebAssemblyStandalone: boolean = false, isBlazorWebAssemblyHosted: boolean = false): protocol.WorkspaceInformationResponse {
+function createMSBuildWorkspaceInformation(projectPath: string, assemblyName: string, targetFrameworkShortName: string, targetPath: string = undefined, isExe: boolean = true, isWebProject: boolean = false, isBlazorWebAssemblyStandalone: boolean = false, isBlazorWebAssemblyHosted: boolean = false): protocol.WorkspaceInformationResponse {
     return {
         MsBuild: {
             SolutionPath: '',
@@ -330,7 +350,7 @@ function createMSBuildWorkspaceInformation(projectPath: string, assemblyName: st
                     ProjectGuid: '',
                     Path: projectPath,
                     AssemblyName: assemblyName,
-                    TargetPath: path.join(path.dirname(projectPath), 'bin', 'Debug', new Date().getTime().toString(), targetFrameworkShortName, `${assemblyName}.dll`),
+                    TargetPath: targetPath ?? path.join(path.dirname(projectPath), 'bin', 'Debug', new Date().getTime().toString(), targetFrameworkShortName, `${assemblyName}.dll`),
                     TargetFramework: '',
                     SourceFiles: [],
                     TargetFrameworks: [

Original file line number	Diff line number	Diff line change
`@@ -162,6 +162,11 @@ export class AssetGenerator {`
`162`	`162`	`}`
`163`	`163`
`164`	`164`	`const relativeTargetPath = path.relative(this.workspaceFolder.uri.fsPath, this.startupProject.TargetPath);`
	`165`	`+ if (relativeTargetPath === this.startupProject.TargetPath) {`
	`166`	`+ // This can happen if, for example, the workspace folder and the target path`
	`167`	`+ // are on completely different drives.`
	`168`	`+ return this.startupProject.TargetPath;`
	`169`	`+ }`
`165`	`170`	`return path.join('${workspaceFolder}', relativeTargetPath);`
`166`	`171`	`}`
`167`	`172`
`@@ -170,6 +175,8 @@ export class AssetGenerator {`
`170`	`175`	`throw new Error("Startup project not set");`
`171`	`176`	`}`
`172`	`177`
	`178`	`+ // Startup project will always be a child of the workspace folder,`
	`179`	`+ // so the special check above isn't necessary.`
`173`	`180`	`const relativeProjectPath = path.relative(this.workspaceFolder.uri.fsPath, this.startupProject.Path);`
`174`	`181`	`return path.join('${workspaceFolder}', path.dirname(relativeProjectPath));`
`175`	`182`	`}`