Integration Tests - Add gulp tasks for lsp integration tests (#6188)

* wip

* explicitly use workspace path

* fix

* remove settings

* feedback

* fix

omnisharptest/omnisharpIntegrationTests/testAssets/BasicRazorApp2_1/.vscode/omnisharp_BasicRazorApp2_1.code-workspace

@@ -0,0 +1,11 @@
+{
+    "folders": [
+        {
+            "path": ".."
+        }
+    ],
+    "settings": {
+        "dotnet.server.useOmnisharp": true,
+        "omnisharp.enableLspDriver": false
+    }
+}

omnisharptest/omnisharpIntegrationTests/testAssets/BasicRazorApp2_1/.vscode/omnisharp_lsp_BasicRazorApp2_1.code-workspace

@@ -0,0 +1,11 @@
+{
+    "folders": [
+        {
+            "path": ".."
+        }
+    ],
+    "settings": {
+        "dotnet.server.useOmnisharp": true,
+        "omnisharp.enableLspDriver": true
+    }
+}

omnisharptest/omnisharpIntegrationTests/testAssets/singleCsproj/.vscode/omnisharp_lsp_singleCsproj.code-workspace

@@ -0,0 +1,13 @@
+{
+    "folders": [
+        {
+            "path": ".."
+        }
+    ],
+    "settings": {
+        "omnisharp.path": "latest",
+        "omnisharp.enableRoslynAnalyzers": true,
+        "omnisharp.enableLspDriver": true,
+        "dotnet.server.useOmnisharp": true
+    }
+}

omnisharptest/omnisharpIntegrationTests/testAssets/singleCsproj/.vscode/omnisharp_singleCsproj.code-workspace

@@ -0,0 +1,13 @@
+{
+    "folders": [
+        {
+            "path": ".."
+        }
+    ],
+    "settings": {
+        "omnisharp.path": "latest",
+        "omnisharp.enableRoslynAnalyzers": true,
+        "omnisharp.enableLspDriver": false,
+        "dotnet.server.useOmnisharp": true
+    }
+}

omnisharptest/omnisharpIntegrationTests/testAssets/slnFilterWithCsproj/.vscode/omnisharp_lsp_slnFilterWithCsproj.code-workspace

@@ -0,0 +1,14 @@
+{
+    "folders": [
+        {
+            "path": ".."
+        }
+    ],
+    "settings": {
+        "omnisharp.defaultLaunchSolution": "SolutionFilter.slnf",
+        "omnisharp.path": "latest",
+        "omnisharp.enableRoslynAnalyzers": true,
+        "dotnet.server.useOmnisharp": true,
+        "omnisharp.enableLspDriver": true,
+    }
+}

omnisharptest/omnisharpIntegrationTests/testAssets/slnFilterWithCsproj/.vscode/omnisharp_slnFilterWithCsproj.code-workspace

@@ -0,0 +1,14 @@
+{
+    "folders": [
+        {
+            "path": ".."
+        }
+    ],
+    "settings": {
+        "omnisharp.defaultLaunchSolution": "SolutionFilter.slnf",
+        "omnisharp.path": "latest",
+        "omnisharp.enableRoslynAnalyzers": true,
+        "dotnet.server.useOmnisharp": true,
+        "omnisharp.enableLspDriver": false
+    }
+}

omnisharptest/omnisharpIntegrationTests/testAssets/slnWithCsproj/.vscode/omnisharp_lsp_slnWithCsproj.code-workspace

@@ -9,6 +9,6 @@
         "omnisharp.enableRoslynAnalyzers": true,
         "dotnet.server.useOmnisharp": true,
         "omnisharp.enableLspDriver": true,
-        "dotnet.defaultSolution": "b_SecondInOrder_SlnFile.sln",
+        "dotnet.defaultSolution": "b_SecondInOrder_SlnFile.sln"
     }
 }

package.json

