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

feat: make playwright package not install browsers automatically (#26672)

Browse source 
Additionally introduce `@playwright/browser-<browser>` packages that
just download the respective browser, but do not export anything.

References #26614.
This commit is contained in:
Dmitry Gozman 2023-08-27 07:24:35 -07:00 committed by GitHub
parent 72aef6bc1d
commit 36347e7fea
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
51 changed files with 589 additions and 115 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

45
docs/src/browsers.md
View file

@ -468,31 +468,17 @@ Sometimes companies maintain an internal proxy that blocks direct access to the
resources. In this case, Playwright can be configured to download browsers via a proxy server. resources. In this case, Playwright can be configured to download browsers via a proxy server.
```bash tab=bash-bash lang=js ```bash tab=bash-bash lang=js
# For Playwright Test
HTTPS_PROXY=https://192.0.2.1 npx playwright install HTTPS_PROXY=https://192.0.2.1 npx playwright install
# For Playwright Library
HTTPS_PROXY=https://192.0.2.1 npm install playwright
``` ```
```batch tab=bash-batch lang=js ```batch tab=bash-batch lang=js
# For Playwright Test
set HTTPS_PROXY=https://192.0.2.1 set HTTPS_PROXY=https://192.0.2.1
npx playwright install npx playwright install
# For Playwright Library
set HTTPS_PROXY=https://192.0.2.1
npm install playwright
``` ```
```powershell tab=bash-powershell lang=js ```powershell tab=bash-powershell lang=js
# For Playwright Test
$Env:HTTPS_PROXY="https://192.0.2.1" $Env:HTTPS_PROXY="https://192.0.2.1"
npx playwright install npx playwright install
# For Playwright Library
$Env:HTTPS_PROXY="https://192.0.2.1"
npm install playwright
``` ```
```bash tab=bash-bash lang=python ```bash tab=bash-bash lang=python
@ -614,6 +600,7 @@ pwsh bin/Debug/netX/playwright.ps1 install
$Env:PLAYWRIGHT_DOWNLOAD_CONNECTION_TIMEOUT="120000" $Env:PLAYWRIGHT_DOWNLOAD_CONNECTION_TIMEOUT="120000"
pwsh bin/Debug/netX/playwright.ps1 install pwsh bin/Debug/netX/playwright.ps1 install
``` ```
## Download from artifact repository ## Download from artifact repository
By default, Playwright downloads browsers from Microsoft's CDN. By default, Playwright downloads browsers from Microsoft's CDN.
@ -623,31 +610,17 @@ binaries. In this case, Playwright can be configured to download from a custom
location using the `PLAYWRIGHT_DOWNLOAD_HOST` env variable. location using the `PLAYWRIGHT_DOWNLOAD_HOST` env variable.
```bash tab=bash-bash lang=js ```bash tab=bash-bash lang=js
# For Playwright Test
PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1 npx playwright install PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1 npx playwright install
# For Playwright Library
PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1 npm install playwright
``` ```
```batch tab=bash-batch lang=js ```batch tab=bash-batch lang=js
# For Playwright Test
set PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1 set PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1
npx playwright install npx playwright install
# For Playwright Library
set PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1
npm install playwright
``` ```
```powershell tab=bash-powershell lang=js ```powershell tab=bash-powershell lang=js
# For Playwright Test
$Env:PLAYWRIGHT_DOWNLOAD_HOST="192.0.2.1" $Env:PLAYWRIGHT_DOWNLOAD_HOST="192.0.2.1"
npx playwright install npx playwright install
# For Playwright Library
$Env:PLAYWRIGHT_DOWNLOAD_HOST="192.0.2.1"
npm install playwright
``` ```
```bash tab=bash-bash lang=python ```bash tab=bash-bash lang=python
@ -699,35 +672,19 @@ It is also possible to use a per-browser download hosts using `PLAYWRIGHT_CHROMI
take precedence over `PLAYWRIGHT_DOWNLOAD_HOST`. take precedence over `PLAYWRIGHT_DOWNLOAD_HOST`.
```bash tab=bash-bash lang=js ```bash tab=bash-bash lang=js
# For Playwright Test
PLAYWRIGHT_FIREFOX_DOWNLOAD_HOST=203.0.113.3 PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1 npx playwright install PLAYWRIGHT_FIREFOX_DOWNLOAD_HOST=203.0.113.3 PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1 npx playwright install
# For Playwright Library
PLAYWRIGHT_FIREFOX_DOWNLOAD_HOST=203.0.113.3 PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1 npm install playwright
``` ```
```batch tab=bash-batch lang=js ```batch tab=bash-batch lang=js
# For Playwright Test
set PLAYWRIGHT_FIREFOX_DOWNLOAD_HOST=203.0.113.3 set PLAYWRIGHT_FIREFOX_DOWNLOAD_HOST=203.0.113.3
set PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1 set PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1
npx playwright install npx playwright install
# For Playwright Library
set PLAYWRIGHT_FIREFOX_DOWNLOAD_HOST=203.0.113.3
set PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1
npm install playwright
``` ```
```powershell tab=bash-powershell lang=js ```powershell tab=bash-powershell lang=js
# For Playwright Test
$Env:PLAYWRIGHT_FIREFOX_DOWNLOAD_HOST="203.0.113.3" $Env:PLAYWRIGHT_FIREFOX_DOWNLOAD_HOST="203.0.113.3"
$Env:PLAYWRIGHT_DOWNLOAD_HOST="192.0.2.1" $Env:PLAYWRIGHT_DOWNLOAD_HOST="192.0.2.1"
npx playwright install npx playwright install
# For Playwright Library
$Env:PLAYWRIGHT_FIREFOX_DOWNLOAD_HOST="203.0.113.3"
$Env:PLAYWRIGHT_DOWNLOAD_HOST="192.0.2.1"
npm install playwright
``` ```
```bash tab=bash-bash lang=python ```bash tab=bash-bash lang=python

111
docs/src/library-js.md
View file

@ -99,8 +99,8 @@ The key differences to note are as follows:
| | Library | Test | | | Library | Test |
| - | - | - | | - | - | - |
| Installation | `npm install playwright` | `npm init playwright@latest` - note `install` vs. `init` | | Installation | `npm install playwright` | `npm init playwright@latest` - note `install` vs. `init` |
| Install browsers | Chromium, Firefox, WebKit are installed by default | `npx playwright install` or `npx playwright install chromium` for a single one | | Install browsers | Install `@playwright/browser-chromium`, `@playwright/browser-firefox` and/or `@playwright/browser-webkit` | `npx playwright install` or `npx playwright install chromium` for a single one |
| `import`/`require` name | `playwright` | `@playwright/test` | | `import` from | `playwright` | `@playwright/test` |
| Initialization | Explicitly need to: <ol><li>Pick a browser to use, e.g. `chromium`</li><li>Launch browser with [`method: BrowserType.launch`]</li><li>Create a context with [`method: Browser.newContext`], <em>and</em> pass any context options explicitly, e.g. `devices['iPhone 11']`</li><li>Create a page with [`method: BrowserContext.newPage`]</li></ol> | An isolated `page` and `context` are provided to each test out-of the box, along with other [built-in fixtures](./test-fixtures.md#built-in-fixtures). No explicit creation. If referenced by the test in it's arguments, the Test Runner will create them for the test. (i.e. lazy-initialization) | | Initialization | Explicitly need to: <ol><li>Pick a browser to use, e.g. `chromium`</li><li>Launch browser with [`method: BrowserType.launch`]</li><li>Create a context with [`method: Browser.newContext`], <em>and</em> pass any context options explicitly, e.g. `devices['iPhone 11']`</li><li>Create a page with [`method: BrowserContext.newPage`]</li></ol> | An isolated `page` and `context` are provided to each test out-of the box, along with other [built-in fixtures](./test-fixtures.md#built-in-fixtures). No explicit creation. If referenced by the test in it's arguments, the Test Runner will create them for the test. (i.e. lazy-initialization) |
| Assertions | No built-in Web-First Assertions | [Web-First assertions](./test-assertions.md) like: <ul><li>[`method: PageAssertions.toHaveTitle`]</li><li>[`method: PageAssertions.toHaveScreenshot#1`]</li></ul> which auto-wait and retry for the condition to be met.| | Assertions | No built-in Web-First Assertions | [Web-First assertions](./test-assertions.md) like: <ul><li>[`method: PageAssertions.toHaveTitle`]</li><li>[`method: PageAssertions.toHaveScreenshot#1`]</li></ul> which auto-wait and retry for the condition to be met.|
| Cleanup | Explicitly need to: <ol><li>Close context with [`method: BrowserContext.close`]</li><li>Close browser with [`method: Browser.close`]</li></ol> | No explicit close of [built-in fixtures](./test-fixtures.md#built-in-fixtures); the Test Runner will take care of it. | Cleanup | Explicitly need to: <ol><li>Close context with [`method: BrowserContext.close`]</li><li>Close browser with [`method: Browser.close`]</li></ol> | No explicit close of [built-in fixtures](./test-fixtures.md#built-in-fixtures); the Test Runner will take care of it.
@ -124,9 +124,19 @@ Use npm or Yarn to install Playwright library in your Node.js project. See [syst
npm i -D playwright npm i -D playwright
``` ```
This single command downloads the Playwright NPM package and browser binaries for Chromium, Firefox and WebKit. To modify this behavior see [managing browsers](./browsers.md#managing-browser-binaries). You will also need to install browsers - either manually or by adding a package that will do it for you automatically.
Once installed, you can `require` Playwright in a Node.js script, and launch any of the 3 browsers (`chromium`, `firefox` and `webkit`). ```bash
# Download the Chromium, Firefox and WebKit browser
npx playwright install chromium firefox webkit
# Alternatively, add packages that will download a browser upon npm install
npm i -D @playwright/browser-chromium @playwright/browser-firefox @playwright/browser-webkit
```
See [managing browsers](./browsers.md#managing-browser-binaries) for more options.
Once installed, you can import Playwright in a Node.js script, and launch any of the 3 browsers (`chromium`, `firefox` and `webkit`).
```js ```js
const { chromium } = require('playwright'); const { chromium } = require('playwright');
@ -179,25 +189,114 @@ npx playwright codegen wikipedia.org
## Browser downloads ## Browser downloads
By default, `playwright` automatically downloads Chromium, Firefox and WebKit during package installation. To download Playwright browsers run:
```bash
# Explicitly download browsers
npx playwright install
```
Alternatively, you can add `@playwright/browser-chromium`, `@playwright/browser-firefox` and `@playwright/browser-webkit` packages to automatically download the respective browser during the package installation.
```bash
# Use a helper package that downloads a browser on npm install
npm install @playwright/browser-chromium
```
**Download behind a firewall or a proxy**
Pass `HTTPS_PROXY` environment variable to download through a proxy.
```bash tab=bash-bash lang=js
# Manual
HTTPS_PROXY=https://192.0.2.1 npx playwright install
# Through @playwright/browser-chromium, @playwright/browser-firefox
# and @playwright/browser-webkit helper packages
HTTPS_PROXY=https://192.0.2.1 npm install
```
```batch tab=bash-batch lang=js
# Manual
set HTTPS_PROXY=https://192.0.2.1
npx playwright install
# Through @playwright/browser-chromium, @playwright/browser-firefox
# and @playwright/browser-webkit helper packages
set HTTPS_PROXY=https://192.0.2.1
npm install
```
```powershell tab=bash-powershell lang=js
# Manual
$Env:HTTPS_PROXY=https://192.0.2.1
npx playwright install
# Through @playwright/browser-chromium, @playwright/browser-firefox
# and @playwright/browser-webkit helper packages
$Env:HTTPS_PROXY=https://192.0.2.1
npm install
```
**Download from artifact repository**
By default, Playwright downloads browsers from Microsoft's CDN. Pass `PLAYWRIGHT_DOWNLOAD_HOST` environment variable to download from an internal artifacts repository instead.
```bash tab=bash-bash lang=js
# Manual
PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1 npx playwright install
# Through @playwright/browser-chromium, @playwright/browser-firefox
# and @playwright/browser-webkit helper packages
PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1 npm install
```
```batch tab=bash-batch lang=js
# Manual
set PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1
npx playwright install
# Through @playwright/browser-chromium, @playwright/browser-firefox
# and @playwright/browser-webkit helper packages
set PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1
npm install
```
```powershell tab=bash-powershell lang=js
# Manual
$Env:PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1
npx playwright install
# Through @playwright/browser-chromium, @playwright/browser-firefox
# and @playwright/browser-webkit helper packages
$Env:PLAYWRIGHT_DOWNLOAD_HOST=192.0.2.1
npm install
```
**Skip browser download**
In certain cases, it is desired to avoid browser downloads altogether because browser binaries are managed separately. This can be done by setting `PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD` variable before installing packages. In certain cases, it is desired to avoid browser downloads altogether because browser binaries are managed separately. This can be done by setting `PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD` variable before installing packages.
```bash tab=bash-bash lang=js ```bash tab=bash-bash lang=js
# When using @playwright/browser-chromium, @playwright/browser-firefox
# and @playwright/browser-webkit helper packages
PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD=1 npm install PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD=1 npm install
``` ```
```batch tab=bash-batch lang=js ```batch tab=bash-batch lang=js
# When using @playwright/browser-chromium, @playwright/browser-firefox
# and @playwright/browser-webkit helper packages
set PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD=1 set PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD=1
npm install npm install
``` ```
```powershell tab=bash-powershell lang=js ```powershell tab=bash-powershell lang=js
# When using @playwright/browser-chromium, @playwright/browser-firefox
# and @playwright/browser-webkit helper packages
$Env:PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD=1 $Env:PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD=1
npm install npm install
``` ```
## TypeScript support ## TypeScript support
Playwright includes built-in support for TypeScript. Type definitions will be imported automatically. It is recommended to use type-checking to improve the IDE experience. Playwright includes built-in support for TypeScript. Type definitions will be imported automatically. It is recommended to use type-checking to improve the IDE experience.

67
package-lock.json generated
View file

@ -1396,6 +1396,18 @@
"node": ">= 8" "node": ">= 8"
} }
}, },
"node_modules/@playwright/browser-chromium": {
"resolved": "packages/playwright-browser-chromium",
"link": true
},
"node_modules/@playwright/browser-firefox": {
"resolved": "packages/playwright-browser-firefox",
"link": true
},
"node_modules/@playwright/browser-webkit": {
"resolved": "packages/playwright-browser-webkit",
"link": true
},
"node_modules/@playwright/experimental-ct-core": { "node_modules/@playwright/experimental-ct-core": {
"resolved": "packages/playwright-ct-core", "resolved": "packages/playwright-ct-core",
"link": true "link": true
@ -6278,7 +6290,6 @@
}, },
"packages/playwright": { "packages/playwright": {
"version": "1.38.0-next", "version": "1.38.0-next",
"hasInstallScript": true,
"license": "Apache-2.0", "license": "Apache-2.0",
"dependencies": { "dependencies": {
"playwright-core": "1.38.0-next" "playwright-core": "1.38.0-next"
@ -6290,6 +6301,42 @@
"node": ">=16" "node": ">=16"
} }
}, },
"packages/playwright-browser-chromium": {
"name": "@playwright/browser-chromium",
"version": "1.38.0-next",
"hasInstallScript": true,
"license": "Apache-2.0",
"dependencies": {
"playwright-core": "1.38.0-next"
},
"engines": {
"node": ">=16"
}
},
"packages/playwright-browser-firefox": {
"name": "@playwright/browser-firefox",
"version": "1.38.0-next",
"hasInstallScript": true,
"license": "Apache-2.0",
"dependencies": {
"playwright-core": "1.38.0-next"
},
"engines": {
"node": ">=16"
}
},
"packages/playwright-browser-webkit": {
"name": "@playwright/browser-webkit",
"version": "1.38.0-next",
"hasInstallScript": true,
"license": "Apache-2.0",
"dependencies": {
"playwright-core": "1.38.0-next"
},
"engines": {
"node": ">=16"
}
},
"packages/playwright-chromium": { "packages/playwright-chromium": {
"version": "1.38.0-next", "version": "1.38.0-next",
"hasInstallScript": true, "hasInstallScript": true,
@ -7402,6 +7449,24 @@
"fastq": "^1.6.0" "fastq": "^1.6.0"
} }
}, },
"@playwright/browser-chromium": {
"version": "file:packages/playwright-browser-chromium",
"requires": {
"playwright-core": "1.38.0-next"
}
},
"@playwright/browser-firefox": {
"version": "file:packages/playwright-browser-firefox",
"requires": {
"playwright-core": "1.38.0-next"
}
},
"@playwright/browser-webkit": {
"version": "file:packages/playwright-browser-webkit",
"requires": {
"playwright-core": "1.38.0-next"
}
},
"@playwright/experimental-ct-core": { "@playwright/experimental-ct-core": {
"version": "file:packages/playwright-ct-core", "version": "file:packages/playwright-ct-core",
"requires": { "requires": {

3
packages/playwright-browser-chromium/README.md Normal file
View file

@ -0,0 +1,3 @@
# @playwright/browser-chromium
This package automatically installs [Chromium](https://www.chromium.org/) browser for [Playwright](http://github.com/microsoft/playwright) library. If you want to write end-to-end tests, we recommend [@playwright/test](https://playwright.dev/docs/intro).

17
packages/playwright-browser-chromium/index.d.ts vendored Normal file
View file

@ -0,0 +1,17 @@
/**
* Copyright (c) Microsoft Corporation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
export {};

15
packages/playwright-browser-chromium/index.js Normal file
View file

@ -0,0 +1,15 @@
/**
* Copyright (c) Microsoft Corporation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

15
packages/playwright-browser-chromium/index.mjs Normal file
View file

@ -0,0 +1,15 @@
/**
* Copyright (c) Microsoft Corporation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

27
packages/playwright-browser-chromium/install.js Normal file
View file

@ -0,0 +1,27 @@
/**
* Copyright (c) Microsoft Corporation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
let install;
try {
if (!require('playwright-core/lib/utils').isLikelyNpxGlobal())
install = require('playwright-core/lib/server').installBrowsersForNpmInstall;
} catch (e) {
// Dev build, don't install browsers by default.
}
if (install)
install(['chromium', 'ffmpeg']);

29
packages/playwright-browser-chromium/package.json Normal file
View file

@ -0,0 +1,29 @@
{
"name": "@playwright/browser-chromium",
"version": "1.38.0-next",
"description": "Playwright package that automatically installs Chromium",
"repository": "github:Microsoft/playwright",
"homepage": "https://playwright.dev",
"engines": {
"node": ">=16"
},
"author": {
"name": "Microsoft Corporation"
},
"license": "Apache-2.0",
"exports": {
".": {
"types": "./index.d.ts",
"import": "./index.mjs",
"require": "./index.js",
"default": "./index.js"
},
"./package.json": "./package.json"
},
"scripts": {
"install": "node install.js"
},
"dependencies": {
"playwright-core": "1.38.0-next"
}
}

3
packages/playwright-browser-firefox/README.md Normal file
View file

@ -0,0 +1,3 @@
# @playwright/browser-firefox
This package automatically installs [Firefox](https://www.mozilla.org/firefox/) browser for [Playwright](http://github.com/microsoft/playwright) library. If you want to write end-to-end tests, we recommend [@playwright/test](https://playwright.dev/docs/intro).

17
packages/playwright-browser-firefox/index.d.ts vendored Normal file
View file

@ -0,0 +1,17 @@
/**
* Copyright (c) Microsoft Corporation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
export {};

15
packages/playwright-browser-firefox/index.js Normal file
View file

@ -0,0 +1,15 @@
/**
* Copyright (c) Microsoft Corporation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

15
packages/playwright-browser-firefox/index.mjs Normal file
View file

@ -0,0 +1,15 @@
/**
* Copyright (c) Microsoft Corporation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

27
packages/playwright-browser-firefox/install.js Normal file
View file

@ -0,0 +1,27 @@
/**
* Copyright (c) Microsoft Corporation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
let install;
try {
if (!require('playwright-core/lib/utils').isLikelyNpxGlobal())
install = require('playwright-core/lib/server').installBrowsersForNpmInstall;
} catch (e) {
// Dev build, don't install browsers by default.
}
if (install)
install(['firefox']);

29
packages/playwright-browser-firefox/package.json Normal file
View file

@ -0,0 +1,29 @@
{
"name": "@playwright/browser-firefox",
"version": "1.38.0-next",
"description": "Playwright package that automatically installs Firefox",
"repository": "github:Microsoft/playwright",
"homepage": "https://playwright.dev",
"engines": {
"node": ">=16"
},
"author": {
"name": "Microsoft Corporation"
},
"license": "Apache-2.0",
"exports": {
".": {
"types": "./index.d.ts",
"import": "./index.mjs",
"require": "./index.js",
"default": "./index.js"
},
"./package.json": "./package.json"
},
"scripts": {
"install": "node install.js"
},
"dependencies": {
"playwright-core": "1.38.0-next"
}
}

3
packages/playwright-browser-webkit/README.md Normal file
View file

@ -0,0 +1,3 @@
# @playwright/browser-webkit
This package automatically installs [WebKit](https://www.webkit.org/) browser for [Playwright](http://github.com/microsoft/playwright) library. If you want to write end-to-end tests, we recommend [@playwright/test](https://playwright.dev/docs/intro).

17
packages/playwright-browser-webkit/index.d.ts vendored Normal file
View file

@ -0,0 +1,17 @@
/**
* Copyright (c) Microsoft Corporation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
export {};

15
packages/playwright-browser-webkit/index.js Normal file
View file

@ -0,0 +1,15 @@
/**
* Copyright (c) Microsoft Corporation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

15
packages/playwright-browser-webkit/index.mjs Normal file
View file

@ -0,0 +1,15 @@
/**
* Copyright (c) Microsoft Corporation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

4
packages/playwright/install.js → packages/playwright-browser-webkit/install.js
View file

@ -18,10 +18,10 @@ let install;
try { try {
if (!require('playwright-core/lib/utils').isLikelyNpxGlobal()) if (!require('playwright-core/lib/utils').isLikelyNpxGlobal())
install = require('playwright-core/lib/server').installDefaultBrowsersForNpmInstall; install = require('playwright-core/lib/server').installBrowsersForNpmInstall;
} catch (e) { } catch (e) {
// Dev build, don't install browsers by default. // Dev build, don't install browsers by default.
} }
if (install) if (install)
install(); install(['webkit']);

29
packages/playwright-browser-webkit/package.json Normal file
View file

@ -0,0 +1,29 @@
{
"name": "@playwright/browser-webkit",
"version": "1.38.0-next",
"description": "Playwright package that automatically installs WebKit",
"repository": "github:Microsoft/playwright",
"homepage": "https://playwright.dev",
"engines": {
"node": ">=16"
},
"author": {
"name": "Microsoft Corporation"
},
"license": "Apache-2.0",
"exports": {
".": {
"types": "./index.d.ts",
"import": "./index.mjs",
"require": "./index.js",
"default": "./index.js"
},
"./package.json": "./package.json"
},
"scripts": {
"install": "node install.js"
},
"dependencies": {
"playwright-core": "1.38.0-next"
}
}

1
packages/playwright/package.json
View file

@ -25,7 +25,6 @@
"playwright": "./cli.js" "playwright": "./cli.js"
}, },
"scripts": { "scripts": {
"install": "node install.js"
}, },
"dependencies": { "dependencies": {
"playwright-core": "1.38.0-next" "playwright-core": "1.38.0-next"

2
tests/installation/android-types.spec.ts
View file

@ -16,7 +16,7 @@
import { test } from './npmTest'; import { test } from './npmTest';
test('android types', async ({ exec, tsc, writeFiles }) => { test('android types', async ({ exec, tsc, writeFiles }) => {
await exec('npm i --foreground-scripts playwright', { env: { PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: '1' } }); await exec('npm i --foreground-scripts playwright');
await writeFiles({ await writeFiles({
'test.ts': 'test.ts':
`import { AndroidDevice, _android, AndroidWebView, Page } from 'playwright';`, `import { AndroidDevice, _android, AndroidWebView, Page } from 'playwright';`,

4
tests/installation/driver-should-work.spec.ts
View file

@ -16,7 +16,7 @@
import { test, expect } from './npmTest'; import { test, expect } from './npmTest';
test('driver should work', async ({ exec }) => { test('driver should work', async ({ exec }) => {
await exec('npm i --foreground-scripts playwright', { env: { PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: '1' } }); await exec('npm i --foreground-scripts playwright');
await exec('npx playwright install'); await exec('npx playwright install');
await exec('node driver-client.js'); await exec('node driver-client.js');
}); });
@ -24,7 +24,7 @@ test('driver should work', async ({ exec }) => {
test('driver should ignore SIGINT', async ({ exec }) => { test('driver should ignore SIGINT', async ({ exec }) => {
test.skip(process.platform === 'win32', 'Only relevant for POSIX'); test.skip(process.platform === 'win32', 'Only relevant for POSIX');
test.info().annotations.push({ type: 'issue', description: 'https://github.com/microsoft/playwright-python/issues/1843' }); test.info().annotations.push({ type: 'issue', description: 'https://github.com/microsoft/playwright-python/issues/1843' });
await exec('npm i --foreground-scripts playwright', { env: { PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: '1' } }); await exec('npm i --foreground-scripts playwright');
await exec('npx playwright install chromium'); await exec('npx playwright install chromium');
const output = await exec('node driver-client-sigint.js'); const output = await exec('node driver-client-sigint.js');
const lines = output.split('\n').filter(l => l.trim()); const lines = output.split('\n').filter(l => l.trim());

2
tests/installation/electron-types.spec.ts
View file

@ -16,7 +16,7 @@
import { test } from './npmTest'; import { test } from './npmTest';
test('electron types', async ({ exec, tsc, writeFiles }) => { test('electron types', async ({ exec, tsc, writeFiles }) => {
await exec('npm i --foreground-scripts playwright electron@12', { env: { PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: '1' } }); await exec('npm i --foreground-scripts playwright electron@12');
await writeFiles({ await writeFiles({
'test.ts': 'test.ts':
`import { Page, _electron, ElectronApplication, Electron } from 'playwright';` `import { Page, _electron, ElectronApplication, Electron } from 'playwright';`

27
tests/installation/fixture-scripts/browser-only.js Normal file
View file

@ -0,0 +1,27 @@
/**
* Copyright (c) Microsoft Corporation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
const requireName = process.argv[2];
const pkg = require(requireName);
for (const key of ['chromium', 'firefox', 'webkit', 'test', 'devices']) {
if (pkg[key] !== undefined) {
console.error(`Package ${requireName} should not export ${key}`);
process.exit(1);
}
}
console.log(`${requireName} SUCCESS`);

15
tests/installation/fixture-scripts/sanity.js
View file

@ -15,20 +15,7 @@
*/ */
const requireName = process.argv[2]; const requireName = process.argv[2];
let success = { const success = process.argv.slice(3);
'playwright': ['chromium', 'firefox', 'webkit'],
'playwright-chromium': ['chromium'],
'playwright-firefox': ['firefox'],
'playwright-webkit': ['webkit'],
'@playwright/test': ['chromium', 'firefox', 'webkit'],
}[requireName];
if (process.argv[3] === 'none')
success = [];
else if (process.argv[3] === 'all')
success = ['chromium', 'firefox', 'webkit'];
else if (process.argv[3])
success = process.argv.slice(3)
const playwright = require(requireName); const playwright = require(requireName);
const packageJSON = require(requireName + '/package.json'); const packageJSON = require(requireName + '/package.json');

11
tests/installation/fixture-scripts/screencast.js
View file

@ -15,16 +15,7 @@
*/ */
const requireName = process.argv[2]; const requireName = process.argv[2];
let success = { const success = process.argv.slice(3);
'playwright': ['chromium', 'firefox', 'webkit'],
'playwright-chromium': ['chromium'],
'playwright-firefox': ['firefox'],
'playwright-webkit': ['webkit'],
}[requireName];
if (process.argv[3] === 'none')
success = [];
if (process.argv[3] === 'all')
success = ['chromium', 'firefox', 'webkit'];
const playwright = require(requireName); const playwright = require(requireName);
const fs = require('fs'); const fs = require('fs');

3
tests/installation/globalSetup.ts
View file

@ -50,6 +50,9 @@ async function globalSetup() {
build('playwright-chromium'), build('playwright-chromium'),
build('playwright-firefox'), build('playwright-firefox'),
build('playwright-webkit'), build('playwright-webkit'),
build('playwright-browser-chromium', '@playwright/browser-chromium'),
build('playwright-browser-firefox', '@playwright/browser-firefox'),
build('playwright-browser-webkit', '@playwright/browser-webkit'),
]); ]);
await fs.promises.writeFile(path.join(__dirname, '.registry.json'), JSON.stringify(Object.fromEntries(builds))); await fs.promises.writeFile(path.join(__dirname, '.registry.json'), JSON.stringify(Object.fromEntries(builds)));

2
tests/installation/npm-installs-local-packages.spec.ts
View file

@ -18,7 +18,7 @@ import { test, expect } from './npmTest';
import fs from 'fs'; import fs from 'fs';
test('installs local packages', async ({ registry, exec, tmpWorkspace }) => { test('installs local packages', async ({ registry, exec, tmpWorkspace }) => {
const packages = ['playwright', 'playwright-core', 'playwright-chromium', 'playwright-firefox', 'playwright-webkit', '@playwright/test']; const packages = ['playwright', 'playwright-core', 'playwright-chromium', 'playwright-firefox', 'playwright-webkit', '@playwright/test', '@playwright/browser-chromium', '@playwright/browser-firefox', '@playwright/browser-webkit'];
await exec('npm i --foreground-scripts', ...packages, { env: { PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: '1' } }); await exec('npm i --foreground-scripts', ...packages, { env: { PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: '1' } });
const output = await exec('node', path.join(__dirname, '..', '..', 'utils', 'workspace.js'), '--get-version'); const output = await exec('node', path.join(__dirname, '..', '..', 'utils', 'workspace.js'), '--get-version');

1
tests/installation/npx-global-install.spec.ts
View file

@ -17,6 +17,7 @@ import { test, expect } from './npmTest';
test('npx playwright install global', async ({ exec, installedSoftwareOnDisk }) => { test('npx playwright install global', async ({ exec, installedSoftwareOnDisk }) => {
test.skip(process.platform === 'win32', 'isLikelyNpxGlobal() does not work in this setup on our bots'); test.skip(process.platform === 'win32', 'isLikelyNpxGlobal() does not work in this setup on our bots');
const result = await exec('npx playwright install', { env: { npm_config_prefix: '' } }); // global npx and npm_config_prefix do not work together nicely (https://github.com/npm/cli/issues/5268) const result = await exec('npx playwright install', { env: { npm_config_prefix: '' } }); // global npx and npm_config_prefix do not work together nicely (https://github.com/npm/cli/issues/5268)
expect(result).toHaveLoggedSoftwareDownload(['chromium', 'ffmpeg', 'firefox', 'webkit']); expect(result).toHaveLoggedSoftwareDownload(['chromium', 'ffmpeg', 'firefox', 'webkit']);
expect(await installedSoftwareOnDisk()).toEqual(['chromium', 'ffmpeg', 'firefox', 'webkit']); expect(await installedSoftwareOnDisk()).toEqual(['chromium', 'ffmpeg', 'firefox', 'webkit']);

5
tests/installation/playwright-cdn-failover-should-work.spec.ts
View file

@ -35,13 +35,14 @@ const parsedDownloads = (rawLogs: string) => {
for (const cdn of CDNS) { for (const cdn of CDNS) {
test(`playwright cdn failover should work (${cdn})`, async ({ exec, nodeMajorVersion, installedSoftwareOnDisk }) => { test(`playwright cdn failover should work (${cdn})`, async ({ exec, nodeMajorVersion, installedSoftwareOnDisk }) => {
const result = await exec('npm i --foreground-scripts playwright', { env: { PW_TEST_CDN_THAT_SHOULD_WORK: cdn, DEBUG: 'pw:install' } }); await exec('npm i --foreground-scripts playwright');
const result = await exec('npx playwright install', { env: { PW_TEST_CDN_THAT_SHOULD_WORK: cdn, DEBUG: 'pw:install' } });
expect(result).toHaveLoggedSoftwareDownload(['chromium', 'ffmpeg', 'firefox', 'webkit']); expect(result).toHaveLoggedSoftwareDownload(['chromium', 'ffmpeg', 'firefox', 'webkit']);
expect(await installedSoftwareOnDisk()).toEqual(['chromium', 'ffmpeg', 'firefox', 'webkit']); expect(await installedSoftwareOnDisk()).toEqual(['chromium', 'ffmpeg', 'firefox', 'webkit']);
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) });
await exec('node sanity.js playwright'); await exec('node sanity.js playwright chromium firefox webkit');
if (nodeMajorVersion >= 14) if (nodeMajorVersion >= 14)
await exec('node esm-playwright.mjs'); await exec('node esm-playwright.mjs');
const stdio = await exec('npx playwright', 'test', '-c', '.', { expectToExitWithError: true }); const stdio = await exec('npx playwright', 'test', '-c', '.', { expectToExitWithError: true });

3
tests/installation/playwright-cdn-should-race-with-timeout.spec.ts
View file

@ -21,7 +21,8 @@ test(`playwright cdn should race with a timeout`, async ({ exec }) => {
const server = http.createServer(() => {}); const server = http.createServer(() => {});
await new Promise<void>(resolve => server.listen(0, resolve)); await new Promise<void>(resolve => server.listen(0, resolve));
try { try {
const result = await exec('npm i --foreground-scripts playwright', { await exec('npm i --foreground-scripts playwright');
const result = await exec('npx playwright install', {
env: { env: {
PLAYWRIGHT_DOWNLOAD_HOST: `http://127.0.0.1:${(server.address() as AddressInfo).port}`, PLAYWRIGHT_DOWNLOAD_HOST: `http://127.0.0.1:${(server.address() as AddressInfo).port}`,
DEBUG: 'pw:install', DEBUG: 'pw:install',

1
tests/installation/playwright-cli-codegen.spec.ts
View file

@ -17,6 +17,7 @@ import { test, expect } from './npmTest';
test('codegen should work', async ({ exec }) => { test('codegen should work', async ({ exec }) => {
await exec('npm i --foreground-scripts playwright'); await exec('npm i --foreground-scripts playwright');
await exec('npx playwright install chromium');
await test.step('codegen without arguments', async () => { await test.step('codegen without arguments', async () => {
const result = await exec('npx playwright codegen', { const result = await exec('npx playwright codegen', {

2
tests/installation/playwright-cli-install-should-work-with-languages.spec.ts
View file

@ -16,7 +16,7 @@
import { test, expect } from './npmTest'; import { test, expect } from './npmTest';
test('codegen should print the right install command without browsers', async ({ exec }) => { test('codegen should print the right install command without browsers', async ({ exec }) => {
await exec('npm i --foreground-scripts playwright', { env: { PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: '1' } }); await exec('npm i --foreground-scripts playwright');
const pwLangName2InstallCommand = { const pwLangName2InstallCommand = {
'java': 'mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="install"', 'java': 'mvn exec:java -e -D exec.mainClass=com.microsoft.playwright.CLI -D exec.args="install"',

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

@ -15,7 +15,7 @@
*/ */
import { test, expect } from './npmTest'; import { test, expect } from './npmTest';
test('codegen should work', async ({ exec, installedSoftwareOnDisk }) => { test('install command should work', async ({ exec, installedSoftwareOnDisk }) => {
await exec('npm i --foreground-scripts playwright', { env: { PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: '1' } }); await exec('npm i --foreground-scripts playwright', { env: { PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: '1' } });
await test.step('playwright install chromium', async () => { await test.step('playwright install chromium', async () => {
@ -30,12 +30,12 @@ test('codegen should work', async ({ exec, installedSoftwareOnDisk }) => {
expect(await installedSoftwareOnDisk()).toEqual(['chromium', 'ffmpeg', 'firefox', 'webkit']); expect(await installedSoftwareOnDisk()).toEqual(['chromium', 'ffmpeg', 'firefox', 'webkit']);
}); });
await exec('node sanity.js playwright none', { env: { PLAYWRIGHT_BROWSERS_PATH: undefined } }); await exec('node sanity.js playwright', { env: { PLAYWRIGHT_BROWSERS_PATH: undefined } });
await exec('node sanity.js playwright'); await exec('node sanity.js playwright chromium firefox webkit');
}); });
test('should be able to remove browsers', async ({ exec, installedSoftwareOnDisk }) => { test('should be able to remove browsers', async ({ exec, installedSoftwareOnDisk }) => {
await exec('npm i --foreground-scripts playwright', { env: { PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: '1' } }); await exec('npm i --foreground-scripts playwright');
await exec('npx playwright install chromium'); await exec('npx playwright install chromium');
expect(await installedSoftwareOnDisk()).toEqual(['chromium', 'ffmpeg']); expect(await installedSoftwareOnDisk()).toEqual(['chromium', 'ffmpeg']);
await exec('npx playwright uninstall'); await exec('npx playwright uninstall');

1
tests/installation/playwright-cli-screenshot-should-work.spec.ts
View file

@ -19,6 +19,7 @@ import path from 'path';
test('playwright cli screenshot should work', async ({ exec, tmpWorkspace }) => { test('playwright cli screenshot should work', async ({ exec, tmpWorkspace }) => {
await exec('npm i --foreground-scripts playwright'); await exec('npm i --foreground-scripts playwright');
await exec('npx playwright install chromium');
await exec(path.join('node_modules', '.bin', 'playwright'), 'screenshot about:blank one.png'); await exec(path.join('node_modules', '.bin', 'playwright'), 'screenshot about:blank one.png');
await fs.promises.stat(path.join(tmpWorkspace, 'one.png')); await fs.promises.stat(path.join(tmpWorkspace, 'one.png'));

2
tests/installation/playwright-electron-should-work.spec.ts
View file

@ -16,6 +16,6 @@
import { test } from './npmTest'; import { test } from './npmTest';
test('electron should work', async ({ exec }) => { test('electron should work', async ({ exec }) => {
await exec('npm i --foreground-scripts playwright electron@9.0', { env: { PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: '1' } }); await exec('npm i --foreground-scripts playwright electron@19.0.11');
await exec('node sanity-electron.js'); await exec('node sanity-electron.js');
}); });

4
tests/installation/playwright-global-installation-cross-package.spec.ts
View file

@ -19,10 +19,10 @@ test('global installation cross package', async ({ exec, installedSoftwareOnDisk
const packages = ['playwright-chromium', 'playwright-firefox', 'playwright-webkit']; const packages = ['playwright-chromium', 'playwright-firefox', 'playwright-webkit'];
for (const pkg of packages) for (const pkg of packages)
await exec('npm i --foreground-scripts', pkg, { env: { PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: '1' } }); await exec('npm i --foreground-scripts', pkg, { env: { PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: '1' } });
const result = await exec('npm i --foreground-scripts playwright'); const result = await exec('npx playwright install');
expect(result).toHaveLoggedSoftwareDownload(['chromium', 'ffmpeg', 'firefox', 'webkit']); expect(result).toHaveLoggedSoftwareDownload(['chromium', 'ffmpeg', 'firefox', 'webkit']);
expect(await installedSoftwareOnDisk()).toEqual(['chromium', 'ffmpeg', 'firefox', 'webkit']); expect(await installedSoftwareOnDisk()).toEqual(['chromium', 'ffmpeg', 'firefox', 'webkit']);
for (const pkg of packages) for (const pkg of packages)
await test.step(pkg, () => exec('node sanity.js', pkg, 'all')); await test.step(pkg, () => exec('node sanity.js', pkg, 'chromium firefox webkit'));
}); });

13
tests/installation/playwright-global-installation.spec.ts
View file

@ -16,9 +16,14 @@
import { test, expect } from './npmTest'; import { test, expect } from './npmTest';
test('global installation', async ({ exec, installedSoftwareOnDisk }) => { test('global installation', async ({ exec, installedSoftwareOnDisk }) => {
const result = await exec('npm i --foreground-scripts playwright'); const result1 = await exec('npm i --foreground-scripts playwright');
expect(result).toHaveLoggedSoftwareDownload(['chromium', 'ffmpeg', 'firefox', 'webkit']); expect(result1).toHaveLoggedSoftwareDownload([]);
expect(await installedSoftwareOnDisk()).toEqual([]);
const result2 = await exec('npx playwright install');
expect(result2).toHaveLoggedSoftwareDownload(['chromium', 'ffmpeg', 'firefox', 'webkit']);
expect(await installedSoftwareOnDisk()).toEqual(['chromium', 'ffmpeg', 'firefox', 'webkit']); expect(await installedSoftwareOnDisk()).toEqual(['chromium', 'ffmpeg', 'firefox', 'webkit']);
await exec('node sanity.js playwright none', { env: { PLAYWRIGHT_BROWSERS_PATH: undefined } });
await exec('node sanity.js playwright'); await exec('node sanity.js playwright', { env: { PLAYWRIGHT_BROWSERS_PATH: undefined } });
await exec('node sanity.js playwright chromium firefox webkit');
}); });

4
tests/installation/playwright-global-subsequent-installs.spec.ts
View file

@ -18,11 +18,11 @@ import path from 'path';
test('subsequent installs works', async ({ exec }) => { test('subsequent installs works', async ({ exec }) => {
test.info().annotations.push({ type: 'issue', description: 'https://github.com/microsoft/playwright/issues/1651' }); test.info().annotations.push({ type: 'issue', description: 'https://github.com/microsoft/playwright/issues/1651' });
await exec('npm i --foreground-scripts playwright'); await exec('npm i --foreground-scripts @playwright/browser-chromium');
// Note: the `npm install` would not actually crash, the error // Note: the `npm install` would not actually crash, the error
// is merely logged to the console. To reproduce the error, we should make // is merely logged to the console. To reproduce the error, we should make
// sure that script's install.js can be run subsequently without unhandled promise rejections. // sure that script's install.js can be run subsequently without unhandled promise rejections.
// Note: the flag `--unhandled-rejections=strict` will force node to terminate in case // Note: the flag `--unhandled-rejections=strict` will force node to terminate in case
// of UnhandledPromiseRejection. // of UnhandledPromiseRejection.
await exec('node --unhandled-rejections=strict', path.join('node_modules', 'playwright', 'install.js')); await exec('node --unhandled-rejections=strict', path.join('node_modules', '@playwright', 'browser-chromium', 'install.js'));
}); });

3
tests/installation/playwright-should-work-with-relative-browsers-path.spec.ts
View file

@ -21,5 +21,6 @@ test('playwright should work with relative home path', async ({ exec, tmpWorkspa
await fs.promises.mkdir(path.join(tmpWorkspace, 'foo')); await fs.promises.mkdir(path.join(tmpWorkspace, 'foo'));
// Make sure that browsers path is resolved relative to the `npm install` call location. // Make sure that browsers path is resolved relative to the `npm install` call location.
await exec('npm i --foreground-scripts playwright', { cwd: path.join(tmpWorkspace, 'foo'), env: { PLAYWRIGHT_BROWSERS_PATH: path.join('..', 'relative') } }); await exec('npm i --foreground-scripts playwright', { cwd: path.join(tmpWorkspace, 'foo'), env: { PLAYWRIGHT_BROWSERS_PATH: path.join('..', 'relative') } });
await exec('node sanity.js playwright', { env: { PLAYWRIGHT_BROWSERS_PATH: path.join('.', 'relative') } }); await exec('npx playwright install', { cwd: path.join(tmpWorkspace, 'foo'), env: { PLAYWRIGHT_BROWSERS_PATH: path.join('..', 'relative') } });
await exec('node sanity.js playwright chromium firefox webkit', { env: { PLAYWRIGHT_BROWSERS_PATH: path.join('.', 'relative') } });
}); });

2
tests/installation/playwright-should-work-with-relative-home-path.spec.ts
View file

@ -20,7 +20,7 @@ test('playwright should work with relative home path', async ({ exec }) => {
test.skip(os.platform().startsWith('win')); test.skip(os.platform().startsWith('win'));
const env = { PLAYWRIGHT_BROWSERS_PATH: '0', HOME: '.' }; const env = { PLAYWRIGHT_BROWSERS_PATH: '0', HOME: '.' };
await exec('npm i --foreground-scripts playwright', { env }); await exec('npm i --foreground-scripts playwright @playwright/browser-chromium @playwright/browser-webkit', { env });
// Firefox does not work with relative HOME. // Firefox does not work with relative HOME.
await exec('node sanity.js playwright chromium webkit', { env }); await exec('node sanity.js playwright chromium webkit', { env });
}); });

11
tests/installation/playwright-should-work.spec.ts
View file

@ -16,10 +16,15 @@
import { test, expect } from './npmTest'; import { test, expect } from './npmTest';
test(`playwright should work`, async ({ exec, nodeMajorVersion, installedSoftwareOnDisk }) => { test(`playwright should work`, async ({ exec, nodeMajorVersion, installedSoftwareOnDisk }) => {
const result = await exec('npm i --foreground-scripts playwright'); const result1 = await exec('npm i --foreground-scripts playwright');
expect(result).toHaveLoggedSoftwareDownload(['chromium', 'ffmpeg', 'firefox', 'webkit']); expect(result1).toHaveLoggedSoftwareDownload([]);
expect(await installedSoftwareOnDisk()).toEqual([]);
const result2 = await exec('npm i --foreground-scripts @playwright/browser-chromium @playwright/browser-firefox @playwright/browser-webkit');
expect(result2).toHaveLoggedSoftwareDownload(['chromium', 'ffmpeg', 'firefox', 'webkit']);
expect(await installedSoftwareOnDisk()).toEqual(['chromium', 'ffmpeg', 'firefox', 'webkit']); expect(await installedSoftwareOnDisk()).toEqual(['chromium', 'ffmpeg', 'firefox', 'webkit']);
await exec('node sanity.js playwright');
await exec('node sanity.js playwright chromium firefox webkit');
if (nodeMajorVersion >= 14) if (nodeMajorVersion >= 14)
await exec('node esm-playwright.mjs'); await exec('node esm-playwright.mjs');
const stdio = await exec('npx playwright', 'test', '-c', '.', { expectToExitWithError: true }); const stdio = await exec('npx playwright', 'test', '-c', '.', { expectToExitWithError: true });

2
tests/installation/playwright-test-should-work.spec.ts
View file

@ -23,7 +23,7 @@ test('@playwright/test should work', async ({ exec, nodeMajorVersion, tmpWorkspa
await exec('npx playwright install'); await exec('npx playwright install');
await exec('npx playwright test -c . --browser=all --reporter=list,json sample.spec.js', { env: { PLAYWRIGHT_JSON_OUTPUT_NAME: 'report.json' } }); await exec('npx playwright test -c . --browser=all --reporter=list,json sample.spec.js', { env: { PLAYWRIGHT_JSON_OUTPUT_NAME: 'report.json' } });
await exec('node read-json-report.js', path.join(tmpWorkspace, 'report.json')); await exec('node read-json-report.js', path.join(tmpWorkspace, 'report.json'));
await exec('node sanity.js @playwright/test'); await exec('node sanity.js @playwright/test chromium firefox webkit');
if (nodeMajorVersion >= 14) if (nodeMajorVersion >= 14)
await exec('node', 'esm-playwright-test.mjs'); await exec('node', 'esm-playwright-test.mjs');
}); });

28
tests/installation/playwright-xyz-should-work.spec.ts
View file

@ -16,8 +16,9 @@
*/ */
import { test, expect } from './npmTest'; import { test, expect } from './npmTest';
for (const pkg of ['playwright-chromium', 'playwright-firefox', 'playwright-webkit']) { for (const browser of ['chromium', 'firefox', 'webkit']) {
test(`${pkg} should work`, async ({ exec, nodeMajorVersion, installedSoftwareOnDisk }) => { test(`playwright-${browser} should work`, async ({ exec, nodeMajorVersion, installedSoftwareOnDisk }) => {
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];
@ -26,8 +27,29 @@ for (const pkg of ['playwright-chromium', 'playwright-firefox', 'playwright-webk
expect(result).toHaveLoggedSoftwareDownload(expectedSoftware as any); expect(result).toHaveLoggedSoftwareDownload(expectedSoftware as any);
expect(await installedSoftwareOnDisk()).toEqual(expectedSoftware); expect(await installedSoftwareOnDisk()).toEqual(expectedSoftware);
expect(result).not.toContain(`To avoid unexpected behavior, please install your dependencies first`); expect(result).not.toContain(`To avoid unexpected behavior, please install your dependencies first`);
await exec('node sanity.js', pkg); await exec('node sanity.js', pkg, browser);
if (nodeMajorVersion >= 14) if (nodeMajorVersion >= 14)
await exec('node', `esm-${pkg}.mjs`); await exec('node', `esm-${pkg}.mjs`);
}); });
} }
for (const browser of ['chromium', 'firefox', 'webkit']) {
test(`@playwright/browser-${browser} should work`, async ({ exec, installedSoftwareOnDisk }) => {
const pkg = `@playwright/browser-${browser}`;
const expectedSoftware = [browser];
if (browser === 'chromium')
expectedSoftware.push('ffmpeg');
const result1 = await exec('npm i --foreground-scripts', pkg);
expect(result1).toHaveLoggedSoftwareDownload(expectedSoftware as any);
expect(await installedSoftwareOnDisk()).toEqual(expectedSoftware);
expect(result1).not.toContain(`To avoid unexpected behavior, please install your dependencies first`);
const result2 = await exec('npm i --foreground-scripts playwright');
expect(result2).toHaveLoggedSoftwareDownload([]);
expect(await installedSoftwareOnDisk()).toEqual(expectedSoftware);
await exec('node sanity.js playwright', browser);
await exec('node browser-only.js', pkg);
});
}

8
tests/installation/screencast.spec.ts
View file

@ -16,8 +16,8 @@
import { test } from './npmTest'; import { test } from './npmTest';
test('screencast works', async ({ exec }) => { test('screencast works', async ({ exec }) => {
const packages = ['playwright', 'playwright-chromium', 'playwright-firefox', 'playwright-webkit']; await exec('npm i --foreground-scripts', 'playwright', 'playwright-chromium', 'playwright-firefox', 'playwright-webkit');
await exec('npm i --foreground-scripts', ...packages); await test.step('playwright', () => exec('node screencast.js playwright chromium firefox webkit'));
for (const pkg of packages) for (const browser of ['chromium', 'firefox', 'webkit'])
await test.step(pkg, () => exec('node screencast.js', pkg)); await test.step(browser, () => exec(`node screencast.js playwright-${browser} ${browser}`));
}); });

2
tests/installation/skip-browser-download-inspect-with-custom-executable.spec.ts
View file

@ -16,7 +16,7 @@
import { test, expect } from './npmTest'; import { test, expect } from './npmTest';
test('should skip download', async ({ exec }) => { test('should skip download', async ({ exec }) => {
const installOutput = await exec('npm i --foreground-scripts playwright', { env: { PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: '1' } }); const installOutput = await exec('npm i --foreground-scripts playwright @playwright/browser-chromium', { env: { PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: '1' } });
expect(installOutput).toContain('Skipping browsers download because'); expect(installOutput).toContain('Skipping browsers download because');
if (process.platform === 'linux') { if (process.platform === 'linux') {
const output = await exec('node inspector-custom-executable.js', { env: { PWDEBUG: '1' } }); const output = await exec('node inspector-custom-executable.js', { env: { PWDEBUG: '1' } });

2
tests/installation/skip-browser-download.spec.ts
View file

@ -16,7 +16,7 @@
import { test, expect } from './npmTest'; import { test, expect } from './npmTest';
test('PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD should skip browser installs', async ({ exec, installedSoftwareOnDisk }) => { test('PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD should skip browser installs', async ({ exec, installedSoftwareOnDisk }) => {
const result = await exec('npm i --foreground-scripts playwright', { env: { PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: '1' } }); const result = await exec('npm i --foreground-scripts @playwright/browser-firefox', { env: { PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: '1' } });
expect(result).toHaveLoggedSoftwareDownload([]); expect(result).toHaveLoggedSoftwareDownload([]);
expect(await installedSoftwareOnDisk()).toEqual([]); expect(await installedSoftwareOnDisk()).toEqual([]);
expect(result).toContain(`Skipping browsers download because`); expect(result).toContain(`Skipping browsers download because`);

2
tests/installation/validate-dependencies.spec.ts
View file

@ -18,12 +18,14 @@ import { test, expect } from './npmTest';
test.describe('validate dependencies', () => { test.describe('validate dependencies', () => {
test('default (on)', async ({ exec }) => { test('default (on)', async ({ exec }) => {
await exec('npm i --foreground-scripts playwright'); await exec('npm i --foreground-scripts playwright');
await exec('npx playwright install chromium');
const result = await exec('node validate-dependencies.js'); const result = await exec('node validate-dependencies.js');
expect(result).toContain(`PLAYWRIGHT_SKIP_VALIDATE_HOST_REQUIREMENTS`); expect(result).toContain(`PLAYWRIGHT_SKIP_VALIDATE_HOST_REQUIREMENTS`);
}); });
test('disabled (off)', async ({ exec }) => { test('disabled (off)', async ({ exec }) => {
await exec('npm i --foreground-scripts playwright'); await exec('npm i --foreground-scripts playwright');
await exec('npx playwright install chromium');
const result = await exec('node validate-dependencies-skip-executable-path.js'); const result = await exec('node validate-dependencies-skip-executable-path.js');
expect(result).not.toContain(`PLAYWRIGHT_SKIP_VALIDATE_HOST_REQUIREMENTS`); expect(result).not.toContain(`PLAYWRIGHT_SKIP_VALIDATE_HOST_REQUIREMENTS`);
}); });

15
utils/workspace.js
View file

@ -178,6 +178,21 @@ const workspace = new Workspace(ROOT_PATH, [
path: path.join(ROOT_PATH, 'packages', 'playwright-chromium'), path: path.join(ROOT_PATH, 'packages', 'playwright-chromium'),
files: LICENCE_FILES, files: LICENCE_FILES,
}), }),
new PWPackage({
name: '@playwright/browser-webkit',
path: path.join(ROOT_PATH, 'packages', 'playwright-browser-webkit'),
files: LICENCE_FILES,
}),
new PWPackage({
name: '@playwright/browser-firefox',
path: path.join(ROOT_PATH, 'packages', 'playwright-browser-firefox'),
files: LICENCE_FILES,
}),
new PWPackage({
name: '@playwright/browser-chromium',
path: path.join(ROOT_PATH, 'packages', 'playwright-browser-chromium'),
files: LICENCE_FILES,
}),
new PWPackage({ new PWPackage({
name: '@playwright/experimental-ct-core', name: '@playwright/experimental-ct-core',
path: path.join(ROOT_PATH, 'packages', 'playwright-ct-core'), path: path.join(ROOT_PATH, 'packages', 'playwright-ct-core'),