Add integration test for untrusted workspace

Author: JoeRobich

.vscode/launch.json

@@ -11,6 +11,38 @@
             "outFiles": ["${workspaceRoot}/dist/*.js"],
             "preLaunchTask": "packageDev"
         },
+        {
+          "name": "[Untrusted] Run Integration Test",
+          "type": "extensionHost",
+          "request": "launch",
+          "runtimeExecutable": "${execPath}",
+          "args": [
+            // Launch VSCode using a specific profile to ensure that user settings are not used.
+            // This profile must be imported into vscode before running this launch configuration.
+            // The profile can be found under /test/csharp-test-profile.
+            "--profile",
+            "csharp-test-profile",
+            "${workspaceRoot}/test/untrustedWorkspace/integrationTests/testAssets/empty/.vscode/empty.code-workspace",
+            "--extensionDevelopmentPath=${workspaceRoot}",
+            "--extensionTestsPath=${workspaceRoot}/out/test/untrustedWorkspace/integrationTests",
+            "--log",
+            "ms-dotnettools.csharp:trace"
+          ],
+          "env": {
+            "CODE_EXTENSIONS_PATH": "${workspaceRoot}",
+          },
+          "sourceMaps": true,
+          "outFiles": [
+            "${workspaceRoot}/dist/*.js",
+            "${workspaceRoot}/out/test/**/*.js"
+          ],
+          "resolveSourceMapLocations": [
+            "${workspaceFolder}/**",
+            "!**/node_modules/**"
+          ],
+          "preLaunchTask": "packageDev",
+          "internalConsoleOptions": "openOnSessionStart"
+        },
         {
             "name": "[Roslyn] Run Current File Integration Tests",
             "type": "extensionHost",

azure-pipelines/test-matrix.yml

@@ -31,6 +31,9 @@ jobs:
       RazorCohostTests:
         npmCommand: test:integration:razor:cohost
         isIntegration: true
+      UntrustedWorkspaceTest:
+        npmCommand: test:integration:untrusted
+        isIntegration: true
   pool: ${{ parameters.pool }}
   ${{ if parameters.containerName }}:
     container: ${{ parameters.containerName }}
@@ -41,4 +44,4 @@ jobs:
       installAdditionalLinuxDependencies: ${{ parameters.installAdditionalLinuxDependencies }}
       npmCommand: $(npmCommand)
       testVSCodeVersion: ${{ parameters.testVSCodeVersion }}
-      isIntegration: $(isIntegration)
+      isIntegration: $(isIntegration)

jest.config.ts

@@ -13,6 +13,7 @@ const config: Config = {
         '<rootDir>/test/omnisharp/omnisharpUnitTests/jest.config.ts',
         '<rootDir>/test/razor/razorIntegrationTests/jest.config.ts',
         '<rootDir>/test/razor/razorTests/jest.config.ts',
+        '<rootDir>/test/untrustedWorkspace/integrationTests/jest.config.ts',
     ],
     // Reporters are a global jest configuration property and cannot be set in the project jest config.
     // This configuration will create a 'junit.xml' file in the output directory, no matter which test project is running.

tasks/testTasks.ts

@@ -74,6 +74,10 @@ function createIntegrationTestSubTasks() {
         gulp.series(integrationTestProjects.map((projectName) => `test:integration:devkit:${projectName}`))
     );
 
+    gulp.task('test:integration:untrusted', async () =>
+        runIntegrationTest('empty', path.join('untrustedWorkspace', 'integrationTests'), `[C#][empty]`)
+    );
+
     for (const projectName of razorIntegrationTestProjects) {
         gulp.task(`test:integration:razor:${projectName}`, async () =>
             // Run DevKit tests because razor doesn't gracefully handle roslyn restarting
@@ -108,7 +112,12 @@ function createIntegrationTestSubTasks() {
 
     gulp.task(
         'test:integration',
-        gulp.series('test:integration:csharp', 'test:integration:devkit', 'test:integration:razor')
+        gulp.series(
+            'test:integration:csharp',
+            'test:integration:devkit',
+            'test:integration:razor',
+            'test:integration:untrusted'
+        )
     );
 }
 

test/untrustedWorkspace/integrationTests/index.ts

@@ -0,0 +1,13 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { runIntegrationTests } from '../../runIntegrationTests';
+import { jestIntegrationTestProjectName } from './jest.config';
+
+export async function run() {
+    process.env.RUNNING_INTEGRATION_TESTS = 'true';
+
+    await runIntegrationTests(jestIntegrationTestProjectName);
+}

test/untrustedWorkspace/integrationTests/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 = 'Untrusted Integration Tests';
+
+/**
+ * Defines a project configuration for jest integration tests.
+ */
+const integrationTestConfig: Config = {
+    ...baseProjectConfig,
+    displayName: jestIntegrationTestProjectName,
+    roots: ['<rootDir>'],
+    testEnvironment: '<rootDir>/../../vsCodeEnvironment.ts',
+    setupFilesAfterEnv: ['<rootDir>/../../vsCodeFramework.ts'],
+};
+
+export default integrationTestConfig;

test/untrustedWorkspace/integrationTests/testAssets/empty/.vscode/devkit_empty.code-workspace

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

test/untrustedWorkspace/integrationTests/testAssets/empty/.vscode/empty.code-workspace

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

test/untrustedWorkspace/integrationTests/testAssets/empty/readme.md

@@ -0,0 +1 @@
+This folder left empty so that the C# extension does not automatically activate.

test/untrustedWorkspace/integrationTests/untrustedWorkspace.integration.test.ts

@@ -0,0 +1,27 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { describe, expect, jest, test } from '@jest/globals';
+import * as vscode from 'vscode';
+import { CSharpExtensionExports, LimitedExtensionExports } from '../../../src/csharpExtensionExports';
+
+describe(`Untrusted Workspace`, () => {
+    test(`Limited activation in untrusted workspace`, async () => {
+        // Simulate an untrusted workspace by setting isTrusted to false
+        jest.spyOn(vscode.workspace, 'isTrusted', 'get').mockReturnValue(false);
+
+        const extension = vscode.extensions.getExtension<CSharpExtensionExports | LimitedExtensionExports>(
+            'ms-dotnettools.csharp'
+        );
+        if (!extension) {
+            throw new Error('Failed to find installation of ms-dotnettools.csharp');
+        }
+
+        expect(extension.isActive).toBe(false);
+        await extension.activate();
+
+        expect(extension.exports.isLimitedActivation).toBe(true);
+    });
+});