terminal.test.ts 26.6 KB
Newer Older
1 2 3 4 5
/*---------------------------------------------------------------------------------------------
 *  Copyright (c) Microsoft Corporation. All rights reserved.
 *  Licensed under the MIT License. See License.txt in the project root for license information.
 *--------------------------------------------------------------------------------------------*/

M
Megan Rogge 已提交
6
import { window, Pseudoterminal, EventEmitter, TerminalDimensions, workspace, ConfigurationTarget, Disposable, UIKind, env, EnvironmentVariableMutatorType, EnvironmentVariableMutator, extensions, ExtensionContext, TerminalOptions, ExtensionTerminalOptions, Terminal } from 'vscode';
7
import { doesNotThrow, equal, deepEqual, throws, strictEqual } from 'assert';
J
Johannes Rieken 已提交
8
import { assertNoRpc } from '../utils';
9

D
Daniel Imms 已提交
10 11 12 13
// Disable terminal tests:
// - Web https://github.com/microsoft/vscode/issues/92826
// - Remote https://github.com/microsoft/vscode/issues/96057
((env.uiKind === UIKind.Web || typeof env.remoteName !== 'undefined') ? suite.skip : suite)('vscode API - terminal', () => {
14 15
	let extensionContext: ExtensionContext;

16
	suiteSetup(async () => {
17 18 19 20
		// 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;

21 22 23
		const config = workspace.getConfiguration('terminal.integrated');
		// Disable exit alerts as tests may trigger then and we're not testing the notifications
		await config.update('showExitAlert', false, ConfigurationTarget.Global);
D
Daniel Imms 已提交
24
		// Canvas may cause problems when running in a container
D
Daniel Imms 已提交
25
		await config.update('rendererType', 'dom', ConfigurationTarget.Global);
26
	});
27

28
	suite('Terminal', () => {
29 30 31
		let disposables: Disposable[] = [];

		teardown(() => {
J
Johannes Rieken 已提交
32
			assertNoRpc();
33 34 35 36
			disposables.forEach(d => d.dispose());
			disposables.length = 0;
		});

D
Daniel Imms 已提交
37
		test('sendText immediately after createTerminal should not throw', async () => {
38
			const terminal = window.createTerminal();
M
Megan Rogge 已提交
39 40 41 42 43 44 45 46
			const result = await new Promise<Terminal>(r => {
				disposables.push(window.onDidOpenTerminal(t => {
					if (t === terminal) {
						r(t);
					}
				}));
			});
			equal(result, terminal);
47
			doesNotThrow(terminal.sendText.bind(terminal, 'echo "foo"'));
M
Megan Rogge 已提交
48 49 50 51 52 53 54 55
			await new Promise<void>(r => {
				disposables.push(window.onDidCloseTerminal(t => {
					if (t === terminal) {
						r();
					}
				}));
				terminal.dispose();
			});
56 57
		});

D
Daniel Imms 已提交
58 59
		test('echo works in the default shell', async () => {
			console.log('  test 1');
60
			const terminal = await new Promise<Terminal>(r => {
D
Daniel Imms 已提交
61
				console.log('  test 2');
62
				disposables.push(window.onDidOpenTerminal(t => {
D
Daniel Imms 已提交
63
					console.log('  test 3');
64 65 66
					strictEqual(terminal, t);
					r(terminal);
				}));
D
Daniel Imms 已提交
67
				console.log('  test 4');
68 69 70
				// Use a single character to avoid winpty/conpty issues with injected sequences
				const terminal = window.createTerminal({
					env: { TEST: '`' }
71
				});
D
Daniel Imms 已提交
72
				console.log('  test 5');
73
				terminal.show();
74
			});
75

D
Daniel Imms 已提交
76
			console.log('  test 6');
77 78
			let data = '';
			await new Promise<void>(r => {
D
Daniel Imms 已提交
79
				console.log('  test 7');
80
				disposables.push(window.onDidWriteTerminalData(e => {
D
Daniel Imms 已提交
81
					console.log('  test 8');
82 83 84
					strictEqual(terminal, e.terminal);
					data += e.data;
					if (data.indexOf('`') !== 0) {
D
Daniel Imms 已提交
85
						console.log('  test 9');
86 87 88
						r();
					}
				}));
89 90
				// Print an environment variable value so the echo statement doesn't get matched
				if (process.platform === 'win32') {
D
Daniel Imms 已提交
91
					console.log('  test 10');
92 93
					terminal.sendText(`$env:TEST`);
				} else {
D
Daniel Imms 已提交
94
					console.log('  test 11');
95 96 97
					terminal.sendText(`echo $TEST`);
				}
			});
98

D
Daniel Imms 已提交
99
			console.log('  test 12');
100
			await new Promise<void>(r => {
D
Daniel Imms 已提交
101
				console.log('  test 1');
102
				terminal.dispose();
D
Daniel Imms 已提交
103
				console.log('  test 14');
104
				disposables.push(window.onDidCloseTerminal(t => {
D
Daniel Imms 已提交
105
					console.log('  test 15');
106 107 108 109
					strictEqual(terminal, t);
					r();
				}));
			});
110 111
		});

D
Daniel Imms 已提交
112
		test('onDidCloseTerminal event fires when terminal is disposed', async () => {
113
			const terminal = window.createTerminal();
M
Megan Rogge 已提交
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129
			const result = await new Promise<Terminal>(r => {
				disposables.push(window.onDidOpenTerminal(t => {
					if (t === terminal) {
						r(t);
					}
				}));
			});
			equal(result, terminal);
			await new Promise<void>(r => {
				disposables.push(window.onDidCloseTerminal(t => {
					if (t === terminal) {
						r();
					}
				}));
				terminal.dispose();
			});
130 131
		});

D
Daniel Imms 已提交
132
		test.skip('processId immediately after createTerminal should fetch the pid', async () => {
133
			const terminal = window.createTerminal();
M
Megan Rogge 已提交
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
			const result = await new Promise<Terminal>(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<void>(r => {
				disposables.push(window.onDidCloseTerminal(t => {
					if (t === terminal) {
						r();
					}
				}));
				terminal.dispose();
			});
152 153
		});

D
Daniel Imms 已提交
154
		test.skip('name in constructor should set terminal.name', async () => {
155
			const terminal = window.createTerminal('a');
M
Megan Rogge 已提交
156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171
			const result = await new Promise<Terminal>(r => {
				disposables.push(window.onDidOpenTerminal(t => {
					if (t === terminal) {
						r(t);
					}
				}));
			});
			equal(result, terminal);
			await new Promise<void>(r => {
				disposables.push(window.onDidCloseTerminal(t => {
					if (t === terminal) {
						r();
					}
				}));
				terminal.dispose();
			});
172 173
		});

D
Daniel Imms 已提交
174
		test.skip('creationOptions should be set and readonly for TerminalOptions terminals', async () => {
175 176 177 178 179
			const options = {
				name: 'foo',
				hideFromUser: true
			};
			const terminal = window.createTerminal(options);
M
Megan Rogge 已提交
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197
			const terminalOptions = terminal.creationOptions as TerminalOptions;
			const result = await new Promise<Terminal>(r => {
				disposables.push(window.onDidOpenTerminal(t => {
					if (t === terminal) {
						r(t);
					}
				}));
			});
			equal(result, terminal);
			await new Promise<void>(r => {
				disposables.push(window.onDidCloseTerminal(t => {
					if (t === terminal) {
						r();
					}
				}));
				terminal.dispose();
			});
			throws(() => terminalOptions.name = 'bad', 'creationOptions should be readonly at runtime');
198 199
		});

D
Daniel Imms 已提交
200
		test.skip('onDidOpenTerminal should fire when a terminal is created', async () => {
201
			const terminal = window.createTerminal('b');
M
Megan Rogge 已提交
202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217
			const result = await new Promise<Terminal>(r => {
				disposables.push(window.onDidOpenTerminal(t => {
					if (t === terminal) {
						r(t);
					}
				}));
			});
			equal(result, terminal);
			await new Promise<void>(r => {
				disposables.push(window.onDidCloseTerminal(t => {
					if (t === terminal) {
						r();
					}
				}));
				terminal.dispose();
			});
218
		});
219

D
Daniel Imms 已提交
220
		test.skip('exitStatus.code should be set to undefined after a terminal is disposed', async () => {
M
Megan Rogge 已提交
221 222 223 224 225 226 227 228 229 230
			const terminal = window.createTerminal();
			const result = await new Promise<Terminal>(r => {
				disposables.push(window.onDidOpenTerminal(t => {
					if (t === terminal) {
						r(t);
					}
				}));
			});
			equal(result, terminal);
			await new Promise<void>(r => {
D
Daniel Imms 已提交
231
				disposables.push(window.onDidCloseTerminal(t => {
M
Megan Rogge 已提交
232
					if (t === terminal) {
D
Daniel Imms 已提交
233
						deepEqual(t.exitStatus, { code: undefined });
M
Megan Rogge 已提交
234
						r();
D
Daniel Imms 已提交
235 236 237
					}
				}));
				terminal.dispose();
M
Megan Rogge 已提交
238
			});
D
Daniel Imms 已提交
239 240
		});

241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256
		// 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();
		// });
257

258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309
		// 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();
		// });
310

D
Daniel Imms 已提交
311
		suite.skip('hideFromUser', () => {
M
Megan Rogge 已提交
312
			test('should be available to terminals API', async () => {
313
				const terminal = window.createTerminal({ name: 'bg', hideFromUser: true });
M
Megan Rogge 已提交
314 315 316 317 318 319 320 321 322 323 324 325 326 327
				const result = await new Promise<Terminal>(r => {
					disposables.push(window.onDidOpenTerminal(t => {
						if (t === terminal) {
							r(t);
						}
					}));
				});
				equal(result, terminal);
				equal(true, window.terminals.indexOf(terminal) !== -1);
				await new Promise<void>(r => {
					disposables.push(window.onDidCloseTerminal(t => {
						if (t === terminal) {
							r();
						}
328
					}));
329
					terminal.dispose();
M
Megan Rogge 已提交
330
				});
331 332
			});
		});
333

334 335 336 337 338
		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[] = [];
339
				disposables.push(window.onDidOpenTerminal(e => openEvents.push(e.name)));
340 341

				let resolveOnceDataWritten: (() => void) | undefined;
E
Eric Amodio 已提交
342
				let resolveOnceClosed: (() => void) | undefined;
343

344
				disposables.push(window.onDidWriteTerminalData(e => {
345 346 347
					dataEvents.push({ name: e.terminal.name, data: e.data });

					resolveOnceDataWritten!();
348
				}));
349

350
				disposables.push(window.onDidCloseTerminal(e => {
351
					closeEvents.push(e.name);
D
Daniel Imms 已提交
352 353 354 355 356 357 358 359 360 361
					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']);
						}
E
Eric Amodio 已提交
362
						resolveOnceClosed!();
D
Daniel Imms 已提交
363 364
					} catch (e) {
						done(e);
365
					}
366
				}));
367 368 369

				const term1Write = new EventEmitter<string>();
				const term1Close = new EventEmitter<void>();
E
Eric Amodio 已提交
370 371 372 373 374 375 376 377
				window.createTerminal({
					name: 'test1', pty: {
						onDidWrite: term1Write.event,
						onDidClose: term1Close.event,
						open: async () => {
							term1Write.fire('write1');

							// Wait until the data is written
378
							await new Promise<void>(resolve => { resolveOnceDataWritten = resolve; });
E
Eric Amodio 已提交
379 380 381 382 383

							term1Close.fire();

							// Wait until the terminal is closed
							await new Promise<void>(resolve => { resolveOnceClosed = resolve; });
D
Daniel Imms 已提交
384

E
Eric Amodio 已提交
385 386 387 388 389 390 391 392
							const term2Write = new EventEmitter<string>();
							const term2Close = new EventEmitter<void>();
							window.createTerminal({
								name: 'test2', pty: {
									onDidWrite: term2Write.event,
									onDidClose: term2Close.event,
									open: async () => {
										term2Write.fire('write2');
D
Daniel Imms 已提交
393

E
Eric Amodio 已提交
394 395
										// Wait until the data is written
										await new Promise<void>(resolve => { resolveOnceDataWritten = resolve; });
D
Daniel Imms 已提交
396

E
Eric Amodio 已提交
397
										term2Close.fire();
D
Daniel Imms 已提交
398

E
Eric Amodio 已提交
399 400 401 402 403 404 405 406 407 408 409 410
										// Wait until the terminal is closed
										await new Promise<void>(resolve => { resolveOnceClosed = resolve; });

										done();
									},
									close: () => { }
								}
							});
						},
						close: () => { }
					}
				});
411 412 413
			});
		});

D
Daniel Imms 已提交
414
		suite('Extension pty terminals', () => {
415
			test('should fire onDidOpenTerminal and onDidCloseTerminal', (done) => {
416
				disposables.push(window.onDidOpenTerminal(term => {
D
Daniel Imms 已提交
417 418 419 420
					try {
						equal(term.name, 'c');
					} catch (e) {
						done(e);
D
Daniel Imms 已提交
421
						return;
D
Daniel Imms 已提交
422
					}
423
					disposables.push(window.onDidCloseTerminal(() => done()));
424
					term.dispose();
425
				}));
426
				const pty: Pseudoterminal = {
D
Daniel Imms 已提交
427
					onDidWrite: new EventEmitter<string>().event,
428 429
					open: () => { },
					close: () => { }
430
				};
431
				window.createTerminal({ name: 'c', pty });
432 433
			});

434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479
			// 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<string>().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<string>().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 });
			// });
D
Daniel Imms 已提交
480

D
Daniel Imms 已提交
481
			test('should respect dimension overrides', (done) => {
482
				disposables.push(window.onDidOpenTerminal(term => {
D
Daniel Imms 已提交
483 484 485 486
					try {
						equal(terminal, term);
					} catch (e) {
						done(e);
D
Daniel Imms 已提交
487
						return;
D
Daniel Imms 已提交
488
					}
D
Daniel Imms 已提交
489
					term.show();
490
					disposables.push(window.onDidChangeTerminalDimensions(e => {
D
Daniel Imms 已提交
491 492 493 494 495 496 497 498
						// 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);
D
Daniel Imms 已提交
499
								return;
D
Daniel Imms 已提交
500 501 502
							}
							disposables.push(window.onDidCloseTerminal(() => done()));
							terminal.dispose();
D
Daniel Imms 已提交
503
						}
504 505
					}));
				}));
D
Daniel Imms 已提交
506 507
				const writeEmitter = new EventEmitter<string>();
				const overrideDimensionsEmitter = new EventEmitter<TerminalDimensions>();
508
				const pty: Pseudoterminal = {
509
					onDidWrite: writeEmitter.event,
D
Daniel Imms 已提交
510
					onDidOverrideDimensions: overrideDimensionsEmitter.event,
D
Daniel Imms 已提交
511 512 513 514 515 516 517 518 519 520 521 522 523
					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);
D
Daniel Imms 已提交
524
						return;
D
Daniel Imms 已提交
525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541
					}
					disposables.push(window.onDidCloseTerminal(t => {
						try {
							equal(terminal, t);
							deepEqual(terminal.exitStatus, { code: undefined });
						} catch (e) {
							done(e);
							return;
						}
						done();
					}));
				}));
				const writeEmitter = new EventEmitter<string>();
				const closeEmitter = new EventEmitter<number | undefined>();
				const pty: Pseudoterminal = {
					onDidWrite: writeEmitter.event,
					onDidClose: closeEmitter.event,
542
					open: () => closeEmitter.fire(undefined),
D
Daniel Imms 已提交
543 544 545 546 547 548 549 550 551 552 553 554
					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);
