playwright/docs/src/running-tests-js.md

174 lines
8.3 KiB
Markdown
Raw Normal View History

---
id: running-tests
2023-09-15 22:01:08 +02:00
title: "Running and debugging tests"
---
## Introduction
With Playwright you can run a single test, a set of tests or all tests. Tests can be run on one browser or multiple browsers by using the `--project` flag. Tests are run in parallel by default and 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. However, you can run tests in headed mode by using the `--headed` CLI argument, or you can run your tests in [UI mode](./test-ui-mode.md) by using the `--ui` flag. See a full trace of your tests complete with watch mode, time travel debugging and more.
**You will learn**
- [How to run tests from the command line](/running-tests.md#command-line)
- [How to debug tests](/running-tests.md#debugging-tests)
- [How to open the HTML test reporter](/running-tests.md#test-reports)
2023-09-15 22:01:08 +02:00
## Running tests
### Command line
You can run your tests with the `playwright test` command. This will run your tests on all browsers as configured in the `playwright.config` file. Tests run in headless mode by default meaning no browser window will be opened while running the tests and results will be seen in the terminal.
```bash
npx playwright test
```
![tests running in command line](https://github.com/microsoft/playwright/assets/13063165/981c1b2b-dc7e-4b85-b241-272b44da6628)
### Run tests in UI mode
We highly recommend running your tests with [UI Mode](./test-ui-mode.md) for a better developer experience where you can easily walk through each step of the test and visually see what was happening before, during and after each step. UI mode also comes with many other features such as the locator picker, watch mode and more.
```bash
npx playwright test --ui
```
![UI Mode](https://github.com/microsoft/playwright/assets/13063165/c5b501cc-4f5d-485a-87cc-66044c651786)
Check out or [detailed guide on UI Mode](./test-ui-mode.md) to learn more about it's features.
### Run tests in headed mode
To run your tests in headed mode, use the `--headed` flag. This will give you the ability to visually see how Playwright interacts with the website.
```bash
npx playwright test --headed
```
### Run tests on different browsers
To specify which browser you would like to run your tests on, use the `--project` flag followed by the name of the browser.
```bash
npx playwright test --project webkit
```
To specify multiple browsers to run your tests on, use the `--project` flag multiple times followed by the name of each browser.
```bash
npx playwright test --project webkit --project firefox
```
### Run specific tests
To run a single test file, pass in the name of the test file that you want to run.
```bash
npx playwright test landing-page.spec.ts
```
To run a set of test files from different directories, pass in the names of the directories that you want to run the tests in.
```bash
npx playwright test tests/todo-page/ tests/landing-page/
```
To run files that have `landing` or `login` in the file name, simply pass in these keywords to the CLI.
```bash
npx playwright test landing login
```
To run a test with a specific title, use the `-g` flag followed by the title of the test.
```bash
npx playwright test -g "add a todo item"
```
### Run last failed tests
To run only the tests that failed in the last test run, first run your tests and then run them again with the `--last-failed` flag.
```bash
npx playwright test --last-failed
```
2023-09-15 22:01:08 +02:00
### Run tests in VS Code
Tests can be run right from VS Code using the [VS Code extension](https://marketplace.visualstudio.com/items?itemName=ms-playwright.playwright). Once installed you can simply click the green triangle next to the test you want to run or run all tests from the testing sidebar. Check out our [Getting Started with VS Code](./getting-started-vscode.md#running-tests) guide for more details.
![Playwright VS Code extension](https://github.com/microsoft/playwright/assets/13063165/47726e70-683b-4bd5-94de-7d03dd45c30f)
## Debugging tests
Since Playwright runs in Node.js, you can debug it with your debugger of choice e.g. using `console.log` or inside your IDE or directly in VS Code with the [VS Code Extension](./getting-started-vscode.md). Playwright comes with [UI Mode](./test-ui-mode.md), where you can easily walk through each step of the test, see logs, errors, network requests, inspect the DOM snapshot and more. You can also use the [Playwright Inspector](./debug.md#playwright-inspector), which allows you to step through Playwright API calls, see their debug logs and explore [locators](./locators.md).
### Debug tests in UI mode
We highly recommend debugging your tests with [UI Mode](./test-ui-mode.md) for a better developer experience where you can easily walk through each step of the test and visually see what was happening before, during and after each step. UI mode also comes with many other features such as the locator picker, watch mode and more.
```bash
npx playwright test --ui
```
![showing errors in ui mode](https://github.com/microsoft/playwright/assets/13063165/ffca2fd1-5349-41fb-ade9-ace143bb2c58)
While debugging you can use the Pick Locator button to select an element on the page and see the locator that Playwright would use to find that element. You can also edit the locator in the locator playground and see it highlighting live on the Browser window. Use the Copy Locator button to copy the locator to your clipboard and then paste it into you test.
![pick locator in ui mode](https://github.com/microsoft/playwright/assets/13063165/9e7eeb84-bd26-4010-8614-75e24b56c716)
Check out our [detailed guide on UI Mode](./test-ui-mode.md) to learn more about it's features.
### Debug tests with the Playwright Inspector
To debug all tests, run the Playwright test command followed by the `--debug` flag.
```bash
npx playwright test --debug
```
![Debugging Tests with the Playwright inspector](https://github.com/microsoft/playwright/assets/13063165/6b3b3caa-d258-4cb8-aa05-cd407f501626)
This command will open up a Browser window as well as the Playwright Inspector. You can use the step over button at the top of the inspector to step through your test. Or, press the play button to run your test from start to finish. Once the test has finished, the browser window will close.
To debug one test file, run the Playwright test command with the name of the test file that you want to debug followed by the `--debug` flag.
```bash
npx playwright test example.spec.ts --debug
```
To debug a specific test from the line number where the `test(..` is defined, add a colon followed by the line number at the end of the test file name, followed by the `--debug` flag.
```bash
npx playwright test example.spec.ts:10 --debug
```
2023-12-03 00:35:51 +01:00
While debugging you can use the Pick Locator button to select an element on the page and see the locator that Playwright would use to find that element. You can also edit the locator and see it highlighting live on the Browser window. Use the Copy Locator button to copy the locator to your clipboard and then paste it into your test.
![Locator picker in the Playwright Inspector](https://github.com/microsoft/playwright/assets/13063165/013d5edb-583e-423a-bb53-9f57bab7f3e1)
Check out our [debugging guide](./debug.md) to learn more about debugging with the [VS Code debugger](./debug.md#vs-code-debugger), UI Mode and the [Playwright Inspector](./debug.md#playwright-inspector) as well as debugging with [Browser Developer tools](./debug.md#browser-developer-tools).
## Test reports
The [HTML Reporter](./test-reporters.md#html-reporter) shows you a full report of your tests allowing you to filter the report by browsers, passed tests, failed tests, skipped tests and flaky tests. By default, the HTML report is opened automatically if some of the tests failed, otherwise you can open it with the following command.
```bash
npx playwright show-report
```
![HTML Report](https://github.com/microsoft/playwright/assets/13063165/c5f60e56-fb75-4a2d-a4b6-054b8c5d69c1)
You can filter and search for tests as well as click on each test to see the tests errors and explore each step of the test.
![HTML Reporter detail view](https://github.com/microsoft/playwright/assets/13063165/f36ada14-4701-4534-a3be-ed22c2b16cf5)
## What's next
- [Generate tests with Codegen](./codegen-intro.md)
2022-08-10 14:34:27 +02:00
- [See a trace of your tests](./trace-viewer-intro.md)
- [Explore all the features of UI Mode](./test-ui-mode.md)
- [Run your tests on CI with GitHub Actions](./ci-intro.md)