Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Update Readme.md: Overhaul :-) #7

Closed
wants to merge 4 commits into from
Closed
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 25 additions & 40 deletions Readme.md
Original file line number Diff line number Diff line change
@@ -1,74 +1,63 @@

# Playwright module for Codeception

🚀 This is the **first and the only module that allows [Playwright](https://playwright.dev) testing in PHP**. Playwright allows testing in Chrome, Firefox, Webkit (safari). It is faster and more reliable alternative to Selenium WebDriver. Finally it is available in PHP!
🚀 This is the **first and the only library that features [Playwright](https://playwright.dev) testing in PHP**. Playwright allows testing in Chrome, Firefox, Webkit (safari). It is faster and more reliable alternative to Selenium WebDriver. Finally it is available in PHP!

This module does not implement Playwright API in PHP, rather proxies requests to Playwright helper of [CodeceptJS](https://codecept.io). This is possible because Codeception and CodeceptJS share the same architecture principles, and the interface for web testing is quite the same.

> [!Warning]
> This module is experimental. It is in early development stage. Please report any issues you find.

> [!Note]
> This module can be used as a replacement for WebDriver module. Comparing to WebDriver module, Playwright module can **speed up your tests x3 times**, run in headless mode, record videos, and stack traces out of the box
> This module can be used as a drop-in replacement for Codeception's [module WebDriver](https://codeception.com/docs/modules/WebDriver). Comparing to WebDriver, Playwright can **speed up your tests x3 times**, run in headless mode, record videos and stack traces out of the box
> Since this module provides the same API as module WebDriver, you can use it in your tests without any changes.

## Requirements

* PHP 8.1+
* NodeJS 20+
* [Node.js 20+](https://nodejs.org/)

## Installation

> [!Warning]
> This module is experimental. It is in early development stage. Please report any issues you find.

Install NodeJS part of this module, it will install Playwright and CodeceptJS

```
Install the Node.js part of this module; this will install Playwright and CodeceptJS:
```bash
npm install codeception-module-playwright
```
Install Playwright browsers

```
```bash
npx playwright install --with-deps
```

Install PHP part of this module

Install the PHP part of this module:
```bash
composer require codeception/module-playwright --dev
```

## Configuration

Enable module in `codeception.yml`:
Enable the module in `codeception.yml`:

```yaml
modules:
enabled:
- Playwright:
url: 'http://localhost'
browser: 'chromium'
show: true
url: 'http://localhost' # Base url to open pages from
browser: 'chromium' # Either `chromium`, `firefox`, `webkit`
show: true # Show the browser (=default) or run tests in headless mode
timeout: 5000 # Timeout (in ms) for all Playwright operations. Default: 5000
pw_start: true # Start Playwright server (proxy to CodeceptJS) automatically. Set to `false` and run the server manually in case the server doesn't start.
pw_server: http://localhost:8191 # Url of Playwright server. Default: http://localhost:8191
pw_debug: false # Print Playwright server debug information. Default: false
video: true # Save video on fail
trace: true # Save stack traces on fail
```
Most common config values are:

* `url` - base url to open pages from
* `browser` - either `chromium`, `firefox`, `webkit`
* `show` - (default: `true`) to show browser or set to `false` to run tests in headless mode
* `timeout` - (default: `5000`) timeout (in ms) for all Playwright operations
* `pw_start` - (default: `true`) start Playwright Server (Proxy to CodeceptJS) automatically. Set to `false` and run server manually in case server doesn't start.
* `pw_server` - (default: 'http://localhost:8191') url of Playwright Server
* `pw_debug` - (default: `false`) print Playwright Server debug information
* `video` - save video on fail
* `trace` - save traces on fail

More configuration options are is listed on [CodeceptJS Playwright page](https://codecept.io/helpers/Playwright/#configuration)

More configuration options are listed on [CodeceptJS Playwright page](https://codecept.io/helpers/Playwright/#configuration)

> [!Tip]
> This module is designed as drop-in WebDriver module replacement, you can change `WebDriver` to `Playwright` in your tests and try how it works!

> If you're switching from WebDriver, just change `WebDriver` to `Playwright` and see how it works!

## Usage

Playwright module requires NodeJS server to be running. Playwright module will start it and stop automatically. Default port is **8191**.
Playwright module requires the Node.js server to be running. Playwright module will start it and stop automatically. Default port is **8191**.

If you want to disable automatic server start, set `start` option to `false`:

Expand Down Expand Up @@ -104,11 +93,7 @@ modules:

## API

This module provides the same API as WebDriver module. You can try to use it in your tests without any changes.

For the full command list see [WebDriver module reference](https://codeception.com/docs/modules/WebDriver#dontSeeElement).

Playwright-specific commands are also available in [CodeceptJS Playwright Helper](https://codecept.io/helpers/Playwright/)
Besides supporting all commands of Module Webdriver, there are Playwright-specific commands available in [CodeceptJS Playwright Helper](https://codecept.io/helpers/Playwright/).

## Example

Expand Down
Loading