File size: 8,512 Bytes
8c763fb | 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 | # Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.
$powershell = Join-Path -Path $PSHOME -ChildPath "pwsh"
function Wait-JobPid {
param (
$Job
)
# This is to prevent hanging in the test.
# Some test environments (such as raspberry_pi) require more time for background job to run.
$startTime = [DateTime]::Now
$TimeoutInMilliseconds = 60000
# This will receive the pid of the Job process and nothing more since that was the only thing written to the pipeline.
do {
Start-Sleep -Seconds 1
$pwshId = Receive-Job $Job
if (([DateTime]::Now - $startTime).TotalMilliseconds -gt $timeoutInMilliseconds) {
throw "Unable to receive PowerShell process id."
}
} while (!$pwshId)
$pwshId
}
# Executes the Enter/Exit PSHostProcess script that returns the pid of the process that's started.
function Invoke-PSHostProcessScript {
param (
[string] $ArgumentString,
[int] $Id,
[int] $Retry = 5 # Default retry of 5 times
)
$commandStr = @'
Enter-PSHostProcess {0} -ErrorAction Stop
$PID
Exit-PSHostProcess
'@ -f $ArgumentString
$result = $false
foreach ($i in 1..$Retry) {
# use $i as an incrementally growing pause based on the attempt number
# so that it's more likely to succeed.
Start-Sleep -Seconds $i
$result = ($commandStr | & $powershell -noprofile -c -) -eq $Id
if ($result) {
break
}
}
if ($i -gt 1) {
Write-Verbose -Verbose "Enter-PSHostProcess script failed $i out of $Retry times."
}
$result
}
Describe "Enter-PSHostProcess tests" -Tag Feature {
Context "By Process Id" {
BeforeAll {
$oldColor = $env:NO_COLOR
$env:NO_COLOR = 1
}
AfterAll {
$env:NO_COLOR = $oldColor
}
BeforeEach {
# Start a normal job where the first thing it does is return $PID. After that, spin forever.
# We will use this job as the target process for Enter-PSHostProcess
$pwshJob = Start-Job {
$PID
while ($true) {
Start-Sleep -Seconds 30 | Out-Null
}
}
$pwshId = Wait-JobPid $pwshJob
}
AfterEach {
$pwshJob | Stop-Job -PassThru | Remove-Job
}
It "Can enter, exit, and re-enter another PSHost" {
Wait-UntilTrue { [bool](Get-PSHostProcessInfo -Id $pwshId) } | Should -BeTrue
# This will enter and exit another process
Invoke-PSHostProcessScript -ArgumentString "-Id $pwshId" -Id $pwshId |
Should -BeTrue -Because "The script was able to enter another process and grab the pid of '$pwshId'"
# Re-enter and exit the other process
Invoke-PSHostProcessScript -ArgumentString "-Id $pwshId" -Id $pwshId |
Should -BeTrue -Because "The script was able to re-enter another process and grab the pid of '$pwshId'."
}
It "Can enter, exit, and re-enter another Windows PowerShell PSHost" -Skip:(!$IsWindows) {
# Start a PowerShell job where the first thing it does is return $PID. After that, spin forever.
# We will use this job as the target process for Enter-PSHostProcess
$powershellJob = Start-Job -PSVersion 5.1 {
$PID
while ($true) {
Start-Sleep -Seconds 30 | Out-Null
}
}
$powershellId = Wait-JobPid $powershellJob
try {
Wait-UntilTrue { [bool](Get-PSHostProcessInfo -Id $powershellId) } | Should -BeTrue
# This will enter and exit another process
Invoke-PSHostProcessScript -ArgumentString "-Id $powershellId" -Id $powershellId |
Should -BeTrue -Because "The script was able to enter another process and grab the pid of '$powershellId'."
# Re-enter and exit the other process
Invoke-PSHostProcessScript -ArgumentString "-Id $powershellId" -Id $powershellId |
Should -BeTrue -Because "The script was able to re-enter another process and grab the pid of '$powershellId'."
} finally {
$powershellJob | Stop-Job -PassThru | Remove-Job
}
}
It "Can enter using NamedPipeConnectionInfo" {
try {
Wait-UntilTrue { [bool](Get-PSHostProcessInfo -Id $pwshId) } | Should -BeTrue
$npInfo = [System.Management.Automation.Runspaces.NamedPipeConnectionInfo]::new($pwshId)
$rs = [runspacefactory]::CreateRunspace($npInfo)
# Try to open the runspace while tracing.
$splat = @{
Name = "RunspaceInit"
Expression = {$Input.Open()}
PSHost = $true
ListenerOption = [System.Diagnostics.TraceOptions]::Callstack
FilePath = "$TestDrive/$([System.IO.Path]::GetRandomFileName()).log"
InputObject = $rs
}
Trace-Command @splat
# If opening the runspace fails, then print out the trace with the callstack
Wait-UntilTrue { $rs.RunspaceStateInfo.State -eq [System.Management.Automation.Runspaces.RunspaceState]::Opened } |
Should -BeTrue -Because (Get-Content $splat.FilePath -Raw)
$ps = [powershell]::Create()
$ps.Runspace = $rs
$ps.AddScript('$PID')
[int]$retry = 0
$result = $null
$errorMsg = "Exception: "
while ($retry -lt 5 -and $result -eq $null) {
try {
$result = $ps.Invoke()
}
catch [System.Management.Automation.Runspaces.InvalidRunspaceStateException] {
$errorMsg += $_.Exception.InnerException.Message + "; "
$retry++
Start-Sleep -Milliseconds 100
}
}
$result | Should -Be $pwshId -Because $errorMsg
} finally {
# Clean up disposables
if ($rs) {
$rs.Dispose()
}
if ($ps) {
$ps.Dispose()
}
}
}
}
Context "By CustomPipeName" {
BeforeAll {
$oldColor = $env:NO_COLOR
$env:NO_COLOR = 1
}
AfterAll {
$env:NO_COLOR = $oldColor
}
It "Can enter, exit, and re-enter using CustomPipeName" {
$pipeName = [System.IO.Path]::GetRandomFileName()
$pipePath = Get-PipePath -PipeName $pipeName
# Start a job where the first thing it does is set the custom pipe name, then return $PID.
# After that, spin forever.
# We will use this job as the target process for Enter-PSHostProcess
$pwshJob = Start-Job -ArgumentList $pipeName {
[System.Management.Automation.Remoting.RemoteSessionNamedPipeServer]::CreateCustomNamedPipeServer($args[0])
$PID
while ($true) { Start-Sleep -Seconds 30 | Out-Null }
}
$pwshId = Wait-JobPid $pwshJob
try {
Wait-UntilTrue { Test-Path $pipePath } | Should -BeTrue
# This will enter and exit another process
Invoke-PSHostProcessScript -ArgumentString "-CustomPipeName $pipeName" -Id $pwshId |
Should -BeTrue -Because "The script was able to enter another process and grab the pipe of '$pipeName'."
# Re-enter and exit the other process
Invoke-PSHostProcessScript -ArgumentString "-CustomPipeName $pipeName" -Id $pwshId |
Should -BeTrue -Because "The script was able to re-enter another process and grab the pipe of '$pipeName'."
} finally {
$pwshJob | Stop-Job -PassThru | Remove-Job
}
}
It "Should throw if CustomPipeName does not exist" {
{ Enter-PSHostProcess -CustomPipeName badpipename } | Should -Throw -ExpectedMessage "No named pipe was found with CustomPipeName: badpipename."
}
}
}
|