How to work with configuration cache

[cocorossello]

I would like to work with configuration cache, but I don't really know how to write the tasks so gradle can work with configuration cache.

¿Any ideas?

Environment info

id 'org.hidetake.ssh' version '2.11.2'
java: temurin 23.0.1
gradle 8.11.1

windows (also happens in linux)

Steps to reproduce

Activate gradle configuration cache in gradle.properties:

org.gradle.configuration-cache=true

Run any simple task from documentation:

tasks.register("someSshTask") {
    doLast {
        ssh.run {
            session(remotes['some-remote']) {
                execute 'echo hello wold'
            }
        }
    }
}

Output is:

Execution failed for task ':tr2-web-test:someSshTask'.
> Could not get unknown property 'ssh' for task ':tr2-web-test:someSshTask' of type org.gradle.api.DefaultTask.

* Try:
> Run with --info or --debug option to get more log output.
> Get more help at https://help.gradle.org.

* Exception is:
org.gradle.api.tasks.TaskExecutionException: Execution failed for task ':tr2-web-test:someSshTask'.
	at org.gradle.api.internal.tasks.execution.ExecuteActionsTaskExecuter.lambda$executeIfValid$1(ExecuteActionsTaskExecuter.java:130)
	at org.gradle.internal.Try$Failure.ifSuccessfulOrElse(Try.java:293)
	at org.gradle.api.internal.tasks.execution.ExecuteActionsTaskExecuter.executeIfValid(ExecuteActionsTaskExecuter.java:128)
	at org.gradle.api.internal.tasks.execution.ExecuteActionsTaskExecuter.execute(ExecuteActionsTaskExecuter.java:116)
	at org.gradle.api.internal.tasks.execution.FinalizePropertiesTaskExecuter.execute(FinalizePropertiesTaskExecuter.java:46)
	at org.gradle.api.internal.tasks.execution.ResolveTaskExecutionModeExecuter.execute(ResolveTaskExecutionModeExecuter.java:51)
	at org.gradle.api.internal.tasks.execution.SkipTaskWithNoActionsExecuter.execute(SkipTaskWithNoActionsExecuter.java:57)
	at org.gradle.api.internal.tasks.execution.SkipOnlyIfTaskExecuter.execute(SkipOnlyIfTaskExecuter.java:74)
	at org.gradle.api.internal.tasks.execution.CatchExceptionTaskExecuter.execute(CatchExceptionTaskExecuter.java:36)
	at org.gradle.api.internal.tasks.execution.EventFiringTaskExecuter$1.executeTask(EventFiringTaskExecuter.java:77)
	at org.gradle.api.internal.tasks.execution.EventFiringTaskExecuter$1.call(EventFiringTaskExecuter.java:55)
	at org.gradle.api.internal.tasks.execution.EventFiringTaskExecuter$1.call(EventFiringTaskExecuter.java:52)
	at org.gradle.internal.operations.DefaultBuildOperationRunner$CallableBuildOperationWorker.execute(DefaultBuildOperationRunner.java:209)
	at org.gradle.internal.operations.DefaultBuildOperationRunner$CallableBuildOperationWorker.execute(DefaultBuildOperationRunner.java:204)
	at org.gradle.internal.operations.DefaultBuildOperationRunner$2.execute(DefaultBuildOperationRunner.java:66)
	at org.gradle.internal.operations.DefaultBuildOperationRunner$2.execute(DefaultBuildOperationRunner.java:59)
	at org.gradle.internal.operations.DefaultBuildOperationRunner.execute(DefaultBuildOperationRunner.java:166)
	at org.gradle.internal.operations.DefaultBuildOperationRunner.execute(DefaultBuildOperationRunner.java:59)
	at org.gradle.internal.operations.DefaultBuildOperationRunner.call(DefaultBuildOperationRunner.java:53)
	at org.gradle.api.internal.tasks.execution.EventFiringTaskExecuter.execute(EventFiringTaskExecuter.java:52)
	at org.gradle.execution.plan.LocalTaskNodeExecutor.execute(LocalTaskNodeExecutor.java:42)
	at org.gradle.execution.taskgraph.DefaultTaskExecutionGraph$InvokeNodeExecutorsAction.execute(DefaultTaskExecutionGraph.java:331)
	at org.gradle.execution.taskgraph.DefaultTaskExecutionGraph$InvokeNodeExecutorsAction.execute(DefaultTaskExecutionGraph.java:318)
	at org.gradle.execution.taskgraph.DefaultTaskExecutionGraph$BuildOperationAwareExecutionAction.lambda$execute$0(DefaultTaskExecutionGraph.java:314)
	at org.gradle.internal.operations.CurrentBuildOperationRef.with(CurrentBuildOperationRef.java:85)
	at org.gradle.execution.taskgraph.DefaultTaskExecutionGraph$BuildOperationAwareExecutionAction.execute(DefaultTaskExecutionGraph.java:314)
	at org.gradle.execution.taskgraph.DefaultTaskExecutionGraph$BuildOperationAwareExecutionAction.execute(DefaultTaskExecutionGraph.java:303)
	at org.gradle.execution.plan.DefaultPlanExecutor$ExecutorWorker.execute(DefaultPlanExecutor.java:459)
	at org.gradle.execution.plan.DefaultPlanExecutor$ExecutorWorker.run(DefaultPlanExecutor.java:376)
	at org.gradle.internal.concurrent.ExecutorPolicy$CatchAndRecordFailures.onExecute(ExecutorPolicy.java:64)
	at org.gradle.internal.concurrent.AbstractManagedExecutor$1.run(AbstractManagedExecutor.java:48)