@@ -68,6 +68,7 @@
     "omnisharptest:integration:slnWithCsproj": "tsc -p ./ && gulp omnisharptest:integration:slnWithCsproj",
     "omnisharptest:integration:slnFilterWithCsproj": "tsc -p ./ && gulp omnisharptest:integration:slnFilterWithCsproj",
     "omnisharptest:artifacts": "tsc -p ./ && mocha out/omnisharptest/omnisharpArtifactTests/**/*.test.js",
+    "test:integration:slnWithCsproj": "tsc -p ./ && gulp test:integration:slnWithCsproj",
     "unpackage:vsix": "gulp vsix:release:unpackage",
     "updatePackageDependencies": "gulp updatePackageDependencies",
     "l10nDevGenerateXlf": "npx @vscode/l10n-dev generate-xlf ./package.nls.json ./l10n/bundle.l10n.json --outFile ./loc/vscode-csharp.xlf",

tasks/projectPaths.ts

@@ -19,9 +19,16 @@ export const languageServerDirectory = path.join(rootPath, '.roslyn');
 
 export const codeExtensionPath = commandLineOptions.codeExtensionPath || rootPath;
 
-export const testRootPath = path.join(rootPath, 'out', 'omnisharptest');
-export const featureTestRunnerPath = path.join(testRootPath, 'runFeatureTests.js');
+export const omnisharpTestRootPath = path.join(rootPath, 'out', 'omnisharptest');
+export const omnisharpFeatureTestRunnerPath = path.join(omnisharpTestRootPath, 'runFeatureTests.js');
+export const omnisharpTestAssetsRootPath = path.join(
+    rootPath,
+    'omnisharptest',
+    'omnisharpIntegrationTests',
+    'testAssets'
+);
+
+export const testRootPath = path.join(rootPath, 'out', 'test');
 export const integrationTestRunnerPath = path.join(testRootPath, 'runIntegrationTests.js');
-export const testAssetsRootPath = path.join(rootPath, 'omnisharptest', 'omnisharpIntegrationTests', 'testAssets');
 
 export const nodePath = path.join(process.env.NVM_BIN ? `${process.env.NVM_BIN}${path.sep}` : '', 'node');

tasks/testTasks.ts

