Deployment fixes code from review

Author: JLLeitschuh

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

@@ -50,6 +50,7 @@ private class StreamToTextArea extends OutputStream {
         private final TextArea outputArea;
 
         public StreamToTextArea(TextArea outputArea) {
+            super();
             this.outputArea = outputArea;
         }
 
@@ -76,6 +77,7 @@ public interface Factory {
     }
 
     @FXML
+    @SuppressWarnings("PMD.UnusedPrivateMethod")
     private void initialize() {
         final Supplier<OutputStream> out = () ->
                 new PrintStream(new StreamToTextArea(stdOutStreamTextArea).reset(), false);
@@ -89,6 +91,10 @@ private void initialize() {
                         .collect(Collectors.toList()));
     }
 
+    /**
+     * Calls {@link DeployedInstanceManager#deploy()} and displays the result to the UI.
+     * @param manager The manager to call deploy on
+     */
     private void onDeploy(DeployedInstanceManager manager) {
         Platform.runLater(() -> {
             progressIndicator.setProgress(0);

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

@@ -19,6 +19,10 @@
 import java.net.InetAddress;
 import java.util.function.Consumer;
 
+/**
+ * A simple UI component that can be used to display options for deploying to a remote device using
+ * asynchronous callbacks.
+ */
 @ParametrizedController(url = "DeploymentOptions.fxml")
 public abstract class DeploymentOptionsController {
 
@@ -59,6 +63,7 @@ protected final void initialize() {
     protected abstract Promise<DeployedInstanceManager, String, String> onDeploy();
 
     @FXML
+    @SuppressWarnings("PMD.UnusedPrivateMethod")
     private void deploy() {
         deploySpinner.setVisible(true);
         deployButton.setDisable(true);
@@ -99,15 +104,21 @@ public TitledPane getRoot() {
         return root;
     }
 
-    protected static Promise<InetAddress, Throwable, String> checkInetAddressReachable(SupplierWithIO<InetAddress> address){
+    /**
+     * Checks that an InetAddress is reachable asynchronously
+     *
+     * @param address The address supplier to check
+     * @return A promise that is resolved when the InetAddress is determined to be reachable.
+     */
+    protected static Promise<InetAddress, Throwable, String> checkInetAddressReachable(SupplierWithIO<InetAddress> address) {
         final DeferredManager checkAddressDeferred = new DefaultDeferredManager();
         return checkAddressDeferred.when(new DeferredCallable<InetAddress, String>() {
             @Override
-            public InetAddress call() throws Exception {
+            public InetAddress call() throws IOException {
                 final InetAddress inetAddress = address.getWithIO();
                 final int attemptCount = 5;
                 for (int i = 0; i < attemptCount; i++) {
-                    if(inetAddress.isReachable(1000)) {
+                    if (inetAddress.isReachable(1000)) {
                         return inetAddress;
                     } else {
                         notify("Attempt " + i + "/" + attemptCount + " failed");

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

@@ -50,7 +50,7 @@ protected void postInit() {
         this.address.textProperty().addListener((observable, oldValue, newValue) -> {
             // Enable the "Deploy" button only if the user has entered something.
             // Note: InetAddresses.isInetAddress only works for IP address not mdns names
-            if (newValue.equals("")) {
+            if ("".equals(newValue)) {
                 getDeployButton().setDisable(true);
             } else {
                 getDeployButton().setDisable(false);

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

@@ -43,14 +43,15 @@ FRCDeploymentOptionsController create(
     }
 
     @Override
+    @SuppressWarnings("PMD.IfElseStmtsMustUseBraces")
     protected void postInit() {
         final Label label = new Label("Team Number");
         final SpinnerValueFactory.IntegerSpinnerValueFactory spinnerValueFactory = new SpinnerValueFactory.IntegerSpinnerValueFactory(0, Integer.MAX_VALUE, 190);
         this.teamNumberSpinner = new Spinner(spinnerValueFactory);
         this.teamNumberSpinner.setEditable(true);
         // Ensure the value entered is only a number
         this.teamNumberSpinner.getEditor().textProperty().addListener((observable, oldValue, newValue) -> {
-            if (newValue.equals("")) {
+            if ("".equals(newValue)) {
                 teamNumberSpinner.getEditor().setText(Integer.toString(0));
             } else try {
                 int value = Integer.parseInt(newValue);

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

@@ -28,6 +28,8 @@
 import java.nio.file.Paths;
 import java.util.Optional;
 import java.util.function.Supplier;
+import java.util.logging.Level;
+import java.util.logging.Logger;
 
 import static com.google.common.base.Preconditions.checkNotNull;
 
@@ -36,6 +38,7 @@
  */
 public class DeployedInstanceManager implements StartStoppable {
 
+    private final Logger logger = Logger.getLogger(DeployedInstanceManager.class.getName());
     private final EventBus eventBus;
     private final File coreJar;
     private final File projectFile;
@@ -125,7 +128,7 @@ public synchronized Promise<DeployedInstanceManager, Throwable, Double> deploy()
 
         return deferred.when(new DeferredCallable<DeployedInstanceManager, Double>() {
             @Override
-            public DeployedInstanceManager call() throws Exception {
+            public DeployedInstanceManager call() throws IOException {
                 notify(0.2);
                 scpFileToTarget(coreJar);
                 notify(0.5);
@@ -209,15 +212,18 @@ public synchronized void stop() throws IOException {
                 wait(50);
             } catch (InterruptedException e) {
                 Thread.currentThread().interrupt();
-                //TODO: Move this into a logging framework
-                System.err.println("Caught Exception:");
-                e.printStackTrace();
+                logger.log(Level.WARNING, "Wait interrupted", e);
             }
             runStop();
         } while (isStarted() && !Thread.interrupted());
         eventBus.post(new StartedStoppedEvent(this));
     }
 
+    /**
+     * Makes an SSH connection to the remote and runs the kill command.
+     * Should block until the command has executed.
+     * @throws IOException If the shell fails.
+     */
     private void runStop() throws IOException {
         final Shell.Plain gripShell = new Shell.Plain(new Shell.Safe(details.createSSHShell()));
         gripShell.exec(deploymentCommands.getKillCommand(coreJar.getName()));