Merge pull request #696 from OndraM/feature/env-name

Change environment variable defining path to ChromeDriver executable

Author: OndraM

CHANGELOG.md

@@ -10,6 +10,7 @@ This project versioning adheres to [Semantic Versioning](http://semver.org/).
 ### Changed
 - Revert no longer needed workaround for Chromedriver bug [2943](https://bugs.chromium.org/p/chromedriver/issues/detail?id=2943).
 - Allow installation of Symfony 5 components.
+- Rename environment variable used to pass path to ChromeDriver executable from `webdriver.chrome.driver` to `WEBDRIVER_CHROME_DRIVER`. However the old one also still works to keep backward compatibility
 
 ### Fixed
 - `WebDriverExpectedCondition::presenceOfElementLocated()` works correctly when used within `WebDriverExpectedCondition::not()`.

lib/Chrome/ChromeDriverService.php

@@ -19,19 +19,23 @@
 
 class ChromeDriverService extends DriverService
 {
-    // The environment variable storing the path to the chrome driver executable.
+    /**
+     * The environment variable storing the path to the chrome driver executable.
+     * @deprecated Use ChromeDriverService::CHROME_DRIVER_EXECUTABLE
+     */
     const CHROME_DRIVER_EXE_PROPERTY = 'webdriver.chrome.driver';
+    // The environment variable storing the path to the chrome driver executable
+    const CHROME_DRIVER_EXECUTABLE = 'WEBDRIVER_CHROME_DRIVER';
 
     /**
      * @return static
      */
     public static function createDefaultService()
     {
-        $exe = getenv(self::CHROME_DRIVER_EXE_PROPERTY);
+        $exe = getenv(self::CHROME_DRIVER_EXECUTABLE) ?: getenv(self::CHROME_DRIVER_EXE_PROPERTY);
         $port = 9515; // TODO: Get another port if the default port is used.
-        $args = ["--port=$port"];
-        $service = new static($exe, $port, $args);
+        $args = ['--port=' . $port];
 
-        return $service;
+        return new static($exe, $port, $args);
     }
 }

tests/functional/Chrome/ChromeDriverServiceTest.php

@@ -34,7 +34,7 @@ protected function setUp()
     public function testShouldStartAndStopServiceCreatedUsingShortcutConstructor()
     {
         // The createDefaultService() method expect path to the executable to be present in the environment variable
-        putenv(ChromeDriverService::CHROME_DRIVER_EXE_PROPERTY . '=' . getenv('CHROMEDRIVER_PATH'));
+        putenv(ChromeDriverService::CHROME_DRIVER_EXECUTABLE . '=' . getenv('CHROMEDRIVER_PATH'));
 
         $driverService = ChromeDriverService::createDefaultService();
 
@@ -66,7 +66,7 @@ public function testShouldStartAndStopServiceCreatedUsingDefaultConstructor()
 
     public function testShouldThrowExceptionIfExecutableCannotBeFound()
     {
-        putenv(ChromeDriverService::CHROME_DRIVER_EXE_PROPERTY . '=/not/existing');
+        putenv(ChromeDriverService::CHROME_DRIVER_EXECUTABLE . '=/not/existing');
 
         $this->expectException(\Exception::class);
         $this->expectExceptionMessage('\'/not/existing\' is not a file.');
@@ -75,7 +75,7 @@ public function testShouldThrowExceptionIfExecutableCannotBeFound()
 
     public function testShouldThrowExceptionIfExecutableIsNotExecutable()
     {
-        putenv(ChromeDriverService::CHROME_DRIVER_EXE_PROPERTY . '=' . __FILE__);
+        putenv(ChromeDriverService::CHROME_DRIVER_EXECUTABLE . '=' . __FILE__);
 
         $this->expectException(\Exception::class);
         $this->expectExceptionMessage('is not executable');

tests/functional/Chrome/ChromeDriverTest.php

@@ -46,11 +46,11 @@ protected function tearDown()
     public function testShouldStartChromeDriver()
     {
         // The createDefaultService() method expect path to the executable to be present in the environment variable
-        putenv(ChromeDriverService::CHROME_DRIVER_EXE_PROPERTY . '=' . getenv('CHROMEDRIVER_PATH'));
+        putenv(ChromeDriverService::CHROME_DRIVER_EXECUTABLE . '=' . getenv('CHROMEDRIVER_PATH'));
 
         // Add --no-sandbox as a workaround for Chrome crashing: https://github.com/SeleniumHQ/selenium/issues/4961
         $chromeOptions = new ChromeOptions();
-        $chromeOptions->addArguments(['--no-sandbox']);
+        $chromeOptions->addArguments(['--no-sandbox', '--headless']);
         $desiredCapabilities = DesiredCapabilities::chrome();
         $desiredCapabilities->setCapability(ChromeOptions::CAPABILITY, $chromeOptions);