RemoteWebDriver.php 13.2 KB
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510
<?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\Remote;

use Facebook\WebDriver\Interactions\WebDriverActions;
use Facebook\WebDriver\JavaScriptExecutor;
use Facebook\WebDriver\WebDriver;
use Facebook\WebDriver\WebDriverBy;
use Facebook\WebDriver\WebDriverCommandExecutor;
use Facebook\WebDriver\WebDriverElement;
use Facebook\WebDriver\WebDriverNavigation;
use Facebook\WebDriver\WebDriverOptions;
use Facebook\WebDriver\WebDriverWait;

class RemoteWebDriver implements WebDriver, JavaScriptExecutor {
  /**
   * @var HttpCommandExecutor
   */
  protected $executor;
  /**
   * @var string
   */
  protected $sessionID;
  /**
   * @var RemoteMouse
   */
  protected $mouse;
  /**
   * @var RemoteKeyboard
   */
  protected $keyboard;
  /**
   * @var RemoteTouchScreen
   */
  protected $touch;
  /**
   * @var RemoteExecuteMethod
   */
  protected $executeMethod;

  protected function __construct() {}

  /**
   * Construct the RemoteWebDriver by a desired capabilities.
   *
   * @param string $url The url of the remote server
   * @param DesiredCapabilities|array $desired_capabilities The desired capabilities
   * @param int|null $connection_timeout_in_ms
   * @param int|null $request_timeout_in_ms
   * @param string|null $http_proxy The proxy to tunnel requests through
   * @param int|null $http_proxy_port
   * @return RemoteWebDriver
   */
  public static function create(
    $url = 'http://localhost:4444/wd/hub',
    $desired_capabilities = null,
    $connection_timeout_in_ms = null,
    $request_timeout_in_ms = null,
    $http_proxy = null,
    $http_proxy_port = null
  ) {
    $url = preg_replace('#/+$#', '', $url);

    // Passing DesiredCapabilities as $desired_capabilities is encourged but
    // array is also accepted for legacy reason.
    if ($desired_capabilities instanceof DesiredCapabilities) {
      $desired_capabilities = $desired_capabilities->toArray();
    }

    $executor = new HttpCommandExecutor($url, $http_proxy, $http_proxy_port);
    if ($connection_timeout_in_ms !== null) {
      $executor->setConnectionTimeout($connection_timeout_in_ms);
    }
    if ($request_timeout_in_ms !== null) {
      $executor->setRequestTimeout($request_timeout_in_ms);
    }

    $command = new WebDriverCommand(
      null,
      DriverCommand::NEW_SESSION,
      array('desiredCapabilities' => $desired_capabilities)
    );

    $response = $executor->execute($command);

    $driver = new static();
    $driver->setSessionID($response->getSessionID())
           ->setCommandExecutor($executor);
    return $driver;
  }

  /**
   * [Experimental] Construct the RemoteWebDriver by an existing session.
   *
   * This constructor can boost the performance a lot by reusing the same
   * browser for the whole test suite. You do not have to pass the desired
   * capabilities because the session was created before.
   *
   * @param string $url The url of the remote server
   * @param string $session_id The existing session id
   * @return RemoteWebDriver
   */
  public static function createBySessionID(
    $session_id,
    $url = 'http://localhost:4444/wd/hub'
  ) {
    $driver = new static();
    $driver->setSessionID($session_id)
           ->setCommandExecutor(new HttpCommandExecutor($url));
    return $driver;
  }

  /**
   * Close the current window.
   *
   * @return RemoteWebDriver The current instance.
   */
  public function close() {
    $this->execute(DriverCommand::CLOSE, array());

    return $this;
  }

  /**
   * Find the first WebDriverElement using the given mechanism.
   *
   * @param WebDriverBy $by
   * @return RemoteWebElement NoSuchElementException is thrown in
   *    HttpCommandExecutor if no element is found.
   * @see WebDriverBy
   */
  public function findElement(WebDriverBy $by) {
    $params = array('using' => $by->getMechanism(), 'value' => $by->getValue());
    $raw_element = $this->execute(
      DriverCommand::FIND_ELEMENT,
      $params
    );

    return $this->newElement($raw_element['ELEMENT']);
  }

