Add razor rename integration tests (#7675)

Adds a new rename test and updates the test project to be more modern and target net6. Makes razor integration tests run on windows only until issues with linux/mac are identified and fixed

Author: Andrew Hall

.vscode/launch.json

@@ -66,7 +66,7 @@
             "internalConsoleOptions": "openOnSessionStart"
         },
         {
-            "name": "Launch Current File BasicRazorApp2_1 Integration Tests",
+            "name": "[Razor] Run Current File Integration Test",
             "type": "extensionHost",
             "request": "launch",
             "runtimeExecutable": "${execPath}",
@@ -76,7 +76,7 @@
                 // The profile can be found under /test/csharp-test-profile.
                 "--profile",
                 "csharp-test-profile",
-                "${workspaceRoot}/test/razor/razorIntegrationTests/testAssets/BasicRazorApp2_1/.vscode/lsp_tools_host_BasicRazorApp2_1.code-workspace",
+                "${workspaceRoot}/test/razor/razorIntegrationTests/testAssets/RazorApp/.vscode/RazorApp.code-workspace",
                 "--extensionDevelopmentPath=${workspaceRoot}",
                 "--extensionTestsPath=${workspaceRoot}/out/test/razor/razorIntegrationTests",
                 "--log",
@@ -89,7 +89,7 @@
             "sourceMaps": true,
             "outFiles": ["${workspaceRoot}/dist/*.js", "${workspaceRoot}/out/test/**/*.js"],
             "resolveSourceMapLocations": ["${workspaceFolder}/**", "!**/node_modules/**"],
-            "preLaunchTask": "buildDev",
+            "preLaunchTask": "buildTest",
             "internalConsoleOptions": "openOnSessionStart"
         },
         {
@@ -204,7 +204,7 @@
             "id": "omnisharpAssetName",
             "description": "The name of the asset folder to use for the OmniSharp integration test.",
             "type": "pickString",
-            "options": ["singleCsproj", "BasicRazorApp2_1", "slnWithCsproj", "slnFilterWithCsproj", "slnWithGenerator"]
+            "options": ["singleCsproj", "RazorApp", "slnWithCsproj", "slnFilterWithCsproj", "slnWithGenerator"]
         },
         {
             "id": "gulpTaskName",

.vscode/tasks.json

@@ -1,48 +1,50 @@
 {
-	"version": "2.0.0",
-	"presentation": {
-		"echo": true,
-		"reveal": "always",
-		"focus": false,
-		"panel": "shared"
-	},
-	"tasks": [
-		{
-			"label": "build",
-			"command": "npm",
-			"type": "shell",
-			"args": [
-				"run",
-				"compile"
-			],
-			"group": {
-				"kind": "build",
-				"isDefault": true
-			}
-		},
-		{
-			"label": "buildDev",
-			"command": "npm",
-			"type": "shell",
-			"args": [
-				"run",
-				"compileDev"
-			],
-			"group": {
-				"kind": "build",
-				"isDefault": true
-			}
-		},
-		{
-			"label": "test",
-			"command": "echo",
-			"group": {
-				"kind": "test",
-				"isDefault": true
-			},
-			"args": [
-				"Run tests in VS Code by launching the debugger with the 'Launch Tests' configuration."
-			]
-		},
-	]
-}
+    "version": "2.0.0",
+    "presentation": {
+        "echo": true,
+        "reveal": "always",
+        "focus": false,
+        "panel": "shared"
+    },
+    "tasks": [
+        {
+            "label": "build",
+            "command": "npm",
+            "type": "shell",
+            "args": ["run", "compile"],
+            "group": {
+                "kind": "build",
+                "isDefault": true
+            }
+        },
+        {
+            "label": "buildDev",
+            "command": "npm",
+            "type": "shell",
+            "args": ["run", "compileDev"],
+            "group": {
+                "kind": "build",
+                "isDefault": true
+            }
+        },
+        {
+            "label": "buildTest",
+            "command": "npm",
+            "type": "shell",
+            "args": ["run", "compileTest"],
+            "group": {
+                "kind": "build",
+                "isDefault": true
+            }
+        },
+        {
+            "label": "test",
+            "command": "echo",
+            "group": {
+                "kind": "test",
+                "isDefault": true
+            },
+            "args": ["Run tests in VS Code by launching the debugger with the 'Launch Tests' configuration."]
+        }
+    ]
+}

CONTRIBUTING.md

