项目代码质量检查服务codecheck

项目代码质量检测流程

1. 确保服务开启

  • “项目代码质量检查服务”仅对指定用户开启，系统管理员登录并访问管理>网站配置>系统配置>全局变量配置列表，给变量名 open_huawei_check_users 添加需要开启服务的 user_id 。
  • 未开启“项目代码质量检查服务”的用户，在仓库服务tab下不可见“项目代码质量检查服务”。
  • 用户访问仓库服务tab，接口 /api/v1/{repo_owner}/{repo_identifier}/code_checks 返回 true 表示用户开启了“项目代码质量检查服务”。
  • 用户访问仓库服务tab，接口 /api/v1/{repo_owner}/{repo_identifier}/code_checks 返回 false 表示用户未开启“项目代码质量检查服务”。

权限说明：

  • 仓库管理员/开发者可以访问“服务”tab，已开启 “项目代码质量检查服务”的用户可使用“项目代码质量检查服务”；
  • 仓库管理员/开发者可以访问“服务”tab，未开启“项目代码质量检查服务”的用户不可见且不可使用“项目代码质量检查服务”，不可通过路由直接访问；
  • 仓库报告者可以访问“服务”tab，但不可见且不可使用“项目代码质量检查服务”，不可通过路由直接访问；
  • 非项目成员不可见“服务”tab，且无法通过路由访问；

img_01.png img_01.png

2. 开始检查

前提条件：仓库未进行“项目代码质量检查服务”

  1. 用户访问服务tab， 在“项目代码质量检查服务”点击“查看详情”，跳转到“项目代码质量检查服务”欢迎页 img_02.png img_02.png

  2. 点击“开始检查”，弹出“项目代码质量检查服务”弹窗，选择需要检查的分支，点击“开始检查”按钮 img_03.png img_03.png

  3. 系统自动开始检测，期间页面不能手动刷新，等待检测完成 img_04.png img_04.png

3. 查看检查结果

  1. 检测完成后，页面显示检测结果，默认进入概览页 img_05.png img_05.png

  2. 点击“代码问题”，默认显示所有状态所有级别的问题

  • 支持单个筛选：通过问题状态（待处理/已解决/已忽略/已修复）对问题进行筛选
  • 支持单个筛选：通过问题级别（致命/严重/一般/提示）对问题进行筛选
  • 支持组合筛选：选择多个问题类别和多个问题级别对问题进行筛选
  • 支持复制文件路径
  • 支持查看问题所在代码行数
  • 支持点击“问题帮助”，右侧展开弹窗查看如何正确处理该问题
  • 支持选择单个问题，调整问题状态
  • 支持勾选多个同状态问题，批量调整问题状态 img_06.png img_06.png
  1. 点击“代码度量”，默认显示 文件圈复杂度的所有数据
  • 支持复制文件路径
  • 支持单个筛选：通过文件圈复杂度（<=5/>5）对文件进行筛选
  • 支持单个筛选：通过文件代码重复率（<=15%/>15%）对文件进行筛选 img_07.png img_07.png
  1. 在“代码度量”页面，点击“注释率”数值，可查看文件的注释率 img_08.png img_08.png

重新检查

前提条件：仓库已经进行“项目代码质量检查服务”，有检测结果

  1. 用户访问服务tab， 在“项目代码质量检查服务”点击“查看详情”，跳转到当次检查结果预览页面
  2. 点击“重新检查”，系统自动对当前分支进行重新检测，检测完成后，返回最新的检测结果

再次开始检查

前提条件：仓库已经进行“项目代码质量检查服务”，有检测结果

  1. 用户访问服务tab， 在“项目代码质量检查服务”点击“查看详情”，跳转到当次检查结果预览页面
  2. 点击“开始检查”，弹出“项目代码质量检查服务”弹窗，选择需要检查的分支，点击“开始检查”按钮
  3. 系统自动开始检测，期间页面不能手动刷新，等待检测完成
  4. 检测完成后，页面显示最新的检测结果，原有检测结果被覆盖

问题状态说明

  • 检测完成后，发现的问题状态默认是“待处理”，用户可以手动调整为“已解决”和“已忽略”。
  • 用户根据发现的问题，对代码进行实际处理后，再次点击“重新检查”进行检测，此时系统将上次检测结果与当次检查结果进行比对，发现上次的问题已被处理，此时该问题就会更新状态为“已修复”。