forked from sebastianbergmann/phpunit
-
Notifications
You must be signed in to change notification settings - Fork 0
/
SeleniumTestCase.php
1238 lines (1124 loc) · 28.2 KB
/
SeleniumTestCase.php
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
/**
* PHPUnit
*
* Copyright (c) 2002-2006, Sebastian Bergmann <sb@sebastian-bergmann.de>.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* * Neither the name of Sebastian Bergmann nor the names of his
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRIC
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* @category Testing
* @package PHPUnit
* @author Sebastian Bergmann <sb@sebastian-bergmann.de>
* @copyright 2002-2006 Sebastian Bergmann <sb@sebastian-bergmann.de>
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
* @version SVN: $Id$
* @link http://www.phpunit.de/
* @since File available since Release 3.0.0
*/
require_once 'PHPUnit/Framework.php';
require_once 'PHPUnit/Util/Filter.php';
require_once 'Testing/Selenium.php';
PHPUnit_Util_Filter::addFileToFilter(__FILE__, 'PHPUNIT');
/**
* TestCase class that uses Selenium to provide
* the functionality required for web testing.
*
* @category Testing
* @package PHPUnit
* @author Sebastian Bergmann <sb@sebastian-bergmann.de>
* @copyright 2002-2006 Sebastian Bergmann <sb@sebastian-bergmann.de>
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
* @version Release: @package_version@
* @link http://www.phpunit.de/
* @since Class available since Release 3.0.0
*/
class PHPUnit_Extensions_SeleniumTestCase extends PHPUnit_Framework_TestCase
{
/**
* @var Testing_Selenium
* @access private
*/
private $selenium = NULL;
/**
* @var string
* @access private
*/
private $browser;
/**
* @var string
* @access private
*/
private $browserUrl;
/**
* @var string
* @access private
*/
private $host = 'localhost';
/**
* @var integer
* @access private
*/
private $port = 4444;
/**
* @var integer
* @access private
*/
private $timeout = 30000;
/**
* @access protected
*/
protected function runTest()
{
if (extension_loaded('curl')) {
$driver = 'curl';
} else {
$driver = 'native';
}
$this->selenium = new Testing_Selenium(
$this->browser,
$this->browserUrl,
$this->host,
$this->port,
$this->timeout,
$driver
);
$this->start();
parent::runTest();
try {
$this->stop();
}
catch (Selenium_Exception $e) {
}
$this->selenium = NULL;
}
protected function tearDown()
{
try {
$this->stop();
}
catch (Selenium_Exception $e) {
}
$this->selenium = NULL;
}
/**
* @param string $browser
* @throws InvalidArgumentException
* @access public
*/
public function setBrowser($browser)
{
if (!is_string($browser)) {
throw new InvalidArgumentException;
}
$this->browser = $browser;
}
/**
* @param string $browserUrl
* @throws InvalidArgumentException
* @access public
*/
public function setBrowserUrl($browserUrl)
{
if (!is_string($browserUrl)) {
throw new InvalidArgumentException;
}
$this->browserUrl = $browserUrl;
}
/**
* @param string $host
* @throws InvalidArgumentException
* @access public
*/
public function setHost($host)
{
if (!is_string($host)) {
throw new InvalidArgumentException;
}
$this->host = $host;
}
/**
* @param integer $port
* @throws InvalidArgumentException
* @access public
*/
public function setPort($port)
{
if (!is_int($port)) {
throw new InvalidArgumentException;
}
$this->port = $port;
}
/**
* @param integer $timeout
* @throws InvalidArgumentException
* @access public
*/
public function setTimeout($timeout)
{
if (!is_int($timeout)) {
throw new InvalidArgumentException;
}
$this->timeout = $timeout;
}
/**
* Asserts that an alert is present.
*
* @access public
*/
public function assertAlertPresent()
{
$this->assertTrue($this->isAlertPresent());
}
/**
* Asserts that no alert is present.
*
* @access public
*/
public function assertNoAlertPresent()
{
$this->assertFalse($this->isAlertPresent());
}
/**
*
*
* @param string $locator
* @access public
*/
public function assertChecked($locator)
{
$this->assertTrue($this->isChecked($locator));
}
/**
*
*
* @param string $locator
* @access public
*/
public function assertNotChecked($locator)
{
$this->assertFalse($this->isChecked($locator));
}
/**
* Assert that a confirmation is present.
*
* @access public
*/
public function assertConfirmationPresent()
{
$this->assertTrue($this->isConfirmationPresent());
}
/**
* Assert that no confirmation is present.
*
* @access public
*/
public function assertNoConfirmationPresent()
{
$this->assertFalse($this->isConfirmationPresent());
}
/**
*
*
* @param string $locator
* @access public
*/
public function assertEditable($locator)
{
$this->assertTrue($this->isEditable($locator));
}
/**
*
*
* @param string $locator
* @access public
*/
public function assertNotEditable($locator)
{
$this->assertFalse($this->isEditable($locator));
}
/**
* Asserts than an element is present.
*
* @param string $locator
* @access public
*/
public function assertElementPresent($locator)
{
$this->assertTrue($this->isElementPresent($locator));
}
/**
* Asserts than an element is not present.
*
* @param string $locator
* @access public
*/
public function assertElementNotPresent($locator)
{
$this->assertFalse($this->isElementPresent($locator));
}
/**
*
*
* @param string $location
* @access public
*/
public function assertLocationEquals($location)
{
$this->assertEquals($location, $this->getLocation());
}
/**
*
*
* @param string $location
* @access public
*/
public function assertLocationNotEquals($location)
{
$this->assertNotEquals($location, $this->getLocation());
}
/**
* Asserts than a prompt is present.
*
* @access public
*/
public function assertPromptPresent()
{
$this->assertTrue($this->isPromptPresent());
}
/**
* Asserts than no prompt is present.
*
* @access public
*/
public function assertNoPromptPresent()
{
$this->assertFalse($this->isPromptPresent());
}
/**
* Asserts that something is selected.
*
* @param string $selectLocator
* @access public
*/
public function assertSomethingSelected($selectLocator)
{
$this->assertTrue($this->isSomethingSelected($selectLocator));
}
/**
* Asserts that nothing is selected.
*
* @param string $selectLocator
* @access public
*/
public function assertNothingSelected($selectLocator)
{
$this->assertFalse($this->isSomethingSelected($selectLocator));
}
/**
* Asserts that a given text is present.
*
* @param string $pattern
* @access public
*/
public function assertTextPresent($pattern)
{
$this->assertTrue($this->isTextPresent($pattern));
}
/**
* Asserts that a given text is not present.
*
* @param string $pattern
* @access public
*/
public function assertTextNotPresent($pattern)
{
$this->assertFalse($this->isTextPresent($pattern));
}
/**
* Asserts that the title is equal to a given string.
*
* @param string $title
* @access public
*/
public function assertTitleEquals($title)
{
$this->assertEquals($title, $this->getTitle());
}
/**
* Asserts that the title is not equal to a given string.
*
* @param string $title
* @access public
*/
public function assertTitleNotEquals($title)
{
$this->assertNotEquals($title, $this->getTitle());
}
/**
* Asserts that something is visible.
*
* @param string $locator
* @access public
*/
public function assertVisible($locator)
{
$this->assertTrue($this->isVisible($locator));
}
/**
* Asserts that something is not visible.
*
* @param string $locator
* @access public
*/
public function assertNotVisible($locator)
{
$this->assertFalse($this->isVisible($locator));
}
/**
* Retrieves the message of a JavaScript alert generated during
* the previous action
*
* @return string
* @access public
*/
public function getAlert()
{
return $this->selenium->getAlert();
}
/**
* Returns the IDs of all buttons on the page.
*
* @return array
* @access public
*/
public function getAllButtons()
{
return $this->selenium->getAllButtons();
}
/**
* Returns the IDs of all input fields on the page.
*
* @return array
* @access public
*/
public function getAllFields()
{
return $this->selenium->getAllFields();
}
/**
* Returns the IDs of all links on the page.
*
* @return array
* @access public
*/
public function getAllLinks()
{
return $this->selenium->getAllLinks();
}
/**
* Gets the entire text of the page.
*
* @return string
* @access public
*/
public function getBodyText()
{
return $this->selenium->getBodyText();
}
/**
* Retrieves the message of a JavaScript confirmation dialog
* generated during the previous action.
*
* @return string
* @access public
*/
public function getConfirmation()
{
return $this->selenium->getConfirmation();
}
/**
* Retrieves the text cursor position in the given input element
* or textarea.
*
* @param string $locator
* @return integer
* @access public
*/
public function getCursorPosition($locator)
{
return $this->selenium->getCursorPosition($locator);
}
/**
* Moves the text cursor to the specified position in the given
* input element or textarea.
*
* @param string $locator
* @param integer $position
* @return string
* @access public
*/
public function setCursorPosition($locator, $position)
{
return $this->selenium->setCursorPosition($locator, $position);
}
/**
* Gets the value of an element attribute.
*
* Note: This method should be named getAttribute(), but that
* method is already defined in PHPUnit_Framework_Assert.
*
* @param string $attributeLocator
* @return string
* @access public
*/
public function getElementAttribute($attributeLocator)
{
return $this->selenium->getAttribute($attributeLocator);
}
/**
* Gets the result of evaluating the specified JavaScript snippet.
*
* @param string $script
* @return string
* @access public
*/
public function getEval($script)
{
return $this->selenium->getEval($script);
}
/**
* Returns the specified expression.
*
* @param string $expression
* @return string
* @access public
*/
public function getExpression($expression)
{
return $this->selenium->getExpression($expression);
}
/**
* Returns the entire HTML source between the opening and
* closing "html" tags.
*
* @return string
* @access public
*/
public function getHtmlSource()
{
return $this->selenium->getHtmlSource();
}
/**
* Gets the absolute URL of the current page.
*
* @return string
* @access public
*/
public function getLocation()
{
return $this->selenium->getLocation();
}
/**
* Retrieves the message of a JavaScript question prompt dialog
* generated during the previous action.
*
* @return string
* @access public
*/
public function getPrompt()
{
return $this->selenium->getPrompt();
}
/**
* Gets option element ID for selected option in the specified
* select element.
*
* @param string $selectLocator
* @return string
* @access public
*/
public function getSelectedId($selectLocator)
{
return $this->selenium->getSelectedId($selectLocator);
}
/**
* Gets all option element IDs for selected options in the specified
* select or multi-select element.
*
* @param string $selectLocator
* @return array
* @access public
*/
public function getSelectedIds($selectLocator)
{
return $this->selenium->getSelectedIds($selectLocator);
}
/**
* Gets option index (option number, starting at 0) for selected
* option in the specified select element.
*
* @param string $selectLocator
* @return string
* @access public
*/
public function getSelectedIndex($selectLocator)
{
return $this->selenium->getSelectedIndex($selectLocator);
}
/**
* Gets all option indexes (option number, starting at 0) for selected
* options in the specified select or multi-select element.
*
* @param string $selectLocator
* @return array
* @access public
*/
public function getSelectedIndexes($selectLocator)
{
return $this->selenium->getSelectedIndexes($selectLocator);
}
/**
* Gets all option labels (visible text) for selected options
* in the specified selector multi-select element.
*
* @param string $selectLocator
* @return string
* @access public
*/
public function getSelectedLabel($selectLocator)
{
return $this->selenium->getSelectedLabel($selectLocator);
}
/**
* Gets all option labels (visible text) for selected options
* in the specified select or multi-select element.
*
* @param string $selectLocator
* @return array
* @access public
*/
public function getSelectedLabels($selectLocator)
{
return $this->selenium->getSelectedLabels($selectLocator);
}
/**
* Gets option value (value attribute) for selected option
* in the specified select element.
*
* @param string $selectLocator
* @return string
* @access public
*/
public function getSelectedValue($selectLocator)
{
return $this->selenium->getSelectedValue($selectLocator);
}
/**
* Gets all option values (value attributes) for selected options
* in the specified select or multi-select element.
*
* @param string $selectLocator
* @return array
* @access public
*/
public function getSelectedValues($selectLocator)
{
return $this->selenium->getSelectedValues($selectLocator);
}
/**
* Gets all option labels in the specified select drop-down.
*
* @param string $selectLocator
* @return array
* @access public
*/
public function getSelectOptions($selectLocator)
{
return $this->selenium->getSelectOptions($selectLocator);
}
/**
* Gets the text from a cell of a table.
*
* @param string $tableCellAddress
* @return string
* @access public
*/
public function getTable($tableCellAddress)
{
return $this->selenium->getTable($tableCellAddress);
}
/**
* Gets the text of an element.
*
* @param string $locator
* @return string
* @access public
*/
public function getText($locator)
{
return $this->selenium->getText($locator);
}
/**
* Gets the title of the current page.
*
* @return string
* @access public
*/
public function getTitle()
{
return $this->selenium->getTitle();
}
/**
* Gets the (whitespace-trimmed) value of an input field
* (or anything else with a value parameter).
*
* @param string $locator
* @return string
* @access public
*/
public function getValue($locator)
{
return $this->selenium->getValue($locator);
}
/**
* Has an alert occured?
*
* @return boolean
* @access public
*/
public function isAlertPresent()
{
return $this->selenium->isAlertPresent();
}
/**
* Determines whether a toggle-button (checkbox/radio) is checked.
*
* @param string $locator
* @return boolean
* @access public
*/
public function isChecked($locator)
{
return $this->selenium->isChecked($locator);
}
/**
* Has confirm() been called?
*
* @return boolean
* @access public
*/
public function isConfirmationPresent()
{
return $this->selenium->isConfirmationPresent();
}
/**
* Determines whether the specified input element is editable.
*
* @param string $locator
* @return boolean
* @access public
*/
public function isEditable($locator)
{
return $this->selenium->isEditable($locator);
}
/**
* Verifies that the specified element is somewhere on the page.
*
* @param string $locator
* @return boolean
* @access public
*/
public function isElementPresent($locator)
{
return $this->selenium->isElementPresent($locator);
}
/**
* Has a prompt occured?
*
* @return boolean
* @access public
*/
public function isPromptPresent()
{
return $this->selenium->isPromptPresent();
}
/**
* Determines whether some option in a drop-down menu is selected.
*
* @param string $selectLocator
* @return boolean
* @access public
*/
public function isSomethingSelected($selectLocator)
{
return $this->selenium->isSomethingSelected($selectLocator);
}
/**
* Verifies that the specified text pattern appears somewhere
* on the rendered page shown to the user.
*
* @param string $pattern
* @return boolean
* @access public
*/
public function isTextPresent($pattern)
{
return $this->selenium->isTextPresent($pattern);
}
/**
* Determines if the specified element is visible.
*
* @param string $locator
* @return string
* @access public
*/
public function isVisible($locator)
{
return $this->selenium->isVisible($locator);
}
/**
* Run the browser and set session id.
*
* @return string
* @access public
*/
public function start()
{
return $this->selenium->start();
}
/**
* Close the browser and set session to NULL.
*
* @return string
* @access public
*/
public function stop()
{
if ($this->selenium !== NULL) {
return $this->selenium->stop();
}
}
/**
* Open the URL in the test frame.
*
* @param string $url
* @return string
* @access public
*/
public function open($url)
{
return $this->selenium->open($url);
}
/**
* Simulates the user clicking the "close" button" in the titlebar
* of a popup window or tab.
*
* @return string
* @access public
*/
public function close()
{
return $this->selenium->close();
}
/**
* Simulates clicking on the browser's "go back" button.
*
* @return string
* @access public
*/
public function goBack()
{
return $this->selenium->goBack();
}
/**
* Simulates clicking on the browser's "refresh" button.
*
* @return string
* @access public
*/
public function refresh()
{
return $this->selenium->refresh();
}
/**
* Clicks on a link, button, checkbox or radio button.
* If the click action causes a new page to load,
* call waitForPageToLoad.
*
* @param string $locator
* @return string
* @access public
*/
public function click($locator)
{
return $this->selenium->click($locator);
}
/**
* Simulate an event to trigger the corresponding "onEvent" handler.
*
* @param string $locator
* @param string $eventName
* @return string
* @access public
*/
public function fireEvent($locator, $eventName)
{
return $this->selenium->fireEvent($locator, $eventName);
}
/**
* Simulates a user pressing and holding a key.
*
* @param string $locator
* @param string $keycode
* @return string
* @access public
*/