SafariDriver always runs a clean session

Author: barancev

java/client/src/org/openqa/selenium/safari/SafariOptions.java

@@ -61,8 +61,6 @@ private interface Option {
 
   public SafariOptions() {
     setUseTechnologyPreview(false);
-    useCleanSession(false);
-
     setCapability(CapabilityType.BROWSER_NAME, "safari");
   }
 
@@ -121,20 +119,14 @@ public static SafariOptions fromCapabilities(Capabilities capabilities)
    * session data.
    *
    * @param useCleanSession If true, the SafariDriver will erase all existing session data.
+   * @deprecated SafariDriver always runs a clean session
    */
+  @Deprecated
   public SafariOptions useCleanSession(boolean useCleanSession) {
     options.put(Option.CLEAN_SESSION, useCleanSession);
     return this;
   }
 
-  /**
-   * @deprecated Use {@link #useCleanSession(boolean)} instead
-   */
-  @Deprecated
-  public SafariOptions setUseCleanSession(boolean useCleanSession) {
-    return useCleanSession(useCleanSession);
-  }
-
   /**
    * Instruct the SafariDriver to use the Safari Technology Preview if true, otherwise use the
    * release version of Safari. Defaults to using the release version of Safari.
@@ -151,8 +143,6 @@ public SafariOptions setUseTechnologyPreview(boolean useTechnologyPreview) {
   public void setCapability(String key, Object value) {
     if (Option.TECHNOLOGY_PREVIEW.equals(key)) {
       setUseTechnologyPreview(Boolean.valueOf(value.toString()));
-    } else if (Option.CLEAN_SESSION.equals(key)) {
-      useCleanSession(Boolean.valueOf(value.toString()));
     } else {
       super.setCapability(key, value);
     }
@@ -162,8 +152,6 @@ public void setCapability(String key, Object value) {
   public void setCapability(String key, boolean value) {
     if (Option.TECHNOLOGY_PREVIEW.equals(key)) {
       setUseTechnologyPreview(value);
-    } else if (Option.CLEAN_SESSION.equals(key)) {
-      useCleanSession(value);
     } else {
       super.setCapability(key, value);
     }
@@ -176,20 +164,6 @@ public SafariOptions setProxy(Proxy proxy) {
 
   // Getters
 
-  /**
-   * @return Whether the SafariDriver should erase all session data before launching Safari.
-   * @see #setUseCleanSession(boolean)
-   * @deprecated Getters are not needed in browser Options classes.
-   */
-  @Deprecated
-  public boolean getUseCleanSession() {
-    return (boolean) options.getOrDefault(Option.CLEAN_SESSION, false);
-  }
-
-  /**
-   * @deprecated Getters are not needed in browser Options classes.
-   */
-  @Deprecated
   public boolean getUseTechnologyPreview() {
     return (boolean) options.getOrDefault(Option.TECHNOLOGY_PREVIEW, false);
   }
@@ -204,11 +178,6 @@ public boolean getUseTechnologyPreview() {
   private static SafariOptions fromJsonMap(Map<?, ?> options)  {
     SafariOptions safariOptions = new SafariOptions();
 
-    Boolean useCleanSession = (Boolean) options.get(Option.CLEAN_SESSION);
-    if (useCleanSession != null) {
-      safariOptions.useCleanSession(useCleanSession);
-    }
-
     Boolean useTechnologyPreview = (Boolean) options.get(Option.TECHNOLOGY_PREVIEW);
     if (useTechnologyPreview != null) {
       safariOptions.setUseTechnologyPreview(useTechnologyPreview);

java/client/test/org/openqa/selenium/safari/CleanSessionTest.java

@@ -21,41 +21,43 @@
 import static org.junit.Assert.assertTrue;
 import static org.openqa.selenium.testing.Driver.SAFARI;
 
-import org.junit.AfterClass;
+import org.junit.After;
 import org.junit.Test;
 import org.openqa.selenium.By;
 import org.openqa.selenium.Cookie;
 import org.openqa.selenium.JavascriptExecutor;
+import org.openqa.selenium.WebDriver;
 import org.openqa.selenium.testing.Ignore;
 import org.openqa.selenium.testing.JUnit4TestBase;
 import org.openqa.selenium.testing.NeedsLocalEnvironment;
-import org.openqa.selenium.testing.NotYetImplemented;
 
 @NeedsLocalEnvironment(reason = "Requires local browser launching environment")
 public class CleanSessionTest extends JUnit4TestBase {
 
   private static final Cookie COOKIE = new Cookie("foo", "bar");
 
-  @AfterClass
-  public static void quitDriver() {
-    removeDriver();
+  private WebDriver driver2;
+
+  @After
+  public void quitDriver() {
+    if (driver2 != null) {
+      driver2.quit();
+    }
   }
 
   private void createCleanSession() {
+    removeDriver();
     quitDriver();
-
     SafariOptions safariOptions = new SafariOptions();
-    safariOptions.setUseCleanSession(true);
-    driver = new SafariDriver(safariOptions);
-    driver.get(pages.alertsPage);
+    driver2 = new SafariDriver(safariOptions);
+    driver2.get(pages.alertsPage);
   }
 
   @Test
-  @NotYetImplemented(SAFARI)
   public void shouldClearCookiesWhenStartingWithACleanSession() {
     createCleanSession();
     assertNoCookies();
-    driver.manage().addCookie(COOKIE);
+    driver2.manage().addCookie(COOKIE);
     assertHasCookie(COOKIE);
 
     createCleanSession();
@@ -120,10 +122,10 @@ public void doesNotCreateExtraIframeOnPageUnderTest() {
   }
 
   private void assertHasCookie(Cookie cookie) {
-    assertTrue(driver.manage().getCookies().contains(cookie));
+    assertTrue(driver2.manage().getCookies().contains(cookie));
   }
 
   private void assertNoCookies() {
-    assertTrue(driver.manage().getCookies().isEmpty());
+    assertTrue(driver2.manage().getCookies().isEmpty());
   }
 }

java/client/test/org/openqa/selenium/safari/SafariOptionsTest.java

@@ -23,22 +23,11 @@
 import org.junit.Test;
 import org.openqa.selenium.ImmutableCapabilities;
 
-import java.util.Map;
-
 public class SafariOptionsTest {
 
-  @Test
-  public void commonUsagePatternWorks() {
-    SafariOptions options = new SafariOptions().useCleanSession(true);
-    Map<String, ?> caps = options.asMap();
-    assertEquals(((Map<String, ?>) caps.get(SafariOptions.CAPABILITY)).get("cleanSession"), true);
-  }
-
   @Test
   public void roundTrippingToCapabilitiesAndBackWorks() {
-    SafariOptions expected = new SafariOptions()
-        .useCleanSession(true)
-        .setUseTechnologyPreview(true);
+    SafariOptions expected = new SafariOptions().setUseTechnologyPreview(true);
 
     // Convert to a Map so we can create a standalone capabilities instance, which we then use to
     // create a new set of options. This is the round trip, ladies and gentlemen.
@@ -50,9 +39,8 @@ public void roundTrippingToCapabilitiesAndBackWorks() {
   @Test
   public void canConstructFromCapabilities() {
     SafariOptions options = new SafariOptions(
-        new ImmutableCapabilities("cleanSession", true, "technologyPreview", true));
+        new ImmutableCapabilities("technologyPreview", true));
 
-    assertTrue(options.getUseCleanSession());
     assertTrue(options.getUseTechnologyPreview());
   }