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

11

我想在TFS Service(托管的TFS2012)中使构建失败,当代码覆盖率低于一个阈值时。

我一直在尝试应用这个解决方案:http://scrumdod.blogspot.co.uk/2011/04/fail-build-if-code-coverage-is-low.html

然而,我使用的是TFS2012,很多东西似乎已经改变了。特别是,测试运行的配置完全不同,无论是在构建过程模板还是在.runsettings文件中,都没有找到获取或设置.coverage文件的位置和名称的方法。

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

或者,是否有其他方法可以在代码覆盖率低于阈值时使构建失败?

3个回答

9
这需要几个步骤:
  1. 创建自定义构建活动
  2. 将该活动添加到构建控制器
  3. 在新的构建过程中调用该自定义构建活动
  4. 使用新的构建过程

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

在VS2012中创建一个新项目(我称之为CodeCoverageLibrary)。引用以下程序集:

  • Microsoft.TeamFoundation.Build.Client
  • Microsoft.TeamFoundation.Client
  • Microsoft.TeamFoundation.TestManagement.Client
  • Microsoft.TeamFoundation.WorkItemTracking.Client
  • System
  • System.Activities
  • System.Core
  • System.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 上的版本控制路径中。

2. 将此活动添加到构建控制器

在 Team Explorer 中,转到生成 > 操作 > 管理生成控制器......。然后单击构建控制器的属性...。在版本控制路径到自定义程序集下,输入您上面使用的路径。

3. 在构建过程中调用该自定义构建活动

BuildProcessTemplates\DefaultTemplate.11.1.xaml复制到一个新文件。

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

<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文件的结尾以包含以下内容:

      <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中。

4. 使用新的构建流程

在Team Explorer中,进入构建并右键单击您的构建定义,选择编辑构建定义... > 过程。展开构建流程模板,单击新建...。单击选择现有的XAML文件并输入新XAML文件的路径。单击确定。现在,在4. 杂项下应该会看到CodeCoverageTolerance。您可以输入0到1之间的数字来表示所需的百分比。


非常晚的回复,但我正在尝试在独立的.exe文件中使用GetCoverages。它一直给我tfsbuild blocks,并且给了我很多未覆盖的blocks:(。我能不能确保只获取我的项目文件呢? - Nicolai

0

关于上面的解决方案,只有一件事需要注意,你应该修改计算方式以确保返回一个保留两位小数的百分比值。

return (totalCoveredBlocks == 0 && totalUncoveredBlocks == 0)
                                  ? 0.0
                                  : Math.Round(((double)totalCoveredBlocks) /
                                    ((double)(totalCoveredBlocks + totalUncoveredBlocks)) * 100, 2);

0

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接