Skip to content

Provide additional tests for the *-Job cmdlets #3110

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
daxian-dbw merged 1 commit into from
Feb 22, 2017
Merged

Provide additional tests for the *-Job cmdlets #3110

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
150 changes: 121 additions & 29 deletions test/powershell/Modules/Microsoft.PowerShell.Core/Job.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,49 +1,141 @@
Import-Module $PSScriptRoot\..\..\Common\Test.Helpers.psm1
Describe "Job Cmdlet Tests" -Tag "CI" {
Context "Simple Jobs" {
AfterEach {
Get-Job | Remove-Job -force
}
BeforeEach {
$j = start-job -scriptblock { 1 + 1 }
$j = Start-Job -ScriptBlock { 1 + 1 } -Name "My Job"
}
AfterEach {
Get-Job | Remove-Job -Force
}
It "Start-Job produces a job object" {
Copy link
Member

@daxian-dbw daxian-dbw Feb 8, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

   It "Start-Job produces a job object" {
       $j.gettype().fullname | should be "System.Management.Automation.PSRemotingJob"
    }
  It "Start-Job can name the job" {
       $j = Start-Job -ScriptBlock {6 * 7} -Name "My Job"
       $j.Name | should be "My Job"
   }
  It "Get-Job retrieves a job object" {
       (Get-Job -id $j.id).gettype().fullname | should be "System.Management.Automation.PSRemotingJob"
   }

This may not strictly relevant, but for the 3 simple tests above, it seems too heavy to run start-job -scriptblock { 1 + 1 }, which essentially starts a process, before each test. Can we change the BeforeEach to

        BeforeEach {
            $j = start-job -scriptblock { 1 + 1 } -Name "My Job"
        }

and group those 3 tests into one?

Copy link
Contributor Author

@jeffbi jeffbi Feb 8, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can certainly ad the -Name parameter in the BeforeEach block and merge the first two test together. Personally, I'd rather keep the Get-Job test separate.

Copy link
Member

@daxian-dbw daxian-dbw Feb 8, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That sounds good too.

Copy link
Contributor Author

@jeffbi jeffbi Feb 14, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

Copy link
Member

@daxian-dbw daxian-dbw Feb 16, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @jeffbi #Closed

$j | Should BeOfType System.Management.Automation.Job
$j | Should BeOfType "System.Management.Automation.Job"
$j.Name | Should Be "My Job"
}
It "Get-Job retrieves a job object" {
(Get-Job -id $j.id) | Should BeOfType System.Management.Automation.Job
(Get-Job -Id $j.Id) | Should BeOfType "System.Management.Automation.Job"
}
It "Remove-Job can remove a job" {
remove-job $j -force
try {
get-job $j -ea Stop
throw "Execution OK"
}
catch {
$_.FullyQualifiedErrorId | should be "JobWithSpecifiedNameNotFound,Microsoft.PowerShell.Commands.GetJobCommand"
It "Get-Job retrieves an array of job objects" {
Start-Job -ScriptBlock { 2 * 2 }
$jobs = Get-Job
$jobs.Count | Should Be 2
foreach ($job in $jobs)
{
$job | Should BeOfType "System.Management.Automation.Job"
}
}
It "Receive-Job can retrieve job results" -pending {
$waitjob = Wait-Job -Timeout 10 -id $j.id
if ( $waitJob ) {
$result = receive-job -id $j.id
$result.id | Should be 2
}
It "Remove-Job can remove a job" {
Remove-Job $j -Force
{ Get-Job $j -ErrorAction Stop } | ShouldBeErrorId "JobWithSpecifiedNameNotFound,Microsoft.PowerShell.Commands.GetJobCommand"
}
It "Receive-Job can retrieve job results" {
Wait-Job -Timeout 60 -id $j.id | Should Not BeNullOrEmpty
receive-job -id $j.id | Should be 2
}
}
Context "Jobs with arguments" {
It "Start-Job accepts arguments" {
$sb = { Write-Output $args[1]; Write-Output $args[0] }
$j = Start-Job -ScriptBlock $sb -ArgumentList "$TestDrive", 42
Wait-job -Timeout (5 * 60) $j | Should Be $j
$r = Receive-Job $j
$r -Join "," | Should Be "42,$TestDrive"
}
}
Context "jobs which take time" {
BeforeEach {
$j = start-job -scriptblock { Start-Sleep 15 }
$j = Start-Job -ScriptBlock { Start-Sleep 15 }
}
AfterEach {
Get-Job | Remove-Job -force
Get-Job | Remove-Job -Force
}
It "Wait-Job will wait for a job" {
$result = wait-Job $j
$result | should be $j
$result = Wait-Job $j
$result | Should Be $j
$j.State | Should Be "Completed"
}
It "Wait-Job will timeout waiting for a job" {
$result = Wait-Job -Timeout 2 $j
$result | Should Be $null
}
It "Stop-Job will stop a job" {
Stop-Job -Id $j.Id
$j.State | Should Be "Stopped"
}
It "Remove-Job will not remove a running job" {
$id = $j.Id
Remove-Job $j -ErrorAction SilentlyContinue
$job = Get-Job -Id $id
$job | Should Be $j
}
It "Remove-Job -Force will remove a running job" {
$id = $j.Id
Remove-Job $j -Force
$job = Get-Job -Id $id -ErrorAction SilentlyContinue
$job | Should Be $null
}
}
Context "Retrieving partial output from jobs" {
BeforeAll {
function GetResults($job, $n, $keep)
{
$results = @()

# $count allows us to bail out after 5 minutes, avoiding an endless loop
for ($count = 0; $results.Count -lt $n; $count++)
{
if ($count -eq 1000)
{
# It's been 5 minutes and we still have collected enough results!
throw "Receive-Job behaves suspiciously: Cannot receive $n results in 5 minutes."
}

# sleep for 300 ms to allow data to be produced
Start-Sleep -Milliseconds 300

if ($keep)
{
$results = Receive-Job -Keep $job
}
else
{
$results += Receive-Job $job
}
}

return $results
}

function CheckContent($array)
{
for ($i=1; $i -lt $array.Count; $i++)
{
if ($array[$i] -ne ($array[$i-1] + 1))
{
return $false
}
}

return $true
}

}
BeforeEach {
$j = Start-Job -ScriptBlock { $count = 1; while ($true) { Write-Output ($count++); Start-Sleep -Milliseconds 30 } }
}
AfterEach {
Get-Job | Remove-Job -Force
}

It "Receive-Job will retrieve partial output" {
$result1 = GetResults $j 5 $false
$result2 = GetResults $j 5 $false
CheckContent ($result1 + $result2) | Should Be $true
}
It "Stop-Job will stop a job" -pending {
Stop-Job -id $j.id
$j.Status |Should be Stopped
It "Receive-Job will retrieve partial output, including -Keep results" {
$result1 = GetResults $j 5 $true
$result2 = GetResults $j ($result1.Count + 5) $false
Compare-Object -SyncWindow 0 -PassThru $result1 $result2[0..($result1.Count-1)] | Should Be $null
$result2[$result1.Count - 1] + 1 | Should Be $result2[$result1.Count]
}
}
}
Expand All @@ -66,10 +158,10 @@ Describe "Debug-job test" -tag "Feature" {
$ps.AddScript('$job = start-job { 1..300 | % { sleep 1 } }').Invoke()
$ps.Commands.Clear()
$ps.Runspace.Debugger.GetCallStack() | Should BeNullOrEmpty
start-sleep 3
Start-Sleep 3
$asyncResult = $ps.AddScript('debug-job $job').BeginInvoke()
$ps.commands.clear()
start-sleep 2
Start-Sleep 2
$result = $ps.runspace.Debugger.GetCallStack()
$result.Command | Should be "<ScriptBlock>"
}
Expand Down