Move razor integration tests to their own thing

davidwengier · davidwengier · commit c880e6b23698 · 2023-10-09T16:52:57.000+11:00
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -43,34 +43,6 @@
             ],
             "preLaunchTask": "buildDev"
         },
-        {
-            "name": "Launch Current File BasicRazorApp Integration Tests",
-            "type": "extensionHost",
-            "request": "launch",
-            "runtimeExecutable": "${execPath}",
-            "args": [
-                // Create a temp profile that has no extensions / user settings.
-                // This allows us to only have the C# extension + the dotnet runtime installer extension dependency.
-                "--profile-temp",
-                "${workspaceRoot}/test/integrationTests/testAssets/BasicRazorApp2_1/.vscode/lsp_tools_host_BasicRazorApp2_1.code-workspace",
-                "--extensionDevelopmentPath=${workspaceRoot}",
-                "--extensionTestsPath=${workspaceRoot}/out/test/integrationTests",
-            ],
-            "env": {
-                "CODE_EXTENSIONS_PATH": "${workspaceRoot}",
-                "TEST_FILE_FILTER": "${file}"
-            },
-            "sourceMaps": true,
-            "outFiles": [
-              "${workspaceRoot}/dist/*.js",
-              "${workspaceRoot}/out/test/**/*.js"
-            ],
-            "resolveSourceMapLocations": [
-                "${workspaceFolder}/**",
-                "!**/node_modules/**"
-            ],
-            "preLaunchTask": "buildDev"
-        },
         {
             "type": "node",
             "request": "launch",
@@ -351,6 +323,17 @@
             "generateOptionsSchema"
         ],
         "cwd": "${workspaceFolder}"
+    },
+    {
+        "type": "node",
+        "request": "launch",
+        "name": "Razor integration tests",
+        "preLaunchTask": "build",
+        "program": "${workspaceFolder}/node_modules/gulp/bin/gulp.js",
+        "args": [
+            "test:razorintegration"
+        ],
+        "cwd": "${workspaceFolder}"
     }
     ]
 }
