CHE-3621 Move SSH machine implementation to separate plugin (eclipse-che#3946)

Author: Max Shaposhnik

agents/exec/pom.xml

@@ -48,14 +48,6 @@
             <groupId>org.eclipse.che.core</groupId>
             <artifactId>che-core-api-machine</artifactId>
         </dependency>
-        <dependency>
-            <groupId>org.eclipse.che.core</groupId>
-            <artifactId>che-core-api-workspace</artifactId>
-        </dependency>
-        <dependency>
-            <groupId>org.slf4j</groupId>
-            <artifactId>slf4j-api</artifactId>
-        </dependency>
     </dependencies>
     <build>
         <plugins>

agents/exec/src/main/java/org/eclipse/che/api/agent/SshMachineExecAgentLauncher.java

@@ -23,7 +23,6 @@
 import org.eclipse.che.api.agent.LSTypeScriptAgent;
 import org.eclipse.che.api.agent.SshAgent;
 import org.eclipse.che.api.agent.SshAgentLauncher;
-import org.eclipse.che.api.agent.SshMachineExecAgentLauncher;
 import org.eclipse.che.api.agent.UnisonAgent;
 import org.eclipse.che.api.agent.WsAgent;
 import org.eclipse.che.api.agent.WsAgentLauncher;
@@ -136,7 +135,6 @@ protected void configure() {
         Multibinder<AgentLauncher> launchers = Multibinder.newSetBinder(binder(), AgentLauncher.class);
         launchers.addBinding().to(WsAgentLauncher.class);
         launchers.addBinding().to(ExecAgentLauncher.class);
-        launchers.addBinding().to(SshMachineExecAgentLauncher.class);
         launchers.addBinding().to(SshAgentLauncher.class);
 
         bindConstant().annotatedWith(Names.named("machine.ws_agent.run_command"))

assembly/assembly-wsmaster-war/src/main/java/org/eclipse/che/api/deploy/WsMasterModule.java

@@ -30,6 +30,10 @@
             <groupId>com.google.code.gson</groupId>
             <artifactId>gson</artifactId>
         </dependency>
+        <dependency>
+            <groupId>com.google.guava</groupId>
+            <artifactId>guava</artifactId>
+        </dependency>
         <dependency>
             <groupId>com.google.inject</groupId>
             <artifactId>guice</artifactId>
@@ -54,6 +58,10 @@
             <groupId>javax.ws.rs</groupId>
             <artifactId>javax.ws.rs-api</artifactId>
         </dependency>
+        <dependency>
+            <groupId>org.eclipse.che.core</groupId>
+            <artifactId>che-core-api-agent-shared</artifactId>
+        </dependency>
         <dependency>
             <groupId>org.eclipse.che.core</groupId>
             <artifactId>che-core-api-core</artifactId>
@@ -66,6 +74,10 @@
             <groupId>org.eclipse.che.core</groupId>
             <artifactId>che-core-api-model</artifactId>
         </dependency>
+        <dependency>
+            <groupId>org.eclipse.che.core</groupId>
+            <artifactId>che-core-api-workspace</artifactId>
+        </dependency>
         <dependency>
             <groupId>org.eclipse.che.core</groupId>
             <artifactId>che-core-commons-annotations</artifactId>
@@ -74,6 +86,10 @@
             <groupId>org.eclipse.che.core</groupId>
             <artifactId>che-core-commons-lang</artifactId>
         </dependency>
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>slf4j-api</artifactId>
+        </dependency>
         <dependency>
             <groupId>ch.qos.logback</groupId>
             <artifactId>logback-classic</artifactId>

plugins/plugin-ssh-machine/pom.xml

@@ -10,22 +10,38 @@
  *******************************************************************************/
 package org.eclipse.che.plugin.machine.ssh;
 
-import com.google.inject.assistedinject.Assisted;
+import com.jcraft.jsch.JSch;
 
 import org.eclipse.che.api.core.model.machine.Command;
 import org.eclipse.che.api.core.model.machine.Machine;
+import org.eclipse.che.api.core.model.machine.ServerConf;
 import org.eclipse.che.api.core.util.LineConsumer;
 import org.eclipse.che.api.machine.server.exception.MachineException;
-import org.eclipse.che.api.machine.server.spi.Instance;
+import org.eclipse.che.plugin.machine.ssh.jsch.JschSshClient;
 
+import javax.inject.Inject;
+import javax.inject.Named;
 import java.util.Map;
+import java.util.Set;
 
 /**
  * Provides ssh machine implementation instances.
  *
  * @author Alexander Garagatyi
+ * @author Max Shaposhnik
  */
-public interface SshMachineFactory {
+public class SshMachineFactory {
+
+    private final int             connectionTimeoutMs;
+    private final Set<ServerConf> machinesServers;
+
+    @Inject
+    public SshMachineFactory(@Named("che.workspace.ssh_connection_timeout_ms") int connectionTimeoutMs,
+                             @Named("machine.ssh.machine_servers") Set<ServerConf> machinesServers) {
+        this.connectionTimeoutMs = connectionTimeoutMs;
+        this.machinesServers = machinesServers;
+    }
+
 
     /**
      * Creates {@link SshClient} to communicate with machine over SSH protocol.
@@ -35,31 +51,39 @@ public interface SshMachineFactory {
      * @param envVars
      *         environment variables that should be injected into machine
      */
-    SshClient createSshClient(@Assisted SshMachineRecipe sshMachineRecipe,
-                              @Assisted Map<String, String> envVars);
+    public SshClient createSshClient(SshMachineRecipe sshMachineRecipe, Map<String, String> envVars) {
+        return new JschSshClient(sshMachineRecipe, envVars, new JSch(), connectionTimeoutMs);
+    }
 
     /**
-     * Creates ssh machine implementation of {@link Instance}.
+     * Creates ssh machine implementation instance.
      *
-     * @param machine description of machine
-     * @param sshClient ssh client of machine
-     * @param outputConsumer consumer of output from container main process
-     * @throws MachineException if error occurs on creation of {@code Instance}
+     * @param machine
+     *         description of machine
+     * @param sshClient
+     *         ssh client of machine
+     * @param outputConsumer
+     *         consumer of output from container main process
+     * @throws MachineException
+     *         if error occurs on creation of {@code Instance}
      */
-    SshMachineInstance createInstance(@Assisted Machine machine,
-                                      @Assisted SshClient sshClient,
-                                      @Assisted LineConsumer outputConsumer) throws MachineException;
+    public SshMachineInstance createInstance(Machine machine, SshClient sshClient, LineConsumer outputConsumer) throws MachineException {
+        return new SshMachineInstance(machine, sshClient, outputConsumer, this, machinesServers);
+    }
 
     /**
-     * Creates ssh machine implementation of {@link org.eclipse.che.api.machine.server.spi.InstanceProcess}.
+     * Creates ssh machine implementation of {@link SshMachineProcess}.
      *
-     * @param command command that should be executed on process start
-     * @param outputChannel channel where output will be available on process execution
-     * @param pid virtual id of that process
-     * @param sshClient client to communicate with machine
+     * @param command
+     *         command that should be executed on process start
+     * @param outputChannel
+     *         channel where output will be available on process execution
+     * @param pid
+     *         virtual id of that process
+     * @param sshClient
+     *         client to communicate with machine
      */
-    SshMachineProcess createInstanceProcess(@Assisted Command command,
-                                            @Assisted("outputChannel") String outputChannel,
-                                            @Assisted int pid,
-                                            @Assisted SshClient sshClient);
+    public SshMachineProcess createInstanceProcess(Command command, String outputChannel, int pid, SshClient sshClient) {
+        return new SshMachineProcess(command, outputChannel, pid, sshClient);
+    }
 }