如果代码覆盖率低于 TFS2012 中的阈值，则构建失败

本文介绍了如果代码覆盖率低于 TFS2012 中的阈值，则构建失败的处理方法，对大家解决问题具有一定的参考价值，需要的朋友们下面随着小编来一起学习吧！

问题描述

当代码覆盖率低于阈值时，我试图在 TFS 服务(托管 TFS2012)中构建失败.

I'm trying to fail builds in TFS Service (Hosted TFS2012) when Code Coverage is below a threshold.

我一直在 http://scrumdod.blogspot.co.uk/2011/04/fail-build-if-code-coverage-is-low.html

但是，我使用的是 TFS2012，很多事情似乎都发生了变化.特别是，测试运行的配置完全不同，似乎没有任何方法可以在构建过程模板或 .runsettings 文件中获取或设置 .coverage 文件的位置和名称.

However, I'm using TFS2012 and a great many things appear to have changed. In particular, the configuration of the test run is completely different and there does not appear to be any way to get or set the location and name of the .coverage file in either the build process template or the .runsettings file.

我将如何在 TFS2012 或 TFSService 中查找(或设置).coverage 文件的位置?

How would I go about finding (or setting) the location of the .coverage file in TFS2012 or TFSService?

或者，如果代码覆盖率低于阈值，是否还有另一种方法可以使构建失败?

Alterntely, is there another way that I can fail the build if code coverage is below a threshold?

1.创建自定义构建活动.

