Custom property in remotes block?

[cilki]

Feature Request

Is there any way that custom properties could be implemented for each Remote?

remotes {
    local {
        host = 'localhost'
        user = 'username'

        platform = 'linux' // It would be nice to define this right here
        directory = '/home/username/custom'
    }
}

[univerz1977]

You can do it like this:

ssh.remotes {
    host_1 {
        host = '30.4.161.7'
	extensions.add platform:{'linux'}
	extensions.add directory:{'/home/username/custom'}
    }
}

ssh.run{
    session(ssh.remotes.host_1) {
	      executeScript """
			echo "Hello World! ${platform()}"
	      """
	      
    }
}

[cilki]

@univerz1977 Can you explain what this is doing? I'm not proficient in Groovy yet.

It's not working for me. I'm writing a plugin that configures the SSH tasks for my project. When I use platform() in my plugin, I get a MissingMethodException.

Basically I read the remote definitions from a file remote.gradle and for each rhost I have this code in my plugin:

@TaskAction
void action() {
	switch(rhost.platform()){  // MissingMethodException
	case "lin":
		// Configure linux SSH tasks
	case "win":
		// Configure windows SSH tasks
	case "osx":
		// Configure osx SSH tasks
	}

}

[univerz1977]

@cilki Maybe you can try with the simplest way first, below is work for me ( in gradle DSL )

build.gradle

plugins {
    id 'org.hidetake.ssh' version '2.9.0'
}

remotes {
    host_117 {
        host = 'xxx.xxx.xxx.xxx'
        user = 'user'
        identity = file(".ssh/id_rsa")
        knownHosts = file(".ssh/known_hosts")
        extensions.add platform:{'linux xxxxxxxxxxxxxxxxxxxxxxxxxxxxx'}
    }
}

task hello {
	doLast{
    println ssh.version
    ssh.run {
        session(remotes.host_117) {
        		execute "echo ${platform()}"
        }
    }
  }
}

execute command

gradle hello

result

D:\>gradle hello
:hello
gradle-ssh-plugin-2.9.0 (groovy-ssh-2.9.0, jsch-0.1.53, groovy-2.4.12, java-1.8.0_131)
host_117#6|linux xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

BUILD SUCCESSFUL in 2s
1 actionable task: 1 executed

[univerz1977]

@cilki Maybe your code can work by removing "rhost."

[cilki]

@univerz1977 The problem is that I need the platform information before I actually open a session with session(remotes.host_117). So I believe that extensions.add makes platform available to the hello task, but it doesn't help me because I'm operating on the Remote objects.

Maybe there is still a way to get the property after doing extensions.add, but I don't know enough about Gradle extensions to figure that out yet.

[univerz1977]

@cilki try this:

println remotes.host_117.extensions[0].platform()

'extension' actually a list of closure, 'platform' is a name of the closure.

[cilki]

@univerz1977 It's working now. Thank you very much!

For any others with the same issue, you can define custom properties in your remotes block by doing:

extensions.add property:{'value'}

and you can access those properties via the host.extensions list. Just make sure to keep your properties in the same order or add some logic to get the correct property from the list.