Improve logging errors (#13327)

* Refactored log capture and formatting code in org.openqa.selenium.testing and org.openqa.selenium.grid.log packages.

* Add logging capability to various classes across the project

The commit introduces a Logger in various classes to handle exceptions more efficiently. Instead of simply outputting exceptions via printStackTrace, they are now logged using java.util.logging.Logger. This improvement allows for enhanced understanding and handling of exception occurrences during execution.

---------

Co-authored-by: Diego Molina <[email protected]>

Author: manuelsblanco

java/src/org/openqa/selenium/grid/Bootstrap.java

@@ -76,7 +76,7 @@ private static void runMain(ClassLoader loader, String[] args) {
       Method main = clazz.getMethod("main", String[].class);
       main.invoke(null, new Object[] {args});
     } catch (ReflectiveOperationException e) {
-      e.printStackTrace();
+      LOG.severe("Error during execution: " + e.getMessage());
       System.exit(1);
     }
   }

java/src/org/openqa/selenium/grid/jmx/JMXHelper.java

@@ -18,12 +18,15 @@
 package org.openqa.selenium.grid.jmx;
 
 import java.lang.management.ManagementFactory;
+import java.util.logging.Logger;
 import javax.management.InstanceAlreadyExistsException;
 import javax.management.MBeanServer;
 import javax.management.ObjectName;
 
 public class JMXHelper {
 
+  private static final Logger LOG = Logger.getLogger(JMXHelper.class.getName());
+
   public MBean register(Object bean) {
     MBeanServer mbs = ManagementFactory.getPlatformMBeanServer();
     MBean mBean = new MBean(bean);
@@ -33,7 +36,7 @@ public MBean register(Object bean) {
     } catch (InstanceAlreadyExistsException t) {
       return mBean;
     } catch (Throwable t) {
-      t.printStackTrace();
+      LOG.severe("Error during execution: " + t.getMessage());
       return null;
     }
   }

java/src/org/openqa/selenium/grid/jmx/MBean.java

@@ -22,6 +22,7 @@
 import java.util.HashMap;
 import java.util.Map;
 import java.util.Objects;
+import java.util.logging.Logger;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 import javax.management.Attribute;
@@ -36,6 +37,7 @@
 
 public class MBean implements DynamicMBean {
 
+  private static final Logger LOG = Logger.getLogger(MBean.class.getName());
   private final Object bean;
   private final MBeanInfo beanInfo;
   private final Map<String, AttributeInfo> attributeMap = new HashMap<>();
@@ -59,7 +61,7 @@ MBeanAttributeInfo getMBeanAttributeInfo() {
       try {
         return new MBeanAttributeInfo(name, description, getter, setter);
       } catch (IntrospectionException e) {
-        e.printStackTrace();
+        LOG.severe("Error during execution: " + e.getMessage());
         return null;
       }
     }
@@ -123,7 +125,7 @@ private AttributeInfo getAttributeInfo(Method m) {
       String name = "".equals(ma.name()) ? m.getName() : ma.name();
       return new AttributeInfo(name, ma.description(), findGetter(m), findSetter(m));
     } catch (Throwable t) {
-      t.printStackTrace();
+      LOG.severe("Error during execution: " + t.getMessage());
       return null;
     }
   }
@@ -144,7 +146,7 @@ private Method findGetter(Method annotatedMethod) {
       }
       return null;
     } catch (NoSuchMethodException e) {
-      e.printStackTrace();
+      LOG.severe("Error during execution: " + e.getMessage());
       return null;
     }
   }
@@ -223,7 +225,7 @@ public Object getAttribute(String attribute) {
         return res.toString();
       }
     } catch (IllegalAccessException | InvocationTargetException e) {
-      e.printStackTrace();
+      LOG.severe("Error during execution: " + e.getMessage());
       return null;
     }
   }
@@ -233,7 +235,7 @@ public void setAttribute(Attribute attribute) {
     try {
       attributeMap.get(attribute.getName()).setter.invoke(bean, attribute.getValue());
     } catch (IllegalAccessException | InvocationTargetException e) {
-      e.printStackTrace();
+      LOG.severe("Error during execution: " + e.getMessage());
     }
   }
 
@@ -252,7 +254,7 @@ public Object invoke(String actionName, Object[] params, String[] signature) {
     try {
       return operationMap.get(actionName).method.invoke(bean, params);
     } catch (IllegalAccessException | InvocationTargetException e) {
-      e.printStackTrace();
+      LOG.severe("Error during execution: " + e.getMessage());
       return null;
     }
   }

java/test/org/openqa/selenium/ElementAttributeTest.java

@@ -27,6 +27,7 @@
 import static org.openqa.selenium.testing.drivers.Browser.SAFARI;
 
 import java.util.List;