在 VS2012 中新建一个项目(我叫我的 CodeCoverageLibrary.参考以下程序集:

1. Create a custom build activity.

Make a new project in VS2012 (I called mine CodeCoverageLibrary. Reference the following assemblies:

Microsoft.TeamFoundation.Build.Client
Microsoft.TeamFoundation.Client
Microsoft.TeamFoundation.TestManagement.Client
Microsoft.TeamFoundation.WorkItemTracking.Client
系统
系统.活动
系统核心
系统.Xaml

您可以使用以下代码:

using System;
using System.Activities;
using System.Collections.Generic;
using Microsoft.TeamFoundation.Build.Client;
using Microsoft.TeamFoundation.Client;
using Microsoft.TeamFoundation.TestManagement.Client;

namespace CodeCoverageLibrary
{
    [BuildActivity(HostEnvironmentOption.All)]
    public sealed class GetCodeCoverage : CodeActivity<double>
    {
        public InArgument<IBuildDetail> BuildDetail { get; set; }

        protected override double Execute(CodeActivityContext context)
        {
            var buildDetail = BuildDetail.Get(context);
            var buildCoverages = GetBuildCoverages(buildDetail.BuildServer.TeamProjectCollection.Uri,
                                                   buildDetail.TeamProject, buildDetail.Uri);
            return GetTotalCoverage(buildCoverages);
        }

        private static IEnumerable<IBuildCoverage> GetBuildCoverages(Uri uri, string projectName, Uri buildUri)
        {
            return TfsTeamProjectCollectionFactory.GetTeamProjectCollection(uri)
                                                  .GetService<ITestManagementService>()
                                                  .GetTeamProject(projectName)
                                                  .CoverageAnalysisManager.QueryBuildCoverage(buildUri.ToString(),
                                                                                              CoverageQueryFlags.Modules);
        }

        private static double GetTotalCoverage(IEnumerable<IBuildCoverage> buildCoverages)
        {
            int totalCoveredBlocks = 0, totalUncoveredBlocks = 0;
            foreach (var buildCoverage in buildCoverages)
            {
                foreach (var module in buildCoverage.Modules)
                {
                    totalCoveredBlocks += module.Statistics.BlocksCovered;
                    totalUncoveredBlocks += module.Statistics.BlocksNotCovered;
                }
            }

            return (totalCoveredBlocks == 0 && totalUncoveredBlocks == 0)
                                      ? 0.0
                                      : ((double) totalCoveredBlocks) /
                                        ((double) (totalCoveredBlocks + totalUncoveredBlocks));
        }
    }
}

编译项目并添加到 TFS 上的版本控制路径.

Compile the project and add to to a version controlled path on TFS.

在 Team Explorer 中，转到 Builds > Actions > Manage Build Controllers ....然后单击构建控制器的属性....在自定义程序集的版本控制路径下，输入您在上面使用的路径.

In Team Explorer, go to Builds > Actions > Manage Build Controllers .... Then click on Properties... for the build controller. Under Version control path to custom assemblies, put the path you used above.

将 BuildProcessTemplatesDefaultTemplate.11.1.xaml 复制到一个新文件.

Copy BuildProcessTemplatesDefaultTemplate.11.1.xaml to a new file.

更新新 XAML 文件的开头以包含以下内容:

Update the beginning of the new XAML file to include the following:

<Activity ...
          xmlns:ccl="clr-namespace:CodeCoverageLibrary;assembly=CodeCoverageLibrary"
          ...
          >
  <x:Members>
    ...
    <x:Property Name="CodeCoverageTolerance" Type="InArgument(x:Double)" />
  </x:Members>
  ...
  <this:Process.Metadata>
    <mtbw:ProcessParameterMetadataCollection>
      ...
      <mtbw:ProcessParameterMetadata BrowsableWhen="EditingDefinition" Category="#900 Misc" DisplayName="CodeCoverageTolerance" Description="If the overall code coverage drops below this threshold, then the build will fail. This is a number between 0 and 1." ParameterName="CodeCoverageTolerance" />
    </mtbw:ProcessParameterMetadataCollection>
  </this:Process.Metadata>

更新 XAML 文件的末尾以包含以下内容:

Update the end of the XAML file to include the following:

      <Sequence DisplayName="Code Coverage Check" mtbwt:BuildTrackingParticipant.Importance="None">
        <Sequence.Variables>
          <Variable x:TypeArguments="x:Double" Name="CodeCovered" />
        </Sequence.Variables>
        <ccl:GetCodeCoverage DisplayName="Getting Code Coverage" BuildDetail="[BuildDetail]" Result="[CodeCovered]" />
        <If Condition="[CodeCovered &lt; CodeCoverageTolerance]">
          <If.Then>
            <Sequence DisplayName="Comparing Code Coverage Against Tolerance">
              <mtbwa:SetBuildProperties DisplayName="Set TestStatus to Failed" mtbwt:BuildTrackingParticipant.Importance="Low" PropertiesToSet="TestStatus" TestStatus="[Microsoft.TeamFoundation.Build.Client.BuildPhaseStatus.Failed]" />
              <mtbwa:WriteBuildError Message="[&quot;Code Coverage of &quot; + CodeCovered.ToString(&quot;P&quot;) + &quot; is less than required &quot; + CodeCoverageTolerance.ToString(&quot;P&quot;)]" />
            </Sequence>
          </If.Then>
        </If>
      </Sequence>
    </mtbwa:AgentScope>
    <mtbwa:InvokeForReason DisplayName="Check In Gated Changes for CheckInShelveset Builds" Reason="CheckInShelveset">
      <mtbwa:CheckInGatedChanges DisplayName="Check In Gated Changes" />
    </mtbwa:InvokeForReason>
  </Sequence>
</Activity>

将此检查到 TFS.

在 Team Explorer 中，转到 Builds 并右键单击您的构建定义.转到编辑构建定义... > 过程.展开构建流程模板，然后单击新建....单击选择现有 XAML 文件，然后输入新 XAML 文件的路径.点击确定.您现在应该在 4 下看到 CodeCoverageTolerance.杂项.您可以输入一个介于 0 和 1 之间的数字来表示您想要的百分比.

In Team Explorer, go to Builds and right-click on your build definition. Go to Edit Build Definition... > Process. Expand Build process template and click New.... Click Select an existing XAML file and put the path to the new XAML file. Click OK. You should now see CodeCoverageTolerance under 4. Misc. You can put in a number between 0 and 1 to indicate your desired percentage.

这篇关于如果代码覆盖率低于 TFS2012 中的阈值，则构建失败的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持！

中的阈值