Merge pull request php-webdriver#274 from OndraM/improve-tests

Improve unit tests & codestyle

Author: gfosco

composer.json

@@ -26,7 +26,8 @@
   },
   "autoload-dev": {
     "psr-4": {
-      "Facebook\\WebDriver\\": "tests/functional"
-    }
+      "Facebook\\WebDriver\\": "tests/unit"
+    },
+    "classmap": ["tests/functional/"]
   }
 }

lib/Chrome/ChromeOptions.php

@@ -85,8 +85,7 @@ public function addExtensions(array $paths) {
   }
 
   /**
-   * @param array $encoded_extensions An array of base64 encoded of the
-   *                                  extensions.
+   * @param array $encoded_extensions An array of base64 encoded of the extensions.
    * @return ChromeOptions
    */
   public function addEncodedExtensions(array $encoded_extensions) {
@@ -109,8 +108,7 @@ public function setExperimentalOption($name, $value) {
   }
 
   /**
-   * @return DesiredCapabilities The DesiredCapabilities for Chrome with this
-   *                             options.
+   * @return DesiredCapabilities The DesiredCapabilities for Chrome with this options.
    */
   public function toCapabilities() {
     $capabilities = DesiredCapabilities::chrome();

lib/Firefox/FirefoxDriver.php

@@ -16,6 +16,9 @@
 namespace Facebook\WebDriver\Firefox;
 
 class FirefoxDriver {
-
   const PROFILE = 'firefox_profile';
+
+  private function __construct()
+  {
+  }
 }

lib/Firefox/FirefoxPreferences.php

@@ -0,0 +1,33 @@
+<?php
+// Copyright 2004-present Facebook. All Rights Reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+namespace Facebook\WebDriver\Firefox;
+
+/**
+ * Constants of common Firefox profile preferences (about:config values).
+ * @see http://kb.mozillazine.org/Firefox_:_FAQs_:_About:config_Entries
+ */
+class FirefoxPreferences {
+  /** @var string Port WebDriver uses to communicate with Firefox instance */
+  const WEBDRIVER_FIREFOX_PORT = 'webdriver_firefox_port';
+  /** @var string Should the reader view (FF 38+) be enabled? */
+  const READER_PARSE_ON_LOAD_ENABLED = 'reader.parse-on-load.enabled';
+  /** @var string Browser homepage */
+  const BROWSER_STARTUP_HOMEPAGE = 'browser.startup.homepage';
+
+  private function __construct()
+  {
+  }
+}

lib/Firefox/FirefoxProfile.php

@@ -55,7 +55,7 @@ public function addExtension($extension) {
   /**
    * @param string $extension_datas The path to the folder containing the datas to add to the extension
    * @return FirefoxProfile
-   */  
+   */
   public function addExtensionDatas($extension_datas) {
     if (!is_dir($extension_datas)) {
       return;
@@ -73,7 +73,7 @@ public function setRdfFile($rdf_file) {
     if (!is_file($rdf_file)) {
       return;
     }
-    
+
     $this->rdf_file = $rdf_file;
     return $this;
   }
@@ -99,6 +99,19 @@ public function setPreference($key, $value) {
     return $this;
   }
 
+  /**
+   * @param $key
+   * @return mixed
+   */
+  public function getPreference($key)
+  {
+    if (array_key_exists($key, $this->preferences)) {
+      return $this->preferences[$key];
+    }
+
+    return null;
+  }
+
   /**
    * @return string
    */

lib/Remote/DesiredCapabilities.php

@@ -18,6 +18,7 @@
 use Exception;
 use Facebook\WebDriver\Chrome\ChromeOptions;
 use Facebook\WebDriver\Firefox\FirefoxDriver;
+use Facebook\WebDriver\Firefox\FirefoxPreferences;
 use Facebook\WebDriver\Firefox\FirefoxProfile;
 use Facebook\WebDriver\WebDriverCapabilities;
 use Facebook\WebDriver\WebDriverPlatform;
@@ -203,7 +204,7 @@ public static function firefox() {
 
     // disable the "Reader View" help tooltip, which can hide elements in the window.document
     $profile = new FirefoxProfile();
-    $profile->setPreference('reader.parse-on-load.enabled', false);
+    $profile->setPreference(FirefoxPreferences::READER_PARSE_ON_LOAD_ENABLED, false);
     $caps->setCapability(FirefoxDriver::PROFILE, $profile);
 
     return $caps;

lib/Remote/DriverCommand.php

@@ -19,7 +19,6 @@
  * This list of command defined in the WebDriver json wire protocol.
  */
 class DriverCommand {
-
   const GET_ALL_SESSIONS = "getAllSessions";
   const GET_CAPABILITIES = "getCapabilities";
   const NEW_SESSION = "newSession";
@@ -126,16 +125,14 @@ class DriverCommand {
   const SET_SCREEN_ORIENTATION = "setScreenOrientation";
   const GET_SCREEN_ORIENTATION = "getScreenOrientation";
 
-  // These belong to the Advanced user interactions - an element is
-  // optional for these commands.
+  // These belong to the Advanced user interactions - an element is optional for these commands.
   const CLICK = "mouseClick";
   const DOUBLE_CLICK = "mouseDoubleClick";
   const MOUSE_DOWN = "mouseButtonDown";
   const MOUSE_UP = "mouseButtonUp";
   const MOVE_TO = "mouseMoveTo";
 
-  // Those allow interactions with the Input Methods installed on
-  // the system.
+  // Those allow interactions with the Input Methods installed on the system.
   const IME_GET_AVAILABLE_ENGINES = "imeGetAvailableEngines";
   const IME_GET_ACTIVE_ENGINE = "imeGetActiveEngine";
   const IME_IS_ACTIVATED = "imeIsActivated";
@@ -168,4 +165,7 @@ class DriverCommand {
   const GET_NETWORK_CONNECTION = "getNetworkConnection";
   const SET_NETWORK_CONNECTION = "setNetworkConnection";
 
+  private function __construct()
+  {
+  }
 }

lib/Remote/RemoteWebDriver.php

@@ -74,7 +74,7 @@ public static function create(
   ) {
     $url = preg_replace('#/+$#', '', $url);
 
-    // Passing DesiredCapabilities as $desired_capabilities is encourged but
+    // Passing DesiredCapabilities as $desired_capabilities is encouraged but
     // array is also accepted for legacy reason.
     if ($desired_capabilities instanceof DesiredCapabilities) {
       $desired_capabilities = $desired_capabilities->toArray();

lib/Remote/Service/DriverCommandExecutor.php

@@ -38,13 +38,12 @@ public function __construct(DriverService $service) {
 
   /**
    * @param WebDriverCommand $command
-   * @param array            $curl_opts
    *
    * @return mixed
    * @throws WebDriverException
    * @throws \Exception
    */
-  public function execute(WebDriverCommand $command, $curl_opts = array()) {
+  public function execute(WebDriverCommand $command) {
     if ($command->getName() === DriverCommand::NEW_SESSION) {
       $this->service->start();
     }

lib/Remote/WebDriverBrowserType.php

@@ -19,7 +19,6 @@
  * All the browsers supported by selenium
  */
 class WebDriverBrowserType {
-
   const FIREFOX = "firefox";
   const FIREFOX_2 = "firefox2";
   const FIREFOX_3 = "firefox3";
@@ -42,4 +41,8 @@ class WebDriverBrowserType {
   const IPHONE = "iphone";
   const IPAD = "iPad";
   const PHANTOMJS = "phantomjs";
+
+  private function __construct()
+  {
+  }
 }