PowerShell/test/powershell/Language/Scripting/NativeExecution/NativeStreams.Tests.ps1

# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.
Describe "Native streams behavior with PowerShell" -Tags 'CI' {
    BeforeAll {
        $powershell = Join-Path -Path $PSHOME -ChildPath "pwsh"
    }

    Context "Error stream" {
        # we are using powershell itself as an example of a native program.
        # we can create a behavior we want on the fly and test complex scenarios.

        $error.Clear()

        $command = [string]::Join('', @(
            '[Console]::Error.Write("foo`n`nbar`n`nbaz"); ',
            '[Console]::Error.Write("middle"); ',
            '[Console]::Error.Write("foo`n`nbar`n`nbaz")'
        ))

        $out = & $powershell -noprofile -command $command 2>&1

        # this check should be the first one, because $error is a global shared variable
        It 'should not add records to $error variable' {
            $error.Count | Should -Be 0
        }

        It 'uses ErrorRecord object to return stderr output' {
            ($out | Measure-Object).Count | Should -BeGreaterThan 1

            $out[0] | Should -BeOfType System.Management.Automation.ErrorRecord
            $out[0].FullyQualifiedErrorId | Should -Be 'NativeCommandError'

            $out | Select-Object -Skip 1 | ForEach-Object {
                $_ | Should -BeOfType System.Management.Automation.ErrorRecord
                $_.FullyQualifiedErrorId | Should -Be 'NativeCommandErrorMessage'
            }
        }

        It 'uses correct exception messages for error stream' {
            ($out | Measure-Object).Count | Should -Be 9
            $out[0].Exception.Message | Should -BeExactly 'foo'
            $out[1].Exception.Message | Should -BeExactly ''
            $out[2].Exception.Message | Should -BeExactly 'bar'
            $out[3].Exception.Message | Should -BeExactly ''
            $out[4].Exception.Message | Should -BeExactly 'bazmiddlefoo'
            $out[5].Exception.Message | Should -BeExactly ''
            $out[6].Exception.Message | Should -BeExactly 'bar'
            $out[7].Exception.Message | Should -BeExactly ''
            $out[8].Exception.Message | Should -BeExactly 'baz'
        }

        It 'preserves error stream as is with Out-String' {
            ($out | Out-String).Replace("`r", '') | Should -BeExactly "foo`n`nbar`n`nbazmiddlefoo`n`nbar`n`nbaz`n"
        }

        It 'Does not get truncated or split when redirected' {
            if (Test-IsWindowsArm64) {
                Set-ItResult -Pending -Because "IOException: The handle is invalid."
            }

            $longtext = "0123456789"
            while ($longtext.Length -lt [console]::WindowWidth) {
                $longtext += $longtext
            }
            & $powershell -c "& { [Console]::Error.WriteLine('$longtext') }" 2>&1 > $testdrive\error.txt
            $e = Get-Content -Path $testdrive\error.txt
            $e.Count | Should -Be 1
            $e | Should -BeExactly $longtext
        }
    }
}

Describe 'piping powershell objects to finished native executable' -Tags 'CI' {
    It 'doesn''t throw any exceptions, when we are piping to the closed executable' {
        1..3 | ForEach-Object {
            Start-Sleep -Milliseconds 100
            # yield some multi-line formatted object
            @{'a' = 'b'}
        } | testexe -echoargs | Should -BeNullOrEmpty
    }
}