[java] set isDisabled to true by default (make Bindings opt-in) (#342)

titusfortner · web-flow · commit 13d040845f4b · 2024-11-06T14:57:38.000-08:00
diff --git a/.github/workflows/java.yml b/.github/workflows/java.yml
@@ -61,6 +61,9 @@ jobs:
         run: git --no-pager diff --exit-code
   main:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        profile: [enabled, disabled]
     steps:
       - uses: actions/checkout@v4
       - name: Set up JDK 11
@@ -71,11 +74,11 @@ jobs:
       - name: Remove driver directories
         run: |
           sudo rm -rf $CHROMEWEBDRIVER $EDGEWEBDRIVER $GECKOWEBDRIVER
-      - name: Test with Maven
+      - name: Sauce (${{ matrix.profile }})
         env:
           SAUCE_USERNAME: ${{ secrets.SAUCE_USERNAME }}
           SAUCE_ACCESS_KEY: ${{ secrets.SAUCE_ACCESS_KEY }}
-        run: cd java/main && mvn clean test -Dmaven.javadoc.skip=true
+        run: cd java/main && mvn clean test -Psauce-${{ matrix.profile }} -Dmaven.javadoc.skip=true
   junit4:
     runs-on: ubuntu-latest
     steps:
@@ -95,6 +98,9 @@ jobs:
         run: cd java/junit4 && mvn clean test -Dmaven.javadoc.skip=true
   junit5:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        profile: [enabled, disabled]
     steps:
       - uses: actions/checkout@v4
       - name: Set up JDK 11
@@ -113,11 +119,11 @@ jobs:
           echo "DISPLAY=:99" >> "$GITHUB_ENV"
       - name: Install main bindings snapshot
         run: cd java/main && mvn clean package install -DskipTests -Dgpg.skip=true
-      - name: Test with Maven
+      - name: Sauce (${{ matrix.profile }})
         env:
           SAUCE_USERNAME: ${{ secrets.SAUCE_USERNAME }}
           SAUCE_ACCESS_KEY: ${{ secrets.SAUCE_ACCESS_KEY }}
-        run: cd java/junit5 && mvn clean test -Dmaven.javadoc.skip=true
+        run: cd java/junit5 && mvn clean test -Psauce-${{ matrix.profile }} -Dmaven.javadoc.skip=true
   testng:
     runs-on: ubuntu-latest
     steps:
diff --git a/java/junit5/pom.xml b/java/junit5/pom.xml
@@ -77,6 +77,59 @@
         </dependency>
     </dependencies>
 
+    <profiles>
+        <profile>
+            <id>sauce-enabled</id>
+            <build>
+                <plugins>
+                    <plugin>
+                        <groupId>org.apache.maven.plugins</groupId>
+                        <artifactId>maven-surefire-plugin</artifactId>
+                        <version>3.5.1</version>
+                        <configuration>
+                            <includes>
+                                <include>**/*Test.java</include>
+                            </includes>
+                            <systemPropertyVariables>
+                                <sauce.enabled>true</sauce.enabled>
+                            </systemPropertyVariables>
+                            <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>
+                    </plugin>
+                </plugins>
+            </build>
+        </profile>
+        <profile>
+            <id>sauce-disabled</id>
+            <activation>
+                <activeByDefault>true</activeByDefault>
+            </activation>
+            <build>
+                <plugins>
+                    <plugin>
+                        <groupId>org.apache.maven.plugins</groupId>
+                        <artifactId>maven-surefire-plugin</artifactId>
+                        <version>3.5.1</version>
+                        <configuration>
+                            <includes>
+                                <include>**/*Example.java</include>
+                                <include>**/ToggleTest.java</include>
+                            </includes>
+                        </configuration>
+                    </plugin>
+                </plugins>
+            </build>
+        </profile>
+    </profiles>
+
     <build>
         <resources>
             <resource>
@@ -98,48 +151,6 @@
                     </execution>
                 </executions>
             </plugin>
-            <plugin>
-                <groupId>org.apache.maven.plugins</groupId>
-                <artifactId>maven-surefire-plugin</artifactId>
-                <version>3.1.2</version>
-                <executions>
-                    <execution>
-                        <id>sauce-enabled</id>
-                        <goals>
-                            <goal>test</goal>
-                        </goals>
-                        <configuration>
-                            <properties>
-                                <configurationParameters>
-                                    sauce.disabled = false
-                                    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>sauce-disabled</id>
-                        <goals>
-                            <goal>test</goal>
-                        </goals>
-                        <configuration>
-                            <includes>
-                                <include>**/ToggleTest.java</include>
-                            </includes>
-                            <properties>
-                                <configurationParameters>
-                                    sauce.disabled = true
-                                    junit.jupiter.execution.parallel.enabled = false
-                                </configurationParameters>
-                            </properties>
-                        </configuration>
-                    </execution>
-                </executions>
-            </plugin>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-gpg-plugin</artifactId>
diff --git a/java/junit5/src/main/java/com/saucelabs/saucebindings/junit5/SauceBindingsExtension.java b/java/junit5/src/main/java/com/saucelabs/saucebindings/junit5/SauceBindingsExtension.java
@@ -37,6 +37,10 @@ private SauceBindingsExtension(SauceOptions sauceOptions, DataCenter dataCenter)
     this.buildName = CITools.getBuildName() + ": " + CITools.getBuildNumber();
   }
 
