docs: python running tests guide (#26910)

This commit is contained in:
Debbie O'Brien 2023-09-07 15:47:40 +02:00 committed by GitHub
parent bf1f2d2c81
commit 9b99aea57f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -3,61 +3,76 @@ 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.
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 `--browser` flag. 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` CLI argument.
- Running tests on Chromium
**You will learn**
```bash
pytest
```
- [How to run tests from the command line](/running-tests.md#command-line)
- [How to debug tests](/running-tests.md#debugging-tests)
- Running a single test file
## Command Line
To run your tests use the `pytest` command. This will run your tests on the Chromium browser by default. 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
pytest
```
### Running tests headed
To run your tests in headed mode use the `--headed` flag. This will open up a browser window while running your tests.
```bash
pytest --headed
```
### Running tests on different browsers
To specify which browser you would like to run your tests on use the `--browser` flag followed by the name of the browser.
```bash
pytest --browser webkit
```
To specify multiple browsers to run your tests on use the `--browser` flag multiple times followed by the name of each browser.
```bash
pytest --browser webkit --browser firefox
```
### Running specific tests
To run a single test file pass in the name of the test file that you want to run.
```bash
pytest test_login.py
```
- Run a set of test files
To run a set of test files pass in the names of the test files that you want to run.
```bash
pytest tests/todo-page/ tests/landing-page/
pytest tests/test_todo_page.py tests/test_landing_page.py
```
- Run the test with the function name
To run a specific test pass in the function name of the test you want to run.
```bash
pytest -k "test_add_a_todo_item"
pytest -k test_add_a_todo_item
```
- Running tests in headed mode
### Run tests in Parallel
To run your tests in parallel use the `--numprocesses` flag followed by the number of processes you would like to run your tests on. We recommend half of logical CPU cores.
```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
```
- Running Tests in parallel
```bash
pytest --numprocesses auto
pytest --numprocesses 2
```
(This assumes `pytest-xdist` is installed. For more information see [here](./test-runners.md#parallelism-running-multiple-tests-at-once).)
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).
## Running Tests
## Debugging Tests
Since Playwright runs in Python, you can debug it with your debugger of choice with e.g. the [Python extension](https://code.visualstudio.com/docs/python/python-tutorial) in Visual Studio Code. Playwright comes with the Playwright Inspector which allows you to step through Playwright API calls, see their debug logs and explore [locators](./locators.md).