Refactors Deployment to use dependency injection

Author: JLLeitschuh

ui/src/main/java/edu/wpi/grip/ui/DeployerController.java

@@ -2,9 +2,7 @@
 
 
 import com.google.common.base.Throwables;
-import com.google.common.eventbus.EventBus;
 import com.google.inject.Inject;
-import com.google.inject.Singleton;
 import edu.wpi.grip.ui.annotations.ParametrizedController;
 import edu.wpi.grip.ui.components.StartStoppableButton;
 import edu.wpi.grip.ui.deployment.DeploymentOptionsController;
@@ -24,7 +22,6 @@
 import java.util.function.Supplier;
 import java.util.stream.Collectors;
 
-@Singleton
 @ParametrizedController(url = "DeployerPane.fxml")
 public class DeployerController {
 
@@ -46,7 +43,6 @@ public class DeployerController {
     @FXML
     private ProgressBar progressIndicator;
 
-    private final EventBus eventBus;
     private final StartStoppableButton.Factory startStopButtonFactory;
     private final DeploymentOptionsControllersFactory optionsControllersFactory;
 
@@ -74,8 +70,7 @@ public interface Factory {
     }
 
     @Inject
-    DeployerController(EventBus eventBus, StartStoppableButton.Factory startStopButtonFactory, DeploymentOptionsControllersFactory optionsControllersFactory) {
-        this.eventBus = eventBus;
+    DeployerController(StartStoppableButton.Factory startStopButtonFactory, DeploymentOptionsControllersFactory optionsControllersFactory) {
         this.startStopButtonFactory = startStopButtonFactory;
         this.optionsControllersFactory = optionsControllersFactory;
     }

ui/src/main/java/edu/wpi/grip/ui/GRIPUIModule.java

@@ -10,6 +10,8 @@
 import edu.wpi.grip.core.Source;
 import edu.wpi.grip.ui.annotations.ParametrizedController;
 import edu.wpi.grip.ui.components.StartStoppableButton;
+import edu.wpi.grip.ui.deployment.FRCAdvancedDeploymentOptionsController;
+import edu.wpi.grip.ui.deployment.FRCDeploymentOptionsController;
 import edu.wpi.grip.ui.pipeline.OutputSocketController;
 import edu.wpi.grip.ui.pipeline.SocketHandleView;
 import edu.wpi.grip.ui.pipeline.StepController;
@@ -68,6 +70,9 @@ public <I> void hear(final TypeLiteral<I> typeLiteral, TypeEncounter<I> typeEnco
         install(new FactoryModuleBuilder().build(OperationController.Factory.class));
         install(new FactoryModuleBuilder().build(SocketHandleView.Factory.class));
         install(new FactoryModuleBuilder().build(OutputSocketController.Factory.class));
+        install(new FactoryModuleBuilder().build(DeployerController.Factory.class));
+        install(new FactoryModuleBuilder().build(FRCDeploymentOptionsController.Factory.class));
+        install(new FactoryModuleBuilder().build(FRCAdvancedDeploymentOptionsController.Factory.class));
         // End arbitrary controllers
 
         // InputSocketController Factories

ui/src/main/java/edu/wpi/grip/ui/deployment/DeploymentOptionsController.java

@@ -1,10 +1,10 @@
 package edu.wpi.grip.ui.deployment;
 
+import edu.wpi.grip.ui.annotations.ParametrizedController;
 import edu.wpi.grip.ui.util.SupplierWithIO;
 import edu.wpi.grip.ui.util.deployment.DeployedInstanceManager;
 import javafx.application.Platform;
 import javafx.fxml.FXML;
-import javafx.fxml.FXMLLoader;
 import javafx.scene.control.Button;
 import javafx.scene.control.Label;
 import javafx.scene.control.ProgressIndicator;
@@ -19,6 +19,7 @@
 import java.net.InetAddress;
 import java.util.function.Consumer;
 
+@ParametrizedController(url = "DeploymentOptions.fxml")
 public abstract class DeploymentOptionsController {
 
     @FXML
@@ -39,14 +40,9 @@ public abstract class DeploymentOptionsController {
     private final String title;
     private final Consumer<DeployedInstanceManager> onDeployCallback;
 
-    protected DeploymentOptionsController(String title, Consumer<DeployedInstanceManager> onDeployCallback) {
+    DeploymentOptionsController(String title, Consumer<DeployedInstanceManager> onDeployCallback) {
         this.title = title;
         this.onDeployCallback = onDeployCallback;
-        try {
-            FXMLLoader.load(DeploymentOptionsController.class.getResource("DeploymentOptions.fxml"), null, null, c -> this);
-        } catch (IOException e) {
-            throw new IllegalStateException("Could not load FXML", e);
-        }
     }
 
     @FXML

ui/src/main/java/edu/wpi/grip/ui/deployment/DeploymentOptionsControllersFactory.java

@@ -1,6 +1,8 @@
 package edu.wpi.grip.ui.deployment;
 
 
+import com.google.inject.Inject;
+import com.google.inject.Singleton;
 import edu.wpi.grip.ui.util.deployment.DeployedInstanceManager;
 
 import java.io.OutputStream;
@@ -9,19 +11,25 @@
 import java.util.function.Consumer;
 import java.util.function.Supplier;
 
+@Singleton
 public class DeploymentOptionsControllersFactory {
 
-    private final DeployedInstanceManager.Factory deployedInstanceManagerFactory;
+    private final FRCDeploymentOptionsController.Factory frcDeploymentOptionsControllerFactory;
+    private final FRCAdvancedDeploymentOptionsController.Factory frcAdvancedDeploymentOptionsControllerFactory;
 
-    public DeploymentOptionsControllersFactory(DeployedInstanceManager.Factory deployedInstanceManagerFactory) {
-        this.deployedInstanceManagerFactory = deployedInstanceManagerFactory;
+    @Inject
+    DeploymentOptionsControllersFactory(
+            FRCDeploymentOptionsController.Factory frcDeploymentOptionsControllerFactory,
+            FRCAdvancedDeploymentOptionsController.Factory frcAdvancedDeploymentOptionsControllerFactory) {
+        this.frcDeploymentOptionsControllerFactory = frcDeploymentOptionsControllerFactory;
+        this.frcAdvancedDeploymentOptionsControllerFactory = frcAdvancedDeploymentOptionsControllerFactory;
     }
 
 
     public Collection<DeploymentOptionsController> createControllers(Consumer<DeployedInstanceManager> onDeployCallback, Supplier<OutputStream> stdOut, Supplier<OutputStream> stdErr) {
         return Arrays.asList(
-                new FRCDeploymentOptionsController(deployedInstanceManagerFactory, onDeployCallback, stdOut, stdErr),
-                new FRCAdvancedDeployment(deployedInstanceManagerFactory, onDeployCallback, stdOut, stdErr)
+                frcDeploymentOptionsControllerFactory.create(onDeployCallback, stdOut, stdErr),
+                frcAdvancedDeploymentOptionsControllerFactory.create(onDeployCallback, stdOut, stdErr)
         );
     }
 }

…ui/deployment/FRCAdvancedDeployment.java …AdvancedDeploymentOptionsController.javaui/src/main/java/edu/wpi/grip/ui/deployment/FRCAdvancedDeployment.java renamed to ui/src/main/java/edu/wpi/grip/ui/deployment/FRCAdvancedDeploymentOptionsController.java ui/src/main/java/edu/wpi/grip/ui/deployment/FRCAdvancedDeployment.java renamed to ui/src/main/java/edu/wpi/grip/ui/deployment/FRCAdvancedDeploymentOptionsController.java

@@ -1,5 +1,7 @@
 package edu.wpi.grip.ui.deployment;
 
+import com.google.inject.Inject;
+import com.google.inject.assistedinject.Assisted;
 import edu.wpi.grip.ui.util.deployment.DeployedInstanceManager;
 import javafx.scene.control.Label;
 import javafx.scene.control.TextField;
@@ -12,18 +14,27 @@
 import java.util.function.Consumer;
 import java.util.function.Supplier;
 
-public class FRCAdvancedDeployment extends DeploymentOptionsController {
+public class FRCAdvancedDeploymentOptionsController extends DeploymentOptionsController {
 
 
     private final DeployedInstanceManager.Factory deployedInstanceManagerFactor;
     private final Supplier<OutputStream> stdOut, stdErr;
 
     private TextField address;
 
-    protected FRCAdvancedDeployment(DeployedInstanceManager.Factory deployedInstanceManagerFactor,
-                                    Consumer<DeployedInstanceManager> onDeployCallback,
-                                    Supplier<OutputStream> stdOut,
-                                    Supplier<OutputStream> stdErr) {
+    public interface Factory {
+        FRCAdvancedDeploymentOptionsController create(
+                Consumer<DeployedInstanceManager> onDeployCallback,
+                @Assisted("stdOut") Supplier<OutputStream> stdOut,
+                @Assisted("stdErr") Supplier<OutputStream> stdErr
+        );
+    }
+
+    @Inject
+    FRCAdvancedDeploymentOptionsController(DeployedInstanceManager.Factory deployedInstanceManagerFactor,
+                                           @Assisted Consumer<DeployedInstanceManager> onDeployCallback,
+                                           @Assisted("stdOut") Supplier<OutputStream> stdOut,
+                                           @Assisted("stdErr") Supplier<OutputStream> stdErr) {
         super("FRC Advanced", onDeployCallback);
         this.deployedInstanceManagerFactor = deployedInstanceManagerFactor;
         this.stdOut = stdOut;

ui/src/main/java/edu/wpi/grip/ui/deployment/FRCDeploymentOptionsController.java

@@ -1,5 +1,7 @@
 package edu.wpi.grip.ui.deployment;
 
+import com.google.inject.Inject;
+import com.google.inject.assistedinject.Assisted;
 import edu.wpi.grip.ui.util.deployment.DeployedInstanceManager;
 import javafx.scene.control.Label;
 import javafx.scene.control.Spinner;
@@ -21,10 +23,19 @@ public class FRCDeploymentOptionsController extends DeploymentOptionsController
     private final DeployedInstanceManager.Factory deployedInstanceManagerFactor;
     private final Supplier<OutputStream> stdOut, stdErr;
 
-    protected FRCDeploymentOptionsController(DeployedInstanceManager.Factory deployedInstanceManagerFactor,
-                                             Consumer<DeployedInstanceManager> onDeployCallback,
-                                             Supplier<OutputStream> stdOut,
-                                             Supplier<OutputStream> stdErr) {
+    public interface Factory {
+        FRCDeploymentOptionsController create(
+                Consumer<DeployedInstanceManager> onDeployCallback,
+                @Assisted("stdOut") Supplier<OutputStream> stdOut,
+                @Assisted("stdErr") Supplier<OutputStream> stdErr
+            );
+    }
+
+    @Inject
+    FRCDeploymentOptionsController(DeployedInstanceManager.Factory deployedInstanceManagerFactor,
+                                   @Assisted Consumer<DeployedInstanceManager> onDeployCallback,
+                                   @Assisted("stdOut") Supplier<OutputStream> stdOut,
+                                   @Assisted("stdErr") Supplier<OutputStream> stdErr) {
         super("FRC", onDeployCallback);
         this.deployedInstanceManagerFactor = deployedInstanceManagerFactor;
         this.stdOut = stdOut;

ui/src/main/java/edu/wpi/grip/ui/util/deployment/DeployedInstanceManager.java

@@ -2,6 +2,8 @@
 
 
 import com.google.common.eventbus.EventBus;
+import com.google.inject.Inject;
+import com.google.inject.Singleton;
 import com.jcabi.ssh.Shell;
 import com.jcraft.jsch.JSch;
 import edu.wpi.grip.core.StartStoppable;
@@ -43,14 +45,20 @@ public class DeployedInstanceManager implements StartStoppable {
     private final Supplier<OutputStream> stdErr;
     private Optional<Thread> sshThread;
 
+    @Singleton
     public static class Factory {
         private final EventBus eventBus;
         private final File coreJAR;
         private final Project project;
         private final SecureShellDetails.Factory secureShellDetailsFactory;
         private final DeploymentCommands.Factory deploymentCommandsFactory;
 
-        public Factory(EventBus eventBus, Project project, SecureShellDetails.Factory secureShellDetailsFactory, DeploymentCommands.Factory deploymentCommandsFactory) {
+        @Inject
+        public Factory(
+                EventBus eventBus,
+                Project project,
+                SecureShellDetails.Factory secureShellDetailsFactory,
+                DeploymentCommands.Factory deploymentCommandsFactory) {
             this.eventBus = eventBus;
             try {
                 this.coreJAR = new File(edu.wpi.grip.core.Main.class.getProtectionDomain().getCodeSource().getLocation().toURI().getPath());
@@ -62,10 +70,6 @@ public Factory(EventBus eventBus, Project project, SecureShellDetails.Factory se
             this.deploymentCommandsFactory = deploymentCommandsFactory;
         }
 
-        public Factory(EventBus eventBus, Project project) {
-            this(eventBus, project, new SecureShellDetails.Factory(), new DeploymentCommands.Factory());
-        }
-
         public DeployedInstanceManager createFRC(InetAddress address) {
             return createFRC(address, NullOutputStream::new, NullOutputStream::new);
         }
@@ -93,7 +97,7 @@ public DeployedInstanceManager createFRC(InetAddress addresses, File projectFile
      * @param stdOut             Supplies the stream to be used for the standard output from the ssh command
      * @param stdErr             Supplies the stream to be used for the standard error from the ssh command
      */
-    public DeployedInstanceManager(EventBus eventBus,
+    private DeployedInstanceManager(EventBus eventBus,
                                    File coreJar,
                                    File projectFile,
                                    SecureShellDetails details,

ui/src/main/java/edu/wpi/grip/ui/util/deployment/DeploymentCommands.java

@@ -1,6 +1,8 @@
 package edu.wpi.grip.ui.util.deployment;
 
 
+import com.google.inject.Singleton;
+
 import java.util.function.Function;
 
 import static com.google.common.base.Preconditions.checkNotNull;
@@ -17,8 +19,8 @@ public class DeploymentCommands {
     private final String javaCommand;
     private final Function<String, String> killByNameCommand;
 
+    @Singleton
     public static class Factory {
-
         public DeploymentCommands createFRC() {
             return new DeploymentCommands("/usr/local/frc/JRE/bin/java", DEFAULT_KILL_BY_NAME);
         }

ui/src/main/java/edu/wpi/grip/ui/util/deployment/SecureShellDetails.java

@@ -1,5 +1,6 @@
 package edu.wpi.grip.ui.util.deployment;
 
+import com.google.inject.Singleton;
 import com.jcabi.ssh.SSHByPassword;
 import com.jcabi.ssh.Shell;
 import org.apache.tools.ant.Project;
@@ -23,6 +24,7 @@ public class SecureShellDetails {
     private final Optional<String> remoteDir;
     private final int port;
 
+    @Singleton
     public static class Factory {
         SecureShellDetails createFRC(InetAddress address) {
             return new SecureShellDetails("lvuser", address.getHostAddress());