commonTest should be skipped

[mustafaozhan]

Hello 👋

Currently kover calculates the coverages for the test classes in commonTest in Kotlin Multiplatform projects. It should skip the test folders. If it is not possible we should have option to exclude files by directory currently only package option is available.

In Android module test folder is already skipped, we should have the same behavior for KMP projects for commonTest folder. It causes unfair coverage increase.

[shanshin]

Hi,
may you clarify, do you want the Kover report not to take into account the coverage of tests that are located in commonTest?

[mustafaozhan]

@shanshin yeap exactly, it is done automatically for android apps/libraries for test folder, but the equivalent folder is called commonTest in multiplatform libraries, so we should not take them in account when we calculate the overall coverage.

Note: Even though it can be super edge case, there are also jvmTest iosTest jsTest... folders in Multiplatform libraries, depends on which platforms you enable, so preferably the solution should include every possible test folders.

[shanshin]

At the moment, there is no way to disable the use of tests from a specific source set.
As a workaround, you may arrange all tests from the commonTest in an individual package and exclude its contents from instrumentation.

[shanshin]

@mustafaozhan, I would also like to clarify, the classes from commonTest were included in the HTML report?

[mustafaozhan]

Hello @shanshin thank you for your answers!

As a workaround, you may arrange all tests from the commonTest in an individual package and exclude its contents from instrumentation.

Unfortunately, this will require different setup for each module maybe we need a more general workaround, I tried adding below code into root build.gradle but it didn't work, do you have any suggestion ?

koverMerged {
    enable()
    filters {
        classes {
            excludes += listOf(
                "*Test",
                "*.*Test",
                "*.*.*Test",
                "*.*.*.*Test",
                "*.*.*.*.*Test"
            )
        }
    }
}

@mustafaozhan, I would also like to clarify, the classes from commonTest were included in the HTML report?

Yes I can see these classes both in xml and html reports.

[shanshin]

This is definitely a bug, classes from test source sets should not get into the report.

[mustafaozhan]

@shanshin Thank you for your answer, I agree with you, test sources should be excluded

Also, I think the workaround I have posted should work too, I will create a separate issue for that.

Created issue: #252

[hoc081098]

I have the same issue. excludes does not work (#252)

android {
 testOptions {
    unitTests {
      isReturnDefaultValues = true
      all {
        if (it.name == "testDebugUnitTest") {
          it.extensions.configure<kotlinx.kover.api.KoverTaskExtension>() {
            isDisabled.set(false)
            excludes.addAll(
              "hilt_aggregated_deps.*",
              "io.mockative.*"
            )
          }
        }
      }
    }
  }
}

[shanshin]

Fixed in 0.7.0-Alpha