File size: 17,802 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 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 | # Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.
Describe 'Basic Job Tests' -Tags 'Feature' {
BeforeAll {
# Make sure we do not have any jobs running
Get-Job | Remove-Job -Force
$timeBeforeStartedJob = Get-Date
$startedJob = Start-Job -Name 'StartedJob' -Scriptblock { 1 + 1 } | Wait-Job
$timeAfterStartedJob = Get-Date
function script:ValidateJobInfo($job, $state, $hasMoreData, $command)
{
$job.State | Should -BeExactly $state
$job.HasMoreData | Should -Be $hasMoreData
if($command -ne $null)
{
$job.Command | Should -BeExactly $command
}
}
}
AfterAll {
$startedJob | Remove-Job -Force -ErrorAction SilentlyContinue
}
Context 'Basic tests' {
BeforeAll {
$invalidPathTestCases = @(
@{ path = "This is an invalid path"; case = "invalid path"; errorId = "DirectoryNotFoundException,Microsoft.PowerShell.Commands.StartJobCommand"}
@{ path = ""; case = "empty string"; errorId = "ParameterArgumentValidationError,Microsoft.PowerShell.Commands.StartJobCommand"}
@{ path = " "; case = "whitespace string (single space)"; errorId = "ParameterArgumentValidationError,Microsoft.PowerShell.Commands.StartJobCommand"}
)
}
AfterEach {
Get-Job | Where-Object { $_.Id -ne $startedJob.Id } | Remove-Job -ErrorAction SilentlyContinue -Force
}
It 'Can start, wait and receive a Job' {
$job = Start-Job -ScriptBlock { 1 + 1 }
$result = $job | Wait-Job | Receive-Job
ValidateJobInfo -job $job -state 'Completed' -hasMoreData $false -command ' 1 + 1 '
$result | Should -Be 2
}
It 'Can run nested jobs' {
$job = Start-Job -ScriptBlock { Start-Job -ScriptBlock { 1 + 1 } | Wait-Job | Receive-Job }
ValidateJobInfo -job $job -state 'Running' -hasMoreData $true -command ' Start-Job -ScriptBlock { 1 + 1 } | Wait-Job | Receive-Job '
$result = $job | Wait-Job | Receive-Job
$result | Should -Be 2
}
It 'Can get errors messages from job' {
$job = Start-Job -ScriptBlock { throw 'MyError' } | Wait-Job
Receive-Job -Job $job -ErrorVariable ev -ErrorAction SilentlyContinue
$ev[0].Exception.Message | Should -BeExactly 'MyError'
}
It 'Can get warning messages from job' {
$job = Start-Job -ScriptBlock { Write-Warning 'MyWarning' } | Wait-Job
Receive-Job -Job $job -WarningVariable wv -WarningAction SilentlyContinue
$wv | Should -BeExactly 'MyWarning'
}
It 'Can get verbose message from job' {
$job = Start-Job -ScriptBlock { Write-Verbose -Verbose 'MyVerbose' } | Wait-Job
$VerboseMsg = $job.ChildJobs[0].verbose.readall()
$VerboseMsg | Should -BeExactly 'MyVerbose'
}
It 'Can get progress message from job' {
$job = Start-Job -ScriptBlock { Write-Progress -Activity 1 -Status 2 } | Wait-Job
$ProgressMsg = $job.ChildJobs[0].progress.readall()
$ProgressMsg[0].Activity | Should -BeExactly 1
$ProgressMsg[0].StatusDescription | Should -BeExactly 2
}
It 'Can use the user specified working directory parameter with whitespace' {
$path = Join-Path -Path $TestDrive -ChildPath "My Dir"
$null = New-Item -ItemType Directory -Path "$path"
$job = Start-Job -ScriptBlock { $PWD } -WorkingDirectory $path | Wait-Job
$jobOutput = Receive-Job $job
$jobOutput | Should -BeExactly $path.ToString()
}
It 'Can specify the working directory with a PSPath' {
try {
Push-Location 'Temp:\'
$job = Start-Job -ScriptBlock { $PWD } -WorkingDirectory $pwd.Path | Wait-Job
$jobOutput = Receive-Job $job
$jobOutput | Should -BeExactly $pwd.Path
} finally {
Pop-Location
}
}
It 'Can use the user specified working directory parameter with quote' -Skip:($IsWindows) {
$path = Join-Path -Path $TestDrive -ChildPath "My ""Dir"
$null = New-Item -ItemType Directory -Path "$path"
$job = Start-Job -ScriptBlock { $PWD } -WorkingDirectory $path | Wait-Job
$jobOutput = Receive-Job $job
$jobOutput | Should -BeExactly $path.ToString()
}
It 'Verifies the working directory parameter path with trailing backslash' -Skip:(! $IsWindows) {
$job = Start-Job { $PWD } -WorkingDirectory '\' | Wait-Job
$job.JobStateInfo.State | Should -BeExactly 'Completed'
}
It 'Throws an error when the working directory parameter is <case>' -TestCases $invalidPathTestCases {
param($path, $case, $errorId)
{Start-Job -ScriptBlock { 1 + 1 } -WorkingDirectory $path} | Should -Throw -ErrorId $errorId
}
It 'Verifies that the current working directory is preserved' {
$job = Start-Job -ScriptBlock { $PWD }
$location = $job | Wait-Job | Receive-Job
$job | Remove-Job
$location.Path | Should -BeExactly $PWD.Path
}
It "Create job with native command" {
try {
$nativeJob = Start-Job { & "$PSHOME/pwsh" -c 1+1 }
$nativeJob | Wait-Job
$nativeJob.State | Should -BeExactly "Completed"
$nativeJob.HasMoreData | Should -BeTrue
Receive-Job $nativeJob | Should -BeExactly 2
Remove-Job $nativeJob
{ Get-Job $nativeJob -ErrorAction Stop } | Should -Throw -ErrorId "JobWithSpecifiedNameNotFound,Microsoft.PowerShell.Commands.GetJobCommand"
}
finally {
Remove-Job $nativeJob -Force -ErrorAction SilentlyContinue
}
}
}
Context 'Wait-Job tests' {
BeforeAll {
$waitJobTestCases = @(
@{ parameters = @{ Name = $startedJob.Name } ; property = '-Name'},
@{ parameters = @{ Id = $startedJob.Id } ; property = '-Id'},
@{ parameters = @{ Job = $startedJob } ; property = '-Job'},
@{ parameters = @{ InstanceId = $startedJob.InstanceId } ; property = '-InstanceId'},
@{ parameters = @{ State = $startedJob.State } ; property = '-State'}
)
}
AfterEach {
Get-Job | Where-Object { $_.Id -ne $startedJob.Id } | Remove-Job -ErrorAction SilentlyContinue -Force
}
It 'Can wait for jobs to complete using <property>' -TestCases $waitJobTestCases {
param($parameters)
$job = Wait-Job @parameters
ValidateJobInfo -job $job -state 'Completed' -hasMoreData $true -command ' 1 + 1 '
}
It 'Can wait for any job to complete' {
$jobs = 1..3 | ForEach-Object { $seconds = $_ ; Start-Job -ScriptBlock { Start-Sleep -Seconds $using:seconds ; $using:seconds} }
$waitedJob = Wait-Job -Job $jobs -Any
ValidateJobInfo -job $waitedJob -state 'Completed' -hasMoreData $true -command ' Start-Sleep -Seconds $using:seconds ; $using:seconds'
$result = $waitedJob | Receive-Job
## We check for $result to be less than 4 so that any of the jobs completing first will considered a success.
$result | Should -BeLessThan 4
## Check none of the jobs threw errors.
$jobs.Error | Should -BeNullOrEmpty
}
It 'Can timeout waiting for a job' {
$job = Start-Job -ScriptBlock { Start-Sleep -Seconds 10 }
$job | Wait-Job -TimeoutSec 1
ValidateJobInfo -job $job -state 'Running' -hasMoreData $true -command ' Start-Sleep -Seconds 10 '
}
}
Context 'Receive-job tests' {
It 'Can Receive-Job with state change events' {
$result = Start-Job -Name 'ReceiveWriteEventsJob' -ScriptBlock { 1 + 1 } | Receive-Job -Wait -WriteEvents
$result.Count | Should -Be 3
$result[0] | Should -Be 2
$result[1].GetType().FullName | Should -BeExactly 'System.Management.Automation.JobStateEventArgs'
}
It 'Can Receive-Job with job object and result' {
$result = Start-Job -ScriptBlock { 1 + 1 } | Receive-Job -Wait -WriteJobInResults
$result.Count | Should -Be 2
ValidateJobInfo -job $result[0] -command ' 1 + 1 ' -state 'Completed' -hasMoreData $false
$result[1] | Should -Be 2
$result[0] | Remove-Job -Force -ErrorAction SilentlyContinue
}
It 'Can Receive-Job and autoremove' {
$result = Start-Job -Name 'ReceiveJobAutoRemove' -ScriptBlock { 1 + 1 } | Receive-Job -Wait -AutoRemoveJob
$result | Should -Be 2
{ Get-Job -Name 'ReceiveJobAutoRemove' -ErrorAction Stop } | Should -Throw -ErrorId 'JobWithSpecifiedNameNotFound,Microsoft.PowerShell.Commands.GetJobCommand'
}
It 'Can Receive-Job and keep results' {
$job = Start-Job -ScriptBlock { 1 + 1 } | Wait-Job
$result = Receive-Job -Keep -Job $job
$result | Should -Be 2
$result2 = Receive-Job -Job $job
$result2 | Should -Be 2
$result3 = Receive-Job -Job $job
$result3 | Should -BeNullOrEmpty
$job | Remove-Job -Force -ErrorAction SilentlyContinue
}
It 'Can Receive-Job with NoRecurse' {
$job = Start-Job -ScriptBlock { 1 + 1 }
$result = Receive-Job -Wait -NoRecurse -Job $job
$result | Should -BeNullOrEmpty
$job | Remove-Job -Force -ErrorAction SilentlyContinue
}
It 'Can Receive-Job using ComputerName' {
$jobName = 'ReceiveUsingComputerName'
$job = Start-Job -ScriptBlock { 1 + 1 } -Name $jobName | Wait-Job
$result = Receive-Job -ComputerName localhost -Job $job
$result | Should -Be 2
$job | Remove-Job -Force -ErrorAction SilentlyContinue
}
It 'Can Receive-Job using Location' {
$jobName = 'ReceiveUsingLocation'
$job = Start-Job -ScriptBlock { 1 + 1 } -Name $jobName | Wait-Job
$result = Receive-Job -Location localhost -Job $job
$result | Should -Be 2
$job | Remove-Job -Force -ErrorAction SilentlyContinue
}
It 'Can receive a job with -wait switch' {
$job = Start-Job -ScriptBlock { 1 + 1 }
$result = $job | Receive-Job -Wait
ValidateJobInfo -job $job -state 'Completed' -hasMoreData $false -command ' 1 + 1 '
$result | Should -Be 2
}
}
Context 'Get-Job tests' {
BeforeAll {
$getJobTestCases = @(
@{ parameters = @{ Name = $startedJob.Name } ; property = 'Name'},
@{ parameters = @{ Id = $startedJob.Id } ; property = 'Id'},
@{ parameters = @{ InstanceId = $startedJob.InstanceId } ; property = 'InstanceId'},
@{ parameters = @{ State = $startedJob.State } ; property = 'State'}
)
$getJobSwitches = @(
@{ parameters = @{ Before = $timeAfterStartedJob }; property = '-Before'},
@{ parameters = @{ After = $timeBeforeStartedJob }; property = '-After'},
@{ parameters = @{ HasMoreData = $true }; property = '-HasMoreData'}
)
$getJobChildJobs = @(
@{ parameters = @{ IncludeChildJob = $true }; property = '-IncludeChildJob'},
@{ parameters = @{ ChildJobState = 'Completed' }; property = '-ChildJobState'}
)
}
AfterEach {
Get-Job | Where-Object { $_.Id -ne $startedJob.Id } | Remove-Job -ErrorAction SilentlyContinue -Force
}
It 'Can Get-Job with <property>' -TestCases $getJobTestCases {
param($parameters)
$job = Get-Job @parameters
ValidateJobInfo -job $job -state 'Completed' -hasMoreData $true -command ' 1 + 1 '
}
It 'Can Get-Job with <property>' -TestCases $getJobSwitches {
param($parameters)
$job = Get-Job @parameters
ValidateJobInfo -job $job -state 'Completed' -hasMoreData $true -Name 'StartedJob'
}
It 'Can Get-Job with <property>' -TestCases $getJobChildJobs {
param($parameters)
$jobs = Get-Job @parameters
$jobs.Count | Should -Be 2
ValidateJobInfo -job $jobs[0] -state 'Completed' -hasMoreData $true -Name 'StartedJob'
ValidateJobInfo -job $jobs[1] -state 'Completed' -hasMoreData $true
}
}
Context 'Remove-Job tests' {
# The test pattern used here is different from other tests since there is a scoping issue in Pester.
# If BeforeEach is used then $removeJobTestCases does not bind when the It is called.
# This implementation works around the problem by using a BeforeAll and creating a job inside the It.
BeforeAll {
$removeJobTestCases = @(
@{ property = 'Name'}
@{ property = 'Id'}
@{ property = 'InstanceId'}
@{ property = 'State'}
)
}
It 'Can Remove-Job with <property>' -TestCases $removeJobTestCases {
param($property)
$jobToRemove = Start-Job -ScriptBlock { 1 + 1 } -Name 'JobToRemove' | Wait-Job
$splat = @{ $property = $jobToRemove.$property }
Remove-Job @splat
Get-Job $jobToRemove -ErrorAction SilentlyContinue | Should -BeNullOrEmpty
}
}
Context 'Stop-Job tests' {
# The test pattern used here is different from other tests since there is a scoping issue in Pester.
# If BeforeEach is used then $stopJobTestCases does not bind when the It is called.
# This implementation works around the problem by using a BeforeAll and creating a job inside the It.
BeforeAll {
$stopJobTestCases = @(
@{ property = 'Name'}
@{ property = 'Id'}
@{ property = 'InstanceId'}
@{ property = 'State'}
)
}
BeforeEach {
# 20 seconds is chosen to be large, so that the job is in running state when Stop-Job is called.
$jobToStop = Start-Job -Scriptblock {
1..80 | ForEach-Object {
Write-Output $_
Start-Sleep -Milliseconds 250
}
} -Name 'JobToStop'
# Wait until the job is actually running and executing the script
do {
$data = Receive-Job -Job $jobToStop
} while (($data.Count -eq 0) -and ($jobToStop.State -eq 'Running'))
}
AfterEach {
Remove-Job $jobToStop -Force -ErrorAction SilentlyContinue
}
It 'Can Stop-Job with <property>' -TestCases $stopJobTestCases {
param($property)
$splat = @{ $property = $jobToStop.$property }
Stop-Job @splat
ValidateJobInfo -job $jobToStop -state 'Stopped' -hasMoreData $false
}
}
Context 'Background pwsh process should terminate after job is done' {
It "Can clean up background pwsh process after job is done" {
$job = Start-Job { $pid }
$processId = Receive-Job $job -Wait
try {
$process = Get-Process -Id $processId -ErrorAction Stop
Wait-UntilTrue { $process.HasExited } -IntervalInMilliseconds 300 | Should -BeTrue
} catch {
$_.FullyQualifiedErrorId | Should -BeExactly 'NoProcessFoundForGivenId,Microsoft.PowerShell.Commands.GetProcessCommand'
}
Remove-Job $job -Force
}
It "Can clean up background pwsh process when job is stopped" {
$job = Start-Job { $pid; Start-Sleep -Second 10 }
# Wait for the pid to be received.
Wait-UntilTrue { [bool](Receive-Job $job -Keep) } | Should -BeTrue
$processId = Receive-Job $job
# Stop the job and wait for the cleanup to finish.
Stop-Job $job
try {
$process = Get-Process -Id $processId -ErrorAction Stop
Wait-UntilTrue { $process.HasExited } -IntervalInMilliseconds 300 | Should -BeTrue
} catch {
$_.FullyQualifiedErrorId | Should -BeExactly 'NoProcessFoundForGivenId,Microsoft.PowerShell.Commands.GetProcessCommand'
}
Remove-Job $job -Force
}
It "Can clean up background pwsh process when job is removed" {
$job = Start-Job { $pid; Start-Sleep -Second 10 }
# Wait for the pid to be received.
Wait-UntilTrue { [bool](Receive-Job $job -Keep) } | Should -BeTrue
$processId = Receive-Job $job
# Remove the job and wait for the cleanup to finish.
Remove-Job $job -Force
try {
$process = Get-Process -Id $processId -ErrorAction Stop
Wait-UntilTrue { $process.HasExited } -IntervalInMilliseconds 300 | Should -BeTrue
} catch {
$_.FullyQualifiedErrorId | Should -BeExactly 'NoProcessFoundForGivenId,Microsoft.PowerShell.Commands.GetProcessCommand'
}
}
}
}
|