Making shadowed jar the default for baseJavaagentLibs

Author: LikeTheSalad

conventions/src/main/kotlin/io.opentelemetry.instrumentation.javaagent-testing.gradle.kts

@@ -1,3 +1,5 @@
+import com.github.jengelman.gradle.plugins.shadow.tasks.ShadowJar
+
 plugins {
   `java-library`
 
@@ -48,7 +50,8 @@ val testInstrumentation by configurations.creating {
   isCanBeResolved = true
 }
 
-tasks.shadowJar {
+val agentTestingShadowJar by tasks.registering(ShadowJar::class)  {
+  from(sourceSets.main.map { it.output })
   configurations = listOf(project.configurations.runtimeClasspath.get(), testInstrumentation)
 
   archiveFileName.set("agent-testing.jar")
@@ -101,18 +104,17 @@ class JavaagentTestArgumentsProvider(
 // need to run this after evaluate because testSets plugin adds new test tasks
 afterEvaluate {
   tasks.withType<Test>().configureEach {
-    val shadowJar = tasks.shadowJar.get()
     val agentShadowJar = agentForTesting.resolve().first()
 
-    dependsOn(shadowJar)
+    dependsOn(agentTestingShadowJar)
     // TODO: Figure out why dependsOn override is still needed in otel.javaagent-testing despite
     // this dependency.
     dependsOn(agentForTesting.buildDependencies)
 
     jvmArgumentProviders.add(
       JavaagentTestArgumentsProvider(
         agentShadowJar,
-        shadowJar.archiveFile.get().asFile
+        agentTestingShadowJar.get().archiveFile.get().asFile
       )
     )
 

instrumentation/internal/internal-class-loader/javaagent/build.gradle.kts

@@ -25,31 +25,8 @@ dependencies {
   testImplementation("org.apache.felix:org.apache.felix.framework:6.0.2")
 }
 
-val shadedJar by tasks.registering(ShadowJar::class) {
-  from(zipTree(tasks.jar.get().archiveFile))
-  archiveClassifier.set("shaded")
-}
-
 tasks {
   withType(ShadowJar::class) {
     relocate("io.opentelemetry.javaagent.instrumentation.internal.classloader.stub", "java.lang")
   }
-
-  assemble {
-    dependsOn(shadedJar)
-  }
-}
-
-// Create a consumable configuration for the shaded jar. We can't use the "shadow" configuration
-// because that is taken by the agent-testing.jar
-configurations {
-  consumable("shaded") {
-    attributes {
-      attribute(LibraryElements.LIBRARY_ELEMENTS_ATTRIBUTE, objects.named("shaded"))
-    }
-  }
-}
-
-artifacts {
-  add("shaded", shadedJar)
 }

javaagent-internal-logging-simple/build.gradle.kts

@@ -32,8 +32,4 @@ tasks {
     // Prevents configuration naming conflict with other SLF4J instances
     relocate("org.slf4j", "io.opentelemetry.javaagent.slf4j")
   }
-
-  assemble {
-    dependsOn(shadowJar)
-  }
 }

javaagent/build.gradle.kts

@@ -27,7 +27,19 @@ val bootstrapLibs by configurations.creating {
 val baseJavaagentLibs by configurations.creating {
   isCanBeResolved = true
   isCanBeConsumed = false
+  attributes {
+    attribute(Bundling.BUNDLING_ATTRIBUTE, objects.named(Bundling.SHADOWED))
+  }
+}
+// This compatibility rule allows to fall back to "regular jars" when a baseJavaagentLibs dependency doesn't have a "shadowed" bundling.
+abstract class ShadowedJarRule: AttributeCompatibilityRule<Bundling> {
+  override fun execute(details: CompatibilityCheckDetails<Bundling>) = details.run {
+    if (consumerValue?.name == Bundling.SHADOWED && producerValue?.name == Bundling.EXTERNAL) {
+      compatible()
+    }
+  }
 }
+
 // this configuration collects libs that will be placed in the agent classloader, isolated from the instrumented application code
 val javaagentLibs by configurations.creating {
   isCanBeResolved = true
@@ -54,6 +66,11 @@ val licenseReportDependencies by configurations.creating {
 }
 
 dependencies {
+  attributesSchema {
+    attribute(Bundling.BUNDLING_ATTRIBUTE) {
+      compatibilityRules.add(ShadowedJarRule::class.java)
+    }
+  }
   bootstrapLibs(project(":instrumentation-api"))
   // opentelemetry-api is an api dependency of :instrumentation-api, but opentelemetry-api-incubator is not
   bootstrapLibs("io.opentelemetry:opentelemetry-api-incubator")
@@ -74,7 +91,7 @@ dependencies {
 
   baseJavaagentLibs(project(":javaagent-tooling"))
   baseJavaagentLibs(project(":javaagent-internal-logging-application"))
-  baseJavaagentLibs(project(":javaagent-internal-logging-simple", configuration = "shadow"))
+  baseJavaagentLibs(project(":javaagent-internal-logging-simple"))
   baseJavaagentLibs(project(":muzzle"))
   baseJavaagentLibs(project(":instrumentation:opentelemetry-api:opentelemetry-api-1.0:javaagent"))
   baseJavaagentLibs(project(":instrumentation:opentelemetry-api:opentelemetry-api-1.4:javaagent"))
@@ -94,7 +111,7 @@ dependencies {
   baseJavaagentLibs(project(":instrumentation:opentelemetry-instrumentation-annotations-1.16:javaagent"))
   baseJavaagentLibs(project(":instrumentation:executors:javaagent"))
   baseJavaagentLibs(project(":instrumentation:internal:internal-application-logger:javaagent"))
-  baseJavaagentLibs(project(":instrumentation:internal:internal-class-loader:javaagent", configuration = "shaded"))
+  baseJavaagentLibs(project(":instrumentation:internal:internal-class-loader:javaagent"))
   baseJavaagentLibs(project(":instrumentation:internal:internal-eclipse-osgi-3.6:javaagent"))
   baseJavaagentLibs(project(":instrumentation:internal:internal-lambda:javaagent"))
   baseJavaagentLibs(project(":instrumentation:internal:internal-reflection:javaagent"))