  /**
   * Find all WebDriverElements within the current page using the given
   * mechanism.
   *
   * @param WebDriverBy $by
   * @return RemoteWebElement[] A list of all WebDriverElements, or an empty
   *    array if nothing matches
   * @see WebDriverBy
   */
  public function findElements(WebDriverBy $by) {
    $params = array('using' => $by->getMechanism(), 'value' => $by->getValue());
    $raw_elements = $this->execute(
      DriverCommand::FIND_ELEMENTS,
      $params
    );

    $elements = array();
    foreach ($raw_elements as $raw_element) {
      $elements[] = $this->newElement($raw_element['ELEMENT']);
    }
    return $elements;
  }

    /**
     * Load a new web page in the current browser window.
     *
     * @param string $url
     *
     * @return RemoteWebDriver The current instance.
     */
  public function get($url) {
    $params = array('url' => (string)$url);
    $this->execute(DriverCommand::GET, $params);

    return $this;
  }

  /**
   * Get a string representing the current URL that the browser is looking at.
   *
   * @return string The current URL.
   */
  public function getCurrentURL() {
    return $this->execute(DriverCommand::GET_CURRENT_URL);
  }

  /**
   * Get the source of the last loaded page.
   *
   * @return string The current page source.
   */
  public function getPageSource() {
    return $this->execute(DriverCommand::GET_PAGE_SOURCE);
  }

  /**
   * Get the title of the current page.
   *
   * @return string The title of the current page.
   */
  public function getTitle() {
    return $this->execute(DriverCommand::GET_TITLE);
  }

  /**
   * Return an opaque handle to this window that uniquely identifies it within
   * this driver instance.
   *
   * @return string The current window handle.
   */
  public function getWindowHandle() {
    return $this->execute(
      DriverCommand::GET_CURRENT_WINDOW_HANDLE,
      array()
    );
  }

  /**
   * Get all window handles available to the current session.
   *
   * @return array An array of string containing all available window handles.
   */
  public function getWindowHandles() {
    return $this->execute(DriverCommand::GET_WINDOW_HANDLES, array());
  }

  /**
   * Quits this driver, closing every associated window.
   *
   * @return void
   */
  public function quit() {
    $this->execute(DriverCommand::QUIT);
    $this->executor = null;
  }

  /**
   * Prepare arguments for JavaScript injection
   *
   * @param array $arguments
   * @return array
   */
  private function prepareScriptArguments(array $arguments) {
    $args = array();
    foreach ($arguments as $key => $value) {
      if ($value instanceof WebDriverElement) {
        $args[$key] = array('ELEMENT'=>$value->getID());
      } else {
        if (is_array($value)) {
          $value = $this->prepareScriptArguments($value);
        }
        $args[$key] = $value;
      }
    }
    return $args;
  }

  /**
   * Inject a snippet of JavaScript into the page for execution in the context
   * of the currently selected frame. The executed script is assumed to be
   * synchronous and the result of evaluating the script will be returned.
   *
   * @param string $script The script to inject.
   * @param array $arguments The arguments of the script.
   * @return mixed The return value of the script.
   */
  public function executeScript($script, array $arguments = array()) {
    $params = array(
      'script' => $script,
      'args' => $this->prepareScriptArguments($arguments),
    );
    return $this->execute(DriverCommand::EXECUTE_SCRIPT, $params);
  }

  /**
   * Inject a snippet of JavaScript into the page for asynchronous execution in
   * the context of the currently selected frame.
   *
   * The driver will pass a callback as the last argument to the snippet, and
   * block until the callback is invoked.
   *
   * @see WebDriverExecuteAsyncScriptTestCase
   *
   * @param string $script The script to inject.
   * @param array $arguments The arguments of the script.
   * @return mixed The value passed by the script to the callback.
   */
  public function executeAsyncScript($script, array $arguments = array()) {
    $params = array(
      'script' => $script,
      'args' => $this->prepareScriptArguments($arguments),
    );
    return $this->execute(
      DriverCommand::EXECUTE_ASYNC_SCRIPT,
      $params
    );
  }

  /**
   * Take a screenshot of the current page.
   *
   * @param string $save_as The path of the screenshot to be saved.
   * @return string The screenshot in PNG format.
   */
  public function takeScreenshot($save_as = null) {
    $screenshot = base64_decode(
      $this->execute(DriverCommand::SCREENSHOT)
    );
    if ($save_as) {
      file_put_contents($save_as, $screenshot);
    }
    return $screenshot;
  }