diff --git a/jest.config.ts b/jest.config.ts
@@ -8,6 +8,7 @@ const config: Config = {
     projects: [
         '<rootDir>/test/unitTests/jest.config.ts',
         '<rootDir>/test/integrationTests/jest.config.ts',
+        '<rootDir>/test/razorIntegrationTests/jest.config.ts',
         '<rootDir>/test/razorTests/jest.config.ts',
         '<rootDir>/omnisharptest/omnisharpJestTests/jest.config.ts',
     ],
diff --git a/package.json b/package.json
@@ -63,6 +63,7 @@
     "test": "tsc -p ./ && gulp test",
     "test:integration": "tsc -p ./ && gulp test:integration",
     "test:razor": "tsc -p ./ && npm run compile:razorTextMate && gulp test:razor",
+    "test:razorintegration": "tsc -p ./ && gulp test:razorintegration",
     "omnisharptest": "tsc -p ./ && gulp omnisharptest",
     "omnisharptest:unit": "tsc -p ./ && gulp omnisharptest:unit",
     "omnisharptest:feature": "tsc -p ./ && gulp omnisharptest:feature",
diff --git a/tasks/projectPaths.ts b/tasks/projectPaths.ts
@@ -23,8 +23,14 @@ export const omnisharpTestRootPath = path.join(rootPath, 'out', 'omnisharptest')
 export const omnisharpFeatureTestRunnerPath = path.join(omnisharpTestRootPath, 'runFeatureTests.js');
 
 export const integrationTestAssetsRootPath = path.join(rootPath, 'test', 'integrationTests', 'testAssets');
+export const razorIntegrationTestAssetsRootPath = path.join(rootPath, 'test', 'razorIntegrationTests', 'testAssets');
 
 export const testRootPath = path.join(rootPath, 'out', 'test');
 export const integrationTestRunnerPath = path.join(testRootPath, 'integrationTests', 'runIntegrationTests.js');
+export const razorIntegrationTestRunnerPath = path.join(
+    testRootPath,
+    'razorIntegrationTests',
+    'runIntegrationTests.js'
+);
 
 export const nodePath = path.join(process.env.NVM_BIN ? `${process.env.NVM_BIN}${path.sep}` : '', 'node');
diff --git a/tasks/testTasks.ts b/tasks/testTasks.ts
@@ -14,6 +14,8 @@ import {
     omnisharpTestRootPath,
     testRootPath,
     integrationTestRunnerPath,
+    razorIntegrationTestAssetsRootPath,
+    razorIntegrationTestRunnerPath,
 } from './projectPaths';
 import spawnNode from './spawnNode';
 import * as jest from 'jest';
@@ -45,6 +47,16 @@ gulp.task('test:razor', async () => {
     runJestTest(razorTestProjectName);
 });
 
+const razorIntegrationTestProjects = ['BasicRazorApp2_1'];
+for (const projectName of razorIntegrationTestProjects) {
+    gulp.task(`test:razorintegration:${projectName}`, async () => runIntegrationTest(projectName, /* razor */ true));
+}
+
+gulp.task(
+    'test:razorintegration',
+    gulp.series(razorIntegrationTestProjects.map((projectName) => `test:razorintegration:${projectName}`))
+);
+
 gulp.task('omnisharptest:unit', async () => {
     const result = await spawnNode([
         mochaPath,
@@ -113,7 +125,7 @@ gulp.task(
     gulp.series(integrationTestProjects.map((projectName) => `test:integration:${projectName}`))
 );
 
-gulp.task('test', gulp.series('test:unit', 'test:integration', 'test:razor'));
+gulp.task('test', gulp.series('test:unit', 'test:integration', 'test:razor', 'test:razorintegration'));
 
 async function runOmnisharpIntegrationTest(testAssetName: string, engine: 'stdio' | 'lsp') {
     const workspaceFile = `omnisharp${engine === 'lsp' ? '_lsp' : ''}_${testAssetName}.code-workspace`;
@@ -145,22 +157,23 @@ async function runOmnisharpIntegrationTest(testAssetName: string, engine: 'stdio
     return result;
 }
 
-async function runIntegrationTest(testAssetName: string) {
+async function runIntegrationTest(testAssetName: string, razor = false) {
     const workspacePath = path.join(
-        integrationTestAssetsRootPath,
+        razor ? razorIntegrationTestAssetsRootPath : integrationTestAssetsRootPath,
         testAssetName,
         '.vscode',
         `lsp_tools_host_${testAssetName}.code-workspace`
     );
-    const codeTestsPath = path.join(testRootPath, 'integrationTests');
+    const codeTestsPath = path.join(testRootPath, razor ? 'razorIntegrationTests' : 'integrationTests');
 
     const env = {
         CODE_TESTS_WORKSPACE: workspacePath,
         CODE_EXTENSIONS_PATH: rootPath,
         EXTENSIONS_TESTS_PATH: path.join(codeTestsPath, 'index.js'),
     };
 
-    const result = await spawnNode([integrationTestRunnerPath, '--enable-source-maps'], { env, cwd: rootPath });
+    const runnerPath = razor ? razorIntegrationTestRunnerPath : integrationTestRunnerPath;
+    const result = await spawnNode([runnerPath, '--enable-source-maps'], { env, cwd: rootPath });
 
     if (result.code === null || result.code > 0) {
         // Ensure that gulp fails when tests fail
diff --git a/test/razorIntegrationTests/index.ts b/test/razorIntegrationTests/index.ts
@@ -0,0 +1,49 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import * as jest from 'jest';
+import { Config } from '@jest/types';
+import * as path from 'path';
+import { jestIntegrationTestProjectName } from './jest.config';
+
+async function runIntegrationTests() {
+    const repoRoot = process.env.CODE_EXTENSIONS_PATH;
+    if (!repoRoot) {
+        throw new Error('CODE_EXTENSIONS_PATH not set.');
+    }
+
+    const jestConfigPath = path.join(repoRoot, 'jest.config.ts');
+    const jestConfig = {
+        config: jestConfigPath,
+        selectProjects: [jestIntegrationTestProjectName],
+        // Since we're running tests in the actual vscode process we have to run them serially.
+        runInBand: true,
+        // Timeout cannot be overriden in the jest config file, so override here.
+        testTimeout: 120000,
+        verbose: true,
+    } as Config.Argv;
+
+    let filter: string;
+    if (process.env.TEST_FILE_FILTER) {
+        // If we have just a file, run that with runTestsByPath.
+        jestConfig.runTestsByPath = true;
+        jestConfig.testMatch = [process.env.TEST_FILE_FILTER];
+        filter = process.env.TEST_FILE_FILTER;
+    } else {
+        filter = jestIntegrationTestProjectName;
+    }
+
+    const { results } = await jest.runCLI(jestConfig, [filter]);
+
+    if (!results.success) {
+        throw new Error('Tests failed.');
+    }
+}
+
+export async function run() {
+    process.env.RUNNING_INTEGRATION_TESTS = 'true';
+
+    return runIntegrationTests();
+}
diff --git a/test/razorIntegrationTests/jest.config.ts b/test/razorIntegrationTests/jest.config.ts
@@ -0,0 +1,21 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+import type { Config } from 'jest';
+import { baseProjectConfig } from '../../baseJestConfig';
+
+export const jestIntegrationTestProjectName = 'Razor Integration Tests';
+
+/**
+ * Defines a project configuration for jest integration tests.
+ */
+const integrationTestConfig: Config = {
+    ...baseProjectConfig,
+    displayName: jestIntegrationTestProjectName,
+    roots: ['<rootDir>'],
+    testEnvironment: '<rootDir>/jestSetup/vsCodeEnvironment.ts',
+    setupFilesAfterEnv: ['<rootDir>/jestSetup/vsCodeFramework.ts'],
+};
+
+export default integrationTestConfig;
diff --git a/test/razorIntegrationTests/jestSetup/vsCodeEnvironment.ts b/test/razorIntegrationTests/jestSetup/vsCodeEnvironment.ts
@@ -0,0 +1,30 @@
+/*---------------------------------------------------------------------------------------------
+ *  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 { JestEnvironmentConfig, EnvironmentContext } from '@jest/environment';
+import { TestEnvironment } from 'jest-environment-node';
+
+/**
+ * Defines a custom jest environment that allows us to replace vscode module imports with the
+ * instance from the vscode extension in the test runner.
+ */
+class VsCodeEnvironment extends TestEnvironment {
+    constructor(config: JestEnvironmentConfig, context: EnvironmentContext) {
+        super(config, context);
+    }
+
+    public async setup() {
+        await super.setup();
+        this.global.vscode = vscode;
+    }
+
+    public async teardown() {
+        this.global.vscode = {};
+        return await super.teardown();
+    }
+}
+
+module.exports = VsCodeEnvironment;
diff --git a/test/razorIntegrationTests/jestSetup/vsCodeFramework.ts b/test/razorIntegrationTests/jestSetup/vsCodeFramework.ts
@@ -0,0 +1,9 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { jest } from '@jest/globals';
+
+// Defines a virtual mock for the vscode library since it doesn't exist until it gets loaded in by the vscode extension process.
+jest.mock('vscode', () => (global as any).vscode, { virtual: true });
diff --git a/test/razorIntegrationTests/razorFormatting.integration.test.ts b/test/razorIntegrationTests/razorFormatting.integration.test.ts
@@ -7,7 +7,7 @@ import * as path from 'path';
 import * as vscode from 'vscode';
 import * as jestLib from '@jest/globals';
 import testAssetWorkspace from './testAssets/testAssetWorkspace';
-import * as integrationHelpers from './integrationHelpers';
+import * as integrationHelpers from '../integrationTests/integrationHelpers';
 
 jestLib.describe(`Razor Formatting ${testAssetWorkspace.description}`, function () {
     jestLib.beforeAll(async function () {
diff --git a/test/razorIntegrationTests/runIntegrationTests.ts b/test/razorIntegrationTests/runIntegrationTests.ts
@@ -0,0 +1,68 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import * as cp from 'child_process';
+import { downloadAndUnzipVSCode, resolveCliArgsFromVSCodeExecutablePath, runTests } from '@vscode/test-electron';
+
+async function main() {
+    try {
+        const vscodeExecutablePath = await downloadAndUnzipVSCode('stable');
+        const [cli, ...args] = resolveCliArgsFromVSCodeExecutablePath(vscodeExecutablePath);
+
+        console.log('Display: ' + process.env.DISPLAY);
+
+        const result = cp.spawnSync(cli, [...args, '--install-extension', 'ms-dotnettools.vscode-dotnet-runtime'], {
+            encoding: 'utf-8',
+            stdio: 'inherit',
+        });
+        if (result.error) {
+            throw new Error(`Failed to install the runtime extension: ${result.error}`);
+        }
+
+        // The folder containing the Extension Manifest package.json
+        // Passed to `--extensionDevelopmentPath`
+        const extensionDevelopmentPath = process.env.CODE_EXTENSIONS_PATH;
+        if (!extensionDevelopmentPath) {
+            throw new Error('Environment variable CODE_EXTENSIONS_PATH is empty');
+        }
+
+        // The path to the extension test runner script
+        // Passed to --extensionTestsPath
+        const extensionTestsPath = process.env.EXTENSIONS_TESTS_PATH;
+
+        if (!extensionTestsPath) {
+            console.error('Empty extension tests path');
+            process.exit(-1);
+        }
+
+        // The integration tests expect that the workspace to run the
+        // tests against is set in an environment variable.
+        const workspacePath = process.env.CODE_TESTS_WORKSPACE;
+
+        if (!workspacePath) {
+            console.error(`Empty workspace path`);
+            process.exit(-1);
+        }
+
+        console.log(`workspace path = '${workspacePath}'`);
+
+        // Download VS Code, unzip it and run the integration test
+        const exitCode = await runTests({
+            extensionDevelopmentPath,
+            extensionTestsPath,
+            // Launch with info logging as anything else is way too verbose and will hide test results.
+            launchArgs: [workspacePath, '-n', '--log', 'info'],
+            extensionTestsEnv: process.env,
+        });
+
+        process.exit(exitCode);
+    } catch (err) {
+        console.error(err);
+        console.error('Failed to run tests');
+        process.exit(1);
+    }
+}
+
+main();
diff --git a/test/razorIntegrationTests/testAssets/NuGet.config b/test/razorIntegrationTests/testAssets/NuGet.config
@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- NuGet config for integration test projects.  Guards against a higher level NuGet.config from removing a required package source. -->
+<configuration>
+  <packageSources>
+    <clear />
+    <add key="nuget.org" value="https://api.nuget.org/v3/index.json" />
+  </packageSources>
+  <disabledPackageSources>
+    <clear />
+  </disabledPackageSources>
+</configuration>
diff --git a/test/razorIntegrationTests/testAssets/basicRazorApp21.ts b/test/razorIntegrationTests/testAssets/basicRazorApp21.ts
@@ -0,0 +1,17 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { ITestAssetWorkspace } from '../../integrationTests/testAssets/testAssets';
+
+const workspace: ITestAssetWorkspace = {
+    description: 'Basic Razor app',
+    projects: [
+        {
+            relativeFilePath: 'BasicRazorApp2_1.csproj',
+        },
+    ],
+};
+
+export default workspace;
diff --git a/test/razorIntegrationTests/testAssets/testAssetWorkspace.ts b/test/razorIntegrationTests/testAssets/testAssetWorkspace.ts
@@ -0,0 +1,20 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import * as path from 'path';
+import * as vscode from 'vscode';
+
+import BasicRazorApp2_1 from './basicRazorApp21';
+import { ITestAssetWorkspace, TestAssetWorkspace } from '../../integrationTests/testAssets/testAssets';
+
+const testAssetWorkspaces: { [x: string]: ITestAssetWorkspace } = {
+    BasicRazorApp2_1,
+};
+
+const workspaceName = vscode.workspace.workspaceFolders![0].uri.fsPath.split(path.sep).pop();
+
+const activeTestAssetWorkspace = new TestAssetWorkspace(testAssetWorkspaces[workspaceName!]);
+
+export default activeTestAssetWorkspace;
