Revise use of Start-Sleep cmdlet (#8633)

xtqqczze · iSazonov · commit 6126624b6325 · 2019-01-15T12:31:52.000+05:00
* Avoid use of sleep alias (follow-up to #8546) * Specify default parameter name * Shorten overly specific comments
diff --git a/test/docker/networktest/DockerRemoting.Tests.ps1 b/test/docker/networktest/DockerRemoting.Tests.ps1
@@ -16,9 +16,9 @@ Describe "Basic remoting test with docker" -tags @("Scenario","Slow"){
 
         # give the containers something to do, otherwise they will exit and be removed
         Write-Verbose -verbose "setting up docker container PowerShell server"
-        $server = docker run -d $imageName powershell -c start-sleep $timeout
+        $server = docker run -d $imageName powershell -c Start-Sleep -Seconds $timeout
         Write-Verbose -verbose "setting up docker container PowerShell client"
-        $client = docker run -d $imageName powershell -c start-sleep $timeout
+        $client = docker run -d $imageName powershell -c Start-Sleep -Seconds $timeout
 
         # get fullpath to installed core powershell
         Write-Verbose -verbose "Getting path to PowerShell core"
diff --git a/test/powershell/Language/Classes/Scripting.Classes.Attributes.Tests.ps1 b/test/powershell/Language/Classes/Scripting.Classes.Attributes.Tests.ps1
@@ -470,7 +470,7 @@ Describe 'ValidateSet support a dynamically generated set' -Tag "CI" {
         It 'Can implement CachedValidValuesGeneratorBase with cache expiration in PowerShell' {
             Get-TestValidateSetPS5 -Param1 "TestString1" -ErrorAction SilentlyContinue | Should -BeExactly "TestString1"
             Get-TestValidateSetPS5 -Param1 "TestString1" -ErrorAction SilentlyContinue | Should -BeExactly "TestString1"
-            Start-Sleep 3
+            Start-Sleep -Seconds 3
             Get-TestValidateSetPS5 -Param1 "TestString2" -ErrorAction SilentlyContinue | Should -BeExactly "TestString2"
         }
     }
diff --git a/test/powershell/Modules/Microsoft.PowerShell.Core/Job.Tests.ps1 b/test/powershell/Modules/Microsoft.PowerShell.Core/Job.Tests.ps1
@@ -44,7 +44,7 @@ Describe "Job Cmdlet Tests" -Tag "CI" {
     }
     Context "jobs which take time" {
         BeforeEach {
-            $j = Start-Job -ScriptBlock { Start-Sleep 15 }
+            $j = Start-Job -ScriptBlock { Start-Sleep -Seconds 15 }
         }
         AfterEach {
             Get-Job | Remove-Job -Force
@@ -93,7 +93,7 @@ Describe "Job Cmdlet Tests" -Tag "CI" {
                         throw "Receive-Job behaves suspiciously: Cannot receive $n results in 5 minutes."
                     }
 
-                    # sleep for 300 ms to allow data to be produced
+                    # Wait to allow data to be produced
                     Start-Sleep -Milliseconds 300
 
                     if ($keep)
diff --git a/test/powershell/Modules/Microsoft.PowerShell.Utility/Implicit.Remoting.Tests.ps1 b/test/powershell/Modules/Microsoft.PowerShell.Utility/Implicit.Remoting.Tests.ps1
@@ -1947,7 +1947,7 @@ try
             Disconnect-PSSession $session
             Start-Process powershell -arg 'Get-PSSession -cn localhost -name Session102 | Connect-PSSession' -Wait
 
-            Start-Sleep 3
+            Start-Sleep -Seconds 3
 
             ## This time a new session is created because the old one is unavailable.
             $dSessionPid = Get-RemoteVariable pid
diff --git a/test/powershell/Modules/Microsoft.PowerShell.Utility/XMLCommand.Tests.ps1 b/test/powershell/Modules/Microsoft.PowerShell.Utility/XMLCommand.Tests.ps1
@@ -56,11 +56,11 @@ Describe "XmlCommand DRT basic functionality Tests" -Tags "CI" {
         $ps = [PowerShell]::Create()
         $null = $ps.AddScript("1..10")
         $null = $ps.AddCommand("foreach-object")
-        $null = $ps.AddParameter("Process", { $_; start-sleep 1 })
+        $null = $ps.AddParameter("Process", { $_; Start-Sleep -Seconds 1 })
         $null = $ps.AddCommand("Export-CliXml")
         $null = $ps.AddParameter("Path", $testfile)
         $null = $ps.BeginInvoke()
-        Start-Sleep 1
+        Start-Sleep -Seconds 1
         $null = $ps.Stop()
         $ps.InvocationStateInfo.State | Should -Be "Stopped"
         $ps.Dispose()
diff --git a/test/tools/Modules/HelpersCommon/HelpersCommon.psm1 b/test/tools/Modules/HelpersCommon/HelpersCommon.psm1
@@ -17,7 +17,7 @@ function Wait-UntilTrue
         if (([DateTime]::Now - $startTime).TotalMilliseconds -gt $timeoutInMilliseconds) {
             return $false
         }
-        # Sleep for the specified interval
+        # Wait
         Start-Sleep -Milliseconds $intervalInMilliseconds
     }
     return $true
diff --git a/test/tools/Modules/HttpListener/HttpListener.psm1 b/test/tools/Modules/HttpListener/HttpListener.psm1
@@ -357,7 +357,7 @@ Function Start-HTTPListener {
                 {
                     # ignore if listener is not ready
                 }
-                Start-Sleep -milliseconds 100
+                Start-Sleep -Milliseconds 100
             }
             if (!$succeeded)
             {
diff --git a/test/tools/Modules/PSSysLog/PSSysLog.psm1 b/test/tools/Modules/PSSysLog/PSSysLog.psm1
@@ -938,7 +938,7 @@ function Wait-UntilSuccess
             }
         }
 
-        # Sleep for the specified interval
+        # Wait
         Start-Sleep -Milliseconds $intervalInMilliseconds
     }
     return $true
@@ -1073,7 +1073,7 @@ function Wait-PSWinEvent
 
     do
     {
-        sleep $pause
+        Start-Sleep -Seconds $pause
 
         $recordsToReturn = @()
 

Original file line number	Diff line number	Diff line change
`@@ -470,7 +470,7 @@ Describe 'ValidateSet support a dynamically generated set' -Tag "CI" {`
`470`	`470`	`It 'Can implement CachedValidValuesGeneratorBase with cache expiration in PowerShell' {`
`471`	`471`	`Get-TestValidateSetPS5 -Param1 "TestString1" -ErrorAction SilentlyContinue \| Should -BeExactly "TestString1"`
`472`	`472`	`Get-TestValidateSetPS5 -Param1 "TestString1" -ErrorAction SilentlyContinue \| Should -BeExactly "TestString1"`
`473`		`- Start-Sleep 3`
	`473`	`+ Start-Sleep -Seconds 3`
`474`	`474`	`Get-TestValidateSetPS5 -Param1 "TestString2" -ErrorAction SilentlyContinue \| Should -BeExactly "TestString2"`
`475`	`475`	`}`
`476`	`476`	`}`
Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,7 @@ Describe "Job Cmdlet Tests" -Tag "CI" {`
`44`	`44`	`}`
`45`	`45`	`Context "jobs which take time" {`
`46`	`46`	`BeforeEach {`
`47`		`- $j = Start-Job -ScriptBlock { Start-Sleep 15 }`
	`47`	`+ $j = Start-Job -ScriptBlock { Start-Sleep -Seconds 15 }`
`48`	`48`	`}`
`49`	`49`	`AfterEach {`
`50`	`50`	`Get-Job \| Remove-Job -Force`
`@@ -93,7 +93,7 @@ Describe "Job Cmdlet Tests" -Tag "CI" {`
`93`	`93`	`throw "Receive-Job behaves suspiciously: Cannot receive $n results in 5 minutes."`
`94`	`94`	`}`
`95`	`95`
`96`		`- # sleep for 300 ms to allow data to be produced`
	`96`	`+ # Wait to allow data to be produced`
`97`	`97`	`Start-Sleep -Milliseconds 300`
`98`	`98`
`99`	`99`	`if ($keep)`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ function Wait-UntilTrue`
`17`	`17`	`if (([DateTime]::Now - $startTime).TotalMilliseconds -gt $timeoutInMilliseconds) {`
`18`	`18`	`return $false`
`19`	`19`	`}`
`20`		`- # Sleep for the specified interval`
	`20`	`+ # Wait`
`21`	`21`	`Start-Sleep -Milliseconds $intervalInMilliseconds`
`22`	`22`	`}`
`23`	`23`	`return $true`
Original file line number	Diff line number	Diff line change
`@@ -357,7 +357,7 @@ Function Start-HTTPListener {`
`357`	`357`	`{`
`358`	`358`	`# ignore if listener is not ready`
`359`	`359`	`}`
`360`		`- Start-Sleep -milliseconds 100`
	`360`	`+ Start-Sleep -Milliseconds 100`
`361`	`361`	`}`
`362`	`362`	`if (!$succeeded)`
`363`	`363`	`{`
Original file line number	Diff line number	Diff line change
`@@ -938,7 +938,7 @@ function Wait-UntilSuccess`
`938`	`938`	`}`
`939`	`939`	`}`
`940`	`940`
`941`		`- # Sleep for the specified interval`
	`941`	`+ # Wait`
`942`	`942`	`Start-Sleep -Milliseconds $intervalInMilliseconds`
`943`	`943`	`}`
`944`	`944`	`return $true`
`@@ -1073,7 +1073,7 @@ function Wait-PSWinEvent`
`1073`	`1073`
`1074`	`1074`	`do`
`1075`	`1075`	`{`
`1076`		`- sleep $pause`
	`1076`	`+ Start-Sleep -Seconds $pause`
`1077`	`1077`
`1078`	`1078`	`$recordsToReturn = @()`
`1079`	`1079`