remove shell integration none tests (#306932)

This commit is contained in:
Megan Rogge
2026-03-31 17:30:41 -04:00
committed by GitHub
parent 64ea63952b
commit 6c3a002c90

View File

@@ -8,10 +8,6 @@ import 'mocha';
import * as vscode from 'vscode';
import { DeferredPromise, assertNoRpc, closeAllEditors, disposeAll } from '../utils';
const enum ShellIntegrationTimeoutOverride {
DisableForTests = -2
}
const isWindows = process.platform === 'win32';
const isMacOS = process.platform === 'darwin';
const sandboxFileSystemSetting = isMacOS
@@ -31,10 +27,17 @@ function extractTextContent(result: vscode.LanguageModelToolResult): string {
(vscode.env.uiKind === vscode.UIKind.Web ? suite.skip : suite)('chat - run_in_terminal', () => {
let disposables: vscode.Disposable[] = [];
let originalShellIntegrationEnabled: boolean | undefined;
setup(async () => {
disposables = [];
// Force shell integration on so tests that rely on exit code / output
// reporting are not dependent on prior test suites or user settings.
const terminalConfig = vscode.workspace.getConfiguration('terminal.integrated');
originalShellIntegrationEnabled = terminalConfig.get<boolean>('shellIntegration.enabled');
await terminalConfig.update('shellIntegration.enabled', true, vscode.ConfigurationTarget.Global);
// Register a dummy default model required for participant requests
disposables.push(vscode.lm.registerLanguageModelChatProvider('copilot', {
async provideLanguageModelChatInformation(_options, _token) {
@@ -76,6 +79,10 @@ function extractTextContent(result: vscode.LanguageModelToolResult): string {
const chatToolsConfig = vscode.workspace.getConfiguration('chat.tools.global');
await chatToolsConfig.update('autoApprove', undefined, vscode.ConfigurationTarget.Global);
await vscode.commands.executeCommand('setContext', 'vscode.chat.tools.global.autoApprove.testMode', undefined);
// Restore shell integration setting
const terminalConfig = vscode.workspace.getConfiguration('terminal.integrated');
await terminalConfig.update('shellIntegration.enabled', originalShellIntegrationEnabled, vscode.ConfigurationTarget.Global);
});
/**
@@ -174,266 +181,215 @@ function extractTextContent(result: vscode.LanguageModelToolResult): string {
assert.ok(schema.properties?.['isBackground'], 'Schema should have an isBackground property');
});
// --- Shell integration OFF (fast idle polling) ---
// --- Sandbox OFF tests ---
suite('shell integration off', () => {
suite('sandbox off', () => {
test('echo command returns exactly the echoed text', async function () {
this.timeout(60000);
const marker = `MARKER_${Date.now()}_ECHO`;
const output = await invokeRunInTerminal(`echo ${marker}`);
assert.strictEqual(output.trim(), marker);
});
test('no-output command reports empty output, not prompt echo (issue #303531)', async function () {
this.timeout(60000);
// `true` on Unix exits 0 with no output; `cmd /c rem` on Windows is a no-op
const command = isWindows ? 'cmd /c rem' : 'true';
const output = await invokeRunInTerminal(command);
assert.strictEqual(output.trim(), 'Command produced no output');
});
test('multi-line output preserves all lines in order', async function () {
this.timeout(60000);
const m1 = `M1_${Date.now()}`;
const m2 = `M2_${Date.now()}`;
const m3 = `M3_${Date.now()}`;
// Use `;` on Windows (PowerShell) since `&&` is rewritten to `;`
const sep = isWindows ? ';' : '&&';
const output = await invokeRunInTerminal(`echo ${m1} ${sep} echo ${m2} ${sep} echo ${m3}`);
assert.strictEqual(output.trim(), `${m1}\n${m2}\n${m3}`);
});
(isWindows ? test : test.skip)('&& operators are converted to ; on PowerShell', async function () {
this.timeout(60000);
const m1 = `CHAIN_${Date.now()}_A`;
const m2 = `CHAIN_${Date.now()}_B`;
const output = await invokeRunInTerminal(`echo ${m1} && echo ${m2}`);
// The rewriter prepends a note explaining the simplification
const trimmed = output.trim();
assert.ok(trimmed.startsWith('Note: The tool simplified the command to'), `Expected rewrite note, got: ${trimmed}`);
assert.ok(trimmed.endsWith(`${m1}\n${m2}`), `Expected markers at end, got: ${trimmed}`);
});
test('non-zero exit code is reported', async function () {
this.timeout(60000);
// Use a subshell so we don't kill the shared terminal
const command = isWindows ? 'cmd /c exit 42' : 'bash -c "exit 42"';
const output = await invokeRunInTerminal(command);
// On Windows with shell integration, `cmd /c exit 42` may report
// exit code 1 instead of 42 due to how PowerShell propagates
// cmd.exe exit codes through shell integration sequences.
const acceptable = [
'Command produced no output\nCommand exited with code 42',
...(isWindows ? ['Command produced no output\nCommand exited with code 1'] : []),
];
assert.ok(acceptable.includes(output.trim()), `Unexpected output: ${JSON.stringify(output.trim())}`);
});
test('output with special characters is captured verbatim', async function () {
this.timeout(60000);
const marker = `SP_${Date.now()}`;
const output = await invokeRunInTerminal(`echo "${marker} hello & world"`);
assert.strictEqual(output.trim(), `${marker} hello & world`);
});
});
// --- Sandbox ON tests (macOS and Linux only) ---
(isWindows ? suite.skip : suite)('sandbox on', () => {
setup(async () => {
const termConfig = vscode.workspace.getConfiguration('terminal.integrated');
await termConfig.update('shellIntegration.enabled', false, vscode.ConfigurationTarget.Global);
await termConfig.update('shellIntegration.timeout', ShellIntegrationTimeoutOverride.DisableForTests, vscode.ConfigurationTarget.Global);
const toolConfig = vscode.workspace.getConfiguration('chat.tools.terminal');
await toolConfig.update('idlePollInterval', 100, vscode.ConfigurationTarget.Global);
const configuration = vscode.workspace.getConfiguration();
await configuration.update('chat.agent.sandbox', true, vscode.ConfigurationTarget.Global);
});
teardown(async () => {
const termConfig = vscode.workspace.getConfiguration('terminal.integrated');
await termConfig.update('shellIntegration.enabled', undefined, vscode.ConfigurationTarget.Global);
await termConfig.update('shellIntegration.timeout', undefined, vscode.ConfigurationTarget.Global);
const toolConfig = vscode.workspace.getConfiguration('chat.tools.terminal');
await toolConfig.update('idlePollInterval', undefined, vscode.ConfigurationTarget.Global);
const configuration = vscode.workspace.getConfiguration();
await configuration.update('chat.agent.sandbox', undefined, vscode.ConfigurationTarget.Global);
});
defineTests(false);
// Flaky: #305722
test.skip('echo works in sandbox and output is clean', async function () {
this.timeout(60000);
const marker = `SANDBOX_ECHO_${Date.now()}`;
const output = await invokeRunInTerminal(`echo ${marker}`);
assert.strictEqual(output.trim(), marker);
});
test('network requests to allowlisted domains succeed in sandbox', async function () {
this.timeout(60000);
const configuration = vscode.workspace.getConfiguration();
await configuration.update('chat.agent.sandboxNetwork.allowedDomains', ['example.com'], vscode.ConfigurationTarget.Global);
try {
const output = await invokeRunInTerminal('curl -s --max-time 5 https://example.com');
const trimmed = output.trim();
const acceptable = [
'Command produced no output',
'<title>Example Domain</title>',
];
assert.ok(acceptable.some(value => trimmed.includes(value) || trimmed === value), `Unexpected output: ${JSON.stringify(trimmed)}`);
} finally {
await configuration.update('chat.agent.sandboxNetwork.allowedDomains', undefined, vscode.ConfigurationTarget.Global);
}
});
test('requestUnsandboxedExecution preserves sandbox $TMPDIR', async function () {
this.timeout(60000);
const marker = `SANDBOX_UNSANDBOX_${Date.now()}`;
const sentinelName = `sentinel-${marker}.txt`;
// Step 1: Write a sentinel file into the sandbox-provided $TMPDIR.
const writeOutput = await invokeRunInTerminal(`echo ${marker} > "$TMPDIR/${sentinelName}" && echo ${marker}`);
assert.strictEqual(writeOutput.trim(), marker);
// Step 2: Retry with requestUnsandboxedExecution=true while sandbox
// stays enabled. The tool should preserve $TMPDIR from the sandbox so
// the sentinel file created in step 1 is still accessible.
const retryOutput = await invokeRunInTerminal(`cat "$TMPDIR/${sentinelName}"`, {
timeout: 30000,
requestUnsandboxedExecution: true,
requestUnsandboxedExecutionReason: 'Need to verify $TMPDIR persists on unsandboxed retry',
});
const trimmed = retryOutput.trim();
assert.ok(trimmed.startsWith('Note: The tool simplified the command to'), `Unexpected output: ${JSON.stringify(trimmed)}`);
assert.ok(trimmed.includes(`cat "$TMPDIR/${sentinelName}"`), `Unexpected output: ${JSON.stringify(trimmed)}`);
assert.ok(trimmed.endsWith(marker), `Unexpected output: ${JSON.stringify(trimmed)}`);
});
test('cannot write to /tmp', async function () {
this.timeout(60000);
const marker = `SANDBOX_TMP_${Date.now()}`;
const output = await invokeRunInTerminal(`echo "${marker}" > /tmp/${marker}.txt`);
// macOS sandbox-exec returns "Operation not permitted" via /bin/bash;
// Linux read-only bind mount returns "Read-only file system" via /usr/bin/bash.
// Some shells include "line N:" in the error (e.g. "/usr/bin/bash: line 1: …").
const shellError = isMacOS
? `/bin/bash: /tmp/${marker}.txt: Operation not permitted`
: `/usr/bin/bash: line 1: /tmp/${marker}.txt: Read-only file system`;
const sandboxBody = [
`- If it would be reasonable to extend the sandbox rules, work with the user to update allowWrite for file system access problems in ${sandboxFileSystemSetting}, or to add required domains to chat.agent.sandboxNetwork.allowedDomains.`,
'- Otherwise, immediately retry the command with requestUnsandboxedExecution=true. Do NOT ask the user \u2014 setting this flag automatically shows a confirmation prompt to the user.',
'',
'Here is the output of the command:',
'',
shellError,
].join('\n');
const expected = `Command failed while running in sandboxed mode. If the command failed due to sandboxing:\n${sandboxBody}\n\nCommand exited with code 1`;
assert.strictEqual(output.trim(), expected);
});
test('can read files outside the workspace', async function () {
this.timeout(60000);
const output = await invokeRunInTerminal('head -1 /etc/shells');
const trimmed = output.trim();
// macOS: "# List of acceptable shells for chpass(1)."
// Linux: "# /etc/shells: valid login shells"
assert.ok(
trimmed.startsWith('#'),
`Expected a comment line from /etc/shells, got: ${trimmed}`
);
});
test('can write inside the workspace folder', async function () {
this.timeout(60000);
const marker = `SANDBOX_WS_${Date.now()}`;
const output = await invokeRunInTerminal(`echo "${marker}" > .sandbox-test-${marker}.tmp && cat .sandbox-test-${marker}.tmp && rm .sandbox-test-${marker}.tmp`);
assert.strictEqual(output.trim(), marker);
});
test('$TMPDIR is writable inside the sandbox', async function () {
this.timeout(60000);
const marker = `SANDBOX_TMPDIR_${Date.now()}`;
const output = await invokeRunInTerminal(`echo "${marker}" > "$TMPDIR/${marker}.tmp" && cat "$TMPDIR/${marker}.tmp" && rm "$TMPDIR/${marker}.tmp"`);
assert.strictEqual(output.trim(), marker);
});
test('non-allowlisted domains trigger unsandboxed confirmation flow', async function () {
this.timeout(60000);
const marker = `SANDBOX_DOMAIN_${Date.now()}`;
const output = await invokeRunInTerminal(`echo https://example.net >/dev/null && echo "${marker}" > /tmp/${marker}.txt && cat /tmp/${marker}.txt && rm /tmp/${marker}.txt`);
const trimmed = output.trim();
assert.ok(trimmed.startsWith('Note: The tool simplified the command to'), `Unexpected output: ${JSON.stringify(trimmed)}`);
assert.ok(trimmed.includes('https://example.net'), `Unexpected output: ${JSON.stringify(trimmed)}`);
assert.ok(trimmed.endsWith(marker), `Unexpected output: ${JSON.stringify(trimmed)}`);
});
});
// --- Shell integration ON ---
suite('shell integration on', () => {
defineTests(true);
});
function defineTests(hasShellIntegration: boolean) {
// --- Sandbox OFF tests ---
suite('sandbox off', () => {
test('echo command returns exactly the echoed text', async function () {
this.timeout(60000);
const marker = `MARKER_${Date.now()}_ECHO`;
const output = await invokeRunInTerminal(`echo ${marker}`);
assert.strictEqual(output.trim(), marker);
});
test('no-output command reports empty output, not prompt echo (issue #303531)', async function () {
this.timeout(60000);
// `true` on Unix exits 0 with no output; `cmd /c rem` on Windows is a no-op
const command = isWindows ? 'cmd /c rem' : 'true';
const output = await invokeRunInTerminal(command);
assert.strictEqual(output.trim(), 'Command produced no output');
});
test('multi-line output preserves all lines in order', async function () {
this.timeout(60000);
const m1 = `M1_${Date.now()}`;
const m2 = `M2_${Date.now()}`;
const m3 = `M3_${Date.now()}`;
// Use `;` on Windows (PowerShell) since `&&` is rewritten to `;`
const sep = isWindows ? ';' : '&&';
const output = await invokeRunInTerminal(`echo ${m1} ${sep} echo ${m2} ${sep} echo ${m3}`);
// Without shell integration, idle polling may miss the
// output on slow CI machines.
const acceptable = [
`${m1}\n${m2}\n${m3}`,
...(!hasShellIntegration ? ['Command produced no output'] : []),
];
assert.ok(acceptable.includes(output.trim()), `Unexpected output: ${JSON.stringify(output.trim())}`);
});
(isWindows ? test.skip : test.skip)('&& operators are converted to ; on PowerShell', async function () {
this.timeout(60000);
const m1 = `CHAIN_${Date.now()}_A`;
const m2 = `CHAIN_${Date.now()}_B`;
const output = await invokeRunInTerminal(`echo ${m1} && echo ${m2}`);
// The rewriter prepends a note explaining the simplification
const trimmed = output.trim();
assert.ok(trimmed.startsWith('Note: The tool simplified the command to'), `Expected rewrite note, got: ${trimmed}`);
assert.ok(trimmed.endsWith(`${m1}\n${m2}`), `Expected markers at end, got: ${trimmed}`);
});
test('non-zero exit code is reported', async function () {
this.timeout(60000);
// Use a subshell so we don't kill the shared terminal
const command = isWindows ? 'cmd /c exit 42' : 'bash -c "exit 42"';
const output = await invokeRunInTerminal(command);
// Without shell integration, exit codes are unavailable.
// On Windows with shell integration, `cmd /c exit 42` may report
// exit code 1 instead of 42 due to how PowerShell propagates
// cmd.exe exit codes through shell integration sequences.
const acceptable = [
'Command produced no output\nCommand exited with code 42',
...(!hasShellIntegration ? ['Command produced no output'] : []),
...(isWindows && hasShellIntegration ? ['Command produced no output\nCommand exited with code 1'] : []),
];
assert.ok(acceptable.includes(output.trim()), `Unexpected output: ${JSON.stringify(output.trim())}`);
});
test('output with special characters is captured verbatim', async function () {
this.timeout(60000);
const marker = `SP_${Date.now()}`;
const output = await invokeRunInTerminal(`echo "${marker} hello & world"`);
assert.strictEqual(output.trim(), `${marker} hello & world`);
});
});
// --- Sandbox ON tests (macOS and Linux only) ---
(isWindows ? suite.skip : suite)('sandbox on', () => {
setup(async () => {
const configuration = vscode.workspace.getConfiguration();
await configuration.update('chat.agent.sandbox', true, vscode.ConfigurationTarget.Global);
});
teardown(async () => {
const configuration = vscode.workspace.getConfiguration();
await configuration.update('chat.agent.sandbox', undefined, vscode.ConfigurationTarget.Global);
});
// Flaky: #305722
test.skip('echo works in sandbox and output is clean', async function () {
this.timeout(60000);
const marker = `SANDBOX_ECHO_${Date.now()}`;
const output = await invokeRunInTerminal(`echo ${marker}`);
assert.strictEqual(output.trim(), marker);
});
test('network requests to allowlisted domains succeed in sandbox', async function () {
this.timeout(60000);
const configuration = vscode.workspace.getConfiguration();
await configuration.update('chat.agent.sandboxNetwork.allowedDomains', ['example.com'], vscode.ConfigurationTarget.Global);
try {
const output = await invokeRunInTerminal('curl -s --max-time 5 https://example.com');
const trimmed = output.trim();
const acceptable = [
'Command produced no output',
'<title>Example Domain</title>',
];
assert.ok(acceptable.some(value => trimmed.includes(value) || trimmed === value), `Unexpected output: ${JSON.stringify(trimmed)}`);
} finally {
await configuration.update('chat.agent.sandboxNetwork.allowedDomains', undefined, vscode.ConfigurationTarget.Global);
}
});
test('requestUnsandboxedExecution preserves sandbox $TMPDIR', async function () {
this.timeout(60000);
const marker = `SANDBOX_UNSANDBOX_${Date.now()}`;
const sentinelName = `sentinel-${marker}.txt`;
// Step 1: Write a sentinel file into the sandbox-provided $TMPDIR.
const writeOutput = await invokeRunInTerminal(`echo ${marker} > "$TMPDIR/${sentinelName}" && echo ${marker}`);
const writeAcceptable = [
marker,
...(!hasShellIntegration ? ['Command produced no output'] : []),
];
assert.ok(writeAcceptable.includes(writeOutput.trim()), `Unexpected output: ${JSON.stringify(writeOutput.trim())}`);
// Step 2: Retry with requestUnsandboxedExecution=true while sandbox
// stays enabled. The tool should preserve $TMPDIR from the sandbox so
// the sentinel file created in step 1 is still accessible.
const retryOutput = await invokeRunInTerminal(`cat "$TMPDIR/${sentinelName}"`, {
timeout: 30000,
requestUnsandboxedExecution: true,
requestUnsandboxedExecutionReason: 'Need to verify $TMPDIR persists on unsandboxed retry',
});
const trimmed = retryOutput.trim();
assert.ok(trimmed.startsWith('Note: The tool simplified the command to'), `Unexpected output: ${JSON.stringify(trimmed)}`);
assert.ok(trimmed.includes(`cat "$TMPDIR/${sentinelName}"`), `Unexpected output: ${JSON.stringify(trimmed)}`);
assert.ok(trimmed.endsWith(marker), `Unexpected output: ${JSON.stringify(trimmed)}`);
});
test('cannot write to /tmp', async function () {
this.timeout(60000);
const marker = `SANDBOX_TMP_${Date.now()}`;
const output = await invokeRunInTerminal(`echo "${marker}" > /tmp/${marker}.txt`);
// macOS sandbox-exec returns "Operation not permitted" via /bin/bash;
// Linux read-only bind mount returns "Read-only file system" via /usr/bin/bash.
// Some shells include "line N:" in the error (e.g. "/usr/bin/bash: line 1: …").
const shellError = isMacOS
? `/bin/bash: /tmp/${marker}.txt: Operation not permitted`
: `/usr/bin/bash: line 1: /tmp/${marker}.txt: Read-only file system`;
const sandboxBody = [
`- If it would be reasonable to extend the sandbox rules, work with the user to update allowWrite for file system access problems in ${sandboxFileSystemSetting}, or to add required domains to chat.agent.sandboxNetwork.allowedDomains.`,
'- Otherwise, immediately retry the command with requestUnsandboxedExecution=true. Do NOT ask the user \u2014 setting this flag automatically shows a confirmation prompt to the user.',
'',
'Here is the output of the command:',
'',
shellError,
].join('\n');
const acceptable = [
// With shell integration: known failure with exit code
`Command failed while running in sandboxed mode. If the command failed due to sandboxing:\n${sandboxBody}\n\nCommand exited with code 1`,
// Without shell integration: heuristic detection, no exit code
...(!hasShellIntegration ? [`Command ran in sandboxed mode and may have been blocked by the sandbox. If the command failed due to sandboxing:\n${sandboxBody}`] : []),
];
assert.ok(acceptable.includes(output.trim()), `Unexpected output: ${JSON.stringify(output.trim())}`);
});
test('can read files outside the workspace', async function () {
this.timeout(60000);
const output = await invokeRunInTerminal('head -1 /etc/shells');
const trimmed = output.trim();
// macOS: "# List of acceptable shells for chpass(1)."
// Linux: "# /etc/shells: valid login shells"
assert.ok(
trimmed.startsWith('#'),
`Expected a comment line from /etc/shells, got: ${trimmed}`
);
});
test('can write inside the workspace folder', async function () {
this.timeout(60000);
const marker = `SANDBOX_WS_${Date.now()}`;
const output = await invokeRunInTerminal(`echo "${marker}" > .sandbox-test-${marker}.tmp && cat .sandbox-test-${marker}.tmp && rm .sandbox-test-${marker}.tmp`);
assert.strictEqual(output.trim(), marker);
});
test('$TMPDIR is writable inside the sandbox', async function () {
this.timeout(60000);
const marker = `SANDBOX_TMPDIR_${Date.now()}`;
const output = await invokeRunInTerminal(`echo "${marker}" > "$TMPDIR/${marker}.tmp" && cat "$TMPDIR/${marker}.tmp" && rm "$TMPDIR/${marker}.tmp"`);
assert.strictEqual(output.trim(), marker);
});
test('non-allowlisted domains trigger unsandboxed confirmation flow', async function () {
this.timeout(60000);
const marker = `SANDBOX_DOMAIN_${Date.now()}`;
const output = await invokeRunInTerminal(`echo https://example.net >/dev/null && echo "${marker}" > /tmp/${marker}.txt && cat /tmp/${marker}.txt && rm /tmp/${marker}.txt`);
const trimmed = output.trim();
assert.ok(trimmed.startsWith('Note: The tool simplified the command to'), `Unexpected output: ${JSON.stringify(trimmed)}`);
assert.ok(trimmed.includes('https://example.net'), `Unexpected output: ${JSON.stringify(trimmed)}`);
assert.ok(trimmed.endsWith(marker), `Unexpected output: ${JSON.stringify(trimmed)}`);
});
});
}
});