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

D
Daniel Imms 已提交
6
import { window, Pseudoterminal, EventEmitter, TerminalDimensions, workspace, ConfigurationTarget, Disposable, UIKind, env, EnvironmentVariableMutatorType, EnvironmentVariableMutator } 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
	suiteSetup(async () => {
14
		const config = workspace.getConfiguration('terminal.integrated');
15
		// Disable conpty in integration tests because of https://github.com/microsoft/vscode/issues/76548
16 17 18
		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);
19 20
	});
	suite('Terminal', () => {
21 22 23 24 25 26 27
		let disposables: Disposable[] = [];

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

28

29
		test('sendText immediately after createTerminal should not throw', (done) => {
30
			disposables.push(window.onDidOpenTerminal(term => {
D
Daniel Imms 已提交
31 32 33 34
				try {
					equal(terminal, term);
				} catch (e) {
					done(e);
D
Daniel Imms 已提交
35
					return;
D
Daniel Imms 已提交
36
				}
37
				terminal.dispose();
38 39
				disposables.push(window.onDidCloseTerminal(() => done()));
			}));
40 41 42 43
			const terminal = window.createTerminal();
			doesNotThrow(terminal.sendText.bind(terminal, 'echo "foo"'));
		});

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

87
		test('onDidCloseTerminal event fires when terminal is disposed', (done) => {
88
			disposables.push(window.onDidOpenTerminal(term => {
D
Daniel Imms 已提交
89 90 91 92
				try {
					equal(terminal, term);
				} catch (e) {
					done(e);
D
Daniel Imms 已提交
93
					return;
D
Daniel Imms 已提交
94
				}
95
				terminal.dispose();
96 97
				disposables.push(window.onDidCloseTerminal(() => done()));
			}));
98
			const terminal = window.createTerminal();
99 100 101
		});

		test('processId immediately after createTerminal should fetch the pid', (done) => {
102
			disposables.push(window.onDidOpenTerminal(term => {
D
Daniel Imms 已提交
103 104 105 106
				try {
					equal(terminal, term);
				} catch (e) {
					done(e);
D
Daniel Imms 已提交
107
					return;
D
Daniel Imms 已提交
108
				}
109
				terminal.processId.then(id => {
D
Daniel Imms 已提交
110
					try {
D
Daniel Imms 已提交
111
						ok(id && id > 0);
D
Daniel Imms 已提交
112 113
					} catch (e) {
						done(e);
D
Daniel Imms 已提交
114
						return;
D
Daniel Imms 已提交
115
					}
116
					terminal.dispose();
117
					disposables.push(window.onDidCloseTerminal(() => done()));
118
				});
119
			}));
120
			const terminal = window.createTerminal();
121 122
		});

123
		test('name in constructor should set terminal.name', (done) => {
124
			disposables.push(window.onDidOpenTerminal(term => {
D
Daniel Imms 已提交
125 126 127 128
				try {
					equal(terminal, term);
				} catch (e) {
					done(e);
D
Daniel Imms 已提交
129
					return;
D
Daniel Imms 已提交
130
				}
131
				terminal.dispose();
132 133
				disposables.push(window.onDidCloseTerminal(() => done()));
			}));
134
			const terminal = window.createTerminal('a');
D
Daniel Imms 已提交
135 136 137 138
			try {
				equal(terminal.name, 'a');
			} catch (e) {
				done(e);
D
Daniel Imms 已提交
139
				return;
D
Daniel Imms 已提交
140
			}
141 142
		});

143 144 145 146 147 148
		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 已提交
149
					return;
150 151 152 153 154 155 156 157 158 159 160 161 162 163 164
				}
				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 已提交
165
				return;
166 167 168
			}
		});

169
		test('onDidOpenTerminal should fire when a terminal is created', (done) => {
170
			disposables.push(window.onDidOpenTerminal(term => {
D
Daniel Imms 已提交
171 172 173 174
				try {
					equal(term.name, 'b');
				} catch (e) {
					done(e);
D
Daniel Imms 已提交
175
					return;
D
Daniel Imms 已提交
176
				}
177
				disposables.push(window.onDidCloseTerminal(() => done()));
178
				terminal.dispose();
179
			}));
180 181
			const terminal = window.createTerminal('b');
		});
