[java] get junit4 and junit5 examples to match better

Author: titusfortner

java/junit4/src/test/java/com/saucelabs/saucebindings/junit4/examples/AccessibilityExample.java

@@ -3,7 +3,6 @@
 import com.deque.html.axecore.results.Results;
 import com.saucelabs.saucebindings.SauceSession;
 import com.saucelabs.saucebindings.junit4.SauceBindingsWatcher;
-import org.junit.Assert;
 import org.junit.Before;
 import org.junit.Rule;
 import org.junit.Test;
@@ -13,15 +12,15 @@ public class AccessibilityExample {
   private SauceSession session;
   private WebDriver driver;
 
-  // 1. Use the SauceBindingsWatcher rule
+  // 1. Use the SauceBindingsWatcher rule with defaults
   @Rule public SauceBindingsWatcher sauceWatcher = new SauceBindingsWatcher();
 
-  // 2. Enable SauceBindingsWatcher rule
+  // 2. Enable this watcher in the static block
   static {
     SauceBindingsWatcher.enable();
   }
 
-  // 3. Get variables created by Watcher
+  // 3. Get variables created by the watcher
   @Before
   public void storeVariables() {
     this.session = sauceWatcher.getSession();
@@ -30,13 +29,10 @@ public void storeVariables() {
 
   @Test
   public void startSession() {
-    // 4. Use the driver in your tests just like normal
     driver.get("https://www.saucedemo.com/");
 
-    // 5. Get and assert on accessibility results
+    // 4. store the accessibility results into an object
     Results results = session.getAccessibilityResults();
-    Assert.assertEquals(3, results.getViolations().size());
-
-    // 6. Session is stopped and results are sent to Sauce Labs automatically by the superclass
+    // if you want, you can assert on the accessibilityResults
   }
 }

java/junit4/src/test/java/com/saucelabs/saucebindings/junit4/examples/CapabilitiesExample.java

@@ -15,7 +15,7 @@ public class CapabilitiesExample {
   WebDriver driver;
   SauceSession session;
 
-  // 1. Create Selenium Capabilities instance in static method
+  // 1. Create Selenium Capabilities instance in a static method
   private static Capabilities createCapabilities() {
     SafariOptions browserOptions = new SafariOptions();
     browserOptions.setPlatformName("macOS 12");
@@ -26,17 +26,17 @@ private static Capabilities createCapabilities() {
     return browserOptions;
   }
 
-  // 2. Pass these options to the SauceBindingsWatcher rule
+  // 2. Use the SauceBindingsWatcher rule with these capabilities
   @Rule
   public SauceBindingsWatcher sauceWatcher =
-      SauceBindingsWatcher.builder().withCapabilities(createCapabilities()).build();
+          SauceBindingsWatcher.builder().withCapabilities(createCapabilities()).build();
 
-  // 3. Enable SauceBindingsWatcher rule
+  // 3. Enable this watcher in the static block
   static {
     SauceBindingsWatcher.enable();
   }
 
-  // 4. Get variables created by Watcher
+  // 4. Get variables created by the watcher
   @Before
   public void storeVariables() {
     this.session = sauceWatcher.getSession();
@@ -50,7 +50,5 @@ public void basicOptions() {
 
     // 6. Use the driver instance to do Selenium things
     driver.get("https://www.saucedemo.com/");
-
-    // 7. Watcher does all teardown activities
   }
 }

java/junit4/src/test/java/com/saucelabs/saucebindings/junit4/examples/DataCenterExample.java

@@ -12,17 +12,17 @@ public class DataCenterExample {
   private SauceSession session;
   private WebDriver driver;
 
-  // 1. Pass in desired Datacenter to the SauceBindingsWatcher rule
+  // 1. Use the SauceBindingsWatcher rule with specific DataCenter
   @Rule
   public SauceBindingsWatcher sauceWatcher =
       SauceBindingsWatcher.builder().withDataCenter(DataCenter.EU_CENTRAL).build();
 
-  // 2. Enable SauceBindingsWatcher rule
+  // 2. Enable this watcher in the static block
   static {
     SauceBindingsWatcher.enable();
   }
 
-  // 3. Get variables created by Watcher
+  // 3. Get variables created by the watcher
   @Before
   public void storeVariables() {
     this.session = sauceWatcher.getSession();
@@ -36,7 +36,5 @@ public void startSession() {
 
     // 5. Use the driver instance to do Selenium things
     driver.get("https://www.saucedemo.com/");
-
-    // 6. Watcher does all teardown activities
   }
 }

java/junit4/src/test/java/com/saucelabs/saucebindings/junit4/examples/QuickStartExample.java

@@ -14,12 +14,12 @@ public class QuickStartExample {
   // 1. Use the SauceBindingsWatcher rule
   @Rule public SauceBindingsWatcher sauceWatcher = new SauceBindingsWatcher();
 
-  // 2. Enable SauceBindingsWatcher rule
+  // 2. Enable this watcher in the static block
   static {
     SauceBindingsWatcher.enable();
   }
 
-  // 3. Get variables created by Watcher
+  // 3. Get variables created by the watcher
   @Before
   public void storeVariables() {
     this.session = sauceWatcher.getSession();
@@ -33,7 +33,5 @@ public void startSession() {
 
     // 5. Use the driver instance to do Selenium things
     driver.get("https://www.saucedemo.com/");
-
-    // 6. Watcher does all teardown activities
   }
 }

java/junit4/src/test/java/com/saucelabs/saucebindings/junit4/examples/RunLocalExample.java

@@ -11,11 +11,13 @@
 import org.openqa.selenium.chrome.ChromeDriver;
 
 public class RunLocalExample {
-  private SauceSession session;
   private WebDriver driver;
+  private SauceSession session;
 
-  // 1. Set multiple rules for when Sauce is and isn't enabled
+  // 1. Register Watchers
+  // Register Sauce Bindings watcher with defaults
   @Rule public SauceBindingsWatcher sauceWatcher = new SauceBindingsWatcher();
+  // Register additional test watcher(s) for local execution
   @Rule public TestWatcher localWatcher = new LocalTestWatcher();
 
   // Sauce Labs execution is disabled by default,
@@ -26,7 +28,7 @@ public class RunLocalExample {
     // SauceBindingsWatcher.enable();
   }
 
-  // 2. Start driver if running locally
+  // Only start driver if Sauce Watcher is not enabled
   @Before
   public void storeVariables() {
     this.session = sauceWatcher.getSession();

java/junit4/src/test/java/com/saucelabs/saucebindings/junit4/examples/SauceOptionsExample.java

@@ -10,33 +10,35 @@
 import org.junit.Rule;
 import org.junit.Test;
 import org.openqa.selenium.WebDriver;
+import org.openqa.selenium.chrome.ChromeOptions;
 
 public class SauceOptionsExample {
   WebDriver driver;
   SauceSession session;
 
   // 1. Create SauceOptions instance in static method
   public static SauceOptions createSauceOptions() {
-    return SauceOptions.firefox()
-        .setBrowserVersion("127.0")
-        .setPlatformName(SaucePlatform.WINDOWS_10)
-        .setUnhandledPromptBehavior(UnhandledPromptBehavior.IGNORE)
-        .setIdleTimeout(Duration.ofSeconds(45))
-        .setTimeZone("Alaska")
-        .build();
+    ChromeOptions chromeOptions = new ChromeOptions();
+    chromeOptions.addArguments("--hide-scrollbars");
+
+    return SauceOptions.chrome(chromeOptions)
+            .setPlatformName(SaucePlatform.MAC_CATALINA)
+            .setUnhandledPromptBehavior(UnhandledPromptBehavior.IGNORE)
+            .setIdleTimeout(Duration.ofSeconds(30))
+            .build();
   }
 
-  // 2. Pass these options to the SauceBindingsWatcher rule
+  // 2. Create SauceBindingsWatcher rule with these options
   @Rule
   public SauceBindingsWatcher sauceWatcher =
       SauceBindingsWatcher.builder().withSauceOptions(createSauceOptions()).build();
 
-  // 3. Enable SauceBindingsWatcher rule
+  // 3. Enable this watcher in the static block
   static {
     SauceBindingsWatcher.enable();
   }
 
-  // 4. Get variables created by Watcher
+  // 4. Get variables created by the watcher
   @Before
   public void storeVariables() {
     this.session = sauceWatcher.getSession();
@@ -50,7 +52,5 @@ public void basicOptions() {
 
     // 6. Use the driver instance to do Selenium things
     driver.get("https://www.saucedemo.com/");
-
-    // 7. Watcher does all teardown activities
   }
 }

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

@@ -12,14 +12,15 @@ public class AccessibilityExample {
   WebDriver driver;
   SauceSession session;
 
-  // Register extension
+  // 1. Register Sauce Bindings extension with defaults
   @RegisterExtension static SauceBindingsExtension sauceExtension = new SauceBindingsExtension();
 
-  // Enable extension (this also can be done by running with -Dsauce.enabled=true)
+  // 2. Enable extension (this also can be done by running with -Dsauce.enabled=true)
   static {
     sauceExtension.enable();
   }
 
+  // 3. Get variables created by the Sauce Bindings extension
   @BeforeEach
   public void setUp(SauceSession session) {
     this.session = session;
@@ -28,9 +29,12 @@ public void setUp(SauceSession session) {
 
   @Test
   public void accessibilityExample() {
+    // 4. Use the driver instance to do Selenium things
     driver.get("https://www.saucedemo.com/");
-    // store the accessibility results into an object
+
+    // 5. store the accessibility results into an object
     Results accessibilityResults = session.getAccessibilityResults();
-    // if you want, you can assert on the accessibilityResults
+
+    // 6. you can assert on the accessibilityResults as desired
   }
 }

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

@@ -15,35 +15,40 @@ public class CapabilitiesExample {
   WebDriver driver;
   SauceSession session;
 
-  // Register extension with Selenium capabilities instance
+  // 1. Create static method with Selenium Capabilities
+  private static Capabilities getCapabilities() {
+    SafariOptions browserOptions = new SafariOptions();
+    browserOptions.setPlatformName("macOS 12");
+    browserOptions.setBrowserVersion("latest");
+    Map<String, Object> sauceOptions = new HashMap<>();
+    sauceOptions.put("idleTimeout", 30);
+    browserOptions.setCapability("sauce:options", sauceOptions);
+    return browserOptions;
+  }
+
+  // 2. Register Sauce Bindings extension with these capabilities
   @RegisterExtension
   static SauceBindingsExtension sauceExtension =
       SauceBindingsExtension.builder().withCapabilities(getCapabilities()).build();
 
-  // Enable extension (this also can be done by running with -Dsauce.enabled=true)
+  // 3. Enable extension (this also can be done by running with -Dsauce.enabled=true)
   static {
     sauceExtension.enable();
   }
 
+  // 4. Get variables created by the Sauce Bindings extension
   @BeforeEach
   public void setUp(SauceSession session, WebDriver driver) {
     this.session = session;
     this.driver = driver;
   }
 
-  private static Capabilities getCapabilities() {
-    SafariOptions browserOptions = new SafariOptions();
-    browserOptions.setPlatformName("macOS 12");
-    browserOptions.setBrowserVersion("latest");
-    Map<String, Object> sauceOptions = new HashMap<>();
-    sauceOptions.put("idleTimeout", 30);
-    browserOptions.setCapability("sauce:options", sauceOptions);
-    return browserOptions;
-  }
-
   @Test
   public void capabilitiesExample() {
+    // 5. Use the session instance to do Sauce Labs things
     session.annotate("Navigating to Swag Labs");
+
+    // 6. Use the driver instance to do Selenium things
     driver.get("https://www.saucedemo.com/");
   }
 }

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

@@ -12,16 +12,17 @@ public class DataCenterExample {
   WebDriver driver;
   SauceSession session;
 
-  // Register extension with custom data center
+  // 1. Register Sauce Bindings 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 -Dsauce.enabled=true)
+  // 2. Enable extension (this also can be done by running with -Dsauce.enabled=true)
   static {
     sauceExtension.enable();
   }
 
+  // 3. Get variables created by the Sauce Bindings extension
   @BeforeEach
   public void setUp(SauceSession session, WebDriver driver) {
     this.session = session;
@@ -30,7 +31,10 @@ public void setUp(SauceSession session, WebDriver driver) {
 
   @Test
   public void dataCenterExample() {
+    // 4. Use the session instance to do Sauce Labs things
     session.annotate("Navigating to Swag Labs");
+
+    // 5. Use the driver instance to do Selenium things
     driver.get("https://www.saucedemo.com/");
   }
 }

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

@@ -11,14 +11,15 @@ public class QuickStartExample {
   WebDriver driver;
   SauceSession session;
 
-  // Register extension with defaults
+  // 1. Register Sauce Bindings extension with defaults
   @RegisterExtension static SauceBindingsExtension sauceExtension = new SauceBindingsExtension();
 
-  // Enable extension (this also can be done by running with -Dsauce.enabled=true)
+  // 2. Enable extension (this also can be done by running with -Dsauce.enabled=true)
   static {
     sauceExtension.enable();
   }
 
+  // 3. Get variables created by the Sauce Bindings extension
   @BeforeEach
   public void setUp(SauceSession session, WebDriver driver) {
     this.session = session;
@@ -27,7 +28,10 @@ public void setUp(SauceSession session, WebDriver driver) {
 
   @Test
   public void quickStartExample() {
+    // 4. Use the session instance to do Sauce Labs things
     session.annotate("Navigating to Swag Labs");
+
+    // 5. Use the driver instance to do Selenium things
     driver.get("https://www.saucedemo.com/");
   }
 }