Skip to content
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

fix: remaining configuration cache issues #1245

Merged
merged 2 commits into from
Dec 3, 2024
Merged

fix: remaining configuration cache issues #1245

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
706bc67
fix: remaining configuration cache issues
lukasgraef Sep 16, 2024
f1c4ea7
fix: broken serialization of NamedDomainObjectFactory on Gradle 7
lukasgraef Dec 1, 2024
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
1 change: 1 addition & 0 deletions api/spotbugs-gradle-plugin.api
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,7 @@ public abstract class com/github/spotbugs/snom/SpotBugsTask : org/gradle/api/Def
public final fun getClasses ()Lorg/gradle/api/file/FileCollection;
public abstract fun getEffort ()Lorg/gradle/api/provider/Property;
public abstract fun getExcludeFilter ()Lorg/gradle/api/file/RegularFileProperty;
public abstract fun getExecOps ()Lorg/gradle/process/ExecOperations;
public abstract fun getExtraArgs ()Lorg/gradle/api/provider/ListProperty;
public fun getIgnoreFailures ()Z
public abstract fun getIncludeFilter ()Lorg/gradle/api/file/RegularFileProperty;
Expand Down
2 changes: 1 addition & 1 deletion src/functionalTest/groovy/com/github/spotbugs/snom/BaseFunctionalTest.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ abstract class BaseFunctionalTest extends Specification {
return new TestGradleRunner()
.withGradleVersion(gradleVersion)
.withProjectDir(rootDir)
.withArguments('--info', '--stacktrace', '--warning-mode=fail')
.withArguments('--configuration-cache', '--info', '--stacktrace', '--warning-mode=fail')
.withTestKitDir(testKitDir)
.forwardOutput()
.withPluginClasspath()
Expand Down
6 changes: 3 additions & 3 deletions src/functionalTest/groovy/com/github/spotbugs/snom/CacheabilityFunctionalTest.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ class CacheabilityFunctionalTest extends BaseFunctionalTest {

when:
BuildResult result = gradleRunner
.withArguments(':spotbugsMain', '--configuration-cache')
.withArguments(':spotbugsMain')
.build()

then:
Expand All @@ -44,7 +44,7 @@ class CacheabilityFunctionalTest extends BaseFunctionalTest {

when:
BuildResult resultOfCachedBuild = gradleRunner
.withArguments(':spotbugsMain', '--configuration-cache')
.withArguments(':spotbugsMain')
.build()
then:
resultOfCachedBuild.task(":spotbugsMain").outcome == TaskOutcome.UP_TO_DATE
Expand Down Expand Up @@ -156,7 +156,7 @@ class CacheabilityFunctionalTest extends BaseFunctionalTest {

when:
def result = gradleRunner
.withArguments(':spotbugsMain', '--configuration-cache')
.withArguments(':spotbugsMain')
.build()

then:
Expand Down
38 changes: 26 additions & 12 deletions src/main/kotlin/com/github/spotbugs/snom/SpotBugsTask.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ import org.gradle.api.Action
import org.gradle.api.DefaultTask
import org.gradle.api.InvalidUserDataException
import org.gradle.api.NamedDomainObjectContainer
import org.gradle.api.NamedDomainObjectFactory
import org.gradle.api.file.ConfigurableFileCollection
import org.gradle.api.file.DirectoryProperty
import org.gradle.api.file.FileCollection
Expand All @@ -48,6 +49,7 @@ import org.gradle.api.tasks.TaskAction
import org.gradle.api.tasks.VerificationTask
import org.gradle.jvm.toolchain.JavaLauncher
import org.gradle.jvm.toolchain.JavaToolchainService
import org.gradle.process.ExecOperations
import org.gradle.workers.WorkerExecutor
import org.slf4j.LoggerFactory

Expand Down Expand Up @@ -93,6 +95,9 @@ abstract class SpotBugsTask : DefaultTask(), VerificationTask {
@get:Inject
abstract val workerExecutor: WorkerExecutor

@get:Inject
abstract val execOps: ExecOperations

@Input
override fun getIgnoreFailures(): Boolean = ignoreFailures.get()

Expand Down Expand Up @@ -304,17 +309,26 @@ abstract class SpotBugsTask : DefaultTask(), VerificationTask {

init {
val objects = project.objects
reports = objects.domainObjectContainer(SpotBugsReport::class.java) { name: String ->
when (name) {
"html" -> objects.newInstance(SpotBugsHtmlReport::class.java, name, objects, this)
"xml" -> objects.newInstance(SpotBugsXmlReport::class.java, name, objects, this)
"text" -> objects.newInstance(SpotBugsTextReport::class.java, name, objects, this)
"sarif" -> objects.newInstance(SpotBugsSarifReport::class.java, name, objects, this)
else -> throw InvalidUserDataException("$name is invalid as the report name")
}.also {
(outputs as org.gradle.api.tasks.TaskOutputs).file(it.outputLocation)
}
}
val taskRef = this
reports = objects.domainObjectContainer(
SpotBugsReport::class.java,
// This anonymous object is necessary
// Otherwise the serialization of this lambda is broken with config-cache on Gradle 7
@Suppress("ObjectLiteralToLambda")
object : NamedDomainObjectFactory<SpotBugsReport> {
override fun create(name: String): SpotBugsReport {
return when (name) {
"html" -> objects.newInstance(SpotBugsHtmlReport::class.java, name, objects, taskRef)
"xml" -> objects.newInstance(SpotBugsXmlReport::class.java, name, objects, taskRef)
"text" -> objects.newInstance(SpotBugsTextReport::class.java, name, objects, taskRef)
"sarif" -> objects.newInstance(SpotBugsSarifReport::class.java, name, objects, taskRef)
else -> throw InvalidUserDataException("$name is invalid as the report name")
}.also {
(outputs as org.gradle.api.tasks.TaskOutputs).file(it.outputLocation)
}
}
},
)
description = "Run SpotBugs analysis."
group = JavaBasePlugin.VERIFICATION_GROUP
}
Expand Down Expand Up @@ -389,7 +403,7 @@ abstract class SpotBugsTask : DefaultTask(), VerificationTask {
SpotBugsRunnerForHybrid(workerExecutor, launcher).run(this)
} else {
log.info("Running SpotBugs by JavaExec...")
SpotBugsRunnerForJavaExec(launcher).run(this)
SpotBugsRunnerForJavaExec(execOps, launcher).run(this)
}
}

Expand Down
9 changes: 4 additions & 5 deletions src/main/kotlin/com/github/spotbugs/snom/internal/SpotBugsRunnerForJavaExec.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,12 @@ import org.gradle.api.file.RegularFileProperty
import org.gradle.api.provider.Property
import org.gradle.api.provider.Provider
import org.gradle.jvm.toolchain.JavaLauncher
import org.gradle.process.ExecOperations
import org.gradle.process.JavaExecSpec
import org.slf4j.LoggerFactory

internal class SpotBugsRunnerForJavaExec @Inject constructor(
private val execOps: ExecOperations,
private val javaLauncher: Property<JavaLauncher>,
) : SpotBugsRunner() {
private val log = LoggerFactory.getLogger(SpotBugsRunnerForJavaExec::class.java)
Expand All @@ -37,14 +39,11 @@ internal class SpotBugsRunnerForJavaExec @Inject constructor(
override fun run(task: SpotBugsTask) {
// TODO print version of SpotBugs and Plugins
try {
task.project.javaexec(configureJavaExec(task)).rethrowFailure().assertNormalExitValue()
execOps.javaexec(configureJavaExec(task)).rethrowFailure().assertNormalExitValue()
if (stderrOutputScanner.isFailedToReport && !task.getIgnoreFailures()) {
throw GradleException("SpotBugs analysis succeeded but report generation failed")
}
} catch (
// TODO remove this internal API usage.
@Suppress("InternalGradleApiUsage") e: org.gradle.process.internal.ExecException,
) {
} catch (e: GradleException) {
if (task.getIgnoreFailures()) {
log.warn(
"SpotBugs reported failures",
Expand Down