terminal.test.ts 25.5 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.
 *--------------------------------------------------------------------------------------------*/

6
import { window, Pseudoterminal, EventEmitter, TerminalDimensions, workspace, ConfigurationTarget, Disposable, UIKind, env, EnvironmentVariableMutatorType, EnvironmentVariableMutator, extensions, ExtensionContext } from 'vscode';
7
import { doesNotThrow, equal, ok, deepEqual, throws } from 'assert';
8

D
Daniel Imms 已提交
9 10 11 12
// 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', () => {
13 14
	let extensionContext: ExtensionContext;

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

20
		const config = workspace.getConfiguration('terminal.integrated');
21
		// Disable conpty in integration tests because of https://github.com/microsoft/vscode/issues/76548
22 23 24
		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 已提交
25
		// Canvas may cause problems when running in a container
D
Daniel Imms 已提交
26
		await config.update('rendererType', 'dom', ConfigurationTarget.Global);
27
	});
28

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

		teardown(() => {
			disposables.forEach(d => d.dispose());
			disposables.length = 0;
		});

37
		test('sendText immediately after createTerminal should not throw', (done) => {
38
			disposables.push(window.onDidOpenTerminal(term => {
D
Daniel Imms 已提交
39 40 41 42
				try {
					equal(terminal, term);
				} catch (e) {
					done(e);
D
Daniel Imms 已提交
43
					return;
D
Daniel Imms 已提交
44
				}
45
				terminal.dispose();
46 47
				disposables.push(window.onDidCloseTerminal(() => done()));
			}));
48 49 50 51
			const terminal = window.createTerminal();
			doesNotThrow(terminal.sendText.bind(terminal, 'echo "foo"'));
		});

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

97
		test('onDidCloseTerminal event fires when terminal is disposed', (done) => {
98
			disposables.push(window.onDidOpenTerminal(term => {
D
Daniel Imms 已提交
99 100 101 102
				try {
					equal(terminal, term);
				} catch (e) {
					done(e);
D
Daniel Imms 已提交
103
					return;
D
Daniel Imms 已提交
104
				}
105
				terminal.dispose();
106 107
				disposables.push(window.onDidCloseTerminal(() => done()));
			}));
108
			const terminal = window.createTerminal();
109 110 111
		});

		test('processId immediately after createTerminal should fetch the pid', (done) => {
112
			disposables.push(window.onDidOpenTerminal(term => {
D
Daniel Imms 已提交
113 114 115 116
				try {
					equal(terminal, term);
				} catch (e) {
					done(e);
D
Daniel Imms 已提交
117
					return;
D
Daniel Imms 已提交
118
				}
119
				terminal.processId.then(id => {
D
Daniel Imms 已提交
120
					try {
D
Daniel Imms 已提交
121
						ok(id && id > 0);
D
Daniel Imms 已提交
122 123
					} catch (e) {
						done(e);
D
Daniel Imms 已提交
124
						return;
D
Daniel Imms 已提交
125
					}
126
					terminal.dispose();
127
					disposables.push(window.onDidCloseTerminal(() => done()));
128
				});
129
			}));
130
			const terminal = window.createTerminal();
131 132
		});

133
		test('name in constructor should set terminal.name', (done) => {
134
			disposables.push(window.onDidOpenTerminal(term => {
D
Daniel Imms 已提交
135 136 137 138
				try {
					equal(terminal, term);
				} catch (e) {
					done(e);
D
Daniel Imms 已提交
139
					return;
D
Daniel Imms 已提交
140
				}
141
				terminal.dispose();
142 143
				disposables.push(window.onDidCloseTerminal(() => done()));
			}));
144
			const terminal = window.createTerminal('a');
D
Daniel Imms 已提交
145 146 147 148
			try {
				equal(terminal.name, 'a');
			} catch (e) {
				done(e);
D
Daniel Imms 已提交
149
				return;
D
Daniel Imms 已提交
150
			}
151 152
		});

