[junit5] use disable feature in main library instead of extension

Author: titusfortner

java/junit5/pom.xml

@@ -61,7 +61,7 @@
     <dependency>
       <groupId>com.saucelabs</groupId>
       <artifactId>sauce_bindings</artifactId>
-      <version>1.5.0</version>
+      <version>1.6.0</version>
     </dependency>
     <dependency>
       <groupId>org.projectlombok</groupId>
@@ -95,21 +95,41 @@
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-surefire-plugin</artifactId>
         <version>3.1.2</version>
-        <configuration>
-          <includes>
-            <include>**/*Test.java</include>
-            <include>**/*Example.java</include>
-          </includes>
-          <properties>
-            <configurationParameters>
-              junit.jupiter.execution.parallel.enabled = true
-              junit.jupiter.execution.parallel.mode.default = concurrent
-              junit.jupiter.execution.parallel.mode.classes.default = same_thread
-              junit.jupiter.execution.parallel.config.strategy = fixed
-              junit.jupiter.execution.parallel.config.fixed.parallelism = ${surefire.parallel}
-            </configurationParameters>
-          </properties>
-        </configuration>
+        <executions>
+          <execution>
+            <id>parallel-tests</id>
+            <goals>
+              <goal>test</goal>
+            </goals>
+            <configuration>
+              <properties>
+                <configurationParameters>
+                  junit.jupiter.execution.parallel.enabled = true
+                  junit.jupiter.execution.parallel.mode.default = concurrent
+                  junit.jupiter.execution.parallel.config.strategy = fixed
+                  junit.jupiter.execution.parallel.config.fixed.parallelism = ${surefire.parallel}
+                  junit.jupiter.execution.parallel.config.fixed.max-pool-size = ${surefire.parallel}
+                </configurationParameters>
+              </properties>
+            </configuration>
+          </execution>
+          <execution>
+            <id>sequential-tests</id>
+            <goals>
+              <goal>test</goal>
+            </goals>
+            <configuration>
+              <includes>
+                <include>**/*Example.java</include>
+              </includes>
+              <properties>
+                <configurationParameters>
+                  junit.jupiter.execution.parallel.enabled = false
+                </configurationParameters>
+              </properties>
+            </configuration>
+          </execution>
+        </executions>
       </plugin>
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>

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

@@ -64,10 +64,6 @@ public SauceBindingsExtension(DataCenter dataCenter) {
 
   @Override
   public void beforeEach(ExtensionContext context) {
-    if (isExtensionDisabled()) {
-      return;
-    }
-
     if (sauceOptions.sauce().getName() == null) {
       sauceOptions.sauce().setName(context.getDisplayName());
     }
@@ -79,10 +75,6 @@ public void beforeEach(ExtensionContext context) {
 
   @Override
   public void testSuccessful(ExtensionContext context) {
-    if (isExtensionDisabled()) {
-      return;
-    }
-
     try {
       session.stop(true);
     } catch (NoSuchSessionException e) {
@@ -105,10 +97,4 @@ public void testFailed(ExtensionContext context, Throwable cause) {
       session.stop(false);
     }
   }
-
-  // TODO: Implement this in SauceSession directly
-  private boolean isExtensionDisabled() {
-    String value = System.getenv("SAUCE_DISABLED");
-    return Boolean.parseBoolean(value) || Boolean.getBoolean("sauce.disabled");
-  }
 }

java/junit5/src/test/java/com/saucelabs/saucebindings/junit5/DisabledTest.java

@@ -5,7 +5,9 @@
 import com.saucelabs.saucebindings.junit5.SauceBindingsExtension;
 import com.saucelabs.saucebindings.options.SauceOptions;
 import java.time.Duration;
+import java.util.List;
 import org.junit.jupiter.api.AfterAll;
+import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
@@ -20,40 +22,41 @@ public class ToggleLocalExample {
   WebDriver driver;
   SauceSession session;
 
+  // Allow registering multiple test watchers
   @RegisterExtension
   static SauceBindingsExtension sauceExtension = new SauceBindingsExtension(getSauceOptions());
 
   @RegisterExtension TestWatcher testWatcher = new LocalTestWatcher();
 
-  // To run test on Sauce Labs, change this to "false"
+  // Run tests with this property set to "false" to execute on Sauce Labs
   @BeforeAll
   public static void disableSauce() {
     System.setProperty("sauce.disabled", "true");
   }
 
-  @AfterAll
-  public static void resetSauce() {
-    System.clearProperty("sauce.disabled");
-  }
-
   @BeforeEach
   public void setup() {
-    // TODO: Allow getting session even when disabled
-    if (isSauceEnabled()) {
-      session = sauceExtension.getSession();
-      driver = sauceExtension.getDriver();
-    } else {
+    session = sauceExtension.getSession();
+    driver = sauceExtension.getDriver();
+    if (driver == null) {
       driver = new ChromeDriver(getCapabilities());
     }
   }
 
   @Test
   public void localExample() {
-    // TODO: Allow this method to be ignored if Sauce is disabled
-    if (isSauceEnabled()) {
-      session.annotate("Navigating to Swag Labs");
-    }
+    // This code executes whether running locally or on Sauce
     driver.get("https://www.saucedemo.com/");
+
+    // This code executes if Sauce enabled, and is ignored when disabled
+    Assertions.assertDoesNotThrow(
+        () -> {
+          session.annotate("This gets ignored");
+          session.addTags(List.of("ignored"));
+          session.stopNetwork();
+          session.enableLogging();
+          session.getAccessibilityResults();
+        });
   }
 
   private static SauceOptions getSauceOptions() {
@@ -66,33 +69,30 @@ private static SauceOptions getSauceOptions() {
   }
 
   private static ChromeOptions getCapabilities() {
-    ChromeOptions chromeOptions = new ChromeOptions();
-    chromeOptions.addArguments("--hide-scrollbars");
-
-    return chromeOptions;
-  }
-
-  // TODO: Implement this as a method in SauceSession directly
-  private boolean isSauceEnabled() {
-    String value = System.getenv("SAUCE_DISABLED");
-    return Boolean.parseBoolean(value) || !Boolean.getBoolean("sauce.disabled");
+    return new ChromeOptions();
   }
 
+  // Do not quit the driver if running on Sauce Labs
   public class LocalTestWatcher implements TestWatcher {
     @Override
     public void testSuccessful(ExtensionContext context) {
-      if (!isSauceEnabled()) {
-        System.out.println("Test Succeeded");
+      System.out.println("Test Succeeded");
+      if (SauceSession.isDisabled()) {
         driver.quit();
       }
     }
 
     @Override
     public void testFailed(ExtensionContext context, Throwable cause) {
-      if (!isSauceEnabled()) {
-        System.out.println("Test Failed");
+      System.out.println("Test Failed");
+      if (SauceSession.isDisabled()) {
         driver.quit();
       }
     }
   }
+
+  @AfterAll
+  public static void resetSauce() {
+    System.clearProperty("sauce.disabled");
+  }
 }