182

D
Daniel Imms 已提交
183 184 185 186 187 188
		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 已提交
189
					return;
D
Daniel Imms 已提交
190 191 192 193 194 195 196 197 198 199 200 201 202 203 204
				}
				disposables.push(window.onDidCloseTerminal(t => {
					try {
						deepEqual(t.exitStatus, { code: undefined });
					} catch (e) {
						done(e);
						return;
					}
					done();
				}));
				terminal.dispose();
			}));
			const terminal = window.createTerminal();
		});

205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220
		// 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();
		// });
221

222 223 224 225 226 227 228 229 230 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
		// 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();
		// });
274

275 276 277
		suite('hideFromUser', () => {
			test('should be available to terminals API', done => {
				const terminal = window.createTerminal({ name: 'bg', hideFromUser: true });
278
				disposables.push(window.onDidOpenTerminal(t => {
D
Daniel Imms 已提交
279 280 281 282 283 284
					try {
						equal(t, terminal);
						equal(t.name, 'bg');
						ok(window.terminals.indexOf(terminal) !== -1);
					} catch (e) {
						done(e);
D
Daniel Imms 已提交
285
						return;
D
Daniel Imms 已提交
286
					}
287 288
					disposables.push(window.onDidCloseTerminal(() => {
						// reg3.dispose();
289
						done();
290
					}));
291
					terminal.dispose();
292
				}));
293 294
			});
		});
295

296 297 298 299 300
		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[] = [];
301
				disposables.push(window.onDidOpenTerminal(e => openEvents.push(e.name)));
302 303

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

306
				disposables.push(window.onDidWriteTerminalData(e => {
307 308 309
					dataEvents.push({ name: e.terminal.name, data: e.data });

					resolveOnceDataWritten!();
310
				}));
311

312
				disposables.push(window.onDidCloseTerminal(e => {
313
					closeEvents.push(e.name);
D
Daniel Imms 已提交
314 315 316 317 318 319 320 321 322 323
					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 已提交
324
						resolveOnceClosed!();
D
Daniel Imms 已提交
325 326
					} catch (e) {
						done(e);
327
					}
328
				}));
329 330 331

				const term1Write = new EventEmitter<string>();
				const term1Close = new EventEmitter<void>();
E
Eric Amodio 已提交
332 333 334 335 336 337 338 339 340 341 342 343 344 345
				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 已提交
346

E
Eric Amodio 已提交
347 348 349 350 351 352 353 354
							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 已提交
355

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

E
Eric Amodio 已提交
359
										term2Close.fire();
D
Daniel Imms 已提交
360

E
Eric Amodio 已提交
361 362 363 364 365 366 367 368 369 370 371 372
										// Wait until the terminal is closed
										await new Promise<void>(resolve => { resolveOnceClosed = resolve; });

										done();
									},
									close: () => { }
								}
							});
						},
						close: () => { }
					}
				});
373 374 375
			});
		});

D
Daniel Imms 已提交
376
		suite('Extension pty terminals', () => {
377
			test('should fire onDidOpenTerminal and onDidCloseTerminal', (done) => {
378
				disposables.push(window.onDidOpenTerminal(term => {
D
Daniel Imms 已提交
379 380 381 382
					try {
						equal(term.name, 'c');
					} catch (e) {
						done(e);
D
Daniel Imms 已提交
383
						return;
D
Daniel Imms 已提交
384
					}
385
					disposables.push(window.onDidCloseTerminal(() => done()));
386
					term.dispose();
387
				}));
388
				const pty: Pseudoterminal = {
D
Daniel Imms 已提交
389
					onDidWrite: new EventEmitter<string>().event,
390 391
					open: () => { },
					close: () => { }
392
				};
393
				window.createTerminal({ name: 'c', pty });
394 395
			});

396 397 398 399 400 401 402 403 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
			// 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 已提交
442

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

			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 已提交
587
						return;
588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607
					}
					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);
				}
			});