Caused by: groovy.lang.MissingPropertyException: Could not get unknown property 'ssh' for task ':tr2-web-test:someSshTask' of type org.gradle.api.DefaultTask.
	at org.gradle.internal.metaobject.AbstractDynamicObject.getMissingProperty(AbstractDynamicObject.java:85)
	at org.gradle.internal.metaobject.AbstractDynamicObject.getProperty(AbstractDynamicObject.java:62)
	at org.gradle.api.DefaultTask_Decorated.getProperty(Unknown Source)

[cocorossello]

I found the solution:

tasks.register("someSshTask") {
    def ssh = project.getExtensions().findByName("ssh")
    def remotes = project.getExtensions().findByName("remotes")
    doLast {
        ssh.run {
            session(remotes['some.host']) {
                execute 'echo hello wold'
            }
        }
    }
}

The only caveat is that you must modify gradle jvm arguments in gradle.properties:

org.gradle.jvmargs=--add-opens=java.base/java.util.concurrent=ALL-UNNAMED

Otherwise you get the error:

Configuration cache state could not be cached: field `proxies` of `org.hidetake.groovy.ssh.core.Service` bean found in field `value` of `groovy.lang.Reference` bean found in field `ssh` of `build_akqdccl5udnv5900f8d5tkoyg$_run_closure5$_closure8` bean found in field `closure` of `org.gradle.api.internal.AbstractTask$ClosureTaskAction` bean found in field `actions` of task `:someSshTask` of type `org.gradle.api.DefaultTask`: error writing value of type 'org.hidetake.groovy.ssh.core.container.ProxyContainer'
> Unable to make private void java.util.concurrent.ConcurrentSkipListMap.writeObject(java.io.ObjectOutputStream) throws java.io.IOException accessible: module java.base does not "opens java.util.concurrent" to unnamed module @4e212dee

[karstenrenhak]

Thanks @cocorossello for the workaround.
Unfortunately it doesn’t work for roles.
This example produces the error message below:

tasks.register('upload') {
	def ssh = project.getExtensions().findByName("ssh")
	def remotes = project.getExtensions().findByName("remotes")
	doLast {
		ssh.run {
			session(remotes.role('test')) {
				println "Upload"
			}
		}
	}
}

Could not find method role() for arguments [test] on Remote container of type org.gradle.api.internal.FactoryNamedDomainObjectContainer.

Any ideas to fix this?