为什么我的 PowerShell 退出代码总是“0”？

Question

我有一个 PowerShell 脚本如下

##teamcity[progressMessage 'Beginning build']
# If the build computer is not running the appropriate version of .NET, then the build will not run. Throw an error immediately.
if( (ls "$env:windir\Microsoft.NET\Framework\v4.0*") -eq $null ) {
    throw "This project requires .NET 4.0 to compile. Unfortunately .NET 4.0 doesn't appear to be installed on this machine."
    ##teamcity[buildStatus status='FAILURE' ]
}

##teamcity[progressMessage 'Setting up variables']
# Set up variables for the build script
$invocation = (Get-Variable MyInvocation).Value
$directorypath = Split-Path $invocation.MyCommand.Path
$v4_net_version = (ls "$env:windir\Microsoft.NET\Framework\v4.0*").Name
$nl = [Environment]::NewLine

Copy-Item -LiteralPath "$directorypath\packages\NUnit.2.6.2\lib\nunit.framework.dll" "$directorypath\Pandell.Tests\bin\debug" -Force

##teamcity[progressMessage 'Using msbuild.exe to build the project']
# Build the project using msbuild.exe.
# Note we've already determined that .NET is already installed on this computer.
cmd /c C:\Windows\Microsoft.NET\Framework\$v4_net_version\msbuild.exe "$directorypath\Pandell.sln" /p:Configuration=Release
cmd /c C:\Windows\Microsoft.NET\Framework\$v4_net_version\msbuild.exe "$directorypath\Pandell.sln" /p:Configuration=Debug

# Break if the build throws an error.
if(! $?) {
    throw "Fatal error, project build failed"
    ##teamcity[buildStatus status='FAILURE' ]
}

##teamcity[progressMessage 'Build Passed']
# Good, the build passed
Write-Host "$nl project build passed."  -ForegroundColor Green


##teamcity[progressMessage 'running tests']
# Run the tests.
cmd /c $directorypath\build_tools\nunit\nunit-console.exe $directorypath\Pandell.Tests\bin\debug\Pandell.Tests.dll

# Break if the tests throw an error.
if(! $?) {
    throw "Test run failed."
    ##teamcity[buildStatus status='FAILURE' ]
}

##teamcity[progressMessage 'Tests passed']

据我所知，an uncaught Throw 将导致退出代码为1，但不幸的是，TeamCity 另有说明。

[19:32:20]Test run failed.
[19:32:20]At C:\BuildAgent\work\e903de7564e599c8\build.ps1:44 char:2
[19:32:20]+     throw "Test run failed."
[19:32:20]+     ~~~~~~~~~~~~~~~~~~~~~~~~
[19:32:20]    + CategoryInfo          : OperationStopped: (Test run failed.:String) [],
[19:32:20]   RuntimeException
[19:32:20]    + FullyQualifiedErrorId : Test run failed.
[19:32:20]
[19:32:20]Process exited with code 0
[19:32:20]Publishing internal artifacts
[19:32:20][Publishing internal artifacts] Sending build.finish.properties.gz file
[19:32:20]Build finished

注意我的Execution Mode 设置为Execute .ps1 script with "-File" argument 可能也很重要。

我尝试将其更改为Put script into PowerShell stdin with "-Command -" arguments，但即使通过了测试，它也会以1 的退出代码失败。我确信以-File 运行它会是正确的方式。

如果我打开位于 C:\BuildAgent\work\e903de7564e599c8\build.ps1 的脚本并在 CMD 中手动运行它，它会做同样的事情......即，失败的测试失败，%errorlevel% 仍然是 0。

然而，如果我在 PowerShell 中运行它并调用 $LASTEXITCODE，它每次都会返回正确的代码。

Answer 1

这是 PowerShell 的一个已知问题。使用-file 执行脚本会返回退出代码 0，而它不应该这样做。

（更新：以下链接不再有效。请在 PowerShell: Hot (1454 ideas) – Windows Server 上查找或报告此问题）

• https://connect.microsoft.com/PowerShell/feedback/details/777375/powershell-exe-does-not-set-an-exit-code-when-file-is-used

• https://connect.microsoft.com/PowerShell/feedback/details/750653/powershell-exe-doesn-t-return-correct-exit-codes-when-using-the-file-option

由于使用-command 不适合您，您可以尝试在脚本顶部添加一个陷阱：

trap
{
    write-output $_
    ##teamcity[buildStatus status='FAILURE' ]
    exit 1
}

当抛出异常时，上述内容应该会产生正确的退出代码。

