fixup - more more updates

Author: titusfortner

checkstyle-suppressions.xml

@@ -6,6 +6,5 @@
 
 <suppressions>
     <suppress checks="MissingJavadoc*" files="/test/"/>
-<!--    Temporary-->
-    <suppress checks="*" files="/(junit|testng)/"/>
+    <suppress checks="*" files="/(junit4|junit5|testng)/"/>
 </suppressions>

checkstyle.xml

@@ -253,7 +253,7 @@
         <module name="AbbreviationAsWordInName">
             <property name="ignoreFinal" value="false"/>
             <property name="allowedAbbreviationLength" value="3"/>
-            <property name="allowedAbbreviations" value="XML, URL, JUnit, TestNG" />
+            <property name="allowedAbbreviations" value="XML, URL, JUnit, TestNG, APAC" />
             <property name="tokens"
                       value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, ANNOTATION_DEF, ANNOTATION_FIELD_DEF,
                     PARAMETER_DEF, VARIABLE_DEF, METHOD_DEF, PATTERN_VARIABLE_DEF, RECORD_DEF,

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

@@ -21,6 +21,8 @@
 public class SauceOptions extends com.saucelabs.saucebindings.options.SauceOptions {
 
     /**
+     * Create instance from capabilities
+     *
      * @deprecated Use com.saucelabs.saucebindings.options.SauceOptions() instead
      */
     @Deprecated
@@ -29,6 +31,8 @@ public SauceOptions() {
     }
 
     /**
+     * Create instance from Options
+     *
      * @param options instance of Selenium browser options
      * @deprecated Use com.saucelabs.saucebindings.options.SauceOptions.chrome(options) instead
      */

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

@@ -13,7 +13,8 @@
  * @deprecated each timeout has its own setter in options.SauceOptions
  */
 @Accessors(chain = true)
-@Setter @Getter
+@Setter
+@Getter
 @Deprecated
 public class TimeoutStore {
     private Integer implicitWait;

java/main/src/main/java/com/saucelabs/saucebindings/options/ChromeConfigurations.java

@@ -2,9 +2,7 @@
 
 import org.openqa.selenium.chrome.ChromeOptions;
 
-/**
- * Capabilities that apply only to Chrome sessions.
- */
+/** Capabilities that apply only to Chrome sessions. */
 public class ChromeConfigurations extends VDCConfigurations<ChromeConfigurations> {
     ChromeConfigurations(ChromeOptions chromeOptions) {
         validatePrefix("goog", chromeOptions.asMap());
@@ -13,7 +11,7 @@ public class ChromeConfigurations extends VDCConfigurations<ChromeConfigurations
     }
 
     /**
-     * Enables Performance Capture feature
+     * Enables Performance Capture feature.
      *
      * @return instance of configuration
      */
@@ -27,14 +25,14 @@ public ChromeConfigurations setCapturePerformance() {
     }
 
     /**
-     * Chrome requires the major browser version to match the major driver version
-     * This setting might be useful if there is a bug in the minor or point version of the default chromedriver
+     * Chrome requires the major browser version to match the major driver version.
+     * This setting might be useful if there is a bug in the minor or point version of the default chromedriver.
+     *
+     * TODO: Consider ensuring this matches the browser's major version number
      *
      * @param version the specific version of driver to use for the test
      * @return instance of configuration
      */
-    // Use case is a different point release than the driver provided by default
-    // TODO - consider ensuring this matches browser major version number
     public ChromeConfigurations setChromedriverVersion(String version) {
         sauceOptions.sauce().setChromedriverVersion(version);
         return this;

java/main/src/main/java/com/saucelabs/saucebindings/options/InternetExplorerConfigurations.java

@@ -2,9 +2,7 @@
 
 import org.openqa.selenium.ie.InternetExplorerOptions;
 
-/**
- * Capabilities that apply only to Internet Explorer sessions.
- */
+/** Capabilities that apply only to Internet Explorer sessions. */
 public class InternetExplorerConfigurations extends VDCConfigurations<InternetExplorerConfigurations> {
     InternetExplorerConfigurations(InternetExplorerOptions internetExplorerOptions) {
         validatePrefix("se", internetExplorerOptions.asMap());
@@ -13,7 +11,8 @@ public class InternetExplorerConfigurations extends VDCConfigurations<InternetEx
     }
 
     /**
-     * You should almost always use the latest version of Selenium
+     * You should almost always use the latest version of Selenium.
+     *
      * @param version the version of Selenium Server to use for the test
      * @return instance of configuration
      */
@@ -23,7 +22,8 @@ public InternetExplorerConfigurations setSeleniumVersion(String version) {
     }
 
     /**
-     * This should match the Selenium version
+     * This should match the Selenium version.
+     *
      * @param version the specific version of Driver to use with the job
      * @return instance of configuration
      */
@@ -36,6 +36,7 @@ public InternetExplorerConfigurations setIedriverVersion(String version) {
      * Sauce routes traffic through a proxy server so HTTPS connections with self-signed certificates work everywhere.
      * This method allows bypassing the proxy so browsers communicate directly the server.
      * Toggles avoid Proxy to True
+     *
      * @return instance of configuration
      */
     public InternetExplorerConfigurations setAvoidProxy() {

java/main/src/main/java/com/saucelabs/saucebindings/options/SafariConfigurations.java

@@ -17,9 +17,10 @@ public class SafariConfigurations extends VDCConfigurations<SafariConfigurations
     }
 
     /**
-     * Sauce routes traffic through a proxy server so that HTTPS connections with self-signed certificates work everywhere.
+     * Traffic is routed through a proxy server so that HTTPS connections with self-signed certificates work everywhere.
      * This method allows bypassing the proxy so browsers communicate directly the server.
      * Toggles avoid Proxy to True
+     *
      * @return instance of configuration
      */
     public SafariConfigurations setAvoidProxy() {
@@ -28,7 +29,8 @@ public SafariConfigurations setAvoidProxy() {
     }
 
     /**
-     * You should almost always use the latest version of Selenium
+     * You should almost always use the latest version of Selenium.
+     *
      * @param version the version of Selenium Server to use for the test
      * @return instance of configuration
      */

java/main/src/main/java/com/saucelabs/saucebindings/options/SauceOptions.java

@@ -47,6 +47,8 @@ public class SauceOptions extends BaseOptions {
     @Setter(AccessLevel.NONE) @Getter(AccessLevel.NONE) private SauceLabsOptions sauceLabsOptions;
 
     /**
+     * A way to store timeout values.
+     *
      * @deprecated set timeouts directly with setter methods
      */
     @Deprecated
@@ -136,8 +138,9 @@ public SauceOptions(Map<String, Object> map) {
     }
 
     /**
-     * This method allows building a default Sauce Options instance for Chrome
-     * Call build() method on return value rather than using directly
+     * This method allows building a default Sauce Options instance for Chrome.
+     * Call build() method on return value rather than using directly.
+     *
      * @return instance of ChromeConfigurations
      * @see ChromeConfigurations#build()
      */
@@ -192,7 +195,7 @@ public static FirefoxConfigurations firefox() {
     }
 
     /**
-     * This method allows building a Sauce Options instance for Firefox using a provided Selenium FirefoxOptions instance
+     * Allows building a Sauce Options instance for Firefox using a provided Selenium FirefoxOptions instance
      * Call build() method on return value rather than using directly
      *
      * @param firefoxOptions an instance of a Selenium FirefoxOptions class
@@ -204,7 +207,7 @@ public static FirefoxConfigurations firefox(FirefoxOptions firefoxOptions) {
     }
 
     /**
-     * This method allows building a default Sauce Options instance for Internet Explorer
+     * Allows building a default Sauce Options instance for Internet Explorer
      * Call build() method on return value rather than using directly
      *
      * @return instance of InternetExplorerConfigurations
@@ -215,7 +218,8 @@ public static InternetExplorerConfigurations ie() {
     }
 
     /**
-     * This method allows building a Sauce Options instance for Internet Explorer using a provided Selenium InternetExplorerOptions instance
+     * Allows building a Sauce Options instance for Internet Explorer.
+     * Uses a provided Selenium InternetExplorerOptions instance
      * Call build() method on return value rather than using directly
      *
      * @param internetExplorerOptions an instance of a Selenium InternetExplorerOptions class
@@ -416,9 +420,9 @@ public Duration getScriptTimeout() {
 
     /**
      *
-     * @deprecated Use setters for specific timeouts instead
      * @param timeouts valid timeouts and their associated values in milliseconds
      * @return instance of this class
+     * @deprecated Use setters for specific timeouts instead
      */
     @Deprecated
     public SauceOptions setTimeouts(Map<Timeouts, Long> timeouts) {

java/main/src/main/java/com/saucelabs/saucebindings/options/VDCConfigurations.java

@@ -17,9 +17,8 @@
  */
 public abstract class VDCConfigurations<T extends VDCConfigurations<T>> extends BaseConfigurations<T> {
 
-    // W3C Values
-
     /**
+     * Version of Browser.
      * TODO: Set restrictions on allowed versions in subclass
      *
      * @param version The version of the browser you want to use in your test
@@ -110,8 +109,6 @@ public T setScriptTimeout(Duration timeout) {
         return (T) this;
     }
 
-    // Sauce Values common to all browser sessions:
-
     /**
      * Toggles off Sauce Labs recording video of the session.
      * Not recommended since videos are very useful for debugging failures and visual reproduction of actions taken.

java/main/src/test/java/com/saucelabs/saucebindings/options/SauceOptionsDeprecatedMapTest.java

@@ -5,8 +5,7 @@
 import org.junit.Test;
 
 /**
- * This Test uses the default SauceOptions constructor then adds configs via Map using mergeCapabilities
- *
+ * This Test uses the default SauceOptions constructor then adds configs via Map using mergeCapabilities.
  * This functionality has been replaced by supporting config files themselves in the constructor
  */
 public class SauceOptionsDeprecatedMapTest {