153 154 155 156 157 158
		test('creationOptions should be set and readonly for TerminalOptions terminals', (done) => {
			disposables.push(window.onDidOpenTerminal(term => {
				try {
					equal(terminal, term);
				} catch (e) {
					done(e);
D
Daniel Imms 已提交
159
					return;
160 161 162 163 164 165 166 167 168 169 170 171 172 173 174
				}
				terminal.dispose();
				disposables.push(window.onDidCloseTerminal(() => done()));
			}));
			const options = {
				name: 'foo',
				hideFromUser: true
			};
			const terminal = window.createTerminal(options);
			try {
				equal(terminal.name, 'foo');
				deepEqual(terminal.creationOptions, options);
				throws(() => (<any>terminal.creationOptions).name = 'bad', 'creationOptions should be readonly at runtime');
			} catch (e) {
				done(e);
D
Daniel Imms 已提交
175
				return;
176 177 178
			}
		});

179
		test('onDidOpenTerminal should fire when a terminal is created', (done) => {
180
			disposables.push(window.onDidOpenTerminal(term => {
D
Daniel Imms 已提交
181 182 183 184
				try {
					equal(term.name, 'b');
				} catch (e) {
					done(e);
D
Daniel Imms 已提交
185
					return;
D
Daniel Imms 已提交
186
				}
187
				disposables.push(window.onDidCloseTerminal(() => done()));
188
				terminal.dispose();
189
			}));
190 191
			const terminal = window.createTerminal('b');
		});
192

D
Daniel Imms 已提交
193 194 195 196 197 198
		test('exitStatus.code should be set to undefined after a terminal is disposed', (done) => {
			disposables.push(window.onDidOpenTerminal(term => {
				try {
					equal(term, terminal);
				} catch (e) {
					done(e);
D
Daniel Imms 已提交
199
					return;
D
Daniel Imms 已提交
200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
				}
				disposables.push(window.onDidCloseTerminal(t => {
					try {
						deepEqual(t.exitStatus, { code: undefined });
					} catch (e) {
						done(e);
						return;
					}
					done();
				}));
				terminal.dispose();
			}));
			const terminal = window.createTerminal();
		});

215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230
		// 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();
		// });
231

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

285 286 287
		suite('hideFromUser', () => {
			test('should be available to terminals API', done => {
				const terminal = window.createTerminal({ name: 'bg', hideFromUser: true });
288
				disposables.push(window.onDidOpenTerminal(t => {
D
Daniel Imms 已提交
289 290 291 292 293 294
					try {
						equal(t, terminal);
						equal(t.name, 'bg');
						ok(window.terminals.indexOf(terminal) !== -1);
					} catch (e) {
						done(e);
D
Daniel Imms 已提交
295
						return;
D
Daniel Imms 已提交
296
					}
297 298
					disposables.push(window.onDidCloseTerminal(() => {
						// reg3.dispose();
299
						done();
300
					}));
301
					terminal.dispose();
302
				}));
303 304
			});
		});
305

306 307 308 309 310
		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[] = [];
311
				disposables.push(window.onDidOpenTerminal(e => openEvents.push(e.name)));
312 313

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

316
				disposables.push(window.onDidWriteTerminalData(e => {
317 318 319
					dataEvents.push({ name: e.terminal.name, data: e.data });

					resolveOnceDataWritten!();
320
				}));
321

322
				disposables.push(window.onDidCloseTerminal(e => {
323
					closeEvents.push(e.name);
D
Daniel Imms 已提交
324 325 326 327 328 329 330 331 332 333
					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 已提交
334
						resolveOnceClosed!();
D
Daniel Imms 已提交
335 336
					} catch (e) {
						done(e);
337
					}
338
				}));
339 340 341

				const term1Write = new EventEmitter<string>();
				const term1Close = new EventEmitter<void>();
E
Eric Amodio 已提交
342 343 344 345 346 347 348 349 350 351 352 353 354 355
				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<void>(resolve => { resolveOnceClosed = resolve; });
D
Daniel Imms 已提交
356

E
Eric Amodio 已提交
357 358 359 360 361 362 363 364
							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 已提交
365

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

E
Eric Amodio 已提交
369
										term2Close.fire();
D
Daniel Imms 已提交
370

E
Eric Amodio 已提交
371 372 373 374 375 376 377 378 379 380 381 382
										// Wait until the terminal is closed
										await new Promise<void>(resolve => { resolveOnceClosed = resolve; });

										done();
									},
									close: () => { }
								}
							});
						},
						close: () => { }
					}
				});
383 384 385
			});
		});

