Merge pull request #35 from the-mentor/master

Version Bump to 2.0 and Enchanced Start-SeFirefox with many new features

Author: adamdriscoll

Diff for: Examples/A-Simple-Google-Search.ps1

@@ -40,7 +40,7 @@ if($Driver){
 
     # The $AllInputElements contains all the input elements on the page if we want to find the specific element for the google search box we will need to loop through each input element in the $AllInputElements array and get the attibute we want in this case we're looking for the title attribute.
     # And we only want to return the element that has a title equal to Search we can find this out based on the html code on the page.
-    $SearchBoxElement = $AllInputElements|%{if($_.GetAttribute('title') -eq 'Search'){return $_}}
+    $SearchBoxElement = $AllInputElements|ForEach-Object{if($_.GetAttribute('title') -eq 'Search'){return $_}}
 
     # Now for the fun part after finding the element we want to send keyboard input to it. this will allow us to automate the search process
     # We can get the list of all special keyboard keys like enter/backspace etc using the Get-SeKeys command
@@ -51,15 +51,15 @@ if($Driver){
     # You can send special key strokes to the SearchBoxElement, you should use the Selenium Keys enum. For example, if we wanted to send an enter key stroke, you could do it like this
     Send-SeKeys -Element $SearchBoxElement -Keys ([OpenQA.Selenium.Keys]::Enter)
 
-    # When working with dynamic websites, it’s often necessary to wait awhile for elements to appear on the page. By default, Selenium won’t wait and you’ll receive $null from Find-SeElement because the element isn’t there yet. There are a couple ways to work around this.
-    # The first is to use the Wait-SeElementExists cmdlet to wait for the existence of an element in the document.
-    # The Wait-SeElementExists will also return the element once it is found so you can use in order to wait and then find elements on the page.
+    # When working with dynamic websites, it's often necessary to wait awhile for elements to appear on the page. By default, Selenium won't wait and you'll receive $null from Find-SeElement because the element isn�t there yet. There are a couple ways to work around this.
+    # The first is to use the Find-SeElement cmdlet with the -Wait switch to wait for the existence of an element in the document.
+    # When using the Find-SeElement with the -Wait please take into account that only 1 element can be returned unlike the without the -Wait switch where multiple elements can be returned.
 
     # This command will wait for the img elements for 10 seconds and then return it to you or time out if the element wasn't found on.
-    $ImageElements = Wait-SeElementExists -Driver $Driver -TagName 'img' -Timeout 10
-
+    $LogoImageElement = Find-SeElement -Driver $Driver -Wait -Timeout 10 -Id 'logo'
+    
     # Once we have the image element we can simulate a mouse click on it using the Invoke-SeClick command.
-    Invoke-SeClick -Driver $Driver -Element $ImageElements
+    Invoke-SeClick -Driver $Driver -Element $LogoImageElement
 
     # Once we are done with the web driver and we finished with all our testing/automation we can release the driver by running the Stop-SeDriver command.
     Stop-SeDriver -Driver $Driver

Diff for: Selenium.psd1

@@ -12,7 +12,7 @@
 RootModule = '.\Selenium.psm1'
 
 # Version number of this module.
-ModuleVersion = '1.4.0'
+ModuleVersion = '2.0.0'
 
 # Supported PSEditions
 # CompatiblePSEditions = @()

Diff for: Selenium.psm1

@@ -44,7 +44,7 @@ function Start-SeChrome {
     )
 
     BEGIN{
-        if($Maximized -ne $false -and $Minimized -ne $false) {
+        if($Maximized -ne $false -and $Minimized -ne $false){
             throw 'Maximized and Minimized may not be specified together.'
         }
         elseif($Maximized -ne $false -and $Fullscreen -ne $false){
@@ -76,29 +76,29 @@ function Start-SeChrome {
             $Chrome_Options.AddUserProfilePreference('plugins', @{'always_open_pdf_externally' =  $true;})
         }
 
-        if ($Headless) {
+        if($Headless){
             $Chrome_Options.AddArguments('headless')
         }
 
-        if ($Incognito) {
+        if($Incognito){
             $Chrome_Options.AddArguments('Incognito')
         }
 
-        if ($Maximized) {
+        if($Maximized){
             $Chrome_Options.AddArguments('start-maximized')
         }
 
-        if ($Fullscreen) {
+        if($Fullscreen){
             $Chrome_Options.AddArguments('start-fullscreen')
         }
 
-        if ($Arguments) {
+        if($Arguments){
             foreach ($Argument in $Arguments){
                 $Chrome_Options.AddArguments($Argument)
             }
         }
 
-        if (!$HideVersionHint) {
+        if(!$HideVersionHint){
             Write-Verbose "Download the right chromedriver from 'http://chromedriver.chromium.org/downloads'"
         }
 
@@ -109,20 +109,18 @@ function Start-SeChrome {
             $Driver = New-Object -TypeName "OpenQA.Selenium.Chrome.ChromeDriver" -ArgumentList $Chrome_Options 
         }
 
-        if($Minimized){
+        if($Minimized -and $Driver){
             $driver.Manage().Window.Minimize();
-
         }
 
-        if($Headless -and $DefaultDownloadPath) {
+        if($Headless -and $DefaultDownloadPath -and $Driver){
             $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){
+        if($StartURL -and $Driver){
             Enter-SeUrl -Driver $Driver -Url $StartURL
         }
     }
@@ -142,30 +140,87 @@ function Start-SeEdge {
 }
 
 function Start-SeFirefox {
-    param([Switch]$Profile)
+    param(
+        [array]$Arguments,
+        [string]$StartURL,
+        [System.IO.FileInfo]$DefaultDownloadPath,
+        [switch]$Headless,
+        [switch]$PrivateBrowsing,
+        [switch]$Maximized,
+        [switch]$Minimized,
+        [switch]$Fullscreen
+    )
 
-    if ($Profile) {
-        #Doesn't work....
-        $ProfilePath = Join-Path $PSScriptRoot "Assets\ff-profile\rust_mozprofile.YwpEBLY3hCRX"
-        $firefoxProfile = New-Object OpenQA.Selenium.Firefox.FirefoxProfile -ArgumentList ($ProfilePath)
-        $firefoxProfile.WriteToDisk()
-        if($IsLinux -or $IsMacOS){
-            New-Object -TypeName "OpenQA.Selenium.Firefox.FirefoxDriver" -ArgumentList $AssembliesPath,$firefoxProfile
+    BEGIN{
+        if($Maximized -ne $false -and $Minimized -ne $false){
+            throw 'Maximized and Minimized may not be specified together.'
         }
-        else{
-            New-Object -TypeName "OpenQA.Selenium.Firefox.FirefoxDriver" -ArgumentList $firefoxProfile
+        elseif($Maximized -ne $false -and $Fullscreen -ne $false){
+            throw 'Maximized and Fullscreen may not be specified together.'
+        }
+        elseif($Minimized -ne $false -and $Fullscreen -ne $false){
+            throw 'Minimized and Fullscreen may not be specified together.'
+        }
+
+        if($StartURL){
+            if(![system.uri]::IsWellFormedUriString($StartURL,[System.UriKind]::Absolute)){
+                throw 'Incorrect StartURL please make sure the URL starts with http:// or https://'
+            }
         }
     }
-    else {
+    PROCESS{
+        $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($IsLinux -or $IsMacOS){
-            $Driver = New-Object -TypeName "OpenQA.Selenium.Firefox.FirefoxDriver" -ArgumentList $AssembliesPath
+            $Driver = New-Object -TypeName "OpenQA.Selenium.Firefox.FirefoxDriver" -ArgumentList $AssembliesPath,$Firefox_Options
         }
         else{
-            $Driver = New-Object -TypeName "OpenQA.Selenium.Firefox.FirefoxDriver"
+            $Driver = New-Object -TypeName "OpenQA.Selenium.Firefox.FirefoxDriver" -ArgumentList $Firefox_Options
         }
+
+        if($Driver){
+            $Driver.Manage().Timeouts().ImplicitWait = [TimeSpan]::FromSeconds(10)
+        }
+
+        if($Minimized -and $Driver){
+            $Driver.Manage().Window.Minimize()
+        }
+
+        if($Maximized -and $Driver){
+            $Driver.Manage().Window.Maximize()
+        }
+
+        if($Fullscreen -and $Driver){
+            $Driver.Manage().Window.FullScreen()
+        }
+
+        if($StartURL -and $Driver){
+            Enter-SeUrl -Driver $Driver -Url $StartURL
+        }
+    }
+    END{
+        return $Driver
     }
-    $Driver.Manage().Timeouts().ImplicitWait = [TimeSpan]::FromSeconds(10)
-    $Driver
 }
 
 function Stop-SeDriver {

Diff for: Selenium.tests.ps1

@@ -15,25 +15,25 @@ Describe "Verify the Binaries SHA256 Hash" {
 
     It "Check ChromeDriver.exe Hash" {
         # The ChromeDriver.exe was extracted from https://chromedriver.storage.googleapis.com/76.0.3809.68/chromedriver_win32.zip its VirusTotal Scan URL - https://www.virustotal.com/gui/url/69ffe387a3fa4fbf8a108391580f1a0befb8b96b82486da4417cfcdab4add4d4/detection
-        # VirusTotal Scan URL = https://www.virustotal.com/gui/file/66cfa645f83fde41720beac7061a559fd57b6f5caa83d7918f44de0f4dd27845/detection
+        # VirusTotal Scan URL = https://www.virustotal.com/gui/file/297e5f1be088a60b0fbfd67bf6b6e9d3aff4acbe228cddd77642a9e270cb4c30/detection
         $Hash = (Get-FileHash -Algorithm SHA256 -Path $PSScriptRoot\assemblies\chromedriver.exe).Hash
         $Hash |Should Be (Get-Content -Path $PSScriptRoot\assemblies\chromedriver.exe.sha256)
     }
 
     It "Check ChromeDriver Linux Hash" {
-        # VirusTotal Scan URL = https://www.virustotal.com/gui/file/3da69344b8b2b3b7e1497378672231a179eed6b3a0fdccbfacd3d053612e2547/detection
+        # VirusTotal Scan URL = https://www.virustotal.com/gui/file/da1ff4d52963446f679b2175fc05af020fd4e02b92b7b3447ed51fab8f4f4d28/detection
         $Hash = (Get-FileHash -Algorithm SHA256 -Path $PSScriptRoot\assemblies\linux\chromedriver).Hash
         $Hash |Should Be (Get-Content -Path $PSScriptRoot\assemblies\linux\chromedriver.sha256)
     }
 
     It "Check ChromeDriver MacOS Hash" {
-        # VirusTotal Scan URL = https://www.virustotal.com/gui/file/57097bb65200f003152906c831ccd226ebbd5a9fd47df46f18adc29f7d01f2f0/detection
+        # VirusTotal Scan URL = https://www.virustotal.com/gui/file/e19d7c2806adaea658c3f5465da0231c090e354d1339d1544a9f92501964a471/detection
         $Hash = (Get-FileHash -Algorithm SHA256 -Path $PSScriptRoot\assemblies\macos\chromedriver).Hash
         $Hash |Should Be (Get-Content -Path $PSScriptRoot\assemblies\macos\chromedriver.sha256)
     }
 
     It "Check GeckoDriver.exe Hash" {
-        # VirusTotal Scan URL = https://www.virustotal.com/gui/file/1ae81b2a6f40f7d11be3c91c4d83977ae0c0897bd5d154c02a6d869b58866b58/detection
+        # VirusTotal Scan URL = https://www.virustotal.com/gui/file/3104a5ba26ff22962d0d75536506c081939bcd7580ba16503d4f3ce5507d06d2/detection
         $Hash = (Get-FileHash -Algorithm SHA256 -Path $PSScriptRoot\assemblies\geckodriver.exe).Hash
         $Hash |Should Be (Get-Content -Path $PSScriptRoot\assemblies\geckodriver.exe.sha256)
     }
@@ -72,11 +72,21 @@ Describe "Start-SeChrome" {
 
 Describe "Start-SeChrome with Options" {
     Context "Should Start Chrome Driver with different startup options" {
+        It "Start Chrome with StartURL" {
+            $Driver = Start-SeChrome -StartURL 'https://github.com/adamdriscoll/selenium-powershell'
+            Stop-SeDriver $Driver
+        }
+
         It "Start Chrome in Headless mode" {
             $Driver = Start-SeChrome -Headless
             Stop-SeDriver $Driver
         }
 
+        It "Start Chrome Minimize" {
+            $Driver = Start-SeChrome -Minimize
+            Stop-SeDriver $Driver
+        }
+
         It "Start Chrome Maximized" {
             $Driver = Start-SeChrome -Maximized
             Stop-SeDriver $Driver
@@ -99,6 +109,7 @@ Describe "Start-SeChrome with Options" {
 
         It "Start Chrome with Multiple arguments" {
             $Driver = Start-SeChrome -Arguments @('Incognito','start-maximized')
+            Stop-SeDriver $Driver
         }
     }
 }
@@ -110,6 +121,50 @@ Describe "Start-SeFirefox"{
     }
 }
 
+Describe "Start-SeFirefox with Options" {
+    Context "Should Start Firefox Driver with different startup options" {
+        It "Start Firefox with StartURL" {
+            $Driver = Start-SeFirefox -StartURL 'https://github.com/adamdriscoll/selenium-powershell'
+            Stop-SeDriver $Driver
+        }
+
+        It "Start Firefox in Headless mode" {
+            $Driver = Start-SeFirefox -Headless
+            Stop-SeDriver $Driver
+        }
+
+        It "Start Firefox Minimize" {
+            $Driver = Start-SeFirefox -Minimize
+            Stop-SeDriver $Driver
+        }
+
+        It "Start Firefox Maximized" {
+            $Driver = Start-SeFirefox -Maximized
+            Stop-SeDriver $Driver
+        }
+
+        It "Start Firefox PrivateBrowsing (Incognito)" {
+            $Driver = Start-SeFirefox -PrivateBrowsing
+            Stop-SeDriver $Driver
+        }
+        
+        It "Start Firefox Fullscreen" {
+            $Driver = Start-SeFirefox -Fullscreen
+            Stop-SeDriver $Driver
+        }
+
+        It "Start Firefox Maximized and PrivateBrowsing (Incognito)" {
+            $Driver = Start-SeFirefox -Maximized -PrivateBrowsing
+            Stop-SeDriver $Driver
+        }
+
+        It "Start Firefox with Multiple arguments" {
+            $Driver = Start-SeFirefox -Arguments @('-headless','-private')
+            Stop-SeDriver $Driver
+        }
+    }
+}
+
 Describe "Start-SeEdge" {
     Context "Should Start Edge Driver" {
         if(!$IsLinux -and !$IsMacOS){

Diff for: assemblies/chromedriver.exe

@@ -1 +1 @@
-66CFA645F83FDE41720BEAC7061A559FD57B6F5CAA83D7918F44DE0F4DD27845
+297E5F1BE088A60B0FBFD67BF6B6E9D3AFF4ACBE228CDDD77642A9E270CB4C30

Diff for: assemblies/chromedriver.exe.sha256

@@ -1 +1 @@
-1AE81B2A6F40F7D11BE3C91C4D83977AE0C0897BD5D154C02A6D869B58866B58
+3104A5BA26FF22962D0D75536506C081939BCD7580BA16503D4F3CE5507D06D2

Diff for: assemblies/geckodriver.exe

@@ -1 +1 @@
-3DA69344B8B2B3B7E1497378672231A179EED6B3A0FDCCBFACD3D053612E2547
+DA1FF4D52963446F679B2175FC05AF020FD4E02B92B7B3447ED51FAB8F4F4D28

Diff for: assemblies/geckodriver.exe.sha256

@@ -1 +1 @@
-57097BB65200F003152906C831CCD226EBBD5A9FD47DF46F18ADC29F7D01F2F0
+E19D7C2806ADAEA658C3F5465DA0231C090E354D1339D1544A9F92501964A471