{{ message }}
Repository navigation
Expand file tree
/
Copy pathRemoteWebDriver.php
More file actions
760 lines (669 loc) · 23.5 KB
/
Copy pathRemoteWebDriver.php
File metadata and controls
760 lines (669 loc) · 23.5 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
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
<?php
namespace Facebook\WebDriver\Remote;
use Facebook\WebDriver\Exception\Internal\UnexpectedResponseException;
use Facebook\WebDriver\Interactions\WebDriverActions;
use Facebook\WebDriver\JavaScriptExecutor;
use Facebook\WebDriver\Support\IsElementDisplayedAtom;
use Facebook\WebDriver\Support\ScreenshotHelper;
use Facebook\WebDriver\WebDriver;
use Facebook\WebDriver\WebDriverBy;
use Facebook\WebDriver\WebDriverCapabilities;
use Facebook\WebDriver\WebDriverCommandExecutor;
use Facebook\WebDriver\WebDriverElement;
use Facebook\WebDriver\WebDriverHasInputDevices;
use Facebook\WebDriver\WebDriverNavigation;
use Facebook\WebDriver\WebDriverOptions;
use Facebook\WebDriver\WebDriverWait;
class RemoteWebDriver implements WebDriver, JavaScriptExecutor, WebDriverHasInputDevices
{
/**
* @var HttpCommandExecutor|null
*/
protected $executor;
/**
* @var WebDriverCapabilities|null
*/
protected $capabilities;
/**
* @var string
*/
protected $sessionID;
/**
* @var RemoteMouse
*/
protected $mouse;
/**
* @var RemoteKeyboard
*/
protected $keyboard;
/**
* @var RemoteTouchScreen
*/
protected $touch;
/**
* @var RemoteExecuteMethod
*/
protected $executeMethod;
/**
* @var bool
*/
protected $isW3cCompliant;
/**
* @param string $sessionId
* @param bool $isW3cCompliant false to use the legacy JsonWire protocol, true for the W3C WebDriver spec
*/
protected function __construct(
HttpCommandExecutor $commandExecutor,
$sessionId,
WebDriverCapabilities $capabilities,
$isW3cCompliant = false
) {
$this->executor = $commandExecutor;
$this->sessionID = $sessionId;
$this->isW3cCompliant = $isW3cCompliant;
$this->capabilities = $capabilities;
}
/**
* Construct the RemoteWebDriver by a desired capabilities.
*
* @param string $selenium_server_url The url of the remote Selenium WebDriver server
* @param DesiredCapabilities|array $desired_capabilities The desired capabilities
* @param int|null $connection_timeout_in_ms Set timeout for the connect phase to remote Selenium WebDriver server
* @param int|null $request_timeout_in_ms Set the maximum time of a request to remote Selenium WebDriver server
* @param string|null $http_proxy The proxy to tunnel requests to the remote Selenium WebDriver through
* @param int|null $http_proxy_port The proxy port to tunnel requests to the remote Selenium WebDriver through
* @param DesiredCapabilities $required_capabilities The required capabilities
*
* @return static
*/
public static function create(
$selenium_server_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,
?DesiredCapabilities $required_capabilities = null
) {
$selenium_server_url = preg_replace('#/+$#', '', $selenium_server_url);
$desired_capabilities = self::castToDesiredCapabilitiesObject($desired_capabilities);
$executor = new HttpCommandExecutor($selenium_server_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);
}
// W3C
$parameters = [
'capabilities' => [
'firstMatch' => [(object) $desired_capabilities->toW3cCompatibleArray()],
],
];
if ($required_capabilities !== null && !empty($required_capabilities->toArray())) {
$parameters['capabilities']['alwaysMatch'] = (object) $required_capabilities->toW3cCompatibleArray();
}
// Legacy protocol
if ($required_capabilities !== null) {
// TODO: Selenium (as of v3.0.1) does accept requiredCapabilities only as a property of desiredCapabilities.
// This has changed with the W3C WebDriver spec, but is the only way how to pass these
// values with the legacy protocol.
$desired_capabilities->setCapability('requiredCapabilities', (object) $required_capabilities->toArray());
}
$parameters['desiredCapabilities'] = (object) $desired_capabilities->toArray();
$command = WebDriverCommand::newSession($parameters);
$response = $executor->execute($command);
return static::createFromResponse($response, $executor);
}
/**
* [Experimental] Construct the RemoteWebDriver by an existing session.
*
* This constructor can boost the performance by reusing the same browser for the whole test suite. On the other
* hand, because the browser is not pristine, this may lead to flaky and dependent tests. So carefully
* consider the tradeoffs.
*
* To create the instance, we need to know Capabilities of the previously created session. You can either
* pass them in $existingCapabilities parameter, or we will attempt to receive them from the Selenium Grid server.
* However, if Capabilities were not provided and the attempt to get them was not successful,
* exception will be thrown.
*
* @param string $session_id The existing session id
* @param string $selenium_server_url The url of the remote Selenium WebDriver server
* @param int|null $connection_timeout_in_ms Set timeout for the connect phase to remote Selenium WebDriver server
* @param int|null $request_timeout_in_ms Set the maximum time of a request to remote Selenium WebDriver server
* @param bool $isW3cCompliant True to use W3C WebDriver (default), false to use the legacy JsonWire protocol
* @param WebDriverCapabilities|null $existingCapabilities Provide capabilities of the existing previously created
* session. If not provided, we will attempt to read them, but this will only work when using Selenium Grid.
* @return static
*/
public static function createBySessionID(
$session_id,
$selenium_server_url = 'http://localhost:4444/wd/hub',
$connection_timeout_in_ms = null,
$request_timeout_in_ms = null
) {
// BC layer to not break the method signature
$isW3cCompliant = func_num_args() > 4 ? func_get_arg(4) : true;
$existingCapabilities = func_num_args() > 5 ? func_get_arg(5) : null;
$executor = new HttpCommandExecutor($selenium_server_url, null, null);
if ($connection_timeout_in_ms !== null) {
$executor->setConnectionTimeout($connection_timeout_in_ms);
}
if ($request_timeout_in_ms !== null) {
$executor->setRequestTimeout($request_timeout_in_ms);
}
if (!$isW3cCompliant) {
$executor->disableW3cCompliance();
}
// if capabilities were not provided, attempt to read them from the Selenium Grid API
if ($existingCapabilities === null) {
$existingCapabilities = self::readExistingCapabilitiesFromSeleniumGrid($session_id, $executor);
}
return new static($executor, $session_id, $existingCapabilities, $isW3cCompliant);
}
/**
* Close the current window.
*
* @return RemoteWebDriver The current instance.
*/
public function close()
{
$this->execute(DriverCommand::CLOSE, []);
return $this;
}
/**
* Create a new top-level browsing context.
*
* @codeCoverageIgnore
* @deprecated Use $driver->switchTo()->newWindow()
* @return WebDriver The current instance.
*/
public function newWindow()
{
return $this->switchTo()->newWindow();
}
/**
* Find the first WebDriverElement using the given mechanism.
*
* @return RemoteWebElement NoSuchElementException is thrown in HttpCommandExecutor if no element is found.
* @see WebDriverBy
*/
public function findElement(WebDriverBy $by)
{
$raw_element = $this->execute(
DriverCommand::FIND_ELEMENT,
JsonWireCompat::getUsing($by, $this->isW3cCompliant)
);
return $this->newElement(JsonWireCompat::getElement($raw_element));
}
/**
* Find all WebDriverElements within the current page using the given mechanism.
*
* @return RemoteWebElement[] A list of all WebDriverElements, or an empty array if nothing matches
* @see WebDriverBy
*/
public function findElements(WebDriverBy $by)
{
$raw_elements = $this->execute(
DriverCommand::FIND_ELEMENTS,
JsonWireCompat::getUsing($by, $this->isW3cCompliant)
);
if (!is_array($raw_elements)) {
throw UnexpectedResponseException::forError('Server response to findElements command is not an array');
}
$elements = [];
foreach ($raw_elements as $raw_element) {
$elements[] = $this->newElement(JsonWireCompat::getElement($raw_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 = ['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,
[]
);
}
/**
* Get all window handles available to the current session.
*
* Note: Do not use `end($driver->getWindowHandles())` to find the last open window, for proper solution see:
* https://github.com/php-webdriver/php-webdriver/wiki/Alert,-tabs,-frames,-iframes#switch-to-the-new-window
*
* @return array An array of string containing all available window handles.
*/
public function getWindowHandles()
{
return $this->execute(DriverCommand::GET_WINDOW_HANDLES, []);
}
/**
* Quits this driver, closing every associated window.
*/
public function quit()
{
$this->execute(DriverCommand::QUIT);
$this->executor = null;
}
/**
* 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 = [])
{
$params = [
'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.
*
* You may need to define script timeout using `setScriptTimeout()` method of `WebDriverTimeouts` first.
*
* @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 = [])
{
$params = [
'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)
{
return (new ScreenshotHelper($this->getExecuteMethod()))->takePageScreenshot($save_as);
}
/**
* Status returns information about whether a remote end is in a state in which it can create new sessions.
*/
public function getStatus()
{
$response = $this->execute(DriverCommand::STATUS);
return RemoteStatus::createFromResponse($response);
}
/**
* 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(), $this->isW3cCompliant);
}
/**
* 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, $this->isW3cCompliant);
}
/**
* @return RemoteMouse
*/
public function getMouse()
{
if (!$this->mouse) {
$this->mouse = new RemoteMouse($this->getExecuteMethod(), $this->isW3cCompliant);
}
return $this->mouse;
}
/**
* @return RemoteKeyboard
*/
public function getKeyboard()
{
if (!$this->keyboard) {
$this->keyboard = new RemoteKeyboard($this->getExecuteMethod(), $this, $this->isW3cCompliant);
}
return $this->keyboard;
}
/**
* @return RemoteTouchScreen
*/
public function getTouch()
{
if (!$this->touch) {
$this->touch = new RemoteTouchScreen($this->getExecuteMethod());
}
return $this->touch;
}
/**
* Construct a new action builder.
*
* @return WebDriverActions
*/
public function action()
{
return new WebDriverActions($this);
}
/**
* Set the command executor of this RemoteWebdriver
*
* @deprecated To be removed in the future. Executor should be passed in the constructor.
* @internal
* @codeCoverageIgnore
* @param WebDriverCommandExecutor $executor Despite the typehint, it have be an instance of HttpCommandExecutor.
* @return RemoteWebDriver
*/
public function setCommandExecutor(WebDriverCommandExecutor $executor)
{
$this->executor = $executor;
return $this;
}
/**
* Get the command executor of this RemoteWebdriver
*
* @return HttpCommandExecutor
*/
public function getCommandExecutor()
{
return $this->executor;
}
/**
* Set the session id of the RemoteWebDriver.
*
* @deprecated To be removed in the future. Session ID should be passed in the constructor.
* @internal
* @codeCoverageIgnore
* @param string $session_id
* @return RemoteWebDriver
*/
public function setSessionID($session_id)
{
$this->sessionID = $session_id;
return $this;
}
/**
* Get current selenium sessionID
*
* @return string
*/
public function getSessionID()
{
return $this->sessionID;
}
/**
* Get capabilities of the RemoteWebDriver.
*
* @return WebDriverCapabilities|null
*/
public function getCapabilities()
{
return $this->capabilities;
}
/**
* Returns a list of the currently active sessions.
*
* @deprecated Removed in W3C WebDriver.
* @param string $selenium_server_url The url of the remote Selenium WebDriver server
* @param int $timeout_in_ms
* @return array
*/
public static function getAllSessions($selenium_server_url = 'http://localhost:4444/wd/hub', $timeout_in_ms = 30000)
{
$executor = new HttpCommandExecutor($selenium_server_url, null, null);
$executor->setConnectionTimeout($timeout_in_ms);
$command = new WebDriverCommand(
null,
DriverCommand::GET_ALL_SESSIONS,
[]
);
return $executor->execute($command)->getValue();
}
public function execute($command_name, $params = [])
{
// As we so far only use atom for IS_ELEMENT_DISPLAYED, this condition is hardcoded here. In case more atoms
// are used, this should be rewritten and separated from this class (e.g. to some abstract matcher logic).
if ($command_name === DriverCommand::IS_ELEMENT_DISPLAYED
&& (
// When capabilities are missing in php-webdriver 1.13.x, always fallback to use the atom
$this->getCapabilities() === null
// If capabilities are present, use the atom only if condition matches
|| IsElementDisplayedAtom::match($this->getCapabilities()->getBrowserName())
)
) {
return (new IsElementDisplayedAtom($this))->execute($params);
}
$command = new WebDriverCommand(
$this->sessionID,
$command_name,
$params
);
if ($this->executor) {
$response = $this->executor->execute($command);
return $response->getValue();
}
return null;
}
/**
* Execute custom commands on remote end.
* For example vendor-specific commands or other commands not implemented by php-webdriver.
*
* @see https://github.com/php-webdriver/php-webdriver/wiki/Custom-commands
* @param string $endpointUrl
* @param string $method
* @param array $params
* @return mixed|null
*/
public function executeCustomCommand($endpointUrl, $method = 'GET', $params = [])
{
$command = new CustomWebDriverCommand(
$this->sessionID,
$endpointUrl,
$method,
$params
);
if ($this->executor) {
$response = $this->executor->execute($command);
return $response->getValue();
}
return null;
}
/**
* @internal
* @return bool
*/
public function isW3cCompliant()
{
return $this->isW3cCompliant;
}
/**
* Create instance based on response to NEW_SESSION command.
* Also detect W3C/OSS dialect and setup the driver/executor accordingly.
*
* @internal
* @return static
*/
protected static function createFromResponse(WebDriverResponse $response, HttpCommandExecutor $commandExecutor)
{
$responseValue = $response->getValue();
if (!$isW3cCompliant = isset($responseValue['capabilities'])) {
$commandExecutor->disableW3cCompliance();
}
if ($isW3cCompliant) {
$returnedCapabilities = DesiredCapabilities::createFromW3cCapabilities($responseValue['capabilities']);
} else {
$returnedCapabilities = new DesiredCapabilities($responseValue);
}
return new static($commandExecutor, $response->getSessionID(), $returnedCapabilities, $isW3cCompliant);
}
/**
* Prepare arguments for JavaScript injection
*
* @return array
*/
protected function prepareScriptArguments(array $arguments)
{
$args = [];
foreach ($arguments as $key => $value) {
if ($value instanceof WebDriverElement) {
$args[$key] = [
$this->isW3cCompliant ?
JsonWireCompat::WEB_DRIVER_ELEMENT_IDENTIFIER
: 'ELEMENT' => $value->getID(),
];
} else {
if (is_array($value)) {
$value = $this->prepareScriptArguments($value);
}
$args[$key] = $value;
}
}
return $args;
}
/**
* @return RemoteExecuteMethod
*/
protected function getExecuteMethod()
{
if (!$this->executeMethod) {
$this->executeMethod = new RemoteExecuteMethod($this);
}
return $this->executeMethod;
}
/**
* 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, $this->isW3cCompliant);
}
/**
* Cast legacy types (array or null) to DesiredCapabilities object. To be removed in future when instance of
* DesiredCapabilities will be required.
*
* @param array|DesiredCapabilities|null $desired_capabilities
* @return DesiredCapabilities
*/
protected static function castToDesiredCapabilitiesObject($desired_capabilities = null)
{
if ($desired_capabilities === null) {
return new DesiredCapabilities();
}
if (is_array($desired_capabilities)) {
return new DesiredCapabilities($desired_capabilities);
}
return $desired_capabilities;
}
protected static function readExistingCapabilitiesFromSeleniumGrid(
string $session_id,
HttpCommandExecutor $executor
): DesiredCapabilities {
$getCapabilitiesCommand = new CustomWebDriverCommand($session_id, '/se/grid/session/:sessionId', 'GET', []);
try {
$capabilitiesResponse = $executor->execute($getCapabilitiesCommand);
$existingCapabilities = DesiredCapabilities::createFromW3cCapabilities(
$capabilitiesResponse->getValue()['capabilities']
);
if ($existingCapabilities === null) {
throw UnexpectedResponseException::forError('Empty capabilities received');
}
} catch (\Exception $e) {
throw UnexpectedResponseException::forCapabilitiesRetrievalError($e);
}
return $existingCapabilities;
}
}
You can’t perform that action at this time.