forked from adamdriscoll/selenium-powershell
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Selenium.psm1
1447 lines (1302 loc) · 57.3 KB
/
Selenium.psm1
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
class ValidateURIAttribute : System.Management.Automation.ValidateArgumentsAttribute {
[void] Validate([object] $arguments , [System.Management.Automation.EngineIntrinsics]$EngineIntrinsics) {
$Out = $null
if ([uri]::TryCreate($arguments,[System.UriKind]::Absolute, [ref]$Out)) {return}
else {throw [System.Management.Automation.ValidationMetadataException]::new('Incorrect StartURL please make sure the URL starts with http:// or https://')}
return
}
}
class ValidateIsWebDriverAttribute : System.Management.Automation.ValidateArgumentsAttribute {
[void] Validate([object] $arguments , [System.Management.Automation.EngineIntrinsics]$EngineIntrinsics) {
if ($arguments -isnot [OpenQA.Selenium.Remote.RemoteWebDriver]) {
throw [System.Management.Automation.ValidationMetadataException]::new('Target was not a valid web driver')
}
return
}
}
#Allow BY to shorten cssSelector, ClassName, LinkText, and TagName
class ByTransformAttribute : System.Management.Automation.ArgumentTransformationAttribute {
[object] Transform([System.Management.Automation.EngineIntrinsics]$EngineIntrinsics, [object] $InputData) {
if ($inputData -match 'CssSelector|Name|Id|ClassName|LinkText|PartialLinkText|TagName|XPath') {
return $InputData
}
switch -regex ($InputData) {
"^css" {return 'CssSelector'; break}
"^class" {return 'ClassName' ; break}
"^link" {return 'LinkText' ; break}
"^tag" {return 'TagName' ; break}
}
return $InputData
}
}
#Allow operator to use containing, matching, matches, equals etc.
class OperatorTransformAttribute : System.Management.Automation.ArgumentTransformationAttribute {
[object] Transform([System.Management.Automation.EngineIntrinsics]$EngineIntrinsics, [object] $InputData) {
if ($inputData -match '^(contains|like|notlike|match|notmatch|eq|ne|gt|lt)$#') {
return $InputData
}
switch -regex ($InputData) {
"^contain" {return 'contains' ; break}
"^match" {return 'match' ; break}
"^n\w*match" {return 'notmatch' ; break}
"^eq" {return 'eq' ; break}
"^n\w*eq" {return 'ne' ; break}
}
return $InputData
}
}
$dll1Path = Join-path -path (Join-path -path $PSScriptRoot -ChildPath 'assemblies') -ChildPath 'WebDriver.dll'
$dll2Path = Join-path -path (Join-path -path $PSScriptRoot -ChildPath 'assemblies') -ChildPath 'WebDriver.Support.dll'
Add-type @"
using OpenQA.Selenium;
using OpenQA.Selenium.Support.UI;
using System.Collections.Generic;
namespace SeleniumSelection {
public class Option {
public static bool IsMultiSelect(IWebElement element) {
var selection = new SelectElement(element);
return selection.IsMultiple;
}
public static IList<IWebElement> GetOptions(IWebElement element) {
var selection = new SelectElement(element);
return selection.Options;
}
public static void SelectByValue(IWebElement element, string value) {
var selection = new SelectElement(element);
selection.SelectByValue(value);
}
public static void DeselectByValue(IWebElement element, string value) {
var selection = new SelectElement(element);
selection.DeselectByValue(value);
}
public static void SelectByText(IWebElement element, string text, bool partialMatch = false) {
var selection = new SelectElement(element);
selection.SelectByText(text,partialMatch);
}
public static void DeselectByText(IWebElement element, string text) {
var selection = new SelectElement(element);
selection.DeselectByText(text);
}
public static void SelectByIndex(IWebElement element, int index) {
var selection = new SelectElement(element);
selection.SelectByIndex(index);
}
public static void DeselectByIndex(IWebElement element, int index) {
var selection = new SelectElement(element);
selection.DeselectByIndex(index);
}
public static void DeselectAll(IWebElement element) {
var selection = new SelectElement(element);
selection.DeselectAll();
}
public static IWebElement GetSelectedOption(IWebElement element) {
var selection = new SelectElement(element);
return selection.SelectedOption;
}
public static IList<IWebElement> GetAllSelectedOptions(IWebElement element) {
var selection = new SelectElement(element);
return selection.AllSelectedOptions;
}
}
}
"@ -ReferencedAssemblies $dll1Path,$dll2Path, mscorlib
$Script:SeKeys = [OpenQA.Selenium.Keys] | Get-Member -MemberType Property -Static |
Select-Object -Property Name, @{N = "ObjectString"; E = { "[OpenQA.Selenium.Keys]::$($_.Name)" } }
#region Set path to assemblies on Linux and MacOS and Grant Execution permissions on them
if($IsLinux){
$AssembliesPath = "$PSScriptRoot/assemblies/linux"
}
elseif($IsMacOS){
$AssembliesPath = "$PSScriptRoot/assemblies/macos"
}
# Grant Execution permission to assemblies on Linux and MacOS
if($AssembliesPath){
# Check if powershell is NOT running as root
Get-Item -Path "$AssembliesPath/chromedriver", "$AssembliesPath/geckodriver" | ForEach-Object {
if($IsLinux) {$FileMod = stat -c "%a" $_.FullName}
elseif($IsMacOS){$FileMod = /usr/bin/stat -f "%A" $_.FullName}
Write-Verbose "$($_.FullName) $Filemod"
if($FileMod[2] -ne '5' -and $FileMod[2] -ne '7' ){
Write-Host "Granting $($_.fullname) Execution Permissions ..."
chmod +x $_.fullname
}
}
if(-not $env:GeckoWebDriver -and (Test-Path "$AssembliesPath/geckodriver" )) {$env:GeckoWebDriver = $AssembliesPath}
if(-not $env:ChromeWebDriver -and (Test-Path "$AssembliesPath/chromedriver")) {$env:ChromeWebDriver = $AssembliesPath}
}
#endregion
function ValidateURL {
[Alias("Validate-Url")]
param(
[Parameter(Mandatory=$true)]$URL
)
$Out = $null
[uri]::TryCreate($URL,[System.UriKind]::Absolute, [ref]$Out)
}
function Start-SeNewEdge {
[cmdletbinding(DefaultParameterSetName='default')]
[Alias('CrEdge','NewEdge')]
param(
[ValidateURIAttribute()]
[Parameter(Position=0)]
[string]$StartURL,
[switch]$HideVersionHint,
[parameter(ParameterSetName='min', Mandatory=$true)]
[switch]$Minimized,
[parameter(ParameterSetName='max', Mandatory=$true)]
[switch]$Maximized,
[parameter(ParameterSetName='ful', Mandatory=$true)]
[switch]$FullScreen,
[parameter(ParameterSetName='hl', Mandatory=$true)]
[switch]$Headless,
$BinaryPath = "C:\Program Files (x86)\Microsoft\Edge\Application\msedge.exe",
$ProfileDirectoryPath,
$DefaultDownloadPath,
[switch]$AsDefaultDriver,
[switch]$Quiet,
[Alias('Incognito')]
[switch]$PrivateBrowsing,
[int]$ImplicitWait = 10,
$WebDriverDirectory = $env:EdgeWebDriver
)
$OptionSettings = @{ browserName=''}
#region check / set paths for browser and web driver and edge options
if($PSBoundParameters['BinaryPath'] -and -not (Test-Path -Path $BinaryPath)) {
throw "Could not find $BinaryPath"; return
}
#Were we given a driver location and is msedgedriver there ?
#If were were given a location (which might be from an environment variable) is the driver THERE ?
# if not, were we given a path for the browser executable, and is the driver THERE ?
# and if not there either, is there one in the assemblies sub dir ? And if not bail
if( $WebDriverDirectory -and -not (Test-Path -Path (Join-Path -Path $WebDriverDirectory -ChildPath 'msedgedriver.exe' ))) {
throw "Could not find msedgedriver.exe in $WebDriverDirectory"; return
}
elseif( $WebDriverDirectory -and (Test-Path (Join-Path -Path $WebDriverDirectory -ChildPath 'msedge.exe' ))) {
Write-Verbose -Message "Using browser from $WebDriverDirectory"
$optionsettings['BinaryLocation'] = Join-Path -Path $WebDriverDirectory -ChildPath 'msedge.exe'
}
elseif( $BinaryPath) {
$optionsettings['BinaryLocation'] = $ExecutionContext.SessionState.Path.GetUnresolvedProviderPathFromPSPath($BinaryPath)
$binaryDir = Split-Path -Path $BinaryPath -Parent
Write-Verbose -Message "Will request $($OptionSettings['BinaryLocation']) as the browser"
}
if(-not $WebDriverDirectory -and $binaryDir -and (Test-Path (Join-Path -Path $binaryDir -ChildPath 'msedgedriver.exe' ))) {
$WebDriverDirectory = $binaryDir
}
# No linux or mac driver to test for yet
if(-not $WebDriverDirectory -and (Test-Path (Join-path -Path "$PSScriptRoot\Assemblies\" -ChildPath 'msedgedriver.exe' ))) {
$WebDriverDirectory = "$PSScriptRoot\Assemblies\"
Write-Verbose -Message "Using Web driver from the default location"
}
if(-not $WebDriverDirectory) {throw "Could not find msedgedriver.exe"; return}
# The "credge" web driver will work with the edge selenium objects, but works better with the chrome ones.
$service = [OpenQA.Selenium.Chrome.ChromeDriverService]::CreateDefaultService($WebDriverDirectory, 'msedgedriver.exe')
$options = New-Object -TypeName OpenQA.Selenium.Chrome.ChromeOptions -Property $OptionSettings
#The command line args may now be --inprivate --headless but msedge driver V81 does not pass them
if($PrivateBrowsing) {$options.AddArguments('InPrivate')}
if($Headless) {$options.AddArguments('headless')}
if($Quiet) {$service.HideCommandPromptWindow = $true}
if($ProfileDirectoryPath) {
$ProfileDirectoryPath = $ExecutionContext.SessionState.Path.GetUnresolvedProviderPathFromPSPath($ProfileDirectoryPath)
Write-Verbose "Setting Profile directory: $ProfileDirectoryPath"
$options.AddArgument("user-data-dir=$ProfileDirectoryPath")
}
if($DefaultDownloadPath) {
$DefaultDownloadPath = $ExecutionContext.SessionState.Path.GetUnresolvedProviderPathFromPSPath($DefaultDownloadPath)
Write-Verbose "Setting Default Download directory: $DefaultDownloadPath"
$Options.AddUserProfilePreference('download', @{'default_directory' = $DefaultDownloadPath; 'prompt_for_download' = $false; })
}
#endregion
$Driver = New-Object -TypeName OpenQA.Selenium.Chrome.ChromeDriver -ArgumentList $service, $options
#region post driver checks and option checks If we have a version know to have problems with passing arguments, generate a warning if we tried to send any.
if(-not $Driver) {
Write-Warning "Web driver was not created"; return
}
else {
$driverversion = $Driver.Capabilities.ToDictionary().msedge.msedgedriverVersion -replace '^([\d.]+).*$','$1'
if (-not $driverversion) {$driverversion = $driver.Capabilities.ToDictionary().chrome.chromedriverVersion -replace '^([\d.]+).*$','$1'}
Write-Verbose "Web Driver version $driverversion"
Write-Verbose ("Browser: {0,9} {1}" -f $Driver.Capabilities.ToDictionary().browserName,
$Driver.Capabilities.ToDictionary().browserVersion)
if(!$HideVersionHint){
Write-Verbose "You can download the right webdriver from 'https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/'"
}
$browserCmdline = (Get-CimInstance -Verbose:$false -Query (
"Select * From win32_process " +
"Where parentprocessid = $($service.ProcessId) "+
"And name = 'msedge.exe'") ).commandline
$options.arguments | Where-Object {$browserCmdline -notlike "*$_*"} | ForEach-Object {
Write-Warning "Argument $_ was not passed to the Browser. This is a known issue with some web driver versions."
}
}
$Driver.Manage().Timeouts().ImplicitWait = [TimeSpan]::FromSeconds($ImplicitWait)
if($StartURL) {$Driver.Navigate().GoToUrl($StartURL)}
if($Minimized){
$Driver.Manage().Window.Minimize();
}
if($Maximized){
$Driver.Manage().Window.Maximize()
}
if ($FullScreen) {
$Driver.Manage().Window.FullScreen()
}
#endregion
if($AsDefaultDriver) {
if($Global:SeDriver) {$Global:SeDriver.Dispose()}
$Global:SeDriver = $Driver
}
else {$Driver}
}
function Start-SeChrome {
[cmdletbinding(DefaultParameterSetName='default')]
[Alias('SeChrome')]
param(
[ValidateURIAttribute()]
[Parameter(Position=0)]
[string]$StartURL,
[Parameter(Mandatory = $false)]
[array]$Arguments,
[switch]$HideVersionHint,
[System.IO.FileInfo]$DefaultDownloadPath,
[System.IO.FileInfo]$ProfileDirectoryPath,
[Parameter(DontShow)]
[bool]$DisableBuiltInPDFViewer=$true,
[switch]$EnablePDFViewer,
[Alias('PrivateBrowsing')]
[switch]$Incognito,
[parameter(ParameterSetName='hl', Mandatory=$true)]
[switch]$Headless,
[parameter(ParameterSetName='Min',Mandatory=$true)]
[switch]$Maximized,
[parameter(ParameterSetName='Max',Mandatory=$true)]
[switch]$Minimized,
[parameter(ParameterSetName='Ful',Mandatory=$true)]
[switch]$Fullscreen,
[Alias('ChromeBinaryPath')]
$BinaryPath,
$WebDriverDirectory = $env:ChromeWebDriver,
[switch]$Quiet,
[switch]$AsDefaultDriver,
[int]$ImplicitWait = 10
)
process {
#region chrome set-up options
$Chrome_Options = New-Object -TypeName "OpenQA.Selenium.Chrome.ChromeOptions"
if($DefaultDownloadPath){
Write-Verbose "Setting Default Download directory: $DefaultDownloadPath"
$Chrome_Options.AddUserProfilePreference('download', @{'default_directory' = $($DefaultDownloadPath.FullName); 'prompt_for_download' = $false; })
}
if($ProfileDirectoryPath){
Write-Verbose "Setting Profile directory: $ProfileDirectoryPath"
$Chrome_Options.AddArgument("user-data-dir=$ProfileDirectoryPath")
}
if($BinaryPath){
Write-Verbose "Setting Chrome Binary directory: $BinaryPath"
$Chrome_Options.BinaryLocation ="$BinaryPath"
}
if($DisableBuiltInPDFViewer -and -not $EnablePDFViewer){
$Chrome_Options.AddUserProfilePreference('plugins', @{'always_open_pdf_externally' = $true;})
}
if($Headless){
$Chrome_Options.AddArguments('headless')
}
if($Incognito){
$Chrome_Options.AddArguments('Incognito')
}
if($Maximized){
$Chrome_Options.AddArguments('start-maximized')
}
if($Fullscreen){
$Chrome_Options.AddArguments('start-fullscreen')
}
if($Arguments){
foreach ($Argument in $Arguments){
$Chrome_Options.AddArguments($Argument)
}
}
if(!$HideVersionHint){
Write-Verbose "Download the right chromedriver from 'http://chromedriver.chromium.org/downloads'"
}
if($WebDriverDirectory) {$service = [OpenQA.Selenium.Chrome.ChromeDriverService]::CreateDefaultService($WebDriverDirectory)}
else {$service = [OpenQA.Selenium.Chrome.ChromeDriverService]::CreateDefaultService()}
if ($Quiet) {$service.HideCommandPromptWindow = $true}
#endregion
$Driver = New-Object -TypeName "OpenQA.Selenium.Chrome.ChromeDriver" -ArgumentList $service,$Chrome_Options
if(-not $Driver) {Write-Warning "Web driver was not created"; return}
#region post creation options
$Driver.Manage().Timeouts().ImplicitWait = [TimeSpan]::FromSeconds($ImplicitWait)
if($Minimized){
$Driver.Manage().Window.Minimize();
}
if($Headless -and $DefaultDownloadPath){
$HeadlessDownloadParams = New-Object 'system.collections.generic.dictionary[[System.String],[System.Object]]]'
$HeadlessDownloadParams.Add('behavior', 'allow')
$HeadlessDownloadParams.Add('downloadPath', $DefaultDownloadPath.FullName)
$Driver.ExecuteChromeCommand('Page.setDownloadBehavior', $HeadlessDownloadParams)
}
if($StartURL) {$Driver.Navigate().GoToUrl($StartURL)}
#endregion
if($AsDefaultDriver) {
if($Global:SeDriver) {$Global:SeDriver.Dispose()}
$Global:SeDriver = $Driver
}
else {$Driver}
}
}
function Start-SeInternetExplorer {
[cmdletbinding(DefaultParameterSetName='Default')]
[Alias('SeInternetExplorer','SeIE')]
param(
[ValidateURIAttribute()]
[Parameter(Position=0)]
[string]$StartURL,
[switch]$Quiet,
[switch]$AsDefaultDriver,
[parameter(ParameterSetName='Max', Mandatory=$true)]
[switch]$Maximized,
[parameter(ParameterSetName='Min', Mandatory=$true)]
[switch]$Minimized,
[parameter(ParameterSetName='Min', Mandatory=$true)]
[switch]$FullScreen,
[Parameter(DontShow)]
[parameter(ParameterSetName='HL', Mandatory=$true)]
[switch]$Headless,
[Parameter(DontShow)]
[Alias('Incognito')]
[switch]$PrivateBrowsing,
[int]$ImplicitWait = 10,
$WebDriverDirectory = $env:IEWebDriver
)
#region IE set-up options
if($Headless -or $PrivateBrowsing) {Write-Warning 'The Internet explorer driver does not support headless or Inprivate operation; these switches are ignored'}
$InternetExplorer_Options = New-Object -TypeName "OpenQA.Selenium.IE.InternetExplorerOptions"
$InternetExplorer_Options.IgnoreZoomLevel = $true
if($StartURL) {$InternetExplorer_Options.InitialBrowserUrl = $StartURL }
if($WebDriverDirectory) {$Service = [OpenQA.Selenium.IE.InternetExplorerDriverService]::CreateDefaultService($WebDriverDirectory)}
else {$Service = [OpenQA.Selenium.IE.InternetExplorerDriverService]::CreateDefaultService()}
if($Quiet) {$Service.HideCommandPromptWindow = $true}
#endregion
$Driver = New-Object -TypeName "OpenQA.Selenium.IE.InternetExplorerDriver" -ArgumentList $service, $InternetExplorer_Options
if(-not $Driver) {Write-Warning "Web driver was not created"; return}
#region post creation options
$Driver.Manage().Timeouts().ImplicitWait = [TimeSpan]::FromSeconds($ImplicitWait)
if($Minimized){
$Driver.Manage().Window.Minimize();
}
if($Maximized){
$Driver.Manage().Window.Maximize()
}
if ($FullScreen) {
$Driver.Manage().Window.FullScreen()
}
#endregion
if($AsDefaultDriver) {
if($Global:SeDriver) {$Global:SeDriver.Dispose()}
$Global:SeDriver = $Driver
}
else {$Driver}
}
function Start-SeEdge {
[cmdletbinding(DefaultParameterSetName='default')]
[Alias('LegacyEdge','Start-SeLegacyEdge')]
param(
[ValidateURIAttribute()]
[Parameter(Position=0)]
[string]$StartURL,
[parameter(ParameterSetName='Min', Mandatory=$true)]
[switch]$Maximized,
[parameter(ParameterSetName='Max', Mandatory=$true)]
[switch]$Minimized,
[parameter(ParameterSetName='Full',Mandatory=$true)]
[switch]$FullScreen,
[Alias('Incognito')]
[switch]$PrivateBrowsing,
[switch]$Quiet,
[switch]$AsDefaultDriver,
[Parameter(DontShow)]
[switch]$Headless,
[int]$ImplicitWait = 10
)
#region Edge set-up options
if($Headless) {Write-Warning 'Pre-Chromium Edge does not support headless operation; the Headless switch is ignored'}
$service = [OpenQA.Selenium.Edge.EdgeDriverService]::CreateDefaultService()
$options = New-Object -TypeName OpenQA.Selenium.Edge.EdgeOptions
if($Quiet) {$service.HideCommandPromptWindow = $true}
if($PrivateBrowsing) {$options.UseInPrivateBrowsing = $true}
if($StartURL) {$options.StartPage = $StartURL}
#endregion
try {
$Driver = New-Object -TypeName "OpenQA.Selenium.Edge.EdgeDriver" -ArgumentList $service ,$options
}
catch {
$driverversion = (Get-Item .\assemblies\MicrosoftWebDriver.exe ).VersionInfo.ProductVersion
$WindowsVersion = [System.Environment]::OSVersion.Version.ToString()
Write-Warning -Message "Edge driver is $driverversion. Windows is $WindowsVersion. If the driver is out-of-date, update it as a Windows feature,`r`nand then delete $PSScriptRoot\assemblies\MicrosoftWebDriver.exe"
throw $_ ; return
}
if(-not $Driver) {Write-Warning "Web driver was not created"; return}
#region post creation options
$Driver.Manage().Timeouts().ImplicitWait = [TimeSpan]::FromSeconds($ImplicitWait)
if($Minimized) {$Driver.Manage().Window.Minimize() }
if($Maximized) {$Driver.Manage().Window.Maximize() }
if($FullScreen) {$Driver.Manage().Window.FullScreen()}
#endregion
if($AsDefaultDriver) {
if($Global:SeDriver) {$Global:SeDriver.Dispose()}
$Global:SeDriver = $Driver
}
else {$Driver}
}
function Start-SeFirefox {
[cmdletbinding(DefaultParameterSetName='default')]
[Alias('SeFirefox')]
param(
[ValidateURIAttribute()]
[Parameter(Position=0)]
[string]$StartURL,
[array]$Arguments,
[System.IO.FileInfo]$DefaultDownloadPath,
[alias('Incognito')]
[switch]$PrivateBrowsing,
[parameter(ParameterSetName='HL', Mandatory=$true)]
[switch]$Headless,
[parameter(ParameterSetName='Min',Mandatory=$true)]
[switch]$Maximized,
[parameter(ParameterSetName='Max',Mandatory=$true)]
[switch]$Minimized,
[parameter(ParameterSetName='Ful',Mandatory=$true)]
[switch]$Fullscreen,
[switch]$SuppressLogging,
[switch]$Quiet,
[switch]$AsDefaultDriver,
[int]$ImplicitWait = 10,
$WebDriverDirectory = $env:GeckoWebDriver
)
process {
#region firefox set-up options
$Firefox_Options = New-Object -TypeName "OpenQA.Selenium.Firefox.FirefoxOptions"
if($Headless){
$Firefox_Options.AddArguments('-headless')
}
if($DefaultDownloadPath){
Write-Verbose "Setting Default Download directory: $DefaultDownloadPath"
$Firefox_Options.setPreference("browser.download.folderList",2);
$Firefox_Options.SetPreference("browser.download.dir", "$DefaultDownloadPath");
}
if($PrivateBrowsing){
$Firefox_Options.SetPreference("browser.privatebrowsing.autostart", $true)
}
if($Arguments){
foreach ($Argument in $Arguments){
$Firefox_Options.AddArguments($Argument)
}
}
if($SuppressLogging){
# Sets GeckoDriver log level to Fatal.
$Firefox_Options.LogLevel = 6
}
if($WebDriverDirectory) {$service = [OpenQA.Selenium.Firefox.FirefoxDriverService]::CreateDefaultService($WebDriverDirectory)}
else {$service = [OpenQA.Selenium.Firefox.FirefoxDriverService]::CreateDefaultService()}
if($Quiet) {$service.HideCommandPromptWindow = $true}
#endregion
$Driver = New-Object -TypeName "OpenQA.Selenium.Firefox.FirefoxDriver" -ArgumentList $service, $Firefox_Options
if(-not $Driver) {Write-Warning "Web driver was not created"; return}
#region post creation options
$Driver.Manage().Timeouts().ImplicitWait = [TimeSpan]::FromSeconds($ImplicitWait)
if($Minimized) {$Driver.Manage().Window.Minimize() }
if($Maximized) {$Driver.Manage().Window.Maximize() }
if($Fullscreen) {$Driver.Manage().Window.FullScreen() }
if($StartURL) {$Driver.Navigate().GoToUrl($StartURL) }
#endregion
if($AsDefaultDriver) {
if($Global:SeDriver) {$Global:SeDriver.Dispose()}
$Global:SeDriver = $Driver
}
else {$Driver}
}
}
function Start-SeRemote {
<#
.example
#you can a remote testing account with testing bot at https://testingbot.com/users/sign_up
#Set $key and $secret and then ...
#see also https://crossbrowsertesting.com/freetrial / https://help.crossbrowsertesting.com/selenium-testing/getting-started/c-sharp/
#and https://www.browserstack.com/automate/c-sharp
$RemoteDriverURL = [uri]"http://$key`:[email protected]/wd/hub"
#See https://testingbot.com/support/getting-started/csharp.html for values for different browsers/platforms
$caps = @{
platform = 'HIGH-SIERRA'
version = '11'
browserName = 'safari'
}
Start-SeRemote -RemoteAddress $remoteDriverUrl -DesiredCapabilties $caps
#>
[cmdletbinding(DefaultParameterSetName='default')]
param(
[string]$RemoteAddress,
[hashtable]$DesiredCapabilities,
[ValidateURIAttribute()]
[Parameter(Position=0)]
[string]$StartURL,
[switch]$AsDefaultDriver,
[int]$ImplicitWait = 10
)
$desired = New-Object -TypeName OpenQA.Selenium.Remote.DesiredCapabilities
if (-not $DesiredCapabilities.Name) {
$desired.SetCapability('name', [datetime]::now.tostring("yyyyMMdd-hhmmss"))
}
foreach ($k in $DesiredCapabilities.keys) {$desired.SetCapability($k,$DesiredCapabilities[$k])}
$Driver = New-Object -TypeName OpenQA.Selenium.Remote.RemoteWebDriver -ArgumentList $RemoteAddress,$desired
if(-not $Driver) {Write-Warning "Web driver was not created"; return}
$Driver.Manage().Timeouts().ImplicitWait = [TimeSpan]::FromSeconds($ImplicitWait)
if ($StartURL) {$Driver.Navigate().GotoUrl($StartURL)}
if($AsDefaultDriver) {
if($Global:SeDriver) {$Global:SeDriver.Dispose()}
$Global:SeDriver = $Driver
}
else {$Driver}
}
function Stop-SeDriver {
[alias('SeClose')]
param(
[Parameter(ValueFromPipeline=$true, position=0,ParameterSetName='Driver')]
[ValidateIsWebDriverAttribute()]
$Driver,
[Parameter(Mandatory=$true, ParameterSetName='Default')]
[switch]$Default
)
if(-not $PSBoundParameters.ContainsKey('Driver') -and $Global:SeDriver -and ($Default -or $MyInvocation.InvocationName -eq 'SeClose')) {
Write-Verbose -Message "Closing $($Global:SeDriver.Capabilities.browsername)..."
$Global:SeDriver.Close()
$Global:SeDriver.Dispose()
Remove-Variable -Name SeDriver -Scope global
}
elseif($Driver) {
$Driver.Close()
$Driver.Dispose()
}
else {Write-Warning -Message 'No Driver Specified'}
}
<#function Enter-SeUrl {
param($Driver, $Url)
$Driver.Navigate().GoToUrl($Url)
}
#>
function Open-SeUrl {
[cmdletbinding(DefaultParameterSetName='default')]
[Alias('SeNavigate',"Enter-SeUrl")]
param(
[Parameter(Mandatory=$true, Position=0,ParameterSetName='default')]
[ValidateURIAttribute()]
[string]$Url,
[Alias("Driver")]
[ValidateIsWebDriverAttribute()]
[Parameter(ValueFromPipeline=$true, Position=1)]
$Target = $Global:SeDriver,
[Parameter(Mandatory=$true,ParameterSetName='back')]
[switch]$Back
)
if($Back) {$Target.Navigate().Back()}
else {$Target.Navigate().GoToUrl($Url)}
}
<#function Find-SeElement {
param(
[Parameter()]
$Driver,
[Parameter()]
$Element,
[Parameter()][Switch]$Wait,
[Parameter()]$Timeout = 30,
[Parameter(ParameterSetName = "ByCss")]
$Css,
[Parameter(ParameterSetName = "ByName")]
$Name,
[Parameter(ParameterSetName = "ById")]
$Id,
[Parameter(ParameterSetName = "ByClassName")]
$ClassName,
[Parameter(ParameterSetName = "ByLinkText")]
$LinkText,
[Parameter(ParameterSetName = "ByPartialLinkText")]
$PartialLinkText,
[Parameter(ParameterSetName = "ByTagName")]
$TagName,
[Parameter(ParameterSetName = "ByXPath")]
$XPath
)
process {
if($null -ne $Driver -and $null -ne $Element) {
throw "Driver and Element may not be specified together."
}
elseif($null -ne $Driver) {
$Target = $Driver
}
elseif(-ne $Null $Element) {
$Target = $Element
}
else {
"Driver or element must be specified"
}
if($Wait){
if($PSCmdlet.ParameterSetName -eq "ByName") {
$TargetElement = [OpenQA.Selenium.By]::Name($Name)
}
if($PSCmdlet.ParameterSetName -eq "ById") {
$TargetElement = [OpenQA.Selenium.By]::Id($Id)
}
if($PSCmdlet.ParameterSetName -eq "ByLinkText") {
$TargetElement = [OpenQA.Selenium.By]::LinkText($LinkText)
}
if($PSCmdlet.ParameterSetName -eq "ByPartialLinkText") {
$TargetElement = [OpenQA.Selenium.By]::PartialLinkText($PartialLinkText)
}
if($PSCmdlet.ParameterSetName -eq "ByClassName") {
$TargetElement = [OpenQA.Selenium.By]::ClassName($ClassName)
}
if($PSCmdlet.ParameterSetName -eq "ByTagName") {
$TargetElement = [OpenQA.Selenium.By]::TagName($TagName)
}
if($PSCmdlet.ParameterSetName -eq "ByXPath") {
$TargetElement = [OpenQA.Selenium.By]::XPath($XPath)
}
if($PSCmdlet.ParameterSetName -eq "ByCss") {
$TargetElement = [OpenQA.Selenium.By]::CssSelector($Css)
}
$WebDriverWait = New-Object -TypeName OpenQA.Selenium.Support.UI.WebDriverWait($Driver, (New-TimeSpan -Seconds $Timeout))
$Condition = [OpenQA.Selenium.Support.UI.ExpectedConditions]::ElementExists($TargetElement)
$WebDriverWait.Until($Condition)
}
else{
if($PSCmdlet.ParameterSetName -eq "ByName") {
$Target.FindElements([OpenQA.Selenium.By]::Name($Name))
}
if($PSCmdlet.ParameterSetName -eq "ById") {
$Target.FindElements([OpenQA.Selenium.By]::Id($Id))
}
if($PSCmdlet.ParameterSetName -eq "ByLinkText") {
$Target.FindElements([OpenQA.Selenium.By]::LinkText($LinkText))
}
if($PSCmdlet.ParameterSetName -eq "ByPartialLinkText") {
$Target.FindElements([OpenQA.Selenium.By]::PartialLinkText($PartialLinkText))
}
if($PSCmdlet.ParameterSetName -eq "ByClassName") {
$Target.FindElements([OpenQA.Selenium.By]::ClassName($ClassName))
}
if($PSCmdlet.ParameterSetName -eq "ByTagName") {
$Target.FindElements([OpenQA.Selenium.By]::TagName($TagName))
}
if($PSCmdlet.ParameterSetName -eq "ByXPath") {
$Target.FindElements([OpenQA.Selenium.By]::XPath($XPath))
}
if($PSCmdlet.ParameterSetName -eq "ByCss") {
$Target.FindElements([OpenQA.Selenium.By]::CssSelector($Css))
}
}
}
}
#>
function Get-SeElement {
[Alias('Find-SeElement','SeElement')]
param(
#Specifies whether the selction text is to select by name, ID, Xpath etc
[ValidateSet("CssSelector", "Name", "Id", "ClassName", "LinkText", "PartialLinkText", "TagName", "XPath")]
[ByTransformAttribute()]
[string]$By = "XPath",
#Text to select on
[Alias("CssSelector","Name", "Id", "ClassName","LinkText", "PartialLinkText", "TagName","XPath")]
[Parameter(Position=1,Mandatory=$true)]
[string]$Selection,
#Specifies a time out
[Parameter(Position=2)]
[Int]$Timeout = 0,
#The driver or Element where the search should be performed.
[Parameter(Position=3,ValueFromPipeline=$true)]
[Alias('Element','Driver')]
$Target = $Global:SeDriver,
[parameter(DontShow)]
[Switch]$Wait
)
process {
#if one of the old parameter names was used and BY was NIT specified, look for
# <cmd/alias name> [anything which doesn't mean end of command] -Param
# capture Param and set it as the value for by
$mi = $MyInvocation.InvocationName
if(-not $PSBoundParameters.ContainsKey("By") -and
($MyInvocation.Line -match "$mi[^>\|;]*-(CssSelector|Name|Id|ClassName|LinkText|PartialLinkText|TagName|XPath)")) {
$By = $Matches[1]
}
if($wait -and $Timeout -eq 0) {$Timeout = 30 }
if($TimeOut -and $Target -is [OpenQA.Selenium.Remote.RemoteWebDriver]) {
$TargetElement = [OpenQA.Selenium.By]::$By($Selection)
$WebDriverWait = New-Object -TypeName OpenQA.Selenium.Support.UI.WebDriverWait -ArgumentList $Target, (New-TimeSpan -Seconds $Timeout)
$Condition = [OpenQA.Selenium.Support.UI.ExpectedConditions]::ElementExists($TargetElement)
$WebDriverWait.Until($Condition)
}
elseif($Target -is [OpenQA.Selenium.Remote.RemoteWebElement] -or
$Target -is [OpenQA.Selenium.Remote.RemoteWebDriver]) {
if($Timeout) {Write-Warning "Timeout does not apply when searching an Element"}
$Target.FindElements([OpenQA.Selenium.By]::$By($Selection))
}
else {throw "No valid target was provided."}
}
}
function Invoke-SeClick {
param(
[Parameter(Mandatory = $true, ValueFromPipeline = $true)]
[OpenQA.Selenium.IWebElement]$Element,
[Parameter()]
[Switch]$JavaScriptClick,
[Parameter()]
$Driver
)
if($JavaScriptClick) {
$Driver.ExecuteScript("arguments[0].click()", $Element)
}
else {
$Element.Click()
}
}
function Send-SeClick {
[alias('SeClick')]
param(
[Parameter(Mandatory = $true, ValueFromPipeline = $true,Position=0)]
[OpenQA.Selenium.IWebElement]$Element,
[Alias('JS')]
[Switch]$JavaScriptClick,
$SleepSeconds = 0 ,
[Parameter(DontShow)]
$Driver,
[Alias('PT')]
[switch]$PassThru
)
Process {
if($JavaScriptClick) { $Element.WrappedDriver.ExecuteScript("arguments[0].click()", $Element) }
else { $Element.Click() }
if($SleepSeconds) { Start-Sleep -Seconds $SleepSeconds}
if($PassThru) { $Element}
}
}
function Get-SeKeys {
[OpenQA.Selenium.Keys] | Get-Member -MemberType Property -Static | Select-Object -Property Name, @{N = "ObjectString"; E = { "[OpenQA.Selenium.Keys]::$($_.Name)" } }
}
function Send-SeKeys {
param(
[Parameter(Mandatory=$true,Position=0,ValueFromPipeline=$true)]
[OpenQA.Selenium.IWebElement]$Element,
[Parameter(Mandatory=$true,Position=1)]
[string]$Keys
)
foreach ($Key in $Script:SeKeys.Name) {
$Keys = $Keys -replace "{{$Key}}", [OpenQA.Selenium.Keys]::$Key
}
$Element.SendKeys($Keys)
}
function Get-SeCookie {
param(
[Alias("Driver")]
[ValidateIsWebDriverAttribute()]
$Target = $Global:SeDriver
)
$Target.Manage().Cookies.AllCookies.GetEnumerator()
}
function Remove-SeCookie {
param(
$Driver,
[switch]$DeleteAllCookies,
[string]$Name
)
if($DeleteAllCookies){
$Driver.Manage().Cookies.DeleteAllCookies()
}
else{
$Driver.Manage().Cookies.DeleteCookieNamed($Name)
}
}
function Set-SeCookie {
[cmdletbinding()]
param(
[string]$Name,
[string]$Value,
[string]$Path,
[string]$Domain,
$ExpiryDate,
[Alias("Driver")]
[ValidateIsWebDriverAttribute()]
$Target = $Global:SeDriver
)
<# Selenium Cookie Information
Cookie(String, String)
Initializes a new instance of the Cookie class with a specific name and value.
Cookie(String, String, String)
Initializes a new instance of the Cookie class with a specific name, value, and path.
Cookie(String, String, String, Nullable<DateTime>)
Initializes a new instance of the Cookie class with a specific name, value, path and expiration date.
Cookie(String, String, String, String, Nullable<DateTime>)
Initializes a new instance of the Cookie class with a specific name, value, domain, path and expiration date.
#>
begin {
if($null -ne $ExpiryDate -and $ExpiryDate.GetType().Name -ne 'DateTime'){
throw '$ExpiryDate can only be $null or TypeName: System.DateTime'
}
}
process {
if($Name -and $Value -and (!$Path -and !$Domain -and !$ExpiryDate)){
$cookie = New-Object -TypeName OpenQA.Selenium.Cookie -ArgumentList $Name,$Value
}
Elseif($Name -and $Value -and $Path -and (!$Domain -and !$ExpiryDate)){
$cookie = New-Object -TypeName OpenQA.Selenium.Cookie -ArgumentList $Name,$Value,$Path
}
Elseif($Name -and $Value -and $Path -and $ExpiryDate -and !$Domain){
$cookie = New-Object -TypeName OpenQA.Selenium.Cookie -ArgumentList $Name,$Value,$Path,$ExpiryDate
}
Elseif($Name -and $Value -and $Path -and $Domain -and (!$ExpiryDate -or $ExpiryDate)){
if($Driver.Url -match $Domain){
$cookie = New-Object -TypeName OpenQA.Selenium.Cookie -ArgumentList $Name,$Value,$Domain,$Path,$ExpiryDate
}
else{
Throw 'In order to set the cookie the browser needs to be on the cookie domain URL'
}
}
else{
Throw "Incorrect Cookie Layout:
Cookie(String, String)
Initializes a new instance of the Cookie class with a specific name and value.
Cookie(String, String, String)
Initializes a new instance of the Cookie class with a specific name, value, and path.
Cookie(String, String, String, Nullable<DateTime>)
Initializes a new instance of the Cookie class with a specific name, value, path and expiration date.
Cookie(String, String, String, String, Nullable<DateTime>)
Initializes a new instance of the Cookie class with a specific name, value, domain, path and expiration date."
}
$Driver.Manage().Cookies.AddCookie($cookie)
}
}
function Get-SeElementAttribute {
param(
[Parameter(ValueFromPipeline = $true, Mandatory = $true)]
[OpenQA.Selenium.IWebElement]$Element,
[Parameter(Mandatory = $true)]
[string]$Attribute
)
process {
$Element.GetAttribute($Attribute)
}
}
function Invoke-SeScreenshot {
param(
[Alias("Driver")]
[ValidateIsWebDriverAttribute()]
$Target = $Global:SeDriver,
[Switch]$AsBase64EncodedString
)
$Screenshot = [OpenQA.Selenium.Support.Extensions.WebDriverExtensions]::TakeScreenshot($Target)
if($AsBase64EncodedString) {
$Screenshot.AsBase64EncodedString
}
else {