I am attempting to revive using Jacoco in a Kotlin multiplatform project. It is worse than pulling t...

# gradle

[pajatopmr]

I am attempting to revive using Jacoco in a Kotlin multiplatform project. It is worse than pulling teeth, given that 1) there is no Java or Application plugin in use that defines “jacocoTestReport”, 2) I am using Kotlin DSL so creating the task “jacocoTestReport” is non-trivial (for me anyway), 3) I am using Kotlin test (not Junit) which I’m guessing does not support Jacoco, and 4) the GooglePlex, Stack Overflow, Medium, etc. all are coming up empty for a simple example that illustrates what needs to be done. I would not be surprised at all to learn that it is even more complicated. In any case, a link to a project that has worked around the constraints I described would be much appreciated. Additional insight will also likely be invaluable.

[pajatopmr]

Please post responses to this thread. Thanks.

[gildor]

2. What do you mean? Could you share some sample?

[gildor]

Just to be clear, do you try to configure it for JVM part of your MPP project, right?

[pajatopmr]

I did not do anything specific to configure Jacoco for the JVM (only part right now other than common).

[pajatopmr]

This example, taken from an old Groovy script I found, was my starting point:

task jacocoJVMTestReport(type: JacocoReport) {
    //dependsOn = test
    group = “Reporting”
    description = “Generate Jacoco coverage report.”
    classDirectories = fileTree(dir: “$buildDir/classes/kotlin/jvm/main”)
    def coverageSourceDirs = [“src/commonMain/kotlin”, “src/jvmMain/kotlin”]
    additionalSourceDirs = files(coverageSourceDirs)
    sourceDirectories = files(coverageSourceDirs)
    executionData = files(“$buildDir/jacoco/jvmTest.exec”)
    reports {
        html.enabled = true
        xml.enabled = true
        csv.enabled = false
    }
}

[pajatopmr]

Mapping that to use Kotlin DSL and a multiplatform project has been difficult to say the least. But I am still at it while trying to find a version already converted and using MPP.

[pajatopmr]

@gildor do you have any insight into 3)?

[gildor]

Why do you convert it to Kotlin DSL if you not familiar with it? You can continue to use groovy, even move it to groovy script

[gildor]

I did some super fast test using kmath project and it works for me

[gildor]

But it uses standard kotlin org.jebrains.kotlin.test and org.jebrains.kotlin.test-junit

[gildor]

and this task above works for me

[gildor]

if you have some sampe project that uses kotlin.test, please share, I never used it, maybe it really has some problems, but as I understand how Jacoco works it shouldn’t be related

[gildor]

I pushed sample here:
https://github.com/gildor/kmath/blob/jacoco-test/kmath-core/build.gradle.kts

[gildor]

Also, check that you applied jacoco plugin, without it code instrumentation will not be applied so you cannot get reports

[gildor]

But again, this sample uses org.jebrains.kotlin.test + org.jebrains.kotlin.test-junit, but most probably it will work with kotlintest

[LeoColman]

I use Kotlintest and Jacoco, and they work correctly. I didn't try it with MPP, however

[LeoColman]

I don't think jacoco depends on how it's being executed, but KT uses JUnit to execute tests

[pajatopmr]

@LeoColman do you have a public repo where I can look at your build script?

[pajatopmr]

@gildor your kmath-core directory is helpful. However, jvmTest is unresolved in my build.gradle.kts when I copy the tasks {…} block from your kmath-core project. This makes no sense to me. Here’s my build script:

[gildor]

@pajatopmr Maybe you just share some sample that doesn’t work for you, because JVM only and MPP configs are pretty differnt, not sure how this would help you, especially if kotlintest uses Junit 5

[pajatopmr]

build.gradle.kts

[gildor]

However, jvmTest is unresolved in my build.gradle.kts

Because I use type safe accessors which available because I have custom plugin with basic config
Just use dynamic syntax:

named("jvmTest") {
  finalizeBy(coverage)
}

[gildor]

@pajatopmr Your config will not work, because you didn’t apply jacoco plugin
https://kotlinlang.slack.com/archives/C19FD9681/p1556503441047200?thread_ts=1556478196.043900&cid=C19FD9681

[gildor]

Also to configure finalizeBy you can do the same syntax as on line 68, named just does this lazy

[pajatopmr]

Hmmm I thought that apply happened automagically via using the plugins block.

[gildor]

I don’t see jacoco plugin in your plugins block

[pajatopmr]

My bad. I took it out and did not put it back. 😞

[pajatopmr]

Can you elaborate on fixing ‘finalizeBy’

[gildor]

replace:

jvmTest {
   finalizedBy(coverage)
}

With:

named("jvmTest") {
  finalizeBy(coverage)
}

[gildor]

you don’t need this line, if you don’t want to run coverage each time after test run

[pajatopmr]

That I did but now ‘finalizedBy’ is not resolved.

[pajatopmr]

got it now.

[gildor]

there is just a typo, finalizeBy -> finalizedBy

[gildor]

but as I said, it the same what you do in line 68, just using eager syntax:

tasks.get(name = "jvmTest").dependsOn += tasks.get(name = "copyTestResources")

[gildor]

you can combine those 2 configs

[gildor]

named(“jvmTest”) {
dependsOn(named(“copyTestResources”))
finalizedBy(coverage)
}

[pajatopmr]

And now I get coverage! Awesome. Thanks for the help.

[mben]

Hello i'm interested about this topic since i'm trying to also launch some test coverage for my commonTest module but couldn't get your solution to work since i'm having Task with name 'jvmTest' not found in project

[LeoColman]

I think jvmTest must be inside a kotlin block, isn't it?

[mben]

Nope my kotlin block looks like this

kotlin.kt

[mben]

so i have no clue on how to make it work

[gildor]

Of course you don't have jvmTest, because you don't have jvm as target platform, instead you have Android test tasks

[mben]

i'm not that good on gradle configuration and neither test coverage so if you could enlighten me i would be thankful

[mben]

my all build.gradle look like this it work well i can generate and use framework with cocoapods plugin and all my tests are inside a commonTest folder and now i wanted to try test coverage with jacoco that i never used before

build_gradle.kt

[gildor]

Do you understand that jacoco is JVM only tool?
There is also experimental K/N coverage tool

[mben]

you are talking about this one https://github.com/JetBrains/kotlin-native/blob/master/CODE_COVERAGE.md ?

[LeoColman]

nothing for MPP yet, I suppose?

[gildor]

Yes, this is coverage tool for K/N