如何獲得測試覆蓋或忽略Jacoco的Kotlin數據類

Question

Jacoco對Kotlin的數據類別的覆蓋率為0％。 如何配置它來測量覆蓋率或忽略數據類？

Answer 1

我正在為數據模型類的自動生成代碼尋找相同測試覆蓋問題的解決方案，並偶然發現：
Kotlin + JaCoCo：調整編譯器以跳過生成的代碼

解決方案：將 JaCoCo插件更新為0.8.2並解決您的問題。

JaCoCo在0.8.2版本中解決了這個問題，請閱讀更改日志 -

• 在生成報告期間（GitHub＃731）過濾掉用簡單名稱為Generated的運行時可見和不可見注釋注釋的類和方法。
• 在生成報告期間，Kotlin編譯器添加的沒有行號的方法將被過濾掉。 Nikolay Krasko的理念和實施（GitHub＃689）。

Answer 2

有一個關於它的開放問題， 在這里 ，所以自動覆蓋過濾似乎是一項正在進行的工作。

編輯有一個拉動請求 （已接受）引入了生成的kotlin代碼的過濾。 它還沒有找到它進入發布的方式。 但到目前為止，人們已經在SNAPSHOT版本中測試了它，一切似乎都有效。

目前您最好的選擇是使用SNAPSHOT版本。

Answer 3

雖然它並沒有真正回答你的問題，但你可以通過編寫涵蓋數據類生成的函數的測試來完全覆蓋jacoco中的數據類。

例如，假設有一個包含一個var和一個val的數據類

data class MyDataClass(var s1: String, val s2: String)

當我運行jacoco時，我發現它正在測量MyDataClass生成的以下內容的覆蓋范圍：

• hashCode()
• equals(Object)
• toString()
• MyDataClass(String, String)
• copy(String, String)
• setS1(String)
• getS1()
• getS2()
• component1()
• component2()

涵蓋大部分內容的單元測試可能是：

 @Test
 fun testCodeCoverageForMyDataClass() {
     // call the constructor
     val tested = MyDataClass("original s1", "original s2").apply {
         // call the setters
         s1 = "new s1"

         // call the getters
         assertEquals("new s1 original s2", "$s1 $s2")

         // call toString()
         assertEquals("MyDataClass(s1=new s1, s2=original s2)", "$this")

         // call componentN() functions
         val (res1, res2) = this
         assertEquals("new s1 original s2", "$res1 $res2")
    }

    // call copy()
    val testedCopy = tested.copy(s2 = "new s2").apply {
        // call equals()
        assertNotEquals(this, tested)

        // call hashCode()
        assertNotEquals(this.hashCode(), tested.hashCode())
    }
}

我知道，這是一種痛苦，但在有支持之前，這有助於我完成覆蓋。

Answer 4

如果您將數據類放在特定包或特定文件中，則可以將它們從classDirectories排除。 在下面的示例中，我將數據類放在**/model/** ：

task kotlinJacocoTestReport(type: JacocoReport, dependsOn: 'test') {

    reports {
        html.enabled = true
        html.destination = "${buildDir}/reports/jacoco"
    }

    sourceDirectories = files(["${project.projectDir}/src/main/kotlin"])
    classDirectories = fileTree(dir: "${buildDir}/classes/kotlin/main", excludes: ['**/model/**'])
    executionData = files("${buildDir}/jacoco/test.exec")
}

Answer 5

使用插件，如下所示： 生成Kotlin插件

該插件通過在幕后添加@lombok.Generated注釋，從代碼覆蓋中刪除所有合成的Kotlin生成的代碼（自動獲取器和設置器，並且應該干凈地覆蓋您的數據類）。

請注意，您必須使用Jacoco 0.8或更高版本才能工作。