Use DevKit for testing

Author: Andrew Hall

tasks/testTasks.ts

@@ -76,7 +76,10 @@ function createIntegrationTestSubTasks() {
 
     for (const projectName of razorIntegrationTestProjects) {
         gulp.task(`test:integration:razor:${projectName}`, async () =>
-            runIntegrationTest(
+            // Run DevKit tests because razor doesn't gracefully handle roslyn restarting
+            // in tests. DevKit prevents that behavior by handling project restore without
+            // requiring it.
+            runDevKitIntegrationTests(
                 projectName,
                 path.join('razor', 'razorIntegrationTests'),
                 `Razor Test Integration ${projectName}`

test/lsptoolshost/integrationTests/integrationHelpers.ts

@@ -13,19 +13,7 @@ import testAssetWorkspace from './testAssets/testAssetWorkspace';
 import { EOL, platform } from 'os';
 import { describe, expect, test } from '@jest/globals';
 
-export async function activateRazorExtension(): Promise<void> {
-    // Razor requires statefulness in the extension and server to communicate
-    // properly with CSharp. That means allowing a restart of the CSharp server
-    // will improperly break that state. This will be fixed in cohosting and
-    // could be potentially fixed now but I timeboxed to unblock adding more tests.
-    // Without this the symptoms in a test will be that all razor files are considered
-    // in the misc workspace.
-    await activateCSharpExtension(false);
-}
-
-export async function activateCSharpExtension(allowRestart?: boolean): Promise<void> {
-    allowRestart = allowRestart ?? true;
-
+export async function activateCSharpExtension(): Promise<void> {
     const csharpExtension = vscode.extensions.getExtension<CSharpExtensionExports>('ms-dotnettools.csharp');
     if (!csharpExtension) {
         throw new Error('Failed to find installation of ms-dotnettools.csharp');
@@ -62,7 +50,7 @@ export async function activateCSharpExtension(allowRestart?: boolean): Promise<v
     console.log('ms-dotnettools.csharp activated');
     console.log(`Extension Log Directory: ${csharpExtension.exports.logDirectory}`);
 
-    if (shouldRestart && allowRestart) {
+    if (shouldRestart) {
         await restartLanguageServer();
     }
 }
@@ -271,6 +259,16 @@ export async function expectText(document: vscode.TextDocument, expectedLines: s
     expect(document.getText()).toBe(expectedText);
 }
 
+export function expectPath(expected: vscode.Uri, actual: vscode.Uri) {
+    if (isLinux()) {
+        expect(actual.path).toBe(expected.path);
+    } else {
+        const actualPath = actual.path.toLowerCase();
+        const expectedPath = expected.path.toLocaleLowerCase();
+        expect(actualPath).toBe(expectedPath);
+    }
+}
+
 export const describeIfCSharp = describeIf(!usingDevKit());
 export const describeIfDevKit = describeIf(usingDevKit());
 export const describeIfNotMacOS = describeIf(!isMacOS());
@@ -297,3 +295,7 @@ function isWindows() {
     const currentPlatform = platform();
     return currentPlatform === 'win32';
 }
+
+function isLinux() {
+    return !(isMacOS() || isWindows());
+}

test/razor/razorIntegrationTests/formatting.integration.test.ts

@@ -9,7 +9,7 @@ import { beforeAll, afterAll, test, expect, beforeEach } from '@jest/globals';
 import testAssetWorkspace from './testAssets/testAssetWorkspace';
 import * as integrationHelpers from '../../lsptoolshost/integrationTests/integrationHelpers';
 
-integrationHelpers.describeIfWindows(`Razor Formatting ${testAssetWorkspace.description}`, function () {
+integrationHelpers.describeIfDevKit(`Razor Formatting ${testAssetWorkspace.description}`, function () {
     beforeAll(async function () {
         if (!integrationHelpers.isRazorWorkspace(vscode.workspace)) {
             return;

test/razor/razorIntegrationTests/hover.integration.test.ts

@@ -9,7 +9,7 @@ import { beforeAll, afterAll, test, expect, beforeEach } from '@jest/globals';
 import testAssetWorkspace from './testAssets/testAssetWorkspace';
 import * as integrationHelpers from '../../lsptoolshost/integrationTests/integrationHelpers';
 
-integrationHelpers.describeIfWindows(`Razor Hover ${testAssetWorkspace.description}`, function () {
+integrationHelpers.describeIfDevKit(`Razor Hover ${testAssetWorkspace.description}`, function () {
     beforeAll(async function () {
         if (!integrationHelpers.isRazorWorkspace(vscode.workspace)) {
             return;

test/razor/razorIntegrationTests/reference.integration.test.ts

@@ -9,13 +9,13 @@ import { beforeAll, afterAll, test, expect, beforeEach } from '@jest/globals';
 import testAssetWorkspace from './testAssets/testAssetWorkspace';
 import * as integrationHelpers from '../../lsptoolshost/integrationTests/integrationHelpers';
 
-integrationHelpers.describeIfWindows(`Razor References ${testAssetWorkspace.description}`, function () {
+integrationHelpers.describeIfDevKit(`Razor References ${testAssetWorkspace.description}`, function () {
     beforeAll(async function () {
         if (!integrationHelpers.isRazorWorkspace(vscode.workspace)) {
             return;
         }
 
-        await integrationHelpers.activateRazorExtension();
+        await integrationHelpers.activateCSharpExtension();
     });
 
     beforeEach(async function () {
@@ -151,9 +151,9 @@ integrationHelpers.describeIfWindows(`Razor References ${testAssetWorkspace.desc
                 const razorFile = integrationHelpers.getFilePath(path.join('Pages', 'References.razor'));
                 const csharpFile = integrationHelpers.getFilePath(path.join('Pages', 'References.razor.cs'));
 
-                expect(sortedLocations[0].uri.path).toBe(razorFile.path);
-                expect(sortedLocations[1].uri.path).toBe(csharpFile.path);
-                expect(sortedLocations[2].uri.path).toBe(csharpFile.path);
+                integrationHelpers.expectPath(razorFile, sortedLocations[0].uri);
+                integrationHelpers.expectPath(csharpFile, sortedLocations[1].uri);
+                integrationHelpers.expectPath(csharpFile, sortedLocations[2].uri);
             }
         );
     });

test/razor/razorIntegrationTests/rename.integration.test.ts

@@ -9,7 +9,7 @@ import { beforeAll, afterAll, test, expect, beforeEach } from '@jest/globals';
 import testAssetWorkspace from './testAssets/testAssetWorkspace';
 import * as integrationHelpers from '../../lsptoolshost/integrationTests/integrationHelpers';
 
-integrationHelpers.describeIfWindows(`Razor Rename ${testAssetWorkspace.description}`, function () {
+integrationHelpers.describeIfDevKit(`Razor Rename ${testAssetWorkspace.description}`, function () {
     beforeAll(async function () {
         if (!integrationHelpers.isRazorWorkspace(vscode.workspace)) {
             return;

test/razor/razorIntegrationTests/testAssets/RazorApp/.vscode/devkit_RazorApp.code-workspace

@@ -0,0 +1,14 @@
+{
+    "folders": [
+        {
+            "path": ".."
+        }
+    ],
+    "settings": {
+        "dotnet.defaultSolution": "RazorApp.sln",
+        "dotnet.server.useOmnisharp": false,
+        "omnisharp.enableLspDriver": false,
+        "razor.server.trace": "Trace",
+        "dotnet.preferCSharpExtension": false
+    }
+}