* [JENKINS-45781] Remote ssh host management and configurable host na…

src/main/java/org/jvnet/hudson/plugins/CredentialsSSHSite.java

@@ -41,6 +41,7 @@
 import com.jcraft.jsch.ChannelExec;
 import com.jcraft.jsch.JSchException;
 import com.jcraft.jsch.Session;
+import hudson.Util;
 
 public class CredentialsSSHSite {
 
@@ -49,6 +50,8 @@ public static class LegacySSHSite extends CredentialsSSHSite {
 		transient String keyfile;
 	}
 
+	String name;
+
 	String hostname;
 	String username;
 	int port;
@@ -67,13 +70,14 @@ private CredentialsSSHSite() {
 	}
 
 	@DataBoundConstructor
-	public CredentialsSSHSite(final String hostname, final String port, final String credentialId,
+	public CredentialsSSHSite(final String name, final String hostname, final String port, final String credentialId,
 			final String serverAliveInterval, final String timeout) {
 		final StandardUsernameCredentials credentials = lookupCredentialsById(credentialId);
 		if (credentials != null) {
 			this.username = credentials.getUsername();
 		}
 
+		this.name = Util.fixEmptyAndTrim(name);
 		this.hostname = hostname;
 		try {
 			this.port = Integer.parseInt(port);
@@ -192,7 +196,7 @@ legacy.username, new FileOnMasterPrivateKeySource(legacy.keyfile), legacy.passwo
 			credentialId = existingCredentials.getId();
 		}
 
-		return new CredentialsSSHSite(legacy.hostname, String.valueOf(legacy.port), credentialId,
+		return new CredentialsSSHSite(null, legacy.hostname, String.valueOf(legacy.port), credentialId,
 				String.valueOf(legacy.serverAliveInterval), String.valueOf(legacy.timeout));
 	}
 
@@ -299,7 +303,7 @@ public String getServerAliveInterval() {
 
 	/** Returns &quot;identifier&quot; for ssh site: <strong>username@hostname:port</strong> */
 	public String getSitename() {
-		return username + "@" + hostname + ":" + port;
+		return (Util.fixEmptyAndTrim(name) == null) ? username + "@" + hostname + ":" + port : name + " - " + username + "@" + hostname + ":" + port;
 	}
 
 	public String getTimeout() {
@@ -329,6 +333,14 @@ public void setPort(final String port) {
 		}
 	}
 
+	public String getName() {
+		return name;
+	}
+
+	public void setName(String name) {
+		this.name = Util.fixEmptyAndTrim(name);
+	}
+
 	@DataBoundSetter
 	public void setPty(final Boolean pty) {
 		this.pty = pty;
@@ -365,7 +377,7 @@ public void testConnection(final PrintStream logger) throws JSchException, IOExc
 
 	@Override
 	public String toString() {
-		return "SSHSite [username=" + username + ", hostname=" + hostname + ",port=" + port + ", credentialId="
+		return "SSHSite [name=" + name + ", username=" + username + ", hostname=" + hostname + ",port=" + port + ", credentialId="
 				+ credentialId + ", pty=" + pty + "]";
 	}
 

src/main/java/org/jvnet/hudson/plugins/SSHBuildWrapper.java

@@ -259,11 +259,12 @@ public ListBoxModel doFillCredentialIdItems(final @AncestorInPath ItemGroup<?> c
 		/**
 		 * Validates ssh connection - currently this is executed on master node
 		 */
-		public FormValidation doLoginCheck(@QueryParameter("hostname") String hostname,
+		public FormValidation doLoginCheck(@QueryParameter("name") String name, @QueryParameter("hostname") String hostname,
 				@QueryParameter("port") String port,
 				@QueryParameter("credentialId") String credentialId,
 				@QueryParameter("serverAliveInterval") String serverAliveInterval,
 				@QueryParameter("timeout") String timeout) {
+			name = Util.fixEmptyAndTrim(name);
 			hostname = Util.fixEmpty(hostname);
 			port = Util.fixEmpty(port);
 			credentialId = Util.fixEmpty(credentialId);
@@ -272,7 +273,7 @@ public FormValidation doLoginCheck(@QueryParameter("hostname") String hostname,
 				return FormValidation.warning("Please fill host, port and credentials.");
 			}
 
-			final CredentialsSSHSite site = new CredentialsSSHSite(hostname, port, credentialId,
+			final CredentialsSSHSite site = new CredentialsSSHSite(name, hostname, port, credentialId,
 					serverAliveInterval, timeout);
 			try {
 				try {

src/main/resources/org/jvnet/hudson/plugins/SSHBuildWrapper/global.jelly

@@ -5,6 +5,9 @@
       description="${%SSH sites that projects will want to connect}">
       <f:repeatable var="site" name="sites" items="${descriptor.sites}">
         <table width="100%">
+          <f:entry title="${%Name}" help="/plugin/ssh/help-name.html">
+            <f:textbox name="name" value="${site.name}"/>
+          </f:entry>
           <f:entry title="${%Hostname}" help="/plugin/ssh/help-hostname.html">
             <f:textbox name="hostname" value="${site.hostname}" checkUrl="'${rootURL}/descriptorByName/org.jvnet.hudson.plugins.SSHBuildWrapper/checkHostname?hostname='+escape(this.value)" />
           </f:entry>

src/main/webapp/help-name.html

@@ -0,0 +1 @@
+<div>SSH name/alias</div>

src/main/webapp/help-name_ja.html

@@ -0,0 +1 @@
+<div>SSH名/エイリアス</div>

src/test/java/org/jvnet/hudson/plugins/SSHBuildWrapperTest.java

@@ -82,4 +82,16 @@ public void loadAllThreePossibleSiteConfigs() throws Exception {
 			}
 		}
 	}
+
+	@LocalData
+	@Test
+	public void checkNameForSSHConfiguration() throws Exception {
+		SSHBuildWrapper.DescriptorImpl desc = new SSHBuildWrapper.DescriptorImpl();
+		assertEquals(3, desc.getSites().length);
+
+		CredentialsSSHSite[] site = desc.getSites();
+			assertEquals("SSH worker1 - root@worker1.example.com:22", site[0].getSitename());
+			assertEquals("root@worker2.example.com:22", site[1].getSitename());
+			assertEquals("root@worker3.example.com:22", site[2].getSitename());
+	}
 }

src/test/resources/org/jvnet/hudson/plugins/SSHBuildWrapperTest/checkNameForSSHConfiguration/config.xml

@@ -0,0 +1,16 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<hudson>
+  <version>1.609.3</version>
+  <numExecutors>1</numExecutors>
+  <mode>NORMAL</mode>
+  <useSecurity>true</useSecurity>
+  <authorizationStrategy class="hudson.security.ProjectMatrixAuthorizationStrategy">
+    <permission>hudson.model.Hudson.Read:anonymous</permission>
+    <permission>hudson.model.Item.Read:anonymous</permission>
+  </authorizationStrategy>
+  <securityRealm class="hudson.security.LegacySecurityRealm"/>
+  <jdks/>
+  <slaves/>
+  <quietPeriod>5</quietPeriod>
+</hudson>
+

src/test/resources/org/jvnet/hudson/plugins/SSHBuildWrapperTest/checkNameForSSHConfiguration/org.jvnet.hudson.plugins.SSHBuildWrapper.xml

@@ -0,0 +1,33 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<org.jvnet.hudson.plugins.SSHBuildWrapper_-DescriptorImpl plugin="ssh@2.6">
+  <sites>
+    <org.jvnet.hudson.plugins.CredentialsSSHSite>
+      <name>SSH worker1</name>
+      <hostname>worker1.example.com</hostname>
+      <port>22</port>
+      <username>root</username>
+      <credentialId>ca0fcca1-8d34-4f6d-91d3-61a58a1ebb8a</credentialId>
+      <timeout>0</timeout>
+      <pty>false</pty>
+    </org.jvnet.hudson.plugins.CredentialsSSHSite>
+    <org.jvnet.hudson.plugins.CredentialsSSHSite>
+      <name/>
+      <hostname>worker2.example.com</hostname>
+      <port>22</port>
+      <username>root</username>
+      <credentialId>ca0fcca1-8d34-4f6d-91d3-61a58a1ebb8a</credentialId>
+      <timeout>0</timeout>
+      <pty>false</pty>
+    </org.jvnet.hudson.plugins.CredentialsSSHSite>
+    <org.jvnet.hudson.plugins.CredentialsSSHSite>
+      <name>  </name>
+      <hostname>worker3.example.com</hostname>
+      <port>22</port>
+      <username>root</username>
+      <credentialId>ca0fcca1-8d34-4f6d-91d3-61a58a1ebb8a</credentialId>
+      <timeout>0</timeout>
+      <pty>false</pty>
+    </org.jvnet.hudson.plugins.CredentialsSSHSite>
+  </sites>
+</org.jvnet.hudson.plugins.SSHBuildWrapper_-DescriptorImpl>
+