[junit4] update watcher with latest sauce bindings improvements

titusfortner · titusfortner · commit aba2b52e9d26 · 2024-11-06T17:32:54.000-08:00
diff --git a/java/junit4/pom.xml b/java/junit4/pom.xml
@@ -46,6 +46,7 @@
 
     <properties>
         <saucebindings-junit4.version>2.0.0-beta.1-SNAPSHOT</saucebindings-junit4.version>
+        <surefire.parallel>8</surefire.parallel>
         <maven.compiler.source>11</maven.compiler.source>
         <maven.compiler.target>11</maven.compiler.target>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
@@ -95,34 +96,15 @@
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-surefire-plugin</artifactId>
                 <version>2.22.1</version>
-                <executions>
-                    <execution>
-                        <id>sauce-enabled</id>
-                        <goals>
-                            <goal>test</goal>
-                        </goals>
-                        <configuration>
-                            <parallel>all</parallel>
-                            <threadCountMethods>50</threadCountMethods>
-                            <useUnlimitedThreads>true</useUnlimitedThreads>
-                            <redirectTestOutputToFile>false</redirectTestOutputToFile>
-                        </configuration>
-                    </execution>
-                    <execution>
-                        <id>sauce-disabled</id>
-                        <goals>
-                            <goal>test</goal>
-                        </goals>
-                        <configuration>
-                            <systemPropertyVariables>
-                                <sauce.disabled>true</sauce.disabled>
-                            </systemPropertyVariables>
-                            <includes>
-                                <include>**/ToggleTest.java</include>
-                            </includes>
-                        </configuration>
-                    </execution>
-                </executions>
+                <configuration>
+                    <includes>
+                        <include>**/*Example.java</include>
+                    </includes>
+                    <parallel>all</parallel>
+                    <threadCountMethods>${surefire.parallel}</threadCountMethods>
+                    <useUnlimitedThreads>true</useUnlimitedThreads>
+                    <redirectTestOutputToFile>false</redirectTestOutputToFile>
+                </configuration>
             </plugin>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
@@ -170,7 +152,7 @@
                     <dependency>
                         <groupId>org.apache.maven.scm</groupId>
                         <artifactId>maven-scm-provider-gitexe</artifactId>
-                        <version>2.1.0</version>
+                        <version>2.0.1</version>
                     </dependency>
                 </dependencies>
             </plugin>
diff --git a/java/junit4/src/main/java/com/saucelabs/saucebindings/junit4/SauceBindingsWatcher.java b/java/junit4/src/main/java/com/saucelabs/saucebindings/junit4/SauceBindingsWatcher.java
@@ -8,11 +8,10 @@
 import java.io.InputStream;
 import java.lang.annotation.Annotation;
 import java.util.ArrayList;
-import java.util.Arrays;
 import java.util.List;
+import java.util.Objects;
 import java.util.Properties;
 import java.util.logging.Logger;
-import java.util.stream.Collectors;
 import lombok.Getter;
 import org.junit.AssumptionViolatedException;
 import org.junit.experimental.categories.Category;
@@ -29,7 +28,7 @@ public class SauceBindingsWatcher extends TestWatcher {
   private final DataCenter dataCenter;
   private SauceSession session;
   private WebDriver driver;
-  private static final String buildName = CITools.getBuildName() + ": " + CITools.getBuildNumber();
+  private static final String build = CITools.getBuildName() + ": " + CITools.getBuildNumber();
 
   public SauceBindingsWatcher() {
     this(new SauceOptions(), DataCenter.US_WEST);
@@ -44,21 +43,29 @@ public static Builder builder() {
     return new Builder();
   }
 
+  public static void enable() {
+    System.setProperty("sauce.enabled", "true");
+  }
+
   @Override
   protected void starting(Description description) {
-    updateOptions(description);
+    sauceOptions.sauce().setBuild(build);
+    updateTestName(description);
+    updateCustomData();
+    updateTags(description);
 
     session = new SauceSession(sauceOptions);
     session.setDataCenter(dataCenter);
     driver = session.start();
   }
 
-  private void updateOptions(Description description) {
+  public void updateTestName(Description description) {
     String className = description.getClassName();
     String simpleClassName = className.substring(className.lastIndexOf(".") + 1);
     sauceOptions.sauce().setName(simpleClassName + ": " + description.getMethodName());
-    sauceOptions.sauce().setBuild(buildName);
+  }
 
+  private void updateCustomData() {
     Properties prop = new Properties();
     try (InputStream input = getClass().getResourceAsStream("/app.properties")) {
       prop.load(input);
@@ -67,23 +74,23 @@ private void updateOptions(Description description) {
     } catch (IOException ignored) {
       sauceOptions.sauce().getCustomData().put("sauce-bindings-junit4", "unknown");
     }
+  }
 
-    List<String> tags = sauceOptions.sauce().getTags();
+  private void updateTags(Description description) {
+    List<String> tags =
+        Objects.requireNonNullElseGet(sauceOptions.sauce().getTags(), ArrayList::new);
 
     List<Annotation> annotations = (List<Annotation>) description.getAnnotations();
     for (Annotation annotation : annotations) {
       if (annotation instanceof Category) {
         Category category = (Category) annotation;
         for (Class<?> categoryClass : category.value()) {
-          if (tags == null) {
-            tags = new ArrayList<>();
-          }
           tags.add(categoryClass.getSimpleName());
         }
       }
     }
 
-    if (tags != null) {
+    if (!tags.isEmpty()) {
       sauceOptions.sauce().setTags(tags);
     }
   }
@@ -103,14 +110,7 @@ protected void succeeded(Description description) {
   protected void failed(Throwable e, Description description) {
     if (session != null) {
       try {
-        session.annotate("Failure Reason: " + e.getMessage());
-
-        Arrays.stream(e.getStackTrace())
-            .map(StackTraceElement::toString)
-            .filter(line -> !line.contains("sun"))
-            .forEach(session::annotate);
-
-        session.stop(false);
+        session.stop(e);
       } catch (NoSuchSessionException ex) {
         LOGGER.severe(
             "Driver quit prematurely; Remove calls to `driver.quit()` to allow"
@@ -123,16 +123,7 @@ protected void failed(Throwable e, Description description) {
   public void skipped(AssumptionViolatedException e, Description description) {
     LOGGER.fine("Test Aborted: " + e.getMessage());
     if (session != null) {
-      session.annotate("Test Skipped; marking completed instead of failed");
-      session.annotate("Reason: " + e.getMessage());
-
-      String stackTrace =
-          Arrays.stream(e.getStackTrace())
-              .map(StackTraceElement::toString)
-              .collect(Collectors.joining("\n"));
-      session.annotate(stackTrace);
-
-      session.abort();
+      session.abort(e);
     }
   }
 
diff --git a/java/junit4/src/test/java/com/saucelabs/saucebindings/junit4/ToggleTest.java b/java/junit4/src/test/java/com/saucelabs/saucebindings/junit4/ToggleTest.java
@@ -15,10 +15,6 @@ public class ToggleTest {
 
   @Rule public SauceBindingsWatcher sauceWatcher = new SauceBindingsWatcher();
 
-  static {
-    System.setProperty("sauce.disabled", "true");
-  }
-
   @Before
   public void storeVariables() {
     this.session = sauceWatcher.getSession();
@@ -27,7 +23,7 @@ public void storeVariables() {
 
   @Test
   public void disableSauce() {
-    Assume.assumeTrue("true".equals(System.getProperty("sauce.disabled")));
+    Assume.assumeFalse(Boolean.getBoolean("sauce.enabled"));
 
     Assert.assertNull(driver);
 
diff --git a/java/junit4/src/test/java/com/saucelabs/saucebindings/junit4/examples/AccessibilityExample.java b/java/junit4/src/test/java/com/saucelabs/saucebindings/junit4/examples/AccessibilityExample.java
@@ -16,7 +16,12 @@ public class AccessibilityExample {
   // 1. Use the SauceBindingsWatcher rule
   @Rule public SauceBindingsWatcher sauceWatcher = new SauceBindingsWatcher();
 
-  // 2. Get variables created by Watcher
+  // 2. Enable SauceBindingsWatcher rule
+  static {
+    SauceBindingsWatcher.enable();
+  }
+
+  // 3. Get variables created by Watcher
   @Before
   public void storeVariables() {
     this.session = sauceWatcher.getSession();
@@ -25,13 +30,13 @@ public void storeVariables() {
 
   @Test
   public void startSession() {
-    // 3. Use the driver in your tests just like normal
+    // 4. Use the driver in your tests just like normal
     driver.get("https://www.saucedemo.com/");
 
-    // 4. Get and assert on accessibility results
+    // 5. Get and assert on accessibility results
     Results results = session.getAccessibilityResults();
     Assert.assertEquals(3, results.getViolations().size());
 
-    // 5. Session is stopped and results are sent to Sauce Labs automatically by the superclass
+    // 6. Session is stopped and results are sent to Sauce Labs automatically by the superclass
   }
 }
diff --git a/java/junit4/src/test/java/com/saucelabs/saucebindings/junit4/examples/CapabilitiesExample.java b/java/junit4/src/test/java/com/saucelabs/saucebindings/junit4/examples/CapabilitiesExample.java
@@ -31,7 +31,12 @@ private static Capabilities createCapabilities() {
   public SauceBindingsWatcher sauceWatcher =
       SauceBindingsWatcher.builder().withCapabilities(createCapabilities()).build();
 
-  // 3. Get variables created by Watcher
+  // 3. Enable SauceBindingsWatcher rule
+  static {
+    SauceBindingsWatcher.enable();
+  }
+
+  // 4. Get variables created by Watcher
   @Before
   public void storeVariables() {
     this.session = sauceWatcher.getSession();
@@ -40,12 +45,12 @@ public void storeVariables() {
 
   @Test
   public void basicOptions() {
-    // 4. Use the session instance to do Sauce Labs things
+    // 5. Use the session instance to do Sauce Labs things
     session.annotate("Navigating to Swag Labs");
 
-    // 5. Use the driver instance to do Selenium things
+    // 6. Use the driver instance to do Selenium things
     driver.get("https://www.saucedemo.com/");
 
-    // 6. Watcher does all teardown activities
+    // 7. Watcher does all teardown activities
   }
 }
diff --git a/java/junit4/src/test/java/com/saucelabs/saucebindings/junit4/examples/DataCenterExample.java b/java/junit4/src/test/java/com/saucelabs/saucebindings/junit4/examples/DataCenterExample.java
@@ -17,7 +17,12 @@ public class DataCenterExample {
   public SauceBindingsWatcher sauceWatcher =
       SauceBindingsWatcher.builder().withDataCenter(DataCenter.EU_CENTRAL).build();
 
-  // 2. Get variables created by Watcher
+  // 2. Enable SauceBindingsWatcher rule
+  static {
+    SauceBindingsWatcher.enable();
+  }
+
+  // 3. Get variables created by Watcher
   @Before
   public void storeVariables() {
     this.session = sauceWatcher.getSession();
@@ -26,12 +31,12 @@ public void storeVariables() {
 
   @Test
   public void startSession() {
-    // 3. Use the session instance to do Sauce Labs things
+    // 4. Use the session instance to do Sauce Labs things
     session.annotate("Navigating to Swag Labs");
 
-    // 4. Use the driver instance to do Selenium things
+    // 5. Use the driver instance to do Selenium things
     driver.get("https://www.saucedemo.com/");
 
-    // 5. Watcher does all teardown activities
+    // 6. Watcher does all teardown activities
   }
 }
diff --git a/java/junit4/src/test/java/com/saucelabs/saucebindings/junit4/examples/QuickStartExample.java b/java/junit4/src/test/java/com/saucelabs/saucebindings/junit4/examples/QuickStartExample.java
@@ -14,7 +14,12 @@ public class QuickStartExample {
   // 1. Use the SauceBindingsWatcher rule
   @Rule public SauceBindingsWatcher sauceWatcher = new SauceBindingsWatcher();
 
-  // 2. Get variables created by Watcher
+  // 2. Enable SauceBindingsWatcher rule
+  static {
+    SauceBindingsWatcher.enable();
+  }
+
+  // 3. Get variables created by Watcher
   @Before
   public void storeVariables() {
     this.session = sauceWatcher.getSession();
@@ -23,12 +28,12 @@ public void storeVariables() {
 
   @Test
   public void startSession() {
-    // 3. Use the session instance to do Sauce Labs things
+    // 4. Use the session instance to do Sauce Labs things
     session.annotate("Navigating to Swag Labs");
 
-    // 4. Use the driver instance to do Selenium things
+    // 5. Use the driver instance to do Selenium things
     driver.get("https://www.saucedemo.com/");
 
-    // 5. Watcher does all teardown activities
+    // 6. Watcher does all teardown activities
   }
 }
diff --git a/java/junit4/src/test/java/com/saucelabs/saucebindings/junit4/examples/RunLocalExample.java b/java/junit4/src/test/java/com/saucelabs/saucebindings/junit4/examples/RunLocalExample.java
@@ -3,33 +3,34 @@
 import com.saucelabs.saucebindings.SauceSession;
 import com.saucelabs.saucebindings.junit4.SauceBindingsWatcher;
 import org.junit.Before;
-import org.junit.BeforeClass;
 import org.junit.Rule;
 import org.junit.Test;
 import org.junit.rules.TestWatcher;
 import org.junit.runner.Description;
 import org.openqa.selenium.WebDriver;
 import org.openqa.selenium.chrome.ChromeDriver;
 
-public class ToggleLocalExample {
+public class RunLocalExample {
   private SauceSession session;
   private WebDriver driver;
 
-  // Change this property to "true" to run locally
-  @BeforeClass
-  public static void disableSauce() {
-    System.setProperty("sauce.disabled", "false");
-  }
-
   // 1. Set multiple rules for when Sauce is and isn't enabled
   @Rule public SauceBindingsWatcher sauceWatcher = new SauceBindingsWatcher();
   @Rule public TestWatcher localWatcher = new LocalTestWatcher();
 
+  // Sauce Labs execution is disabled by default,
+  // To run tests without Sauce, do not enable the watcher (`SauceBindingsWatcher.enable()`)
+  // and do not execute with `-Dsauce.enabled=true`
+  static {
+    System.out.println("Sauce Bindings Extension not Enabled");
+    // SauceBindingsWatcher.enable();
+  }
+
   // 2. Start driver if running locally
   @Before
   public void storeVariables() {
     this.session = sauceWatcher.getSession();
-    this.driver = SauceSession.isDisabled() ? new ChromeDriver() : sauceWatcher.getDriver();
+    this.driver = SauceSession.isEnabled() ? sauceWatcher.getDriver(): new ChromeDriver();
   }
 
   @Test
@@ -44,15 +45,15 @@ public class LocalTestWatcher extends TestWatcher {
     @Override
     public void succeeded(Description description) {
       System.out.println("Test Succeeded");
-      if (SauceSession.isDisabled()) {
+      if (!SauceSession.isEnabled()) {
         driver.quit();
       }
     }
 
     @Override
     public void failed(Throwable e, Description description) {
       System.out.println("Test Failed: " + e.getMessage());
-      if (SauceSession.isDisabled()) {
+      if (!SauceSession.isEnabled()) {
         driver.quit();
       }
     }
diff --git a/java/junit4/src/test/java/com/saucelabs/saucebindings/junit4/examples/SauceOptionsExample.java b/java/junit4/src/test/java/com/saucelabs/saucebindings/junit4/examples/SauceOptionsExample.java