D
Daniel Imms 已提交
555
						return;
D
Daniel Imms 已提交
556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585
					}
					disposables.push(window.onDidCloseTerminal(t => {
						try {
							equal(terminal, t);
							deepEqual(terminal.exitStatus, { code: 0 });
						} catch (e) {
							done(e);
							return;
						}
						done();
					}));
				}));
				const writeEmitter = new EventEmitter<string>();
				const closeEmitter = new EventEmitter<number | undefined>();
				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);
D
Daniel Imms 已提交
586
						return;
D
Daniel Imms 已提交
587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603
					}
					disposables.push(window.onDidCloseTerminal(t => {
						try {
							equal(terminal, t);
							deepEqual(terminal.exitStatus, { code: 22 });
						} catch (e) {
							done(e);
							return;
						}
						done();
					}));
				}));
				const writeEmitter = new EventEmitter<string>();
				const closeEmitter = new EventEmitter<number | undefined>();
				const pty: Pseudoterminal = {
					onDidWrite: writeEmitter.event,
					onDidClose: closeEmitter.event,
604 605 606 607 608 609
					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);
					},
610
					close: () => { }
D
Daniel Imms 已提交
611
				};
612
				const terminal = window.createTerminal({ name: 'foo', pty });
D
Daniel Imms 已提交
613
			});
