Implementing ability to configure firefox log target using driver service builder or a system property. Sending logs to null output stream by default. Fixes #4136

Author: barancev

java/client/src/org/openqa/selenium/firefox/GeckoDriverService.java

@@ -134,22 +134,24 @@ protected GeckoDriverService createDriverService(File exe, int port,
                                                      ImmutableMap<String, String> environment) {
       try {
         GeckoDriverService service = new GeckoDriverService(exe, port, args, environment);
-        if (getLogFile() !=  null) {
-          // TODO: This stream is leaked.
-          service.sendOutputTo(new FileOutputStream(getLogFile()));
+        String firefoxLogFile = System.getProperty(FirefoxDriver.SystemProperty.BROWSER_LOGFILE);
+        if (firefoxLogFile != null) { // System property has higher precedence
+          if ("/dev/stdout".equals(firefoxLogFile)) {
+            service.sendOutputTo(System.out);
+          } else if ("/dev/stderr".equals(firefoxLogFile)) {
+            service.sendOutputTo(System.err);
+          } else if ("/dev/null".equals(firefoxLogFile)) {
+            service.sendOutputTo(ByteStreams.nullOutputStream());
+          } else {
+            // TODO: The stream is leaked.
+            service.sendOutputTo(new FileOutputStream(firefoxLogFile));
+          }
         } else {
-          String firefoxLogFile = System.getProperty(FirefoxDriver.SystemProperty.BROWSER_LOGFILE);
-          if (firefoxLogFile != null) {
-            if ("/dev/stdout".equals(firefoxLogFile)) {
-              service.sendOutputTo(System.out);
-            } else if ("/dev/stderr".equals(firefoxLogFile)) {
-              service.sendOutputTo(System.err);
-            } else if ("/dev/null".equals(firefoxLogFile)) {
-              service.sendOutputTo(ByteStreams.nullOutputStream());
-            } else {
-              // TODO: The stream is leaked.
-              service.sendOutputTo(new FileOutputStream(firefoxLogFile));
-            }
+          if (getLogFile() != null) {
+            // TODO: This stream is leaked.
+            service.sendOutputTo(new FileOutputStream(getLogFile()));
+          } else {
+            service.sendOutputTo(ByteStreams.nullOutputStream());
           }
         }
         return service;

java/client/src/org/openqa/selenium/firefox/XpiDriverService.java

@@ -24,6 +24,7 @@
 import com.google.common.base.Preconditions;
 import com.google.common.collect.ImmutableList;
 import com.google.common.collect.ImmutableMap;
+import com.google.common.io.ByteStreams;
 
 import org.openqa.selenium.WebDriverException;
 import org.openqa.selenium.firefox.internal.ClasspathExtension;
@@ -56,7 +57,8 @@ private XpiDriverService(
       ImmutableList<String> args,
       ImmutableMap<String, String> environment,
       FirefoxBinary binary,
-      FirefoxProfile profile)
+      FirefoxProfile profile,
+      File logFile)
       throws IOException {
     super(executable, port, args, environment);
 
@@ -67,13 +69,24 @@ private XpiDriverService(
     this.profile = profile;
 
     String firefoxLogFile = System.getProperty(FirefoxDriver.SystemProperty.BROWSER_LOGFILE);
-
-    if (firefoxLogFile !=  null) {
+    if (firefoxLogFile != null) { // System property has higher precedence
       if ("/dev/stdout".equals(firefoxLogFile)) {
         sendOutputTo(System.out);
+      } else if ("/dev/stderr".equals(firefoxLogFile)) {
+        sendOutputTo(System.err);
+      } else if ("/dev/null".equals(firefoxLogFile)) {
+        sendOutputTo(ByteStreams.nullOutputStream());
       } else {
+        // TODO: This stream is leaked.
         sendOutputTo(new FileOutputStream(firefoxLogFile));
       }
+    } else {
+      if (logFile != null) {
+        // TODO: This stream is leaked.
+        sendOutputTo(new FileOutputStream(logFile));
+      } else {
+        sendOutputTo(ByteStreams.nullOutputStream());
+      }
     }
   }
 
@@ -211,7 +224,8 @@ protected XpiDriverService createDriverService(
             args,
             environment,
             binary == null ? new FirefoxBinary() : binary,
-            profile == null ? new FirefoxProfile() : profile);
+            profile == null ? new FirefoxProfile() : profile,
+            getLogFile());
       } catch (IOException e) {
         throw new WebDriverException(e);
       }