add: Playwright sample tests

put electron launch code in a setup file

Author: sergiolms

tests/playwright/setup.ts

@@ -1,4 +1,4 @@
-import { downloadAndUnzipVSCode } from '@vscode/test-electron/out/download';
+import { downloadAndUnzipVSCode } from '@vscode/test-electron';
 
 export default async () => {
 	await downloadAndUnzipVSCode('insiders');

tests/playwright/specs/baseTest.ts

@@ -0,0 +1,91 @@
+import { test as base, type Page, _electron } from '@playwright/test';
+import { downloadAndUnzipVSCode } from '@vscode/test-electron/out/download';
+export { expect } from '@playwright/test';
+import path from 'path';
+import os from 'os';
+import fs from 'fs';
+import { spawnSync } from 'child_process';
+
+export type TestOptions = {
+	vscodeVersion: string;
+};
+
+type TestFixtures = TestOptions & {
+	page: Page;
+	createTestProject: () => Promise<string>;
+	createTmpDir: () => Promise<string>;
+};
+
+let testProjectPath: string;
+export const test = base.extend<TestFixtures>({
+	vscodeVersion: ['insiders', { option: true }],
+	page: async ({ vscodeVersion, createTestProject, createTmpDir }, use) => {
+		const defaultCachePath = await createTmpDir();
+		const vscodePath = await downloadAndUnzipVSCode(vscodeVersion);
+		testProjectPath = await createTestProject();
+
+		const electronApp = await _electron.launch({
+			executablePath: vscodePath,
+			// Got it from https://github.com/microsoft/vscode-test/blob/0ec222ef170e102244569064a12898fb203e5bb7/lib/runTest.ts#L126-L160
+			args: [
+				'--no-sandbox', // https://github.com/microsoft/vscode/issues/84238
+				'--disable-gpu-sandbox', // https://github.com/microsoft/vscode-test/issues/221
+				'--disable-updates', // https://github.com/microsoft/vscode-test/issues/120
+				'--skip-welcome',
+				'--skip-release-notes',
+				'--disable-workspace-trust',
+				`--extensionDevelopmentPath=${path.join(__dirname, '../../../')}`,
+				`--extensions-dir=${path.join(defaultCachePath, 'extensions')}`,
+				`--user-data-dir=${path.join(defaultCachePath, 'user-data')}`,
+				testProjectPath,
+			],
+		});
+
+		const page = await electronApp.firstWindow();
+		await page.context().tracing.start({
+			screenshots: true,
+			snapshots: true,
+			title: test.info().title,
+		});
+
+		await use(page);
+
+		const tracePath = test.info().outputPath('trace.zip');
+		await page.context().tracing.stop({ path: tracePath });
+		test.info().attachments.push({ name: 'trace', path: tracePath, contentType: 'application/zip' });
+		await electronApp.close();
+
+		const logPath = path.join(defaultCachePath, 'user-data');
+		if (fs.existsSync(logPath)) {
+			const logOutputPath = test.info().outputPath('vscode-logs');
+			await fs.promises.cp(logPath, logOutputPath, { recursive: true });
+		}
+	},
+	createTestProject: async ({ createTmpDir }, use) => {
+		await use(async () => {
+			// We want to be outside of the project directory to avoid already installed dependencies.
+			const projectPath = await createTmpDir();
+			if (fs.existsSync(projectPath)) await fs.promises.rm(projectPath, { recursive: true });
+			console.log(`Creating project in ${projectPath}`);
+			await fs.promises.mkdir(projectPath);
+			spawnSync(`yarn init playwright@latest --yes -- --quiet --browser=chromium --gha --install-deps`, {
+				cwd: projectPath,
+				stdio: 'inherit',
+				shell: true,
+			});
+			spawnSync(`git init .`, {
+				cwd: projectPath,
+			});
+			return projectPath;
+		});
+	},
+	createTmpDir: async ({}, use) => {
+		const tempDirs: string[] = [];
+		await use(async () => {
+			const tempDir = await fs.promises.realpath(await fs.promises.mkdtemp(path.join(os.tmpdir(), 'gltest-')));
+			tempDirs.push(tempDir);
+			return tempDir;
+		});
+		for (const tempDir of tempDirs) await fs.promises.rm(tempDir, { recursive: true });
+	},
+});

tests/playwright/specs/basic.test.ts

@@ -0,0 +1,16 @@
+import { test, expect } from './baseTest';
+
+test.describe('Test GitLens installation', () => {
+	test('should display GitLens Welcome page after installation', async ({ page }) => {
+		const title = await page.textContent('.tab a');
+		expect(title).toBe('Welcome to GitLens');
+	});
+
+	test('should contain GitLens & GitLens Inspect icons in activity bar', async ({ page }) => {
+		await page.getByRole('tab', { name: 'GitLens Inspect' }).waitFor();
+		const gitlensIcons = await page.getByRole('tab', { name: 'GitLens' });
+		expect(gitlensIcons).toHaveCount(2);
+
+		expect(await page.title()).toContain('[Extension Development Host] gltest-');
+	});
+});

tests/playwright/specs/basic2.test.ts

@@ -6095,6 +6095,15 @@ [email protected], playwright@^1.45.0:
   optionalDependencies:
     fsevents "2.3.2"
 
+playwright@^1.45.1:
+  version "1.45.1"
+  resolved "https://registry.npmjs.org/playwright/-/playwright-1.45.1.tgz#aaa6b0d6db14796b599d80c6679e63444e942534"
+  integrity sha512-Hjrgae4kpSQBr98nhCj3IScxVeVUixqj+5oyif8TdIn2opTCPEzqAqNMeK42i3cWDCVu9MI+ZsGWw+gVR4ISBg==
+  dependencies:
+    playwright-core "1.45.1"
+  optionalDependencies:
+    fsevents "2.3.2"
+
 plimit-lit@^1.2.6:
   version "1.6.1"
   resolved "https://registry.yarnpkg.com/plimit-lit/-/plimit-lit-1.6.1.tgz#a34594671b31ee8e93c72d505dfb6852eb72374a"