e2e-test: add visual-mode test

src/vs/workbench/services/dialogs/common/dialogService.ts

@@ -52,9 +52,9 @@ export class DialogService extends Disposable implements IDialogService {
 	prompt<T>(prompt: IPromptWithDefaultCancel<T>): Promise<IPromptResult<T>>;
 	prompt<T>(prompt: IPrompt<T>): Promise<IPromptResult<T>>;
 	async prompt<T>(prompt: IPrompt<T> | IPromptWithCustomCancel<T> | IPromptWithDefaultCancel<T>): Promise<IPromptResult<T> | IPromptResultWithCancel<T>> {
-		if (this.skipDialogs()) {
-			throw new Error(`DialogService: refused to show dialog in tests. Contents: ${prompt.message}`);
-		}
+		// if (this.skipDialogs()) {
+		// 	throw new Error(`DialogService: refused to show dialog in tests. Contents: ${prompt.message}`);
+		// }
 
 		const handle = this.model.show({ promptArgs: { prompt } });
 

test/e2e/infra/fixtures/keyboard.ts

@@ -0,0 +1,48 @@
+import test, { Page } from '@playwright/test';
+
+export enum Hotkeys {
+	COPY = 'Cmd+C',
+	PASTE = 'Cmd+V',
+	CUT = 'Cmd+X',
+	SELECT_ALL = 'Cmd+A',
+	SAVE = 'Cmd+S',
+	UNDO = 'Cmd+Z',
+	OPEN_FILE = 'Cmd+O',
+	FIND = 'Cmd+F',
+	CLOSE_TAB = 'Cmd+W',
+	FIRST_TAB = 'Cmd+1',
+	SWITCH_TAB_LEFT = 'Cmd+Shift+[',
+	SWITCH_TAB_RIGHT = 'Cmd+Shift+]',
+	CLOSE_ALL_EDITORS = 'Cmd+K Cmd+W', // space indicates a sequence of keys
+	VISUAL_MODE = 'Cmd+Shift+F4',
+}
+
+export class Keyboard {
+	constructor(private page: Page) { }
+
+	private getModifierKey(): string {
+		return process.platform === 'darwin' ? 'Meta' : 'Control';
+	}
+
+	async hotKeys(action: Hotkeys) {
+		await test.step(`Press hotkeys: ${action}`, async () => {
+			const modifierKey = this.getModifierKey();
+
+			// Split command if there are multiple sequential key presses
+			const keySequences = action.split(' ').map(keys => keys.replace(/Cmd/g, modifierKey));
+
+			for (const key of keySequences) {
+				await this.page.keyboard.press(key);
+			}
+		})
+	}
+
+	async press(keys: string) {
+		await this.page.keyboard.press(keys);
+	}
+
+	async type(text: string) {
+		await this.page.keyboard.type(text);
+	}
+}
+

test/e2e/infra/index.ts

@@ -43,6 +43,7 @@ export * from '../pages/scm';
 // fixtures
 export * from './fixtures/userSettings';
 export * from './fixtures/interpreter';
+export * from './fixtures/keyboard';
 
 // test-runner
 export * from './test-runner';

test/e2e/infra/test-runner/test-tags.ts

@@ -40,14 +40,15 @@ export enum TestTags {
 	OUTPUT = '@:output',
 	PLOTS = '@:plots',
 	PROBLEMS = '@:problems',
-	REFERENCES = '@:references',
 	R_MARKDOWN = '@:r-markdown',
 	R_PKG_DEVELOPMENT = '@:r-pkg-development',
+	REFERENCES = '@:references',
 	RETICULATE = '@:reticulate',
 	SCM = '@:scm',
 	TEST_EXPLORER = '@:test-explorer',
 	TOP_ACTION_BAR = '@:top-action-bar',
 	VARIABLES = '@:variables',
+	VISUAL_MODE = '@:visual-mode',
 	WELCOME = '@:welcome',
 
 	// platform  tags

test/e2e/infra/workbench.ts

@@ -5,6 +5,7 @@
 
 import { Code } from './code';
 import { Interpreter } from '../infra/fixtures/interpreter';
+import { Keyboard } from '../infra/fixtures/keyboard';
 import { Popups } from '../pages/popups';
 import { Console } from '../pages/console';
 import { Variables } from '../pages/variables';
@@ -75,6 +76,7 @@ export class Workbench {
 	readonly problems: Problems;
 	readonly references: References;
 	readonly scm: SCM;
+	readonly keyboard: Keyboard;
 
 	constructor(code: Code) {
 
@@ -111,6 +113,7 @@ export class Workbench {
 		this.problems = new Problems(code, this.quickaccess);
 		this.references = new References(code);
 		this.scm = new SCM(code, this.layouts);
+		this.keyboard = new Keyboard(code.driver.page);
 	}
 }
 

test/e2e/pages/editorActionBar.ts

@@ -134,7 +134,6 @@ export class EditorActionBar {
 	 */
 	async verifyPreviewRendersHtml(heading: string) {
 		await test.step('Verify "preview" renders html', async () => {
-			await this.page.getByLabel('Preview', { exact: true }).click();
 			const viewerFrame = this.viewer.getViewerFrame().frameLocator('iframe');
 			await expect(viewerFrame.getByRole('heading', { name: heading })).toBeVisible({ timeout: 30000 });
 		});

test/e2e/pages/quickaccess.ts

@@ -91,28 +91,28 @@ export class QuickAccess {
 		this.code.logger.log('QuickAccess: File search succeeded.');
 	}
 
-	async openFile(path: string): Promise<void> {
-		await test.step('Open file', async () => {
-			if (!isAbsolute(path)) {
-				// we require absolute paths to get a single
-				// result back that is unique and avoid hitting
-				// the search process to reduce chances of
-				// search needing longer.
-				throw new Error('QuickAccess.openFile requires an absolute path');
-			}
+	async openFile(path: string, waitForFocus = true): Promise<void> {
+		if (!isAbsolute(path)) {
+			// we require absolute paths to get a single
+			// result back that is unique and avoid hitting
+			// the search process to reduce chances of
+			// search needing longer.
+			throw new Error('QuickAccess.openFile requires an absolute path');
+		}
 
-			const fileName = basename(path);
+		const fileName = basename(path);
 
-			// quick access shows files with the basename of the path
-			await this.openFileQuickAccessAndWait(path, basename(path));
+		// quick access shows files with the basename of the path
+		await this.openFileQuickAccessAndWait(path, basename(path));
 
-			// open first element
-			await this.quickInput.selectQuickInputElement(0);
+		// open first element
+		await this.quickInput.selectQuickInputElement(0);
 
-			// wait for editor being focused
+		// wait for editor being focused
+		if (waitForFocus) {
 			await this.editors.waitForActiveTab(fileName);
 			await this.editors.selectTab(fileName);
-		});
+		}
 	}
 
 	private async openQuickAccessWithRetry(kind: QuickAccessKind, value?: string): Promise<void> {

test/e2e/tests/_test.setup.ts

@@ -21,8 +21,9 @@ import { randomUUID } from 'crypto';
 import archiver from 'archiver';
 
 // Local imports
-import { Application, Logger, UserSetting, UserSettingsFixtures, createLogger, createApp, TestTags } from '../infra';
+import { Application, Logger, UserSetting, UserSettingsFixtures, createLogger, createApp, TestTags, } from '../infra';
 import { PackageManager } from '../pages/utils/packageManager';
+import { Keyboard } from '../infra/fixtures/keyboard';
 
 // Constants
 const TEMP_DIR = `temp-${randomUUID()}`;
@@ -151,9 +152,9 @@ export const test = base.extend<TestFixtures, WorkerFixtures>({
 
 	// ex: await openFile('workspaces/basic-rmd-file/basicRmd.rmd');
 	openFile: async ({ app }, use) => {
-		await use(async (filePath: string) => {
+		await use(async (filePath: string, waitForFocus = true) => {
 			await test.step(`Open file: ${path.basename(filePath)}`, async () => {
-				await app.workbench.quickaccess.openFile(path.join(app.workspacePathOrFolder, filePath));
+				await app.workbench.quickaccess.openFile(path.join(app.workspacePathOrFolder, filePath), waitForFocus);
 			});
 		});
 	},
@@ -181,6 +182,13 @@ export const test = base.extend<TestFixtures, WorkerFixtures>({
 		});
 	},
 
+	// ex: await keyboard.hotKeys(HotKeys.COPY);
+	// ex: await keyboard.press('Enter');
+	keyboard: async ({ page }, use) => {
+		const keyboard = new Keyboard(page);
+		await use(keyboard);
+	},
+
 	// ex: await userSettings.set([['editor.actionBar.enabled', 'true']], false);
 	userSettings: [async ({ app }, use) => {
 		const userSettings = new UserSettingsFixtures(app);
@@ -318,7 +326,7 @@ export const test = base.extend<TestFixtures, WorkerFixtures>({
 // Runs once per worker. If a worker handles multiple specs, these hooks only run for the first spec.
 // However, we are using `suiteId` to ensure each suite gets a new worker (and a fresh app
 // instance). This also ensures these before/afterAll hooks will run for EACH spec
-test.beforeAll(async ({ logger }, testInfo) => {
+test.beforeAll('Mark test start in logger', async ({ logger }, testInfo) => {
 	// since the worker doesn't know or have access to the spec name when it starts,
 	// we store the spec name in a global variable. this ensures logs are written
 	// to the correct folder even when the app is scoped to "worker".
@@ -331,7 +339,7 @@ test.beforeAll(async ({ logger }, testInfo) => {
 	logger.log('');
 });
 
-test.afterAll(async function ({ logger }, testInfo) {
+test.afterAll('Mark test end in logger', async function ({ logger }, testInfo) {
 	try {
 		logger.log('');
 		logger.log(`>>> Suite end: '${testInfo.titlePath[0] ?? 'unknown'}' <<<`);
@@ -384,10 +392,11 @@ interface TestFixtures {
 	packages: PackageManager;
 	autoTestFixture: any;
 	devTools: void;
-	openFile: (filePath: string) => Promise<void>;
+	openFile: (filePath: string, waitForFocus?: boolean) => Promise<void>;
 	openDataFile: (filePath: string) => Promise<void>;
 	runCommand: (command: string) => Promise<void>;
 	executeCode: (language: 'Python' | 'R', code: string) => Promise<void>;
+	keyboard: Keyboard;
 }
 
 interface WorkerFixtures {

test/e2e/tests/editor-action-bar/document-files.test.ts

@@ -6,7 +6,7 @@
 import { expect, Page } from '@playwright/test';
 import { test, tags } from '../_test.setup';
 import { EditorActionBar } from '../../pages/editorActionBar';
-import { Application } from '../../infra';
+import { Application, Hotkeys, Keyboard } from '../../infra';
 
 let editorActionBar: EditorActionBar;
 
@@ -93,15 +93,13 @@ async function verifyOpenViewerRendersHtml(app: Application, title: string) {
 }
 
 async function verifyOpenChanges(page: Page) {
+	const keyboard = new Keyboard(page);
 	await test.step('verify "open changes" shows diff', async () => {
-		async function bindPlatformHotkey(page: Page, key: string) {
-			await page.keyboard.press(process.platform === 'darwin' ? `Meta+${key}` : `Control+${key}`);
-		}
 
 		// make change & save
 		await page.getByText('date', { exact: true }).click();
 		await page.keyboard.press('X');
-		await bindPlatformHotkey(page, 'S');
+		await keyboard.hotKeys(Hotkeys.SAVE);
 
 		// click open changes & verify
 		await editorActionBar.clickButton('Open Changes');
@@ -110,8 +108,8 @@ async function verifyOpenChanges(page: Page) {
 		await page.getByRole('tab', { name: 'quarto_basic.qmd (Working' }).getByLabel('Close').click();
 
 		// undo changes & save
-		await bindPlatformHotkey(page, 'Z');
-		await bindPlatformHotkey(page, 'S');
+		await keyboard.hotKeys(Hotkeys.UNDO);
+		await keyboard.hotKeys(Hotkeys.SAVE);
 	});
 }
 

test/e2e/tests/problems/problems.test.ts

@@ -4,7 +4,7 @@
  *--------------------------------------------------------------------------------------------*/
 
 import { expect } from '@playwright/test';
-import { Problems, ProblemSeverity } from '../../infra';
+import { Hotkeys, Problems, ProblemSeverity } from '../../infra';
 import { test, tags } from '../_test.setup';
 import { join } from 'path';
 
@@ -16,7 +16,7 @@ test.describe('Problems', {
 	tag: [tags.PROBLEMS, tags.WEB, tags.WIN]
 }, () => {
 
-	test('Python - Verify Problems Functionality', async function ({ app, python, openFile }) {
+	test('Python - Verify Problems Functionality', async function ({ app, python, openFile, keyboard }) {
 
 		await test.step('Open file and replace "rows" on line 9 with exclamation point', async () => {
 			await openFile(join('workspaces', 'chinook-db-py', 'chinook-sqlite.py'));
@@ -43,10 +43,7 @@ test.describe('Problems', {
 			}).toPass({ timeout: 20000 });
 		});
 
-		await test.step('Revert error', async () => {
-			await app.code.driver.page.keyboard.press(process.platform === 'darwin' ? 'Meta+Z' : 'Control+Z');
-
-		});
+		await keyboard.hotKeys(Hotkeys.UNDO);
 
 		await test.step('Verify File Squiggly Is Gone', async () => {
 			const fileSquiggly = Problems.getSelectorInEditor(ProblemSeverity.ERROR);
@@ -64,7 +61,7 @@ test.describe('Problems', {
 
 	});
 
-	test('R - Verify Problems Functionality', async function ({ app, r, openFile }) {
+	test('R - Verify Problems Functionality', async function ({ app, r, openFile, keyboard }) {
 
 		await test.step('Open file and replace "albums" on line 5 with exclamation point', async () => {
 			await openFile(join('workspaces', 'chinook-db-r', 'chinook-sqlite.r'));
@@ -89,10 +86,7 @@ test.describe('Problems', {
 			expect(errorLocators.length).toBe(1);
 		});
 
-		await test.step('Revert error', async () => {
-			await app.code.driver.page.keyboard.press(process.platform === 'darwin' ? 'Meta+Z' : 'Control+Z');
-
-		});
+		await keyboard.hotKeys(Hotkeys.UNDO);
 
 		await test.step('Verify File Squiggly Is Gone', async () => {
 			const fileSquiggly = Problems.getSelectorInEditor(ProblemSeverity.ERROR);

test/e2e/tests/scm/scm.test.ts

@@ -3,6 +3,7 @@
  *  Licensed under the Elastic License 2.0. See LICENSE.txt for license information.
  *--------------------------------------------------------------------------------------------*/
 
+import { Hotkeys } from '../../infra';
 import { test, tags } from '../_test.setup';
 import { join } from 'path';
 
@@ -14,7 +15,7 @@ test.describe('Source Content Management', {
 	tag: [tags.SCM, tags.WEB, tags.WIN]
 }, () => {
 
-	test('Verify SCM Tracks File Modifications, Staging, and Commit Actions', async function ({ app, openFile }) {
+	test('Verify SCM Tracks File Modifications, Staging, and Commit Actions', async function ({ app, openFile, keyboard }) {
 
 		const file = 'chinook-sqlite.py';
 		await test.step('Open file and add a new line to it', async () => {
@@ -28,7 +29,7 @@ test.describe('Source Content Management', {
 
 			await app.code.driver.page.keyboard.type('print(df)');
 
-			await app.code.driver.page.keyboard.press(process.platform === 'darwin' ? 'Meta+S' : 'Control+S');
+			await keyboard.hotKeys(Hotkeys.SAVE);
 
 		});