[java] move error message and stack trace annotation from test runners to main bindings (#339)

Author: titusfortner

java/junit5/src/main/java/com/saucelabs/saucebindings/junit5/SauceBindingsExtension.java

@@ -7,12 +7,10 @@
 import java.io.IOException;
 import java.io.InputStream;
 import java.util.ArrayList;
-import java.util.Arrays;
 import java.util.List;
 import java.util.Optional;
 import java.util.Properties;
 import java.util.logging.Logger;
-import java.util.stream.Collectors;
 import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.extension.BeforeEachCallback;
 import org.junit.jupiter.api.extension.ExtensionContext;
@@ -22,7 +20,6 @@
 import org.openqa.selenium.Capabilities;
 import org.openqa.selenium.NoSuchSessionException;
 import org.openqa.selenium.WebDriver;
-import org.openqa.selenium.remote.RemoteWebDriver;
 
 public class SauceBindingsExtension implements TestWatcher, BeforeEachCallback, ParameterResolver {
   private static final Logger LOGGER = Logger.getLogger(SauceBindingsExtension.class.getName());
@@ -101,7 +98,6 @@ private ExtensionContext.Store getStore(ExtensionContext context) {
   public void testSuccessful(ExtensionContext context) {
     if (!SauceSession.isDisabled()) {
       SauceSession session = (SauceSession) getStore(context).get("session");
-      RemoteWebDriver driver = session.getDriver();
       try {
         session.stop(true);
       } catch (NoSuchSessionException e) {
@@ -117,14 +113,7 @@ public void testFailed(ExtensionContext context, Throwable cause) {
     if (!SauceSession.isDisabled()) {
       SauceSession session = (SauceSession) getStore(context).get("session");
       try {
-        session.annotate("Failure Reason: " + cause.getMessage());
-
-        Arrays.stream(cause.getStackTrace())
-            .map(StackTraceElement::toString)
-            .filter(line -> !line.contains("sun"))
-            .forEach(session::annotate);
-
-        session.stop(false);
+        session.stop(cause);
       } catch (NoSuchSessionException e) {
         LOGGER.severe(
             "Driver quit prematurely; Remove calls to `driver.quit()` to allow"
@@ -138,16 +127,7 @@ public void testAborted(ExtensionContext context, Throwable cause) {
     LOGGER.fine("Test Aborted: " + cause.getMessage());
     SauceSession session = (SauceSession) getStore(context).get("session");
     if (session != null) {
-      session.annotate("Test Aborted; marking completed instead of failed");
-      session.annotate("Reason: " + cause.getMessage());
-
-      String stackTrace =
-          Arrays.stream(cause.getStackTrace())
-              .map(StackTraceElement::toString)
-              .collect(Collectors.joining("\n"));
-      session.annotate(stackTrace);
-
-      session.abort();
+      session.abort(cause);
     }
   }
 

java/main/src/main/java/com/saucelabs/saucebindings/SauceSession.java

@@ -6,7 +6,9 @@
 import com.saucelabs.saucebindings.options.SauceOptions;
 import java.net.MalformedURLException;
 import java.net.URL;
+import java.util.Arrays;
 import java.util.List;
+import java.util.stream.Collectors;
 import lombok.Getter;
 import lombok.Setter;
 import org.openqa.selenium.Capabilities;
@@ -128,13 +130,32 @@ public void stop(Boolean passed) {
     }
   }
 
+  public void stop(Throwable cause) {
+    if (isDisabled()) {
+      return;
+    }
+
+    if (this.driver != null) {
+      annotate("Failure Reason: " + cause.getMessage());
+
+      sendStackTrace(cause);
+      updateResult("failed");
+      quit();
+    }
+  }
+
   /** Ends the session on Sauce Labs and quits the driver without setting a test result. */
-  public void abort() {
+  public void abort(Throwable cause) {
     if (isDisabled()) {
       return;
     }
 
+    this.result = "complete";
     if (this.driver != null) {
+      annotate("Test Aborted; marking completed instead of failed");
+      annotate("Reason: " + cause.getMessage());
+
+      sendStackTrace(cause);
       printToConsole();
       quit();
     }
@@ -313,6 +334,14 @@ private void updateResult(String result) {
     printToConsole();
   }
 
+  private void sendStackTrace(Throwable cause) {
+    String stackTrace =
+        Arrays.stream(cause.getStackTrace())
+            .map(StackTraceElement::toString)
+            .collect(Collectors.joining("\n"));
+    annotate(stackTrace);
+  }
+
   public void printToConsole() {
     // Add output for the Sauce OnDemand Jenkins plugin
     // The first print statement will automatically populate links on Jenkins to Sauce