614 615 616 617 618 619 620

			test('creationOptions should be set and readonly for ExtensionTerminalOptions terminals', (done) => {
				disposables.push(window.onDidOpenTerminal(term => {
					try {
						equal(terminal, term);
					} catch (e) {
						done(e);
D
Daniel Imms 已提交
621
						return;
622 623 624 625 626 627 628 629 630 631 632 633 634 635
					}
					terminal.dispose();
					disposables.push(window.onDidCloseTerminal(() => done()));
				}));
				const writeEmitter = new EventEmitter<string>();
				const pty: Pseudoterminal = {
					onDidWrite: writeEmitter.event,
					open: () => { },
					close: () => { }
				};
				const options = { name: 'foo', pty };
				const terminal = window.createTerminal(options);
				try {
					equal(terminal.name, 'foo');
636 637 638 639
					const terminalOptions = terminal.creationOptions as ExtensionTerminalOptions;
					equal(terminalOptions.name, 'foo');
					equal(terminalOptions.pty, pty);
					throws(() => terminalOptions.name = 'bad', 'creationOptions should be readonly at runtime');
640 641 642 643
				} catch (e) {
					done(e);
				}
			});
644
		});
645

646
		suite.skip('environmentVariableCollection', () => {
647 648 649 650 651 652 653 654 655 656 657 658
			test('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 => {
					try {
						equal(terminal, e.terminal);
					} catch (e) {
						done(e);
D
Daniel Imms 已提交
659
						return;
660 661 662 663 664 665 666 667 668 669 670
					}
					// 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();
						}
					}
				}));
