From 8fe1bc569480c8173c2b763495e0034d415e981d Mon Sep 17 00:00:00 2001 From: Thomas Landauer Date: Sun, 1 Nov 2020 23:37:05 +0100 Subject: [PATCH] Update WebDriver.php Reorganizing the docs about setup. First step of what I suggested at https://github.com/Codeception/module-webdriver/pull/30#issuecomment-720152810 --- src/Codeception/Module/WebDriver.php | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/src/Codeception/Module/WebDriver.php b/src/Codeception/Module/WebDriver.php index c7f1997..4051089 100644 --- a/src/Codeception/Module/WebDriver.php +++ b/src/Codeception/Module/WebDriver.php @@ -49,18 +49,24 @@ use Facebook\WebDriver\WebDriverSelect; /** - * New generation Selenium WebDriver module. + * Run tests in real browsers using the W3C [WebDriver protocol](https://www.w3.org/TR/webdriver/). * * ## Local Testing * + * ### Browsers: Chrome and/or Firefox + * + * First, you need to install the browser itself: Chrome and/or Firefox. + * * To run tests in Chrome/Chromium, you need to install [ChromeDriver](https://sites.google.com/a/chromium.org/chromedriver/getting-started). + * * To use Firefox, install [GeckoDriver](https://github.com/mozilla/geckodriver). + * If you want to use both, consider setting up a dedicated [Codeception environment](https://codeception.com/docs/07-AdvancedUsage#Environments) for each. + * * ### Selenium * * To run Selenium Server you need [Java](https://www.java.com/) as well as Chrome or Firefox browser installed. * * 1. Download [Selenium Standalone Server](http://docs.seleniumhq.org/download/) - * 2. To use Chrome, install [ChromeDriver](https://sites.google.com/a/chromium.org/chromedriver/getting-started). To use Firefox, install [GeckoDriver](https://github.com/mozilla/geckodriver). - * 3. Launch the Selenium Server: `java -jar selenium-server-standalone-3.xx.xxx.jar`. To locate Chromedriver binary use `-Dwebdriver.chrome.driver=./chromedriver` option. For Geckodriver use `-Dwebdriver.gecko.driver=./geckodriver`. - * 4. Configure this module (in `acceptance.suite.yml`) by setting `url` and `browser`: + * 2. Launch the Selenium Server: `java -jar selenium-server-standalone-3.xx.xxx.jar`. To locate Chromedriver binary use `-Dwebdriver.chrome.driver=./chromedriver` option. For Geckodriver use `-Dwebdriver.gecko.driver=./geckodriver`. + * 3. Configure this module (in `acceptance.suite.yml`) by setting `url` and `browser`: * * ```yaml * modules: