SQUASH - make changes based on feedback

Author: titusfortner

docs/BASIC_OPTIONS.md

@@ -20,31 +20,34 @@ Here's an example of running a test on Firefox and Windows 8.0.
 
 ```java
 import com.saucelabs.saucebindings.*;
+import com.saucelabs.saucebindings.options.SauceOptions;
+import com.saucelabs.saucebindings.options.capabilities.Browser;
+import com.saucelabs.saucebindings.options.capabilities.SaucePlatform;
 import org.junit.Test;
 import org.openqa.selenium.remote.RemoteWebDriver;
 
 public class BasicOptionsTest {
 
-    @Test
-    public void basicOptions() {
-        // 1. Specify the 3 basic parameters of a SauceOptions instance
-        SauceOptions sauceOptions = new SauceOptions();
-        sauceOptions.setBrowserName(Browser.FIREFOX);
-        sauceOptions.setBrowserVersion("73.0");
-        sauceOptions.setPlatformName(SaucePlatform.WINDOWS_8);
+ @Test
+ public void basicOptions() {
+  // 1. Specify the 3 basic parameters of a SauceOptions instance
+  SauceOptions sauceOptions = new SauceOptions();
+  sauceOptions.setBrowserName(Browser.FIREFOX);
+  sauceOptions.setBrowserVersion("73.0");
+  sauceOptions.setPlatformName(SaucePlatform.WINDOWS_8);
 
-        // 2. Create Session object with the Options object instance
-        SauceSession session = new SauceSession(sauceOptions);
+  // 2. Create Session object with the Options object instance
+  SauceSession session = new SauceSession(sauceOptions);
 
-        // 3. Start Session to get the Driver
-        RemoteWebDriver driver = session.start();
+  // 3. Start Session to get the Driver
+  RemoteWebDriver driver = session.start();
 
-        // 4. Use the driver in your tests just like normal
-        driver.get("https://www.saucedemo.com/");
+  // 4. Use the driver in your tests just like normal
+  driver.get("https://www.saucedemo.com/");
 
-        // 5. Stop the Session with whether the test passed or failed
-        session.stop(true);
-    }
+  // 5. Stop the Session with whether the test passed or failed
+  session.stop(true);
+ }
 }
 ```
 

docs/BROWSER_OPTIONS.md

@@ -13,6 +13,7 @@ one of these objects:
 
 ```java
 import com.saucelabs.saucebindings.*;
+import com.saucelabs.saucebindings.options.SauceOptions;
 import org.junit.Test;
 import org.openqa.selenium.firefox.FirefoxOptions;
 import org.openqa.selenium.remote.RemoteWebDriver;

docs/SAUCE_OPTIONS.md

@@ -13,7 +13,7 @@ All of these configurations can now be easily set with the `SauceOptions` class
 <!--Java-->
 
 ```java
-import com.saucelabs.saucebindings.*;
+import com.saucelabs.saucebindings.options.SauceOptions;
 import org.junit.Test;
 import org.openqa.selenium.remote.RemoteWebDriver;
 

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

@@ -1,6 +1,7 @@
 package com.saucelabs.saucebindings;
 
-import com.saucelabs.saucebindings.configs.SauceConfigs;
+import com.saucelabs.saucebindings.options.BaseConfigurations;
+import com.saucelabs.saucebindings.options.SauceOptions;
 import lombok.Getter;
 import lombok.Setter;
 import org.openqa.selenium.InvalidArgumentException;
@@ -21,7 +22,7 @@ public SauceSession() {
         this(new SauceOptions());
     }
 
-    public SauceSession(SauceConfigs configs) {
+    public SauceSession(BaseConfigurations configs) {
         this(configs.build());
     }
 

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

@@ -1,6 +1,9 @@
 package com.saucelabs.saucebindings.examples;
 
 import com.saucelabs.saucebindings.*;
+import com.saucelabs.saucebindings.options.SauceOptions;
+import com.saucelabs.saucebindings.options.capabilities.Browser;
+import com.saucelabs.saucebindings.options.capabilities.SaucePlatform;
 import org.junit.Test;
 import org.openqa.selenium.remote.RemoteWebDriver;
 

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

@@ -1,6 +1,7 @@
 package com.saucelabs.saucebindings.examples;
 
 import com.saucelabs.saucebindings.*;
+import com.saucelabs.saucebindings.options.SauceOptions;
 import org.junit.Test;
 import org.openqa.selenium.firefox.FirefoxOptions;
 import org.openqa.selenium.remote.RemoteWebDriver;

java/src/main/java/com/saucelabs/saucebindings/configs/SauceConfigsBrowser.java

@@ -1,6 +1,7 @@
 package com.saucelabs.saucebindings.examples;
 
 import com.saucelabs.saucebindings.*;
+import com.saucelabs.saucebindings.options.SauceOptions;
 import org.junit.Test;
 import org.openqa.selenium.remote.RemoteWebDriver;
 

java/src/main/java/com/saucelabs/saucebindings/configs/SauceConfigsChrome.java

@@ -0,0 +1,7 @@
+package com.saucelabs.saucebindings.exceptions;
+
+public class InvalidSauceOptionsArgumentException extends RuntimeException {
+    public InvalidSauceOptionsArgumentException(String message) {
+        super(message);
+    }
+}

java/src/main/java/com/saucelabs/saucebindings/examples/BasicOptionsTest.java

@@ -0,0 +1,7 @@
+package com.saucelabs.saucebindings.exceptions;
+
+public class SauceEnvironmentVariablesNotSetException extends RuntimeException {
+    public SauceEnvironmentVariablesNotSetException(String message) {
+        super(message);
+    }
+}

java/src/main/java/com/saucelabs/saucebindings/examples/BrowserOptionsTest.java

@@ -1,13 +1,12 @@
-package com.saucelabs.saucebindings.configs;
+package com.saucelabs.saucebindings.options;
 
-import com.saucelabs.saucebindings.JobVisibility;
-import com.saucelabs.saucebindings.SauceOptions;
-import com.saucelabs.saucebindings.SaucePlatform;
+import com.saucelabs.saucebindings.options.capabilities.JobVisibility;
+import com.saucelabs.saucebindings.options.capabilities.SaucePlatform;
 
 import java.util.List;
 import java.util.Map;
 
-public class SauceConfigs<T extends SauceConfigs<T>> {
+public class BaseConfigurations<T extends BaseConfigurations<T>> {
     // Needs to be instantiated in subclass
     SauceOptions sauceOptions = null;
 

java/src/main/java/com/saucelabs/saucebindings/examples/SauceLabsOptionsTest.java

@@ -0,0 +1,31 @@
+package com.saucelabs.saucebindings.options;
+
+import com.saucelabs.saucebindings.exceptions.InvalidSauceOptionsArgumentException;
+import org.openqa.selenium.chrome.ChromeOptions;
+
+public class ChromeConfigurations extends VDCConfigurations<ChromeConfigurations> {
+    ChromeConfigurations(ChromeOptions chromeOptions) {
+        sauceOptions = new SauceOptions(chromeOptions);
+    }
+
+    public ChromeConfigurations setCapturePerformance() {
+        sauceOptions.setExtendedDebugging(true);
+        sauceOptions.setCapturePerformance(true);
+        if (sauceOptions.getName() == null) {
+            throw new InvalidSauceOptionsArgumentException("Need to call `setName()` before `setCapturePerformance`");
+        }
+        return this;
+    }
+
+    // Use case is a different point release than the driver provided by default
+    // TODO - consider ensuring this matches browser Version
+    public ChromeConfigurations setChromedriverVersion(String version) {
+        sauceOptions.setChromedriverVersion(version);
+        return this;
+    }
+
+    public ChromeConfigurations setExtendedDebugging() {
+        sauceOptions.setExtendedDebugging(true);
+        return this;
+    }
+}

java/src/main/java/com/saucelabs/saucebindings/exceptions/InvalidSauceOptionsArgumentException.java

@@ -1,6 +1,8 @@
-package com.saucelabs.saucebindings;
+package com.saucelabs.saucebindings.options;
 
-import com.saucelabs.saucebindings.configs.SauceConfigsChrome;
+import com.saucelabs.saucebindings.exceptions.InvalidSauceOptionsArgumentException;
+import com.saucelabs.saucebindings.exceptions.SauceEnvironmentVariablesNotSetException;
+import com.saucelabs.saucebindings.options.capabilities.*;
 import lombok.AccessLevel;
 import lombok.Getter;
 import lombok.Setter;
@@ -134,16 +136,16 @@ public class SauceOptions {
      * @return SauceConfigsChrome,
      *   note: constructor implementation is deprecated for public use, but usage here is intentional
      */
-    public static SauceConfigsChrome chrome() {
-        return new SauceConfigsChrome(new ChromeOptions());
+    public static ChromeConfigurations chrome() {
+        return new ChromeConfigurations(new ChromeOptions());
     }
 
     /**
      * @return SauceConfigsChrome,
      *   note: constructor implementation is deprecated for public use, but usage here is intentional
      */
-    public static SauceConfigsChrome chrome(ChromeOptions chromeOptions) {
-        return new SauceConfigsChrome(chromeOptions);
+    public static ChromeConfigurations chrome(ChromeOptions chromeOptions) {
+        return new ChromeConfigurations(chromeOptions);
     }
 
     public SauceOptions() {
@@ -363,7 +365,7 @@ protected String getSystemProperty(String key) {
         return System.getProperty(key);
     }
 
-    protected String getEnvironmentVariable(String key) {
+    public String getEnvironmentVariable(String key) {
         return System.getenv(key);
     }
 }