[java] update the property for enabling Sauce Bindings

Author: titusfortner

java/junit5/pom.xml

@@ -111,7 +111,7 @@
                         <configuration>
                             <properties>
                                 <configurationParameters>
-                                    sauce.disabled = false
+                                    sauce.enabled = true
                                     junit.jupiter.execution.parallel.enabled = true
                                     junit.jupiter.execution.parallel.mode.default = concurrent
                                     junit.jupiter.execution.parallel.config.strategy = fixed
@@ -132,7 +132,6 @@
                             </includes>
                             <properties>
                                 <configurationParameters>
-                                    sauce.disabled = true
                                     junit.jupiter.execution.parallel.enabled = false
                                 </configurationParameters>
                             </properties>

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");
+  }
+
   @Override
   public void beforeEach(ExtensionContext context) {
     SauceOptions options = updateOptions(context);
@@ -96,7 +100,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);
@@ -110,7 +114,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);
@@ -176,6 +180,11 @@ public Builder withDataCenter(DataCenter dataCenter) {
       return this;
     }
 
+    public Builder enable() {
+      System.setProperty("sauce.enabled", "true");
+      return this;
+    }
+
     public SauceBindingsExtension build() {
       return new SauceBindingsExtension(sauceOptions, dataCenter);
     }

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;

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 =
       new 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;

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 =
       new 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;

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 =
       new 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;

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;

java/junit5/src/test/java/com/saucelabs/saucebindings/junit5/examples/ToggleLocalExample.java

@@ -15,20 +15,22 @@ public class ToggleLocalExample {
   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");
+  // Sauce Labs execution is disabled by default,
+  // To run tests without Sauce, remove this code block and do not execute code with
+  // `-Dsaucelabs.enabled=true`
+  static {
+    sauceExtension.enable();
   }
 
   @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();
   }
 
   @Test
@@ -43,15 +45,15 @@ public class LocalTestWatcher implements TestWatcher {
     @Override
     public void testSuccessful(ExtensionContext context) {
       System.out.println("Test Succeeded");
-      if (SauceSession.isDisabled()) {
+      if (!SauceSession.isEnabled()) {
         driver.quit();
       }
     }
 
     @Override
     public void testFailed(ExtensionContext context, Throwable cause) {
       System.out.println("Test Failed: " + cause.getMessage());
-      if (SauceSession.isDisabled()) {
+      if (!SauceSession.isEnabled()) {
         driver.quit();
       }
     }

java/junit5/src/test/java/com/saucelabs/saucebindings/junit5/examples/without/ToggleLocalExample.java

@@ -31,31 +31,32 @@ public class ToggleLocalExample {
   @RegisterExtension TestWatcher watcher = new SauceTestWatcher();
   @RegisterExtension TestWatcher testWatcher = new LocalTestWatcher();
 
-  // To run test on Sauce Labs, change this to "false"
+  // All Sauce specific code must use conditionals to avoid errors
+  // This is an example of how a user would toggle those conditionals
+  // This property would typically get set in the run command that gets executed on the CI tool
+  boolean sauceEnabled() {
+    return Boolean.getBoolean("sauce.enabled");
+  }
+
   @BeforeAll
-  public static void disableSauce() {
-    System.setProperty("sauce.disabled", "true");
+  public static void enableSauce() {
+    System.setProperty("sauce.enabled", "true");
   }
 
   @BeforeEach
   public void setup(TestInfo testInfo) {
-    if (isSauceDisabled()) {
-      driver = new ChromeDriver();
-    } else {
+    if (sauceEnabled()) {
       this.testInfo = testInfo;
       driver = new RemoteWebDriver(getSauceUrl(), getCapabilities());
       this.sessionId = ((RemoteWebDriver) driver).getSessionId();
+    } else {
+      driver = new ChromeDriver();
     }
   }
 
-  @AfterAll
-  public static void resetSauce() {
-    System.clearProperty("sauce.disabled");
-  }
-
   @Test
   public void toggleLocal() {
-    if (!isSauceDisabled()) {
+    if (sauceEnabled()) {
       ((JavascriptExecutor) driver).executeScript("sauce:context=Navigating to Swag Labs");
     }
 
@@ -72,11 +73,6 @@ private static SauceOptions getSauceOptions() {
         .build();
   }
 
-  private boolean isSauceDisabled() {
-    String value = System.getenv("SAUCE_DISABLED");
-    return Boolean.parseBoolean(value) || Boolean.getBoolean("sauce.disabled");
-  }
-
   private Capabilities getCapabilities() {
     ChromeOptions options = new ChromeOptions();
     Map<String, Object> sauceOptions = new HashMap<>();
@@ -114,7 +110,7 @@ public void testFailed(ExtensionContext context, Throwable cause) {
   private class SauceTestWatcher implements TestWatcher {
     @Override
     public void testSuccessful(ExtensionContext context) {
-      if (isSauceDisabled()) {
+      if (!sauceEnabled()) {
         return;
       }
 
@@ -129,7 +125,7 @@ public void testSuccessful(ExtensionContext context) {
 
     @Override
     public void testFailed(ExtensionContext context, Throwable cause) {
-      if (isSauceDisabled()) {
+      if (!sauceEnabled()) {
         return;
       }
 

java/main/pom.xml

@@ -141,7 +141,7 @@
             <configuration>
               <properties>
                 <configurationParameters>
-                  sauce.disabled = false
+                  sauce.enabled = true
                   junit.jupiter.execution.parallel.enabled = true
                   junit.jupiter.execution.parallel.mode.default = concurrent
                   junit.jupiter.execution.parallel.config.strategy = fixed
@@ -162,7 +162,6 @@
               </includes>
               <properties>
                 <configurationParameters>
-                  sauce.disabled = true
                   junit.jupiter.execution.parallel.enabled = false
                 </configurationParameters>
               </properties>

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

@@ -320,19 +320,23 @@ public void addTags(List<String> tags) {
    *
    * @return whether the methods in this library are ignored (true) or executed (false)
    */
-  public static boolean isDisabled() {
-    String env = System.getenv("SAUCE_DISABLED");
-    String prop = System.getProperty("sauce.disabled");
+  public static boolean isEnabled() {
+    String env = System.getenv("SAUCE_ENABLED");
+    String prop = System.getProperty("sauce.enabled");
 
     if (env != null) {
       return Boolean.parseBoolean(env);
     } else if (prop != null) {
       return Boolean.parseBoolean(prop);
     } else {
-      return true;
+      return false;
     }
   }
 
+  private static boolean isDisabled() {
+    return !isEnabled();
+  }
+
   /**
    * Not intended for subclassing. Package-private for testing.
    *

java/main/src/test/java/com/saucelabs/saucebindings/integration/DisableSauceTest.java

@@ -11,8 +11,8 @@
 public class DisableSauceTest {
 
   @Test
-  @EnabledIfSystemProperty(named = "sauce.disabled", matches = "true")
-  @DisabledIfSystemProperty(named = "sauce.disabled", matches = "(?!true)") // Needed for IntelliJ
+  @EnabledIfSystemProperty(named = "sauce.enabled", matches = "(!?true)")
+  @DisabledIfSystemProperty(named = "sauce.enabled", matches = "true") // Needed for IntelliJ
   public void disableSauce() {
     SauceSession session = new SauceSession();
     WebDriver driver = session.start();