Add tests and CI check

runningcode · runningcode · commit 00bd9a2cea32 · 2025-06-12T16:42:31.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### Features
+
+- Add upload functionality for size analysis ([#915](https://github.com/getsentry/sentry-android-gradle-plugin/pull/915))
+
 ### Fixes
 
 - Enable caching for BundleSourcesTask ([#894](https://github.com/getsentry/sentry-android-gradle-plugin/pull/894)
diff --git a/examples/android-gradle-kts/build.gradle.kts b/examples/android-gradle-kts/build.gradle.kts
@@ -22,8 +22,6 @@ android {
 
 sentry {
   autoUploadProguardMapping.set(CI.canAutoUpload())
-  debug.set(true)
-  sizeAnalysis.enabled.set(true)
 
   telemetryDsn.set(CI.SENTRY_SDKS_DSN)
   tracingInstrumentation { enabled.set(false) }
diff --git a/examples/android-gradle-kts/sentry.properties b/examples/android-gradle-kts/sentry.properties
@@ -1,3 +1,2 @@
 defaults.project=sentry-android
 defaults.org=sentry-sdks
-cli.executable=/Users/nelsonosacky/workspace/sentry-cli/bin/sentry-cli-dev
diff --git a/examples/android-gradle/build.gradle b/examples/android-gradle/build.gradle
@@ -23,8 +23,6 @@ android {
 
 sentry {
   autoUploadProguardMapping = CI.INSTANCE.canAutoUpload()
-  debug= true
-  sizeAnalysis.enabled = true
 
   telemetryDsn = CI.INSTANCE.SENTRY_SDKS_DSN
   tracingInstrumentation {
diff --git a/examples/android-gradle/sentry.properties b/examples/android-gradle/sentry.properties
@@ -1,3 +1,2 @@
 defaults.project=sentry-android
 defaults.org=sentry-sdks
-cli.executable=/Users/nelsonosacky/workspace/sentry-cli/bin/sentry-cli-dev
diff --git a/examples/android-guardsquare-proguard/sentry.properties b/examples/android-guardsquare-proguard/sentry.properties
@@ -1,3 +1,2 @@
 defaults.project=sentry-android
 defaults.org=sentry-sdks
-cli.executable=/Users/nelsonosacky/workspace/sentry-cli/bin/sentry-cli-dev
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -42,6 +42,7 @@ autoServiceAnnotatons = { group = "com.google.auto.service", name = "auto-servic
 kotlinJunit = { group = "org.jetbrains.kotlin", name = "kotlin-test-junit", version.ref = "kotlin" }
 kotlinCompileTesting = { group = "dev.zacsweers.kctfork", name = "core", version = "0.7.0" }
 composeDesktop = { group = "org.jetbrains.compose.desktop", name = "desktop", version = "1.6.10" }
+truth = { module = "com.google.truth:truth", version = "1.4.4" }
 
 # bytecode instrumentation
 asm = { group = "org.ow2.asm", name = "asm-util", version.ref = "asm" }
diff --git a/plugin-build/build.gradle.kts b/plugin-build/build.gradle.kts
@@ -1,3 +1,4 @@
+import com.github.jengelman.gradle.plugins.shadow.tasks.ShadowJar
 import io.sentry.android.gradle.internal.ASMifyTask
 import io.sentry.android.gradle.internal.BootstrapAndroidSdk
 import java.io.FileInputStream
@@ -29,11 +30,11 @@ val testImplementationAar by configurations.getting // this converts .aar into .
 val agp70: SourceSet by sourceSets.creating
 val agp74: SourceSet by sourceSets.creating
 
-// val shade: Configuration by
-//  configurations.creating {
-//    isCanBeConsumed = false
-//    isCanBeResolved = true
-//  }
+val shade: Configuration by
+  configurations.creating {
+    isCanBeConsumed = false
+    isCanBeResolved = true
+  }
 
 val fixtureClasspath: Configuration by configurations.creating
 
@@ -61,8 +62,8 @@ dependencies {
 
   // compileOnly since we'll be shading the common dependency into the final jar
   // but we still need to be able to compile it (this also excludes it from .pom)
-  //  compileOnly(project(":common"))
-  implementation(project(":common"))
+  compileOnly(project(":common"))
+  shade(project(":common"))
 
   testImplementation(gradleTestKit())
   testImplementation(kotlin("test"))
@@ -76,6 +77,7 @@ dependencies {
   testImplementation(libs.proguard)
   testImplementation(libs.junit)
   testImplementation(libs.mockitoKotlin)
+  testImplementation(libs.truth)
 
   testImplementation(libs.asm)
   testImplementation(libs.asmCommons)
@@ -191,19 +193,19 @@ tasks.withType<Jar>().configureEach {
   from(agp74.output)
 }
 
-// tasks.withType<ShadowJar>().configureEach {
-//  archiveClassifier.set("")
-//  configurations = listOf(shade)
+tasks.withType<ShadowJar>().configureEach {
+  archiveClassifier.set("")
+  configurations = listOf(shade)
 
-//  exclude("/kotlin/**")
-//  exclude("/groovy**")
-//  exclude("/org/**")
-// }
+  exclude("/kotlin/**")
+  exclude("/groovy**")
+  exclude("/org/**")
+}
 
-// artifacts {
-//  runtimeOnly(tasks.named("shadowJar"))
-//  archives(tasks.named("shadowJar"))
-// }
+artifacts {
+  runtimeOnly(tasks.named("shadowJar"))
+  archives(tasks.named("shadowJar"))
+}
 
 spotless {
   kotlin {
diff --git a/plugin-build/sentry-cli.properties b/plugin-build/sentry-cli.properties
@@ -1,3 +1,2 @@
-#version = 2.46.0
-#repo = https://github.com/getsentry/sentry-cli
-cli.executable=/Users/nelsonosacky/workspace/sentry-cli/bin/sentry-cli-dev
+version = 2.46.0
+repo = https://github.com/getsentry/sentry-cli
diff --git a/plugin-build/src/main/kotlin/io/sentry/android/gradle/AndroidComponentsConfig.kt b/plugin-build/src/main/kotlin/io/sentry/android/gradle/AndroidComponentsConfig.kt
@@ -65,10 +65,10 @@ fun AndroidComponentsExtension<*, *, *>.configure(
   tmpDir.mkdirs()
 
   configureVariants { variant ->
-    val sentryTelemetryProvider =
-      variant.configureTelemetry(project, extension, cliExecutable, sentryOrg, buildEvents)
     if (isVariantAllowed(extension, variant.name, variant.flavorName, variant.buildType)) {
       val paths = OutputPaths(project, variant.name)
+      val sentryTelemetryProvider =
+        variant.configureTelemetry(project, extension, cliExecutable, sentryOrg, buildEvents)
 
       variant.configureDependenciesTask(project, extension, sentryTelemetryProvider)
 
@@ -247,6 +247,8 @@ fun AndroidComponentsExtension<*, *, *>.configure(
       }
     }
     if (extension.sizeAnalysis.enabled.get() == true) {
+      val sentryTelemetryProvider =
+        variant.configureTelemetry(project, extension, cliExecutable, sentryOrg, buildEvents)
       variant.configureUploadAppTasks(
         project,
         extension,
@@ -427,6 +429,9 @@ private fun Variant.configureProguardMappingsTasks(
   }
 }
 
+/**
+ * Configure the upload AAB and APK tasks and set them up as finalizers on the respective producer tasks
+ */
 fun Variant.configureUploadAppTasks(
   project: Project,
   extension: SentryPluginExtension,
@@ -453,6 +458,7 @@ fun Variant.configureUploadAppTasks(
       sentryProperties = sentryProps,
       taskSuffix = name.capitalized,
     )
+  // TODO we can use the listToArtifacts API in AGP 8.3+ https://github.com/android/gradle-recipes/tree/agp-8.10/listenToArtifacts
   project.afterEvaluate {
     getBundleTask(project, variant.name)!!.configure { it.finalizedBy(uploadBundleTask) }
     getAssembleTaskProvider(project, variant)!!.configure { it.finalizedBy(uploadApkTask) }
diff --git a/plugin-build/src/main/kotlin/io/sentry/android/gradle/extensions/SizeAnalysisExtension.kt b/plugin-build/src/main/kotlin/io/sentry/android/gradle/extensions/SizeAnalysisExtension.kt
@@ -1,9 +1,15 @@
 package io.sentry.android.gradle.extensions
 
+import io.sentry.android.gradle.util.CiUtils.isCi
 import javax.inject.Inject
 import org.gradle.api.model.ObjectFactory
 import org.gradle.api.provider.Property
+import org.gradle.api.provider.ProviderFactory
 
-open class SizeAnalysisExtension @Inject constructor(objects: ObjectFactory) {
-  val enabled: Property<Boolean> = objects.property(Boolean::class.java).convention(false)
+open class SizeAnalysisExtension
+@Inject
+constructor(objects: ObjectFactory, providerFactory: ProviderFactory) {
+
+  val enabled: Property<Boolean> =
+    objects.property(Boolean::class.java).convention(providerFactory.isCi())
 }
diff --git a/plugin-build/src/main/kotlin/io/sentry/android/gradle/tasks/SentryUploadAppArtifactTask.kt b/plugin-build/src/main/kotlin/io/sentry/android/gradle/tasks/SentryUploadAppArtifactTask.kt
@@ -37,13 +37,33 @@ abstract class SentryUploadAppArtifactTask @Inject constructor(objectFactory: Ob
   override fun getArguments(args: MutableList<String>) {
     args.add("mobile-app")
     args.add("upload")
-    if (bundle.isPresent && bundle.get().asFile.exists()) {
-      args.add(bundle.get().asFile.path)
-    } else if (apk.isPresent && apk.get().asFile.exists()) {
-      // find *.apk inside apk input directory
-      val path = apk.get().asFileTree.find { file -> file.name.endsWith(".apk") }!!.path
-      args.add(path)
+
+    val bundleFile = bundle.orNull?.asFile
+    if (bundleFile != null) {
+      if (bundleFile.exists()) {
+        args.add(bundleFile.path)
+        return
+      } else {
+        throw IllegalStateException("Bundle file does not exist: ${bundleFile.path}")
+      }
     }
+
+    val apkDir = apk.orNull?.asFile
+    if (apkDir != null) {
+      if (apkDir.exists()) {
+        val apkFile = apkDir.walkTopDown().find { it.isFile && it.name.endsWith(".apk") }
+        if (apkFile != null) {
+          args.add(apkFile.path)
+          return
+        } else {
+          throw IllegalStateException("No APK file exists in directory: ${apkDir.path}")
+        }
+      } else {
+        throw IllegalStateException("APK directory does not exist: ${apkDir.path}")
+      }
+    }
+
+    throw IllegalStateException("No bundle or apk found")
   }
 
   companion object {
diff --git a/plugin-build/src/main/kotlin/io/sentry/android/gradle/util/CI.kt b/plugin-build/src/main/kotlin/io/sentry/android/gradle/util/CI.kt
@@ -0,0 +1,77 @@
+package io.sentry.android.gradle.util
+
+import org.gradle.api.provider.ProviderFactory
+
+/**
+ * Inspired by:
+ * https://github.com/gradle/common-custom-user-data-gradle-plugin/blob/280c9d37596a70c531111cd15824f375edd3c515/src/main/java/com/gradle/CiUtils.java
+ */
+internal object CiUtils {
+  fun ProviderFactory.isCi(): Boolean {
+    return isGenericCI() ||
+      isJenkins() ||
+      isHudson() ||
+      isTeamCity() ||
+      isCircleCI() ||
+      isBamboo() ||
+      isGitHubActions() ||
+      isGitLab() ||
+      isTravis() ||
+      isBitrise() ||
+      isGoCD() ||
+      isAzurePipelines() ||
+      isBuildkite()
+  }
+
+  fun ProviderFactory.isGenericCI(): Boolean {
+    return environmentVariable("CI").isPresent || systemProperty("CI").isPresent
+  }
+
+  fun ProviderFactory.isJenkins(): Boolean {
+    return environmentVariable("JENKINS_URL").isPresent
+  }
+
+  fun ProviderFactory.isHudson(): Boolean {
+    return environmentVariable("HUDSON_URL").isPresent
+  }
+
+  fun ProviderFactory.isTeamCity(): Boolean {
+    return environmentVariable("TEAMCITY_VERSION").isPresent
+  }
+
+  fun ProviderFactory.isCircleCI(): Boolean {
+    return environmentVariable("CIRCLE_BUILD_URL").isPresent
+  }
+
+  fun ProviderFactory.isBamboo(): Boolean {
+    return environmentVariable("bamboo_resultsUrl").isPresent
+  }
+
+  fun ProviderFactory.isGitHubActions(): Boolean {
+    return environmentVariable("GITHUB_ACTIONS").isPresent
+  }
+
+  fun ProviderFactory.isGitLab(): Boolean {
+    return environmentVariable("GITLAB_CI").isPresent
+  }
+
+  fun ProviderFactory.isTravis(): Boolean {
+    return environmentVariable("TRAVIS_JOB_ID").isPresent
+  }
+
+  fun ProviderFactory.isBitrise(): Boolean {
+    return environmentVariable("BITRISE_BUILD_URL").isPresent
+  }
+
+  fun ProviderFactory.isGoCD(): Boolean {
+    return environmentVariable("GO_SERVER_URL").isPresent
+  }
+
+  fun ProviderFactory.isAzurePipelines(): Boolean {
+    return environmentVariable("TF_BUILD").isPresent
+  }
+
+  fun ProviderFactory.isBuildkite(): Boolean {
+    return environmentVariable("BUILDKITE").isPresent
+  }
+}
diff --git a/plugin-build/src/test/kotlin/io/sentry/android/gradle/integration/SentryPluginUploadTest.kt b/plugin-build/src/test/kotlin/io/sentry/android/gradle/integration/SentryPluginUploadTest.kt
diff --git a/plugin-build/src/test/kotlin/io/sentry/android/gradle/tasks/SentryUploadAppArtifactTaskTest.kt b/plugin-build/src/test/kotlin/io/sentry/android/gradle/tasks/SentryUploadAppArtifactTaskTest.kt

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,2 @@`
`1`	`1`	`defaults.project=sentry-android`
`2`	`2`	`defaults.org=sentry-sdks`
`3`		`-cli.executable=/Users/nelsonosacky/workspace/sentry-cli/bin/sentry-cli-dev`