@@ -59,7 +59,7 @@ To debug integration tests
 1.  Import the `csharp-test-profile.code-profile` in VSCode to setup a clean profile in which to run integration tests.  This must be imported at least once to use the launch configurations (ensure the extensions are updated in the profile).
 2.  Open any integration test file and <kbd>F5</kbd> launch with the correct launch configuration selected.
     - For integration tests inside `test/lsptoolshost`, use either `Launch Current File slnWithCsproj Integration Tests` or `[DevKit] Launch Current File slnWithCsproj Integration Tests` (to run tests using C# + C# Dev Kit)
-    - For integration tests inside `test/razor`, use `Launch Current File BasicRazorApp2_1 Integration Tests`
+    - For integration tests inside `test/razor`, use `[Razor] Run Current File Integration Test`
     - For integration tests inside `test/omnisharp`, use one of the `Omnisharp:` current file profiles
 
 These will allow you to actually debug the test, but the 'Razor integration tests' configuration does not.

package.json

@@ -65,6 +65,7 @@
     "compile": "tsc -p ./ && npx eslint ./ && npm run l10nDevGenerateLocalizationBundle && npm run compile:razorTextMate",
     "compile:razorTextMate": "npx js-yaml src/razor/syntaxes/aspnetcorerazor.tmLanguage.yml > src/razor/syntaxes/aspnetcorerazor.tmLanguage.json",
     "compileDev": "tsc -p ./ && npx eslint ./ && webpack --mode development && npm run l10nDevGenerateLocalizationBundle",
+    "compileTest": "tsc -p ./ && webpack --mode development",
     "watch": "tsc -watch -p ./",
     "test": "tsc -p ./ && gulp test",
     "test:withoutDevKit": "tsc -p ./ && gulp test:withoutDevKit",

tasks/testTasks.ts

@@ -75,7 +75,7 @@ function createIntegrationTestSubTasks() {
         gulp.series(integrationTestProjects.map((projectName) => `test:integration:devkit:${projectName}`))
     );
 
-    const razorIntegrationTestProjects = ['BasicRazorApp2_1'];
+    const razorIntegrationTestProjects = ['RazorApp'];
     for (const projectName of razorIntegrationTestProjects) {
         gulp.task(`test:razorintegration:${projectName}`, async () =>
             runIntegrationTest(

test/lsptoolshost/integrationTests/integrationHelpers.ts

@@ -10,7 +10,7 @@ import { CSharpExtensionExports } from '../../../src/csharpExtensionExports';
 import { existsSync } from 'fs';
 import { ServerState } from '../../../src/lsptoolshost/serverStateChange';
 import testAssetWorkspace from './testAssets/testAssetWorkspace';
-import { EOL } from 'os';
+import { EOL, platform } from 'os';
 import { describe, expect, test } from '@jest/globals';
 
 export async function activateCSharpExtension(): Promise<void> {
@@ -102,7 +102,7 @@ export async function restartLanguageServer(): Promise<void> {
 }
 
 export function isRazorWorkspace(workspace: typeof vscode.workspace) {
-    return isGivenSln(workspace, 'BasicRazorApp2_1');
+    return isGivenSln(workspace, 'RazorApp');
 }
 
 export function isSlnWithGenerator(workspace: typeof vscode.workspace) {
@@ -229,8 +229,12 @@ export async function expectText(document: vscode.TextDocument, expectedLines: s
 
 export const describeIfCSharp = describeIf(!usingDevKit());
 export const describeIfDevKit = describeIf(usingDevKit());
+export const describeIfNotMacOS = describeIf(!isMacOS());
+export const describeIfWindows = describeIf(isWindows());
 export const testIfCSharp = testIf(!usingDevKit());
 export const testIfDevKit = testIf(usingDevKit());
+export const testIfNotMacOS = testIf(!isMacOS());
+export const testIfWindows = testIf(isWindows());
 
 function describeIf(condition: boolean) {
     return condition ? describe : describe.skip;
@@ -239,3 +243,13 @@ function describeIf(condition: boolean) {
 function testIf(condition: boolean) {
     return condition ? test : test.skip;
 }
+
+function isMacOS() {
+    const currentPlatform = platform();
+    return currentPlatform === 'darwin';
+}
+
+function isWindows() {
+    const currentPlatform = platform();
+    return currentPlatform === 'win32';
+}

test/lsptoolshost/integrationTests/testAssets/basicRazorApp21.ts renamed to test/lsptoolshost/integrationTests/testAssets/razorApp.ts

@@ -6,10 +6,10 @@
 import { ITestAssetWorkspace } from './testAssets';
 
 const workspace: ITestAssetWorkspace = {
-    description: 'Basic Razor app',
+    description: 'Razor App',
     projects: [
         {
-            relativeFilePath: 'BasicRazorApp2_1.csproj',
+            relativeFilePath: 'RazorApp.csproj',
         },
     ],
 };

test/lsptoolshost/integrationTests/testAssets/testAssetWorkspace.ts

@@ -11,14 +11,14 @@ import { ITestAssetWorkspace, TestAssetWorkspace } from './testAssets';
 import singleCsproj from './singleCsproj';
 import slnWithCsproj from './slnWithCsproj';
 import slnFilterWithCsproj from './slnFilterWithCsproj';
-import BasicRazorApp2_1 from './basicRazorApp21';
+import RazorApp from './razorApp';
 import slnWithGenerator from './slnWithGenerator';
 
 const testAssetWorkspaces: { [x: string]: ITestAssetWorkspace } = {
     singleCsproj,
     slnWithCsproj,
     slnFilterWithCsproj,
-    BasicRazorApp2_1,
+    RazorApp,
     slnWithGenerator,
 };
 

test/omnisharp/omnisharpIntegrationTests/testAssets/activeTestAssetWorkspace.ts

@@ -11,7 +11,7 @@ import { ITestAssetWorkspace } from '../../../lsptoolshost/integrationTests/test
 import singleCsproj from '../../../lsptoolshost/integrationTests/testAssets/singleCsproj';
 import slnWithCsproj from '../../../lsptoolshost/integrationTests/testAssets/slnWithCsproj';
 import slnFilterWithCsproj from '../../../lsptoolshost/integrationTests/testAssets/slnFilterWithCsproj';
-import BasicRazorApp2_1 from '../../../lsptoolshost/integrationTests/testAssets/basicRazorApp21';
+import BasicRazorApp2_1 from '../../../lsptoolshost/integrationTests/testAssets/razorApp';
 import slnWithGenerator from '../../../lsptoolshost/integrationTests/testAssets/slnWithGenerator';
 import { OmnisharpTestAssetWorkspace } from './omnisharpTestAssetWorkspace';
 

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

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