terminal.test.ts 26.4 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 7
import { window, Pseudoterminal, EventEmitter, TerminalDimensions, workspace, ConfigurationTarget, Disposable, UIKind, env, EnvironmentVariableMutatorType, EnvironmentVariableMutator, extensions, ExtensionContext, TerminalOptions, ExtensionTerminalOptions, Terminal } from 'vscode';
import { doesNotThrow, equal, deepEqual, throws } 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
		const config = workspace.getConfiguration('terminal.integrated');
22
		// Disable conpty in integration tests because of https://github.com/microsoft/vscode/issues/76548
23 24 25
		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);
D
Daniel Imms 已提交
26
		// Canvas may cause problems when running in a container
D
Daniel Imms 已提交
27
		await config.update('rendererType', 'dom', ConfigurationTarget.Global);
28
	});
29

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

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

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

60
		(process.platform === 'linux' ? test.skip : test.skip)('echo works in the default shell', (done) => {
61 62 63 64 65
			disposables.push(window.onDidOpenTerminal(term => {
				try {
					equal(terminal, term);
				} catch (e) {
					done(e);
D
Daniel Imms 已提交
66
					return;
67 68
				}
				let data = '';
69
				const dataDisposable = window.onDidWriteTerminalData(e => {
70 71 72 73
					try {
						equal(terminal, e.terminal);
					} catch (e) {
						done(e);
D
Daniel Imms 已提交
74
						return;
75 76
					}
					data += e.data;
77
					if (data.indexOf(expected) !== 0) {
78
						dataDisposable.dispose();
79
						terminal.dispose();
D
Daniel Imms 已提交
80 81 82
						disposables.push(window.onDidCloseTerminal(() => {
							done();
						}));
83
					}
84 85
				});
				disposables.push(dataDisposable);
86
			}));
87 88 89 90 91 92 93
			// Use a single character to avoid winpty/conpty issues with injected sequences
			const expected = '`';
			const terminal = window.createTerminal({
				env: {
					TEST: '`'
				}
			});
D
Daniel Imms 已提交
94
			terminal.show();
95 96 97 98 99 100 101 102
			doesNotThrow(() => {
				// 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`);
				}
			});
103 104
		});

D
Daniel Imms 已提交
105
		test('onDidCloseTerminal event fires when terminal is disposed', async () => {
106
			const terminal = window.createTerminal();
M
Megan Rogge 已提交
107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122
			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();
			});
123 124
		});

D
Daniel Imms 已提交
125
		test('processId immediately after createTerminal should fetch the pid', async () => {
126
			const terminal = window.createTerminal();
M
Megan Rogge 已提交
127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144
			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();
			});
145 146
		});

D
Daniel Imms 已提交
147
		test('name in constructor should set terminal.name', async () => {
148
			const terminal = window.createTerminal('a');
M
Megan Rogge 已提交
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164
			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();
			});
165 166
		});

D
Daniel Imms 已提交
167
		test('creationOptions should be set and readonly for TerminalOptions terminals', async () => {
168 169 170 171 172
			const options = {
				name: 'foo',
				hideFromUser: true
			};
			const terminal = window.createTerminal(options);
M
Megan Rogge 已提交
173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190
			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');
191 192
		});

D
Daniel Imms 已提交
193
		test('onDidOpenTerminal should fire when a terminal is created', async () => {
194
			const terminal = window.createTerminal('b');
M
Megan Rogge 已提交
195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210
			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();
			});
211
		});
212

D
Daniel Imms 已提交
213
		test('exitStatus.code should be set to undefined after a terminal is disposed', async () => {
M
Megan Rogge 已提交
214 215 216 217 218 219 220 221 222 223
			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 已提交
224
				disposables.push(window.onDidCloseTerminal(t => {
M
Megan Rogge 已提交
225
					if (t === terminal) {
D
Daniel Imms 已提交
226
						deepEqual(t.exitStatus, { code: undefined });
M
Megan Rogge 已提交
227
						r();
D
Daniel Imms 已提交
228 229 230
					}
				}));
				terminal.dispose();
M
Megan Rogge 已提交
231
			});
D
Daniel Imms 已提交
232 233
		});

234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249
		// 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();
		// });
250

251 252 253 254 255 256 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
		// 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();
		// });
303

