Filip/playwright
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

test: make installation tests pass

Browse source
This commit is contained in:
Max Schmitt 2024-12-19 18:55:37 +01:00
parent c626270c6a
commit 1c6a9a12bf
7 changed files with 32 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
packages/playwright-core/src/cli/program.ts
View file

@ -103,8 +103,6 @@ function checkBrowsersToInstall(args: string[], options: { noShell?: boolean, on
executables.push(executable); executables.push(executable);
if (executable?.browserName === 'chromium') if (executable?.browserName === 'chromium')
executables.push(registry.findExecutable('ffmpeg')!); executables.push(registry.findExecutable('ffmpeg')!);
if (process.platform === 'win32')
executables.push(registry.findExecutable('winldd')!);
}; };
for (const arg of args) { for (const arg of args) {
@ -118,6 +116,9 @@ function checkBrowsersToInstall(args: string[], options: { noShell?: boolean, on
} }
} }
if (process.platform === 'win32')
executables.push(registry.findExecutable('winldd')!);
if (faultyArguments.length) if (faultyArguments.length)
throw new Error(`Invalid installation targets: ${faultyArguments.map(name => `'${name}'`).join(', ')}. Expecting one of: ${suggestedBrowsersToInstall()}`); throw new Error(`Invalid installation targets: ${faultyArguments.map(name => `'${name}'`).join(', ')}. Expecting one of: ${suggestedBrowsersToInstall()}`);
return executables; return executables;

2
packages/playwright-core/src/server/registry/index.ts
View file