D
Daniel Imms 已提交
386
		suite('Extension pty terminals', () => {
387
			test('should fire onDidOpenTerminal and onDidCloseTerminal', (done) => {
388
				disposables.push(window.onDidOpenTerminal(term => {
D
Daniel Imms 已提交
389 390 391 392
					try {
						equal(term.name, 'c');
					} catch (e) {
						done(e);
D
Daniel Imms 已提交
393
						return;
D
Daniel Imms 已提交
394
					}
395
					disposables.push(window.onDidCloseTerminal(() => done()));
396
					term.dispose();
397
				}));
398
				const pty: Pseudoterminal = {
D
Daniel Imms 已提交
399
					onDidWrite: new EventEmitter<string>().event,
400 401
					open: () => { },
					close: () => { }
402
				};
403
				window.createTerminal({ name: 'c', pty });
404 405
			});

406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 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
			// 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 已提交
452

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

			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 已提交
593
						return;
594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613
					}
					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');
					deepEqual(terminal.creationOptions, options);
					throws(() => (<any>terminal.creationOptions).name = 'bad', 'creationOptions should be readonly at runtime');
				} catch (e) {
					done(e);
				}
			});
614
		});
615

616
		suite('environmentVariableCollection', () => {
617 618 619 620 621 622 623 624 625 626 627 628
			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 已提交
629
						return;
630 631 632 633 634 635 636 637 638 639 640
					}
					// 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();
						}
					}
				}));
641 642
				const collection = extensionContext.environmentVariableCollection;
				disposables.push({ dispose: () => collection.clear() });
643 644 645 646 647 648 649 650 651 652
				collection.replace('A', '~a2~');
				collection.append('B', '~b2~');
				collection.prepend('C', '~c2~');
				const terminal = window.createTerminal({
					env: {
						A: 'a1',
						B: 'b1',
						C: 'c1'
					}
				});
653 654 655 656 657 658 659 660
				// 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');
661 662 663 664 665 666 667 668 669 670 671 672 673 674
			});

			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 已提交
675
						return;
676 677 678 679 680 681 682 683 684 685 686
					}
					// 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();
						}
					}
				}));
687 688
				const collection = extensionContext.environmentVariableCollection;
				disposables.push({ dispose: () => collection.clear() });
689 690 691 692 693 694 695 696 697 698
				collection.replace('A', '~a2~');
				collection.append('B', '~b2~');
				collection.prepend('C', '~c2~');
				const terminal = window.createTerminal({
					env: {
						A: null,
						B: null,
						C: null
					}
				});
699 700 701 702 703 704 705 706
				// 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');
707
			});
D
Daniel Imms 已提交
708 709 710 711 712 713 714 715 716 717 718 719

			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 已提交
720
						return;
D
Daniel Imms 已提交
721 722 723 724 725 726 727 728 729 730 731
					}
					// 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();
						}
					}
				}));
732 733
				const collection = extensionContext.environmentVariableCollection;
				disposables.push({ dispose: () => collection.clear() });
D
Daniel Imms 已提交
734 735 736 737 738 739 740 741 742
				collection.replace('A', '~a2~');
				collection.replace('B', '~a2~');
				collection.clear();
				const terminal = window.createTerminal({
					env: {
						A: '~a1~',
						B: '~b1~'
					}
				});
743 744 745 746 747 748
				// 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 已提交
749 750 751 752 753 754 755 756 757 758 759 760 761
			});

			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 已提交
762
						return;
D
Daniel Imms 已提交
763 764 765 766 767 768 769 770 771 772 773
					}
					// 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();
						}
					}
				}));
774 775
				const collection = extensionContext.environmentVariableCollection;
				disposables.push({ dispose: () => collection.clear() });
D
Daniel Imms 已提交
776 777 778 779 780 781 782 783 784
				collection.replace('A', '~a2~');
				collection.replace('B', '~b2~');
				collection.delete('A');
				const terminal = window.createTerminal({
					env: {
						A: '~a1~',
						B: '~b2~'
					}
				});
785 786 787 788 789 790
				// 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 已提交
791 792 793
			});

			test('get and forEach should work', () => {
794 795
				const collection = extensionContext.environmentVariableCollection;
				disposables.push({ dispose: () => collection.clear() });
D
Daniel Imms 已提交
796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813
				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 }]
				]);
			});
814
		});
815 816
	});
});