Android||SonarCodeCoverage问题与hilt(依赖注入)
-
问题描述：在使用SonarQube分析工具检查Android应用程序的代码时，使用hilt进行依赖注入会导致部分代码的覆盖率不准确或无法计算。这是由于hilt使用了一些AOP技术来生成代码，导致Sonar无法正确解析代码的执行情况。
-
解决方案：
- 方法1：手动添加代码覆盖率报告
可以手动将Hilt生成的代码添加到测试覆盖率报告中，以获得更准确的结果。具体步骤如下：
- 在 build.gradle 文件中添加如下依赖项：
dependencies { testImplementation "org.jacoco:org.jacoco.core:0.8.5" androidTestImplementation "org.jacoco:org.jacoco.core:0.8.5" }
- 在 app/build.gradle 文件中添加如下配置：
android { buildTypes { debug { testCoverageEnabled true } } }
- 运行测试，生成 JaCoCo 覆盖率报告：
./gradlew createDebugCoverageReport
该命令将在 app/build/reports/coverage/debug 目录下生成 coverage.ec 和 coverage.html 文件。
- 在 SonarQube 中配置 JaCoCo 报告：
在项目配置中，选择“Coverage”，然后添加“JaCoCo Coverage Report”并设置路径，如下所示：
sonar.coverage.jacoco.xmlReportPaths=app/build/reports/coverage/debug/report.xml
- 方法2：禁用 Sonar 的追踪策略
可以使用 Sonar 插件提供的配置选项来禁用 Sonar 的追踪策略，以避免无法正确解析应用程序的代码。具体步骤如下：
-
在 SonarQube 管理面板中选择选择项目的管理页面。
-
在“规则”页面中选择要禁用的规则，例如“S2885 – Issues should not be reported on test sources”。
-
禁用规则：
sonar.issue.ignore.multicriteria=E1,E2 sonar.issue.ignore.multicriteria.E1.ruleKey=S2885 sonar.issue.ignore.multicriteria.E1.resourceType=FILE sonar.issue.ignore.multicriteria.E1.scope=TEST sonar.issue.ignore.multicriteria.E2.ruleKey=SXXXX sonar.issue.ignore.multicriteria.E2.resourceType=FILE sonar.issue.ignore.multicriteria.E2.scope=MAIN
这将禁用“S2885 – Issues should not be reported on test sources”规则以及其他任何指定的规则。
- 重新分析代码。
以上两种方法都可以解决Sonar Code Coverage与hilt依赖注入的问题，