@ -1315,6 +1315,8 @@ export async function installBrowsersForNpmInstall(browsers: string[]) {
return false; return false;
} }
const executables: Executable[] = []; const executables: Executable[] = [];
if (process.platform === 'win32')
executables.push(registry.findExecutable('winldd')!);
for (const browserName of browsers) { for (const browserName of browsers) {
const executable = registry.findExecutable(browserName); const executable = registry.findExecutable(browserName);
if (!executable || executable.installType === 'none') if (!executable || executable.installType === 'none')

8
tests/installation/npmTest.ts
View file

@ -31,22 +31,22 @@ export const TMP_WORKSPACES = path.join(os.platform() === 'darwin' ? '/tmp' : os
const debug = debugLogger('itest'); const debug = debugLogger('itest');
const expect = _expect.extend({ const expect = _expect.extend({
toHaveLoggedSoftwareDownload(received: any, browsers: ('chromium' | 'chromium-headless-shell' | 'firefox' | 'webkit' | 'ffmpeg')[]) { toHaveLoggedSoftwareDownload(received: string, browsers: ('chromium' | 'chromium-headless-shell' | 'firefox' | 'webkit' | 'winldd' |'ffmpeg')[]) {
if (typeof received !== 'string') if (typeof received !== 'string')
throw new Error(`Expected argument to be a string.`); throw new Error(`Expected argument to be a string.`);
const downloaded = new Set(); const downloaded = new Set();
let index = 0; let index = 0;
while (true) { while (true) {
const match = received.substring(index).match(/(chromium|chromium headless shell|firefox|webkit|ffmpeg)[\s\d\.]+\(?playwright build v\d+\)? downloaded/im); const match = received.substring(index).match(/(chromium|chromium headless shell|firefox|webkit|winldd|ffmpeg)[\s\d\.]+\(?playwright build v\d+\)? downloaded/im);
if (!match) if (!match)
break; break;
downloaded.add(match[1].replace(/\s/g, '-').toLowerCase()); downloaded.add(match[1].replace(/\s/g, '-').toLowerCase());
index += match.index + 1; index += match.index + 1;
} }
const expected = browsers; const expected = new Set(browsers);
if (expected.length === downloaded.size && expected.every(browser => downloaded.has(browser))) { if (expected.size === downloaded.size && [...expected].every(browser => downloaded.has(browser))) {
return { return {
pass: true, pass: true,
message: () => 'Expected not to download browsers, but did.' message: () => 'Expected not to download browsers, but did.'

6
tests/installation/playwright-cdn.spec.ts
View file

@ -37,12 +37,14 @@ const parsedDownloads = (rawLogs: string) => {
test.use({ isolateBrowsers: true }); test.use({ isolateBrowsers: true });
const extraInstalledSoftware = process.platform === 'win32' ? ['winldd' as const] : [];
for (const cdn of CDNS) { for (const cdn of CDNS) {
test(`playwright cdn failover should work (${cdn})`, async ({ exec, checkInstalledSoftwareOnDisk }) => { test(`playwright cdn failover should work (${cdn})`, async ({ exec, checkInstalledSoftwareOnDisk }) => {
await exec('npm i playwright'); await exec('npm i playwright');
const result = await exec('npx playwright install', { env: { PW_TEST_CDN_THAT_SHOULD_WORK: cdn, DEBUG: 'pw:install' } }); const result = await exec('npx playwright install', { env: { PW_TEST_CDN_THAT_SHOULD_WORK: cdn, DEBUG: 'pw:install' } });
expect(result).toHaveLoggedSoftwareDownload(['chromium', 'chromium-headless-shell', 'ffmpeg', 'firefox', 'webkit']); expect(result).toHaveLoggedSoftwareDownload(['chromium', 'chromium-headless-shell', 'ffmpeg', 'firefox', 'webkit', ...extraInstalledSoftware]);
await checkInstalledSoftwareOnDisk(['chromium', 'chromium-headless-shell', 'ffmpeg', 'firefox', 'webkit']); await checkInstalledSoftwareOnDisk((['chromium', 'chromium-headless-shell', 'ffmpeg', 'firefox', 'webkit', ...extraInstalledSoftware]));
const dls = parsedDownloads(result); const dls = parsedDownloads(result);
for (const software of ['chromium', 'ffmpeg', 'firefox', 'webkit']) for (const software of ['chromium', 'ffmpeg', 'firefox', 'webkit'])
expect(dls).toContainEqual({ status: 200, name: software, url: expect.stringContaining(cdn) }); expect(dls).toContainEqual({ status: 200, name: software, url: expect.stringContaining(cdn) });

12
tests/installation/playwright-cli-install-should-work.spec.ts
View file

@ -19,19 +19,21 @@ import path from 'path';
test.use({ isolateBrowsers: true }); test.use({ isolateBrowsers: true });
const extraInstalledSoftware = process.platform === 'win32' ? ['winldd' as const] : [];
test('install command should work', async ({ exec, checkInstalledSoftwareOnDisk }) => { test('install command should work', async ({ exec, checkInstalledSoftwareOnDisk }) => {
await exec('npm i playwright'); await exec('npm i playwright');
await test.step('playwright install chromium', async () => { await test.step('playwright install chromium', async () => {
const result = await exec('npx playwright install chromium'); const result = await exec('npx playwright install chromium');
expect(result).toHaveLoggedSoftwareDownload(['chromium', 'chromium-headless-shell', 'ffmpeg']); expect(result).toHaveLoggedSoftwareDownload(['chromium', 'chromium-headless-shell', 'ffmpeg', ...extraInstalledSoftware]);
await checkInstalledSoftwareOnDisk(['chromium', 'chromium-headless-shell', 'ffmpeg']); await checkInstalledSoftwareOnDisk(['chromium', 'chromium-headless-shell', 'ffmpeg', ...extraInstalledSoftware]);
}); });
await test.step('playwright install', async () => { await test.step('playwright install', async () => {
const result = await exec('npx playwright install'); const result = await exec('npx playwright install');
expect(result).toHaveLoggedSoftwareDownload(['firefox', 'webkit']); expect(result).toHaveLoggedSoftwareDownload(['firefox', 'webkit']);
await checkInstalledSoftwareOnDisk(['chromium', 'chromium-headless-shell', 'ffmpeg', 'firefox', 'webkit']); await checkInstalledSoftwareOnDisk(['chromium', 'chromium-headless-shell', 'ffmpeg', 'firefox', 'webkit', ...extraInstalledSoftware]);
}); });
await exec('node sanity.js playwright', { env: { PLAYWRIGHT_BROWSERS_PATH: '0' } }); await exec('node sanity.js playwright', { env: { PLAYWRIGHT_BROWSERS_PATH: '0' } });
@ -51,9 +53,9 @@ test('install command should work', async ({ exec, checkInstalledSoftwareOnDisk
test('should be able to remove browsers', async ({ exec, checkInstalledSoftwareOnDisk }) => { test('should be able to remove browsers', async ({ exec, checkInstalledSoftwareOnDisk }) => {
await exec('npm i playwright'); await exec('npm i playwright');
await exec('npx playwright install chromium'); await exec('npx playwright install chromium');
await checkInstalledSoftwareOnDisk(['chromium', 'chromium-headless-shell', 'ffmpeg']); await checkInstalledSoftwareOnDisk(['chromium', 'chromium-headless-shell', 'ffmpeg', ...extraInstalledSoftware]);
await exec('npx playwright uninstall'); await exec('npx playwright uninstall');
await checkInstalledSoftwareOnDisk([]); await checkInstalledSoftwareOnDisk([...extraInstalledSoftware]);
}); });
test('should print the right install command without browsers', async ({ exec }) => { test('should print the right install command without browsers', async ({ exec }) => {

22
tests/installation/playwright-packages-install-behavior.spec.ts
View file

@ -18,12 +18,14 @@ import { test, expect } from './npmTest';
test.use({ isolateBrowsers: true }); test.use({ isolateBrowsers: true });
const extraInstalledSoftware = process.platform === 'win32' ? ['winldd' as const] : [];
for (const browser of ['chromium', 'firefox', 'webkit']) { for (const browser of ['chromium', 'firefox', 'webkit']) {
test(`playwright-${browser} should work`, async ({ exec, checkInstalledSoftwareOnDisk }) => { test(`playwright-${browser} should work`, async ({ exec, checkInstalledSoftwareOnDisk }) => {
const pkg = `playwright-${browser}`; const pkg = `playwright-${browser}`;
const result = await exec('npm i --foreground-scripts', pkg); const result = await exec('npm i --foreground-scripts', pkg);
const browserName = pkg.split('-')[1]; const browserName = pkg.split('-')[1];
const expectedSoftware = [browserName]; const expectedSoftware = [browserName, ...extraInstalledSoftware];
if (browserName === 'chromium') if (browserName === 'chromium')
expectedSoftware.push('chromium-headless-shell', 'ffmpeg'); expectedSoftware.push('chromium-headless-shell', 'ffmpeg');
expect(result).toHaveLoggedSoftwareDownload(expectedSoftware as any); expect(result).toHaveLoggedSoftwareDownload(expectedSoftware as any);
@ -37,7 +39,7 @@ for (const browser of ['chromium', 'firefox', 'webkit']) {
for (const browser of ['chromium', 'firefox', 'webkit']) { for (const browser of ['chromium', 'firefox', 'webkit']) {
test(`@playwright/browser-${browser} should work`, async ({ exec, checkInstalledSoftwareOnDisk }) => { test(`@playwright/browser-${browser} should work`, async ({ exec, checkInstalledSoftwareOnDisk }) => {
const pkg = `@playwright/browser-${browser}`; const pkg = `@playwright/browser-${browser}`;
const expectedSoftware = [browser]; const expectedSoftware = [browser, ...extraInstalledSoftware];
if (browser === 'chromium') if (browser === 'chromium')
expectedSoftware.push('chromium-headless-shell', 'ffmpeg'); expectedSoftware.push('chromium-headless-shell', 'ffmpeg');
@ -69,8 +71,8 @@ test(`playwright should work`, async ({ exec, checkInstalledSoftwareOnDisk }) =>
await checkInstalledSoftwareOnDisk([]); await checkInstalledSoftwareOnDisk([]);
const result2 = await exec('npx playwright install'); const result2 = await exec('npx playwright install');
expect(result2).toHaveLoggedSoftwareDownload(['chromium', 'chromium-headless-shell', 'ffmpeg', 'firefox', 'webkit']); expect(result2).toHaveLoggedSoftwareDownload(['chromium', 'chromium-headless-shell', 'ffmpeg', 'firefox', 'webkit', ...extraInstalledSoftware]);
await checkInstalledSoftwareOnDisk(['chromium', 'chromium-headless-shell', 'ffmpeg', 'firefox', 'webkit']); await checkInstalledSoftwareOnDisk(['chromium', 'chromium-headless-shell', 'ffmpeg', 'firefox', 'webkit', ...extraInstalledSoftware]);
await exec('node sanity.js playwright chromium firefox webkit'); await exec('node sanity.js playwright chromium firefox webkit');
await exec('node esm-playwright.mjs'); await exec('node esm-playwright.mjs');
@ -81,8 +83,8 @@ test(`playwright should work with chromium --no-shell`, async ({ exec, checkInst
expect(result1).toHaveLoggedSoftwareDownload([]); expect(result1).toHaveLoggedSoftwareDownload([]);
await checkInstalledSoftwareOnDisk([]); await checkInstalledSoftwareOnDisk([]);
const result2 = await exec('npx playwright install chromium --no-shell'); const result2 = await exec('npx playwright install chromium --no-shell');
expect(result2).toHaveLoggedSoftwareDownload(['chromium', 'ffmpeg']); expect(result2).toHaveLoggedSoftwareDownload(['chromium', 'ffmpeg', ...extraInstalledSoftware]);
await checkInstalledSoftwareOnDisk(['chromium', 'ffmpeg']); await checkInstalledSoftwareOnDisk(['chromium', 'ffmpeg', ...extraInstalledSoftware]);
}); });
test(`playwright should work with chromium --only-shell`, async ({ exec, checkInstalledSoftwareOnDisk }) => { test(`playwright should work with chromium --only-shell`, async ({ exec, checkInstalledSoftwareOnDisk }) => {
@ -90,8 +92,8 @@ test(`playwright should work with chromium --only-shell`, async ({ exec, checkIn
expect(result1).toHaveLoggedSoftwareDownload([]); expect(result1).toHaveLoggedSoftwareDownload([]);
await checkInstalledSoftwareOnDisk([]); await checkInstalledSoftwareOnDisk([]);
const result2 = await exec('npx playwright install --only-shell'); const result2 = await exec('npx playwright install --only-shell');
expect(result2).toHaveLoggedSoftwareDownload(['chromium-headless-shell', 'ffmpeg', 'firefox', 'webkit']); expect(result2).toHaveLoggedSoftwareDownload(['chromium-headless-shell', 'ffmpeg', 'firefox', 'webkit', ...extraInstalledSoftware]);
await checkInstalledSoftwareOnDisk(['chromium-headless-shell', 'ffmpeg', 'firefox', 'webkit']); await checkInstalledSoftwareOnDisk(['chromium-headless-shell', 'ffmpeg', 'firefox', 'webkit', ...extraInstalledSoftware]);
}); });
test('@playwright/test should work', async ({ exec, checkInstalledSoftwareOnDisk }) => { test('@playwright/test should work', async ({ exec, checkInstalledSoftwareOnDisk }) => {
@ -102,8 +104,8 @@ test('@playwright/test should work', async ({ exec, checkInstalledSoftwareOnDisk
await exec('npx playwright test -c . sample.spec.js', { expectToExitWithError: true, message: 'should not be able to run tests without installing browsers' }); await exec('npx playwright test -c . sample.spec.js', { expectToExitWithError: true, message: 'should not be able to run tests without installing browsers' });
const result2 = await exec('npx playwright install'); const result2 = await exec('npx playwright install');
expect(result2).toHaveLoggedSoftwareDownload(['chromium', 'chromium-headless-shell', 'ffmpeg', 'firefox', 'webkit']); expect(result2).toHaveLoggedSoftwareDownload(['chromium', 'chromium-headless-shell', 'ffmpeg', 'firefox', 'webkit', ...extraInstalledSoftware]);
await checkInstalledSoftwareOnDisk(['chromium', 'chromium-headless-shell', 'ffmpeg', 'firefox', 'webkit']); await checkInstalledSoftwareOnDisk(['chromium', 'chromium-headless-shell', 'ffmpeg', 'firefox', 'webkit', ...extraInstalledSoftware]);
await exec('node sanity.js @playwright/test chromium firefox webkit'); await exec('node sanity.js @playwright/test chromium firefox webkit');
await exec('node', 'esm-playwright-test.mjs'); await exec('node', 'esm-playwright-test.mjs');

1
tests/installation/playwright-test-plugin.spec.ts
View file

@ -26,7 +26,6 @@ function patchPackageJsonForPreReleaseIfNeeded(tmpWorkspace: string) {
// Workaround per https://stackoverflow.com/questions/71479750/npm-install-pre-release-versions-for-peer-dependency. // Workaround per https://stackoverflow.com/questions/71479750/npm-install-pre-release-versions-for-peer-dependency.
const pkg = JSON.parse(fs.readFileSync(path.resolve(tmpWorkspace, 'package.json'), 'utf-8')); const pkg = JSON.parse(fs.readFileSync(path.resolve(tmpWorkspace, 'package.json'), 'utf-8'));
if (pkg.dependencies['@playwright/test'].match(/\d+\.\d+-\w+/)) { if (pkg.dependencies['@playwright/test'].match(/\d+\.\d+-\w+/)) {
console.log(`Setting overrides in package.json to make pre-release version of peer dependency work.`);
pkg.overrides = { '@playwright/test': '$@playwright/test' }; pkg.overrides = { '@playwright/test': '$@playwright/test' };
fs.writeFileSync(path.resolve(tmpWorkspace, 'package.json'), JSON.stringify(pkg, null, 2)); fs.writeFileSync(path.resolve(tmpWorkspace, 'package.json'), JSON.stringify(pkg, null, 2));
} }