D
Daniel Imms 已提交
304
		suite('hideFromUser', () => {
M
Megan Rogge 已提交
305
			test('should be available to terminals API', async () => {
306
				const terminal = window.createTerminal({ name: 'bg', hideFromUser: true });
M
Megan Rogge 已提交
307 308 309 310 311 312 313 314 315 316 317 318 319 320
				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();
						}
321
					}));
322
					terminal.dispose();
M
Megan Rogge 已提交
323
				});
324 325
			});
		});
326

327 328 329 330 331
		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[] = [];
332
				disposables.push(window.onDidOpenTerminal(e => openEvents.push(e.name)));
333 334

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

337
				disposables.push(window.onDidWriteTerminalData(e => {
338 339 340
					dataEvents.push({ name: e.terminal.name, data: e.data });

					resolveOnceDataWritten!();
341
				}));
342

343
				disposables.push(window.onDidCloseTerminal(e => {
344
					closeEvents.push(e.name);
D
Daniel Imms 已提交
345 346 347 348 349 350 351 352 353 354
					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 已提交
355
						resolveOnceClosed!();
D
Daniel Imms 已提交
356 357
					} catch (e) {
						done(e);
358
					}
359
				}));
360 361 362

				const term1Write = new EventEmitter<string>();
				const term1Close = new EventEmitter<void>();
E
Eric Amodio 已提交
363 364 365 366 367 368 369 370
				window.createTerminal({
					name: 'test1', pty: {
						onDidWrite: term1Write.event,
						onDidClose: term1Close.event,
						open: async () => {
							term1Write.fire('write1');

							// Wait until the data is written
371
							await new Promise<void>(resolve => { resolveOnceDataWritten = resolve; });
E
Eric Amodio 已提交
372 373 374 375 376

							term1Close.fire();

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

E
Eric Amodio 已提交
378 379 380 381 382 383 384 385
							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 已提交
386

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

E
Eric Amodio 已提交
390
										term2Close.fire();
D
Daniel Imms 已提交
391

E
Eric Amodio 已提交
392 393 394 395 396 397 398 399 400 401 402 403
										// Wait until the terminal is closed
										await new Promise<void>(resolve => { resolveOnceClosed = resolve; });

										done();
									},
									close: () => { }
								}
							});
						},
						close: () => { }
					}
				});
404 405 406
			});
		});

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

427 428 429 430 431 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
			// 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 已提交
473

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

			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 已提交
614
						return;
615 616 617 618 619 620 621 622 623 624 625 626 627 628
					}
					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');
629 630 631 632
					const terminalOptions = terminal.creationOptions as ExtensionTerminalOptions;
					equal(terminalOptions.name, 'foo');
					equal(terminalOptions.pty, pty);
					throws(() => terminalOptions.name = 'bad', 'creationOptions should be readonly at runtime');
633 634 635 636
				} catch (e) {
					done(e);
				}
			});
637
		});
638

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

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

			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 已提交
743
						return;
D
Daniel Imms 已提交
744 745 746 747 748 749 750 751 752 753 754
					}
					// 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();
						}
					}
				}));
755 756
				const collection = extensionContext.environmentVariableCollection;
				disposables.push({ dispose: () => collection.clear() });
D
Daniel Imms 已提交
757 758 759 760 761 762 763 764 765
				collection.replace('A', '~a2~');
				collection.replace('B', '~a2~');
				collection.clear();
				const terminal = window.createTerminal({
					env: {
						A: '~a1~',
						B: '~b1~'
					}
				});
766 767 768 769 770 771
				// 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 已提交
772 773 774 775 776 777 778 779 780 781 782 783 784
			});

			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 已提交
785
						return;
D
Daniel Imms 已提交
786 787 788 789 790 791 792 793 794 795 796
					}
					// 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();
						}
					}
				}));
797 798
				const collection = extensionContext.environmentVariableCollection;
				disposables.push({ dispose: () => collection.clear() });
D
Daniel Imms 已提交
799 800 801 802 803 804 805 806 807
				collection.replace('A', '~a2~');
				collection.replace('B', '~b2~');
				collection.delete('A');
				const terminal = window.createTerminal({
					env: {
						A: '~a1~',
						B: '~b2~'
					}
				});
808 809 810 811 812 813
				// 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 已提交
814 815 816
			});

			test('get and forEach should work', () => {
817 818
				const collection = extensionContext.environmentVariableCollection;
				disposables.push({ dispose: () => collection.clear() });
D
Daniel Imms 已提交
819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836
				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 }]
				]);
			});
837
		});
838 839
	});
});