cherry-pick: ToT docs changes (#15838)
This cherry-picks the following changes:267614341cc65b5171d49fda46822cd34830c96f33f45e3f536d883deb69dcb83d9db02996f4bbb5a2d2865f0509debb4a55311580bcec2de0624a5e93d8e7ae4a
This commit is contained in:
Max Schmitt
GitHub
parent
a8937f5b83
commit
03380d6e34
|
|
@ -114,7 +114,7 @@ def test_should_create_feature_request(api_request_context: APIRequestContext) -
|
|||
|
||||
### Setup and teardown
|
||||
|
||||
These tests assume that repository exists. You probably want to create a new one before running tests and delete it afterwards. Use a [session fixture](https://docs.pytest.org/en/6.2.x/fixture.html#fixture-scopes) for that. The part before `yield` is the before all and after is the after all.
|
||||
These tests assume that repository exists. You probably want to create a new one before running tests and delete it afterwards. Use a [session fixture](https://docs.pytest.org/en/stable/fixture.html#fixture-scopes) for that. The part before `yield` is the before all and after is the after all.
|
||||
|
||||
```python
|
||||
# ...
|
||||
|
|
|
|||
|
|
@ -472,7 +472,7 @@ rowLocator
|
|||
.screenshot();
|
||||
```
|
||||
```python async
|
||||
row_locator = page.lsocator("tr")
|
||||
row_locator = page.locator("tr")
|
||||
# ...
|
||||
await row_locator
|
||||
.filter(has_text="text in column 1")
|
||||
|
|
@ -480,7 +480,7 @@ await row_locator
|
|||
.screenshot()
|
||||
```
|
||||
```python sync
|
||||
row_locator = page.lsocator("tr")
|
||||
row_locator = page.locator("tr")
|
||||
# ...
|
||||
row_locator
|
||||
.filter(has_text="text in column 1")
|
||||
|
|
|
|||
|
|
@ -148,14 +148,48 @@ var context = await browser.NewContextAsync(new()
|
|||
```
|
||||
|
||||
### Code generation
|
||||
* langs: js
|
||||
|
||||
Logging in via the UI and then reusing authentication state can be combined to
|
||||
implement **login once and run multiple scenarios**. The lifecycle looks like:
|
||||
|
||||
1. Run tests (for example, with `npm run test`).
|
||||
1. Login via UI and retrieve authentication state.
|
||||
2. Login via UI and retrieve authentication state.
|
||||
* In Jest, this can be executed in [`globalSetup`](https://jestjs.io/docs/en/configuration#globalsetup-string).
|
||||
1. In each test, load authentication state in `beforeEach` or `beforeAll` step.
|
||||
3. In each test, load authentication state in `beforeEach` or `beforeAll` step.
|
||||
|
||||
This approach will also **work in CI environments**, since it does not rely on any external state.
|
||||
|
||||
### Code generation
|
||||
* langs: python
|
||||
|
||||
Logging in via the UI and then reusing authentication state can be combined to implement **login once and run multiple scenarios**. The lifecycle looks like:
|
||||
|
||||
1. Run tests (for example, with `pytest`).
|
||||
2. Login via UI and retrieve authentication state.
|
||||
3. In each test, load authentication state using `autouse=True` fixture with `scope=function`.
|
||||
|
||||
This approach will also **work in CI environments**, since it does not rely on any external state.
|
||||
|
||||
### Code generation
|
||||
* langs: csharp
|
||||
|
||||
Logging in via the UI and then reusing authentication state can be combined to implement **login once and run multiple scenarios**. The lifecycle looks like:
|
||||
|
||||
1. Run tests (for example, with `dotnet test`).
|
||||
2. Login via UI and retrieve authentication state.
|
||||
3. In each test, load authentication state in `SetUp`.
|
||||
|
||||
This approach will also **work in CI environments**, since it does not rely on any external state.
|
||||
|
||||
### Code generation
|
||||
* langs: java
|
||||
|
||||
Logging in via the UI and then reusing authentication state can be combined to implement **login once and run multiple scenarios**. The lifecycle looks like:
|
||||
|
||||
1. Run tests (for example, with `mvn test`).
|
||||
2. Login via UI and retrieve authentication state.
|
||||
3. In each test, load authentication state in `@beforeEach` or `@beforeAll` step.
|
||||
|
||||
This approach will also **work in CI environments**, since it does not rely on any external state.
|
||||
|
||||
|
|
|
|||
|
|
@ -157,6 +157,19 @@ See all supported browsers:
|
|||
pwsh bin\Debug\netX\playwright.ps1 install --help
|
||||
```
|
||||
|
||||
## Install browsers via API
|
||||
* langs: csharp
|
||||
|
||||
It's possible to run [Command line tools](./cli.md) commands via the .NET API:
|
||||
|
||||
```csharp
|
||||
var exitCode = Microsoft.Playwright.Program.Main(new[] {"install"});
|
||||
if (exitCode != 0)
|
||||
{
|
||||
throw new Exception($"Playwright exited with code {exitCode}");
|
||||
}
|
||||
```
|
||||
|
||||
## Managing browser binaries
|
||||
|
||||
Playwright downloads Chromium, WebKit and Firefox browsers into the OS-specific cache folders:
|
||||
|
|
|
|||
|
|
@ -85,7 +85,7 @@ pwsh bin\Debug\netX\playwright.ps1 codegen --load-storage=auth.json my.web.app
|
|||
If you would like to use codegen in some non-standard setup (for example, use [`method: BrowserContext.route`]), it is possible to call [`method: Page.pause`] that will open a separate window with codegen controls.
|
||||
|
||||
```js
|
||||
const { chromium } = require('playwright');
|
||||
const { chromium } = require('@playwright/test');
|
||||
|
||||
(async () => {
|
||||
// Make sure to run headed.
|
||||
|
|
|
|||
|
|
@ -27,7 +27,9 @@ const [ download ] = await Promise.all([
|
|||
page.locator('button#delayed-download').click(),
|
||||
]);
|
||||
// Wait for the download process to complete
|
||||
const path = await download.path();
|
||||
console.log(await download.path());
|
||||
// Save downloaded file somewhere
|
||||
await download.saveAs('/path/to/save/download/at.txt');
|
||||
```
|
||||
|
||||
```java
|
||||
|
|
@ -38,6 +40,9 @@ Download download = page.waitForDownload(() -> {
|
|||
});
|
||||
// Wait for the download process to complete
|
||||
Path path = download.path();
|
||||
System.out.println(download.path());
|
||||
// Save downloaded file somewhere
|
||||
download.saveAs(Paths.get("/path/to/save/download/at.txt"));
|
||||
```
|
||||
|
||||
```python async
|
||||
|
|
@ -47,7 +52,9 @@ async with page.expect_download() as download_info:
|
|||
await page.locator("button#delayed-download").click()
|
||||
download = await download_info.value
|
||||
# Wait for the download process to complete
|
||||
path = await download.path()
|
||||
print(await download.path())
|
||||
# Save downloaded file somewhere
|
||||
download.save_as("/path/to/save/download/at.txt")
|
||||
```
|
||||
|
||||
```python sync
|
||||
|
|
@ -57,7 +64,9 @@ with page.expect_download() as download_info:
|
|||
page.locator("button#delayed-download").click()
|
||||
download = download_info.value
|
||||
# Wait for the download process to complete
|
||||
path = download.path()
|
||||
print(download.path())
|
||||
# Save downloaded file somewhere
|
||||
download.save_as("/path/to/save/download/at.txt")
|
||||
```
|
||||
|
||||
```csharp
|
||||
|
|
@ -67,7 +76,9 @@ var waitForDownloadTask = page.WaitForDownloadAsync();
|
|||
await page.Locator("#downloadButton").ClickAsync();
|
||||
// Wait for the download process to complete
|
||||
var download = await waitForDownloadTask;
|
||||
var path = await download.PathAsync();
|
||||
Console.WriteLine(await download.PathAsync());
|
||||
// Save downloaded file somewhere
|
||||
await download.SaveAsAsync("/path/to/save/download/at.txt");
|
||||
```
|
||||
|
||||
#### Variations
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ title: "Getting started - VS Code"
|
|||
|
||||
Playwright Test was created specifically to accommodate the needs of end-to-end testing. Playwright supports all modern rendering engines including Chromium, WebKit, and Firefox. Test on Windows, Linux, and macOS, locally or on CI, headless or headed with native mobile emulation of Google Chrome for Android and Mobile Safari.
|
||||
|
||||
Get started by installing Playwright and generating a test to see it in action.
|
||||
Get started by installing Playwright and generating a test to see it in action. Alternatively you can also get started and run your tests using the [CLI](./intro.md).
|
||||
|
||||
## Installation
|
||||
|
||||
|
|
@ -13,19 +13,30 @@ Install the [VS Code extension from the marketplace](https://marketplace.visuals
|
|||
|
||||
<img width="535" alt="image" src="https://user-images.githubusercontent.com/13063165/177198887-de49ec12-a7a9-48c2-8d02-ad53ea312c91.png"></img>
|
||||
|
||||
Once installed, open the command panel and type "Install Playwright" and select "Test: Install Playwright". Choose the browsers you would like to run your tests on. These can be later configured in the [playwright.config file](./test-configuration.md) file.
|
||||
Once installed, open the command panel and type:
|
||||
|
||||
```bash
|
||||
Install Playwright
|
||||
```
|
||||
|
||||
<img width="538" alt="image" src="https://user-images.githubusercontent.com/13063165/177199115-ce90eb84-f12a-4b95-bd3a-17ff870fcec2.png"></img>
|
||||
|
||||
Select "Test: Install Playwright" and Choose the browsers you would like to run your tests on. These can be later configured in the [playwright.config file](./test-configuration.md) file. You can also choose if you would like to have a GitHub Actions setup to run your tests on CI.
|
||||
|
||||
## Generating Tests with Codegen
|
||||
|
||||
[CodeGen](./codegen.md) will auto generate your tests for you and is a great way to quickly get started. Click on the Testing icon in the left menu to open the testing sidebar. To record a test click on the record icon. This will create a `test-1.spec.ts` file as well as open up a browser window. As you record your user actions your test code will be generated in the newly created file.
|
||||
[CodeGen](./codegen.md) will auto generate your tests for you and is a great way to quickly get started. Click on the Testing icon in the left menu to open the testing sidebar.
|
||||
|
||||
### Recording a Test
|
||||
|
||||
To record a test click on the record icon. This will create a `test-1.spec.ts` file as well as open up a browser window.
|
||||
|
||||
<img width="810" alt="image" src="https://user-images.githubusercontent.com/13063165/177197869-40b32235-ae7c-4a6e-8b7e-e69aea17ea1b.png"></img>
|
||||
|
||||
As you hover over an element Playwright will highlight the element with the [selector](./selectors.md) shown underneath it. If you click the element [CodeGen](./codegen.md) will generate the test for you in the test file that was created.
|
||||
### Generating a Test
|
||||
|
||||
As you interact with the page Codegen will generate the test for you in the newly created file in VS Code. When you hover over an element Playwright will highlight the element and show the [selector](./selectors.md) underneath it.
|
||||
|
||||
<img width="958" alt="image" src="https://user-images.githubusercontent.com/13063165/177199982-42dc316f-3438-48b1-a6a6-417be77be658.png"></img>
|
||||
|
||||
|
||||
|
|
@ -35,14 +46,20 @@ You can run a single test by clicking the green triangle next to your test block
|
|||
|
||||
<img width="813" alt="image" src="https://user-images.githubusercontent.com/13063165/177201109-e0a17553-88cc-496e-a717-9a60247db935.png"></img>
|
||||
|
||||
### View All Tests
|
||||
|
||||
View all tests in the testing sidebar and extend the tests by clicking on each test. Tests that have not been run will not have the green check next to them.
|
||||
|
||||
<img width="812" alt="image" src="https://user-images.githubusercontent.com/13063165/177201231-f26e11da-2860-43fa-9a31-b04bba55d52e.png" />
|
||||
|
||||
### Run All Tests
|
||||
|
||||
Run all tests by clicking on the white triangle as you hover over the tests in the testing sidebar.
|
||||
|
||||
<img width="252" alt="image" src="https://user-images.githubusercontent.com/13063165/178029941-d9555c43-0966-4699-8739-612a9664e604.png" />
|
||||
|
||||
### Run Tests on Specific Browsers
|
||||
|
||||
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 and choose the option of "Select Default Profile" and select the browsers you wish to run your tests on.
|
||||
|
||||
<img width="506" alt="image" src="https://user-images.githubusercontent.com/13063165/178030111-3c422349-a501-4190-9ad6-ec0bdc187b9e.png" />
|
||||
|
|
@ -53,7 +70,14 @@ With the VS Code extension you can debug your tests right in VS Code see error m
|
|||
|
||||
<img width="1025" alt="image" src="https://user-images.githubusercontent.com/13063165/178027941-0d9d5f88-2426-43fb-b204-62a2add27415.png" />
|
||||
|
||||
Modify your test right in VS Code while debugging and Playwright will highlight the selector you are modifying in the browser. You can step through the tests, pause the test and rerun the tests from the menu in VS Code.
|
||||
### Live Debugging with VS Code
|
||||
|
||||
Modify your test right in VS Code while debugging and Playwright Test will highlight the selector you are modifying in the browser. You can step through the tests, pause the test and rerun the tests from the menu in VS Code.
|
||||
|
||||
|
||||
<img width="1044" alt="image" src="https://user-images.githubusercontent.com/13063165/178029249-e0a85f53-b8d4-451f-b3e5-df62b0c57929.png" />
|
||||
|
||||
## What's next
|
||||
|
||||
- [Write tests using web first assertions, page fixtures and locators](./writing-tests.md)
|
||||
- [See a trace of your tests](./trace-viewer.md)
|
||||
|
|
@ -1,81 +1,89 @@
|
|||
---
|
||||
id: intro
|
||||
title: "Getting started"
|
||||
title: "Installation"
|
||||
---
|
||||
|
||||
<!-- TOC -->
|
||||
- [Release notes](./release-notes.md)
|
||||
Playwright was created specifically to accommodate the needs of end-to-end testing. Playwright supports all modern rendering engines including Chromium, WebKit, and Firefox. Test on Windows, Linux, and macOS, locally or on CI, headless or headed with native mobile emulation.
|
||||
|
||||
## First project
|
||||
You can choose to use [NUnit base classes](./test-runners.md#nunit) or [MSTest base classes](./test-runners.md#nunit) that Playwright provides to write end-to-end tests. These classes support running tests on multiple browser engines, parallelizing tests, adjusting launch/context options and getting a [Page]/[BrowserContext] instance per test out of the box. Alternatively you can use the [library](./library.md) to manually write the testing infrastructure.
|
||||
|
||||
Create a console project and add the Playwright dependency.
|
||||
1. Start by creating a new project with `dotnet new`. This will create the `PlaywrightTests` directory which includes a `UnitTest1.cs` file:
|
||||
|
||||
<Tabs
|
||||
defaultValue="nunit"
|
||||
values={[
|
||||
{label: 'NUnit', value: 'nunit'},
|
||||
{label: 'MSTest', value: 'mstest'}
|
||||
]
|
||||
}>
|
||||
<TabItem value="nunit">
|
||||
|
||||
```bash
|
||||
# Create project
|
||||
dotnet new console -n PlaywrightDemo
|
||||
cd PlaywrightDemo
|
||||
|
||||
# Add project dependency
|
||||
dotnet add package Microsoft.Playwright
|
||||
# Build the project
|
||||
dotnet build
|
||||
# Install required browsers - replace netX with actual output folder name, f.ex. net6.0.
|
||||
pwsh bin\Debug\netX\playwright.ps1 install
|
||||
|
||||
# If the pwsh command does not work (throws TypeNotFound), make sure to use an up-to-date version of PowerShell.
|
||||
dotnet tool update --global PowerShell
|
||||
```
|
||||
|
||||
Create a `Program.cs` that will navigate to `https://playwright.dev/dotnet` and take a screenshot in Chromium.
|
||||
|
||||
```csharp
|
||||
using Microsoft.Playwright;
|
||||
|
||||
using var playwright = await Playwright.CreateAsync();
|
||||
await using var browser = await playwright.Chromium.LaunchAsync();
|
||||
var page = await browser.NewPageAsync();
|
||||
await page.GotoAsync("https://playwright.dev/dotnet");
|
||||
await page.ScreenshotAsync(new PageScreenshotOptions { Path = "screenshot.png" });
|
||||
```
|
||||
|
||||
Now run it.
|
||||
|
||||
```bash
|
||||
dotnet run
|
||||
```
|
||||
|
||||
By default, Playwright runs the browsers in headless mode. To see the browser UI, pass the `Headless = false` flag while launching the browser. You can also use [`option: slowMo`] to slow down execution. Learn more in the debugging tools [section](./debug.md).
|
||||
|
||||
```csharp
|
||||
await playwright.Firefox.LaunchAsync(new()
|
||||
{
|
||||
Headless = false,
|
||||
SlowMo = 50,
|
||||
});
|
||||
```
|
||||
|
||||
## First test
|
||||
|
||||
You can choose to use NUnit test fixtures that come bundled with Playwright. These fixtures support running tests on multiple browser engines in parallel, out of the box. Learn more about [Playwright with NUnit](./test-runners.md).
|
||||
|
||||
```bash
|
||||
# Create new project.
|
||||
dotnet new nunit -n PlaywrightTests
|
||||
cd PlaywrightTests
|
||||
```
|
||||
|
||||
Install dependencies, build project and download necessary browsers. This is only done once per project.
|
||||
</TabItem>
|
||||
<TabItem value="mstest">
|
||||
|
||||
```bash
|
||||
dotnet new mstest -n PlaywrightTests
|
||||
cd PlaywrightTests
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
2. Install the necessary Playwright dependencies:
|
||||
|
||||
<Tabs
|
||||
defaultValue="nunit"
|
||||
values={[
|
||||
{label: 'NUnit', value: 'nunit'},
|
||||
{label: 'MSTest', value: 'mstest'}
|
||||
]
|
||||
}>
|
||||
<TabItem value="nunit">
|
||||
|
||||
```bash
|
||||
# Add project dependency
|
||||
dotnet add package Microsoft.Playwright.NUnit
|
||||
# Build the project
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="mstest">
|
||||
|
||||
```bash
|
||||
dotnet add package Microsoft.Playwright.MSTest
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
3. Build the project so the `playwright.ps1` is available inside the `bin` directory:
|
||||
|
||||
```bash
|
||||
dotnet build
|
||||
# Install required browsers - replace netX with actual output folder name, f.ex. net6.0.
|
||||
```
|
||||
|
||||
4. Install required browsers by replacing `netX` with the actual output folder name, e.g. `net6.0`:
|
||||
|
||||
```bash
|
||||
pwsh bin\Debug\netX\playwright.ps1 install
|
||||
```
|
||||
|
||||
Edit UnitTest1.cs file.
|
||||
## Add Example Tests
|
||||
|
||||
Edit the `UnitTest1.cs` file with the code below to create an example end-to-end test:
|
||||
|
||||
<Tabs
|
||||
defaultValue="nunit"
|
||||
values={[
|
||||
{label: 'NUnit', value: 'nunit'},
|
||||
{label: 'MSTest', value: 'mstest'}
|
||||
]
|
||||
}>
|
||||
<TabItem value="nunit">
|
||||
|
||||
```csharp
|
||||
using System.Threading.Tasks;
|
||||
using Microsoft.Playwright.NUnit;
|
||||
|
|
@ -87,93 +95,99 @@ namespace PlaywrightTests;
|
|||
public class Tests : PageTest
|
||||
{
|
||||
[Test]
|
||||
async public Task ShouldHaveTheCorrectSlogan()
|
||||
async public Task HomepageHasPlaywrightInTitleAndGetStartedLinkLinkingtoTheIntroPage()
|
||||
{
|
||||
await Page.GotoAsync("https://playwright.dev");
|
||||
await Expect(Page.Locator("text=enables reliable end-to-end testing for modern web apps")).ToBeVisibleAsync();
|
||||
}
|
||||
|
||||
[Test]
|
||||
public async Task ShouldHaveTheCorrectTitle()
|
||||
{
|
||||
await Page.GotoAsync("https://playwright.dev");
|
||||
var title = Page.Locator(".navbar__inner .navbar__title");
|
||||
await Expect(title).ToHaveTextAsync("Playwright");
|
||||
}
|
||||
// Expect a title "to contain" a substring.
|
||||
await Expect(Page).ToHaveTitleAsync(new Regex("Playwright"));
|
||||
|
||||
[Test]
|
||||
public async Task ShouldAdd()
|
||||
{
|
||||
var result = await Page.EvaluateAsync<int>("() => 7 + 3");
|
||||
Assert.AreEqual(10, result);
|
||||
// create a locator
|
||||
var getStarted = Page.Locator("text=Get Started");
|
||||
|
||||
// Expect an attribute "to be strictly equal" to the value.
|
||||
await Expect(getStarted).ToHaveAttributeAsync("href", "/docs/intro");
|
||||
|
||||
// Click the get started link.
|
||||
await getStarted.ClickAsync();
|
||||
|
||||
// Expects the URL to contain intro.
|
||||
await Expect(Page).ToHaveURLAsync(new Regex(".*intro"));
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="mstest">
|
||||
|
||||
```csharp
|
||||
using Microsoft.Playwright.MSTest;
|
||||
|
||||
namespace PlaywrightTests;
|
||||
|
||||
public class UnitTest1 : PageTest
|
||||
{
|
||||
[TestMethod]
|
||||
async public Task HomepageHasPlaywrightInTitleAndGetStartedLinkLinkingtoTheIntroPage()
|
||||
{
|
||||
await Page.GotoAsync("https://playwright.dev");
|
||||
|
||||
// Expect a title "to contain" a substring.
|
||||
await Expect(Page).ToHaveTitleAsync(new Regex("Playwright"));
|
||||
|
||||
// create a locator
|
||||
var getStarted = Page.Locator("text=Get Started");
|
||||
|
||||
// Expect an attribute "to be strictly equal" to the value.
|
||||
await Expect(getStarted).ToHaveAttributeAsync("href", "/docs/intro");
|
||||
|
||||
// Click the get started link.
|
||||
await getStarted.ClickAsync();
|
||||
|
||||
// Expects the URL to contain intro.
|
||||
await Expect(Page).ToHaveURLAsync(new Regex(".*intro"));
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Running the Example Tests
|
||||
|
||||
By default tests will be run on Chromium. This can be configured via the `BROWSER` environment variable, or by adjusting the [launch configuration options](./test-runners.md). Tests are run in headless mode meaning no browser will open up when running the tests. Results of the tests and test logs will be shown in the terminal.
|
||||
|
||||
<Tabs
|
||||
defaultValue="nunit"
|
||||
values={[
|
||||
{label: 'NUnit', value: 'nunit'},
|
||||
{label: 'MSTest', value: 'mstest'}
|
||||
]
|
||||
}>
|
||||
<TabItem value="nunit">
|
||||
|
||||
```bash
|
||||
dotnet test -- NUnit.NumberOfTestWorkers=5
|
||||
```
|
||||
|
||||
## Record scripts
|
||||
|
||||
[Command line tools](./cli.md) can be used to record user interactions and generate C# code.
|
||||
</TabItem>
|
||||
<TabItem value="mstest">
|
||||
|
||||
```bash
|
||||
pwsh bin\Debug\netX\playwright.ps1 codegen
|
||||
dotnet test -- MSTest.Parallelize.Workers=5
|
||||
```
|
||||
|
||||
## Install browsers via API
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
It's possible to run [Command line tools](./cli.md) commands via the .NET API:
|
||||
See our doc on [Test Runners](./test-runners.md) to learn more about running tests in headed mode, running multiple tests, running specific configurations etc.
|
||||
|
||||
```csharp
|
||||
var exitCode = Microsoft.Playwright.Program.Main(new[] {"install"});
|
||||
if (exitCode != 0)
|
||||
{
|
||||
throw new Exception($"Playwright exited with code {exitCode}");
|
||||
}
|
||||
```
|
||||
## What's next
|
||||
|
||||
## Bundle drivers for different platforms
|
||||
|
||||
Playwright by default does bundle only the driver for the .NET publish target runtime. If you want to bundle for additional platforms, you can
|
||||
override this behavior by using either `all`, `none` or `linux`, `win`, `osx` in your project file.
|
||||
|
||||
```xml
|
||||
<PropertyGroup>
|
||||
<PlaywrightPlatform>all</PlaywrightPlatform>
|
||||
</PropertyGroup>
|
||||
```
|
||||
|
||||
or:
|
||||
|
||||
```xml
|
||||
<PropertyGroup>
|
||||
<PlaywrightPlatform>osx;linux</PlaywrightPlatform>
|
||||
</PropertyGroup>
|
||||
```
|
||||
|
||||
## System requirements
|
||||
|
||||
The browser binaries for Chromium, Firefox and WebKit work across the 3 platforms (Windows, macOS, Linux):
|
||||
|
||||
### Windows
|
||||
|
||||
Works with Windows and Windows Subsystem for Linux (WSL).
|
||||
|
||||
### macOS
|
||||
|
||||
Requires 11 (Big Sur) or above.
|
||||
|
||||
### Linux
|
||||
|
||||
Depending on your Linux distribution, you might need to install additional
|
||||
dependencies to run the browsers.
|
||||
|
||||
:::note
|
||||
Only Ubuntu 18.04, 20.04, and 22.04 are officially supported.
|
||||
:::
|
||||
|
||||
See also in the [Command line tools](./cli.md#install-system-dependencies)
|
||||
which has a command to install all necessary dependencies automatically for Ubuntu
|
||||
LTS releases.
|
||||
- [Write tests using web first assertions, page fixtures and locators](./writing-tests.md)
|
||||
- [Run single tests, multiple tests, headed mode](./running-tests.md)
|
||||
- [Learn more about the NUnit and MSTest base classes](./test-runners.md)
|
||||
- [Debug tests with the Playwright Debugger](./debug.md)
|
||||
- [Generate tests with Codegen](./codegen.md)
|
||||
- [See a trace of your tests](./trace-viewer.md)
|
||||
- [Using Playwright as library](./library.md)
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ title: "Installation"
|
|||
|
||||
Playwright Test was created specifically to accommodate the needs of end-to-end testing. Playwright supports all modern rendering engines including Chromium, WebKit, and Firefox. Test on Windows, Linux, and macOS, locally or on CI, headless or headed with native mobile emulation of Google Chrome for Android and Mobile Safari.
|
||||
|
||||
Get started by installing Playwright and running the example test to see it in action.
|
||||
Get started by installing Playwright and running the example test to see it in action. Alternatively you can also get started and run your tests using the [VS Code Extension](./getting-started-vscode.md).
|
||||
|
||||
<Tabs
|
||||
defaultValue="npm"
|
||||
|
|
|
|||
|
|
@ -1,222 +1,70 @@
|
|||
---
|
||||
id: intro
|
||||
title: "Getting started"
|
||||
title: "Installation"
|
||||
---
|
||||
|
||||
<!-- TOC -->
|
||||
Playwright was created specifically to accommodate the needs of end-to-end testing. Playwright supports all modern rendering engines including Chromium, WebKit, and Firefox. Test on Windows, Linux, and macOS, locally or on CI, headless or headed with native mobile emulation.
|
||||
|
||||
- [Release notes](./release-notes.md)
|
||||
Playwright recommends using the official [Playwright Pytest plugin](./test-runners.md) to write end-to-end tests. It provides context isolation, running it on multiple browser configurations out of the box. Alternatively you can use the [library](./library.md) to manually write the testing infrastructure with your preferred test-runner. The Pytest plugin utilizes the sync version of Playwright, there is also an async version accessible via the library.
|
||||
|
||||
## Installation
|
||||
Get started by installing Playwright and running the example test to see it in action.
|
||||
|
||||
See [system requirements](#system-requirements).
|
||||
|
||||
### Pip
|
||||
|
||||
[](https://pypi.python.org/pypi/playwright/)
|
||||
Install the [Pytest plugin](https://pypi.org/project/pytest-playwright/):
|
||||
|
||||
```bash
|
||||
pip install pytest-playwright
|
||||
```
|
||||
|
||||
Install the required browsers:
|
||||
|
||||
```bash
|
||||
pip install --upgrade pip
|
||||
pip install playwright
|
||||
playwright install
|
||||
```
|
||||
|
||||
### Conda
|
||||
## Add Example Test
|
||||
|
||||
[](https://anaconda.org/Microsoft/playwright)
|
||||
Create a `test_my_application.py` file inside the current working directory or in a sub-directory with the code below:
|
||||
|
||||
```py
|
||||
import re
|
||||
from playwright.sync_api import Page, expect
|
||||
|
||||
|
||||
def test_homepage_has_Playwright_in_title_and_get_started_link_linking_to_the_intro_page(
|
||||
page: Page, foo
|
||||
):
|
||||
page.goto("https://playwright.dev/")
|
||||
|
||||
# Expect a title "to contain" a substring.
|
||||
expect(page).to_have_title(re.compile("Playwright"))
|
||||
|
||||
# create a locator
|
||||
get_started = page.locator("text=Get Started")
|
||||
|
||||
# Expect an attribute "to be strictly equal" to the value.
|
||||
expect(get_started).to_have_attribute("href", "/docs/intro")
|
||||
|
||||
# Click the get started link.
|
||||
get_started.click()
|
||||
|
||||
# Expects the URL to contain intro.
|
||||
expect(page).to_have_url(re.compile(".*intro"))
|
||||
```
|
||||
|
||||
## Running the Example Test
|
||||
|
||||
By default tests will be run on chromium. This can be configured via the CLI options. Tests are run in headless mode meaning no browser UI will open up when running the tests. Results of the tests and test logs will be shown in the terminal.
|
||||
|
||||
```bash
|
||||
conda config --add channels conda-forge
|
||||
conda config --add channels microsoft
|
||||
conda install playwright
|
||||
playwright install
|
||||
pytest
|
||||
```
|
||||
|
||||
These commands download the Playwright package and install browser binaries for Chromium, Firefox and WebKit. To modify this behavior see [installation parameters](./browsers.md#installing-browsers).
|
||||
See our doc on [Running Tests](./running-tests.md) to learn more about running tests in headed mode, running multiple tests, running specific tests etc.
|
||||
|
||||
## Usage
|
||||
## What's next
|
||||
|
||||
Once installed, you can `import` Playwright in a Python script, and launch any of the 3 browsers (`chromium`, `firefox` and `webkit`).
|
||||
|
||||
```py
|
||||
from playwright.sync_api import sync_playwright
|
||||
|
||||
with sync_playwright() as p:
|
||||
browser = p.chromium.launch()
|
||||
page = browser.new_page()
|
||||
page.goto("http://playwright.dev")
|
||||
print(page.title())
|
||||
browser.close()
|
||||
```
|
||||
|
||||
Playwright supports two variations of the API: synchronous and asynchronous. If your modern project uses [asyncio](https://docs.python.org/3/library/asyncio.html), you should use async API:
|
||||
|
||||
```py
|
||||
import asyncio
|
||||
from playwright.async_api import async_playwright
|
||||
|
||||
async def main():
|
||||
async with async_playwright() as p:
|
||||
browser = await p.chromium.launch()
|
||||
page = await browser.new_page()
|
||||
await page.goto("http://playwright.dev")
|
||||
print(await page.title())
|
||||
await browser.close()
|
||||
|
||||
asyncio.run(main())
|
||||
```
|
||||
|
||||
## First script
|
||||
|
||||
In our first script, we will navigate to `whatsmyuseragent.org` and take a screenshot in WebKit.
|
||||
|
||||
```py
|
||||
from playwright.sync_api import sync_playwright
|
||||
|
||||
with sync_playwright() as p:
|
||||
browser = p.webkit.launch()
|
||||
page = browser.new_page()
|
||||
page.goto("http://whatsmyuseragent.org/")
|
||||
page.screenshot(path="example.png")
|
||||
browser.close()
|
||||
```
|
||||
|
||||
By default, Playwright runs the browsers in headless mode. To see the browser UI, pass the `headless=False` flag while launching the browser. You can also use [`option: slowMo`] to slow down execution. Learn more in the debugging tools [section](./debug.md).
|
||||
|
||||
```py
|
||||
firefox.launch(headless=False, slow_mo=50)
|
||||
```
|
||||
|
||||
## Record scripts
|
||||
|
||||
[Command line tools](./cli.md) can be used to record user interactions and generate Python code.
|
||||
|
||||
```bash
|
||||
playwright codegen wikipedia.org
|
||||
```
|
||||
|
||||
## With Pytest
|
||||
|
||||
See [here](./test-runners.md) for Pytest instructions and examples.
|
||||
|
||||
## Interactive mode (REPL)
|
||||
|
||||
Blocking REPL, as in CLI via Python directly:
|
||||
|
||||
```bash
|
||||
python
|
||||
```
|
||||
|
||||
```py
|
||||
>>> from playwright.sync_api import sync_playwright
|
||||
>>> playwright = sync_playwright().start()
|
||||
# Use playwright.chromium, playwright.firefox or playwright.webkit
|
||||
# Pass headless=False to launch() to see the browser UI
|
||||
>>> browser = playwright.chromium.launch()
|
||||
>>> page = browser.new_page()
|
||||
>>> page.goto("http://whatsmyuseragent.org/")
|
||||
>>> page.screenshot(path="example.png")
|
||||
>>> browser.close()
|
||||
>>> playwright.stop()
|
||||
```
|
||||
|
||||
Async REPL such as `asyncio` REPL:
|
||||
|
||||
```bash
|
||||
python -m asyncio
|
||||
```
|
||||
|
||||
```py
|
||||
>>> from playwright.async_api import async_playwright
|
||||
>>> playwright = await async_playwright().start()
|
||||
>>> browser = await playwright.chromium.launch()
|
||||
>>> page = await browser.new_page()
|
||||
>>> await page.goto("http://whatsmyuseragent.org/")
|
||||
>>> await page.screenshot(path="example.png")
|
||||
>>> await browser.close()
|
||||
>>> await playwright.stop()
|
||||
```
|
||||
|
||||
## Pyinstaller
|
||||
|
||||
You can use Playwright with [Pyinstaller](https://www.pyinstaller.org/) to create standalone executables.
|
||||
|
||||
```py
|
||||
# main.py
|
||||
from playwright.sync_api import sync_playwright
|
||||
|
||||
with sync_playwright() as p:
|
||||
browser = p.chromium.launch()
|
||||
page = browser.new_page()
|
||||
page.goto("http://whatsmyuseragent.org/")
|
||||
page.screenshot(path="example.png")
|
||||
browser.close()
|
||||
```
|
||||
|
||||
If you want to bundle browsers with the executables:
|
||||
|
||||
```bash tab=bash-bash
|
||||
PLAYWRIGHT_BROWSERS_PATH=0 playwright install chromium
|
||||
pyinstaller -F main.py
|
||||
```
|
||||
|
||||
```batch tab=bash-batch
|
||||
set PLAYWRIGHT_BROWSERS_PATH=0
|
||||
playwright install chromium
|
||||
pyinstaller -F main.py
|
||||
```
|
||||
|
||||
```powershell tab=bash-powershell
|
||||
$env:PLAYWRIGHT_BROWSERS_PATH="0"
|
||||
playwright install chromium
|
||||
pyinstaller -F main.py
|
||||
```
|
||||
|
||||
:::note
|
||||
Bundling the browsers with the executables will generate bigger binaries.
|
||||
It is recommended to only bundle the browsers you use.
|
||||
:::
|
||||
|
||||
## Known issues
|
||||
|
||||
### `time.sleep()` leads to outdated state
|
||||
|
||||
You should use `page.wait_for_timeout(5000)` instead of `time.sleep(5)` and it is better to not wait for a timeout at all, but sometimes it is useful for debugging. In these cases, use our wait method instead of the `time` module. This is because we internally rely on asynchronous operations and when using `time.sleep(5)` they can't get processed correctly.
|
||||
|
||||
|
||||
### incompatible with `SelectorEventLoop` of `asyncio` on Windows
|
||||
|
||||
Playwright runs the driver in a subprocess, so it requires `ProactorEventLoop` of `asyncio` on Windows because `SelectorEventLoop` does not supports async subprocesses.
|
||||
|
||||
On Windows Python 3.7, Playwright sets the default event loop to `ProactorEventLoop` as it is default on Python 3.8+.
|
||||
|
||||
### Threading
|
||||
|
||||
Playwright's API is not thread-safe. If you are using Playwright in a multi-threaded environment, you should create a playwright instance per thread. See [threading issue](https://github.com/microsoft/playwright-python/issues/623) for more details.
|
||||
|
||||
|
||||
## System requirements
|
||||
|
||||
Playwright requires Python 3.7 or above. The browser binaries for Chromium,
|
||||
Firefox and WebKit work across the 3 platforms (Windows, macOS, Linux):
|
||||
|
||||
### Windows
|
||||
|
||||
Works with Windows and Windows Subsystem for Linux (WSL).
|
||||
|
||||
### macOS
|
||||
|
||||
Requires 11 (Big Sur) or above.
|
||||
|
||||
### Linux
|
||||
|
||||
Depending on your Linux distribution, you might need to install additional
|
||||
dependencies to run the browsers.
|
||||
|
||||
:::note
|
||||
Only Ubuntu 18.04, 20.04, and 22.04 are officially supported.
|
||||
:::
|
||||
|
||||
See also in the [Command line tools](./cli.md#install-system-dependencies)
|
||||
which has a command to install all necessary dependencies automatically for Ubuntu
|
||||
LTS releases.
|
||||
- [Write tests using web first assertions, page fixtures and locators](./writing-tests.md)
|
||||
- [Run single tests, multiple tests, headed mode](./running-tests.md)
|
||||
- [Debug tests with the Playwright Debugger](./debug.md)
|
||||
- [Generate tests with Codegen](./codegen.md)
|
||||
- [See a trace of your tests](./trace-viewer.md)
|
||||
|
|
|
|||
73
docs/src/library-csharp.md
Normal file
73
docs/src/library-csharp.md
Normal file
|
|
@ -0,0 +1,73 @@
|
|||
---
|
||||
id: library
|
||||
title: "Getting started - Library"
|
||||
---
|
||||
|
||||
Playwright can either be used with the [NUnit](./test-runners.md#nunit) or [MSTest](./test-runners.md#mstest), or as a Playwright Library (this guide). If you are working on an application that utilizes Playwright capabilities or you are using Playwright with another test runner, read on.
|
||||
|
||||
## Usage
|
||||
|
||||
Create a console project and add the Playwright dependency.
|
||||
|
||||
```bash
|
||||
# Create project
|
||||
dotnet new console -n PlaywrightDemo
|
||||
cd PlaywrightDemo
|
||||
|
||||
# Add project dependency
|
||||
dotnet add package Microsoft.Playwright
|
||||
# Build the project
|
||||
dotnet build
|
||||
# Install required browsers - replace netX with actual output folder name, e.g. net6.0.
|
||||
pwsh bin\Debug\netX\playwright.ps1 install
|
||||
|
||||
# If the pwsh command does not work (throws TypeNotFound), make sure to use an up-to-date version of PowerShell.
|
||||
dotnet tool update --global PowerShell
|
||||
```
|
||||
|
||||
Create a `Program.cs` that will navigate to `https://playwright.dev/dotnet` and take a screenshot in Chromium.
|
||||
|
||||
```csharp
|
||||
using Microsoft.Playwright;
|
||||
|
||||
using var playwright = await Playwright.CreateAsync();
|
||||
await using var browser = await playwright.Chromium.LaunchAsync();
|
||||
var page = await browser.NewPageAsync();
|
||||
await page.GotoAsync("https://playwright.dev/dotnet");
|
||||
await page.ScreenshotAsync(new PageScreenshotOptions { Path = "screenshot.png" });
|
||||
```
|
||||
|
||||
Now run it.
|
||||
|
||||
```bash
|
||||
dotnet run
|
||||
```
|
||||
|
||||
By default, Playwright runs the browsers in headless mode. To see the browser UI, pass the `Headless = false` flag while launching the browser. You can also use [`option: slowMo`] to slow down execution. Learn more in the debugging tools [section](./debug.md).
|
||||
|
||||
```csharp
|
||||
await using var browser = await playwright.Firefox.LaunchAsync(new()
|
||||
{
|
||||
Headless = false,
|
||||
SlowMo = 50,
|
||||
});
|
||||
```
|
||||
|
||||
## Bundle drivers for different platforms
|
||||
|
||||
Playwright by default does bundle only the driver for the .NET publish target runtime. If you want to bundle for additional platforms, you can
|
||||
override this behavior by using either `all`, `none` or `linux`, `win`, `osx` in your project file.
|
||||
|
||||
```xml
|
||||
<PropertyGroup>
|
||||
<PlaywrightPlatform>all</PlaywrightPlatform>
|
||||
</PropertyGroup>
|
||||
```
|
||||
|
||||
or:
|
||||
|
||||
```xml
|
||||
<PropertyGroup>
|
||||
<PlaywrightPlatform>osx;linux</PlaywrightPlatform>
|
||||
</PropertyGroup>
|
||||
```
|
||||
206
docs/src/library-python.md
Normal file
206
docs/src/library-python.md
Normal file
|
|
@ -0,0 +1,206 @@
|
|||
---
|
||||
id: library
|
||||
title: "Getting started - Library"
|
||||
---
|
||||
|
||||
## Installation
|
||||
|
||||
### Pip
|
||||
|
||||
[](https://pypi.python.org/pypi/playwright/)
|
||||
|
||||
```bash
|
||||
pip install --upgrade pip
|
||||
pip install playwright
|
||||
playwright install
|
||||
```
|
||||
|
||||
### Conda
|
||||
|
||||
[](https://anaconda.org/Microsoft/playwright)
|
||||
|
||||
```bash
|
||||
conda config --add channels conda-forge
|
||||
conda config --add channels microsoft
|
||||
conda install playwright
|
||||
playwright install
|
||||
```
|
||||
|
||||
These commands download the Playwright package and install browser binaries for Chromium, Firefox and WebKit. To modify this behavior see [installation parameters](./browsers.md#installing-browsers).
|
||||
|
||||
## Usage
|
||||
|
||||
Once installed, you can `import` Playwright in a Python script, and launch any of the 3 browsers (`chromium`, `firefox` and `webkit`).
|
||||
|
||||
```py
|
||||
from playwright.sync_api import sync_playwright
|
||||
|
||||
with sync_playwright() as p:
|
||||
browser = p.chromium.launch()
|
||||
page = browser.new_page()
|
||||
page.goto("http://playwright.dev")
|
||||
print(page.title())
|
||||
browser.close()
|
||||
```
|
||||
|
||||
Playwright supports two variations of the API: synchronous and asynchronous. If your modern project uses [asyncio](https://docs.python.org/3/library/asyncio.html), you should use async API:
|
||||
|
||||
```py
|
||||
import asyncio
|
||||
from playwright.async_api import async_playwright
|
||||
|
||||
async def main():
|
||||
async with async_playwright() as p:
|
||||
browser = await p.chromium.launch()
|
||||
page = await browser.new_page()
|
||||
await page.goto("http://playwright.dev")
|
||||
print(await page.title())
|
||||
await browser.close()
|
||||
|
||||
asyncio.run(main())
|
||||
```
|
||||
|
||||
## First script
|
||||
|
||||
In our first script, we will navigate to `whatsmyuseragent.org` and take a screenshot in WebKit.
|
||||
|
||||
```py
|
||||
from playwright.sync_api import sync_playwright
|
||||
|
||||
with sync_playwright() as p:
|
||||
browser = p.webkit.launch()
|
||||
page = browser.new_page()
|
||||
page.goto("http://whatsmyuseragent.org/")
|
||||
page.screenshot(path="example.png")
|
||||
browser.close()
|
||||
```
|
||||
|
||||
By default, Playwright runs the browsers in headless mode. To see the browser UI, pass the `headless=False` flag while launching the browser. You can also use [`option: slowMo`] to slow down execution. Learn more in the debugging tools [section](./debug.md).
|
||||
|
||||
```py
|
||||
firefox.launch(headless=False, slow_mo=50)
|
||||
```
|
||||
|
||||
## Interactive mode (REPL)
|
||||
|
||||
You can launch the interactive python REPL:
|
||||
|
||||
```bash
|
||||
python
|
||||
```
|
||||
|
||||
and then launch Playwright within it for quick experimentation:
|
||||
|
||||
```py
|
||||
>>> from playwright.sync_api import sync_playwright
|
||||
>>> playwright = sync_playwright().start()
|
||||
# Use playwright.chromium, playwright.firefox or playwright.webkit
|
||||
# Pass headless=False to launch() to see the browser UI
|
||||
>>> browser = playwright.chromium.launch()
|
||||
>>> page = browser.new_page()
|
||||
>>> page.goto("http://whatsmyuseragent.org/")
|
||||
>>> page.screenshot(path="example.png")
|
||||
>>> browser.close()
|
||||
>>> playwright.stop()
|
||||
```
|
||||
|
||||
Async REPL such as `asyncio` REPL:
|
||||
|
||||
```bash
|
||||
python -m asyncio
|
||||
```
|
||||
|
||||
```py
|
||||
>>> from playwright.async_api import async_playwright
|
||||
>>> playwright = await async_playwright().start()
|
||||
>>> browser = await playwright.chromium.launch()
|
||||
>>> page = await browser.new_page()
|
||||
>>> await page.goto("http://whatsmyuseragent.org/")
|
||||
>>> await page.screenshot(path="example.png")
|
||||
>>> await browser.close()
|
||||
>>> await playwright.stop()
|
||||
```
|
||||
|
||||
## Pyinstaller
|
||||
|
||||
You can use Playwright with [Pyinstaller](https://www.pyinstaller.org/) to create standalone executables.
|
||||
|
||||
```py
|
||||
# main.py
|
||||
from playwright.sync_api import sync_playwright
|
||||
|
||||
with sync_playwright() as p:
|
||||
browser = p.chromium.launch()
|
||||
page = browser.new_page()
|
||||
page.goto("http://whatsmyuseragent.org/")
|
||||
page.screenshot(path="example.png")
|
||||
browser.close()
|
||||
```
|
||||
|
||||
If you want to bundle browsers with the executables:
|
||||
|
||||
```bash tab=bash-bash
|
||||
PLAYWRIGHT_BROWSERS_PATH=0 playwright install chromium
|
||||
pyinstaller -F main.py
|
||||
```
|
||||
|
||||
```batch tab=bash-batch
|
||||
set PLAYWRIGHT_BROWSERS_PATH=0
|
||||
playwright install chromium
|
||||
pyinstaller -F main.py
|
||||
```
|
||||
|
||||
```powershell tab=bash-powershell
|
||||
$env:PLAYWRIGHT_BROWSERS_PATH="0"
|
||||
playwright install chromium
|
||||
pyinstaller -F main.py
|
||||
```
|
||||
|
||||
:::note
|
||||
Bundling the browsers with the executables will generate bigger binaries.
|
||||
It is recommended to only bundle the browsers you use.
|
||||
:::
|
||||
|
||||
## Known issues
|
||||
|
||||
### `time.sleep()` leads to outdated state
|
||||
|
||||
Most likely you don't need to wait manually, since Playwright has [auto-waiting](./actionability.md). If you still rely on it, you should use `page.wait_for_timeout(5000)` instead of `time.sleep(5)` and it is better to not wait for a timeout at all, but sometimes it is useful for debugging. In these cases, use our wait (`wait_for_timeout`) method instead of the `time` module. This is because we internally rely on asynchronous operations and when using `time.sleep(5)` they can't get processed correctly.
|
||||
|
||||
|
||||
### incompatible with `SelectorEventLoop` of `asyncio` on Windows
|
||||
|
||||
Playwright runs the driver in a subprocess, so it requires `ProactorEventLoop` of `asyncio` on Windows because `SelectorEventLoop` does not supports async subprocesses.
|
||||
|
||||
On Windows Python 3.7, Playwright sets the default event loop to `ProactorEventLoop` as it is default on Python 3.8+.
|
||||
|
||||
### Threading
|
||||
|
||||
Playwright's API is not thread-safe. If you are using Playwright in a multi-threaded environment, you should create a playwright instance per thread. See [threading issue](https://github.com/microsoft/playwright-python/issues/623) for more details.
|
||||
|
||||
|
||||
## System requirements
|
||||
|
||||
Playwright requires Python 3.7 or above. The browser binaries for Chromium,
|
||||
Firefox and WebKit work across the 3 platforms (Windows, macOS, Linux):
|
||||
|
||||
### Windows
|
||||
|
||||
Works with Windows and Windows Subsystem for Linux (WSL).
|
||||
|
||||
### macOS
|
||||
|
||||
Requires 11 (Big Sur) or above.
|
||||
|
||||
### Linux
|
||||
|
||||
Depending on your Linux distribution, you might need to install additional
|
||||
dependencies to run the browsers.
|
||||
|
||||
:::note
|
||||
Only Ubuntu 18.04, 20.04, and 22.04 are officially supported.
|
||||
:::
|
||||
|
||||
See also in the [Command line tools](./cli.md#install-system-dependencies)
|
||||
which has a command to install all necessary dependencies automatically for Ubuntu
|
||||
LTS releases.
|
||||
|
|
@ -137,7 +137,7 @@ given selector.
|
|||
await page.locator('button').click();
|
||||
|
||||
// Works because we explicitly tell locator to pick the first element:
|
||||
await page.locator('button').first().click();
|
||||
await page.locator('button').first().click(); // ⚠️ using first disables strictness
|
||||
|
||||
// Works because count knows what to do with multiple matches:
|
||||
await page.locator('button').count();
|
||||
|
|
@ -148,7 +148,7 @@ await page.locator('button').count();
|
|||
await page.locator('button').click()
|
||||
|
||||
# Works because we explicitly tell locator to pick the first element:
|
||||
await page.locator('button').first.click()
|
||||
await page.locator('button').first.click() # ⚠️ using first disables strictness
|
||||
|
||||
# Works because count knows what to do with multiple matches:
|
||||
await page.locator('button').count()
|
||||
|
|
@ -159,7 +159,7 @@ await page.locator('button').count()
|
|||
page.locator('button').click()
|
||||
|
||||
# Works because we explicitly tell locator to pick the first element:
|
||||
page.locator('button').first.click()
|
||||
page.locator('button').first.click() # ⚠️ using first disables strictness
|
||||
|
||||
# Works because count knows what to do with multiple matches:
|
||||
page.locator('button').count()
|
||||
|
|
@ -170,7 +170,7 @@ page.locator('button').count()
|
|||
page.locator("button").click();
|
||||
|
||||
// Works because we explicitly tell locator to pick the first element:
|
||||
page.locator("button").first().click();
|
||||
page.locator("button").first().click(); // ⚠️ using first disables strictness
|
||||
|
||||
// Works because count knows what to do with multiple matches:
|
||||
page.locator("button").count();
|
||||
|
|
@ -181,12 +181,16 @@ page.locator("button").count();
|
|||
await page.Locator("button").ClickAsync();
|
||||
|
||||
// Works because we explicitly tell locator to pick the first element:
|
||||
await page.Locator("button").First.ClickAsync();
|
||||
await page.Locator("button").First.ClickAsync(); // ⚠️ using First disables strictness
|
||||
|
||||
// Works because Count knows what to do with multiple matches:
|
||||
await page.Locator("button").CountAsync();
|
||||
```
|
||||
|
||||
:::caution
|
||||
Using [`method: Locator.first`], [`method: Locator.last`], and [`method: Locator.nth`] is discouraged since it disables the concept of strictness, and as your page changes, Playwright may click on an element you did not intend. It's better to make your locator more specific. Learn more below in [Filtering Locators](#filtering-locators) and the [selectors guide](./selectors.md).
|
||||
:::
|
||||
|
||||
## Lists
|
||||
|
||||
You can also use locators to work with the element lists.
|
||||
|
|
|
|||
|
|
@ -5,6 +5,130 @@ title: "Release notes"
|
|||
|
||||
<!-- TOC -->
|
||||
|
||||
## Version 1.24
|
||||
|
||||
### 🌍 Multiple Web Servers in `playwright.config.ts`
|
||||
|
||||
Launch multiple web servers, databases, or other processes by passing an array of configurations:
|
||||
|
||||
```ts
|
||||
// playwright.config.ts
|
||||
import type { PlaywrightTestConfig } from '@playwright/test';
|
||||
const config: PlaywrightTestConfig = {
|
||||
webServer: [
|
||||
{
|
||||
command: 'npm run start',
|
||||
port: 3000,
|
||||
timeout: 120 * 1000,
|
||||
reuseExistingServer: !process.env.CI,
|
||||
},
|
||||
{
|
||||
command: 'npm run backend',
|
||||
port: 3333,
|
||||
timeout: 120 * 1000,
|
||||
reuseExistingServer: !process.env.CI,
|
||||
}
|
||||
],
|
||||
use: {
|
||||
baseURL: 'http://localhost:3000/',
|
||||
},
|
||||
};
|
||||
export default config;
|
||||
```
|
||||
|
||||
### 🐂 Debian 11 Bullseye Support
|
||||
|
||||
Playwright now supports Debian 11 Bullseye on x86_64 for Chromium, Firefox and WebKit. Let us know
|
||||
if you encounter any issues!
|
||||
|
||||
Linux support looks like this:
|
||||
|
||||
| | Ubuntu 18.04 | Ubuntu 20.04 | Ubuntu 22.04 | Debian 11
|
||||
| :--- | :---: | :---: | :---: | :---: |
|
||||
| Chromium | ✅ | ✅ | ✅ | ✅ |
|
||||
| WebKit | ✅ | ✅ | ✅ | ✅ |
|
||||
| Firefox | ✅ | ✅ | ✅ | ✅ |
|
||||
|
||||
### 🕵️ Anonymous Describe
|
||||
|
||||
It is now possible to call [`method: Test.describe#2`] to create suites without a title. This is useful for giving a group of tests a common option with [`method: Test.use`].
|
||||
|
||||
```ts
|
||||
test.describe(() => {
|
||||
test.use({ colorScheme: 'dark' });
|
||||
|
||||
test('one', async ({ page }) => {
|
||||
// ...
|
||||
});
|
||||
|
||||
test('two', async ({ page }) => {
|
||||
// ...
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
### 🧩 Component Tests Update
|
||||
|
||||
Playwright 1.24 Component Tests introduce `beforeMount` and `afterMount` hooks.
|
||||
Use these to configure your app for tests.
|
||||
|
||||
For example, this could be used to setup App router in Vue.js:
|
||||
|
||||
```js
|
||||
// src/component.spec.ts
|
||||
import { test } from '@playwright/experimental-ct-vue';
|
||||
import { Component } from './mycomponent';
|
||||
|
||||
test('should work', async ({ mount }) => {
|
||||
const component = await mount(Component, {
|
||||
hooksConfig: {
|
||||
/* anything to configure your app */
|
||||
}
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
```js
|
||||
// playwright/index.ts
|
||||
import { router } from '../router';
|
||||
import { beforeMount } from '@playwright/experimental-ct-vue/hooks';
|
||||
|
||||
beforeMount(async ({ app, hooksConfig }) => {
|
||||
app.use(router);
|
||||
});
|
||||
```
|
||||
|
||||
A similar configuration in Next.js would look like this:
|
||||
|
||||
```js
|
||||
// src/component.spec.jsx
|
||||
import { test } from '@playwright/experimental-ct-react';
|
||||
import { Component } from './mycomponent';
|
||||
|
||||
test('should work', async ({ mount }) => {
|
||||
const component = await mount(<Component></Component>, {
|
||||
// Pass mock value from test into `beforeMount`.
|
||||
hooksConfig: {
|
||||
router: {
|
||||
query: { page: 1, per_page: 10 },
|
||||
asPath: '/posts'
|
||||
}
|
||||
}
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
```js
|
||||
// playwright/index.js
|
||||
import router from 'next/router';
|
||||
import { beforeMount } from '@playwright/experimental-ct-react/hooks';
|
||||
|
||||
beforeMount(async ({ hooksConfig }) => {
|
||||
// Before mount, redefine useRouter to return mock value from test.
|
||||
router.useRouter = () => hooksConfig.router;
|
||||
});
|
||||
```
|
||||
|
||||
## Version 1.23
|
||||
|
||||
<div className="embed-youtube">
|
||||
|
|
|
|||
74
docs/src/running-tests-csharp.md
Normal file
74
docs/src/running-tests-csharp.md
Normal file
|
|
@ -0,0 +1,74 @@
|
|||
---
|
||||
id: running-tests
|
||||
title: "Running Tests"
|
||||
---
|
||||
|
||||
You can run a single test, a set of tests or all tests. Tests can be run on different browsers. By default tests are run in a headless manner meaning no browser window will be opened while running the tests and results will be seen in the terminal. If you prefer you can run your tests in headed mode by using the `headless` test run parameter.
|
||||
|
||||
- Running all tests
|
||||
|
||||
```bash
|
||||
dotnet test
|
||||
```
|
||||
|
||||
- Running a single test file
|
||||
|
||||
```bash
|
||||
dotnet test --filter "MyClassName"
|
||||
```
|
||||
|
||||
- Run a set of test files
|
||||
|
||||
```bash
|
||||
dotnet test --filter "MyClassName1|MyClassName2"
|
||||
```
|
||||
|
||||
- Run the test with the title
|
||||
|
||||
```bash
|
||||
dotnet test --filter "Name~TestMethod1"
|
||||
```
|
||||
|
||||
- Running Tests on specific browsers
|
||||
|
||||
```bash tab=bash-bash
|
||||
BROWSER=webkit dotnet test
|
||||
```
|
||||
|
||||
```batch tab=bash-batch
|
||||
set BROWSER=webkit
|
||||
dotnet test
|
||||
```
|
||||
|
||||
```powershell tab=bash-powershell
|
||||
$env:BROWSER="webkit"
|
||||
dotnet test
|
||||
```
|
||||
|
||||
- Running Tests on multiple browsers
|
||||
|
||||
To run your test on multiple browsers or configurations you need to invoke the `dotnet test` command multiple times. There you can then either specify the `BROWSER` environment variable (like the previous) or pass the `browser` via the runsettings file:
|
||||
|
||||
```bash
|
||||
dotnet test --settings:chromium.runsettings
|
||||
dotnet test --settings:firefox.runsettings
|
||||
dotnet test --settings:webkit.runsettings
|
||||
```
|
||||
|
||||
```xml
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<RunSettings>
|
||||
<TestRunParameters>
|
||||
<Parameter name="browser" value="chromium" />
|
||||
<Parameter name="headless" value="false" />
|
||||
</TestRunParameters>
|
||||
</RunSettings>
|
||||
```
|
||||
|
||||
For more information see [selective unit tests](https://docs.microsoft.com/en-us/dotnet/core/testing/selective-unit-tests?pivots=mstest) in the Microsoft docs.
|
||||
|
||||
## What's Next
|
||||
|
||||
- [Debug tests with the Playwright Debugger](./debug.md)
|
||||
- [Generate tests with Codegen](./codegen.md)
|
||||
- [See a trace of your tests](./trace-viewer.md)
|
||||
56
docs/src/running-tests-python.md
Normal file
56
docs/src/running-tests-python.md
Normal file
|
|
@ -0,0 +1,56 @@
|
|||
---
|
||||
id: running-tests
|
||||
title: "Running Tests"
|
||||
---
|
||||
|
||||
You can run a single test, a set of tests or all tests. Tests can be run on one browser or multiple browsers. By default tests are run in a headless manner meaning no browser window will be opened while running the tests and results will be seen in the terminal. If you prefer you can run your tests in headed mode by using the `--headed` flag.
|
||||
|
||||
- Running tests on Chromium
|
||||
|
||||
```bash
|
||||
pytest
|
||||
```
|
||||
|
||||
- Running a single test file
|
||||
|
||||
```bash
|
||||
pytest test_login.py
|
||||
```
|
||||
|
||||
- Run a set of test files
|
||||
|
||||
```bash
|
||||
pytest tests/todo-page/ tests/landing-page/
|
||||
```
|
||||
|
||||
- Run the test with the function name
|
||||
|
||||
```bash
|
||||
pytest -k "test_add_a_todo_item"
|
||||
```
|
||||
|
||||
- Running tests in headed mode
|
||||
|
||||
```bash
|
||||
pytest --headed test_login.py
|
||||
```
|
||||
|
||||
- Running Tests on specific browsers
|
||||
|
||||
```bash
|
||||
pytest test_login.py --browser webkit
|
||||
```
|
||||
|
||||
- Running Tests on multiple browsers
|
||||
|
||||
```bash
|
||||
pytest test_login.py --browser webkit --browser firefox
|
||||
```
|
||||
|
||||
For more information see [Playwright Pytest usage](./test-runners.md) or the Pytest documentation for [general CLI usage](https://docs.pytest.org/en/stable/usage.html).
|
||||
|
||||
## What's Next
|
||||
|
||||
- [Debug tests with the Playwright Debugger](./debug.md)
|
||||
- [Generate tests with Codegen](./codegen.md)
|
||||
- [See a trace of your tests](./trace-viewer.md)
|
||||
|
|
@ -5,6 +5,8 @@ title: "Selectors"
|
|||
|
||||
Selectors are strings that are used to create [Locator]s. Locators are used to perform actions on the elements by means of methods such as [`method: Locator.click`], [`method: Locator.fill`] and alike.
|
||||
|
||||
Writing good selectors is part art, part science so be sure to checkout the [Best Practices](#best-practices) section.
|
||||
|
||||
<!-- TOC -->
|
||||
|
||||
## Quick guide
|
||||
|
|
|
|||
|
|
@ -545,6 +545,72 @@ export default config;
|
|||
|
||||
However, most common ones like `headless` or `viewport` are available directly in the `use` section - see [basic options](#basic-options), [emulation](#emulation) or [network](#network).
|
||||
|
||||
## Explicit Context Creation and Option Inheritance
|
||||
|
||||
If using the built-in `browser` fixture, calling [`method: Browser.newContext`] will create a context with options inherted from the config:
|
||||
|
||||
```js tab=js-ts
|
||||
// playwright.config.ts
|
||||
import type { PlaywrightTestConfig } from "@playwright/test";
|
||||
|
||||
const config: PlaywrightTestConfig = {
|
||||
use: {
|
||||
userAgent: 'some custom ua',
|
||||
viewport: { width: 100, height: 100 },
|
||||
},
|
||||
};
|
||||
|
||||
export default config;
|
||||
```
|
||||
|
||||
```js tab=js-js
|
||||
// @ts-check
|
||||
// example.spec.js
|
||||
|
||||
/** @type {import('@playwright/test').PlaywrightTestConfig} */
|
||||
const config = {
|
||||
use: {
|
||||
userAgent: 'some custom ua',
|
||||
viewport: { width: 100, height: 100 },
|
||||
},
|
||||
};
|
||||
|
||||
module.exports = config;
|
||||
```
|
||||
|
||||
An example test illustrating the initial context options are set:
|
||||
|
||||
```js tab=js-ts
|
||||
// example.spec.ts
|
||||
import { test, expect } from "@playwright/test";
|
||||
|
||||
test('should inherit use options on context when using built-in browser fixture', async ({
|
||||
browser,
|
||||
}) => {
|
||||
const context = await browser.newContext();
|
||||
const page = await context.newPage();
|
||||
expect(await page.evaluate(() => navigator.userAgent)).toBe('some custom ua');
|
||||
expect(await page.evaluate(() => window.innerWidth)).toBe(100);
|
||||
await context.close();
|
||||
});
|
||||
```
|
||||
|
||||
```js tab=js-js
|
||||
// @ts-check
|
||||
// example.spec.ts
|
||||
const { test, expect } = require("@playwright/test");
|
||||
|
||||
test('should inherit use options on context when using built-in browser fixture', async ({
|
||||
browser,
|
||||
}) => {
|
||||
const context = await browser.newContext();
|
||||
const page = await context.newPage();
|
||||
expect(await page.evaluate(() => navigator.userAgent)).toBe('some custom ua');
|
||||
expect(await page.evaluate(() => window.innerWidth)).toBe(100);
|
||||
await context.close();
|
||||
});
|
||||
```
|
||||
|
||||
## Testing options
|
||||
|
||||
In addition to configuring [Browser] or [BrowserContext], videos or screenshots, Playwright Test has many options to configure how your tests are run. Below are the most common ones, see [TestConfig] for the full list.
|
||||
|
|
|
|||
|
|
@ -108,6 +108,69 @@ By default NUnit will run all test files in parallel, while running tests inside
|
|||
|
||||
For CPU-bound tests, we recommend using as many workers as there are cores on your system, divided by 2. For IO-bound tests you can use as many workers as you have cores.
|
||||
|
||||
### Customizing [BrowserContext] options
|
||||
|
||||
To customize context options, you can override the `ContextOptions` method of your test class derived from `Microsoft.Playwright.MSTest.PageTest` or `Microsoft.Playwright.MSTest.ContextTest`. See the following example:
|
||||
|
||||
```csharp
|
||||
using Microsoft.Playwright.NUnit;
|
||||
|
||||
namespace PlaywrightTests;
|
||||
|
||||
[Parallelizable(ParallelScope.Self)]
|
||||
public class MyTest : PageTest
|
||||
{
|
||||
[Test]
|
||||
public async Task TestWithCustomContextOptions()
|
||||
{
|
||||
// The following Page (and BrowserContext) instance has the custom colorScheme, viewport and baseURL set:
|
||||
await Page.GotoAsync("/login");
|
||||
}
|
||||
|
||||
public override BrowserNewContextOptions ContextOptions()
|
||||
{
|
||||
return new BrowserNewContextOptions()
|
||||
{
|
||||
ColorScheme = ColorScheme.Light,
|
||||
ViewportSize = new()
|
||||
{
|
||||
Width = 1920,
|
||||
Height = 1080
|
||||
},
|
||||
BaseURL = "https://github.com",
|
||||
};
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Customizing [Browser]/launch options
|
||||
|
||||
[Browser]/launch options can be override either using a run settings file or by setting the run settings options directly via the
|
||||
CLI. See the following example:
|
||||
|
||||
```xml
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<RunSettings>
|
||||
<TestRunParameters>
|
||||
<Parameter name="browser" value="chromium" />
|
||||
<Parameter name="headless" value="false" />
|
||||
<Parameter name="channel" value="msedge" />
|
||||
</TestRunParameters>
|
||||
</RunSettings>
|
||||
```
|
||||
|
||||
```bash tab=bash-bash
|
||||
dotnet test -- TestRunParameters.Parameter\(name=\"browser\", value=\"chromium\"\) TestRunParameters.Parameter\(name=\"headless\", value=\"false\"\) TestRunParameters.Parameter\(name=\"channel\", value=\"msedge\"\)
|
||||
```
|
||||
|
||||
```batch tab=bash-batch
|
||||
dotnet test -- TestRunParameters.Parameter(name=\"browser\", value=\"chromium\") TestRunParameters.Parameter(name=\"headless\", value=\"false\") TestRunParameters.Parameter(name=\"channel\", value=\"msedge\")
|
||||
```
|
||||
|
||||
```powershell tab=bash-powershell
|
||||
dotnet test -- TestRunParameters.Parameter(name=\"browser\", value=\"chromium\") TestRunParameters.Parameter(name=\"headless\", value=\"false\") TestRunParameters.Parameter(name=\"channel\", value=\"msedge\")
|
||||
```
|
||||
|
||||
### Using Verbose API Logs
|
||||
|
||||
When you have enabled the [verbose API log](./debug.md#verbose-api-logs), via the `DEBUG` environment variable, you will see the messages in the standard error stream. In NUnit, within Visual Studio, that will be the `Tests` pane of the `Output` window. It will also be displayed in the `Test Log` for each test.
|
||||
|
|
@ -247,6 +310,73 @@ By default MSTest will run all classes in parallel, while running tests inside e
|
|||
dotnet test --settings:.runsettings -- MSTest.Parallelize.Workers=4
|
||||
```
|
||||
|
||||
### Customizing [BrowserContext] options
|
||||
|
||||
To customize context options, you can override the `ContextOptions` method of your test class derived from `Microsoft.Playwright.MSTest.PageTest` or `Microsoft.Playwright.MSTest.ContextTest`. See the following example:
|
||||
|
||||
```csharp
|
||||
using System.Threading.Tasks;
|
||||
using Microsoft.Playwright;
|
||||
using Microsoft.Playwright.MSTest;
|
||||
using Microsoft.VisualStudio.TestTools.UnitTesting;
|
||||
|
||||
namespace PlaywrightTests;
|
||||
|
||||
[TestClass]
|
||||
public class UnitTest1 : PageTest
|
||||
{
|
||||
[TestMethod]
|
||||
public async Task TestWithCustomContextOptions()
|
||||
{
|
||||
// The following Page (and BrowserContext) instance has the custom colorScheme, viewport and baseURL set:
|
||||
await Page.GotoAsync("/login");
|
||||
}
|
||||
|
||||
public override BrowserNewContextOptions ContextOptions()
|
||||
{
|
||||
return new BrowserNewContextOptions()
|
||||
{
|
||||
ColorScheme = ColorScheme.Light,
|
||||
ViewportSize = new()
|
||||
{
|
||||
Width = 1920,
|
||||
Height = 1080
|
||||
},
|
||||
BaseURL = "https://github.com",
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
### Customizing [Browser]/launch options
|
||||
|
||||
[Browser]/launch options can be override either using a run settings file or by setting the run settings options directly via the
|
||||
CLI. See the following example:
|
||||
|
||||
```xml
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<RunSettings>
|
||||
<TestRunParameters>
|
||||
<Parameter name="browser" value="chromium" />
|
||||
<Parameter name="headless" value="false" />
|
||||
<Parameter name="channel" value="msedge" />
|
||||
</TestRunParameters>
|
||||
</RunSettings>
|
||||
```
|
||||
|
||||
```bash tab=bash-bash
|
||||
dotnet test -- TestRunParameters.Parameter\(name=\"browser\", value=\"chromium\"\) TestRunParameters.Parameter\(name=\"headless\", value=\"false\"\) TestRunParameters.Parameter\(name=\"channel\", value=\"msedge\"\)
|
||||
```
|
||||
|
||||
```batch tab=bash-batch
|
||||
dotnet test -- TestRunParameters.Parameter(name=\"browser\", value=\"chromium\") TestRunParameters.Parameter(name=\"headless\", value=\"false\") TestRunParameters.Parameter(name=\"channel\", value=\"msedge\")
|
||||
```
|
||||
|
||||
```powershell tab=bash-powershell
|
||||
dotnet test -- TestRunParameters.Parameter(name=\"browser\", value=\"chromium\") TestRunParameters.Parameter(name=\"headless\", value=\"false\") TestRunParameters.Parameter(name=\"channel\", value=\"msedge\")
|
||||
```
|
||||
|
||||
### Using Verbose API Logs
|
||||
|
||||
When you have enabled the [verbose API log](./debug.md#verbose-api-logs), via the `DEBUG` environment variable, you will see the messages in the standard error stream. In MSTest, within Visual Studio, that will be the `Tests` pane of the `Output` window. It will also be displayed in the `Test Log` for each test.
|
||||
|
|
|
|||
|
|
@ -1,42 +1,16 @@
|
|||
---
|
||||
id: test-runners
|
||||
title: "Pytest plugin"
|
||||
title: "Pytest Plugin Reference"
|
||||
---
|
||||
|
||||
Write end-to-end tests for your web apps with [Pytest](https://docs.pytest.org/en/stable/).
|
||||
|
||||
<!-- TOC -->
|
||||
Playwright provides a [Pytest](https://docs.pytest.org/en/stable/) plugin to write end-to-end tests. To get started with it, refer to the [getting started guide](./intro.md).
|
||||
|
||||
## Usage
|
||||
|
||||
```bash
|
||||
pip install pytest-playwright
|
||||
```
|
||||
|
||||
Use the `page` fixture to write a basic test. See [more examples](#examples).
|
||||
|
||||
```py
|
||||
# test_my_application.py
|
||||
def test_example_is_working(page):
|
||||
page.goto("https://example.com")
|
||||
assert page.inner_text('h1') == 'Example Domain'
|
||||
page.locator("text=More information").click()
|
||||
```
|
||||
|
||||
To run your tests, use pytest CLI.
|
||||
To run your tests, use [Pytest](https://docs.pytest.org/en/stable/) CLI.
|
||||
|
||||
```bash
|
||||
# Run tests (Chromium and headless by default)
|
||||
pytest
|
||||
|
||||
# Run tests in headed mode
|
||||
pytest --headed
|
||||
|
||||
# Run tests in a different browser (chromium, firefox, webkit)
|
||||
pytest --browser firefox
|
||||
|
||||
# Run tests in multiple browsers
|
||||
pytest --browser chromium --browser webkit
|
||||
pytest --browser webkit --headedd
|
||||
```
|
||||
|
||||
If you want to add the CLI arguments automatically without specifying them, you can use the [pytest.ini](https://docs.pytest.org/en/stable/reference.html#ini-options-ref) file:
|
||||
|
|
|
|||
|
|
@ -70,7 +70,7 @@ npx playwright test --update-snapshots
|
|||
> Note that `snapshotName` also accepts an array of path segments to the snapshot file such as `expect().toHaveScreenshot(['relative', 'path', 'to', 'snapshot.png'])`.
|
||||
> However, this path must stay within the snapshots directory for each test file (i.e. `a.spec.js-snapshots`), otherwise it will throw.
|
||||
|
||||
Playwright Test uses the [pixelmatch](https://github.com/mapbox/pixelmatch) library. You can [pass various options](./test-assertions#expectpageorlocatortomatchsnapshot-options) to modify its behavior:
|
||||
Playwright Test uses the [pixelmatch](https://github.com/mapbox/pixelmatch) library. You can [pass various options](./test-assertions#page-assertions-to-have-screenshot-2) to modify its behavior:
|
||||
|
||||
```js tab=js-js
|
||||
// example.spec.js
|
||||
|
|
|
|||
238
docs/src/writing-tests-csharp.md
Normal file
238
docs/src/writing-tests-csharp.md
Normal file
|
|
@ -0,0 +1,238 @@
|
|||
---
|
||||
id: writing-tests
|
||||
title: "Writing Tests"
|
||||
---
|
||||
|
||||
Playwright assertions are created specifically for the dynamic web. Checks are automatically retried until the necessary conditions are met. Playwright comes with [auto-wait](./actionability.md) built in meaning it waits for elements to be actionable prior to performing actions. Playwright provides the [Expect](./test-assertions) function to write assertions.
|
||||
|
||||
Take a look at the example test below to see how to write a test using web first assertions, locators and selectors.
|
||||
|
||||
<Tabs
|
||||
defaultValue="nunit"
|
||||
values={[
|
||||
{label: 'NUnit', value: 'nunit'},
|
||||
{label: 'MSTest', value: 'mstest'}
|
||||
]
|
||||
}>
|
||||
<TabItem value="nunit">
|
||||
|
||||
```csharp
|
||||
using System.Text.RegularExpressions;
|
||||
using Microsoft.Playwright.NUnit;
|
||||
|
||||
namespace PlaywrightTests;
|
||||
|
||||
[Parallelizable(ParallelScope.Self)]
|
||||
public class Tests : PageTest
|
||||
{
|
||||
[Test]
|
||||
async public Task HomepageHasPlaywrightInTitleAndGetStartedLinkLinkingtoTheIntroPage()
|
||||
{
|
||||
await Page.GotoAsync("https://playwright.dev");
|
||||
|
||||
// Expect a title "to contain" a substring.
|
||||
await Expect(Page).ToHaveTitleAsync(new Regex("Playwright"));
|
||||
|
||||
// create a locator
|
||||
var getStarted = Page.Locator("text=Get Started");
|
||||
|
||||
// Expect an attribute "to be strictly equal" to the value.
|
||||
await Expect(getStarted).ToHaveAttributeAsync("href", "/docs/intro");
|
||||
|
||||
// Click the get started link.
|
||||
await getStarted.ClickAsync();
|
||||
|
||||
// Expects the URL to contain intro.
|
||||
await Expect(Page).ToHaveURLAsync(new Regex(".*intro"));
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="mstest">
|
||||
|
||||
```csharp
|
||||
using System.Text.RegularExpressions;
|
||||
using Microsoft.Playwright.MSTest;
|
||||
|
||||
namespace PlaywrightTests;
|
||||
|
||||
public class UnitTest1 : PageTest
|
||||
{
|
||||
[TestMethod]
|
||||
async public Task HomepageHasPlaywrightInTitleAndGetStartedLinkLinkingtoTheIntroPage()
|
||||
{
|
||||
await Page.GotoAsync("https://playwright.dev");
|
||||
|
||||
// Expect a title "to contain" a substring.
|
||||
await Expect(Page).ToHaveTitleAsync(new Regex("Playwright"));
|
||||
|
||||
// create a locator
|
||||
var getStarted = Page.Locator("text=Get Started");
|
||||
|
||||
// Expect an attribute "to be strictly equal" to the value.
|
||||
await Expect(getStarted).ToHaveAttributeAsync("href", "/docs/intro");
|
||||
|
||||
// Click the get started link.
|
||||
await getStarted.ClickAsync();
|
||||
|
||||
// Expects the URL to contain intro.
|
||||
await Expect(Page).ToHaveURLAsync(new Regex(".*intro"));
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
### Assertions
|
||||
|
||||
Playwright provides an async function called [Expect](./test-assertions) to assert and wait until the expected condition is met.
|
||||
|
||||
```csharp
|
||||
await Expect(Page).ToHaveTitleAsync(new Regex("Playwright"));
|
||||
```
|
||||
|
||||
|
||||
### Locators
|
||||
|
||||
[Locators](./locators.md) are the central piece of Playwright's auto-waiting and retry-ability. Locators represent a way to find element(s) on the page at any moment and are used to perform actions on elements such as `.ClickAsync` `.FillAsync` etc. Custom locators can be created with the [`method: Page.locator`] method.
|
||||
|
||||
```csharp
|
||||
var getStarted = Page.Locator("text=Get Started");
|
||||
|
||||
await Expect(getStarted).ToHaveAttributeAsync("href", "/docs/installation");
|
||||
await getStarted.ClickAsync();
|
||||
```
|
||||
|
||||
[Selectors](./selectors.md) are strings that are used to create Locators. Playwright supports many different selectors like [Text](./selectors.md#text-selector), [CSS](./selectors.md#css-selector), [XPath](./selectors.md#xpath-selectors) and many more. Learn more about available selectors and how to pick one in this [in-depth guide](./selectors.md).
|
||||
|
||||
```csharp
|
||||
await Expect(Page.Locator("text=Installation")).ToBeVisibleAsync();
|
||||
```
|
||||
|
||||
|
||||
### Test Isolation
|
||||
|
||||
The Playwright NUnit and MSTest test framework base classes will isolate each test from each other by providing a separate `Page` instance. Pages are isolated between tests due to the Browser Context, which is equivalent to a brand new browser profile, where every test gets a fresh environment, even when multiple tests run in a single Browser.
|
||||
|
||||
<Tabs
|
||||
defaultValue="nunit"
|
||||
values={[
|
||||
{label: 'NUnit', value: 'nunit'},
|
||||
{label: 'MSTest', value: 'mstest'}
|
||||
]
|
||||
}>
|
||||
<TabItem value="nunit">
|
||||
|
||||
```csharp
|
||||
using System.Threading.Tasks;
|
||||
using Microsoft.Playwright.NUnit;
|
||||
using NUnit.Framework;
|
||||
|
||||
namespace PlaywrightTests;
|
||||
|
||||
[Parallelizable(ParallelScope.Self)]
|
||||
public class Tests : PageTest
|
||||
{
|
||||
[Test]
|
||||
public async Task BasicTest()
|
||||
{
|
||||
await Page.GotoAsync("https://playwright.dev");
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="mstest">
|
||||
|
||||
```csharp
|
||||
using Microsoft.Playwright.MSTest;
|
||||
|
||||
namespace PlaywrightTests;
|
||||
|
||||
public class UnitTest1 : PageTest
|
||||
{
|
||||
[TestMethod]
|
||||
public async Task BasicTest()
|
||||
{
|
||||
await Page.GotoAsync("https://playwright.dev");
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
### Using Test Hooks
|
||||
|
||||
You can use `SetUp`/`TearDown` in NUnit or `TestInitialize`/`TestCleanup` in MSTest to prepare and clean up your test environment:
|
||||
|
||||
<Tabs
|
||||
defaultValue="nunit"
|
||||
values={[
|
||||
{label: 'NUnit', value: 'nunit'},
|
||||
{label: 'MSTest', value: 'mstest'}
|
||||
]
|
||||
}>
|
||||
<TabItem value="nunit">
|
||||
|
||||
```csharp
|
||||
using System.Threading.Tasks;
|
||||
using Microsoft.Playwright.NUnit;
|
||||
using NUnit.Framework;
|
||||
|
||||
namespace PlaywrightTests;
|
||||
|
||||
[Parallelizable(ParallelScope.Self)]
|
||||
public class Tests : PageTest
|
||||
{
|
||||
[Test]
|
||||
public async Task MainNavigation()
|
||||
{
|
||||
// Assertions use the expect API.
|
||||
await Expect(Page).ToHaveURLAsync("https://playwright.dev/");
|
||||
}
|
||||
|
||||
[SetUp]
|
||||
public async Task SetUp()
|
||||
{
|
||||
await Page.GotoAsync("https://playwright.dev");
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="mstest">
|
||||
|
||||
```csharp
|
||||
using Microsoft.Playwright.MSTest;
|
||||
|
||||
namespace PlaywrightTests;
|
||||
|
||||
public class UnitTest1 : PageTest
|
||||
{
|
||||
[TestMethod]
|
||||
public async Task MainNavigation()
|
||||
{
|
||||
// Assertions use the expect API.
|
||||
await Expect(Page).ToHaveURLAsync("https://playwright.dev/");
|
||||
}
|
||||
|
||||
[TestInitialize]
|
||||
public async Task TestInitialize()
|
||||
{
|
||||
await Page.GotoAsync("https://playwright.dev");
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## What's Next
|
||||
|
||||
- [Run single tests, multiple tests, headed mode](./running-tests.md)
|
||||
- [Debug tests with the Playwright Debugger](./debug.md)
|
||||
- [Generate tests with Codegen](./codegen.md)
|
||||
- [See a trace of your tests](./trace-viewer.md)
|
||||
|
|
@ -3,7 +3,7 @@ id: writing-tests
|
|||
title: "Writing Tests"
|
||||
---
|
||||
|
||||
Playwright assertions are created specifically for the dynamic web. Checks are automatically retried until the necessary conditions are met. Playwright comes with auto-wait built in meaning it waits for elements to be actionable prior to performing actions. Playwright provides a [test](./api/class-test.md) function to declare tests and the [expect](https://jestjs.io/docs/expect) function to write assertions.
|
||||
Playwright assertions are created specifically for the dynamic web. Checks are automatically retried until the necessary conditions are met. Playwright comes with [auto-wait](./actionability.md) built in meaning it waits for elements to be actionable prior to performing actions. Playwright provides a [test](./api/class-test.md) function to declare tests and the [expect](https://jestjs.io/docs/expect) function to write assertions.
|
||||
|
||||
Take a look at the example test included when installing Playwright to see how to write a test using web first assertions, locators and selectors.
|
||||
|
||||
|
|
@ -69,7 +69,7 @@ await expect(page).toHaveTitle(/Playwright/);
|
|||
|
||||
### Locators
|
||||
|
||||
[Locators](./locators.md) are the central piece of Playwright's auto-waiting and retry-ability. Locators represent a way to find element(s) on the page at any moment and are used to perform actions on elements such as .click. fill etc. Custom locators can be created with the [`method: Page.locator`] method.
|
||||
[Locators](./locators.md) are the central piece of Playwright's auto-waiting and retry-ability. Locators represent a way to find element(s) on the page at any moment and are used to perform actions on elements such as `.click` `.fill` etc. Custom locators can be created with the [`method: Page.locator`] method.
|
||||
|
||||
```js
|
||||
const getStarted = page.locator('text=Get Started');
|
||||
|
|
@ -78,7 +78,8 @@ await expect(getStarted).toHaveAttribute('href', '/docs/installation');
|
|||
await getStarted.click();
|
||||
```
|
||||
|
||||
[Selectors](./selectors.md) are strings that are used to create Locators. Playwright supports many different selectors like [Text](./selectors.md#text-selector), [CSS](./selectors.md#css-selector), [XPath](./selectors.md#xpath-selectors) and many more.
|
||||
[Selectors](./selectors.md) are strings that are used to create Locators. Playwright supports many different selectors like [Text](./selectors.md#text-selector), [CSS](./selectors.md#css-selector), [XPath](./selectors.md#xpath-selectors) and many more. Learn more about available selectors and how to pick one in this [in-depth guide](./selectors.md).
|
||||
|
||||
|
||||
```js
|
||||
await expect(page.locator('text=Installation')).toBeVisible();
|
||||
|
|
|
|||
110
docs/src/writing-tests-python.md
Normal file
110
docs/src/writing-tests-python.md
Normal file
|
|
@ -0,0 +1,110 @@
|
|||
---
|
||||
id: writing-tests
|
||||
title: "Writing Tests"
|
||||
---
|
||||
|
||||
Playwright assertions are created specifically for the dynamic web. Checks are automatically retried until the necessary conditions are met. Playwright comes with [auto-wait](./actionability.md) built in meaning it waits for elements to be actionable prior to performing actions. Playwright provides an [expect](./test-assertions.md) function to write assertions.
|
||||
|
||||
Take a look at the example test below to see how to write a test using web first assertions, locators and selectors.
|
||||
|
||||
```python
|
||||
import re
|
||||
from playwright.sync_api import Page, expect
|
||||
|
||||
|
||||
def test_homepage_has_Playwright_in_title_and_get_started_link_linking_to_the_intro_page(
|
||||
page: Page, foo
|
||||
):
|
||||
page.goto("https://playwright.dev/")
|
||||
|
||||
# Expect a title "to contain" a substring.
|
||||
expect(page).to_have_title(re.compile("Playwright"))
|
||||
|
||||
# create a locator
|
||||
get_started = page.locator("text=Get Started")
|
||||
|
||||
# Expect an attribute "to be strictly equal" to the value.
|
||||
expect(get_started).to_have_attribute("href", "/docs/intro")
|
||||
|
||||
# Click the get started link.
|
||||
get_started.click()
|
||||
|
||||
# Expects the URL to contain intro.
|
||||
expect(page).to_have_url(re.compile(".*intro"))
|
||||
```
|
||||
|
||||
|
||||
### Assertions
|
||||
|
||||
Playwright provides the [`expect`](./test-assertions.md) function which will wait until the expected condition is met.
|
||||
|
||||
```python
|
||||
import re
|
||||
from playwright.sync_api import expect
|
||||
|
||||
expect(page).to_have_title(re.compile("Playwright"))
|
||||
```
|
||||
|
||||
|
||||
### Locators
|
||||
|
||||
[Locators](./locators.md) are the central piece of Playwright's auto-waiting and retry-ability. Locators represent a way to find element(s) on the page at any moment and are used to perform actions on elements such as `.click` `.fill` etc. Custom locators can be created with the [`method: Page.locator`] method.
|
||||
|
||||
```python
|
||||
from playwright.sync_api import expect
|
||||
|
||||
get_started = page.locator("text=Get Started")
|
||||
|
||||
expect(get_started).to_have_attribute("href", "/docs/installation")
|
||||
get_started.click()
|
||||
```
|
||||
|
||||
[Selectors](./selectors.md) are strings that are used to create Locators. Playwright supports many different selectors like [Text](./selectors.md#text-selector), [CSS](./selectors.md#css-selector), [XPath](./selectors.md#xpath-selectors) and many more. Learn more about available selectors and how to pick one in this [in-depth guide](./selectors.md).
|
||||
|
||||
|
||||
```python
|
||||
from playwright.sync_api import expect
|
||||
|
||||
expect(page.locator("text=Installation")).to_be_visible()
|
||||
```
|
||||
|
||||
|
||||
### Test Isolation
|
||||
|
||||
The Playwright Pytest plugin is based on the concept of test fixtures such as the [built in page fixture](./test-runners.md), which is passed into your test. Pages are isolated between tests due to the Browser Context, which is equivalent to a brand new browser profile, where every test gets a fresh environment, even when multiple tests run in a single Browser.
|
||||
|
||||
```python
|
||||
from playwright.sync_api import Page
|
||||
|
||||
def test_basic_test(page: Page):
|
||||
# ...
|
||||
```
|
||||
|
||||
### Using Test Hooks
|
||||
|
||||
You can use various [fixtures](https://docs.pytest.org/en/6.2.x/fixture.html#autouse-fixtures-fixtures-you-don-t-have-to-request) to execute code before or after your tests and to share objects between them. A `function` scoped fixture e.g. with autouse behaves like a beforeEach/afterEach. And a `module` scoped fixture with autouse behaves like a beforeAll/afterAll which runs before all and after all the tests.
|
||||
|
||||
```python
|
||||
import pytest
|
||||
from playwright.sync_api import Page
|
||||
|
||||
|
||||
@pytest.fixture(scope="function", autouse=True)
|
||||
def before_each_after_each(page: Page):
|
||||
print("beforeEach")
|
||||
# Go to the starting url before each test.
|
||||
page.goto("https://playwright.dev/")
|
||||
yield
|
||||
print("afterEach")
|
||||
|
||||
def test_main_navigation(page: Page):
|
||||
# Assertions use the expect API.
|
||||
expect(page).to_have_url("https://playwright.dev/")
|
||||
```
|
||||
|
||||
## What's Next
|
||||
|
||||
- [Run single tests, multiple tests, headed mode](./running-tests.md)
|
||||
- [Debug tests with the Playwright Debugger](./debug.md)
|
||||
- [Generate tests with Codegen](./codegen.md)
|
||||
- [See a trace of your tests](./trace-viewer.md)
|
||||
Loading…
Reference in a new issue