Merge pull request #47 from rubensousa/kmp_support

rubensousa · web-flow · commit 4e8fe90db2e0 · 2026-02-18T23:33:57.000+01:00
Add support for kmp by considering its configurations
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -5,6 +5,9 @@ truth = "1.4.5"
 junit = "4.13.2"
 mockk = "1.14.9"
 jackson = "2.17.0"
+runner = "1.5.2"
+core = "1.5.0"
+junitVersion = "1.1.5"
 
 [libraries]
 kotlin-test = { module = "org.jetbrains.kotlin:kotlin-test", version.ref = "kotlin" }
@@ -14,6 +17,10 @@ junit = { group = "junit", name = "junit", version.ref = "junit" }
 kotlin-serialization-json = { module = "org.jetbrains.kotlinx:kotlinx-serialization-json", version = "1.7.1" }
 jackson-yaml = { module = "com.fasterxml.jackson.dataformat:jackson-dataformat-yaml", version.ref = "jackson" }
 jackson-kotlin = { module = "com.fasterxml.jackson.module:jackson-module-kotlin", version.ref = "jackson" }
+kotlin-stdlib = { group = "org.jetbrains.kotlin", name = "kotlin-stdlib", version.ref = "kotlin" }
+runner = { group = "androidx.test", name = "runner", version.ref = "runner" }
+core = { group = "androidx.test", name = "core", version.ref = "core" }
+ext-junit = { group = "androidx.test.ext", name = "junit", version.ref = "junitVersion" }
 
 [plugins]
 android-application = { id = "com.android.application", version.ref = "agp" }
@@ -24,6 +31,9 @@ projectguard = { id = "com.rubensousa.projectguard", version = "unspecified" }
 kotlin-serialization = { id = "org.jetbrains.kotlin.plugin.serialization", version.ref = "kotlin" }
 kover = { id = "org.jetbrains.kotlinx.kover", version = "0.9.7" }
 android-library = { id = "com.android.library", version.ref = "agp" }