671 672
				const collection = extensionContext.environmentVariableCollection;
				disposables.push({ dispose: () => collection.clear() });
673 674 675 676 677 678 679 680 681 682
				collection.replace('A', '~a2~');
				collection.append('B', '~b2~');
				collection.prepend('C', '~c2~');
				const terminal = window.createTerminal({
					env: {
						A: 'a1',
						B: 'b1',
						C: 'c1'
					}
				});
683 684 685 686 687 688 689 690
				// 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');
691 692 693 694 695 696 697 698 699 700 701 702 703 704
			});

			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 => {
					try {
						equal(terminal, e.terminal);
					} catch (e) {
						done(e);
D
Daniel Imms 已提交
705
						return;
706 707 708 709 710 711 712 713 714 715 716
					}
					// 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();
						}
					}
				}));
717 718
				const collection = extensionContext.environmentVariableCollection;
				disposables.push({ dispose: () => collection.clear() });
719 720 721 722 723 724 725 726 727 728
				collection.replace('A', '~a2~');
				collection.append('B', '~b2~');
				collection.prepend('C', '~c2~');
				const terminal = window.createTerminal({
					env: {
						A: null,
						B: null,
						C: null
					}
				});
729 730 731 732 733 734 735 736
				// 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');
737
			});
D
Daniel Imms 已提交
738 739 740 741 742 743 744 745 746 747 748 749

			test('should respect clearing entries', (done) => {
				// Text to match on before passing the test
				const expectedText = [
					'~a1~',
					'~b1~'
				];
				disposables.push(window.onDidWriteTerminalData(e => {
					try {
						equal(terminal, e.terminal);
					} catch (e) {
						done(e);
D
Daniel Imms 已提交
750
						return;
D
Daniel Imms 已提交
751 752 753 754 755 756 757 758 759 760 761
					}
					// 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();
						}
					}
				}));
762 763
				const collection = extensionContext.environmentVariableCollection;
				disposables.push({ dispose: () => collection.clear() });
D
Daniel Imms 已提交
764 765 766 767 768 769 770 771 772
				collection.replace('A', '~a2~');
				collection.replace('B', '~a2~');
				collection.clear();
				const terminal = window.createTerminal({
					env: {
						A: '~a1~',
						B: '~b1~'
					}
				});
773 774 775 776 777 778
				// 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');
D
Daniel Imms 已提交
779 780 781 782 783 784 785 786 787 788 789 790 791
			});

			test('should respect deleting entries', (done) => {
				// Text to match on before passing the test
				const expectedText = [
					'~a1~',
					'~b2~'
				];
				disposables.push(window.onDidWriteTerminalData(e => {
					try {
						equal(terminal, e.terminal);
					} catch (e) {
						done(e);
D
Daniel Imms 已提交
792
						return;
D
Daniel Imms 已提交
793 794 795 796 797 798 799 800 801 802 803
					}
					// 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();
						}
					}
				}));
804 805
				const collection = extensionContext.environmentVariableCollection;
				disposables.push({ dispose: () => collection.clear() });
D
Daniel Imms 已提交
806 807 808 809 810 811 812 813 814
				collection.replace('A', '~a2~');
				collection.replace('B', '~b2~');
				collection.delete('A');
				const terminal = window.createTerminal({
					env: {
						A: '~a1~',
						B: '~b2~'
					}
				});
815 816 817 818 819 820
				// 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');
D
Daniel Imms 已提交
821 822 823
			});

			test('get and forEach should work', () => {
824 825
				const collection = extensionContext.environmentVariableCollection;
				disposables.push({ dispose: () => collection.clear() });
D
Daniel Imms 已提交
826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843
				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 }]
				]);
			});
844
		});
845 846
	});
});