mirror of
https://github.com/microsoft/playwright.git
synced 2025-06-26 21:40:17 +00:00
191 lines
6.2 KiB
Markdown
191 lines
6.2 KiB
Markdown
![]() |
---
|
|||
|
id: test-projects
|
|||
|
title: "Projects"
|
|||
|
---
|
|||
|
|
|||
|
A project is logical group of tests running with the same configuration. We use projects so we can run tests on different browsers and devices. Projects are configured in the `playwright.config.ts` file and once configured you can then run your tests on all projects or only on a specific project. You can also use projects to run the same tests in different configurations. For example, you can run the same tests in a logged-in and logged-out state.
|
|||
|
|
|||
|
By setting up projects you can also run a group of tests with different timeouts or retries or a group of tests against different environments such as staging and production, splitting tests per package/functionality and more.
|
|||
|
|
|||
|
## Configure projects for multiple browsers
|
|||
|
|
|||
|
By using **projects** you can run your tests in multiple browsers such as chromium, webkit and firefox as well as branded browsers such as Google Chrome and Microsoft Edge. Playwright can also run on emulated tablet and mobile devices. See the [registry of device parameters](https://github.com/microsoft/playwright/blob/main/packages/playwright-core/src/server/deviceDescriptorsSource.json) for a complete list of selected desktop, tablet and mobile devices.
|
|||
|
|
|||
|
```js
|
|||
|
import { defineConfig, devices } from '@playwright/test';
|
|||
|
|
|||
|
export default defineConfig({
|
|||
|
projects: [
|
|||
|
{
|
|||
|
name: 'chromium',
|
|||
|
use: { ...devices['Desktop Chrome'] },
|
|||
|
},
|
|||
|
|
|||
|
{
|
|||
|
name: 'firefox',
|
|||
|
use: { ...devices['Desktop Firefox'] },
|
|||
|
},
|
|||
|
|
|||
|
{
|
|||
|
name: 'webkit',
|
|||
|
use: { ...devices['Desktop Safari'] },
|
|||
|
},
|
|||
|
|
|||
|
/* Test against mobile viewports. */
|
|||
|
{
|
|||
|
name: 'Mobile Chrome',
|
|||
|
use: { ...devices['Pixel 5'] },
|
|||
|
},
|
|||
|
{
|
|||
|
name: 'Mobile Safari',
|
|||
|
use: { ...devices['iPhone 12'] },
|
|||
|
},
|
|||
|
|
|||
|
/* Test against branded browsers. */
|
|||
|
{
|
|||
|
name: 'Microsoft Edge',
|
|||
|
use: {
|
|||
|
...devices['Desktop Edge'],
|
|||
|
channel: 'msedge'
|
|||
|
},
|
|||
|
},
|
|||
|
{
|
|||
|
name: 'Google Chrome',
|
|||
|
use: {
|
|||
|
...devices['Desktop Chrome'],
|
|||
|
channel: 'chrome'
|
|||
|
},
|
|||
|
},
|
|||
|
],
|
|||
|
});
|
|||
|
```
|
|||
|
|
|||
|
## Run projects
|
|||
|
|
|||
|
Playwright will run all projects by default.
|
|||
|
|
|||
|
```bash
|
|||
|
npx playwright test
|
|||
|
|
|||
|
Running 7 tests using 5 workers
|
|||
|
|
|||
|
✓ [chromium] › example.spec.ts:3:1 › basic test (2s)
|
|||
|
✓ [firefox] › example.spec.ts:3:1 › basic test (2s)
|
|||
|
✓ [webkit] › example.spec.ts:3:1 › basic test (2s)
|
|||
|
✓ [Mobile Chrome] › example.spec.ts:3:1 › basic test (2s)
|
|||
|
✓ [Mobile Safari] › example.spec.ts:3:1 › basic test (2s)
|
|||
|
✓ [Microsoft Edge] › example.spec.ts:3:1 › basic test (2s)
|
|||
|
✓ [Google Chrome] › example.spec.ts:3:1 › basic test (2s)
|
|||
|
```
|
|||
|
|
|||
|
Use the `--project` command line option to run a single project.
|
|||
|
|
|||
|
```bash
|
|||
|
npx playwright test --project=firefox
|
|||
|
|
|||
|
Running 1 test using 1 worker
|
|||
|
|
|||
|
✓ [firefox] › example.spec.ts:3:1 › basic test (2s)
|
|||
|
```
|
|||
|
|
|||
|
The VS Code test runner runs your tests on the default browser of Chrome. To run on other/multiple browsers click the play button's dropdown from the testing sidebar and choose another profile or modify the default profile by clicking **Select Default Profile** and select the browsers you wish to run your tests on.
|
|||
|
|
|||
|
<img width="1464" alt="selecting browsers" src="https://user-images.githubusercontent.com/13063165/221136731-9d4bc18f-38a4-4adb-997b-5b98c98aec7f.png" />
|
|||
|
|
|||
|
Choose a specific profile, various profiles or all profiles to run tests on.
|
|||
|
|
|||
|
<img width="1536" alt="choosing default profiles" src="https://user-images.githubusercontent.com/13063165/221669537-e5df8672-f50d-4ff1-96f9-141cd67e12f8.png" />
|
|||
|
|
|||
|
|
|||
|
## Configure projects for multiple environments
|
|||
|
|
|||
|
By setting up projects we can also run a group of tests with different timeouts or retries or run a group of tests against different environments. For example we can run our tests against a staging environment with 2 retries as well as against a production environment with 0 retries.
|
|||
|
|
|||
|
```js
|
|||
|
import { defineConfig } from '@playwright/test';
|
|||
|
|
|||
|
export default defineConfig({
|
|||
|
timeout: 60000, // Timeout is shared between all tests.
|
|||
|
projects: [
|
|||
|
{
|
|||
|
name: 'staging',
|
|||
|
use: {
|
|||
|
baseURL: 'staging.example.com',
|
|||
|
}
|
|||
|
retries: 2,
|
|||
|
},
|
|||
|
{
|
|||
|
name: 'production',
|
|||
|
use: {
|
|||
|
baseURL: 'production.example.com',
|
|||
|
}
|
|||
|
retries: 0,
|
|||
|
},
|
|||
|
],
|
|||
|
});
|
|||
|
```
|
|||
|
|
|||
|
## Splitting tests into projects
|
|||
|
|
|||
|
We can split tests into projects and use filters to run a subset of tests. For example, we can create a project that runs tests using a filter matching all tests with a specific file name. We can then have another group of tests that ignore specific test files.
|
|||
|
|
|||
|
Here is an example that defines a common timeout and two projects. The "Smoke" project runs a small subset of tests without retries, and "Default" project runs all other tests with retries.
|
|||
|
|
|||
|
```js
|
|||
|
import { defineConfig } from '@playwright/test';
|
|||
|
|
|||
|
export default defineConfig({
|
|||
|
timeout: 60000, // Timeout is shared between all tests.
|
|||
|
projects: [
|
|||
|
{
|
|||
|
name: 'Smoke',
|
|||
|
testMatch: /.*smoke.spec.ts/,
|
|||
|
retries: 0,
|
|||
|
},
|
|||
|
{
|
|||
|
name: 'Default',
|
|||
|
testIgnore: /.*smoke.spec.ts/,
|
|||
|
retries: 2,
|
|||
|
},
|
|||
|
],
|
|||
|
});
|
|||
|
```
|
|||
|
## Dependencies
|
|||
|
|
|||
|
Dependencies are a list of projects that need to run before the tests in another project run. They can be useful for configuring the global setup actions so that one project depends on this running first. Using dependencies allows global setup to produce traces and other artifacts.
|
|||
|
|
|||
|
In this example the chromium, firefox and webkit projects depend on the setup project.
|
|||
|
|
|||
|
```js
|
|||
|
// playwright.config.ts
|
|||
|
import { defineConfig } from '@playwright/test';
|
|||
|
|
|||
|
export default defineConfig({
|
|||
|
projects: [
|
|||
|
{
|
|||
|
name: 'setup',
|
|||
|
testMatch: /global.setup\.ts/,
|
|||
|
},
|
|||
|
{
|
|||
|
name: 'chromium',
|
|||
|
use: { ...devices['Desktop Chrome'] },
|
|||
|
dependencies: ['setup'],
|
|||
|
},
|
|||
|
{
|
|||
|
name: 'firefox',
|
|||
|
use: { ...devices['Desktop Firefox'] },
|
|||
|
dependencies: ['setup'],
|
|||
|
},
|
|||
|
{
|
|||
|
name: 'webkit',
|
|||
|
use: { ...devices['Desktop Safari'] },
|
|||
|
dependencies: ['setup'],
|
|||
|
},
|
|||
|
],
|
|||
|
});
|
|||
|
```
|
|||
|
|
|||
|
## Custom project parameters
|
|||
|
|
|||
|
Projects can be also used to parametrize tests with your custom configuration - take a look at [this separate guide](./test-parameterize.md#parameterized-projects).
|