Run muzzle check against OpenTelemetry API instrumentation (bridge) (#4797)

* Run muzzle check against bridge

* Simplify

* Renames

Author: trask

gradle-plugins/build.gradle.kts

@@ -14,6 +14,7 @@ apply(from = "../version.gradle.kts")
 
 repositories {
   mavenCentral()
+  gradlePluginPortal()
 }
 
 val bbGradlePlugin by configurations.creating
@@ -33,6 +34,8 @@ dependencies {
   implementation("org.eclipse.aether:aether-transport-http:1.1.0")
   implementation("org.apache.maven:maven-aether-provider:3.3.9")
 
+  implementation("gradle.plugin.com.github.jengelman.gradle.plugins:shadow:7.0.0")
+
   testImplementation("org.assertj:assertj-core:3.19.0")
 
   testImplementation(enforcedPlatform("org.junit:junit-bom:5.7.2"))

…mentation.javaagent-shadowing.gradle.kts …mentation.javaagent-shadowing.gradle.ktsconventions/src/main/kotlin/io.opentelemetry.instrumentation.javaagent-shadowing.gradle.kts renamed to gradle-plugins/src/main/kotlin/io.opentelemetry.instrumentation.javaagent-shadowing.gradle.kts conventions/src/main/kotlin/io.opentelemetry.instrumentation.javaagent-shadowing.gradle.kts renamed to gradle-plugins/src/main/kotlin/io.opentelemetry.instrumentation.javaagent-shadowing.gradle.kts

@@ -3,6 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+import com.github.jengelman.gradle.plugins.shadow.tasks.ShadowJar
 import io.opentelemetry.javaagent.muzzle.AcceptableVersions
 import io.opentelemetry.javaagent.muzzle.MuzzleDirective
 import io.opentelemetry.javaagent.muzzle.MuzzleExtension
@@ -27,6 +28,8 @@ import java.util.stream.StreamSupport
 
 plugins {
   `java-library`
+
+  id("io.opentelemetry.instrumentation.javaagent-shadowing")
 }
 
 // Select a random set of versions to test
@@ -38,14 +41,37 @@ val muzzleTooling: Configuration by configurations.creating {
   isCanBeConsumed = false
   isCanBeResolved = true
 }
+
 val muzzleBootstrap: Configuration by configurations.creating {
   isCanBeConsumed = false
   isCanBeResolved = true
 }
 
+val shadowModule by tasks.registering(ShadowJar::class) {
+  from(tasks.jar)
+
+  configurations = listOf(project.configurations.runtimeClasspath.get())
+
+  archiveFileName.set("module-for-muzzle-check.jar")
+
+  dependsOn(tasks.jar)
+}
+
+val shadowMuzzleTooling by tasks.registering(ShadowJar::class) {
+  configurations = listOf(muzzleTooling)
+
+  archiveFileName.set("tooling-for-muzzle-check.jar")
+}
+
+val shadowMuzzleBootstrap by tasks.registering(ShadowJar::class) {
+  configurations = listOf(muzzleBootstrap)
+
+  archiveFileName.set("bootstrap-for-muzzle-check.jar")
+}
+
 val compileMuzzle by tasks.registering {
-  dependsOn(muzzleBootstrap)
-  dependsOn(muzzleTooling)
+  dependsOn(shadowMuzzleBootstrap)
+  dependsOn(shadowMuzzleTooling)
   dependsOn(tasks.named("classes"))
 }
 
@@ -59,6 +85,7 @@ tasks.register("printMuzzleReferences") {
   group = "Muzzle"
   description = "Print references created by instrumentation muzzle"
   dependsOn(compileMuzzle)
+  dependsOn(shadowModule)
   doLast {
     val instrumentationCL = createInstrumentationClassloader()
     withContextClassLoader(instrumentationCL) {
@@ -126,8 +153,9 @@ if (hasRelevantTask) {
 
 fun createInstrumentationClassloader(): ClassLoader {
   logger.info("Creating instrumentation class loader for: $path")
-  val runtimeClasspath = sourceSets.main.get().runtimeClasspath
-  return classpathLoader(runtimeClasspath + muzzleTooling, ClassLoader.getPlatformClassLoader())
+  val muzzleShadowJar = shadowModule.get().archiveFile.get()
+  val muzzleToolingShadowJar = shadowMuzzleTooling.get().archiveFile.get()
+  return classpathLoader(files(muzzleShadowJar, muzzleToolingShadowJar), ClassLoader.getPlatformClassLoader())
 }
 
 fun classpathLoader(classpath: FileCollection, parent: ClassLoader): ClassLoader {
@@ -214,6 +242,7 @@ fun addMuzzleTask(muzzleDirective: MuzzleDirective, versionArtifact: Artifact?,
 
   val muzzleTask = tasks.register(taskName) {
     dependsOn(configurations.named("runtimeClasspath"))
+    dependsOn(shadowModule)
     doLast {
       val instrumentationCL = createInstrumentationClassloader()
       val userCL = createClassLoaderForTask(config)
@@ -238,7 +267,8 @@ fun addMuzzleTask(muzzleDirective: MuzzleDirective, versionArtifact: Artifact?,
 
 fun createClassLoaderForTask(muzzleTaskConfiguration: Configuration): ClassLoader {
   logger.info("Creating user classloader for muzzle check")
-  return classpathLoader(muzzleTaskConfiguration + muzzleBootstrap, ClassLoader.getPlatformClassLoader())
+  val muzzleBootstrapShadowJar = shadowMuzzleBootstrap.get().archiveFile.get()
+  return classpathLoader(muzzleTaskConfiguration + files(muzzleBootstrapShadowJar), ClassLoader.getPlatformClassLoader())
 }
 
 fun inverseOf(muzzleDirective: MuzzleDirective, system: RepositorySystem, session: RepositorySystemSession): Set<MuzzleDirective> {

gradle-plugins/src/main/kotlin/io.opentelemetry.instrumentation.muzzle-check.gradle.kts

@@ -2,7 +2,15 @@ plugins {
   id("otel.javaagent-instrumentation")
 }
 
-// TODO: add muzzle once 1.4.0 is released
+muzzle {
+  pass {
+    group.set("io.opentelemetry")
+    module.set("opentelemetry-extension-annotations")
+    versions.set("[0.16.0,)")
+    skip("0.13.0") // opentelemetry-api has a bad dependency on non-alpha api-metric 0.13.0
+    assertInverse.set(true)
+  }
+}
 
 val versions: Map<String, String> by project
 

instrumentation/opentelemetry-annotations-1.0/javaagent/build.gradle.kts

@@ -2,7 +2,16 @@ plugins {
   id("otel.javaagent-instrumentation")
 }
 
-// TODO: add muzzle once 1.4.0 is released
+muzzle {
+  pass {
+    group.set("io.opentelemetry")
+    module.set("opentelemetry-api")
+    versions.set("[0.17.0,)")
+    skip("0.13.0") // has a bad dependency on non-alpha api-metric 0.13.0
+    skip("0.9.0") // has no pom file in maven central
+    assertInverse.set(true)
+  }
+}
 
 dependencies {
   // this instrumentation needs to be able to reference both the OpenTelemetry API