Skip to content

Gradle config cache: muzzle #15391

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 20, 2025
Merged

Gradle config cache: muzzle #15391

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
50 changes: 39 additions & 11 deletions gradle-plugins/src/main/kotlin/io.opentelemetry.instrumentation.muzzle-check.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,10 +136,21 @@ val muzzle by tasks.registering {
tasks.register("printMuzzleReferences") {
group = "Muzzle"
description = "Print references created by instrumentation muzzle"
val muzzleShadowJarFile = shadowModule.flatMap { it.archiveFile }
val muzzleToolingShadowJarFile = shadowMuzzleTooling.flatMap { it.archiveFile }

dependsOn(compileMuzzle)
dependsOn(shadowModule)
dependsOn(shadowMuzzleTooling)

doLast {
val instrumentationCL = createInstrumentationClassloader()
// Create instrumentation classloader
val instrumentationUrls = arrayOf(
muzzleShadowJarFile.get().asFile.toURI().toURL(),
muzzleToolingShadowJarFile.get().asFile.toURI().toURL()
)
val instrumentationCL = URLClassLoader(instrumentationUrls, ClassLoader.getPlatformClassLoader())

MuzzleGradlePluginUtil.printMuzzleReferences(instrumentationCL)
}
}
Expand All @@ -149,7 +160,8 @@ val hasRelevantTask = gradle.startParameter.taskNames.any {
val taskName = it.removePrefix(":")
val projectPath = project.path.substring(1)
// Either the specific muzzle task in this project or a top level muzzle task.
taskName == "${projectPath}:muzzle" || taskName.startsWith("instrumentation:muzzle")
taskName == "${projectPath}:muzzle" || taskName.startsWith("instrumentation:muzzle") ||
taskName.contains(":muzzle-Assert")
}

if (hasRelevantTask) {
Expand Down Expand Up @@ -206,10 +218,8 @@ fun getProjectRepositories(project: Project): List<RemoteRepository> {
return projectRepositories
}

fun createInstrumentationClassloader(): ClassLoader {
fun createInstrumentationClassloader(muzzleShadowJar: File, muzzleToolingShadowJar: File): ClassLoader {
logger.info("Creating instrumentation class loader for: $path")
val muzzleShadowJar = shadowModule.get().archiveFile.get()
val muzzleToolingShadowJar = shadowMuzzleTooling.get().archiveFile.get()
return classpathLoader(files(muzzleShadowJar, muzzleToolingShadowJar), ClassLoader.getPlatformClassLoader())
}

Expand Down Expand Up @@ -296,24 +306,42 @@ fun addMuzzleTask(muzzleDirective: MuzzleDirective, versionArtifact: Artifact?,
}

val muzzleTask = tasks.register(taskName) {
val configFiles = config.incoming.files
val muzzleShadowJarFile = shadowModule.flatMap { it.archiveFile }
val muzzleToolingShadowJarFile = shadowMuzzleTooling.flatMap { it.archiveFile }
val muzzleBootstrapShadowJarFile = shadowMuzzleBootstrap.flatMap { it.archiveFile }
val excludedNames = muzzleDirective.excludedInstrumentationNames.get()
val shouldAssertPass = muzzleDirective.assertPass.get()

dependsOn(configurations.named("runtimeClasspath"))
dependsOn(shadowModule)
dependsOn(shadowMuzzleTooling)
dependsOn(shadowMuzzleBootstrap)

doLast {
val instrumentationCL = createInstrumentationClassloader()
val userCL = createClassLoaderForTask(config)
// Create instrumentation classloader
val instrumentationUrls = arrayOf(
muzzleShadowJarFile.get().asFile.toURI().toURL(),
muzzleToolingShadowJarFile.get().asFile.toURI().toURL()
)
val instrumentationCL = URLClassLoader(instrumentationUrls, ClassLoader.getPlatformClassLoader())

// Create user classloader
val userUrls = (configFiles + muzzleBootstrapShadowJarFile.get().asFile).map { it.toURI().toURL() }.toTypedArray()
val userCL = URLClassLoader(userUrls, ClassLoader.getPlatformClassLoader())

MuzzleGradlePluginUtil.assertInstrumentationMuzzled(instrumentationCL, userCL,
muzzleDirective.excludedInstrumentationNames.get(), muzzleDirective.assertPass.get())
excludedNames, shouldAssertPass)
}
}

runAfter.configure { finalizedBy(muzzleTask) }
return muzzleTask
}

fun createClassLoaderForTask(muzzleTaskConfiguration: Configuration): ClassLoader {
fun createClassLoaderForTask(muzzleTaskFiles: FileCollection, muzzleBootstrapShadowJar: File): ClassLoader {
logger.info("Creating user class loader for muzzle check")
val muzzleBootstrapShadowJar = shadowMuzzleBootstrap.get().archiveFile.get()
return classpathLoader(muzzleTaskConfiguration + files(muzzleBootstrapShadowJar), ClassLoader.getPlatformClassLoader())
return classpathLoader(muzzleTaskFiles + files(muzzleBootstrapShadowJar), ClassLoader.getPlatformClassLoader())
}

fun inverseOf(muzzleDirective: MuzzleDirective, system: RepositorySystem, session: RepositorySystemSession, repos: List<RemoteRepository>): Set<MuzzleDirective> {
Expand Down
Loading