How do you use file to point to a resource from buildSrc ``` Gradle Community #community-support

How do you use file to point to a resource from bu...

Bernát Gábor

09/23/2024, 6:04 PM

How do you use file to point to a resource from buildSrc?

Copy code

spotbugs {
    excludeFilter = file("spotbugs/spotbugs-exclude.xml")
}

With the buildSrc layout, so when applying the reusable component it does not try to read the file from the project applied but rather from buildSrc resources

Bernát Gábor

09/23/2024, 6:18 PM

Worked, wonder if it is the best solution?

Untitled.kt

Adam

09/23/2024, 8:19 PM

Is the property type of

excludeFilter

a RegularFileProperty? It'd probably be better to create a Gradle output task that would extract the file and produce to a stable output. Creating a temporary file every time will be bad for Gradle caching and up-to-date checks, since the file location will change every time.

Adam

09/23/2024, 8:39 PM

Try this:

Copy code

val prepareSpotbugsExcludeFilter by tasks.registering {
  val file = temporaryDir.resolve("spotbugs-exclude.xml")
  outputs.file(file)
  val content = {}::class.java.getResource("/spotbugs/exclude.xml")?.readText()
  doLast {
    file.parentFile.mkdirs()
    file.writeText(content ?: error("missing /spotbugs/exclude.xml"))
  }
}

spotbugs {
  excludeFilter = prepareSpotbugsExcludeFilter.map { it.outputs.files.singleFile }
}

Bernát Gábor

09/23/2024, 9:26 PM

What is temporaryDir here @Adam?

Adam

09/23/2024, 9:29 PM

https://docs.gradle.org/current/kotlin-dsl/gradle/org.gradle.api/-task/get-temporary-dir.html

🙌 1

Bernát Gábor

09/23/2024, 10:30 PM

I am getting

Copy code

Caused by: org.gradle.api.reflect.ObjectInstantiationException: Could not create an instance of type com.diffplug.gradle.spotless.SpotlessExtensionImpl.
        at         at org.gradle.internal.instantiation.generator.DependencyInjectingInstantiator.doCreate(DependencyInjectingInstantiator.java:70)
        at org.gradle.internal.instantiation.generator.DependencyInjectingInstantiator.newInstanceWithDisplayName(DependencyInjectingInstantiator.java:51)
        at org.gradle.internal.extensibility.DefaultConvention.instantiate(DefaultConvention.java:229)
        at org.gradle.internal.extensibility.DefaultConvention.create(DefaultConvention.java:150)
        at org.gradle.internal.extensibility.DefaultConvention.create(DefaultConvention.java:145)
        at com.diffplug.gradle.spotless.SpotlessPlugin.apply(SpotlessPlugin.java:53)

due to:

Copy code

Caused by: org.gradle.api.internal.AbstractMutationGuard$IllegalMutationException: Project#afterEvaluate(Action) on project ':x:x-core' cannot be executed in the current context.
        at org.gradle.api.internal.AbstractMutationGuard.createIllegalStateException(AbstractMutationGuard.java:39)
        at org.gradle.api.internal.AbstractMutationGuard.assertMutationAllowed(AbstractMutationGuard.java:34)
        at org.gradle.api.internal.project.DefaultProject.assertMutatingMethodAllowed(DefaultProject.java:1477)
        at org.gradle.api.internal.project.DefaultProject.afterEvaluate(DefaultProject.java:1054)
        at com.diffplug.gradle.spotless.SpotlessExtensionImpl.<init>(SpotlessExtensionImpl.java:42)

ideas? 😄

Adam

09/23/2024, 10:39 PM

looks like a bug in the plugin implementation, so I'd raise a bug

Adam

09/23/2024, 10:40 PM

afterEvalute {}

should be avoided wherever possible, and I don't think it's needed here https://github.com/diffplug/spotless/blob/1108c14f83d8e96bc86f923acebfedb5e4a43917/plugin-gradle/src/main/java/com/diffplug/gradle/spotless/SpotlessExtensionImpl.java#L42

Adam

09/23/2024, 10:41 PM

you could try setting

enforceCheck = false

and setting up the task dependency in a more idiomatic way

Bernát Gábor

09/23/2024, 10:59 PM

thanks https://github.com/diffplug/spotless/issues/2268

6 Views

Open in Slack

Previous Next