跳到主要内容
版本:2.4

代码质量

引入于极狐星TowerFox 1.7;"测试覆盖率门禁" 依赖极狐GitLab 版本:专业版 14.10;依赖 GitLab 版本:Premium 14.10;其余功能无极狐GitLab 和 GitLab 版本依赖。

代码质量是指软件代码的可读性、准确性、稳定性、安全性、健壮性、可维护性、可扩展性、可测试性和可重用性等方面的综合表现。高质量的代码可以在满足产品需求的同时,具有高度的稳定性、扩展性、易读性和可重用性等,最大限度避免各种错误和异常。 好的代码质量可以提高软件产品的质量,减少开发和维护的成本和时间,并提高软件的整体性能和用户满意度。

极狐星TowerFox 使用开源的 Code Climate 工具分析源代码的质量和复杂性,您可以在页面中清晰地查看项目或群组的代码质量问题。通过分析问题出现的原因,您可以采取措施避免问题重复出现,进而显著提升项目或群组的代码质量。

代码质量页面主要由四个部分组成:

  • 筛选器
  • 代码质量问题图表
  • 测试覆盖率门禁图表
  • 平均代码测试覆盖率百分比图

筛选器

您可以通过筛选器查看特定时间段内项目或群组中源代码的质量问题。

  • 时间:最近 7/14/30/60/90/180 天:过去 7/14/30/60/90/180 天代码质量的统计数据。您也可以自定义时间段查看相应群组或项目的代码质量数据。起止时间间隔最大为 180 天。

  • 群组或项目:您可以查看特定群组或项目的代码质量情况,群组或项目支持多选。

  • 成员:您还可以查看特定成员在筛选时间、项目或群组内的代码质量问题,成员支持多选。

代码质量问题图表

代码质量问题通过柱状图或列表的形式展示筛选时间段内的代码质量问题,包括总代码质量问题数和平均每日代码质量问题数。

支持以每日、每周和每月的维度进行查看。您可以选择右上角的图标进行柱状图和列表的切换。

当以列表形式呈现时,页面会展示代码质量问题的出现时间、所属项目、问题级别、问题描述、问题位置、创建人员和合并人员等。点击问题位置链接可以定位到代码仓库中的具体位置以查看问题详情。

测试覆盖率门禁图表

测试覆盖率是指在软件测试过程中,用测试用例覆盖测试目标的比例。它可以通过代码行覆盖率、函数覆盖率、分支覆盖率等指标来衡量。 测试覆盖率门禁通过设置一个测试覆盖率门限值,检查实际的软件测试覆盖率是否达标。

较高的软件测试覆盖率可以尽可能地发现软件中存在的各种问题和异常,避免软件运行出现错误和漏洞,提高软件的可靠性和稳定性,增加软件用户的信任感和认可度,最终提升软件的市场竞争力。 同时,高的软件测试覆盖率也可以减少软件开发和维护的成本和时间,提高开发效率和质量。

测试覆盖率门禁通过曲线图或列表的形式展示筛选时间段内的测试覆盖率门禁被触发的情况,包括总测试覆盖率门禁、平均每日门禁次数和平均每日测试覆盖率。

支持以每日、每周和每月的维度进行查看。您可以选择右上角的图标进行柱状图和列表的切换。

当以列表形式呈现时,页面会展示测试覆盖率门禁的触发时间、所属项目、所属合并请求、创建人员、合并人员和测试覆盖率等。点击项目和合并请求链接可以定位到具体位置以查看详情。

平均代码测试覆盖率百分比图

平均代码测试覆盖率通过百分比环状图展示项目或群组中源代码的平均测试覆盖率。

代码质量视图

极狐星TowerFox 代码质量支持多个视图的保存和展示。如果您需要保留某个项目或群组中特定时间或人员的视图以便后续使用,您可以点击页面右上角的 存为新视图 进行保存。

保存视图时,您需要输入视图名称并选择视图类型。视图分为仅个人可见的个人视图和所有成员可见的公共视图。 保存成功后,您可以点击页面上方的视图展开图标查看所有保存的视图。您还可以点击视图名称,在右侧出现的操作图标中进行编辑、复制、删除或设为默认打开视图。

用户设置默认打开视图后,每次打开效能管理的代码质量页面时系统都会展示默认视图,且默认视图的名称会展示在系统视图列表中的第一个。如果用户没有设置默认打开视图,则每次进入代码质量页面时都会展示系统视图列表中的第一个视图。

代码质量视图

导出数据

极狐星TowerFox 代码质量支持导出多种类型的数据,以供用户后续查看分析。导出数据支持以下五种类型:

  • 代码质量问题统计图
  • 代码质量问题详情表
  • 测试覆盖率门禁统计图
  • 测试覆盖率门禁详情表
  • 代码测试覆盖率图

导出数据:

  1. 登录进入极狐星TowerFox。
  2. 在左侧边栏中,选择 效能管理 > 代码质量
  3. 在筛选器中输入您需要的筛选条件。
  4. 选择右上角的下载图标。
  5. 选择您需要的数据类型,类型支持多选。
  6. 选择 导出为 CSV