How to pass @Input String in a task in buildSrc

Question

This custom plugin exists in gradle's buildSrc/:

abstract class MyTask : DefaultTask() {

    @get:Input
    abstract val buildDir: Property<String>

    @TaskAction
    fun someTask() {
       // do stuff
    }
}

class DevelopmentPlugin : Plugin<Project> {

    override fun apply(project: Project) {
        project.tasks.run {
            register("myTask", MyTask::class.java) {

                inputs.property("buildDir", project.buildDir)

                println(inputs.getProperties())
            }
        }
    }
}

and by running the task with e.g. $ ./gradlew myTask fails with:

Could not determine the dependencies of task ':myTask'.
> Cannot query the value of task ':myTask' property 'rootDir' because it has no value available.

Also the prinln outputs {buildDir=null} meaning that the inputs.property("buildDir", project.buildDir) has failed.

How to pass the project.buildDir value from the Plugin in the task?

Using project.buildDir directly from inside the task is not an acceptable answer due to Gradle's incubating build-cache functionality.

@FranciscoMateo What I ask above :) To pass the `project.buildDir` value from the Plugin in the task (and use it in `someTask`). — Diolor, Dec 11 '21 at 10:05
I understand, but why? What are you trying to achieve or what is the use case — Cisco, Dec 11 '21 at 13:52
Read or write files under `buildDir/somePath/somefile.txt`. The rest is getting out of scope from this very problem. The task should be runnable by both top-level Gradle module and/or submodules. — Diolor, Dec 11 '21 at 14:58

score 0 · Accepted Answer · answered Dec 13 '21 at 14:49

Firstly, there is a class type issue which is not visible in Gradle.

buildDir is of type File while the property is String.

So "${project.buildDir}" should be used.

Secondly, since the property is abstract val it can directly be accessed in the closure. Therefore it can be set with:

// instead of:
inputs.property("buildDir", "${project.buildDir}")
// just this:
buildDir.set("${project.buildDir}")

How to pass @Input String in a task in buildSrc

1 Answers1