[java] fix static analysis complaints

Author: titusfortner

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

@@ -14,20 +14,19 @@
 import java.net.URL;
 
 public class SauceSession {
+    @Getter protected RemoteWebDriver driver;
     @Getter @Setter private DataCenter dataCenter = DataCenter.US_WEST;
     @Getter private final SauceOptions sauceOptions;
     @Setter private URL sauceUrl;
     @Getter private String result;
 
-    @Getter protected RemoteWebDriver driver;
-
     public SauceSession() {
         this(new SauceOptions());
     }
 
     /**
-     * Ideally the end user calls build() on Configurations instance
-     * this constructor is being accommodating in case they do not
+     * Ideally the end user calls build() on Configurations instance.
+     * This constructor is being accommodating in case they do not.
      *
      * @param configs the instance of Configuration used to create the Options
      */
@@ -39,11 +38,19 @@ public SauceSession(SauceOptions options) {
         sauceOptions = options;
     }
 
+    /**
+     * Starts the session on Sauce Labs.
+     *
+     * @return the driver instance for using as normal in your tests.
+     */
     public RemoteWebDriver start() {
         this.driver = createRemoteWebDriver(getSauceUrl(), sauceOptions.toCapabilities());
         return driver;
 	}
 
+    /**
+     * @return the full URL for sending to Sauce Labs based on the desired data center.
+     */
     public URL getSauceUrl() {
         try {
             if (sauceUrl != null) {
@@ -56,14 +63,26 @@ public URL getSauceUrl() {
         }
     }
 
-    protected RemoteWebDriver createRemoteWebDriver(URL url, Capabilities capabilities) {
-        return new RemoteWebDriver(url, capabilities);
-    }
-
+    /**
+     * Analyzes Accessibility for the current page.
+     * User can work with the results from the Results object or see them
+     * in the accessibility tab in the Sauce Labs UI.
+     *
+     * @return an object with the accessibility analysis
+     */
     public Results getAccessibilityResults() {
         return getAccessibilityResults(true);
     }
 
+    /**
+     * Analyzes Accessibility for the current page.
+     * User can work with the results from the Results object or see them
+     * in the accessibility tab in the Sauce Labs UI.
+     *
+     * @param frames whether the page being evaluated needs to dig into frames.
+     *               passing false here will slightly improve performance.
+     * @return an object with the accessibility analysis
+     */
     public Results getAccessibilityResults(boolean frames) {
         AxeBuilder axeBuilder = new AxeBuilder();
         if (!frames) {
@@ -72,33 +91,64 @@ public Results getAccessibilityResults(boolean frames) {
         return getAccessibilityResults(axeBuilder);
     }
 
+    /**
+     * Analyzes Accessibility for the current page.
+     * User can work with the results from the Results object or see them
+     * in the accessibility tab in the Sauce Labs UI.
+     *
+     * @param builder for advanced accessibility information provide your own
+     *                instance of an AxeBuilder.
+     * @return an object with the accessibility analysis
+     */
     public Results getAccessibilityResults(AxeBuilder builder) {
         return builder.analyze(driver);
     }
 
+    /**
+     * Ends the session on Sauce Labs and quits the driver.
+     * It requires reporting whether the test has passed or failed.
+     *
+     * @param passed true if the test has passed, otherwise false
+     */
     public void stop(Boolean passed) {
-        String result = passed ? "passed" : "failed";
-        stop(result);
-    }
-
-    public void stop(String result) {
         if (this.driver != null) {
-            updateResult(result);
+            String update = passed ? "passed" : "failed";
+            updateResult(update);
             quit();
         }
     }
 
+    /**
+     * @deprecated Do not use magic strings, pass in boolean for whether test has passed.
+     */
+    @Deprecated
+    public void stop(String result) {
+        stop(result.equals("passed"));
+    }
+
+    /**
+     * Not intended for subclassing.
+     * Package-private for testing.
+     *
+     * @param url to send session commands to
+     * @param capabilities configuration for session
+     * @return driver instance
+     */
+    RemoteWebDriver createRemoteWebDriver(URL url, Capabilities capabilities) {
+        return new RemoteWebDriver(url, capabilities);
+    }
+
     private void updateResult(String result) {
         this.result = result;
         getDriver().executeScript("sauce:job-result=" + result);
 
         // Add output for the Sauce OnDemand Jenkins plugin
         // The first print statement will automatically populate links on Jenkins to Sauce
         // The second print statement will output the job link to logging/console
-        String sauceReporter = String.format("SauceOnDemandSessionID=%s job-name=%s",
+        final String sauceReporter = String.format("SauceOnDemandSessionID=%s job-name=%s",
                 this.driver.getSessionId(),
                 this.sauceOptions.sauce().getName());
-        String sauceTestLink = String.format("Test Job Link: https://app.saucelabs.com/tests/%s",
+        final String sauceTestLink = String.format("Test Job Link: https://app.saucelabs.com/tests/%s",
                 this.driver.getSessionId());
         System.out.print(sauceReporter + "\n" + sauceTestLink + "\n");
     }

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

@@ -5,14 +5,10 @@
 import com.saucelabs.saucebindings.SauceSession;
 import com.saucelabs.saucebindings.options.SauceOptions;
 import org.junit.After;
+import org.junit.Assert;
 import org.junit.Test;
 import org.openqa.selenium.remote.RemoteWebDriver;
 
-import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertNotNull;
-import static org.junit.Assert.assertNull;
-import static org.junit.Assert.assertTrue;
-
 public class DesktopBrowserTest {
     private SauceSession session = new SauceSession();
     private RemoteWebDriver webDriver;
@@ -27,8 +23,8 @@ public void cleanUp() {
     @Test
     public void defaultsToUSWest() {
         webDriver = session.start();
-        assertNotNull(webDriver);
-        assertTrue(session.getSauceUrl().toString().contains("us-west-"));
+        Assert.assertNotNull(webDriver);
+        Assert.assertTrue(session.getSauceUrl().toString().contains("us-west-"));
     }
 
     @Test
@@ -39,26 +35,26 @@ public void runsUSEast() {
         session.setDataCenter(DataCenter.US_EAST);
         webDriver = session.start();
 
-        assertNotNull(webDriver);
-        assertTrue(session.getSauceUrl().toString().contains("us-east-1"));
+        Assert.assertNotNull(webDriver);
+        Assert.assertTrue(session.getSauceUrl().toString().contains("us-east-1"));
     }
 
     @Test
     public void runsAPACSoutheast() {
         session.setDataCenter(DataCenter.APAC_SOUTHEAST);
         webDriver = session.start();
 
-        assertNotNull(webDriver);
-        assertTrue(session.getSauceUrl().toString().contains("apac-southeast"));
+        Assert.assertNotNull(webDriver);
+        Assert.assertTrue(session.getSauceUrl().toString().contains("apac-southeast"));
     }
 
     @Test
     public void runsEUCentral() {
         session.setDataCenter(DataCenter.EU_CENTRAL);
         webDriver = session.start();
 
-        assertNotNull(webDriver);
-        assertTrue(session.getSauceUrl().toString().contains("eu-central-1"));
+        Assert.assertNotNull(webDriver);
+        Assert.assertTrue(session.getSauceUrl().toString().contains("eu-central-1"));
     }
 
     @Test
@@ -68,14 +64,14 @@ public void storesResultOfFirstStop() {
         session.stop(true);
         session.stop(false);
 
-        assertEquals("passed", session.getResult());
+        Assert.assertEquals("passed", session.getResult());
     }
 
     @Test
     public void nullsDriver() {
         webDriver = session.start();
         session.stop(true);
 
-        assertNull(session.getDriver());
+        Assert.assertNull(session.getDriver());
     }
 }