Merge pull request #154 from ShaunLawrie/fix-write-progress-on-psdrive

Add PSDrive support for Invoke-RestMethodWithProgress

Author: dfinke

Private/Invoke-RestMethodWithProgress.ps1

@@ -41,8 +41,10 @@ function Invoke-RestMethodWithProgress {
         $ProgressActivity = "Thinking..."
     )
 
+    $currentLocation = Get-Location
+
     # Some hosts can't support background jobs. It's best to opt-in to this feature by using a list of supported hosts
-    if($script:SupportedHosts -notcontains (Get-Host).Name) {
+    if($script:SupportedHosts -notcontains (Get-Host).Name -or $currentLocation.Provider.Name -ne "FileSystem") {
         return Invoke-RestMethod @Params
     }
 
@@ -51,6 +53,11 @@ function Invoke-RestMethodWithProgress {
     try {
         try { [Console]::CursorVisible = $false }
         catch [System.IO.IOException] { <# unit tests don't have a console #> }
+
+        Push-Location -StackName "RestMethodWithProgress"
+        if($currentLocation.Path -ne $currentLocation.ProviderPath) {
+            Set-Location $currentLocation.ProviderPath
+        }
 
         $job = Start-Job {
             $restParameters = $using:Params
@@ -87,8 +94,11 @@ function Invoke-RestMethodWithProgress {
     } catch {
         throw $_
     } finally {
-        Stop-Job $job -ErrorAction "SilentlyContinue"
-        Remove-Job $job -Force -ErrorAction "SilentlyContinue"
+        Pop-Location -StackName "RestMethodWithProgress" -ErrorAction "SilentlyContinue"
+        if($null -ne $job) {
+            Stop-Job $job -ErrorAction "SilentlyContinue"
+            Remove-Job $job -Force -ErrorAction "SilentlyContinue"
+        }
         try { [Console]::CursorVisible = $true }
         catch [System.IO.IOException] { <# unit tests don't have a console #> }
     }

__tests__/Invoke-RestMethodWithProgress.tests.ps1

@@ -8,6 +8,13 @@ Describe "Invoke-RestMethodWithProgress" -Tag InvokeRestMethodWithProgress {
 
         BeforeEach {
             Reset-APIEstimatedResponseTimes
+            Push-Location -StackName "MOCK-IRMWP" -Path $PSScriptRoot
+            New-PSDrive -Name "MOCK-IRMWP" -PSProvider "FileSystem" -Root $PSScriptRoot
+        }
+
+        AfterEach {
+            Pop-Location -StackName "MOCK-IRMWP" -ErrorAction "SilentlyContinue"
+            Remove-PSDrive -Name "MOCK-IRMWP" -ErrorAction "SilentlyContinue"
         }
 
         It "should return the known response if the API call is successful" {
@@ -31,6 +38,51 @@ Describe "Invoke-RestMethodWithProgress" -Tag InvokeRestMethodWithProgress {
             $response | Should -BeExactly "a happy web response from a web server"
         }
 
+        It "should work when run from a psdrive" {
+
+            Mock Start-Job {
+                return & $script:StartJobCommand { }
+            }
+            
+            Mock Receive-Job {
+                return @{
+                    Response = "a happy web response from a web server"
+                }
+            }
+
+            $params = @{
+                "Method" = "GET";
+                "Uri" = "http://localhost";
+            }
+
+            Set-Location "MOCK-IRMWP:\"
+            
+            $response = Invoke-RestMethodWithProgress -Params $params
+            $response | Should -BeExactly "a happy web response from a web server"
+        }
+
+        It "should work when run from a non-filesystem provider" {
+            
+            Mock Invoke-RestMethod {
+                return "a happy web response from a web server"
+            }
+
+            Mock Start-Job { }
+
+            $params = @{
+                "Method" = "GET";
+                "Uri" = "http://localhost";
+            }
+
+            Push-Location -StackName "MOCK-IRMWP"
+            Set-Location "Env:\"
+            
+            $response = Invoke-RestMethodWithProgress -Params $params
+            $response | Should -BeExactly "a happy web response from a web server"
+            Should -Invoke -CommandName Invoke-RestMethod -Times 1
+            Should -Invoke -CommandName Start-Job -Times 0
+        }
+
         It "should throw if the API call fails" {
 
             $params = @{