  /**
   * Construct a new WebDriverWait by the current WebDriver instance.
   * Sample usage:
   *
   *   $driver->wait(20, 1000)->until(
   *     WebDriverExpectedCondition::titleIs('WebDriver Page')
   *   );
   *
   * @param int $timeout_in_second
   * @param int $interval_in_millisecond
   *
   * @return WebDriverWait
   */
  public function wait(
      $timeout_in_second = 30,
      $interval_in_millisecond = 250) {
    return new WebDriverWait(
      $this, $timeout_in_second, $interval_in_millisecond
    );
  }

  /**
   * An abstraction for managing stuff you would do in a browser menu. For
   * example, adding and deleting cookies.
   *
   * @return WebDriverOptions
   */
  public function manage() {
    return new WebDriverOptions($this->getExecuteMethod());
  }

  /**
   * An abstraction allowing the driver to access the browser's history and to
   * navigate to a given URL.
   *
   * @return WebDriverNavigation
   * @see WebDriverNavigation
   */
  public function navigate() {
    return new WebDriverNavigation($this->getExecuteMethod());
  }

  /**
   * Switch to a different window or frame.
   *
   * @return RemoteTargetLocator
   * @see RemoteTargetLocator
   */
  public function switchTo() {
    return new RemoteTargetLocator($this->getExecuteMethod(), $this);
  }

  /**
   * @return RemoteMouse
   */
  public function getMouse() {
    if (!$this->mouse) {
      $this->mouse = new RemoteMouse($this->getExecuteMethod());
    }
    return $this->mouse;
  }

  /**
   * @return RemoteKeyboard
   */
  public function getKeyboard() {
    if (!$this->keyboard) {
      $this->keyboard = new RemoteKeyboard($this->getExecuteMethod());
    }
    return $this->keyboard;
  }

  /**
   * @return RemoteTouchScreen
   */
  public function getTouch() {
    if (!$this->touch) {
      $this->touch = new RemoteTouchScreen($this->getExecuteMethod());
    }
    return $this->touch;
  }

  protected function getExecuteMethod() {
    if (!$this->executeMethod) {
      $this->executeMethod = new RemoteExecuteMethod($this);
    }
    return $this->executeMethod;
  }

  /**
   * Construct a new action builder.
   *
   * @return WebDriverActions
   */
  public function action() {
    return new WebDriverActions($this);
  }

  /**
   * Return the WebDriverElement with the given id.
   *
   * @param string $id The id of the element to be created.
   * @return RemoteWebElement
   */
  protected function newElement($id) {
    return new RemoteWebElement($this->getExecuteMethod(), $id);
  }

  /**
   * Set the command executor of this RemoteWebdriver
   *
   * @param WebDriverCommandExecutor $executor
   * @return RemoteWebDriver
   */
  public function setCommandExecutor(WebDriverCommandExecutor $executor) {
    $this->executor = $executor;
    return $this;
  }

  /**
   * Set the command executor of this RemoteWebdriver
   *
   * @return HttpCommandExecutor
   */
  public function getCommandExecutor() {
    return $this->executor;
  }

  /**
   * Set the session id of the RemoteWebDriver.
   *
   * @param string $session_id
   * @return RemoteWebDriver
   */
  public function setSessionID($session_id) {
    $this->sessionID = $session_id;
    return $this;
  }

  /**
   * Get current selenium sessionID
   *
   * @return string sessionID
   */
  public function getSessionID() {
    return $this->sessionID;
  }

  /**
   * Get all selenium sessions.
   *
   * @param string $url The url of the remote server
   * @param int $timeout_in_ms
   * @return array
   */
  public static function getAllSessions(
    $url = 'http://localhost:4444/wd/hub',
    $timeout_in_ms = 30000
  ) {
    $executor = new HttpCommandExecutor($url);
    $executor->setConnectionTimeout($timeout_in_ms);

    $command = new WebDriverCommand(
      null,
      DriverCommand::GET_ALL_SESSIONS,
      array()
    );

    return $executor->execute($command)->getValue();
  }

  public function execute($command_name, $params = array()) {
    $command = new WebDriverCommand(
      $this->sessionID,
      $command_name,
      $params
    );

    $response = $this->executor->execute($command);
    return $response->getValue();
  }
}