From 913421044acb0b39537b153368019865a8c3f0dc Mon Sep 17 00:00:00 2001
From: David Barbet <dabarbet@microsoft.com>
Date: Wed, 28 Aug 2024 11:35:48 -0700
Subject: [PATCH] Add workspace symbol tests

---
 test/integrationTests/integrationHelpers.ts   | 16 +++--
 .../workspaceSymbol.integration.test.ts       | 67 +++++++++++++++++++
 2 files changed, 77 insertions(+), 6 deletions(-)
 create mode 100644 test/integrationTests/workspaceSymbol.integration.test.ts

diff --git a/test/integrationTests/integrationHelpers.ts b/test/integrationTests/integrationHelpers.ts
index 5f3405e82..98a203e1d 100644
--- a/test/integrationTests/integrationHelpers.ts
+++ b/test/integrationTests/integrationHelpers.ts
@@ -122,15 +122,19 @@ export async function getCodeLensesAsync(): Promise<vscode.CodeLens[]> {
 
 export function sortLocations(locations: vscode.Location[]): vscode.Location[] {
     return locations.sort((a, b) => {
-        const uriCompare = a.uri.fsPath.localeCompare(b.uri.fsPath);
-        if (uriCompare !== 0) {
-            return uriCompare;
-        }
-
-        return a.range.start.compareTo(b.range.start);
+        return compareLocations(a, b);
     });
 }
 
+export function compareLocations(a: vscode.Location, b: vscode.Location): number {
+    const uriCompare = a.uri.fsPath.localeCompare(b.uri.fsPath);
+    if (uriCompare !== 0) {
+        return uriCompare;
+    }
+
+    return a.range.start.compareTo(b.range.start);
+}
+
 function isGivenSln(workspace: typeof vscode.workspace, expectedProjectFileName: string) {
     const primeWorkspace = workspace.workspaceFolders![0];
     const projectFileName = primeWorkspace.uri.fsPath.split(path.sep).pop();
diff --git a/test/integrationTests/workspaceSymbol.integration.test.ts b/test/integrationTests/workspaceSymbol.integration.test.ts
new file mode 100644
index 000000000..8473b074f
--- /dev/null
+++ b/test/integrationTests/workspaceSymbol.integration.test.ts
@@ -0,0 +1,67 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import * as vscode from 'vscode';
+import testAssetWorkspace from './testAssets/testAssetWorkspace';
+import { activateCSharpExtension, closeAllEditorsAsync, compareLocations } from './integrationHelpers';
+import { describe, beforeAll, afterAll, test, expect, afterEach } from '@jest/globals';
+
+describe(`[${testAssetWorkspace.description}] Workspace Symbol Tests`, () => {
+    beforeAll(async () => {
+        await activateCSharpExtension();
+    });
+
+    afterAll(async () => {
+        await testAssetWorkspace.cleanupWorkspace();
+    });
+
+    afterEach(async () => {
+        await closeAllEditorsAsync();
+    });
+
+    test('Go to finds multiple symbols in workspace', async () => {
+        const symbols = await getWorkspaceSymbols('Completion');
+
+        expect(symbols).toHaveLength(3);
+
+        expect(symbols[0].name).toEqual('Completion');
+        expect(symbols[0].containerName).toContain('project app');
+        expect(symbols[0].kind).toEqual(vscode.SymbolKind.Class);
+        expect(symbols[0].location.uri.fsPath).toContain('completion.cs');
+        expect(symbols[0].location.range).toEqual(new vscode.Range(4, 10, 4, 20));
+
+        expect(symbols[1].name).toEqual('shouldHaveCompletions');
+        expect(symbols[1].containerName).toContain('in Completion');
+        expect(symbols[1].kind).toEqual(vscode.SymbolKind.Method);
+        expect(symbols[1].location.uri.fsPath).toContain('completion.cs');
+        expect(symbols[1].location.range).toEqual(new vscode.Range(6, 20, 6, 41));
+
+        expect(symbols[2].name).toEqual('CompletionBase');
+        expect(symbols[2].containerName).toContain('project app');
+        expect(symbols[2].kind).toEqual(vscode.SymbolKind.Class);
+        expect(symbols[2].location.uri.fsPath).toContain('completionBase.cs');
+        expect(symbols[2].location.range).toEqual(new vscode.Range(4, 10, 4, 24));
+    });
+
+    test('Go to finds single method in workspace', async () => {
+        const symbols = await getWorkspaceSymbols('TestMain');
+
+        expect(symbols).toHaveLength(1);
+        expect(symbols[0].name).toEqual('TestMain');
+        expect(symbols[0].containerName).toContain('in TestProgram');
+        expect(symbols[0].kind).toEqual(vscode.SymbolKind.Method);
+        expect(symbols[0].location.uri.fsPath).toContain('semantictokens.cs');
+        expect(symbols[0].location.range).toEqual(new vscode.Range(4, 26, 4, 34));
+    });
+});
+
+async function getWorkspaceSymbols(filter: string): Promise<vscode.SymbolInformation[]> {
+    const symbols = <vscode.SymbolInformation[]>(
+        await vscode.commands.executeCommand('vscode.executeWorkspaceSymbolProvider', filter)
+    );
+
+    symbols.sort((a, b) => compareLocations(a.location, b.location));
+    return symbols;
+}