development/vscode
development/vscode
1
0
Fork 0
mirror of https://github.com/Microsoft/vscode synced 2024-10-01 08:50:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

Use a polling approach for writing and asserting

Browse source
This commit is contained in:
Daniel Imms 2023-11-08 09:20:44 -08:00
parent dbb50b80cd
commit 35ae6b1925
No known key found for this signature in database
GPG key ID: E5CF412B63651C69
2 changed files with 41 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
test/automation/src/code.ts
View file

@ -195,6 +195,14 @@ export class Code {
}), 'Code#exit()', this.logger);
}
async getElement(selector: string): Promise<IElement | undefined> {
return (await this.driver.getElements(selector))?.[0];
}
async getElements(selector: string, recursive: boolean): Promise<IElement[] | undefined> {
return this.driver.getElements(selector, recursive);
}
async waitForTextContent(selector: string, textContent?: string, accept?: (result: string) => boolean, retryCount?: number): Promise<string> {
accept = accept || (result => textContent !== undefined ? textContent === result : !!result);

48
test/smoke/src/areas/terminal/terminal-stickyScroll.test.ts
View file

@ -4,6 +4,7 @@
*--------------------------------------------------------------------------------------------*/
import { Application, Terminal, SettingsEditor, TerminalCommandIdWithValue } from '../../../../automation';
import { timeout } from '../../utils';
import { setTerminalTestSettings } from './terminal-helpers';
export function setup() {
@ -29,24 +30,41 @@ export function setup() {
// Create the simplest system profile to get as little process interaction as possible
await terminal.createEmptyTerminal();
function generateCommandAndOutput(command: string, exitCode: number): string {
return [
`${vsc('A')}Prompt> ${vsc('B')}${command}`,
`\\r\\n${vsc('C')}`,
`\\r\\ndata`.repeat(50),
`\\r\\n${vsc(`D;${exitCode}`)}`,
].join('');
}
// A polling approach is used to avoid test flakiness. While it's not ideal that this
// occurs, the main purpose of the tests is to verify sticky scroll shows and updates,
// not edge case race conditions on terminal start up
async function pollForCommandAndOutput(command: string, exitCode: number): Promise<void> {
const data = generateCommandAndOutput(command, exitCode);
for (let i = 0; i < 10; i++) {
await terminal.runCommandWithValue(TerminalCommandIdWithValue.WriteDataToTerminal, data);
const element = await app.code.getElement('.terminal-sticky-scroll .xterm-rows');
if (element && element.textContent.indexOf(`Prompt> ${command}`) >= 0) {
break;
}
if (i === 10) {
throw new Error(`Polling failed for command ${command}, exitcode ${exitCode}, text content ${element?.textContent}`);
}
await timeout(1000);
}
}
// Write prompt, fill viewport, finish command, print new prompt, verify sticky scroll
await terminal.runCommandWithValue(TerminalCommandIdWithValue.WriteDataToTerminal, [
`${vsc('A')}Prompt> ${vsc('B')}sticky scroll 1`,
`\\r\\n${vsc('C')}`,
`\\r\\ndata`.repeat(50),
`\\r\\n${vsc('D;0')}`, // Success
`${vsc('A')}Prompt> ${vsc('B')}sticky scroll 2`
].join(''));
await app.code.waitForElements('.terminal-sticky-scroll', false, elements => elements.some(e => e.textContent.indexOf('Prompt> sticky scroll 1') >= 0));
await pollForCommandAndOutput('sticky scroll 1', 0);
// And again with a failed command
await terminal.runCommandWithValue(TerminalCommandIdWithValue.WriteDataToTerminal, [
`\\r\\n${vsc('C')}`,
`\\r\\ndata`.repeat(50),
`\\r\\n${vsc('D;1')}`, // Fail
`${vsc('A')}Prompt> ${vsc('B')}`,
].join(''));
await app.code.waitForElements('.terminal-sticky-scroll', false, elements => elements.some(e => e.textContent.indexOf('Prompt> sticky scroll 2') >= 0));
await pollForCommandAndOutput('sticky scroll 2', 1);
// And again with a failed command
await pollForCommandAndOutput('sticky scroll 3', 0);
});
});
}