如何将警告视为自定义构建的错误？

Question

作为我们构建的一部分，我们有一个项目 (.vcxproj)，其中仅包含一个带有 Custom Build Tool 构建的 python 脚本，命令行：$(python_bin)/python.exe %(FullPath)。 Msbuild 能够解析来自这个 python 脚本的警告并在构建后显示它们：

"F:\Generators.vcxproj" (default target) (1) ->
(CustomBuild target) -> 
  F:\Tool.py(274): warning : OPSEC [F:\Generators.vcxproj]
  F:\Tool.py(274): warning : OPSEC [F:\Generators.vcxproj]

    2 Warning(s)
    0 Error(s)

现在，如何强制它将这些警告视为错误？我找到的唯一选项是Treat Linker Warning As Errors，这显然没有帮助，因为在这个项目上的链接没有完成（因为它只是一个带有自定义构建的 .py 文件）而且无论如何这些警告来自构建步骤。

我什至尝试将<TreatWarningAsError>true</TreatWarningAsError> 添加到ClCompile 部分。没有帮助。

如何强制 msbuild 将这些警告视为错误？

Answer 1

让我从你最近的一位 cmets 开始：

... msbuild 将 python 脚本的输出识别为警告。但它可以 也可以是 bash、perl、php 脚本或类似的东西。构建 将输出识别为警告，我想将这些警告视为 错误。 ...

对于在 MSBuild 中可以想象的 任何 工具，没有通用的“将警告转化为错误”。怎么可能？ MSBuild 调用的每个工具都有其一种执行方式（如果有的话）。例如，C++ 编译器和 C# 编译器具有特定的命令行选项，这些选项由这些语言的 msbuild 文件包含在它们的命令行中 - 核心 msbuild 引擎无能为力。

因此，您需要做的是指示工具（问题上下文中的 python）在您需要时执行此操作。您可以通过使用现有/众所周知的属性 (TreatWarningsAsErrors) 作为触发器来执行此操作。如果它具有特定值 (true)，那么您需要做任何您需要做的事情，让您的工具发出警告作为错误并采取相应措施。

例子：

<PropertyGroup>
    <PythonCmd>$(python_bin)\python.exe</PythonCmd>
    <PythonCmd Condition="'$(TreatWarningsAsErrors)' == 'true'">$(PythonCmd) -W error</PythonCmd>
    <PythonCmd>$(PythonCmd) %(FullPath)</PythonCmd>
</PropertyGroup>

<Exec Command="$(PythonCmd)" .../>

现在，如果您不知道如何完全让 python 做您想做的事（将警告变成错误），没有 msbuild 魔法可以帮助您做到这一点。你突然确实有一个python特定的问题。因为您现在遇到的实际问题与从 msbuild 或从命令行执行的 python 无关。

第二个选项：如果您不能或不想使用 Python 将警告转化为错误的内置功能，您还可以使用 Exec-Tasks CustomErrorRegularExpression-property 指定正则表达式应该被工具（此处为python.exe）视为“错误输出”。

类似

 <PropertyGroup>
     <ErrorExp>.*: error :.*</ErrorExp>
     <ErrorExp Condition="'$(TreatWarningsAsErrors)' == 'true'">.*: (warning|error) :.*</ErrorExp>
 </PropertyGroup>

 <Exec ... CustomErrorRegularExpression="$(ErrorExp)"/>

（未经测试！）应该可以帮助您入门。

但是，由于 Python 已经提供了一种将警告设置为错误的方法（似乎是通过 -W error），因此该选项似乎是不必要的复杂。

再次，关于您对正在使用的潜在其他工具的评论，请注意，上述方法还需要有关这些其他工具的特定知识以及它们如何格式化警告（如果有的话），因为您需要自定义正则表达式他们。

因此，即使这种方法也需要有关您调用的工具的特定知识，而不是 msbuild。

我可能完全不在这里，而您确实有不同的问题、疑问或需求。检查您的问题的 cmets，看起来我不是唯一的，因此您可能需要更改您的问题或使其更精确（可能有您已经尝试过的示例）以获得进一步/更好的帮助.