Features/v4 optmize driver get stop #179 (#180)

itfranck · web-flow · commit d9615fc24085 · 2020-10-12T06:40:40.000-04:00
#179 Driver checking performance improvement.
diff --git a/Examples/Combined.tests.ps1 b/Examples/Combined.tests.ps1
@@ -218,7 +218,9 @@ Describe "'Headless' mode browser test" {
                 $Processes = Get-CimInstance -Class Win32_Process
                 $DriverProcess = $Processes | Where { $_.Name -like '*driver.exe' -and $_.ParentProcessId -eq $Pid }
                 $BrowserProcess = $Processes | Where-Object { $_.ParentProcessId -eq $DriverProcess.ProcessId -and $_.Name -ne 'conhost.exe' }
-                (Get-process -Id $BrowserProcess.ProcessId).MainWindowHandle   | Should      -be 0
+                if ($BrowserProcess -ne $null) {
+                    (Get-process -Id $BrowserProcess.ProcessId).MainWindowHandle   | Should      -be 0
+                }
             }
             else {
                 $DriverProcess = Get-Process *driver | Where-Object { $_.Parent.id -eq $pid }
diff --git a/Examples/_TestDependencies.ps1 b/Examples/_TestDependencies.ps1
@@ -1,6 +1,6 @@
 
 Function Get-DefaultParams() {
-    if ($null -eq $Global:DefaultBrowser) { $Global:DefaultBrowser = 'Chrome' }
+    if ($null -eq $Global:DefaultBrowser) { $Global:DefaultBrowser = 'Firefox' }
     if ($null -eq $env:SITE_URL) { $env:SITE_URL = 'http://tailspin-spacegame-web.azurewebsites.net' }
     if ($null -eq $Global:HeadlessOnly) { $Global:HeadlessOnly = $False }
 }
diff --git a/Help/Get-SeDriver.md b/Help/Get-SeDriver.md
@@ -12,7 +12,12 @@ Get the list of all active drivers.
 
 ## SYNTAX
 
-### Current (Default)
+### All (Default)
+```
+Get-SeDriver [<CommonParameters>]
+```
+
+### Current
 ```
 Get-SeDriver [-Current] [<CommonParameters>]
 ```
diff --git a/Internal/Get-DriverProcessId.ps1 b/Internal/Get-DriverProcessId.ps1
@@ -0,0 +1,18 @@
+function Get-DriverProcessId {
+    [CmdletBinding()]
+    param (
+        $ServiceProcessId
+    )
+
+    $IsWindowsPowershell = $PSVersionTable.PSVersion.Major -lt 6
+
+    if ($IsWindowsPowershell) {
+        $Processes = Get-CimInstance -Class Win32_Process -Filter "ParentProcessId=$ServiceProcessId"
+        $BrowserProcess = $Processes.Where( { $_.Name -ne 'conhost.exe' }, 'first').ProcessId
+    }
+    else {
+        $BrowserProcess = (Get-Process).Where( { { $_.Parent.id -eq $ServiceProcessId -and $_.Name -ne 'conhost' } }, 'first').Id
+    }
+    return $BrowserProcess
+
+}
diff --git a/Internal/Start-SeChromeDriver.ps1 b/Internal/Start-SeChromeDriver.ps1
@@ -98,7 +98,7 @@ function Start-SeChromeDriver {
         
         $Driver = [OpenQA.Selenium.Chrome.ChromeDriver]::new($service, $Options)
         if (-not $Driver) { Write-Warning "Web driver was not created"; return }
-
+        Add-Member -InputObject $Driver -MemberType NoteProperty -Name 'SeServiceProcessId' -Value $Service.ProcessID
         #region post creation options
         $Driver.Manage().Timeouts().ImplicitWait = [TimeSpan]::FromMilliseconds($ImplicitWait * 1000)
 
diff --git a/Internal/Start-SeEdgeDriver.ps1 b/Internal/Start-SeEdgeDriver.ps1
@@ -84,6 +84,7 @@ function Start-SeEdgeDriver {
         Write-Warning "Web driver was not created"; return
     }
     else {
+        Add-Member -InputObject $Driver -MemberType NoteProperty -Name 'SeServiceProcessId' -Value $Service.ProcessID
         $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"
diff --git a/Internal/Start-SeFirefoxDriver.ps1 b/Internal/Start-SeFirefoxDriver.ps1
@@ -54,7 +54,7 @@ function Start-SeFirefoxDriver {
 
         $Driver = [OpenQA.Selenium.Firefox.FirefoxDriver]::new($service, $Firefox_Options)
         if (-not $Driver) { Write-Warning "Web driver was not created"; return }
-
+        Add-Member -InputObject $Driver -MemberType NoteProperty -Name 'SeServiceProcessId' -Value $Service.ProcessID
         #region post creation options
         $Driver.Manage().Timeouts().ImplicitWait = [TimeSpan]::FromMilliseconds($ImplicitWait * 1000)
 
diff --git a/Internal/Start-SeInternetExplorerDriver.ps1 b/Internal/Start-SeInternetExplorerDriver.ps1
@@ -37,7 +37,7 @@ function Start-SeInternetExplorerDriver {
 
     $Driver = [OpenQA.Selenium.IE.InternetExplorerDriver]::new($service, $InternetExplorer_Options)
     if (-not $Driver) { Write-Warning "Web driver was not created"; return }
-
+    Add-Member -InputObject $Driver -MemberType NoteProperty -Name 'SeServiceProcessId' -Value $Service.ProcessID
     if ($PSBoundParameters.ContainsKey('LogLevel')) {
         Write-Warning "LogLevel parameter is not implemented for $($Options.SeParams.Browser)"
     }
diff --git a/Internal/Start-SeMSEdgeDriver.ps1 b/Internal/Start-SeMSEdgeDriver.ps1
@@ -45,7 +45,7 @@ function Start-SeMSEdgeDriver {
         throw $_ ; return
     }
     if (-not $Driver) { Write-Warning "Web driver was not created"; return }
-
+    Add-Member -InputObject $Driver -MemberType NoteProperty -Name 'SeServiceProcessId' -Value $Service.ProcessID
     #region post creation options
     if ($PSBoundParameters.ContainsKey('Size')) { $Driver.Manage().Window.Size = $Size }
     if ($PSBoundParameters.ContainsKey('Position')) { $Driver.Manage().Window.Position = $Position }
diff --git a/Output/Selenium/Examples/Combined.tests.ps1 b/Output/Selenium/Examples/Combined.tests.ps1
@@ -218,7 +218,9 @@ Describe "'Headless' mode browser test" {
                 $Processes = Get-CimInstance -Class Win32_Process
                 $DriverProcess = $Processes | Where { $_.Name -like '*driver.exe' -and $_.ParentProcessId -eq $Pid }
                 $BrowserProcess = $Processes | Where-Object { $_.ParentProcessId -eq $DriverProcess.ProcessId -and $_.Name -ne 'conhost.exe' }
-                (Get-process -Id $BrowserProcess.ProcessId).MainWindowHandle   | Should      -be 0
+                if ($BrowserProcess -ne $null) {
+                    (Get-process -Id $BrowserProcess.ProcessId).MainWindowHandle   | Should      -be 0
+                }
             }
             else {
                 $DriverProcess = Get-Process *driver | Where-Object { $_.Parent.id -eq $pid }
diff --git a/Output/Selenium/Examples/_TestDependencies.ps1 b/Output/Selenium/Examples/_TestDependencies.ps1
@@ -1,6 +1,6 @@
 
 Function Get-DefaultParams() {
-    if ($null -eq $Global:DefaultBrowser) { $Global:DefaultBrowser = 'Chrome' }
+    if ($null -eq $Global:DefaultBrowser) { $Global:DefaultBrowser = 'Firefox' }
     if ($null -eq $env:SITE_URL) { $env:SITE_URL = 'http://tailspin-spacegame-web.azurewebsites.net' }
     if ($null -eq $Global:HeadlessOnly) { $Global:HeadlessOnly = $False }
 }
diff --git a/Output/Selenium/Selenium.psm1 b/Output/Selenium/Selenium.psm1
diff --git a/Public/Get-SeDriver.ps1 b/Public/Get-SeDriver.ps1
@@ -1,5 +1,6 @@
+
 function Get-SeDriver {
-    [cmdletbinding(DefaultParameterSetName = 'Current')]
+    [cmdletbinding(DefaultParameterSetName = 'All')]
     param(
         [parameter(ParameterSetName = 'Current', Mandatory = $false)]
         [Switch]$Current,
@@ -9,25 +10,41 @@ function Get-SeDriver {
         [ArgumentCompleter( { [Enum]::GetNames([SeBrowsers]) })]
         [ValidateScript( { $_ -in [Enum]::GetNames([SeBrowsers]) })]
         $Browser
-        
-        
-    
+          
+          
+      
     )
-    
-
-    if ($Script:SeDrivers.count -eq 0) { return $null }
-    if ($Current) { return $Script:SeDriversCurrent }
-
 
-    if ($PSBoundParameters.ContainsKey('Browser')) { 
-        return $Script:SeDrivers.Where( { $_.SeBrowser -like "$Browser*" } )
-    }
-    
-    if ($PSBoundParameters.ContainsKey('Name')) { 
-        return $Script:SeDrivers.Where( { $_.SeFriendlyName -eq $Name }, 'first' )
+    $Output = $null
+    switch ($PSCmdlet.ParameterSetName) {
+        'All' { $Output = $Script:SeDrivers; break }
+        'Current' { $Output = $Script:SeDriversCurrent; break }
+        'ByName' { $Output = $Script:SeDrivers.Where( { $_.SeFriendlyName -eq $Name }, 'first' ); break }
+        'ByBrowser' { $Output = $Script:SeDrivers.Where( { $_.SeBrowser -like "$Browser*" }); break }
     }
 
-    return $Script:SeDrivers
+    if ($null -eq $Output) { return }
+    
+    $DriversToClose = [System.Collections.Generic.List[PSObject]]::new()
+    Foreach ($drv in $Output) {
+        $Processes = (Get-Process -Id $Drv.SeProcessId, $Drv.SeServiceProcessId -ErrorAction SilentlyContinue )
+        if ($Processes.count -eq 2) { Continue }
 
-}
+        if ($Processes.count -eq 0) {
+            Write-Warning -Message "The driver $($Drv.SeFriendlyName) $($Drv.SeBrowser) processes are not running anymore and have been removed automatically from the list of available drivers."
+        }
+        else { 
+            $ProcessType = if ($Processes.id -eq $Drv.SeServiceProcessId) { "driver service" } else { "browser" }
+            Write-Warning -Message "The driver $($Drv.SeFriendlyName) $($Drv.SeBrowser) $ProcessType is not running anymore and will be removed from the active driver list."
+        }
+        $DriversToClose.Add($Drv)
+    }
 
+    if ($DriversToClose.Count -gt 0) { 
+        foreach ($drv in $DriversToClose) {
+            $Output = $Output.Where( { $_.SeServiceProcessId -ne $drv.SeServiceProcessId })
+            Stop-SeDriver -Driver $drv
+        }
+    }
+    return $Output
+}
diff --git a/Public/SeShouldHave.ps1 b/Public/SeShouldHave.ps1
@@ -91,31 +91,32 @@ function SeShouldHave {
         $foundElements = [System.Collections.Generic.List[PSObject]]::new()
     }
     process {
+        $Driver = (Get-SeDriver -Current)
         #If we have been asked to check URL or title get them from the driver. Otherwise call Get-SEElement.
         if ($URL) {
             do {
-                $Success = applyTest -testitems $Script:SeDriversCurrent.Url -operator $Operator -value $Value
+                $Success = applyTest -testitems $Driver.Url -operator $Operator -value $Value
                 Start-Sleep -Milliseconds 500
             }
             until ($Success -or [datetime]::now -gt $endTime)
             if (-not $Success) {
-                throw (expandErr "PageURL was $($Script:SeDriversCurrent.Url). The comparison '-$operator $value' failed.")
+                throw (expandErr "PageURL was $($Driver.Url). The comparison '-$operator $value' failed.")
             }
         }
         elseif ($Title) {
             do {
-                $Success = applyTest -testitems $Script:SeDriversCurrent.Title -operator $Operator -value $Value
+                $Success = applyTest -testitems $Driver.Title -operator $Operator -value $Value
                 Start-Sleep -Milliseconds 500
             }
             until ($Success -or [datetime]::now -gt $endTime)
             if (-not $Success) {
-                throw (expandErr "Page title was $($Script:SeDriversCurrent.Title). The comparison '-$operator $value' failed.")
+                throw (expandErr "Page title was $($Driver.Title). The comparison '-$operator $value' failed.")
             }
         }
         elseif ($Alert -or $NoAlert) {
             do {
                 try {
-                    $a = $Script:SeDriversCurrent.SwitchTo().alert()
+                    $a = $Driver.SwitchTo().alert()
                     $Success = $true
                 }
                 catch {
diff --git a/Public/Start-SeDriver.ps1 b/Public/Start-SeDriver.ps1
@@ -124,7 +124,7 @@ function Start-SeDriver {
             Add-Member @mp -Name 'SeBrowser' -Value "$SelectedBrowser$($Headless)"
             Add-Member @mp -Name 'SeFriendlyName' -Value "$FriendlyName"  
             Add-Member @mp -Name 'SeSelectedElements' -Value $null
-
+            Add-Member -InputObject $Driver -MemberType NoteProperty -Name 'SeProcessId' -Value (Get-DriverProcessId -ServiceProcessId $Driver.SeServiceProcessId)
 
             $Script:SeDrivers.Add($Driver)
             Return Switch-SeDriver -Name $FriendlyName
diff --git a/Public/Stop-SeDriver.ps1 b/Public/Stop-SeDriver.ps1
@@ -7,39 +7,35 @@ function Stop-SeDriver {
     )
     Begin {
         $ElementsToRemove = [System.Collections.Generic.List[PSObject]]::new()
-        $TextInfo = (Get-Culture).TextInfo 
     }
     Process {
         if (! $PSBoundParameters.ContainsKey('Driver')) {
-            $Driver = $script:SeDriversCurrent
+            $Driver = Get-SeDriver -Current
         }
 
-
+        
         if ($null -ne $Driver) {
-            $BrowserName = $TextInfo.ToTitleCase($Driver.Capabilities.browsername)
+            $Processes = (Get-Process -Id $Driver.SeProcessId, $Driver.SeServiceProcessId -ErrorAction SilentlyContinue )
 
-            if ($null -eq $Driver.SessionId) {
-                Write-Warning "$BrowserName Driver already closed"
-                if ($ElementsToRemove.contains($Driver)) { $ElementsToRemove.Add($Driver) }
-                
+            switch ($Processes.Count) {
+                2 {
+                    Write-Verbose -Message "Closing $BrowserName $($Driver.SeFriendlyName )..."
+                    $Driver.Close()
+                    $Driver.Dispose() 
+                    break
+                }
+                1 { Stop-Process -Id $Processes.Id -ErrorAction SilentlyContinue }
             }
-            else {
-                Write-Verbose -Message "Closing $BrowserName $($Driver.SeFriendlyName )..."
-            
-                $Driver.Close()
-                $Driver.Dispose()
-                $ElementsToRemove.Add($Driver)    
-            }
-
-            
-      
-       
+            $ElementsToRemove.Add($Driver)   
         }
-        
+               
     }
     End {
         $ElementsToRemove | ForEach-Object { [void]($script:SeDrivers.Remove($_)) }
-        $script:SeDriversCurrent = $null
+        if ($script:SeDriversCurrent -notin $script:SeDrivers) {
+            $script:SeDriversCurrent = $null
+        }
+        
     }
     
 

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`
`2`	`2`	`Function Get-DefaultParams() {`
`3`		`- if ($null -eq $Global:DefaultBrowser) { $Global:DefaultBrowser = 'Chrome' }`
	`3`	`+ if ($null -eq $Global:DefaultBrowser) { $Global:DefaultBrowser = 'Firefox' }`
`4`	`4`	`if ($null -eq $env:SITE_URL) { $env:SITE_URL = 'http://tailspin-spacegame-web.azurewebsites.net' }`
`5`	`5`	`if ($null -eq $Global:HeadlessOnly) { $Global:HeadlessOnly = $False }`
`6`	`6`	`}`
Original file line number	Diff line number	Diff line change
`@@ -84,6 +84,7 @@ function Start-SeEdgeDriver {`
`84`	`84`	`Write-Warning "Web driver was not created"; return`
`85`	`85`	`}`
`86`	`86`	`else {`
	`87`	`+ Add-Member -InputObject $Driver -MemberType NoteProperty -Name 'SeServiceProcessId' -Value $Service.ProcessID`
`87`	`88`	`$driverversion = $Driver.Capabilities.ToDictionary().msedge.msedgedriverVersion -replace '^([\d.]+).*$', '$1'`
`88`	`89`	`if (-not $driverversion) { $driverversion = $driver.Capabilities.ToDictionary().chrome.chromedriverVersion -replace '^([\d.]+).*$', '$1' }`
`89`	`90`	`Write-Verbose "Web Driver version $driverversion"`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ function Start-SeInternetExplorerDriver {`
`37`	`37`
`38`	`38`	`$Driver = [OpenQA.Selenium.IE.InternetExplorerDriver]::new($service, $InternetExplorer_Options)`
`39`	`39`	`if (-not $Driver) { Write-Warning "Web driver was not created"; return }`
`40`		`-`
	`40`	`+ Add-Member -InputObject $Driver -MemberType NoteProperty -Name 'SeServiceProcessId' -Value $Service.ProcessID`
`41`	`41`	`if ($PSBoundParameters.ContainsKey('LogLevel')) {`
`42`	`42`	`Write-Warning "LogLevel parameter is not implemented for $($Options.SeParams.Browser)"`
`43`	`43`	`}`
Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ function Start-SeMSEdgeDriver {`
`45`	`45`	`throw $_ ; return`
`46`	`46`	`}`
`47`	`47`	`if (-not $Driver) { Write-Warning "Web driver was not created"; return }`
`48`		`-`
	`48`	`+ Add-Member -InputObject $Driver -MemberType NoteProperty -Name 'SeServiceProcessId' -Value $Service.ProcessID`
`49`	`49`	`#region post creation options`
`50`	`50`	`if ($PSBoundParameters.ContainsKey('Size')) { $Driver.Manage().Window.Size = $Size }`
`51`	`51`	`if ($PSBoundParameters.ContainsKey('Position')) { $Driver.Manage().Window.Position = $Position }`