Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove the docs for Playwright config override #49660

Merged
merged 1 commit into from
Apr 8, 2023
Merged

Remove the docs for Playwright config override #49660

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 0 additions & 42 deletions docs/contributors/code/e2e/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,45 +114,3 @@ test.describe( 'Grouping tests (@webkit, -chromium)', () => {
} );
} );
```

## Local configuration of Playwright

Sometimes the deafults that Gutenberg offers for Playwright configuration need to be changed. While most configuration can be overriden by passing arguments to the test runner command line, we may want to make permanent confguration changes, such as setting the test to always run with `headless` mode set to `false` and you own custom slow motion value.

To do this one can create a file named `playwright.config.override.ts` file in the `/test/e2e/` folder. In this new file we need to import the exiting configuration, then use the new values on top to override the defaults.

For example:

```ts
/**
* External dependencies
*/
import { defineConfig } from '@playwright/test';
/**
* Internal dependencies
*/
import base from './playwright.config.ts';

const config = defineConfig( {
...base,
use: {
...base.use,
headless: true,
launchOptions: {
//slowMo: 500,
},
trace: 'off',
screenshot: 'off',
video: 'off',
},
} );

export default config;

```

After making this file you can now run your tests passing the new configuration file with the `--config` argument:

```bash
npm run test:e2e:playwright -- --config=test/e2e/playwright.override.config.ts
```