Fix workspaceRoot macro for insights (#4686)

* Fix workspaceRoot macro for insights

The workspaceRoot macro wasn't working correctly for finding the queryFile. There were a couple of issues :

1. The path separators were hardcoded as / which wasn't xplat-compatible
2. They required the first section of the path was one of the folders in the workspace - e.g. if the workspace contained a folder named foo you'd have to specify ${workspaceRoot}\foo\myfile.sql. This is inconsistent with the folder logich was just appends the path after ${workspaceRoot} to the folder that's currently open

I changed the logic to just append the relative part of the path to every folder currently open in the workspace and choose the first one that it found that contained the file we were told to look for - which follows the convention the folder logic uses. If the file doesn't exist it'll just fall back to using the path without the macro (which is likely to not resolve and thus will display an error, but there's nothing we can do at that point anyways)

* Switch to using VS Code resolver (support for more than just workspaceRoot) and move resolution code into helper method so it can be used by the multiple places it's called. Added tests for the methods.

* Add test for invalid param

* Change resolveQueryFilePath to be a standalone exported function. Change it to throw if the file can't be resolved/found so callers can display error correctly. Added more tests to covery new scenarios. Switch to using pfs instead of fs for file existance checks.

* Add extra param to InsightsDialogController construction in test

* Fix formatting and test errors.

* Change to suiteSetup and suiteTeardown so the setup/teardown is only ran once instead of once per test - we don't need unique files and this stops a race condition error with deleting the test folder.

* spaces -> tabs

src/sqltest/parts/insights/insightsDialogController.test.ts

@@ -49,6 +49,7 @@ suite('Insights Dialog Controller Tests', () => {
 			undefined,
 			instMoq.object,
 			connMoq.object,
+			undefined,
 			undefined
 		);
 

src/sqltest/parts/insights/insightsUtils.test.ts

@@ -0,0 +1,178 @@
+/*---------------------------------------------------------------------------------------------
+*  Copyright (c) Microsoft Corporation. All rights reserved.
+*  Licensed under the Source EULA. See License.txt in the project root for license information.
+*--------------------------------------------------------------------------------------------*/
+
+import { equal } from 'assert';
+import * as os from 'os';
+
+import { resolveQueryFilePath } from 'sql/workbench/services/insights/common/insightsUtils';
+import { TestWindowService } from 'sqltest/stubs/windowTestService';
+
+import * as path from 'vs/base/common/path';
+import * as pfs from 'vs/base/node/pfs';
+
+import { getRandomTestPath } from 'vs/base/test/node/testUtils';
+import { Workspace, toWorkspaceFolders } from 'vs/platform/workspace/common/workspace';
+import { ConfigurationResolverService } from 'vs/workbench/services/configurationResolver/browser/configurationResolverService';
+import { TestContextService } from 'vs/workbench/test/workbenchTestServices';
+
+suite('Insights Utils tests', function () {
+	let testRootPath: string;
+	let queryFileDir: string;
+	let queryFilePath: string;
+
+	suiteSetup(done => {
+		// Create test file - just needs to exist for verifying the path resolution worked correctly
+		testRootPath = path.join(os.tmpdir(), 'adstests');
+		queryFileDir = getRandomTestPath(testRootPath, 'insightsutils');
+		pfs.mkdirp(queryFileDir).then(() => {
+			queryFilePath = path.join(queryFileDir, 'test.sql');
+			pfs.writeFile(queryFilePath, '').then(done());
+		});
+
+	});
+
+	test('resolveQueryFilePath resolves path correctly with fully qualified path', async () => {
+		let configurationResolverService = new ConfigurationResolverService(
+			new TestWindowService({}),
+			undefined,
+			undefined,
+			undefined,
+			undefined,
+			new TestContextService(),
+			undefined);
+
+		let resolvedPath = await resolveQueryFilePath(queryFilePath, new TestContextService(), configurationResolverService);
+		equal(resolvedPath, queryFilePath);
+	});
+
+	test('resolveQueryFilePath resolves path correctly with workspaceRoot var and non-empty workspace containing file', async () => {
+		// Create mock context service with our test folder added as a workspace folder for resolution
+		let contextService = new TestContextService(
+			new Workspace(
+				'TestWorkspace',
+				toWorkspaceFolders([{ path: queryFileDir }])
+			));
+		let configurationResolverService = new ConfigurationResolverService(
+			new TestWindowService({}),
+			undefined,
+			undefined,
+			undefined,
+			undefined,
+			contextService,
+			undefined);
+
+		let resolvedPath = await resolveQueryFilePath(path.join('${workspaceRoot}', 'test.sql'), contextService, configurationResolverService);
+		equal(resolvedPath, queryFilePath);
+	});
+
+	test('resolveQueryFilePath throws with workspaceRoot var and non-empty workspace not containing file', async (done) => {
+		let tokenizedPath = path.join('${workspaceRoot}', 'test.sql');
+		// Create mock context service with a folder NOT containing our test file to verify it returns original path
+		let contextService = new TestContextService(
+			new Workspace(
+				'TestWorkspace',
+				toWorkspaceFolders([{ path: os.tmpdir() }])
+			));
+		let configurationResolverService = new ConfigurationResolverService(
+			new TestWindowService({}),
+			undefined,
+			undefined,
+			undefined,
+			undefined,
+			contextService,
+			undefined);
+
+		try {
+			await resolveQueryFilePath(tokenizedPath, contextService, configurationResolverService);
+		}
+		catch (e) {
+			done();
+		}
+	});
+
+	test('resolveQueryFilePath throws with workspaceRoot var and empty workspace', async (done) => {
+		let tokenizedPath = path.join('${workspaceRoot}', 'test.sql');
+		// Create mock context service with an empty workspace
+		let contextService = new TestContextService(
+			new Workspace(
+				'TestWorkspace'));
+		let configurationResolverService = new ConfigurationResolverService(
+			new TestWindowService({}),
+			undefined,
+			undefined,
+			undefined,
+			undefined,
+			contextService,
+			undefined);
+
+		try {
+			await resolveQueryFilePath(tokenizedPath, contextService, configurationResolverService);
+		}
+		catch (e) {
+			done();
+		}
+	});
+
+	test('resolveQueryFilePath resolves path correctly with env var and empty workspace', async () => {
+		let contextService = new TestContextService(
+			new Workspace('TestWorkspace'));
+
+		// Create mock window service with env variable containing test folder for resolution
+		let configurationResolverService = new ConfigurationResolverService(
+			new TestWindowService({ TEST_PATH: queryFileDir }),
+			undefined,
+			undefined,
+			undefined,
+			undefined,
+			undefined,
+			undefined);
+
+		let resolvedPath = await resolveQueryFilePath(path.join('${env:TEST_PATH}', 'test.sql'), contextService, configurationResolverService);
+		equal(resolvedPath, queryFilePath);
+	});
+
+	test('resolveQueryFilePath resolves path correctly with env var and non-empty workspace', async () => {
+		let contextService = new TestContextService(
+			new Workspace('TestWorkspace', toWorkspaceFolders([{ path: os.tmpdir() }])));
+
+		// Create mock window service with env variable containing test folder for resolution
+		let configurationResolverService = new ConfigurationResolverService(
+			new TestWindowService({ TEST_PATH: queryFileDir }),
+			undefined,
+			undefined,
+			undefined,
+			undefined,
+			undefined,
+			undefined);
+
+		let resolvedPath = await resolveQueryFilePath(path.join('${env:TEST_PATH}', 'test.sql'), contextService, configurationResolverService);
+		equal(resolvedPath, queryFilePath);
+	});
+
+	test('resolveQueryFilePath throws if invalid param var specified', async (done) => {
+		let invalidPath = path.join('${INVALID}', 'test.sql');
+		let configurationResolverService = new ConfigurationResolverService(
+			new TestWindowService({}),
+			undefined,
+			undefined,
+			undefined,
+			undefined,
+			undefined,
+			undefined);
+
+		try {
+			await resolveQueryFilePath(invalidPath, new TestContextService(), configurationResolverService);
+		}
+		catch (e) {
+			done();
+		}
+
+	});
+
+	suiteTeardown(done => {
+		// Clean up our test files
+		pfs.del(testRootPath).then(done());
+	});
+});

src/sqltest/stubs/windowTestService.ts

@@ -0,0 +1,19 @@
+/*---------------------------------------------------------------------------------------------
+*  Copyright (c) Microsoft Corporation. All rights reserved.
+*  Licensed under the Source EULA. See License.txt in the project root for license information.
+*--------------------------------------------------------------------------------------------*/
+
+import * as platform from 'vs/base/common/platform';
+import { IWindowConfiguration } from 'vs/platform/windows/common/windows';
+import { TestWindowService as vsTestWindowService } from 'vs/workbench/test/workbenchTestServices';
+
+export class TestWindowService extends vsTestWindowService {
+
+	constructor(private env: platform.IProcessEnvironment) {
+		super();
+	}
+
+	getConfiguration(): IWindowConfiguration {
+		return { userEnv: this.env } as IWindowConfiguration;
+	}
+}