Introducing CollectStdOut and CollectStdOutStderrExecutor, handy classes for executing external execs and collecting their outputs

Author: Federico Fissore

arduino-core/src/processing/app/linux/Platform.java

@@ -26,8 +26,8 @@
 import org.apache.commons.exec.Executor;
 import processing.app.PreferencesData;
 import processing.app.debug.TargetPackage;
-import processing.app.tools.ExternalProcessExecutor;
 import processing.app.legacy.PConstants;
+import processing.app.tools.CollectStdOutExecutor;
 
 import java.io.*;
 import java.util.Map;
@@ -131,7 +131,7 @@ public String getName() {
   @Override
   public Map<String, Object> resolveDeviceAttachedTo(String serial, Map<String, TargetPackage> packages, String devicesListOutput) {
     ByteArrayOutputStream baos = new ByteArrayOutputStream();
-    Executor executor = new ExternalProcessExecutor(baos);
+    Executor executor = new CollectStdOutExecutor(baos);
 
     try {
       CommandLine toDevicePath = CommandLine.parse("udevadm info -q path -n " + serial);

arduino-core/src/processing/app/macosx/Platform.java

@@ -27,9 +27,9 @@
 import org.apache.commons.exec.CommandLine;
 import org.apache.commons.exec.Executor;
 import processing.app.debug.TargetPackage;
-import processing.app.tools.ExternalProcessExecutor;
 import processing.app.legacy.PApplet;
 import processing.app.legacy.PConstants;
+import processing.app.tools.CollectStdOutExecutor;
 
 import javax.swing.*;
 import java.awt.*;
@@ -231,7 +231,7 @@ public Map<String, Object> resolveDeviceAttachedTo(String serial, Map<String, Ta
   @Override
   public String preListAllCandidateDevices() {
     ByteArrayOutputStream baos = new ByteArrayOutputStream();
-    Executor executor = new ExternalProcessExecutor(baos);
+    Executor executor = new CollectStdOutExecutor(baos);
 
     try {
       CommandLine toDevicePath = CommandLine.parse("/usr/sbin/system_profiler SPUSBDataType");

…g/app/tools/ExternalProcessExecutor.java …ing/app/tools/CollectStdOutExecutor.javaarduino-core/src/processing/app/tools/ExternalProcessExecutor.java renamed to arduino-core/src/processing/app/tools/CollectStdOutExecutor.java arduino-core/src/processing/app/tools/ExternalProcessExecutor.java renamed to arduino-core/src/processing/app/tools/CollectStdOutExecutor.java

@@ -10,9 +10,9 @@
 /**
  * Handy process executor, collecting stdout into a given OutputStream
  */
-public class ExternalProcessExecutor extends DefaultExecutor {
+public class CollectStdOutExecutor extends DefaultExecutor {
 
-  public ExternalProcessExecutor(final OutputStream os) {
+  public CollectStdOutExecutor(final OutputStream stdout) {
     this.setStreamHandler(new ExecuteStreamHandler() {
       @Override
       public void setProcessInputStream(OutputStream outputStream) throws IOException {
@@ -27,7 +27,7 @@ public void setProcessOutputStream(InputStream inputStream) throws IOException {
         byte[] buf = new byte[4096];
         int bytes = -1;
         while ((bytes = inputStream.read(buf)) != -1) {
-          os.write(buf, 0, bytes);
+          stdout.write(buf, 0, bytes);
         }
       }
 

arduino-core/src/processing/app/tools/CollectStdOutStdErrExecutor.java

@@ -0,0 +1,49 @@
+package processing.app.tools;
+
+import org.apache.commons.exec.DefaultExecutor;
+import org.apache.commons.exec.ExecuteStreamHandler;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
+
+/**
+ * Handy process executor, collecting stdout and stderr into given OutputStreams
+ */
+public class CollectStdOutStdErrExecutor extends DefaultExecutor {
+
+  public CollectStdOutStdErrExecutor(final OutputStream stdout, final OutputStream stderr) {
+    this.setStreamHandler(new ExecuteStreamHandler() {
+      @Override
+      public void setProcessInputStream(OutputStream outputStream) throws IOException {
+      }
+
+      @Override
+      public void setProcessErrorStream(InputStream inputStream) throws IOException {
+        byte[] buf = new byte[4096];
+        int bytes = -1;
+        while ((bytes = inputStream.read(buf)) != -1) {
+          stderr.write(buf, 0, bytes);
+        }
+      }
+
+      @Override
+      public void setProcessOutputStream(InputStream inputStream) throws IOException {
+        byte[] buf = new byte[4096];
+        int bytes = -1;
+        while ((bytes = inputStream.read(buf)) != -1) {
+          stdout.write(buf, 0, bytes);
+        }
+      }
+
+      @Override
+      public void start() throws IOException {
+      }
+
+      @Override
+      public void stop() {
+      }
+    });
+
+  }
+}

arduino-core/src/processing/app/windows/Platform.java

@@ -32,7 +32,8 @@
 import processing.app.debug.TargetPackage;
 import processing.app.legacy.PApplet;
 import processing.app.legacy.PConstants;
-import processing.app.tools.ExternalProcessExecutor;
+import processing.app.tools.CollectStdOutExecutor;
+import processing.app.tools.CollectStdOutStdErrExecutor;
 import processing.app.windows.Registry.REGISTRY_ROOT_KEY;
 
 import java.io.ByteArrayOutputStream;
@@ -338,7 +339,7 @@ public Map<String, Object> resolveDeviceAttachedTo(String serial, Map<String, Ta
   @Override
   public String preListAllCandidateDevices() {
     ByteArrayOutputStream baos = new ByteArrayOutputStream();
-    Executor executor = new ExternalProcessExecutor(baos);
+    Executor executor = new CollectStdOutExecutor(baos);
 
     try {
       String listComPorts = new File(System.getProperty("user.dir"), "hardware/tools/listComPorts.exe").getCanonicalPath();