+kotlin-multiplatform = { id = "org.jetbrains.kotlin.multiplatform", version.ref = "kotlin" }
+android-kotlin-multiplatform-library = { id = "com.android.kotlin.multiplatform.library", version.ref = "agp" }
+android-lint = { id = "com.android.lint", version.ref = "agp" }
 
 [bundles]
 test = [
diff --git a/projectguard/src/main/kotlin/com/rubensousa/projectguard/plugin/ProjectGuardPlugin.kt b/projectguard/src/main/kotlin/com/rubensousa/projectguard/plugin/ProjectGuardPlugin.kt
@@ -16,7 +16,7 @@
 
 package com.rubensousa.projectguard.plugin
 
-import com.rubensousa.projectguard.plugin.internal.report.DependencyGraphBuilder
+import com.rubensousa.projectguard.plugin.internal.DependencyGraphBuilder
 import com.rubensousa.projectguard.plugin.internal.task.TaskAggregateDependencyDump
 import com.rubensousa.projectguard.plugin.internal.task.TaskAggregateRestrictionDump
 import com.rubensousa.projectguard.plugin.internal.task.TaskBaseline
diff --git a/projectguard/src/main/kotlin/com/rubensousa/projectguard/plugin/internal/DependencyConfiguration.kt b/projectguard/src/main/kotlin/com/rubensousa/projectguard/plugin/internal/DependencyConfiguration.kt
@@ -0,0 +1,41 @@
+/*
+ * Copyright 2026 Rúben Sousa
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.rubensousa.projectguard.plugin.internal
+
+internal object DependencyConfiguration {
+
+    private val supportedConfigurations = mutableSetOf(
+        "androidTestUtil",
+        "compileClasspath",
+        "testCompileClasspath",
+        "testFixturesCompileClasspath",
+    )
+
+    fun isConfigurationSupported(configurationId: String): Boolean {
+        return supportedConfigurations.any { pattern ->
+            configurationId.lowercase().contains(pattern.lowercase())
+        }
+    }
+
+    fun isReleaseConfiguration(configurationId: String): Boolean {
+        val lowerCaseConfiguration = configurationId.lowercase()
+        return lowerCaseConfiguration.contains("compileclasspath")
+                && !lowerCaseConfiguration.contains("test")
+                && !lowerCaseConfiguration.contains("metadata")
+    }
+
+}
diff --git a/projectguard/src/main/kotlin/com/rubensousa/projectguard/plugin/internal/DependencyGraphBuilder.kt b/projectguard/src/main/kotlin/com/rubensousa/projectguard/plugin/internal/DependencyGraphBuilder.kt
@@ -14,9 +14,9 @@
  * limitations under the License.
  */
 
-package com.rubensousa.projectguard.plugin.internal.report
+package com.rubensousa.projectguard.plugin.internal
 
-import com.rubensousa.projectguard.plugin.internal.DependencyGraph
+import com.rubensousa.projectguard.plugin.internal.report.DependencyGraphDump
 import org.gradle.api.Project
 import org.gradle.api.artifacts.ExternalModuleDependency
 import org.gradle.api.artifacts.ProjectDependency
@@ -50,7 +50,7 @@ internal class DependencyGraphBuilder {
 
     fun buildFromProject(project: Project): List<DependencyGraph> {
         return project.configurations
-            .filter { config -> config.isCanBeResolved && isConfigurationSupported(config.name) }
+            .filter { config -> config.isCanBeResolved && DependencyConfiguration.isConfigurationSupported(config.name) }
             .map { config ->
                 val graph = DependencyGraph(
                     configurationId = config.name,
@@ -69,45 +69,14 @@ internal class DependencyGraphBuilder {
                             }
 
                             is ExternalModuleDependency -> {
-                                if (dependency.group == null) {
-                                    // Java/Kotlin libraries provided to android modules are treated as external modules
-                                    // TODO: Improve detection
-                                    graph.addInternalDependency(
-                                        module = moduleId,
-                                        dependency = ":${dependency.name}:${dependency.versionConstraint.displayName}"
-                                    )
-                                } else {
-                                    graph.addExternalDependency(
-                                        module = moduleId,
-                                        dependency = "${dependency.group}:${dependency.name}",
-                                    )
-                                }
+                                graph.addExternalDependency(
+                                    module = moduleId,
+                                    dependency = "${dependency.group}:${dependency.name}",
+                                )
                             }
                         }
                     }
                 graph
             }
     }
-
-
-    companion object {
-        private val supportedConfigurations = mutableSetOf(
-            "androidTestUtil",
-            "compileClasspath",
-            "testCompileClasspath",
-            "testFixturesCompileClasspath",
-        )
-
-        fun isConfigurationSupported(configurationId: String): Boolean {
-            return supportedConfigurations.any { pattern ->
-                configurationId.lowercase().contains(pattern.lowercase())
-            }
-        }
-
-        fun isReleaseConfiguration(configurationId: String): Boolean {
-            return configurationId == "compileClasspath"
-                    || configurationId.lowercase().contains("releasecompileclasspath")
-        }
-    }
-
-}
+}
diff --git a/projectguard/src/main/kotlin/com/rubensousa/projectguard/plugin/internal/report/VerificationReportBuilder.kt b/projectguard/src/main/kotlin/com/rubensousa/projectguard/plugin/internal/report/VerificationReportBuilder.kt
@@ -16,6 +16,7 @@
 
 package com.rubensousa.projectguard.plugin.internal.report
 
