SonarQube扫描报错行超出范围:合并master后文件适配问题
咱们先把问题捋清楚:你的Python项目里,master分支的fileA有1000行,feature分支的同文件是1050行。CI流水线先在feature分支上跑coverage生成coverage.xml,然后SQ预览阶段会切到master,合并feature分支(不提交、不快进),再跑扫描。结果合并后fileA又变回1000行,但覆盖率报告里记录了1000行以上的行号,直接导致SQ报错:
ERROR: Error during SonarQube Scanner execution java.lang.IllegalStateException: Line 1040 is out of range in the file path/to/fileA.py (lines: 1000)
本质原因很明确:覆盖率数据是基于feature分支的文件状态生成的,但SonarQube扫描的却是master和feature合并后的代码,两者行数对不上,SQ自然找不到报告里的行号。
下面给你几个可行的解决思路,按推荐程度排序:
方案一:调整流水线顺序,在合并后的代码上生成覆盖率报告
这是最彻底的解决方式,让覆盖率数据和扫描的代码版本完全对齐:
修改CI流水线的步骤顺序:
- 先执行
git checkout origin/master - 执行
git merge $CI_BUILD_REF --no-commit --no-ff完成分支合并 - 基于合并后的代码运行coverage工具,生成最新的
coverage.xml - 最后执行sonar-scanner预览扫描
这样一来,覆盖率报告和扫描的代码是同一个版本,行号完全匹配,从根源解决问题。唯一需要注意的是,如果合并后有代码冲突或者依赖问题,要确保CI能处理(比如提前在合并步骤处理冲突,或者让开发在提交前解决冲突)。
方案二:直接扫描feature分支,跳过合并步骤
如果你的SQ预览扫描不需要基于合并到master后的代码状态,那可以简化步骤,直接在feature分支上运行扫描:
去掉原来的git checkout和git merge步骤,直接执行sonar-scanner:
- sonar-scanner -Dsonar.analysis.mode=preview -Dsonar.gitlab.project_id=$CI_PROJECT_PATH -Dsonar.login=$SONARQUBE_TOKEN -Dsonar.gitlab.commit_sha=$CI_COMMIT_SHA -Dsonar.gitlab.ref_name=$CI_COMMIT_REF_NAME
这个方案步骤更简洁,不需要处理合并操作,但前提是你的预览扫描目标就是feature分支本身,而不是合并到master后的效果。
方案三:临时排除报错文件(应急用)
如果上面两个方案暂时没法实施,比如CI流水线修改需要审批,那可以先临时排除有问题的文件,保证扫描能正常完成:
在sonar-scanner命令里添加排除参数:
- sonar-scanner -Dsonar.analysis.mode=preview -Dsonar.gitlab.project_id=$CI_PROJECT_PATH -Dsonar.login=$SONARQUBE_TOKEN -Dsonar.gitlab.commit_sha=$CI_COMMIT_SHA -Dsonar.gitlab.ref_name=$CI_COMMIT_REF_NAME -Dsonar.coverage.exclusions=path/to/fileA.py
这个方法能快速解决报错,但代价是该文件的覆盖率数据会被忽略,适合临时应急,不推荐长期使用。
内容的提问来源于stack exchange,提问作者pkaramol

