Skip to content

Document the WebdriverClassic driver - #66

Merged
stof merged 2 commits into
FriendsOfBehat:2.xfrom
mpdude:document-webdriver-classic-driver
Sep 29, 2026
Merged

stof merged 2 commits into
FriendsOfBehat:2.xfrom
mpdude:document-webdriver-classic-driver

Conversation

@mpdude

@mpdude mpdude commented Sep 29, 2026 •

Copy link
Copy Markdown

PR #26 added support for the webdriver_classic driver (wrapping mink/webdriver-classic-driver), but doc/index.md was never updated to explain how to configure it.

This adds a driver entry to the "Drivers" section, next to Selenium2Driver and its flavors, following the existing style. It shows the browser, wd_host and capabilities options and notes that capabilities is merged with values Mink guesses automatically from the environment (e.g. CI build/tag information on Travis or Jenkins).

Closes #30

PR FriendsOfBehat#26 added support for the webdriver_classic driver (wrapping
mink/webdriver-classic-driver), but doc/index.md was never updated to
mention it. Add a driver entry following the existing style, showing
the browser, wd_host and capabilities options and noting that
capabilities are merged with values Mink guesses from the environment.

Closes FriendsOfBehat#30
Comment thread doc/index.md Outdated
browser_stack: ~
```

* **WebdriverClassicDriver** - javascript driver speaking the classic (JSON Wire Protocol-based) WebDriver protocol, the direct successor of Selenium2Driver. In order to use it, install [`mink/webdriver-classic-driver`](https://packagist.org/packages/mink/webdriver-classic-driver) through Composer. Then, modify your `behat.yml` profile:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suggest putting it before Selenium2Driver as it is meant to become the recommended driver for Webdriver over time (Selenium 4 speaks the W3C Webdriver protocol by default)

Comment thread doc/index.md Outdated
browser_stack: ~
```

* **WebdriverClassicDriver** - javascript driver speaking the classic (JSON Wire Protocol-based) WebDriver protocol, the direct successor of Selenium2Driver. In order to use it, install [`mink/webdriver-classic-driver`](https://packagist.org/packages/mink/webdriver-classic-driver) through Composer. Then, modify your `behat.yml` profile:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The WebdriverClassicDriver speaks the W3C Webdriver Classic protocol, not the JSON Wire Webdriver protocol (which is the name of the legacy Selenium Webdriver protocol)

Per @stof's review on the PR:
- Move the WebdriverClassicDriver entry before Selenium2Driver, since
  it's meant to become the recommended WebDriver driver over time
  (Selenium 4 speaks the W3C WebDriver protocol by default).
- Correct the protocol description: it speaks the W3C WebDriver
  (Classic) protocol, not the JSON Wire Protocol. The JSON Wire
  Protocol is the legacy, non-standard protocol name used by the old
  Selenium WebDriver implementation (i.e. Selenium2Driver), not
  something WebdriverClassicDriver speaks.
@mpdude
mpdude requested a review from stof September 29, 2026 14:29
@stof
stof merged commit 88dd9b4 into FriendsOfBehat:2.x Sep 29, 2026
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants