Merge pull request #18 from KirkMunro/issue_4

Added -PassThru parameter to Expand-Archive and Compress-Archive

Author: SteveL-MSFT

Microsoft.PowerShell.Archive/Microsoft.PowerShell.Archive.psm1

@@ -37,6 +37,7 @@ function Compress-Archive
     DefaultParameterSetName="Path", 
     SupportsShouldProcess=$true,
     HelpUri="http://go.microsoft.com/fwlink/?LinkID=393252")]
+    [OutputType([System.IO.File])]
     param 
     (
         [parameter (mandatory=$true, Position=0, ParameterSetName="Path", ValueFromPipeline=$true, ValueFromPipelineByPropertyName=$true)]
@@ -75,7 +76,10 @@ function Compress-Archive
         [parameter(mandatory=$true, ParameterSetName="PathWithForce", ValueFromPipeline=$false, ValueFromPipelineByPropertyName=$false)]
         [parameter(mandatory=$true, ParameterSetName="LiteralPathWithForce", ValueFromPipeline=$false, ValueFromPipelineByPropertyName=$false)]
         [switch]
-        $Force = $false  
+        $Force = $false,
+
+        [switch]
+        $PassThru = $false
     )
 
     BEGIN 
@@ -234,6 +238,10 @@ function Compress-Archive
                         Remove-Item -LiteralPath $DestinationPath -Force -Recurse -ErrorAction SilentlyContinue
                     }
                 }
+                elseif ($PassThru)
+                {
+                    Get-Item -LiteralPath $DestinationPath
+                }
             }
         }
     }
@@ -248,6 +256,7 @@ function Expand-Archive
     DefaultParameterSetName="Path", 
     SupportsShouldProcess=$true,
     HelpUri="http://go.microsoft.com/fwlink/?LinkID=393253")]    
+    [OutputType([System.IO.FileSystemInfo])]
     param 
     (
         [parameter (
@@ -277,7 +286,10 @@ function Expand-Archive
         [parameter (mandatory=$false,
         ValueFromPipeline=$false, 
         ValueFromPipelineByPropertyName=$false)]
-        [switch] $Force
+        [switch] $Force,
+
+        [switch]
+        $PassThru = $false
     )
 
     BEGIN 
@@ -410,6 +422,12 @@ function Expand-Archive
                         $expandedItems | % { Remove-Item $_ -Force -Recurse }
                     }
                 }
+                elseif ($PassThru -and $expandedItems.Count -gt 0)
+                {
+                    # Return the expanded items, being careful to remove trailing backslashes from
+                    # any folder paths for consistency
+                    Get-Item -LiteralPath ($expandedItems -replace '\\+$')
+                }
             }
         }
     }

Tests/Pester.Commands.Cmdlets.Archive.Tests.ps1

@@ -621,6 +621,27 @@ Describe "Test suite for Microsoft.PowerShell.Archive module" -Tags "BVT" {
                 $ps.Dispose()
             }
         }
+
+        It "Validate that Compress-Archive returns nothing when -PassThru is not used" {
+            $sourcePath = @("$TestDrive\SourceDir")
+            $destinationPath = "$TestDrive\NoPassThruTest.zip"
+            $archive = Compress-Archive -Path $sourcePath -DestinationPath $destinationPath
+            $archive | Should Be $null
+        }
+
+        It "Validate that Compress-Archive returns nothing when -PassThru is used with a value of $false" {
+            $sourcePath = @("$TestDrive\SourceDir")
+            $destinationPath = "$TestDrive\FalsePassThruTest.zip"
+            $archive = Compress-Archive -Path $sourcePath -DestinationPath $destinationPath -PassThru:$false
+            $archive | Should Be $null
+        }
+
+        It "Validate that Compress-Archive returns the archive when invoked with -PassThru" {
+            $sourcePath = @("$TestDrive\SourceDir")
+            $destinationPath = "$TestDrive\PassThruTest.zip"
+            $archive = Compress-Archive -Path $sourcePath -DestinationPath $destinationPath -PassThru
+            $archive.FullName | Should Be $destinationPath
+        }
     }
 
     Context "Expand-Archive - Parameter validation test cases" {
@@ -947,5 +968,50 @@ Describe "Test suite for Microsoft.PowerShell.Archive module" -Tags "BVT" {
                 Pop-Location
             }
         }
+
+        It "Validate that Expand-Archive returns nothing when -PassThru is not used" {
+            $sourcePath = "$TestDrive\SourceDir"
+            $archivePath = "$TestDrive\NoPassThruTestForExpand.zip"
+            $destinationPath = "$TestDrive\NoPassThruTest"
+            $sourceList = dir $sourcePath -Name
+
+            Add-CompressionAssemblies
+            [System.IO.Compression.ZipFile]::CreateFromDirectory($sourcePath, $archivePath)
+
+            $contents = Expand-Archive -Path $archivePath -DestinationPath $destinationPath
+
+            $contents | Should Be $null
+        }
+
+        It "Validate that Expand-Archive returns nothing when -PassThru is used with a value of $false" {
+            $sourcePath = "$TestDrive\SourceDir"
+            $archivePath = "$TestDrive\FalsePassThruTestForExpand.zip"
+            $destinationPath = "$TestDrive\FalsePassThruTest"
+            $sourceList = dir $sourcePath -Name
+
+            Add-CompressionAssemblies
+            [System.IO.Compression.ZipFile]::CreateFromDirectory($sourcePath, $archivePath)
+
+            $contents = Expand-Archive -Path $archivePath -DestinationPath $destinationPath -PassThru:$false
+
+            $contents | Should Be $null
+        }
+
+        It "Validate that Expand-Archive returns the contents of the archive -PassThru" {
+            $sourcePath = "$TestDrive\SourceDir"
+            $archivePath = "$TestDrive\PassThruTestForExpand.zip"
+            $destinationPath = "$TestDrive\PassThruTest"
+            $sourceList = dir $sourcePath -Name
+
+            Add-CompressionAssemblies
+            [System.IO.Compression.ZipFile]::CreateFromDirectory($sourcePath, $archivePath)
+
+            $contents = Expand-Archive -Path $archivePath -DestinationPath $destinationPath -PassThru | Sort-Object -Property PSParentPath,PSIsDirectory,Name
+            # We pipe Get-ChildItem to Get-Item here because the ToString results are different between the two, and we
+            # need to compare with other Get-Item results
+            $extractedList = Get-ChildItem -Recurse -LiteralPath $destinationPath | Get-Item
+
+            Compare-Object -ReferenceObject $extractedList -DifferenceObject $contents -PassThru | Should Be $null
+        }
     }
 }