Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .claude/skills/test/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Determine the Gradle test task:
| Module Pattern | Test Task |
|---------------|-----------|
| `sentry-android-*` | `testReleaseUnitTest` |
| `sentry-compose*` | `testReleaseUnitTest` |
| `sentry-compose*` | `testAndroidHostTest` |
| `*-android` | `testReleaseUnitTest` |
| Everything else | `test` |

Expand Down
1 change: 1 addition & 0 deletions build-logic/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ dependencies {
implementation(libs.vanniktechMavenPublishLib)
implementation(libs.asm)
compileOnly(libs.kotlin.gradle.plugin)
compileOnly(libs.kotlin.abi.tools.api)
compileOnly(libs.android.gradle.plugin)
}

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
package io.sentry.gradle

import com.android.build.api.artifact.SingleArtifact
import com.android.build.api.dsl.KotlinMultiplatformAndroidHostTestCompilation
import com.android.build.api.dsl.KotlinMultiplatformAndroidLibraryTarget
import com.android.build.api.dsl.LibraryExtension
import com.android.build.api.variant.KotlinMultiplatformAndroidComponentsExtension
import com.android.build.api.variant.LibraryAndroidComponentsExtension
import org.gradle.api.JavaVersion
import org.gradle.api.Plugin
Expand Down Expand Up @@ -81,6 +84,15 @@ class JdkTargetConvention : Plugin<Project> {
}
}
}
project.plugins.withId("com.android.kotlin.multiplatform.library") {
project.extensions
.getByType(KotlinMultiplatformAndroidComponentsExtension::class.java)
.onVariants { variant ->
verifyMethodParameters.configure {
archives.from(variant.artifacts.get(SingleArtifact.AAR))
}
}
}
// Only works for non-android modules
// See https://issuetracker.google.com/issues/278800528
project.plugins.withId("java-library") {
Expand Down Expand Up @@ -112,6 +124,22 @@ class JdkTargetConvention : Plugin<Project> {
listOf("com.android.library", "com.android.application").forEach { pluginId ->
project.plugins.withId(pluginId) { project.targetBuildJdkForUnitTests() }
}
project.plugins.withId("com.android.kotlin.multiplatform.library") {
project.extensions
.getByType(KotlinMultiplatformExtension::class.java)
.targets
.withType(KotlinMultiplatformAndroidLibraryTarget::class.java)
.configureEach {
aarMetadata { minCompileSdk = project.minSdk() }
compilations
.withType(KotlinMultiplatformAndroidHostTestCompilation::class.java)
.configureEach {
compileTaskProvider.configure {
compilerOptions.jvmTarget.set(JvmTarget.fromTarget(BUILD_JDK.toString()))
}
}
}
}
}

private fun Project.minSdk(): Int =
Expand All @@ -133,13 +161,6 @@ class JdkTargetConvention : Plugin<Project> {
plugins.withId("org.jetbrains.kotlin.android") {
extensions.getByType(KotlinAndroidProjectExtension::class.java).target.targetBuildJdk()
}
plugins.withId("org.jetbrains.kotlin.multiplatform") {
extensions
.getByType(KotlinMultiplatformExtension::class.java)
.targets
.withType(KotlinAndroidTarget::class.java)
.configureEach { targetBuildJdk() }
}
}

private fun KotlinAndroidTarget.targetBuildJdk() {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,173 @@
package io.sentry.gradle

import com.android.build.api.dsl.KotlinMultiplatformAndroidLibraryTarget
import java.io.File
import javax.inject.Inject
import org.gradle.api.DefaultTask
import org.gradle.api.GradleException
import org.gradle.api.Project
import org.gradle.api.file.ConfigurableFileCollection
import org.gradle.api.file.RegularFileProperty
import org.gradle.api.provider.SetProperty
import org.gradle.api.tasks.CacheableTask
import org.gradle.api.tasks.Classpath
import org.gradle.api.tasks.Input
import org.gradle.api.tasks.InputFiles
import org.gradle.api.tasks.OutputFile
import org.gradle.api.tasks.PathSensitive
import org.gradle.api.tasks.PathSensitivity
import org.gradle.api.tasks.TaskAction
import org.gradle.work.DisableCachingByDefault
import org.gradle.workers.WorkAction
import org.gradle.workers.WorkParameters
import org.gradle.workers.WorkerExecutor
import org.jetbrains.kotlin.abi.tools.AbiFilters
import org.jetbrains.kotlin.abi.tools.AbiTools
import org.jetbrains.kotlin.gradle.dsl.KotlinMultiplatformExtension
import org.jetbrains.kotlin.gradle.plugin.getKotlinPluginVersion

/**
* The Kotlin Gradle plugin's ABI validation only dumps JVM and legacy `androidTarget` targets, so a
* module on the KMP Android library plugin would silently stop checking its Android ABI. This dumps
* that target with the same ABI tools the Kotlin Gradle plugin uses, into the same
* `api/<target>/<module>.api` file, and hooks into `checkKotlinAbi` and `updateKotlinAbi`.
*/
internal fun Project.validateKmpAndroidAbi(extension: ApiValidationExtension) {
val abiTools =
configurations.detachedConfiguration(
dependencies.create("org.jetbrains.kotlin:abi-tools:${getKotlinPluginVersion()}")
)

extensions
.getByType(KotlinMultiplatformExtension::class.java)
.targets
.withType(KotlinMultiplatformAndroidLibraryTarget::class.java)
.all {
val targetName = name
val capitalized = targetName.replaceFirstChar { it.uppercase() }
val dump =
tasks.register("dump${capitalized}KotlinAbi", DumpKmpAndroidAbi::class.java) {
description = "Dumps the public ABI of the $targetName target."
classpath.from(abiTools)
classes.from(compilations.getByName("main").output.classesDirs)
ignoredPackages.set(extension.ignoredPackages)
dumpFile.set(layout.buildDirectory.file("kotlin/abi-$targetName/${project.name}.api"))
}
val referenceDump = layout.projectDirectory.file("api/$targetName/${project.name}.api")

val check =
tasks.register("check${capitalized}KotlinAbi", CheckKmpAndroidAbi::class.java) {
description = "Checks the public ABI of the $targetName target against its dump."
group = "verification"
classpath.from(abiTools)
actual.set(dump.flatMap { it.dumpFile })
expected.set(referenceDump)
}
tasks.named("checkKotlinAbi").configure { dependsOn(check) }

val update =
tasks.register("update${capitalized}KotlinAbi", UpdateKmpAndroidAbi::class.java) {
description = "Writes the public ABI of the $targetName target to its dump."
actual.set(dump.flatMap { it.dumpFile })
expected.set(referenceDump)
}
tasks.named("updateKotlinAbi").configure { dependsOn(update) }
}
}

@CacheableTask
abstract class DumpKmpAndroidAbi @Inject constructor(private val workers: WorkerExecutor) :
DefaultTask() {
@get:Classpath abstract val classpath: ConfigurableFileCollection

@get:Classpath abstract val classes: ConfigurableFileCollection

@get:Input abstract val ignoredPackages: SetProperty<String>

@get:OutputFile abstract val dumpFile: RegularFileProperty

@TaskAction
fun dump() {
workers
.classLoaderIsolation { classpath.from(this@DumpKmpAndroidAbi.classpath) }
.submit(DumpAbiAction::class.java) {
classes.from(this@DumpKmpAndroidAbi.classes)
excludedClasses.set(ignoredPackages.map { packages -> packages.map { "$it.**" }.toSet() })
dumpFile.set(this@DumpKmpAndroidAbi.dumpFile)
}
}
}

@DisableCachingByDefault(because = "Comparing two small files is cheaper than caching it")
abstract class CheckKmpAndroidAbi @Inject constructor(private val workers: WorkerExecutor) :
DefaultTask() {
@get:Classpath abstract val classpath: ConfigurableFileCollection

@get:InputFiles @get:PathSensitive(PathSensitivity.NONE) abstract val actual: RegularFileProperty

// InputFiles rather than InputFile, so that a missing dump fails with the message below.
@get:InputFiles
@get:PathSensitive(PathSensitivity.NONE)
abstract val expected: RegularFileProperty

@TaskAction
fun check() {
val expectedFile = expected.get().asFile
if (!expectedFile.exists()) {
throw GradleException(
"The ABI dump ${expectedFile.path} is missing. Run updateKotlinAbi to create it."
)
}
workers
.classLoaderIsolation { classpath.from(this@CheckKmpAndroidAbi.classpath) }
.submit(CheckAbiAction::class.java) {
expected.set(expectedFile)
actual.set(this@CheckKmpAndroidAbi.actual)
}
}
}

@DisableCachingByDefault(because = "Copies one file into the source tree")
abstract class UpdateKmpAndroidAbi : DefaultTask() {
@get:InputFiles @get:PathSensitive(PathSensitivity.NONE) abstract val actual: RegularFileProperty

@get:OutputFile abstract val expected: RegularFileProperty

@TaskAction
fun update() {
actual.get().asFile.copyTo(expected.get().asFile, overwrite = true)
}
}

interface DumpAbiParameters : WorkParameters {
val classes: ConfigurableFileCollection
val excludedClasses: SetProperty<String>
val dumpFile: RegularFileProperty
}

abstract class DumpAbiAction : WorkAction<DumpAbiParameters> {
override fun execute() {
val filters =
AbiFilters(emptySet(), parameters.excludedClasses.get(), emptySet(), emptySet())
val classFiles = parameters.classes.asFileTree.matching { include("**/*.class") }.files
parameters.dumpFile.get().asFile.bufferedWriter().use {
AbiTools.getInstance().printJvmDump(it, classFiles, filters)
}
}
}

interface CheckAbiParameters : WorkParameters {
val expected: RegularFileProperty
val actual: RegularFileProperty
}

abstract class CheckAbiAction : WorkAction<CheckAbiParameters> {
override fun execute() {
val expected: File = parameters.expected.get().asFile
val actual: File = parameters.actual.get().asFile
val diff = AbiTools.getInstance().filesDiff(expected, actual) ?: return
throw GradleException(
"The public ABI of ${expected.path} changed. Run updateKotlinAbi if that is intended.\n$diff"
)
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ class SentryApiValidationPlugin : Plugin<Project> {
KOTLIN_PLUGIN_IDS.forEach {
project.pluginManager.withPlugin(it) { enable(project, extension) }
}
project.pluginManager.withPlugin("com.android.kotlin.multiplatform.library") {
project.validateKmpAndroidAbi(extension)
}
}

private fun enable(project: Project, extension: ApiValidationExtension) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ import org.gradle.api.tasks.OutputFile
import org.gradle.api.tasks.PathSensitive
import org.gradle.api.tasks.PathSensitivity
import org.gradle.api.tasks.TaskAction
import org.gradle.api.tasks.testing.Test
import org.gradle.process.CommandLineArgumentProvider
import org.gradle.work.DisableCachingByDefault

Expand Down Expand Up @@ -69,18 +70,30 @@ class SentryRobolectricPlugin : Plugin<Project> {
propertiesFile.set(project.layout.buildDirectory.file("robolectric/deps.properties"))
}

val useGradleCachedJars: (Test) -> Unit = { test ->
// The properties file holds absolute paths, so it can't be a test input without breaking
// build cache hits across machines. The jars are the input instead.
test.dependsOn(writeDeps)
test.jvmArgumentProviders.add(
project.objects.newInstance(RobolectricDepsArgument::class.java).apply {
androidAllJars.from(coordinatesToJar.values)
propertiesFile.set(writeDeps.flatMap { it.propertiesFile })
}
)
}

project.plugins.withId("com.android.library") {
project.extensions.getByType(LibraryExtension::class.java).testOptions.unitTests.all { test ->
// The properties file holds absolute paths, so it can't be a test input without breaking
// build cache hits across machines. The jars are the input instead.
test.dependsOn(writeDeps)
test.jvmArgumentProviders.add(
project.objects.newInstance(RobolectricDepsArgument::class.java).apply {
androidAllJars.from(coordinatesToJar.values)
propertiesFile.set(writeDeps.flatMap { it.propertiesFile })
}
)
}
project.extensions
.getByType(LibraryExtension::class.java)
.testOptions
.unitTests
.all(useGradleCachedJars)
}
project.plugins.withId("com.android.kotlin.multiplatform.library") {
project.tasks
.withType(Test::class.java)
.matching { it.name == "testAndroidHostTest" }
.configureEach(useGradleCachedJars)
}
}
}
Expand Down
4 changes: 4 additions & 0 deletions build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,10 @@ tasks.register("buildForCodeQL") {
proj.tasks.findByName("compileReleaseUnitTestSources")?.let { testTask ->
this.dependsOn(testTask)
}
} else if (proj.plugins.hasPlugin("com.android.kotlin.multiplatform.library")) {
proj.tasks.findByName("compileAndroidHostTest")?.let { testTask ->
this.dependsOn(testTask)
}
} else {
proj.tasks.findByName("testClasses")?.let { testTask ->
this.dependsOn(testTask)
Expand Down
61 changes: 52 additions & 9 deletions detekt.yml
Original file line number Diff line number Diff line change
@@ -1,16 +1,59 @@
# detekt's defaults exclude test sources from these rules, but its list predates the KMP Android
# library plugin's androidHostTest source set. A rule's excludes replace the default list, so this
# repeats it with androidHostTest added.
comments:
KDocReferencesNonPublicProperty:
excludes: &testSources
- '**/test/**'
- '**/androidTest/**'
- '**/commonTest/**'
- '**/jvmTest/**'
- '**/androidUnitTest/**'
- '**/androidHostTest/**'
- '**/androidInstrumentedTest/**'
- '**/jsTest/**'
- '**/iosTest/**'
UndocumentedPublicClass:
excludes: *testSources
UndocumentedPublicFunction:
excludes: *testSources
UndocumentedPublicProperty:
excludes: *testSources
complexity:
StringLiteralDuplication:
excludes: *testSources
TooManyFunctions:
excludes: *testSources
ignoreAnnotatedFunctions: ['Preview']
exceptions:
InstanceOfCheckForException:
excludes: *testSources
ThrowingExceptionsWithoutMessageOrCause:
excludes: *testSources
TooGenericExceptionCaught:
excludes: *testSources
naming:
FunctionNaming:
excludes: *testSources
ignoreAnnotated: ['Composable']
TopLevelPropertyNaming:
# Accept both SCREAMING_CASE and Compose's PascalCase constants.
constantPattern: '[A-Z][_A-Za-z0-9]*'
performance:
ForEachOnRange:
excludes: *testSources
SpreadOperator:
excludes: *testSources
potential-bugs:
LateinitUsage:
excludes: *testSources
UnsafeCallOnNullableType:
excludes: *testSources
style:
ReturnCount:
max: 3
MagicNumber:
excludes: *testSources
ignorePropertyDeclaration: true
UnusedPrivateMember:
ignoreAnnotated: ['Preview']
naming:
FunctionNaming:
ignoreAnnotated: ['Composable']
TopLevelPropertyNaming:
# Accept both SCREAMING_CASE and Compose's PascalCase constants.
constantPattern: '[A-Z][_A-Za-z0-9]*'
complexity:
TooManyFunctions:
ignoreAnnotatedFunctions: ['Preview']
Loading
Loading