[Azure DevOps] 获取单元测试的代码覆盖率

1. 获取代码覆盖率

上一篇文章里,我们在 Pipeline 中插入一个单元测试并把所有单元测试都通过作为 Pipeline 通过的硬性要求。除此以外,我们还可以获取单元测试的代码覆盖率,用作衡量代码质量的指标。代码覆盖率没有一个标准,各个项目有各个项目的造化,不一定更高的单元测试覆盖率就代表项目的代码质量高。不过通过观察代码覆盖率的趋势也可以从另一个角度衡量项目的代码质量。

在 Azure Devops 有不同的方式生成代码覆盖率,例如使用 .NET Core CLI 编译项目的话可以参考这篇文章生成代码覆盖率:

【Azure DevOps系列】Azure DevOps生成代码覆盖率 - HueiFeng - 博客园

而在前面的文章里我都是使用 Visual Studio Build 编译并使用 Visual Studio Test 进行单元测试,那么事情就简单很多,只需在 VSTest 这个 task 的参数中加上 codeCoverageEnabled: true 即可,修改后的 YAML 如下:

- task: VSTest@2
  inputs:
    platform: '$(buildPlatform)'
    configuration: '$(buildConfiguration)'
    codeCoverageEnabled: true

如果是图形化的 Pipeline 编辑器,则需要在 VSTest 的配置中选中 Code coverage enabled

之后,在 Pipeline 的运行结果中可以看到代码覆盖率:

切换到 Code Coverage 页面,点击 Download code coverage results 可以下载代码覆盖率的详细结果:

这个代码覆盖率的详细结果可以在 Visual Studio 中打开查看:

2. 观察代码覆盖率的趋势

之前说了,我们应该关心代码覆盖率的趋势。Azure Devops 也提供了这种扩展。做左边菜单选中 Overview -> Dashboard,导航到项目的仪表板,点击 Edit 按钮进入编辑模式,然后点击右下角的 Extension Gallery 进入 marketplace。

搜索并进入 Code Coverage Protector 页面,点击 Get it free 按钮。

选中我们的组织并安装:

回到仪表板页面并刷新,进入编辑模式,找到 Code Coverage,点击 Add 按钮:

Size 选择一个 4 X 3,然后在 Build definition 选项选中用于单元测试的 Pipeline,点击 Save

重复一次上面的操作,这次 Size 选择 1 X 1 添加一个只有一格大小的图表。最终结果如下,左边的打的图表显示代码覆盖率的趋势,右边小的图表显示当前代码覆盖率:

可以看到这个项目最近几次提交的代码覆盖率明显下降了,说明这几次提交都没做好单元测试。

3. 最后

关于Visual Studio 测试的更多内容,可以参考以下文档:

Visual Studio 测试任务 - Azure Pipelines Microsoft Docs

Visual Studio 生成和发布任务 - Azure Pipelines Microsoft Docs

如使用 .NET Core CLI 编译项目的话可以参考以下文章:

【Azure DevOps系列】Azure DevOps生成代码覆盖率 - HueiFeng - 博客园

posted @ 2021-04-08 09:22  dino.c  阅读(190)  评论(1编辑  收藏