608
		});
609 610 611 612 613 614 615 616 617 618 619 620 621 622

		suite('getEnvironmentVariableCollection', () => {
			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 已提交
623
						return;
624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646
					}
					// Multiple expected could show up in the same data event
					while (expectedText.length > 0 && e.data.indexOf(expectedText[0]) >= 0) {
						expectedText.shift();
						// Check if all string are found, if so finish the test
						if (expectedText.length === 0) {
							disposables.push(window.onDidCloseTerminal(() => done()));
							terminal.dispose();
						}
					}
				}));
				const collection = window.getEnvironmentVariableCollection();
				disposables.push(collection);
				collection.replace('A', '~a2~');
				collection.append('B', '~b2~');
				collection.prepend('C', '~c2~');
				const terminal = window.createTerminal({
					env: {
						A: 'a1',
						B: 'b1',
						C: 'c1'
					}
				});
647 648 649 650 651 652 653 654
				// 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');
655 656 657 658 659 660 661 662 663 664 665 666 667 668
			});

			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 已提交
669
						return;
670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692
					}
					// Multiple expected could show up in the same data event
					while (expectedText.length > 0 && e.data.indexOf(expectedText[0]) >= 0) {
						expectedText.shift();
						// Check if all string are found, if so finish the test
						if (expectedText.length === 0) {
							disposables.push(window.onDidCloseTerminal(() => done()));
							terminal.dispose();
						}
					}
				}));
				const collection = window.getEnvironmentVariableCollection();
				disposables.push(collection);
				collection.replace('A', '~a2~');
				collection.append('B', '~b2~');
				collection.prepend('C', '~c2~');
				const terminal = window.createTerminal({
					env: {
						A: null,
						B: null,
						C: null
					}
				});
693 694 695 696 697 698 699 700
				// 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');
701
			});
D
Daniel Imms 已提交
702 703 704 705 706 707 708 709 710 711 712 713

			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 已提交
714
						return;
D
Daniel Imms 已提交
715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736
					}
					// Multiple expected could show up in the same data event
					while (expectedText.length > 0 && e.data.indexOf(expectedText[0]) >= 0) {
						expectedText.shift();
						// Check if all string are found, if so finish the test
						if (expectedText.length === 0) {
							disposables.push(window.onDidCloseTerminal(() => done()));
							terminal.dispose();
						}
					}
				}));
				const collection = window.getEnvironmentVariableCollection();
				disposables.push(collection);
				collection.replace('A', '~a2~');
				collection.replace('B', '~a2~');
				collection.clear();
				const terminal = window.createTerminal({
					env: {
						A: '~a1~',
						B: '~b1~'
					}
				});
737 738 739 740 741 742
				// 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 已提交
743 744 745 746 747 748 749 750 751 752 753 754 755
			});

			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 已提交
756
						return;
D
Daniel Imms 已提交
757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778
					}
					// Multiple expected could show up in the same data event
					while (expectedText.length > 0 && e.data.indexOf(expectedText[0]) >= 0) {
						expectedText.shift();
						// Check if all string are found, if so finish the test
						if (expectedText.length === 0) {
							disposables.push(window.onDidCloseTerminal(() => done()));
							terminal.dispose();
						}
					}
				}));
				const collection = window.getEnvironmentVariableCollection();
				disposables.push(collection);
				collection.replace('A', '~a2~');
				collection.replace('B', '~b2~');
				collection.delete('A');
				const terminal = window.createTerminal({
					env: {
						A: '~a1~',
						B: '~b2~'
					}
				});
779 780 781 782 783 784
				// 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 已提交
785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807
			});

			test('get and forEach should work', () => {
				const collection = window.getEnvironmentVariableCollection();
				disposables.push(collection);
				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 }]
				]);
			});
808
		});
809 810
	});
});