Answer 2

无论出于何种原因，这些选项都不适用于我的 PowerShell 脚本。我花了几个小时。

对我来说，最好的选择是在 TeamCity 和 PowerShell 之间放置一个层。所以我简单地编写了一个调用 PowerShell 脚本的 C# 控制台应用程序。

我的做法是，在 TeamCity 中，我们调用一个名为：RemoteFile.ps1的脚本

使用脚本参数：%system.RemoteServerFQDN% %system.RemoteUser% %system.RemoteUserPassword% %system.RemoteScriptName% %system.RemotePropertiesFile% %system.BuildVersion% %system.RunList%

param (
    [Parameter(Mandatory=$true)]
    $Computername,
    [Parameter(Mandatory=$true)]
    $Username,
    [Parameter(Mandatory=$true)]
    $Password,
    [Parameter(Mandatory=$true)]
    $ScriptName,
    [Parameter(Mandatory=$true)]
    $Propfile,
    [Parameter(Mandatory=$true)]
    $Version,
    [Parameter(Mandatory=$true)]
    [string[]]$DeploymentTypes
)

$securePassword = ConvertTo-SecureString -AsPlainText -Force $Password
$cred = New-Object System.Management.Automation.PSCredential $Username, $securePassword
Write-Host "Readying to execute invoke-command..."
Invoke-Command -ComputerName $Computername -Credential $cred -ScriptBlock {       D:\Deployment\PowershellWrapper.exe $using:ScriptName $using:Propfile $using:Version      $using:DeploymentTypes } -ArgumentList $ScriptName,$Propfile,$Version,$DeploymentTypes

存在于指定位置的远程服务器上。

然后该文件在指定位置调用：powershellwrapper.exe（我的脚本有四个参数要传递给 PowerShell 脚本）

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Diagnostics;

namespace PowershellWrapper
{
    class Program
    {
        static void Main(string[] args)
        {
            try
            {
                string argFull = @"""{0} {1} {2} {3}""";
                string arg0 = args[0];
                string arg1 = args[1];
                string arg2 = args[2];
                string arg3 = args[3];
                string argFinal = string.Format(argFull, arg0, arg1, arg2, arg3);

                ProcessStartInfo startInfo = new ProcessStartInfo();
                startInfo.FileName = @"powershell.exe";
                startInfo.Arguments = argFinal;
                startInfo.RedirectStandardOutput = false;
                startInfo.RedirectStandardError = false;
                startInfo.UseShellExecute = false;
                startInfo.RedirectStandardInput = true;
                startInfo.CreateNoWindow = false;
                Process process = new Process();
                process.StartInfo = startInfo;
                process.Start();
            }
            catch (Exception e)
            {
                Console.WriteLine("{0} Exception caught.", e);
                Console.WriteLine("An error occurred in the deployment.", e);
                Console.WriteLine("Please contact test@test.com if error occurs.");
            }
        }
    }
}

这用四个参数调用我的脚本。脚本是第一个参数，加上三个参数。所以基本上这里发生的事情是我正在执行 PowershellWrapper.exe 而不是 PowerShell 脚本本身来捕获错误的退出代码 0，它仍然会将完整的脚本报告回 TeamCity 日志。

我希望这是有道理的。它对我们来说就像一种魅力。

Answer 3

我在使用 -file 运行时遇到了这个确切的问题，但由于某种原因，Kevin 提供的陷阱语法或“退出”语法在我的场景中不起作用。

我不知道为什么，但以防万一其他人遇到同样的问题，我使用了以下语法，它对我有用：

try{
    #DO SOMETHING HERE
}
catch
{
    Write-Error $_
    ##teamcity[buildStatus status='FAILURE']
    [System.Environment]::Exit(1)
}

Answer 4

在命令上使用-ErrorAction stop 默认情况下会返回退出代码 1，并且在没有添加失败条件的情况下也在 TeamCity 中显示它。现在，我们将默认使用$ErrorActionPreference = "Stop"; 为每个 PowerShell 命令实现此行为。

Answer 5

直到这个（大概）被关闭为 dup of my self-answer of an older question，我将在这里总结最干净的解决方案：

• 大多数其他答案涉及从 PowerShell 位向stderr 发出一些东西。这可以通过 Format stderr output as 选项直接使用 TeamCity 完成（将其设置为 Error 而不是默认值，即 Warning）

• 但是，至关重要的是，还需要在“Failure条件”（如果任何其他答案对您有用，您可能已经开启了此功能，但 IME非常很容易忘记！）