/*--------------------------------------------------------------------------------------------- * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. See License.txt in the project root for license information. *--------------------------------------------------------------------------------------------*/ import { window, Pseudoterminal, EventEmitter, TerminalDimensions, workspace, ConfigurationTarget, Disposable, UIKind, env, EnvironmentVariableMutatorType, EnvironmentVariableMutator, extensions, ExtensionContext, TerminalOptions, ExtensionTerminalOptions, Terminal } from 'vscode'; import { doesNotThrow, equal, deepEqual, throws, strictEqual } from 'assert'; import { assertNoRpc } from '../utils'; // Disable terminal tests: // - Web https://github.com/microsoft/vscode/issues/92826 (env.uiKind === UIKind.Web ? suite.skip : suite)('vscode API - terminal', () => { let extensionContext: ExtensionContext; suiteSetup(async () => { // Trigger extension activation and grab the context as some tests depend on it await extensions.getExtension('vscode.vscode-api-tests')?.activate(); extensionContext = (global as any).testExtensionContext; const config = workspace.getConfiguration('terminal.integrated'); // Disable conpty in integration tests because of https://github.com/microsoft/vscode/issues/76548 await config.update('windowsEnableConpty', false, ConfigurationTarget.Global); // Disable exit alerts as tests may trigger then and we're not testing the notifications await config.update('showExitAlert', false, ConfigurationTarget.Global); // Canvas may cause problems when running in a container await config.update('rendererType', 'dom', ConfigurationTarget.Global); // Disable env var relaunch for tests to prevent terminals relaunching themselves await config.update('environmentChangesRelaunch', false, ConfigurationTarget.Global); }); suite('Terminal', () => { let disposables: Disposable[] = []; teardown(() => { assertNoRpc(); disposables.forEach(d => d.dispose()); disposables.length = 0; }); test('sendText immediately after createTerminal should not throw', async () => { const terminal = window.createTerminal(); const result = await new Promise(r => { disposables.push(window.onDidOpenTerminal(t => { if (t === terminal) { r(t); } })); }); equal(result, terminal); doesNotThrow(terminal.sendText.bind(terminal, 'echo "foo"')); await new Promise(r => { disposables.push(window.onDidCloseTerminal(t => { if (t === terminal) { r(); } })); terminal.dispose(); }); }); test('echo works in the default shell', async () => { const terminal = await new Promise(r => { disposables.push(window.onDidOpenTerminal(t => { if (t === terminal) { r(terminal); } })); // Use a single character to avoid winpty/conpty issues with injected sequences const terminal = window.createTerminal({ env: { TEST: '`' } }); terminal.show(); }); let data = ''; await new Promise(r => { disposables.push(window.onDidWriteTerminalData(e => { if (e.terminal === terminal) { data += e.data; if (data.indexOf('`') !== 0) { r(); } } })); // Print an environment variable value so the echo statement doesn't get matched if (process.platform === 'win32') { terminal.sendText(`$env:TEST`); } else { terminal.sendText(`echo $TEST`); } }); await new Promise(r => { terminal.dispose(); disposables.push(window.onDidCloseTerminal(t => { strictEqual(terminal, t); r(); })); }); }); test('onDidCloseTerminal event fires when terminal is disposed', async () => { const terminal = window.createTerminal(); const result = await new Promise(r => { disposables.push(window.onDidOpenTerminal(t => { if (t === terminal) { r(t); } })); }); equal(result, terminal); await new Promise(r => { disposables.push(window.onDidCloseTerminal(t => { if (t === terminal) { r(); } })); terminal.dispose(); }); }); test('processId immediately after createTerminal should fetch the pid', async () => { const terminal = window.createTerminal(); const result = await new Promise(r => { disposables.push(window.onDidOpenTerminal(t => { if (t === terminal) { r(t); } })); }); equal(result, terminal); let pid = await result.processId; equal(true, pid && pid > 0); await new Promise(r => { disposables.push(window.onDidCloseTerminal(t => { if (t === terminal) { r(); } })); terminal.dispose(); }); }); test('name in constructor should set terminal.name', async () => { const terminal = window.createTerminal('a'); const result = await new Promise(r => { disposables.push(window.onDidOpenTerminal(t => { if (t === terminal) { r(t); } })); }); equal(result, terminal); await new Promise(r => { disposables.push(window.onDidCloseTerminal(t => { if (t === terminal) { r(); } })); terminal.dispose(); }); }); test('creationOptions should be set and readonly for TerminalOptions terminals', async () => { const options = { name: 'foo', hideFromUser: true }; const terminal = window.createTerminal(options); const terminalOptions = terminal.creationOptions as TerminalOptions; const result = await new Promise(r => { disposables.push(window.onDidOpenTerminal(t => { if (t === terminal) { r(t); } })); }); equal(result, terminal); await new Promise(r => { disposables.push(window.onDidCloseTerminal(t => { if (t === terminal) { r(); } })); terminal.dispose(); }); throws(() => terminalOptions.name = 'bad', 'creationOptions should be readonly at runtime'); }); test('onDidOpenTerminal should fire when a terminal is created', async () => { const terminal = window.createTerminal('b'); const result = await new Promise(r => { disposables.push(window.onDidOpenTerminal(t => { if (t === terminal) { r(t); } })); }); equal(result, terminal); await new Promise(r => { disposables.push(window.onDidCloseTerminal(t => { if (t === terminal) { r(); } })); terminal.dispose(); }); }); test('exitStatus.code should be set to undefined after a terminal is disposed', async () => { const terminal = window.createTerminal(); const result = await new Promise(r => { disposables.push(window.onDidOpenTerminal(t => { if (t === terminal) { r(t); } })); }); equal(result, terminal); await new Promise(r => { disposables.push(window.onDidCloseTerminal(t => { if (t === terminal) { deepEqual(t.exitStatus, { code: undefined }); r(); } })); terminal.dispose(); }); }); // test('onDidChangeActiveTerminal should fire when new terminals are created', (done) => { // const reg1 = window.onDidChangeActiveTerminal((active: Terminal | undefined) => { // equal(active, terminal); // equal(active, window.activeTerminal); // reg1.dispose(); // const reg2 = window.onDidChangeActiveTerminal((active: Terminal | undefined) => { // equal(active, undefined); // equal(active, window.activeTerminal); // reg2.dispose(); // done(); // }); // terminal.dispose(); // }); // const terminal = window.createTerminal(); // terminal.show(); // }); // test('onDidChangeTerminalDimensions should fire when new terminals are created', (done) => { // const reg1 = window.onDidChangeTerminalDimensions(async (event: TerminalDimensionsChangeEvent) => { // equal(event.terminal, terminal1); // equal(typeof event.dimensions.columns, 'number'); // equal(typeof event.dimensions.rows, 'number'); // ok(event.dimensions.columns > 0); // ok(event.dimensions.rows > 0); // reg1.dispose(); // let terminal2: Terminal; // const reg2 = window.onDidOpenTerminal((newTerminal) => { // // This is guarantees to fire before dimensions change event // if (newTerminal !== terminal1) { // terminal2 = newTerminal; // reg2.dispose(); // } // }); // let firstCalled = false; // let secondCalled = false; // const reg3 = window.onDidChangeTerminalDimensions((event: TerminalDimensionsChangeEvent) => { // if (event.terminal === terminal1) { // // The original terminal should fire dimension change after a split // firstCalled = true; // } else if (event.terminal !== terminal1) { // // The new split terminal should fire dimension change // secondCalled = true; // } // if (firstCalled && secondCalled) { // let firstDisposed = false; // let secondDisposed = false; // const reg4 = window.onDidCloseTerminal(term => { // if (term === terminal1) { // firstDisposed = true; // } // if (term === terminal2) { // secondDisposed = true; // } // if (firstDisposed && secondDisposed) { // reg4.dispose(); // done(); // } // }); // terminal1.dispose(); // terminal2.dispose(); // reg3.dispose(); // } // }); // await timeout(500); // commands.executeCommand('workbench.action.terminal.split'); // }); // const terminal1 = window.createTerminal({ name: 'test' }); // terminal1.show(); // }); suite('hideFromUser', () => { test('should be available to terminals API', async () => { const terminal = window.createTerminal({ name: 'bg', hideFromUser: true }); const result = await new Promise(r => { disposables.push(window.onDidOpenTerminal(t => { if (t === terminal) { r(t); } })); }); equal(result, terminal); equal(true, window.terminals.indexOf(terminal) !== -1); await new Promise(r => { disposables.push(window.onDidCloseTerminal(t => { if (t === terminal) { r(); } })); terminal.dispose(); }); }); }); suite('window.onDidWriteTerminalData', () => { test('should listen to all future terminal data events', (done) => { const openEvents: string[] = []; const dataEvents: { name: string, data: string }[] = []; const closeEvents: string[] = []; disposables.push(window.onDidOpenTerminal(e => openEvents.push(e.name))); let resolveOnceDataWritten: (() => void) | undefined; let resolveOnceClosed: (() => void) | undefined; disposables.push(window.onDidWriteTerminalData(e => { dataEvents.push({ name: e.terminal.name, data: e.data }); resolveOnceDataWritten!(); })); disposables.push(window.onDidCloseTerminal(e => { closeEvents.push(e.name); try { if (closeEvents.length === 1) { deepEqual(openEvents, ['test1']); deepEqual(dataEvents, [{ name: 'test1', data: 'write1' }]); deepEqual(closeEvents, ['test1']); } else if (closeEvents.length === 2) { deepEqual(openEvents, ['test1', 'test2']); deepEqual(dataEvents, [{ name: 'test1', data: 'write1' }, { name: 'test2', data: 'write2' }]); deepEqual(closeEvents, ['test1', 'test2']); } resolveOnceClosed!(); } catch (e) { done(e); } })); const term1Write = new EventEmitter(); const term1Close = new EventEmitter(); window.createTerminal({ name: 'test1', pty: { onDidWrite: term1Write.event, onDidClose: term1Close.event, open: async () => { term1Write.fire('write1'); // Wait until the data is written await new Promise(resolve => { resolveOnceDataWritten = resolve; }); term1Close.fire(); // Wait until the terminal is closed await new Promise(resolve => { resolveOnceClosed = resolve; }); const term2Write = new EventEmitter(); const term2Close = new EventEmitter(); window.createTerminal({ name: 'test2', pty: { onDidWrite: term2Write.event, onDidClose: term2Close.event, open: async () => { term2Write.fire('write2'); // Wait until the data is written await new Promise(resolve => { resolveOnceDataWritten = resolve; }); term2Close.fire(); // Wait until the terminal is closed await new Promise(resolve => { resolveOnceClosed = resolve; }); done(); }, close: () => { } } }); }, close: () => { } } }); }); }); suite('Extension pty terminals', () => { test('should fire onDidOpenTerminal and onDidCloseTerminal', (done) => { disposables.push(window.onDidOpenTerminal(term => { try { equal(term.name, 'c'); } catch (e) { done(e); return; } disposables.push(window.onDidCloseTerminal(() => done())); term.dispose(); })); const pty: Pseudoterminal = { onDidWrite: new EventEmitter().event, open: () => { }, close: () => { } }; window.createTerminal({ name: 'c', pty }); }); // The below tests depend on global UI state and each other // test('should not provide dimensions on start as the terminal has not been shown yet', (done) => { // const reg1 = window.onDidOpenTerminal(term => { // equal(terminal, term); // reg1.dispose(); // }); // const pty: Pseudoterminal = { // onDidWrite: new EventEmitter().event, // open: (dimensions) => { // equal(dimensions, undefined); // const reg3 = window.onDidCloseTerminal(() => { // reg3.dispose(); // done(); // }); // // Show a terminal and wait a brief period before dispose, this will cause // // the panel to init it's dimenisons and be provided to following terminals. // // The following test depends on this. // terminal.show(); // setTimeout(() => terminal.dispose(), 200); // }, // close: () => {} // }; // const terminal = window.createTerminal({ name: 'foo', pty }); // }); // test('should provide dimensions on start as the terminal has been shown', (done) => { // const reg1 = window.onDidOpenTerminal(term => { // equal(terminal, term); // reg1.dispose(); // }); // const pty: Pseudoterminal = { // onDidWrite: new EventEmitter().event, // open: (dimensions) => { // // This test depends on Terminal.show being called some time before such // // that the panel dimensions are initialized and cached. // ok(dimensions!.columns > 0); // ok(dimensions!.rows > 0); // const reg3 = window.onDidCloseTerminal(() => { // reg3.dispose(); // done(); // }); // terminal.dispose(); // }, // close: () => {} // }; // const terminal = window.createTerminal({ name: 'foo', pty }); // }); test('should respect dimension overrides', (done) => { disposables.push(window.onDidOpenTerminal(term => { try { equal(terminal, term); } catch (e) { done(e); return; } term.show(); disposables.push(window.onDidChangeTerminalDimensions(e => { // The default pty dimensions have a chance to appear here since override // dimensions happens after the terminal is created. If so just ignore and // wait for the right dimensions if (e.dimensions.columns === 10 || e.dimensions.rows === 5) { try { equal(e.terminal, terminal); } catch (e) { done(e); return; } disposables.push(window.onDidCloseTerminal(() => done())); terminal.dispose(); } })); })); const writeEmitter = new EventEmitter(); const overrideDimensionsEmitter = new EventEmitter(); const pty: Pseudoterminal = { onDidWrite: writeEmitter.event, onDidOverrideDimensions: overrideDimensionsEmitter.event, open: () => overrideDimensionsEmitter.fire({ columns: 10, rows: 5 }), close: () => { } }; const terminal = window.createTerminal({ name: 'foo', pty }); }); test('exitStatus.code should be set to the exit code (undefined)', (done) => { disposables.push(window.onDidOpenTerminal(term => { try { equal(terminal, term); equal(terminal.exitStatus, undefined); } catch (e) { done(e); return; } disposables.push(window.onDidCloseTerminal(t => { try { equal(terminal, t); deepEqual(terminal.exitStatus, { code: undefined }); } catch (e) { done(e); return; } done(); })); })); const writeEmitter = new EventEmitter(); const closeEmitter = new EventEmitter(); const pty: Pseudoterminal = { onDidWrite: writeEmitter.event, onDidClose: closeEmitter.event, open: () => closeEmitter.fire(undefined), close: () => { } }; const terminal = window.createTerminal({ name: 'foo', pty }); }); test('exitStatus.code should be set to the exit code (zero)', (done) => { disposables.push(window.onDidOpenTerminal(term => { try { equal(terminal, term); equal(terminal.exitStatus, undefined); } catch (e) { done(e); return; } disposables.push(window.onDidCloseTerminal(t => { try { equal(terminal, t); deepEqual(terminal.exitStatus, { code: 0 }); } catch (e) { done(e); return; } done(); })); })); const writeEmitter = new EventEmitter(); const closeEmitter = new EventEmitter(); const pty: Pseudoterminal = { onDidWrite: writeEmitter.event, onDidClose: closeEmitter.event, open: () => closeEmitter.fire(0), close: () => { } }; const terminal = window.createTerminal({ name: 'foo', pty }); }); test('exitStatus.code should be set to the exit code (non-zero)', (done) => { disposables.push(window.onDidOpenTerminal(term => { try { equal(terminal, term); equal(terminal.exitStatus, undefined); } catch (e) { done(e); return; } disposables.push(window.onDidCloseTerminal(t => { try { equal(terminal, t); deepEqual(terminal.exitStatus, { code: 22 }); } catch (e) { done(e); return; } done(); })); })); const writeEmitter = new EventEmitter(); const closeEmitter = new EventEmitter(); const pty: Pseudoterminal = { onDidWrite: writeEmitter.event, onDidClose: closeEmitter.event, open: () => { // Wait 500ms as any exits that occur within 500ms of terminal launch are // are counted as "exiting during launch" which triggers a notification even // when showExitAlerts is true setTimeout(() => closeEmitter.fire(22), 500); }, close: () => { } }; const terminal = window.createTerminal({ name: 'foo', pty }); }); test('creationOptions should be set and readonly for ExtensionTerminalOptions terminals', (done) => { disposables.push(window.onDidOpenTerminal(term => { try { equal(terminal, term); } catch (e) { done(e); return; } terminal.dispose(); disposables.push(window.onDidCloseTerminal(() => done())); })); const writeEmitter = new EventEmitter(); const pty: Pseudoterminal = { onDidWrite: writeEmitter.event, open: () => { }, close: () => { } }; const options = { name: 'foo', pty }; const terminal = window.createTerminal(options); try { equal(terminal.name, 'foo'); const terminalOptions = terminal.creationOptions as ExtensionTerminalOptions; equal(terminalOptions.name, 'foo'); equal(terminalOptions.pty, pty); throws(() => terminalOptions.name = 'bad', 'creationOptions should be readonly at runtime'); } catch (e) { done(e); } }); }); suite('environmentVariableCollection', () => { test.skip('should have collection variables apply to terminals immediately after setting', (done) => { // Text to match on before passing the test const expectedText = [ '~a2~', 'b1~b2~', '~c2~c1' ]; disposables.push(window.onDidWriteTerminalData(e => { if (terminal !== e.terminal) { return; } // Multiple expected could show up in the same data event while (expectedText.length > 0 && e.data.indexOf(expectedText[0]) >= 0) { expectedText.shift(); // Check if all string are found, if so finish the test if (expectedText.length === 0) { disposables.push(window.onDidCloseTerminal(() => done())); terminal.dispose(); } } })); const collection = extensionContext.environmentVariableCollection; disposables.push({ dispose: () => collection.clear() }); collection.replace('A', '~a2~'); collection.append('B', '~b2~'); collection.prepend('C', '~c2~'); const terminal = window.createTerminal({ env: { A: 'a1', B: 'b1', C: 'c1' } }); // Run both PowerShell and sh commands, errors don't matter we're just looking for // the correct output terminal.sendText('$env:A'); terminal.sendText('echo $A'); terminal.sendText('$env:B'); terminal.sendText('echo $B'); terminal.sendText('$env:C'); terminal.sendText('echo $C'); }); test('should have collection variables apply to environment variables that don\'t exist', (done) => { // Text to match on before passing the test const expectedText = [ '~a2~', '~b2~', '~c2~' ]; disposables.push(window.onDidWriteTerminalData(e => { if (terminal !== e.terminal) { return; } // Multiple expected could show up in the same data event while (expectedText.length > 0 && e.data.indexOf(expectedText[0]) >= 0) { expectedText.shift(); // Check if all string are found, if so finish the test if (expectedText.length === 0) { disposables.push(window.onDidCloseTerminal(() => done())); terminal.dispose(); } } })); const collection = extensionContext.environmentVariableCollection; disposables.push({ dispose: () => collection.clear() }); collection.replace('A', '~a2~'); collection.append('B', '~b2~'); collection.prepend('C', '~c2~'); const terminal = window.createTerminal({ env: { A: null, B: null, C: null } }); // Run both PowerShell and sh commands, errors don't matter we're just looking for // the correct output terminal.sendText('$env:A'); terminal.sendText('echo $A'); terminal.sendText('$env:B'); terminal.sendText('echo $B'); terminal.sendText('$env:C'); terminal.sendText('echo $C'); }); test('should respect clearing entries', (done) => { // Text to match on before passing the test const expectedText = [ '~a1~', '~b1~' ]; disposables.push(window.onDidWriteTerminalData(e => { if (terminal !== e.terminal) { return; } // Multiple expected could show up in the same data event while (expectedText.length > 0 && e.data.indexOf(expectedText[0]) >= 0) { expectedText.shift(); // Check if all string are found, if so finish the test if (expectedText.length === 0) { disposables.push(window.onDidCloseTerminal(() => done())); terminal.dispose(); } } })); const collection = extensionContext.environmentVariableCollection; disposables.push({ dispose: () => collection.clear() }); collection.replace('A', '~a2~'); collection.replace('B', '~a2~'); collection.clear(); const terminal = window.createTerminal({ env: { A: '~a1~', B: '~b1~' } }); // Run both PowerShell and sh commands, errors don't matter we're just looking for // the correct output terminal.sendText('$env:A'); terminal.sendText('echo $A'); terminal.sendText('$env:B'); terminal.sendText('echo $B'); }); test('should respect deleting entries', (done) => { // Text to match on before passing the test const expectedText = [ '~a1~', '~b2~' ]; disposables.push(window.onDidWriteTerminalData(e => { if (terminal !== e.terminal) { return; } // Multiple expected could show up in the same data event while (expectedText.length > 0 && e.data.indexOf(expectedText[0]) >= 0) { expectedText.shift(); // Check if all string are found, if so finish the test if (expectedText.length === 0) { disposables.push(window.onDidCloseTerminal(() => done())); terminal.dispose(); } } })); const collection = extensionContext.environmentVariableCollection; disposables.push({ dispose: () => collection.clear() }); collection.replace('A', '~a2~'); collection.replace('B', '~b2~'); collection.delete('A'); const terminal = window.createTerminal({ env: { A: '~a1~', B: '~b2~' } }); // Run both PowerShell and sh commands, errors don't matter we're just looking for // the correct output terminal.sendText('$env:A'); terminal.sendText('echo $A'); terminal.sendText('$env:B'); terminal.sendText('echo $B'); }); test('get and forEach should work', () => { const collection = extensionContext.environmentVariableCollection; disposables.push({ dispose: () => collection.clear() }); collection.replace('A', '~a2~'); collection.append('B', '~b2~'); collection.prepend('C', '~c2~'); // Verify get deepEqual(collection.get('A'), { value: '~a2~', type: EnvironmentVariableMutatorType.Replace }); deepEqual(collection.get('B'), { value: '~b2~', type: EnvironmentVariableMutatorType.Append }); deepEqual(collection.get('C'), { value: '~c2~', type: EnvironmentVariableMutatorType.Prepend }); // Verify forEach const entries: [string, EnvironmentVariableMutator][] = []; collection.forEach((v, m) => entries.push([v, m])); deepEqual(entries, [ ['A', { value: '~a2~', type: EnvironmentVariableMutatorType.Replace }], ['B', { value: '~b2~', type: EnvironmentVariableMutatorType.Append }], ['C', { value: '~c2~', type: EnvironmentVariableMutatorType.Prepend }] ]); }); }); }); });