如何从测试覆盖范围中排除Dagger2类

Mla*_*jac 16 android jacoco android-testing android-studio dagger-2

是否有任何选项可以从Android Studio中的测试覆盖率报告中排除Dagger2类

mac*_*usz 15

JaCoCo排除

如果你正在使用JaCoCo,例如使用android instrumentation connected测试,你需要配置排除(或包括),根据文档是......

要从报告中排除的类文件列表.可以使用通配符(*和?).未指定时,不会排除任何内容.

这意味着您需要匹配生成的匕首类名称.以下规则几乎涵盖了由dagger-compiler任何未生成的类生成的任何类(除非您将类命名为与dagger相同...):

excludes = [
    '**/*_MembersInjector.class',
    '**/Dagger*Component.class', // covers component implementations
    '**/Dagger*Component$Builder.class', // covers component builders
    '**/*Module_*Factory.class'
]
Run Code Online (Sandbox Code Playgroud)

app/build/generated/source/apt运行构建后,您可以在目录中检查生成的dagger类,以查看是否有任何其他要生成的类与排除匹配.

这不包括数组是jacoco插件的配置属性.现在,放置此excludes数组的位置取决于您是基于jacoco插件定义自己的任务,还是使用为您执行此操作的"更高级别插件".例如,使用此插件(您可以看到插件源以查看实际应用排除的位置):

jacocoAndroidUnitTestReport {
  excludes +=  [
        '**/*_MembersInjector.class',
        '**/Dagger*Component.class',
        '**/Dagger*Component$Builder.class',
        '**/*Module_*Factory.class'
    ]
}
Run Code Online (Sandbox Code Playgroud)

连接测试

如果你通过设置运行Android连接测试覆盖率testCoverageEnabled true在buildType,遗憾的是没有声明习惯的方法排除,因为Android的gradle这个插件没有提供这样的选项,和预定义的jacoco报告任务具有硬编码的排除.在这种情况下,您必须使用排除编写自己的任务脚本.


IntelliJ测试运行器

如果您正在使用IntelliJ测试运行器,无论覆盖是由IntelliJ还是JaCoCo完成,您都需要将包含用于测试配置.

  1. 打开" 编辑配置"窗口:

编辑配置

  1. 选择您的测试配置并定义包含(类或整个包).在这种情况下,我包括整个com.google.android.gms包,仅作为示例:

测试范围包括

要排除 dagger生成的文件,最快的方法是将所有dagger依赖项放在一个根包中,并在测试配置中包含所有其他包.


com*_*m1x 10

从 AndroidStudio 索引中排除文件

许多天后,我找到了解决方案:IDE 索引中的排除文件也将它们从 IDE 的代码覆盖率报告中排除。
因此,我们需要为所有 codegen 文件(或仅 Dagger/Hilt 文件)创建新的文件类型,并从索引中排除此文件类型。

为了实现这一目标,您需要:

1. 为 codegen-files 创建新的文件类型“Codegen”

转到Preferences -> File Types,然后添加新文件类型Codegen: 创建新文件类型

添加此模板(模板将来可能会更改):

*_*Factory.java
*_ComponentTreeDeps.java
*_Factory.java
*_GeneratedInjector.java
*_HiltComponents.java
*_HiltModules.java
*_HiltModules_BindsModule.java
*_HiltModules_KeyModule.java
*_MembersInjector.java
*_ProvideFactory.java
*_SingletonC.java
*_TestComponentDataSupplier.java
BR.java
BuildConfig.java
DataBinderMapperImpl.java
Hilt_*.java
_test_*.java
Run Code Online (Sandbox Code Playgroud)

2. 从索引中排除“Codegen”

打开Go to File,选择选项卡Files,然后单击Filter并取消选中Codegen文件类型。 取消选中代码生成器

就这样!

此后,当您运行代码覆盖率测试(使用 IntelliJ IDEA 运行程序)时,匹配的 Codegen 文件也将从 IDE 中的代码覆盖率报告中排除。


注意:使用这种方法,您无法从 CLI 获得覆盖。如果您需要 CLI 的覆盖 - 使用 Jacoco。

  • 甜蜜:)我刚刚添加了 *_*.java 因为我只用 kotlin 编写:D (2认同)

fri*_*mle 5

Dagger 的最新版本会生成模式略有不同的其他文件。使用 Dagger 2.15 时,我成功排除了以下内容

'**/*_MembersInjector.class',
'**/Dagger*Component*.class',
'**/Dagger*Subcomponent*.class',
'**/*Subcomponent$Builder.class',
'**/*Module_*Factory.class',
Run Code Online (Sandbox Code Playgroud)