Codestin Search App

PaulHigin · 2018-06-25T18:32:04Z

PR Summary

This adds the ThreadJob module package from the PSGallery, along with Pester tests

PR Checklist

SteveL-MSFT

LGTM

anmenaga · 2018-06-25T20:55:45Z

test/powershell/Modules/ThreadJob/ThreadJob.Tests.ps1

+        $results | Should Be "Hello There 60"
+    }
+
+    It 'ThreadJob with terminating error' {


What about a test for non-terminating error?
... and, in general, tests for verifying that objects in all PS streams (Verbose, Debug, Error, ...) are returned correctly from ThreadJobs.

This is not intended to be an exhaustive list of job tests, but I have added data stream tests.

anmenaga · 2018-06-25T21:12:32Z

test/powershell/Modules/ThreadJob/ThreadJob.Tests.ps1

+        {
+            # Start four thread jobs with ThrottleLimit set to two
+            Get-Job | where PSJobTypeName -eq "ThreadJob" | Remove-Job -Force
+            Start-ThreadJob -ScriptBlock { Start-Sleep -Seconds 60 } -ThrottleLimit 2


This is not related to review; but for my education:
The ThrottleLimit syntax looks interesting; couple of questions:

What is the scope of ThrottleLimit ? e.g. "all threadjobs in current script" ?

How do subsequent Start-ThreadJob's in the script know under what ThrottleLimit they operate?

Throttle limit is per PowerShell session so it limits all concurrent threadjobs created in that session. The queue is static (singleton). I currently don't have a way to get the current throttle limit value ... you just set it. But something like that can be added.

See source code for more details:
https://github.com/PaulHigin/PSThreadJob/blob/master/ThreadJob/ThreadJob/PSThreadJob.cs#L18

anmenaga · 2018-06-25T21:17:23Z

test/powershell/Modules/ThreadJob/ThreadJob.Tests.ps1

+    }
+}
+
+Describe 'Job2 Tests' -Tags 'CI' {


I would rename the Describe to "Job2 class API tests" or something like this.
For an unfamiliar person it is not clear what 'Job2' is.

adityapatwardhan · 2018-06-25T22:07:59Z

test/powershell/Modules/ThreadJob/ThreadJob.Tests.ps1

+
+        $job = Start-ThreadJob -ScriptBlock { "Hello" }
+        $results = $job | Receive-Job -Wait
+        $results | Should be "Hello"


Can we use Pester 4 syntax?

$results | Should -Be "Hello"

The build only pulls in Pester 3.3.9 right now which does not support this syntax. We should wait to update tests until the default pester version supports the new syntax.

adityapatwardhan · 2018-06-25T22:11:16Z

test/powershell/Modules/ThreadJob/ThreadJob.Tests.ps1

+
+    It 'ThreadJob with terminating error' {
+
+        $job = Start-ThreadJob -ScriptBlock { throw "MyError!" }


Can we also add a test for a non-terminating error where some objects are returned and 1 non-terminating error is returned?

This is outside the scope of this change. Please create an Issue for adding more threadjob tests.

adityapatwardhan · 2018-06-25T22:12:13Z

test/powershell/Modules/ThreadJob/ThreadJob.Tests.ps1

+
+    It 'Verifies terminating job error' {
+
+        $job = Start-ThreadJob -ScriptBlock { throw "My Job Error!" } | Wait-Job


Is this test same as https://github.com/PowerShell/PowerShell/pull/7169/files#diff-74d73c8bffa8cd97ca36a864c1dc71bbR172

It is a slightly different test since it involves Receive-Job, so I'd like to keep it.

adityapatwardhan · 2018-06-25T22:13:08Z

test/powershell/Modules/ThreadJob/ThreadJob.Tests.ps1

+            $job3 | Remove-Job -Force
+
+            (Get-Runspace).Count | Should Be ($rsStartCount + 2)
+


extra empty line

Thanks, but will keep for readability.

adityapatwardhan · 2018-06-25T22:13:22Z

test/powershell/Modules/ThreadJob/ThreadJob.Tests.ps1

+Describe 'Job2 Tests' -Tags 'CI' {
+
+    AfterEach {
+


extra empty line

Thanks, but will keep for readability.

adityapatwardhan · 2018-06-25T22:14:02Z

test/powershell/Modules/ThreadJob/ThreadJob.Tests.ps1

+    }
+
+    AfterEach {
+


extra empty line

Thanks, but will keep for readability.

TravisEz13 · 2018-06-26T18:32:43Z

@adityapatwardhan can you update your review?

BrucePay · 2018-06-26T22:23:04Z

test/powershell/Modules/ThreadJob/ThreadJob.Tests.ps1

+
+    It 'ThreadJob with ScriptBlock and Initialization script' {
+
+        $job = Start-ThreadJob -ScriptBlock { "Goodbye" } -InitializationScript { "Hello" }


Can this actually take a script (i.e. a path to a script) or just a scriptblock. If only takes a scriptblock, then the parameter should probably be named "-InitializationScriptBlock".

Good point. It just takes a scriptblock. But I used the same parameter name as what Start-Job uses, which also just takes a scriptblock. So for consistency we should probably keep the parameter name as is (or change both).

I was just thinking of consistency between -ScriptBlock and -InitialScriptBlock. But following what existing commands do is probably fine.

PaulHigin · 2018-06-27T20:52:44Z

@TravisEz13 I just found a bug in this version of ThreadJob. Please hold off merging until I have a fix ready. Thanks.

TravisEz13 · 2018-06-27T22:47:52Z

@PaulHigin to prevent maintainers from merging, rename your PR with WIP in front of the title. remove WIP to unblock. This will fail the Work In Progress (WIP), CI test immediately.

PaulHigin · 2018-06-29T22:35:48Z

I have fixed the bug, updated tests, and updated the package with the new version. Please take a look.

PaulHigin · 2018-07-02T18:04:47Z

@adityapatwardhan Can you please review changes?

adityapatwardhan · 2018-07-02T18:23:17Z

test/powershell/Modules/ThreadJob/ThreadJob.Tests.ps1

+
+        # Get-Job -Filter is not supported
+        $result = Get-Job -Filter @{Id = ($job.Id)} 3>$null
+        $result | Should -Be $null


This should be Should -BeNullOrEmpty

TravisEz13 · 2018-07-06T00:07:15Z

assets/files.wxs

                </Directory>
                <Directory Id="dir37EBACBC570E49108415C3BA316EB66D" Name="ThreadJob">
-                    <Directory Id="dirCB93DAC4CEB64A8583295B9AC4A79883" Name="1.1.0">
+                    <Directory Id="dirCB93DAC4CEB64A8583295B9AC4A79883" Name="1.1.1">


Not an issue for this PR. We should consider not putting the modules in a version folder. If we have to update the modules, this will make patching very difficult.

Filed #7236

Added ThreadJob module package and tests

514a749

PaulHigin requested review from TravisEz13, adityapatwardhan, anmenaga and daxian-dbw as code owners June 25, 2018 18:32

PaulHigin requested review from SteveL-MSFT and removed request for TravisEz13, adityapatwardhan, anmenaga and daxian-dbw June 25, 2018 18:32

PaulHigin assigned TravisEz13 Jun 25, 2018

PaulHigin added the WG-Engine core PowerShell engine, interpreter, and runtime label Jun 25, 2018

PaulHigin added this to the 6.1.0-Consider milestone Jun 25, 2018

TravisEz13 approved these changes Jun 25, 2018

View reviewed changes

SteveL-MSFT approved these changes Jun 25, 2018

View reviewed changes

anmenaga suggested changes Jun 25, 2018

View reviewed changes

adityapatwardhan requested changes Jun 25, 2018

View reviewed changes

Changes per CR comments

f2c3cfc

anmenaga approved these changes Jun 26, 2018

View reviewed changes

BrucePay approved these changes Jun 26, 2018

View reviewed changes

TravisEz13 changed the title ~~Add ThreadJob module package and tests~~ WIP Add ThreadJob module package and tests Jun 27, 2018

PaulHigin changed the title ~~WIP Add ThreadJob module package and tests~~ Add ThreadJob module package and tests Jun 29, 2018

[Feature] Added CL support and tests

452f4fa

SteveL-MSFT approved these changes Jun 29, 2018

View reviewed changes

[Feature] Fixed package path with correct version

8eb19a7

adityapatwardhan requested changes Jul 2, 2018

View reviewed changes

[Feature] Fixed test per CR

1a2ad89

adityapatwardhan approved these changes Jul 2, 2018

View reviewed changes

TravisEz13 reviewed Jul 6, 2018

View reviewed changes

TravisEz13 approved these changes Jul 6, 2018

View reviewed changes

TravisEz13 merged commit a57fafe into PowerShell:master Jul 6, 2018

PaulHigin deleted the add-threadjob-module branch July 9, 2018 15:16

HumanEquivalentUnit mentioned this pull request Apr 6, 2019

Is it time for "PowerShell vZeroTechnicalDebt" ("vNext") and/or for an opt-in mechanism into new/fixed features that break backward compatibility? #6745

Closed


		It 'ThreadJob with terminating error' {

		$job = Start-ThreadJob -ScriptBlock { throw "MyError!" }


		It 'Verifies terminating job error' {

		$job = Start-ThreadJob -ScriptBlock { throw "My Job Error!" } \| Wait-Job

		$job3 \| Remove-Job -Force

		(Get-Runspace).Count \| Should Be ($rsStartCount + 2)


		It 'ThreadJob with ScriptBlock and Initialization script' {

		$job = Start-ThreadJob -ScriptBlock { "Goodbye" } -InitializationScript { "Hello" }

Conversation

PaulHigin commented Jun 25, 2018

PR Summary

PR Checklist

Uh oh!

SteveL-MSFT left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

TravisEz13 commented Jun 26, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

PaulHigin commented Jun 27, 2018

Uh oh!

TravisEz13 commented Jun 27, 2018

Uh oh!

PaulHigin commented Jun 29, 2018

Uh oh!

PaulHigin commented Jul 2, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants