Added project filter for reports

shanshin · web-flow · commit 742d2abe7cd4 · 2024-05-03T21:33:11.000+02:00
Resolves #584 PR #604
diff --git a/kover-gradle-plugin/api/kover-gradle-plugin.api b/kover-gradle-plugin/api/kover-gradle-plugin.api
@@ -172,6 +172,7 @@ public abstract interface class kotlinx/kover/gradle/plugin/dsl/KoverReportFilte
 	public abstract fun classes (Lorg/gradle/api/provider/Provider;)V
 	public abstract fun classes ([Ljava/lang/String;)V
 	public abstract fun classes ([Lorg/gradle/api/provider/Provider;)V
+	public abstract fun getProjects ()Lorg/gradle/api/provider/SetProperty;
 	public abstract fun packages (Ljava/lang/Iterable;)V
 	public abstract fun packages (Lorg/gradle/api/provider/Provider;)V
 	public abstract fun packages ([Ljava/lang/String;)V
diff --git a/kover-gradle-plugin/src/functionalTest/kotlin/kotlinx/kover/gradle/plugin/test/functional/cases/ReportProjectFilterTests.kt b/kover-gradle-plugin/src/functionalTest/kotlin/kotlinx/kover/gradle/plugin/test/functional/cases/ReportProjectFilterTests.kt
@@ -0,0 +1,109 @@
+/*
+ * Copyright 2017-2023 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
+ */
+
+package kotlinx.kover.gradle.plugin.test.functional.cases
+
+import kotlinx.kover.gradle.plugin.test.functional.framework.configurator.BuildConfigurator
+import kotlinx.kover.gradle.plugin.test.functional.framework.starter.SlicedGeneratedTest
+
+internal class ReportProjectFilterTests {
+    private val subprojectPath = ":common"
+
+    @SlicedGeneratedTest(allLanguages = true)
+    fun BuildConfigurator.testInclude() {
+        addProjectWithKover(subprojectPath) {
+            sourcesFrom("multiproject-common")
+        }
+
+        addProjectWithKover {
+            sourcesFrom("multiproject-user")
+            dependencyKover(subprojectPath)
+
+            kover {
+                reports {
+                    filters {
+                        includes {
+                            // show classes only from ':common' project
+                            projects.add(":c?m*")
+                        }
+                    }
+                }
+            }
+        }
+
+        run(":koverXmlReport") {
+            xmlReport {
+                classCounter("org.jetbrains.CommonClass").assertCovered()
+                classCounter("org.jetbrains.CommonInternalClass").assertCovered()
+                classCounter("org.jetbrains.UserClass").assertAbsent()
+            }
+        }
+    }
+
+    @SlicedGeneratedTest(allLanguages = true)
+    fun BuildConfigurator.testExclude() {
+        addProjectWithKover(subprojectPath) {
+            sourcesFrom("multiproject-common")
+        }
+
+        addProjectWithKover {
+            sourcesFrom("multiproject-user")
+            dependencyKover(subprojectPath)
+
+            kover {
+                reports {
+                    filters {
+                        excludes {
+                            // exclude classes from ':common' project
+                            projects.add(":c?m*")
+                        }
+                    }
+                }
+            }
+        }
+
+        run(":koverXmlReport") {
+            xmlReport {
+                classCounter("org.jetbrains.CommonClass").assertAbsent()
+                classCounter("org.jetbrains.CommonInternalClass").assertAbsent()
+                classCounter("org.jetbrains.UserClass").assertCovered()
+            }
+        }
+    }
+
+    @SlicedGeneratedTest(allLanguages = true)
+    fun BuildConfigurator.testIncludeAndExclude() {
+        addProjectWithKover(subprojectPath) {
+            sourcesFrom("multiproject-common")
+        }
+
+        addProjectWithKover {
+            sourcesFrom("multiproject-user")
+            dependencyKover(subprojectPath)
+
+            kover {
+                reports {
+                    filters {
+                        includes {
+                            // include all projects
+                            projects.add(":*")
+                        }
+                        excludes {
+                            // exclude classes from ':' project
+                            projects.add(":")
+                        }
+                    }
+                }
+            }
+        }
+
+        run(":koverXmlReport") {
+            xmlReport {
+                classCounter("org.jetbrains.CommonClass").assertCovered()
+                classCounter("org.jetbrains.CommonInternalClass").assertCovered()
+                classCounter("org.jetbrains.UserClass").assertAbsent()
+            }
+        }
+    }
+}
diff --git a/kover-gradle-plugin/src/main/kotlin/kotlinx/kover/gradle/plugin/appliers/tasks/VariantReportsSet.kt b/kover-gradle-plugin/src/main/kotlin/kotlinx/kover/gradle/plugin/appliers/tasks/VariantReportsSet.kt
@@ -213,7 +213,8 @@ internal class VariantReportsSet(
         return project.provider {
             ReportFilters(
                 includesImpl.classes.get(), includesImpl.annotations.get(),
-                excludesImpl.classes.get(), excludesImpl.annotations.get()
+                excludesImpl.classes.get(), excludesImpl.annotations.get(),
+                includesImpl.projects.get(), excludesImpl.projects.get(),
             )
         }
     }
diff --git a/kover-gradle-plugin/src/main/kotlin/kotlinx/kover/gradle/plugin/commons/Artifacts.kt b/kover-gradle-plugin/src/main/kotlin/kotlinx/kover/gradle/plugin/commons/Artifacts.kt
@@ -11,6 +11,7 @@ import java.io.Serializable
  * The contents of a single Kover artifact.
  */
 internal class ArtifactContent(
+    val path: String,
     val sources: Set<File>,
     val outputs: Set<File>,
     val reports: Set<File>
@@ -26,16 +27,21 @@ internal class ArtifactContent(
             reports += it.reports
         }
 
-        return ArtifactContent(sources, outputs, reports)
+        return ArtifactContent(path, sources, outputs, reports)
     }
 
     fun existing(): ArtifactContent {
         return ArtifactContent(
+            path,
             sources.filter { it.exists() }.toSet(),
             outputs.filter { it.exists() }.toSet(),
             reports.filter { it.exists() }.toSet()
         )
     }
+
+    companion object {
+        val Empty = ArtifactContent("", emptySet(), emptySet(), emptySet())
+    }
 }
 
 
@@ -47,22 +53,24 @@ internal fun ArtifactContent.write(artifactFile: File, rootDir: File) {
     val outputs = outputs.joinToString("\n") { it.toRelativeString(rootDir) }
     val reports = reports.joinToString("\n") { it.toRelativeString(rootDir) }
 
-    artifactFile.writeText("$sources\n\n$outputs\n\n$reports")
+    artifactFile.writeText("$path\n$sources\n\n$outputs\n\n$reports")
 }
 
 /**
  * Read Kover artifact content from the file.
  */
 internal fun File.parseArtifactFile(rootDir: File): ArtifactContent {
-    if (!exists() || !name.endsWith(".artifact")) return ArtifactContent(emptySet(), emptySet(), emptySet())
+    if (!exists() || !name.endsWith(".artifact")) return ArtifactContent.Empty
 
     val iterator = readLines().iterator()
+    val projectPath = iterator.next()
+    if (!projectPath.startsWith(':')) return ArtifactContent.Empty
 
     val sources = iterator.groupUntil { it.isEmpty() }.map { rootDir.resolve(it) }.toSet()
     val outputs = iterator.groupUntil { it.isEmpty() }.map { rootDir.resolve(it) }.toSet()
     val reports = iterator.groupUntil { it.isEmpty() }.map { rootDir.resolve(it) }.toSet()
 
-    return ArtifactContent(sources, outputs, reports)
+    return ArtifactContent(projectPath, sources, outputs, reports)
 }
 
 private fun <T> Iterator<T>.groupUntil(block: (T) -> Boolean): List<T> {
diff --git a/kover-gradle-plugin/src/main/kotlin/kotlinx/kover/gradle/plugin/commons/Types.kt b/kover-gradle-plugin/src/main/kotlin/kotlinx/kover/gradle/plugin/commons/Types.kt
@@ -75,7 +75,11 @@ internal data class ReportFilters(
     @get:Input
     val excludesClasses: Set<String> = emptySet(),
     @get:Input
-    val excludesAnnotations: Set<String> = emptySet()
+    val excludesAnnotations: Set<String> = emptySet(),
+    @get:Input
+    val includeProjects: Set<String> = emptySet(),
+    @get:Input
+    val excludeProjects: Set<String> = emptySet(),
 ): Serializable
 
 internal open class VerificationRule @Inject constructor(
diff --git a/kover-gradle-plugin/src/main/kotlin/kotlinx/kover/gradle/plugin/dsl/KoverReportsConfig.kt b/kover-gradle-plugin/src/main/kotlin/kotlinx/kover/gradle/plugin/dsl/KoverReportsConfig.kt
@@ -13,6 +13,7 @@ import org.gradle.api.file.DirectoryProperty
 import org.gradle.api.file.RegularFileProperty
 import org.gradle.api.provider.Property
 import org.gradle.api.provider.Provider
+import org.gradle.api.provider.SetProperty
 
 /**
  * Configuration of Kover reports.
@@ -467,6 +468,7 @@ public interface KoverReportFiltersConfig {
      *      classes("com.example.FooBar?", "com.example.*Bar")
      *      packages("com.example.subpackage")
      *      annotatedBy("*Generated*")
+     *      projects.add(":my:lib*")
      *  }
      *  ```
      * Excludes have priority over includes.
@@ -481,6 +483,7 @@ public interface KoverReportFiltersConfig {
      *  includes {
      *      classes("com.example.FooBar?", "com.example.*Bar")
      *      packages("com.example.subpackage")
+     *      projects.add(":my:lib*")
      *  }
      *  ```
      * Excludes have priority over includes.
@@ -500,6 +503,7 @@ public interface KoverReportFiltersConfig {
  *          val somePackages =
  *          packages(listOf("foo.b?r", "com.*.example"))
  *          annotatedBy("*Generated*", "com.example.KoverExclude")
+ *          projects.add(":my:lib*")
  *      }
  * ```
  */
@@ -672,6 +676,19 @@ public interface KoverReportFilter {
      */
     public fun annotatedBy(vararg annotationName: Provider<String>)
 
+    /**
+     * Add all classes in specified project. Only the project path is used (starts with a colon).
+     *
+     * It is acceptable to use `*` and `?` wildcards,
+     * `*` means any number of arbitrary characters (including no chars), `?` means one arbitrary character.
+     *
+     * Example:
+     * ```
+     *  projects.add(":my:lib*")
+     * ```
+     */
+    val projects: SetProperty<String>
+
     /**
      * Add all classes generated by Android plugin to filters.
      *
diff --git a/kover-gradle-plugin/src/main/kotlin/kotlinx/kover/gradle/plugin/dsl/internal/ReportsImpl.kt b/kover-gradle-plugin/src/main/kotlin/kotlinx/kover/gradle/plugin/dsl/internal/ReportsImpl.kt
@@ -326,11 +326,13 @@ internal abstract class KoverReportFilterImpl: KoverReportFilter {
     internal fun extendsFrom(other: KoverReportFilterImpl) {
         classes.addAll(other.classes)
         annotations.addAll(other.annotations)
+        projects.addAll(other.projects)
     }
 
     internal fun clean() {
         classes.empty()
         annotations.empty()
+        projects.empty()
     }
 
     private fun String.packageAsClass(): String = "$this.*"
diff --git a/kover-gradle-plugin/src/main/kotlin/kotlinx/kover/gradle/plugin/tasks/reports/AbstractKoverReportTask.kt b/kover-gradle-plugin/src/main/kotlin/kotlinx/kover/gradle/plugin/tasks/reports/AbstractKoverReportTask.kt
@@ -4,6 +4,7 @@
 
 package kotlinx.kover.gradle.plugin.tasks.reports
 
+import kotlinx.kover.features.jvm.KoverFeatures
 import kotlinx.kover.gradle.plugin.commons.*
 import kotlinx.kover.gradle.plugin.tools.*
 import org.gradle.api.*
@@ -38,8 +39,8 @@ internal abstract class AbstractKoverReportTask : DefaultTask() {
     @get:InputFiles
     @get:PathSensitive(PathSensitivity.RELATIVE)
     internal val externalSources: Provider<Set<File>> = externalArtifacts.elements.map {
-        val content = ArtifactContent(emptySet(), emptySet(), emptySet())
-        content.joinWith(it.map { file -> file.asFile.parseArtifactFile(rootDir) }).sources
+        val content = ArtifactContent.Empty
+        content.joinWith(it.map { file -> file.asFile.parseArtifactFile(rootDir).filterProjectSources() }).sources
     }
 
     /**
@@ -48,8 +49,8 @@ internal abstract class AbstractKoverReportTask : DefaultTask() {
     @get:InputFiles
     @get:PathSensitive(PathSensitivity.RELATIVE)
     internal val externalReports: Provider<Set<File>> = externalArtifacts.elements.map {
-        val content = ArtifactContent(emptySet(), emptySet(), emptySet())
-        content.joinWith(it.map { file -> file.asFile.parseArtifactFile(rootDir) }).reports
+        val content = ArtifactContent.Empty
+        content.joinWith(it.map { file -> file.asFile.parseArtifactFile(rootDir).filterProjectSources() }).reports
     }
 
     /**
@@ -58,7 +59,7 @@ internal abstract class AbstractKoverReportTask : DefaultTask() {
     @get:InputFiles
     @get:PathSensitive(PathSensitivity.RELATIVE)
     internal val localSources: Provider<Set<File>> = localArtifact.map {
-        it.asFile.parseArtifactFile(rootDir).sources
+        it.asFile.parseArtifactFile(rootDir).filterProjectSources().sources
     }
 
     /**
@@ -67,7 +68,7 @@ internal abstract class AbstractKoverReportTask : DefaultTask() {
     @get:InputFiles
     @get:PathSensitive(PathSensitivity.RELATIVE)
     internal val localReports: Provider<Set<File>> = localArtifact.map {
-        it.asFile.parseArtifactFile(rootDir).reports
+        it.asFile.parseArtifactFile(rootDir).filterProjectSources().reports
     }
 
     @get:Nested
@@ -94,8 +95,29 @@ internal abstract class AbstractKoverReportTask : DefaultTask() {
     }
 
     private fun collectAllFiles(): ArtifactContent {
-        val local = localArtifact.get().asFile.parseArtifactFile(rootDir)
-        return local.joinWith(externalArtifacts.files.map { it.parseArtifactFile(rootDir) }).existing()
+        val local = localArtifact.get().asFile.parseArtifactFile(rootDir).filterProjectSources()
+        return local.joinWith(externalArtifacts.files.map { it.parseArtifactFile(rootDir).filterProjectSources() }).existing()
+    }
+
+    private fun ArtifactContent.filterProjectSources(): ArtifactContent {
+        val reportFilters = filters.get()
+        if (reportFilters.includeProjects.isNotEmpty()) {
+            val notIncluded = reportFilters.includeProjects.none { filter ->
+                KoverFeatures.koverWildcardToRegex(filter).toRegex().matches(path)
+            }
+            if (notIncluded) {
+                return ArtifactContent(path, emptySet(), emptySet(), reports)
+            }
+        }
+        if (reportFilters.excludeProjects.isNotEmpty()) {
+            val excluded = reportFilters.excludeProjects.any { filter ->
+                KoverFeatures.koverWildcardToRegex(filter).toRegex().matches(path)
+            }
+            if (excluded) {
+                return ArtifactContent(path, emptySet(), emptySet(), reports)
+            }
+        }
+        return this
     }
 }
 
diff --git a/kover-gradle-plugin/src/main/kotlin/kotlinx/kover/gradle/plugin/tasks/services/KoverArtifactGenerationTask.kt b/kover-gradle-plugin/src/main/kotlin/kotlinx/kover/gradle/plugin/tasks/services/KoverArtifactGenerationTask.kt
@@ -42,9 +42,11 @@ internal abstract class KoverArtifactGenerationTask : DefaultTask() {
 
     private val rootDir: File = project.rootDir
 
+    private val projectPath: String = project.path
+
     @TaskAction
     fun generate() {
-        val mainContent = ArtifactContent(sources.toSet(), outputDirs.toSet(), reports.toSet())
+        val mainContent = ArtifactContent(projectPath, sources.toSet(), outputDirs.toSet(), reports.toSet())
         val additional = additionalArtifacts.files.map { it.parseArtifactFile(rootDir) }
         mainContent.joinWith(additional).write(artifactFile.get().asFile, rootDir)
     }

Original file line number	Diff line number	Diff line change
`@@ -213,7 +213,8 @@ internal class VariantReportsSet(`
`213`	`213`	`return project.provider {`
`214`	`214`	`ReportFilters(`
`215`	`215`	`includesImpl.classes.get(), includesImpl.annotations.get(),`
`216`		`- excludesImpl.classes.get(), excludesImpl.annotations.get()`
	`216`	`+ excludesImpl.classes.get(), excludesImpl.annotations.get(),`
	`217`	`+ includesImpl.projects.get(), excludesImpl.projects.get(),`
`217`	`218`	`)`
`218`	`219`	`}`
`219`	`220`	`}`
Original file line number	Diff line number	Diff line change
`@@ -326,11 +326,13 @@ internal abstract class KoverReportFilterImpl: KoverReportFilter {`
`326`	`326`	`internal fun extendsFrom(other: KoverReportFilterImpl) {`
`327`	`327`	`classes.addAll(other.classes)`
`328`	`328`	`annotations.addAll(other.annotations)`
	`329`	`+ projects.addAll(other.projects)`
`329`	`330`	`}`
`330`	`331`
`331`	`332`	`internal fun clean() {`
`332`	`333`	`classes.empty()`
`333`	`334`	`annotations.empty()`
	`335`	`+ projects.empty()`
`334`	`336`	`}`
`335`	`337`
`336`	`338`	`private fun String.packageAsClass(): String = "$this.*"`