+import java.util.logging.Logger;
 import org.junit.jupiter.api.Test;
 import org.openqa.selenium.environment.webserver.Page;
 import org.openqa.selenium.support.ui.ExpectedConditions;
@@ -35,6 +36,8 @@
 
 class ElementAttributeTest extends JupiterTestBase {
 
+  private static final Logger LOG = Logger.getLogger(ElementAttributeTest.class.getName());
+
   @Test
   void testShouldReturnNullWhenGettingTheValueOfAnAttributeThatIsNotListed() {
     driver.get(pages.simpleTestPage);
@@ -265,7 +268,7 @@ void testShouldCorrectlyReportValueOfColspan() {
     try {
       Thread.sleep(1000);
     } catch (InterruptedException e) {
-      e.printStackTrace();
+      LOG.severe("Error during execution: " + e.getMessage());
     }
 
     WebElement th1 = driver.findElement(By.id("th1"));

java/test/org/openqa/selenium/firefox/ExecutableTest.java

@@ -21,6 +21,7 @@
 import static org.junit.jupiter.api.Assumptions.assumeTrue;
 
 import java.io.File;
+import java.util.logging.Logger;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Tag;
 import org.junit.jupiter.api.Test;
@@ -29,14 +30,16 @@
 @Tag("UnitTests")
 class ExecutableTest {
 
+  private static final Logger LOG = Logger.getLogger(ExecutableTest.class.getName());
+
   private String binaryPath;
 
   @BeforeEach
   public void setUp() {
     try {
       binaryPath = new FirefoxBinary().getPath();
     } catch (WebDriverException ex) {
-      ex.printStackTrace();
+      LOG.severe("Error during execution: " + ex.getMessage());
       assumeTrue(false);
     }
   }

java/test/org/openqa/selenium/grid/distributor/local/LocalDistributorTest.java

@@ -43,6 +43,7 @@
 import java.util.concurrent.Executors;
 import java.util.concurrent.Future;
 import java.util.concurrent.TimeUnit;
+import java.util.logging.Logger;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.openqa.selenium.Capabilities;
@@ -81,6 +82,7 @@
 
 class LocalDistributorTest {
 
+  private static final Logger LOG = Logger.getLogger(LocalDistributorTest.class.getName());
   private final Secret registrationSecret = new Secret("bavarian smoked");
   private static final int newSessionThreadPoolSize = Runtime.getRuntime().availableProcessors();
   private Tracer tracer;
@@ -421,7 +423,7 @@ void slowStartingNodesShouldNotCauseReservationsToBeSerialized() {
                       try {
                         Thread.sleep(delay);
                       } catch (InterruptedException e) {
-                        e.printStackTrace();
+                        LOG.severe("Error during execution: " + e.getMessage());
                       }
                       return new Handler(c);
                     }))

java/test/org/openqa/selenium/remote/internal/HttpClientTestBase.java

@@ -35,6 +35,7 @@
 import java.util.List;
 import java.util.Map;
 import java.util.TreeMap;
+import java.util.logging.Logger;
 import java.util.stream.StreamSupport;
 import org.junit.jupiter.api.AfterAll;
 import org.junit.jupiter.api.BeforeAll;
@@ -59,6 +60,8 @@ public abstract class HttpClientTestBase {
   static HttpHandler delegate;
   static AppServer server;
 
+  private static final Logger LOG = Logger.getLogger(HttpClientTestBase.class.getName());
+
   @BeforeAll
   public static void setUp() {
     server = new NettyAppServer(req -> delegate.execute(req));
@@ -192,7 +195,7 @@ void shouldAllowConfigurationOfRequestTimeout() {
                       try {
                         Thread.sleep(1000);
                       } catch (InterruptedException e) {
-                        e.printStackTrace();
+                        LOG.severe("Error during execution: " + e.getMessage());
                       }
                       return new HttpResponse()
                           .setContent(Contents.utf8String(req.getHeader("user-agent")));

java/test/org/openqa/selenium/testing/IgnoreComparator.java

@@ -20,6 +20,7 @@
 import java.io.IOException;
 import java.util.HashSet;
 import java.util.Set;
+import java.util.logging.Logger;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 import java.util.stream.Stream;
@@ -30,6 +31,8 @@
 class IgnoreComparator {
   private final Set<Browser> ignored = new HashSet<>();
 
+  private static final Logger LOG = Logger.getLogger(IgnoreComparator.class.getName());
+
   // TODO(simon): reduce visibility
   public void addDriver(Browser driverToIgnore) {
     ignored.add(driverToIgnore);
@@ -80,7 +83,7 @@ private boolean isOpenGitHubIssue(String owner, String repo, String issueId) {
       Issue issue = service.getIssue(owner, repo, issueId);
       return "open".equals(issue.getState());
     } catch (IOException e) {
-      e.printStackTrace();
+      LOG.severe("Error during execution: " + e.getMessage());
     }
     return true;
   }