文档

质量规则

更新时间:

本文主要介绍质量规则涉及的指标项、质量分统计规则以及质量分更新时机。

说明

您可以在应用详情中,对质量规则进行配置。

指标项

在迭代详情页的 代码分数 栏,可看到各项指标值。点击具体指标值,可查看指标详情。更新时机

  • 质量分:质量分的统计要素包括 PMD-1、PMD-2、安全问题、代码行、测试通过率、接口注释率、代码重复度、行覆盖率。

  • 行覆盖率:自动化测试用例的全量代码的行覆盖率,计算规则:行覆盖率 = 自动化测试用例的测试覆盖行(具有相同行号的代码算一行)/总行数。

  • 变更行覆盖率:

    • 自动化测试用例的本迭代变更代码的行覆盖率。如发生变更的代码行为注释,则不属于变更行。

    • 迭代分支统计范围:起始版本为 master 。即统计本次迭代变更的代码。

    • 集成分支(master)统计范围:起始版本为最新 tag。即统计本次发布变更的代码。

    • 点击之后展示变更覆盖率详情。

  • 测试通过率:指自动化测试通过率。若没有集成测试,则取单元测试;若有集成测试,则取集成测试。

  • 行覆盖率(自动):指集成测试用例的全量代码行覆盖率。

  • 分支覆盖率(自动):指集成测试用例的全量代码的分支覆盖(又称判定覆盖)率。

说明
  • 以上的集成测试、单元测试指的是集成测试组件、单元测试组件。

  • 质量规则修改并保存后,对所有迭代立即生效。

质量分统计规则

质量分计算公式:质量分 = 5 * (1 - PMD-1/代码总行数 * 1000) + 5 * (1 - PMD-2/代码总行数 * 1000) + 5 * 接口注释率 + 5 * 测试通过率 + 10 * (1 - (代码重复度 - 5.0) / 100 / 0.05) + 10 * (1 - 安全问题/代码总行数 * 1000) + 10 * 行覆盖率

  • PMD-1:每千行出现 1 个,扣 5 分;如果此项得分小于 0 分,总分中 PMD-1 的质量贡献得分算 0 分。PMD-1 权值为 5 分。

  • PMD-2:每千行出现 1 个,扣 1 分;如果此项得分小于 0 分,总分中 PMD-2 的质量贡献得分算 0 分。PMD-2 权值为 5 分。

  • API 注释得分 = API 注释% * 权重。API 注释覆盖率权值为 5 分。

  • 行覆盖得分 = 行覆盖% * 权重,1 级系统低于 50% 预警。行覆盖率权值为 10 分。

  • TestCase 成功率得分 = TestCase% * 权重。TestCase 成功率权值为 5 分。

  • 代码重复度得分:如果代码行重复度 <=5%,则为满分;如果代码行重复度 >=10%,则为零分;代码行重复度每增加 1% 扣 20%。代码重复率权值为 10 分。

  • 安全白盒扫描:每千行出现 1 个,扣 10 分;如果此项得分小于 0 分,总分中安全白盒扫描的质量贡献得分算 0 分;未反馈安全问题权值为 10 分。

说明

针对每一项质量指标计算的质量分若为负数,则取 0,其中若代码重复度小于或等于 5,则计 10 分。

下面是质量分详情示例。质量分计算公式各因子后的括号内“()”标注了该项值。

质量分

更新时机

质量分会在 Pipeline 结束时自动更新(失败或者成功之后更新)。

  • 本页导读 (0)