Repository navigation
Expand file tree
/
Copy pathInnerBrowser.php
More file actions
1536 lines (1391 loc) · 50.9 KB
/
Copy pathInnerBrowser.php
File metadata and controls
1536 lines (1391 loc) · 50.9 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
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
namespace Codeception\Lib;
use Codeception\Configuration;
use Codeception\Exception\ElementNotFound;
use Codeception\Exception\ExternalUrlException;
use Codeception\Exception\MalformedLocatorException;
use Codeception\Exception\ModuleException;
use Codeception\Exception\TestRuntimeException;
use Codeception\Lib\Interfaces\ElementLocator;
use Codeception\Lib\Interfaces\PageSourceSaver;
use Codeception\Lib\Interfaces\Web;
use Codeception\Module;
use Codeception\PHPUnit\Constraint\Crawler as CrawlerConstraint;
use Codeception\PHPUnit\Constraint\CrawlerNot as CrawlerNotConstraint;
use Codeception\PHPUnit\Constraint\Page as PageConstraint;
use Codeception\Test\Descriptor;
use Codeception\TestInterface;
use Codeception\Util\Locator;
use Codeception\Util\ReflectionHelper;
use Codeception\Util\Uri;
use Symfony\Component\BrowserKit\Cookie;
use Symfony\Component\DomCrawler\Crawler;
use Symfony\Component\DomCrawler\Field\ChoiceFormField;
use Symfony\Component\DomCrawler\Field\FileFormField;
use Symfony\Component\DomCrawler\Field\InputFormField;
use Symfony\Component\DomCrawler\Field\TextareaFormField;
use Symfony\Component\DomCrawler\Form;
use Symfony\Component\DomCrawler\Link;
class InnerBrowser extends Module implements Web, PageSourceSaver, ElementLocator
{
/**
* @var \Symfony\Component\DomCrawler\Crawler
*/
protected $crawler;
/**
* @api
* @var \Symfony\Component\BrowserKit\Client
*/
public $client;
/**
* @var array|\Symfony\Component\DomCrawler\Form[]
*/
protected $forms = [];
protected $defaultCookieParameters = ['expires' => null, 'path' => '/', 'domain' => '', 'secure' => false];
protected $internalDomains = null;
public function _failed(TestInterface $test, $fail)
{
if (!$this->client || !$this->client->getInternalResponse()) {
return;
}
$this->_savePageSource(codecept_output_dir().str_replace(['::', '\\', '/'], ['.', '.', '.'], Descriptor::getTestSignature($test)) . '.fail.html');
}
public function _after(TestInterface $test)
{
$this->client = null;
$this->crawler = null;
$this->forms = [];
}
public function _conflicts()
{
return 'Codeception\Lib\Interfaces\Web';
}
public function _findElements($locator)
{
return $this->match($locator);
}
/**
* Send custom request to a backend using method, uri, parameters, etc.
* Use it in Helpers to create special request actions, like accessing API
* Returns a string with response body.
*
* ```php
* <?php
* // in Helper class
* public function createUserByApi($name) {
* $userData = $this->getModule('{{MODULE_NAME}}')->_request('POST', '/api/v1/users', ['name' => $name]);
* $user = json_decode($userData);
* return $user->id;
* }
* ?>
* ```
* Does not load the response into the module so you can't interact with response page (click, fill forms).
* To load arbitrary page for interaction, use `_loadPage` method.
*
* @api
* @param $method
* @param $uri
* @param array $parameters
* @param array $files
* @param array $server
* @param null $content
* @return mixed|Crawler
* @throws ExternalUrlException
* @see `_loadPage`
*/
public function _request($method, $uri, array $parameters = [], array $files = [], array $server = [], $content = null)
{
$this->clientRequest($method, $uri, $parameters, $files, $server, $content, false);
return $this->_getResponseContent();
}
/**
* Returns content of the last response
* Use it in Helpers when you want to retrieve response of request performed by another module.
*
* ```php
* <?php
* // in Helper class
* public function seeResponseContains($text)
* {
* $this->assertContains($text, $this->getModule('{{MODULE_NAME}}')->_getResponseContent(), "response contains");
* }
* ?>
* ```
*
* @api
* @return string
* @throws ModuleException
*/
public function _getResponseContent()
{
return (string)$this->getRunningClient()->getInternalResponse()->getContent();
}
protected function clientRequest($method, $uri, array $parameters = array(), array $files = array(), array $server = array(), $content = null, $changeHistory = true)
{
if ($this instanceof Framework) {
if (preg_match('#^(//|https?://(?!localhost))#', $uri)) {
$hostname = parse_url($uri, PHP_URL_HOST);
if (!$this->isInternalDomain($hostname)) {
throw new ExternalUrlException(get_class($this) . " can't open external URL: " . $uri);
}
}
if ($method !== 'GET' && $content === null && !empty($parameters)) {
$content = http_build_query($parameters);
}
}
if (!ReflectionHelper::readPrivateProperty($this->client, 'followRedirects')) {
$result = $this->client->request($method, $uri, $parameters, $files, $server, $content, $changeHistory);
$this->debugResponse($uri);
return $result;
} else {
$maxRedirects = ReflectionHelper::readPrivateProperty($this->client, 'maxRedirects', 'Symfony\Component\BrowserKit\Client');
$this->client->followRedirects(false);
$result = $this->client->request($method, $uri, $parameters, $files, $server, $content, $changeHistory);
$this->debugResponse($uri);
return $this->redirectIfNecessary($result, $maxRedirects, 0);
}
}
protected function isInternalDomain($domain)
{
if ($this->internalDomains === null) {
$this->internalDomains = $this->getInternalDomains();
}
foreach ($this->internalDomains as $pattern) {
if (preg_match($pattern, $domain)) {
return true;
}
}
return false;
}
/**
* Opens a page with arbitrary request parameters.
* Useful for testing multi-step forms on a specific step.
*
* ```php
* <?php
* // in Helper class
* public function openCheckoutFormStep2($orderId) {
* $this->getModule('{{MODULE_NAME}}')->_loadPage('POST', '/checkout/step2', ['order' => $orderId]);
* }
* ?>
* ```
*
* @api
* @param $method
* @param $uri
* @param array $parameters
* @param array $files
* @param array $server
* @param null $content
*/
public function _loadPage($method, $uri, array $parameters = [], array $files = [], array $server = [], $content = null)
{
$this->crawler = $this->clientRequest($method, $uri, $parameters, $files, $server, $content);
$this->forms = [];
}
/**
* @return Crawler
* @throws ModuleException
*/
private function getCrawler()
{
if (!$this->crawler) {
throw new ModuleException($this, 'Crawler is null. Perhaps you forgot to call "amOnPage"?');
}
return $this->crawler;
}
private function getRunningClient()
{
if ($this->client->getInternalRequest() === null) {
throw new ModuleException($this, "Page not loaded. Use `\$I->amOnPage` (or hidden API methods `_request` and `_loadPage`) to open it");
}
return $this->client;
}
public function _savePageSource($filename)
{
file_put_contents($filename, $this->_getResponseContent());
}
/**
* Authenticates user for HTTP_AUTH
*
* @param $username
* @param $password
*/
public function amHttpAuthenticated($username, $password)
{
$this->client->setServerParameter('PHP_AUTH_USER', $username);
$this->client->setServerParameter('PHP_AUTH_PW', $password);
}
public function amOnPage($page)
{
$this->_loadPage('GET', $page);
}
public function click($link, $context = null)
{
if ($context) {
$this->crawler = $this->match($context);
}
if (is_array($link)) {
$this->clickByLocator($link);
return;
}
$anchor = $this->strictMatch(['link' => $link]);
if (!count($anchor)) {
$anchor = $this->getCrawler()->selectLink($link);
}
if (count($anchor)) {
$this->crawler = $this->clientClick($anchor->first()->link());
$this->forms = [];
return;
}
$buttonText = str_replace('"', "'", $link);
$button = $this->crawler->selectButton($buttonText);
if (count($button)) {
$buttonValue = [];
if (strval($button->attr('name')) !== '' && $button->attr('value') !== null) {
$buttonValue = [$button->attr('name') => $button->attr('value')];
}
$this->proceedSubmitForm(
$button->parents()->filter('form')->first(),
$buttonValue
);
return;
}
try {
$this->clickByLocator($link);
} catch (MalformedLocatorException $e) {
throw new ElementNotFound("name=$link", "'$link' is invalid CSS and XPath selector and Link or Button");
}
}
protected function clickByLocator($link)
{
$nodes = $this->match($link);
if (!$nodes->count()) {
throw new ElementNotFound($link, 'Link or Button by name or CSS or XPath');
}
foreach ($nodes as $node) {
$tag = $node->nodeName;
$type = $node->getAttribute('type');
if ($tag === 'a') {
$this->crawler = $this->clientClick($nodes->first()->link());
$this->forms = [];
break;
} elseif (in_array($tag, ['input', 'button']) && in_array($type, ['submit', 'image'])) {
$buttonValue = [];
if (strval($nodes->first()->attr('name')) !== '' && $nodes->first()->attr('value') !== null) {
$buttonValue = [$nodes->first()->attr('name') => $nodes->first()->attr('value')];
}
$this->proceedSubmitForm(
$nodes->parents()->filter('form')->first(),
$buttonValue
);
break;
}
}
}
public function see($text, $selector = null)
{
if (!$selector) {
$this->assertPageContains($text);
} else {
$nodes = $this->match($selector);
$this->assertDomContains($nodes, $this->stringifySelector($selector), $text);
}
}
public function dontSee($text, $selector = null)
{
if (!$selector) {
$this->assertPageNotContains($text);
} else {
$nodes = $this->match($selector);
$this->assertDomNotContains($nodes, $this->stringifySelector($selector), $text);
}
}
public function seeInSource($raw)
{
$this->assertPageSourceContains($raw);
}
public function dontSeeInSource($raw)
{
$this->assertPageSourceNotContains($raw);
}
public function seeLink($text, $url = null)
{
$links = $this->getCrawler()->selectLink($text);
if ($url) {
$links = $links->filterXPath(sprintf('.//a[contains(@href, %s)]', Crawler::xpathLiteral($url)));
}
$this->assertDomContains($links, 'a');
}
public function dontSeeLink($text, $url = null)
{
$links = $this->getCrawler()->selectLink($text);
if ($url) {
$links = $links->filterXPath(sprintf('.//a[contains(@href, %s)]', Crawler::xpathLiteral($url)));
}
$this->assertDomNotContains($links, 'a');
}
/**
* @return string
* @throws ModuleException
*/
public function _getCurrentUri()
{
return Uri::retrieveUri($this->getRunningClient()->getHistory()->current()->getUri());
}
public function seeInCurrentUrl($uri)
{
$this->assertContains($uri, $this->_getCurrentUri());
}
public function dontSeeInCurrentUrl($uri)
{
$this->assertNotContains($uri, $this->_getCurrentUri());
}
public function seeCurrentUrlEquals($uri)
{
$this->assertEquals(rtrim($uri, '/'), rtrim($this->_getCurrentUri(), '/'));
}
public function dontSeeCurrentUrlEquals($uri)
{
$this->assertNotEquals(rtrim($uri, '/'), rtrim($this->_getCurrentUri(), '/'));
}
public function seeCurrentUrlMatches($uri)
{
\PHPUnit_Framework_Assert::assertRegExp($uri, $this->_getCurrentUri());
}
public function dontSeeCurrentUrlMatches($uri)
{
\PHPUnit_Framework_Assert::assertNotRegExp($uri, $this->_getCurrentUri());
}
public function grabFromCurrentUrl($uri = null)
{
if (!$uri) {
return $this->_getCurrentUri();
}
$matches = [];
$res = preg_match($uri, $this->_getCurrentUri(), $matches);
if (!$res) {
$this->fail("Couldn't match $uri in " . $this->_getCurrentUri());
}
if (!isset($matches[1])) {
$this->fail("Nothing to grab. A regex parameter required. Ex: '/user/(\\d+)'");
}
return $matches[1];
}
public function seeCheckboxIsChecked($checkbox)
{
$checkboxes = $this->getCrawler()->filter($checkbox);
$this->assertDomContains($checkboxes->filter('input[checked=checked]'), 'checkbox');
}
public function dontSeeCheckboxIsChecked($checkbox)
{
$checkboxes = $this->getCrawler()->filter($checkbox);
$this->assertEquals(0, $checkboxes->filter('input[checked=checked]')->count());
}
public function seeInField($field, $value)
{
$nodes = $this->getFieldsByLabelOrCss($field);
$this->assert($this->proceedSeeInField($nodes, $value));
}
public function dontSeeInField($field, $value)
{
$nodes = $this->getFieldsByLabelOrCss($field);
$this->assertNot($this->proceedSeeInField($nodes, $value));
}
public function seeInFormFields($formSelector, array $params)
{
$this->proceedSeeInFormFields($formSelector, $params, false);
}
public function dontSeeInFormFields($formSelector, array $params)
{
$this->proceedSeeInFormFields($formSelector, $params, true);
}
protected function proceedSeeInFormFields($formSelector, array $params, $assertNot)
{
$form = $this->match($formSelector)->first();
if ($form->count() === 0) {
throw new ElementNotFound($formSelector, 'Form');
}
foreach ($params as $name => $values) {
$field = $form->filterXPath(sprintf('.//*[@name=%s]', Crawler::xpathLiteral($name)));
if ($field->count() === 0) {
throw new ElementNotFound(
sprintf('//*[@name=%s]', Crawler::xpathLiteral($name)),
'Form'
);
}
if (!is_array($values)) {
$values = [$values];
}
foreach ($values as $value) {
$ret = $this->proceedSeeInField($field, $value);
if ($assertNot) {
$this->assertNot($ret);
} else {
$this->assert($ret);
}
}
}
}
protected function proceedSeeInField(Crawler $fields, $value)
{
$testValues = $this->proceedGetValueFromField($fields);
if (!is_array($testValues)) {
$testValues = [$testValues];
}
if (is_bool($value) && $value === true && !empty($testValues)) {
$value = reset($testValues);
} elseif (empty($testValues)) {
$testValues = [''];
}
return [
'Contains',
$value,
$testValues,
sprintf('Failed asserting that `%s` is in %s\'s value: %s', $value, $fields->nodeName(), var_export($testValues, true))
];
}
/**
* Strips out one pair of trailing square brackets from a field's
* name.
*
* @param string $name the field name
* @return string the name after stripping trailing square brackets
*/
protected function getSubmissionFormFieldName($name)
{
if (substr($name, -2) === '[]') {
return substr($name, 0, -2);
}
return $name;
}
/**
* Replaces boolean values in $params with the corresponding field's
* value for checkbox form fields.
*
* The function loops over all input checkbox fields, checking if a
* corresponding key is set in $params. If it is, and the value is
* boolean or an array containing booleans, the value(s) are
* replaced in the array with the real value of the checkbox, and
* the array is returned.
*
* @param Crawler $form the form to find checkbox elements
* @param array $params the parameters to be submitted
* @return array the $params array after replacing bool values
*/
protected function setCheckboxBoolValues(Crawler $form, array $params)
{
$checkboxes = $form->filter('input[type=checkbox]');
$chFoundByName = [];
foreach ($checkboxes as $box) {
$fieldName = $this->getSubmissionFormFieldName($box->getAttribute('name'));
$pos = (!isset($chFoundByName[$fieldName])) ? 0 : $chFoundByName[$fieldName];
$skip = (!isset($params[$fieldName]))
|| (!is_array($params[$fieldName]) && !is_bool($params[$fieldName]))
|| ($pos >= count($params[$fieldName])
|| (is_array($params[$fieldName]) && !is_bool($params[$fieldName][$pos])));
if ($skip) {
continue;
}
$values = $params[$fieldName];
if ($values === true) {
$params[$fieldName] = $box->getAttribute('value');
$chFoundByName[$fieldName] = $pos + 1;
} elseif ($values[$pos] === true) {
$params[$fieldName][$pos] = $box->getAttribute('value');
$chFoundByName[$fieldName] = $pos + 1;
} elseif (is_array($values)) {
array_splice($params[$fieldName], $pos, 1);
} else {
unset($params[$fieldName]);
}
}
return $params;
}
/**
* Submits the form currently selected in the passed Crawler, after
* setting any values passed in $params and setting the value of the
* passed button name.
*
* @param Crawler $frmCrawl the form to submit
* @param array $params additional parameter values to set on the
* form
* @param string $button the name of a submit button in the form
*/
protected function proceedSubmitForm(Crawler $frmCrawl, array $params, $button = null)
{
$form = $this->getFormFor($frmCrawl);
$defaults = $this->getFormValuesFor($form);
$merged = array_merge($defaults, $params);
$requestParams = $this->setCheckboxBoolValues($frmCrawl, $merged);
if (!empty($button)) {
$btnCrawl = $frmCrawl->filterXPath(sprintf('//*[not(@disabled) and @type="submit" and @name=%s]', Crawler::xpathLiteral($button)));
if (count($btnCrawl)) {
$requestParams[$button] = $btnCrawl->attr('value');
}
}
$url = $this->getFormUrl($frmCrawl);
if (strcasecmp($form->getMethod(), 'GET') === 0) {
$url = Uri::mergeUrls($url, '?' . http_build_query($requestParams));
}
$this->debugSection('Uri', $url);
$this->debugSection('Method', $form->getMethod());
$this->debugSection('Parameters', $requestParams);
$requestParams= $this->getFormPhpValues($requestParams);
$this->crawler = $this->clientRequest(
$form->getMethod(),
$url,
$requestParams,
$form->getPhpFiles()
);
$this->forms = [];
}
public function submitForm($selector, array $params, $button = null)
{
$form = $this->match($selector)->first();
if (!count($form)) {
throw new ElementNotFound($this->stringifySelector($selector), 'Form');
}
$this->proceedSubmitForm($form, $params, $button);
}
/**
* Returns an absolute URL for the passed URI with the current URL
* as the base path.
*
* @param string $uri the absolute or relative URI
* @return string the absolute URL
* @throws \Codeception\Exception\TestRuntimeException if either the current
* URL or the passed URI can't be parsed
*/
protected function getAbsoluteUrlFor($uri)
{
$currentUrl = $this->getRunningClient()->getHistory()->current()->getUri();
if (empty($uri) || $uri === '#') {
return $currentUrl;
}
return Uri::mergeUrls($currentUrl, $uri);
}
/**
* Returns the form action's absolute URL.
*
* @param \Symfony\Component\DomCrawler\Crawler $form
* @return string
* @throws \Codeception\Exception\TestRuntimeException if either the current
* URL or the URI of the form's action can't be parsed
*/
protected function getFormUrl(Crawler $form)
{
$action = $form->attr('action');
return $this->getAbsoluteUrlFor($action);
}
/**
* Returns a crawler Form object for the form pointed to by the
* passed Crawler.
*
* The returned form is an independent Crawler created to take care
* of the following issues currently experienced by Crawler's form
* object:
* - input fields disabled at a higher level (e.g. by a surrounding
* fieldset) still return values
* - Codeception expects an empty value to match an unselected
* select box.
*
* The function clones the crawler's node and creates a new crawler
* because it destroys or adds to the DOM for the form to achieve
* the desired functionality. Other functions simply querying the
* DOM wouldn't expect them.
*
* @param Crawler $form the form
* @param string $action the form's absolute URL action
* @return Form
*/
private function getFormFromCrawler(Crawler $form, $action)
{
$fakeDom = new \DOMDocument();
$fakeDom->appendChild($fakeDom->importNode($form->getNode(0), true));
$node = $fakeDom->documentElement;
$cloned = new Crawler($node, $action);
$shouldDisable = $cloned->filter('input:disabled:not([disabled]),select option:disabled,select optgroup:disabled option:not([disabled])');
foreach ($shouldDisable as $field) {
$field->parentNode->removeChild($field);
}
$selectNonMulti = $cloned->filterXPath('//select[not(@multiple) and not(option[@value=""])]');
$opt = new \DOMElement('option');
foreach ($selectNonMulti as $field) {
$node = $field->insertBefore($opt, $field->firstChild);
$node->setAttribute('value', '');
}
return $cloned->form();
}
/**
* Returns the DomCrawler\Form object for the form pointed to by
* $node or its closes form parent.
*
* @param \Symfony\Component\DomCrawler\Crawler $node
* @return \Symfony\Component\DomCrawler\Form
*/
protected function getFormFor(Crawler $node)
{
if (strcasecmp($node->first()->getNode(0)->tagName, 'form') === 0) {
$form = $node->first();
} else {
$form = $node->parents()->filter('form')->first();
}
if (!$form) {
$this->fail('The selected node is not a form and does not have a form ancestor.');
}
$action = (string) $this->getFormUrl($form);
if (!isset($this->forms[$action])) {
$this->forms[$action] = $this->getFormFromCrawler($form, $action);
}
return $this->forms[$action];
}
/**
* Returns an array of name => value pairs for the passed form.
*
* For form fields containing a name ending in [], an array is
* created out of all field values with the given name.
*
* @param \Symfony\Component\DomCrawler\Form the form
* @return array an array of name => value pairs
*/
protected function getFormValuesFor(Form $form)
{
$values = [];
$fields = $form->all();
foreach ($fields as $field) {
if ($field->isDisabled() || !$field->hasValue() || $field instanceof FileFormField) {
continue;
}
$fieldName = $this->getSubmissionFormFieldName($field->getName());
if (substr($field->getName(), -2) === '[]') {
if (!isset($values[$fieldName])) {
$values[$fieldName] = [];
}
$values[$fieldName][] = $field->getValue();
} else {
$values[$fieldName] = $field->getValue();
}
}
return $values;
}
public function fillField($field, $value)
{
$input = $this->getFieldByLabelOrCss($field);
$form = $this->getFormFor($input);
$name = $input->attr('name');
$dynamicField = $input->getNode(0)->tagName == 'textarea'
? new TextareaFormField($input->getNode(0))
: new InputFormField($input->getNode(0));
$formField = $this->matchFormField($name, $form, $dynamicField);
$formField->setValue($value);
$input->getNode(0)->nodeValue = htmlspecialchars($value);
}
/**
* @param $field
*
* @return \Symfony\Component\DomCrawler\Crawler
*/
protected function getFieldsByLabelOrCss($field)
{
if (is_array($field)) {
$input = $this->strictMatch($field);
if (!count($input)) {
throw new ElementNotFound($field);
}
return $input;
}
// by label
$label = $this->strictMatch(['xpath' => sprintf('.//label[text()=%s]', Crawler::xpathLiteral($field))]);
if (count($label)) {
$label = $label->first();
if ($label->attr('for')) {
$input = $this->strictMatch(['id' => $label->attr('for')]);
}
}
// by name
if (!isset($input)) {
$input = $this->strictMatch(['name' => $field]);
}
// by CSS and XPath
if (!count($input)) {
$input = $this->match($field);
}
if (!count($input)) {
throw new ElementNotFound($field, 'Form field by Label or CSS');
}
return $input;
}
protected function getFieldByLabelOrCss($field)
{
$input = $this->getFieldsByLabelOrCss($field);
return $input->first();
}
public function selectOption($select, $option)
{
$field = $this->getFieldByLabelOrCss($select);
$form = $this->getFormFor($field);
$fieldName = $this->getSubmissionFormFieldName($field->attr('name'));
if (is_array($option)) {
$options = [];
foreach ($option as $opt) {
$options[] = $this->matchOption($field, $opt);
}
$form[$fieldName]->select($options);
return;
}
$dynamicField = new ChoiceFormField($field->getNode(0));
$formField = $this->matchFormField($fieldName, $form, $dynamicField);
$selValue = $this->matchOption($field, $option);
if (is_array($formField)) {
foreach ($formField as $field) {
$values = $field->availableOptionValues();
foreach ($values as $val) {
if ($val === $option) {
$field->select($selValue);
return;
}
}
}
return;
}
$formField->select($this->matchOption($field, $option));
}
protected function matchOption(Crawler $field, $option)
{
$options = $field->filterXPath(sprintf('//option[text()=normalize-space("%s")]|//input[@type="radio" and @value=normalize-space("%s")]', $option, $option));
if ($options->count()) {
if ($options->getNode(0)->tagName === 'option') {
$options->getNode(0)->setAttribute('selected', 'selected');
} else {
$options->getNode(0)->setAttribute('checked', 'checked');
}
if ($options->first()->attr('value') !== false) {
return $options->first()->attr('value');
}
return $options->first()->text();
}
return $option;
}
public function checkOption($option)
{
$this->proceedCheckOption($option)->tick();
}
public function uncheckOption($option)
{
$this->proceedCheckOption($option)->untick();
}
/**
* @param $option
* @return ChoiceFormField
*/
protected function proceedCheckOption($option)
{
$form = $this->getFormFor($field = $this->getFieldByLabelOrCss($option));
$name = $field->attr('name');
if ($field->getNode(0) === null) {
throw new TestRuntimeException("Form field $name is not located");
}
// If the name is an array than we compare objects to find right checkbox
$formField = $this->matchFormField($name, $form, new ChoiceFormField($field->getNode(0)));
$field->getNode(0)->setAttribute('checked', 'checked');
if (!$formField instanceof ChoiceFormField) {
throw new TestRuntimeException("Form field $name is not a checkable");
}
return $formField;
}
public function attachFile($field, $filename)
{
$form = $this->getFormFor($field = $this->getFieldByLabelOrCss($field));
$path = Configuration::dataDir() . $filename;
$name = $field->attr('name');
if (!is_readable($path)) {
$this->fail("file $filename not found in Codeception data path. Only files stored in data path accepted");
}
$formField = $this->matchFormField($name, $form, new FileFormField($field->getNode(0)));
if (is_array($formField)) {
$this->fail("Field $name is ignored on upload, field $name is treated as array.");
}
$formField->upload($path);
}
/**
* If your page triggers an ajax request, you can perform it manually.
* This action sends a GET ajax request with specified params.
*
* See ->sendAjaxPostRequest for examples.
*
* @param $uri
* @param $params
*/
public function sendAjaxGetRequest($uri, $params = [])
{
$this->sendAjaxRequest('GET', $uri, $params);
}
/**
* If your page triggers an ajax request, you can perform it manually.
* This action sends a POST ajax request with specified params.
* Additional params can be passed as array.
*
* Example:
*
* Imagine that by clicking checkbox you trigger ajax request which updates user settings.
* We emulate that click by running this ajax request manually.
*
* ``` php
* <?php
* $I->sendAjaxPostRequest('/updateSettings', array('notifications' => true)); // POST
* $I->sendAjaxGetRequest('/updateSettings', array('notifications' => true)); // GET
*
* ```
*
* @param $uri
* @param $params
*/
public function sendAjaxPostRequest($uri, $params = [])
{
$this->sendAjaxRequest('POST', $uri, $params);
}
/**
* If your page triggers an ajax request, you can perform it manually.
* This action sends an ajax request with specified method and params.
*
* Example:
*
* You need to perform an ajax request specifying the HTTP method.
*
* ``` php
* <?php
* $I->sendAjaxRequest('PUT', '/posts/7', array('title' => 'new title'));
*
* ```
*
* @param $method
* @param $uri
* @param $params
*/
public function sendAjaxRequest($method, $uri, $params = [])
{
$this->clientRequest($method, $uri, $params, [], ['HTTP_X_REQUESTED_WITH' => 'XMLHttpRequest'], null, false);
}
/**
* @param $url
*/
protected function debugResponse($url)
{
$this->debugSection('Page', $url);
$this->debugSection('Response', $this->getResponseStatusCode());
$this->debugSection('Request Cookies', $this->getRunningClient()->getInternalRequest()->getCookies());
$this->debugSection('Response Headers', $this->getRunningClient()->getInternalResponse()->getHeaders());
}
protected function getResponseStatusCode()
{
// depending on Symfony version
$response = $this->getRunningClient()->getInternalResponse();
if (method_exists($response, 'getStatus')) {
return $response->getStatus();
}
if (method_exists($response, 'getStatusCode')) {
return $response->getStatusCode();
}
return "N/A";
}
/**
* @param $selector
*
* @return Crawler
*/
protected function match($selector)
{
if (is_array($selector)) {
return $this->strictMatch($selector);
}
if (Locator::isCSS($selector)) {
return $this->getCrawler()->filter($selector);
}
if (Locator::isXPath($selector)) {
return $this->getCrawler()->filterXPath($selector);