@@ -7,26 +7,27 @@ import * as gulp from 'gulp';
 import * as path from 'path';
 import {
     codeExtensionPath,
-    featureTestRunnerPath,
-    integrationTestRunnerPath,
-    jestPath,
+    omnisharpFeatureTestRunnerPath,
     mochaPath,
     rootPath,
-    testAssetsRootPath,
+    omnisharpTestAssetsRootPath,
+    omnisharpTestRootPath,
     testRootPath,
+    integrationTestRunnerPath,
+    jestPath,
 } from './projectPaths';
 import spawnNode from './spawnNode';
 
 gulp.task('omnisharptest:feature', async () => {
     const env = {
         OSVC_SUITE: 'omnisharpFeatureTests',
         CODE_EXTENSIONS_PATH: codeExtensionPath,
-        CODE_TESTS_PATH: path.join(testRootPath, 'omnisharpFeatureTests'),
+        CODE_TESTS_PATH: path.join(omnisharpTestRootPath, 'omnisharpFeatureTests'),
         CODE_WORKSPACE_ROOT: rootPath,
         CODE_DISABLE_EXTENSIONS: 'true',
     };
 
-    const result = await spawnNode([featureTestRunnerPath], { env });
+    const result = await spawnNode([omnisharpFeatureTestRunnerPath], { env });
 
     if (result.code === null || result.code > 0) {
         // Ensure that gulp fails when tests fail
@@ -60,8 +61,12 @@ gulp.task('omnisharp:jest:test', async () => {
 const projectNames = ['singleCsproj', 'slnWithCsproj', 'slnFilterWithCsproj', 'BasicRazorApp2_1'];
 
 for (const projectName of projectNames) {
-    gulp.task(`omnisharptest:integration:${projectName}:stdio`, async () => runIntegrationTest(projectName, 'stdio'));
-    gulp.task(`omnisharptest:integration:${projectName}:lsp`, async () => runIntegrationTest(projectName, 'lsp'));
+    gulp.task(`omnisharptest:integration:${projectName}:stdio`, async () =>
+        runOmnisharpIntegrationTest(projectName, 'stdio')
+    );
+    gulp.task(`omnisharptest:integration:${projectName}:lsp`, async () =>
+        runOmnisharpIntegrationTest(projectName, 'lsp')
+    );
     gulp.task(
         `omnisharptest:integration:${projectName}`,
         gulp.series(`omnisharptest:integration:${projectName}:stdio`, `omnisharptest:integration:${projectName}:lsp`)
@@ -86,24 +91,63 @@ gulp.task(
     gulp.series('omnisharp:jest:test', 'omnisharptest:feature', 'omnisharptest:unit', 'omnisharptest:integration:stdio')
 );
 
+gulp.task('test:integration:slnWithCsproj', async () => runIntegrationTest('slnWithCsproj'));
+
 gulp.task('test:unit', async () => {
     runJestTest(/unitTests.*\.ts/);
 });
 
 gulp.task('test', gulp.series('test:unit'));
 
-async function runIntegrationTest(testAssetName: string, engine: 'stdio' | 'lsp') {
+async function runOmnisharpIntegrationTest(testAssetName: string, engine: 'stdio' | 'lsp') {
+    const workspaceFile = `omnisharp${engine === 'lsp' ? '_lsp' : ''}_${testAssetName}.code-workspace`;
+    const workspacePath = path.join(omnisharpTestAssetsRootPath, testAssetName, '.vscode', workspaceFile);
+    const codeTestsPath = path.join(omnisharpTestRootPath, 'omnisharpIntegrationTests');
+
     const env = {
         OSVC_SUITE: testAssetName,
-        CODE_TESTS_PATH: path.join(testRootPath, 'omnisharpIntegrationTests'),
+        CODE_TESTS_PATH: codeTestsPath,
         CODE_EXTENSIONS_PATH: codeExtensionPath,
-        CODE_TESTS_WORKSPACE: path.join(testAssetsRootPath, testAssetName),
+        CODE_TESTS_WORKSPACE: workspacePath,
         CODE_WORKSPACE_ROOT: rootPath,
+        EXTENSIONS_TESTS_PATH: path.join(codeTestsPath, 'index.js'),
         OMNISHARP_ENGINE: engine,
         OMNISHARP_LOCATION: process.env.OMNISHARP_LOCATION,
         CODE_DISABLE_EXTENSIONS: 'true',
     };
 
+    const result = await spawnNode([integrationTestRunnerPath, '--enable-source-maps'], {
+        env,
+        cwd: rootPath,
+    });
+
+    if (result.code === null || result.code > 0) {
+        // Ensure that gulp fails when tests fail
+        throw new Error(`Exit code: ${result.code}  Signal: ${result.signal}`);
+    }
+
+    return result;
+}
+
+async function runIntegrationTest(testAssetName: string) {
+    const workspacePath = path.join(
+        omnisharpTestAssetsRootPath,
+        testAssetName,
+        '.vscode',
+        `lsp_tools_host_${testAssetName}.code-workspace`
+    );
+    const codeTestsPath = path.join(testRootPath, 'integrationTests');
+
+    const env = {
+        OSVC_SUITE: testAssetName,
+        CODE_TESTS_PATH: codeTestsPath,
+        CODE_EXTENSIONS_PATH: codeExtensionPath,
+        CODE_TESTS_WORKSPACE: workspacePath,
+        CODE_WORKSPACE_ROOT: rootPath,
+        EXTENSIONS_TESTS_PATH: path.join(codeTestsPath, 'index.js'),
+        CODE_DISABLE_EXTENSIONS: 'true',
+    };
+
     const result = await spawnNode([integrationTestRunnerPath, '--enable-source-maps'], { env, cwd: rootPath });
 
     if (result.code === null || result.code > 0) {

omnisharptest/runIntegrationTests.ts → test/runIntegrationTests.ts

@@ -31,7 +31,12 @@ async function main() {
 
         // The path to the extension test runner script
         // Passed to --extensionTestsPath
-        const extensionTestsPath = path.resolve(__dirname, './omnisharpIntegrationTests/index');
+        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.