代码合同 - Visual Studio Team Service 脚本化构建服务器单元测试失败

我最近将代码契约添加到我的解决方案中。经过一些修改后，我们的构建运行没有任何问题，但我们的单元测试由于代码契约而失败。

环境：

• 源代码控制和构建服务器托管在Visual Studio 团队服务 https://www.visualstudio.com/en-us/get-started/build/build-your-app-vs(VSTS) 脚本化构建 (以前的VSO)
• VS 2013 高级代码 (现在 VS 2015 企业版) 配置上启用的合约Debug and Release
• 代码合约已关闭DoNotBuild为自定义配置设置标志BuildServer
• Visual Studio Team Services https://www.visualstudio.com/en-us/get-started/build/build-your-app-vs build definition:
  1. 有步骤Visual Studio
  2. 已设置标志/p:CodeContractsEnableRuntimeChecking=false;CodeContractsReferenceAssembly=false

来自构建服务器的错误文本示例：

测试方法 Web.Tests.AccountControllerTests.CreateAccount_Pass_NoPasswordSend_Test 引发异常：System.Diagnostics.Contracts.ContractException：An 程序集（可能是“Cms.Web”）必须使用代码重写 合同二进制重写器（CCRewrite），因为它正在调用 Contract.Requires 和 CONTRACTS_FULL 符号是 定义的。删除 CONTRACTS_FULL 符号的任何显式定义 从您的项目中进行重建。

我检查了构建服务器的诊断输出，没有任何符号CONTRACTS_FULL随处可见。

我不想在构建服务器上启用代码合约，主要是因为我之前尝试过但没有成功，并且由于时间限制我放弃了（经过更多搜索后，我得出的结论是这是不可能的，因为微软不允许在构建服务器上安装自定义扩展）。我只是想忽略构建服务器上的代码契约，但单元测试执行似乎并没有这样做。

有人知道我需要在哪里寻找以确保单元测试忽略代码契约吗？看起来这应该是可能的吧？也许我可以在构建定义中设置另一个标志，该标志将由单元测试选取？

Edit

请注意构建服务器是HOSTED作为 Microsoft 服务作为 Visual Studio Team Services（以前称为 Visual Studio Online）的一部分存储在云中。这意味着它不是我们的构建服务器，我们无法控制构建服务器上安装的内容。即便如此，我们还是想使用代码契约。下面接受的答案是一种允许这种情况的方法。

请阅读代码合同手册。它会告诉您您需要知道的一切。你不需要任何ConditionalAttribute在您的方法上定义。您可以使用Contract.Requires<TException>(bool condition)如果您知道这样做的要求是什么。

正如 @Mixiphoid 在他们的回答中所说，因为他们使用的是 Requires 的通用形式，所以需要在构建服务器上安装代码契约and 执行运行时契约检查需要为Release配置启用此外调试配置。

如果您使用代码合同，那么您将always需要在构建调试版本的构建服务器上安装代码合约。您的团队也是如此：所有需要编译代码的开发人员都需要安装代码合约以进行调试构建。

一切都在第 5 节：使用指南在代码合同手册中。有一个有用的图表page 20这很好地总结了各种使用场景及其要求。

About Contract.Requires<TException>(bool condition)

首先，为代码合约编写此方法的开发人员did not忘记应用ConditionalAttribute正如已接受的答案所述，该方法。离得很远。该方法没有用该​​属性修饰的事实是按设计.

如果你读过第 5 节：使用指南，你会发现如果你使用这种形式Requires方法，那么你需要使用二进制重写器——ccrewrite- 构建装配体时。这意味着任何构建装配体的机器都必须具有ccrewrite可用的。

那么，如何构建您可能无法控制的服务器呢？我很高兴你问了。

TFS 托管构建服务器

关于 TFS 托管的构建服务器：确实，您不能简单地在构建服务器上安装代码契约。那么你有什么选择呢？

1. You could limit yourself to using only the "legacy" form of code contracts, if-then-throw blocks followed by Contract.EndContractBlock() or limit yourself to only using Contract.Requires(bool condition) (the non-generic form), or a mixture of the two.
   • 无论哪种情况，您可能都希望为 TFS 托管的构建服务器提供单独的调试构建配置。这个构建配置将有执行运行时契约检查对该构建配置禁用。
2. 你可以做一点“bing-ing”或“google”并想出this http://blog.mycupof.net/2013/03/30/team-foundation-service-make-codecontracts-work-on-a-hosted-build-agent/搜索结果，描述如何在 TFS Online 上使用代码合同构建解决方案。

上面链接的博客文章包含修改 TFS 托管构建控制器托管构建的说明。

更新：很快就会有 NUGET 版本的代码合约对于那些使用托管构建服务（例如 Visual Studio Online、AppVeyor 等）的人来说，新的社区驱动的代码合同 GitHub 存储库最近发布了v1.10.xxxxx.RC1。在发行说明中，他们提到了代码合约的 NuGet 版本 https://github.com/Microsoft/CodeContracts/issues/13. Enjoy.