Single trap definition for all tasks?

[boernsen-development]

Hi everybody,

we usually use the following trap definition to get useful info about errors such as stack traces:

trap {
    Write-Host "$($PSStyle.Foreground.Red)$($_.Exception)$($PSStyle.Reset)"
    Write-Host "$($PSStyle.Foreground.Magenta)$($_.ScriptStackTrace)$($PSStyle.Reset)"
    throw $_.Exception
}

For the .build.ps1 we can't yet get it to work properly, which I guess is caused by the way Invoke-Build works (which I don't know yet) in combination with how traps are designed: PowerShell/PowerShell#25742

However, I wonder if there is any workaround or alternative?

Imagine the following example:

# .build.ps1

# setup default error handling
Set-StrictMode -Version 3.0
$ErrorActionPreference = 'Stop'
trap {
    Write-Host "$($PSStyle.Foreground.Red)$($_.Exception)$($PSStyle.Reset)"
    Write-Host "$($PSStyle.Foreground.Magenta)$($_.ScriptStackTrace)$($PSStyle.Reset)"
    throw $_.Exception
}

. .\Invoke-Foo.ps1

task task1 {
    Write-Host "task1"
    foo
}

task task2 {
    Write-Host "task2"
    Invoke-Foo
}

# Invoke-Foo.ps1

function Invoke-Foo {
    Write-Host "Invoke-Foo"
    foo
}

When invoking task1 or task2, the foo commands produce errors, but I don't yet get the stack trace. I can get it by inserting the trap definition into each task. For our actual project with almost 30 tasks, this would result in a lot of code duplication though, so we are looking for a solution with minimal code duplication.

I already tried using Enter-Build, Enter-BuildTask and Enter-BuildJob, but with no success.

I wonder if anybody has ideas on how to get it to work by a single definition or by a alternative?

Cheers!

[nightroman]

Hi everybody,

we usually use the following trap definition to get useful info about errors such as stack traces:

trap {
    Write-Host "$($PSStyle.Foreground.Red)$($_.Exception)$($PSStyle.Reset)"
    Write-Host "$($PSStyle.Foreground.Magenta)$($_.ScriptStackTrace)$($PSStyle.Reset)"
    throw $_.Exception
}

For the .build.ps1 we can't yet get it to work properly, which I guess is caused by the way Invoke-Build works (which I don't know yet) in combination with how traps are designed: PowerShell/PowerShell#25742

However, I wonder if there is any workaround or alternative?

Imagine the following example:

# .build.ps1

# setup default error handling
Set-StrictMode -Version 3.0
$ErrorActionPreference = 'Stop'
trap {
    Write-Host "$($PSStyle.Foreground.Red)$($_.Exception)$($PSStyle.Reset)"
    Write-Host "$($PSStyle.Foreground.Magenta)$($_.ScriptStackTrace)$($PSStyle.Reset)"
    throw $_.Exception
}

. .\Invoke-Foo.ps1

task task1 {
    Write-Host "task1"
    foo
}

task task2 {
    Write-Host "task2"
    Invoke-Foo
}

# Invoke-Foo.ps1

function Invoke-Foo {
    Write-Host "Invoke-Foo"
    foo
}

When invoking task1 or task2, the foo commands produce errors, but I don't yet get the stack trace. I can get it by inserting the trap definition into each task. For our actual project with almost 30 tasks, this would result in a lot of code duplication though, so we are looking for a solution with minimal code duplication.

I already tried using Enter-Build, Enter-BuildTask and Enter-BuildJob, but with no success.

I wonder if anybody has ideas on how to get it to work by a single definition or by a alternative?

Cheers!

I do not think such trap will be possible.

But the error enhancement you show is doable now. In Exit-Bulld use the build variable * - it's property Error if not null is the error that failed the build.

[boernsen-development]

Just for future readers, I'm using this now:

Exit-Build {
    if (${*}.Errors.Count -gt 0) {
        Write-Host "$($PSStyle.Foreground.Red)$(${*}.Errors.Error.Exception)$($PSStyle.Reset)"
        Write-Host "$($PSStyle.Foreground.Magenta)$(${*}.Errors.Error.ScriptStackTrace)$($PSStyle.Reset)"
    }
}

This produces output similar to (with some text coloring not shown here):

System.Management.Automation.CommandNotFoundException: The term 'foo' is not recognized as a name of a cmdlet, function, script file, or executable program.
Check the spelling of the name, or if a path was included, verify that the path is correct and try again.
   at System.Management.Automation.ExceptionHandlingOps.CheckActionPreference(FunctionContext funcContext, Exception exception)
   at <ScriptBlock><End>(Closure, FunctionContext)
at Invoke-Foo, [REMOVED]\Invoke-Foo.ps1: line 3
at <ScriptBlock>, [REMOVED]\.build.ps1: line 30
at *Task, C:\Program Files\PowerShell\Modules\InvokeBuild\5.14.22\Invoke-Build.ps1: line 703
at *Task, C:\Program Files\PowerShell\Modules\InvokeBuild\5.14.22\Invoke-Build.ps1: line 675
at <ScriptBlock><End>, C:\Program Files\PowerShell\Modules\InvokeBuild\5.14.22\Invoke-Build.ps1: line 854
at <ScriptBlock>, <No file>: line 2
at <ScriptBlock>, <No file>: line 1