+import com.rubensousa.projectguard.plugin.internal.DependencyConfiguration
 import com.rubensousa.projectguard.plugin.internal.SuppressionMap
 
 internal class VerificationReportBuilder(
@@ -76,7 +77,7 @@ internal class VerificationReportBuilder(
                 // TODO: Until https://github.com/rubensousa/ProjectGuard/issues/3 is clarified,
                 //  filter out test dependencies from the graph reports
                 val moduleDependencies = graph.getOrPut(report.module) { mutableSetOf() }
-                if (DependencyGraphBuilder.isReleaseConfiguration(configuration.id)) {
+                if (DependencyConfiguration.isReleaseConfiguration(configuration.id)) {
                     moduleDependencies.addAll(configuration.dependencies.map { dependency ->
                         DependencyReferenceDump(dependency.id, dependency.isLibrary)
                     })
diff --git a/projectguard/src/main/kotlin/com/rubensousa/projectguard/plugin/internal/task/TaskRestrictionDump.kt b/projectguard/src/main/kotlin/com/rubensousa/projectguard/plugin/internal/task/TaskRestrictionDump.kt
@@ -20,7 +20,7 @@ import com.rubensousa.projectguard.plugin.internal.DependencyRestrictionFinder
 import com.rubensousa.projectguard.plugin.internal.DirectDependencyRestriction
 import com.rubensousa.projectguard.plugin.internal.ProjectGuardSpec
 import com.rubensousa.projectguard.plugin.internal.TransitiveDependencyRestriction
-import com.rubensousa.projectguard.plugin.internal.report.DependencyGraphBuilder
+import com.rubensousa.projectguard.plugin.internal.DependencyGraphBuilder
 import com.rubensousa.projectguard.plugin.internal.report.DependencyGraphDump
 import com.rubensousa.projectguard.plugin.internal.report.JsonFileWriter
 import com.rubensousa.projectguard.plugin.internal.report.RestrictionDependencyReport
diff --git a/projectguard/src/test/kotlin/com/rubensousa/projectguard/plugin/internal/DependencyConfigurationTest.kt b/projectguard/src/test/kotlin/com/rubensousa/projectguard/plugin/internal/DependencyConfigurationTest.kt
@@ -0,0 +1,59 @@
+/*
+ * Copyright 2026 Rúben Sousa
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.rubensousa.projectguard.plugin.internal
+
+import com.google.common.truth.Truth.assertThat
+import kotlin.test.Test
+
+class DependencyConfigurationTest {
+
+    @Test
+    fun `kmp android configuration is considered release`() {
+        assertThat(DependencyConfiguration.isReleaseConfiguration("androidCompileClasspath")).isTrue()
+    }
+
+    @Test
+    fun `kmp android test configuration is not considered release`() {
+        assertThat(DependencyConfiguration.isReleaseConfiguration("androidDeviceTestCompileClasspath")).isFalse()
+    }
+
+    @Test
+    fun `android release configuration is considered release`() {
+        assertThat(DependencyConfiguration.isReleaseConfiguration("releaseCompileClasspath")).isTrue()
+    }
+
+    @Test
+    fun `android unit test release configuration is not considered release`() {
+        assertThat(DependencyConfiguration.isReleaseConfiguration("releaseUnitTestCompileClasspath")).isFalse()
+    }
+
+    @Test
+    fun `android instrumented test configuration is not considered release`() {
+        assertThat(DependencyConfiguration.isReleaseConfiguration("debugAndroidTestCompileClasspath")).isFalse()
+    }
+
+    @Test
+    fun `test configuration is not considered release`() {
+        assertThat(DependencyConfiguration.isReleaseConfiguration("testCompileClasspath")).isFalse()
+    }
+
+    @Test
+    fun `test fixture configuration is not considered release`() {
+        assertThat(DependencyConfiguration.isReleaseConfiguration("testFixturesCompileClasspath")).isFalse()
+    }
+
+}
diff --git a/projectguard/src/test/kotlin/com/rubensousa/projectguard/plugin/internal/DependencyGraphBuilderTest.kt b/projectguard/src/test/kotlin/com/rubensousa/projectguard/plugin/internal/DependencyGraphBuilderTest.kt
@@ -17,7 +17,6 @@
 package com.rubensousa.projectguard.plugin.internal
 
 import com.google.common.truth.Truth.assertThat
-import com.rubensousa.projectguard.plugin.internal.report.DependencyGraphBuilder
 import org.gradle.api.Project
 import org.gradle.testfixtures.ProjectBuilder
 import org.junit.Before
diff --git a/sample/android/build.gradle.kts b/sample/android/build.gradle.kts
@@ -18,7 +18,7 @@ android {
 }
 
 dependencies {
-    implementation(":domain:a")
+    implementation(project(":domain:a"))
     testImplementation(libs.junit)
     androidTestImplementation(project(":legacy:a"))
 }
diff --git a/sample/build.gradle.kts b/sample/build.gradle.kts
@@ -6,6 +6,9 @@ plugins {
     alias(libs.plugins.maven.publish) apply false
     alias(libs.plugins.android.library) apply false
     alias(libs.plugins.projectguard) apply true
+    alias(libs.plugins.kotlin.multiplatform) apply false
+    alias(libs.plugins.android.kotlin.multiplatform.library) apply false
+    alias(libs.plugins.android.lint) apply false
 }
 
 projectGuard {
diff --git a/sample/kmp/.gitignore b/sample/kmp/.gitignore
@@ -0,0 +1 @@
+/build
diff --git a/sample/kmp/build.gradle.kts b/sample/kmp/build.gradle.kts
@@ -0,0 +1,55 @@
+plugins {
+    alias(libs.plugins.kotlin.multiplatform)
+    alias(libs.plugins.android.kotlin.multiplatform.library)
+    alias(libs.plugins.android.lint)
+}
+
+kotlin {
+    androidLibrary {
+        namespace = "com.rubensousa.projectguard.kmp"
+        compileSdk {
+            version = release(36) { minorApiLevel = 1 }
+        }
+        minSdk = 28
+
+        withHostTestBuilder {
+        }
+
+        withDeviceTestBuilder {
+            sourceSetTreeName = "test"
+        }.configure {
+            instrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
+        }
+    }
+    sourceSets {
+        commonMain {
+            dependencies {
+                implementation(libs.kotlin.stdlib)
+                // Add KMP dependencies here
+            }
+        }
+
+        commonTest {
+            dependencies {
+                implementation(libs.kotlin.test)
+            }
+        }
+
+        androidMain {
+            dependencies {
+                // Add Android-specific dependencies here. Note that this source set depends on
+                // commonMain by default and will correctly pull the Android artifacts of any KMP
+                // dependencies declared in commonMain.
+            }
+        }
+
+        getByName("androidDeviceTest") {
+            dependencies {
+                implementation(libs.runner)
+                implementation(libs.core)
+                implementation(libs.ext.junit)
+            }
+        }
+    }
+
+}
diff --git a/sample/kmp/src/androidMain/AndroidManifest.xml b/sample/kmp/src/androidMain/AndroidManifest.xml
@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+
+</manifest>
diff --git a/sample/kmp/src/androidMain/kotlin/com/rubensousa/projectguard/kmp/Platform.android.kt b/sample/kmp/src/androidMain/kotlin/com/rubensousa/projectguard/kmp/Platform.android.kt
@@ -0,0 +1,3 @@
+package com.rubensousa.projectguard.kmp
+
+actual fun platform() = "Android"
diff --git a/sample/kmp/src/commonMain/kotlin/com/rubensousa/projectguard/kmp/Platform.kt b/sample/kmp/src/commonMain/kotlin/com/rubensousa/projectguard/kmp/Platform.kt
@@ -0,0 +1,3 @@
+package com.rubensousa.projectguard.kmp
+
+expect fun platform(): String
diff --git a/sample/settings.gradle.kts b/sample/settings.gradle.kts
@@ -133,3 +133,4 @@ include(":legacy:x")
 include(":legacy:y")
 include(":legacy:z")
 include(":android")
+include(":kmp")

Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ android {`
`18`	`18`	`}`
`19`	`19`
`20`	`20`	`dependencies {`
`21`		`- implementation(":domain:a")`
	`21`	`+ implementation(project(":domain:a"))`
`22`	`22`	`testImplementation(libs.junit)`
`23`	`23`	`androidTestImplementation(project(":legacy:a"))`
`24`	`24`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,9 @@ plugins {`
`6`	`6`	`alias(libs.plugins.maven.publish) apply false`
`7`	`7`	`alias(libs.plugins.android.library) apply false`
`8`	`8`	`alias(libs.plugins.projectguard) apply true`
	`9`	`+ alias(libs.plugins.kotlin.multiplatform) apply false`
	`10`	`+ alias(libs.plugins.android.kotlin.multiplatform.library) apply false`
	`11`	`+ alias(libs.plugins.android.lint) apply false`
`9`	`12`	`}`
`10`	`13`
`11`	`14`	`projectGuard {`