+  public void enable() {
+    System.setProperty("sauce.enabled", "true");
+  }
+
   public static Builder builder() {
     return new Builder();
   }
@@ -100,7 +104,7 @@ private ExtensionContext.Store getStore(ExtensionContext context) {
 
   @Override
   public void testSuccessful(ExtensionContext context) {
-    if (!SauceSession.isDisabled()) {
+    if (SauceSession.isEnabled()) {
       SauceSession session = (SauceSession) getStore(context).get("session");
       try {
         session.stop(true);
@@ -114,7 +118,7 @@ public void testSuccessful(ExtensionContext context) {
 
   @Override
   public void testFailed(ExtensionContext context, Throwable cause) {
-    if (!SauceSession.isDisabled()) {
+    if (SauceSession.isEnabled()) {
       SauceSession session = (SauceSession) getStore(context).get("session");
       try {
         session.stop(cause);
diff --git a/java/junit5/src/test/java/com/saucelabs/saucebindings/junit5/ToggleTest.java b/java/junit5/src/test/java/com/saucelabs/saucebindings/junit5/ToggleTest.java
@@ -13,8 +13,8 @@ public class ToggleTest {
   @RegisterExtension static SauceBindingsExtension sauceExtension = new SauceBindingsExtension();
 
   @Test
-  @EnabledIfSystemProperty(named = "sauce.disabled", matches = "true")
-  @DisabledIfSystemProperty(named = "sauce.disabled", matches = "(?!true)") // Needed for IntelliJ
+  @DisabledIfSystemProperty(named = "sauce.enabled", matches = "true")
+  @EnabledIfSystemProperty(named = "sauce.enabled", matches = "(?!true)") // Needed for IntelliJ
   public void disableSauce(SauceSession session, WebDriver driver) {
     Assertions.assertNull(driver);
 
diff --git a/java/junit5/src/test/java/com/saucelabs/saucebindings/junit5/examples/AccessibilityExample.java b/java/junit5/src/test/java/com/saucelabs/saucebindings/junit5/examples/AccessibilityExample.java
@@ -12,8 +12,14 @@ public class AccessibilityExample {
   WebDriver driver;
   SauceSession session;
 
+  // Register extension
   @RegisterExtension static SauceBindingsExtension sauceExtension = new SauceBindingsExtension();
 
+  // Enable extension (this also can be done by running with -Dsaucelabs.enable=true)
+  static {
+    sauceExtension.enable();
+  }
+
   @BeforeEach
   public void setUp(SauceSession session) {
     this.session = session;
diff --git a/java/junit5/src/test/java/com/saucelabs/saucebindings/junit5/examples/CapabilitiesExample.java b/java/junit5/src/test/java/com/saucelabs/saucebindings/junit5/examples/CapabilitiesExample.java
@@ -15,10 +15,16 @@ public class CapabilitiesExample {
   WebDriver driver;
   SauceSession session;
 
+  // Register extension with Selenium capabilities instance
   @RegisterExtension
-  SauceBindingsExtension sauceExtension =
+  static SauceBindingsExtension sauceExtension =
       SauceBindingsExtension.builder().withCapabilities(getCapabilities()).build();
 
+  // Enable extension (this also can be done by running with -Dsaucelabs.enable=true)
+  static {
+    sauceExtension.enable();
+  }
+
   @BeforeEach
   public void setUp(SauceSession session, WebDriver driver) {
     this.session = session;
diff --git a/java/junit5/src/test/java/com/saucelabs/saucebindings/junit5/examples/DataCenterExample.java b/java/junit5/src/test/java/com/saucelabs/saucebindings/junit5/examples/DataCenterExample.java
@@ -12,10 +12,16 @@ public class DataCenterExample {
   WebDriver driver;
   SauceSession session;
 
+  // Register extension with custom data center
   @RegisterExtension
   static SauceBindingsExtension sauceExtension =
       SauceBindingsExtension.builder().withDataCenter(DataCenter.EU_CENTRAL).build();
 
+  // Enable extension (this also can be done by running with -Dsaucelabs.enable=true)
+  static {
+    sauceExtension.enable();
+  }
+
   @BeforeEach
   public void setUp(SauceSession session, WebDriver driver) {
     this.session = session;
diff --git a/java/junit5/src/test/java/com/saucelabs/saucebindings/junit5/examples/OptionsExample.java b/java/junit5/src/test/java/com/saucelabs/saucebindings/junit5/examples/OptionsExample.java
@@ -15,10 +15,16 @@ public class OptionsExample {
   WebDriver driver;
   SauceSession session;
 
+  // Register extension with SauceOptions
   @RegisterExtension
   static SauceBindingsExtension sauceExtension =
       SauceBindingsExtension.builder().withSauceOptions(getSauceOptions()).build();
 
+  // Enable extension (this also can be done by running with -Dsaucelabs.enable=true)
+  static {
+    sauceExtension.enable();
+  }
+
   @BeforeEach
   public void setUp(SauceSession session, WebDriver driver) {
     this.session = session;
diff --git a/java/junit5/src/test/java/com/saucelabs/saucebindings/junit5/examples/QuickStartExample.java b/java/junit5/src/test/java/com/saucelabs/saucebindings/junit5/examples/QuickStartExample.java
@@ -11,8 +11,14 @@ public class QuickStartExample {
   WebDriver driver;
   SauceSession session;
 
+  // Register extension with defaults
   @RegisterExtension static SauceBindingsExtension sauceExtension = new SauceBindingsExtension();
 
+  // Enable extension (this also can be done by running with -Dsaucelabs.enable=true)
+  static {
+    sauceExtension.enable();
+  }
+
   @BeforeEach
   public void setUp(SauceSession session, WebDriver driver) {
     this.session = session;
diff --git a/java/junit5/src/test/java/com/saucelabs/saucebindings/junit5/examples/RunLocalExample.java b/java/junit5/src/test/java/com/saucelabs/saucebindings/junit5/examples/RunLocalExample.java
@@ -2,7 +2,6 @@
 
 import com.saucelabs.saucebindings.SauceSession;
 import com.saucelabs.saucebindings.junit5.SauceBindingsExtension;
-import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtensionContext;
@@ -11,24 +10,27 @@
 import org.openqa.selenium.WebDriver;
 import org.openqa.selenium.chrome.ChromeDriver;
 
-public class ToggleLocalExample {
+public class RunLocalExample {
   WebDriver driver;
   SauceSession session;
 
-  // Register multiple test watchers for local and sauce execution
+  // Register Sauce Bindings extension with defaults
   @RegisterExtension static SauceBindingsExtension sauceExtension = new SauceBindingsExtension();
+  // Register additional test watcher(s) for local execution
   @RegisterExtension TestWatcher testWatcher = new LocalTestWatcher();
 
-  // Change this property to "true" to run locally
-  @BeforeAll
-  public static void toggleSauce() {
-    System.setProperty("sauce.disabled", "false");
-  }
-
   @BeforeEach
   public void setUp(SauceSession session, WebDriver driver) {
     this.session = session;
-    this.driver = SauceSession.isDisabled() ? new ChromeDriver() : driver;
+    this.driver = SauceSession.isEnabled() ? driver : new ChromeDriver();
+  }
+
+  // Sauce Labs execution is disabled by default,
+  // To run tests without Sauce, do not enable the extension (`sauceExtension.enable()`)
+  // and do not execute with `-Dsaucelabs.enabled=true`
+  static {
+    System.out.println("Sauce Bindings Extension not Enabled");
+    // sauceExtension.enable();
   }
 
   @Test
@@ -43,15 +45,9 @@ public class LocalTestWatcher implements TestWatcher {
     @Override
     public void testSuccessful(ExtensionContext context) {
       System.out.println("Test Succeeded");
-      if (SauceSession.isDisabled()) {
-        driver.quit();
-      }
-    }
-
-    @Override
-    public void testFailed(ExtensionContext context, Throwable cause) {
-      System.out.println("Test Failed: " + cause.getMessage());
-      if (SauceSession.isDisabled()) {
+      if (SauceSession.isEnabled()) {
+        throw new RuntimeException("Test should not run when Extension is enabled");
+      } else {
         driver.quit();
       }
     }
diff --git a/java/junit5/src/test/java/com/saucelabs/saucebindings/junit5/examples/without/ToggleLocalExample.java b/java/junit5/src/test/java/com/saucelabs/saucebindings/junit5/examples/without/ToggleLocalExample.java
diff --git a/java/main/pom.xml b/java/main/pom.xml
diff --git a/java/main/src/main/java/com/saucelabs/saucebindings/SauceSession.java b/java/main/src/main/java/com/saucelabs/saucebindings/SauceSession.java
diff --git a/java/main/src/test/java/com/saucelabs/saucebindings/DisabledSauceTest.java b/java/main/src/test/java/com/saucelabs/saucebindings/DisabledSauceTest.java
