Avoid nested array when using Should -ActualValue (pester#2315)

cjvandyk · May 6, 2023 · bd7bfe7 · bd7bfe7
1 parent 08998af
commit bd7bfe7
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 1 deletion.
diff --git a/src/Pester.Utility.ps1 b/src/Pester.Utility.ps1
@@ -384,3 +384,10 @@ function Fold-Run {
         }
     }
 }
+
+function IsPSEnumerable($Object) {
+    # https://github.com/pester/Pester/issues/1200#issuecomment-493043683
+    # PowerShell doesn't consider all IEnumerable an enumerable, ex. string is excluded.
+    $enumerator = [System.Management.Automation.LanguagePrimitives]::GetEnumerator($Object)
+    return $null -ne $enumerator
+}
diff --git a/src/functions/assertions/Should.ps1 b/src/functions/assertions/Should.ps1
@@ -120,7 +120,14 @@ function Should {
     }
 
     process {
-        $inputArray.Add($ActualValue)
+        # If array was provided using -ActualValue @(1,2,3), unroll like pipeline for consistent behaviour
+        if (-not $PSCmdlet.MyInvocation.ExpectingInput -and (IsPSEnumerable -Object $ActualValue)) {
+            foreach ($object in $ActualValue) {
+                $inputArray.Add($object)
+            }
+        } else {
+            $inputArray.Add($ActualValue)
+        }
     }
 
     end {

diff --git a/tst/functions/assertions/Should.Tests.ps1 b/tst/functions/assertions/Should.Tests.ps1
@@ -28,6 +28,12 @@ InPesterModuleScope {
             @($item1, $item2) | Should -Not -BeNullOrEmpty
         }
 
+        It 'works consistenly with array-input using pipeline or -ActualValue' {
+            # https://github.com/pester/Pester/issues/2314
+            @(1, 2, 3) | Should -Be -ExpectedValue @(1, 2, 3)
+            Should -Be -ActualValue @(1, 2, 3) -ExpectedValue @(1, 2, 3)
+        }
+
         It "can handle exception thrown assertions" {
             { foo } | Should -Throw
         }