java,tests: Replacing stubs with mocks

Author: barancev

Diff for: java/client/test/org/openqa/selenium/remote/AugmenterTest.java

@@ -34,7 +34,6 @@
 import org.junit.Test;
 import org.junit.runner.RunWith;
 import org.junit.runners.JUnit4;
-import org.mockito.Mockito;
 import org.openqa.selenium.By;
 import org.openqa.selenium.Capabilities;
 import org.openqa.selenium.WebDriver;

Diff for: java/client/test/org/openqa/selenium/remote/BaseAugmenterTest.java

@@ -23,6 +23,7 @@
 import static org.junit.Assert.assertSame;
 import static org.junit.Assert.assertTrue;
 import static org.junit.Assert.fail;
+import static org.mockito.Mockito.mock;
 
 import com.google.common.collect.ImmutableMap;
 import com.google.common.collect.Lists;
@@ -34,7 +35,6 @@
 import org.openqa.selenium.NoSuchElementException;
 import org.openqa.selenium.Rotatable;
 import org.openqa.selenium.ScreenOrientation;
-import org.openqa.selenium.StubDriver;
 import org.openqa.selenium.TakesScreenshot;
 import org.openqa.selenium.WebDriver;
 import org.openqa.selenium.WebElement;
@@ -48,7 +48,7 @@ public abstract class BaseAugmenterTest {
 
   @Test
   public void shouldReturnANormalWebDriverUntouched() {
-    WebDriver driver = new StubDriver();
+    WebDriver driver = mock(WebDriver.class);
 
     WebDriver returned = getAugmenter().augment(driver);
 

Diff for: java/client/test/org/openqa/selenium/remote/DesiredCapabilitiesTest.java

@@ -23,7 +23,6 @@
 import org.junit.runners.JUnit4;
 import org.openqa.selenium.Capabilities;
 import org.openqa.selenium.Platform;
-import org.openqa.selenium.StubDriver;
 import org.openqa.selenium.WebDriver;
 import org.openqa.selenium.logging.LoggingPreferences;
 
@@ -42,8 +41,8 @@ public void testAddingTheSameCapabilityToAMapTwiceShouldResultInOneEntry() {
     Map<org.openqa.selenium.Capabilities, Class<? extends WebDriver>> capabilitiesToDriver =
         new ConcurrentHashMap<Capabilities, Class<? extends WebDriver>>();
 
-    capabilitiesToDriver.put(DesiredCapabilities.firefox(), StubDriver.class);
-    capabilitiesToDriver.put(DesiredCapabilities.firefox(), StubDriver.class);
+    capabilitiesToDriver.put(DesiredCapabilities.firefox(), WebDriver.class);
+    capabilitiesToDriver.put(DesiredCapabilities.firefox(), WebDriver.class);
 
     assertEquals(1, capabilitiesToDriver.size());
   }

Diff for: java/client/test/org/openqa/selenium/support/ThreadGuardTest.java

@@ -19,24 +19,27 @@
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertNotNull;
 import static org.junit.Assert.assertNull;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.withSettings;
 
 import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.junit.runners.JUnit4;
 import org.openqa.selenium.By;
-import org.openqa.selenium.StubDriver;
 import org.openqa.selenium.WebDriver;
-import org.openqa.selenium.WebElement;
 import org.openqa.selenium.interactions.HasTouchScreen;
 
 import java.util.concurrent.atomic.AtomicInteger;
 
 /**
  * @author Kristian Rosenvold
  */
+@RunWith(JUnit4.class)
 public class ThreadGuardTest {
 
   @Test
   public void testProtect() throws Exception {
-    WebDriver actual = new PermissiveStubDriver();
+    WebDriver actual = mock(WebDriver.class);
     final WebDriver protect = ThreadGuard.protect(actual);
     final AtomicInteger successes = new AtomicInteger();
     Thread foo = new Thread(new Runnable() {
@@ -52,23 +55,17 @@ public void run() {
 
   @Test
   public void testProtectSuccess() throws Exception {
-    WebDriver actual = new PermissiveStubDriver();
+    WebDriver actual = mock(WebDriver.class);
     final WebDriver protect = ThreadGuard.protect(actual);
     assertNull(protect.findElement(By.id("foo")));
   }
 
   @Test
   public void testInterfacesProxiedProperly() throws Exception {
-    WebDriver actual = new PermissiveStubDriver();
+    WebDriver actual = mock(WebDriver.class,
+                            withSettings().extraInterfaces(HasTouchScreen.class));
     final WebDriver webdriver = ThreadGuard.protect(actual);
     HasTouchScreen hasTouchScreen = (HasTouchScreen) webdriver;
     assertNotNull(hasTouchScreen);
   }
-
-  class PermissiveStubDriver extends StubDriver {
-    @Override
-    public WebElement findElement(By by) {
-      return null;
-    }
-  }
 }

Diff for: java/client/test/org/openqa/selenium/support/events/EventFiringWebDriverTest.java

@@ -26,6 +26,7 @@
 import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.verifyNoMoreInteractions;
 import static org.mockito.Mockito.when;
+import static org.mockito.Mockito.withSettings;
 
 import org.junit.Test;
 import org.junit.runner.RunWith;
@@ -269,7 +270,8 @@ public void onException(Throwable throwable, WebDriver driver) {
 
   @Test
   public void shouldUnpackElementArgsWhenCallingScripts() {
-    final ExececutingDriver mockedDriver = mock(ExececutingDriver.class);
+    final WebDriver mockedDriver = mock(WebDriver.class,
+                                        withSettings().extraInterfaces(JavascriptExecutor.class));
     final WebElement stubbedElement = mock(WebElement.class);
 
     when(mockedDriver.findElement(By.id("foo"))).thenReturn(stubbedElement);
@@ -279,12 +281,13 @@ public void shouldUnpackElementArgsWhenCallingScripts() {
 
     WebElement element = testedDriver.findElement(By.id("foo"));
     testedDriver.executeScript("foo", element);
-    verify(mockedDriver).executeScript("foo", element);
+    verify((JavascriptExecutor) mockedDriver).executeScript("foo", element);
   }
 
   @Test
   public void testShouldUnpackListOfElementArgsWhenCallingScripts() {
-    final ExececutingDriver mockedDriver = mock(ExececutingDriver.class);
+    final WebDriver mockedDriver = mock(WebDriver.class,
+                                        withSettings().extraInterfaces(JavascriptExecutor.class));
     final WebElement mockElement = mock(WebElement.class);
 
     when(mockedDriver.findElement(By.id("foo"))).thenReturn(mockElement);
@@ -302,7 +305,7 @@ public void testShouldUnpackListOfElementArgsWhenCallingScripts() {
       add("after");
     }});
 
-    verify(mockedDriver).executeScript("foo", new ArrayList<Object>() {{
+    verify((JavascriptExecutor) mockedDriver).executeScript("foo", new ArrayList<Object>() {{
       add("before");
       add(mockElement);
       add("after");
@@ -311,7 +314,8 @@ public void testShouldUnpackListOfElementArgsWhenCallingScripts() {
 
   @Test
   public void testShouldUnpackMapOfElementArgsWhenCallingScripts() {
-    final ExececutingDriver mockedDriver = mock(ExececutingDriver.class);
+    final WebDriver mockedDriver = mock(WebDriver.class,
+                                        withSettings().extraInterfaces(JavascriptExecutor.class));
     final WebElement mockElement = mock(WebElement.class);
 
     when(mockedDriver.findElement(By.id("foo"))).thenReturn(mockElement);
@@ -334,7 +338,7 @@ public void testShouldUnpackMapOfElementArgsWhenCallingScripts() {
       }});
     }});
 
-    verify(mockedDriver).executeScript("foo", new HashMap<String, Object>() {{
+    verify((JavascriptExecutor) mockedDriver).executeScript("foo", new HashMap<String, Object>() {{
       put("foo", "bar");
       put("element", mockElement);
       put("nested", new ArrayList<Object>() {{
@@ -358,27 +362,15 @@ public void shouldBeAbleToWrapSubclassesOfSomethingImplementingTheWebDriverInter
 
   @Test
   public void shouldBeAbleToAccessWrappedInstanceFromEventCalls() {
-    class MyStub extends StubDriver {
-      @Override
-      public void get(String url) {
-        // Do nothing
-      }
-
-      @SuppressWarnings("unused")
-      public void fishy() {
-      }
-
-    }
-
-    final WebDriver stub = new MyStub();
+    final WebDriver stub = mock(WebDriver.class);
     EventFiringWebDriver driver = new EventFiringWebDriver(stub);
-    MyStub wrapped = (MyStub) driver.getWrappedDriver();
+    WebDriver wrapped = driver.getWrappedDriver();
     assertEquals(stub, wrapped);
 
     class MyListener extends AbstractWebDriverEventListener {
       @Override
       public void beforeNavigateTo(String url, WebDriver driver) {
-        MyStub unwrapped = (MyStub) ((WrapsDriver) driver).getWrappedDriver();
+        WebDriver unwrapped = ((WrapsDriver) driver).getWrappedDriver();
 
         assertEquals(stub, unwrapped);
       }
@@ -424,7 +416,5 @@ public void shouldReturnLocatorFromToStringMethod() {
     assertEquals(stubElement.toString(), firingElement.toString());
   }
 
-  private static interface ExececutingDriver extends WebDriver, JavascriptExecutor {}
-
   private static class ChildDriver extends StubDriver {}
 }

Diff for: java/client/test/org/openqa/selenium/support/pagefactory/UsingPageFactoryTest.java

@@ -21,15 +21,16 @@
 import static org.hamcrest.Matchers.equalTo;
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertThat;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
 
 import org.junit.Test;
-import org.openqa.selenium.By;
 import org.openqa.selenium.JavascriptExecutor;
-import org.openqa.selenium.StubDriver;
 import org.openqa.selenium.WebDriver;
 import org.openqa.selenium.WebElement;
 import org.openqa.selenium.remote.RemoteWebElement;
 import org.openqa.selenium.remote.internal.WebElementToJsonConverter;
+import org.openqa.selenium.support.ByIdOrName;
 import org.openqa.selenium.support.CacheLookup;
 import org.openqa.selenium.support.FindBy;
 import org.openqa.selenium.support.PageFactory;
@@ -72,12 +73,8 @@ public void testDecoratedElementsShouldBeUnwrapped() {
     final RemoteWebElement element = new RemoteWebElement();
     element.setId("foo");
 
-    WebDriver driver = new StubDriver() {
-      @Override
-      public WebElement findElement(By by) {
-        return element;
-      }
-    };
+    WebDriver driver = mock(WebDriver.class);
+    when(driver.findElement(new ByIdOrName("element"))).thenReturn(element);
 
     PublicPage page = new PublicPage();
     PageFactory.initElements(driver, page);

Diff for: java/server/test/org/openqa/selenium/remote/server/DefaultSessionTest.java

@@ -17,12 +17,16 @@
 
 package org.openqa.selenium.remote.server;
 
+import static org.mockito.Matchers.any;
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.when;
 
 import org.junit.Test;
 import org.junit.runner.RunWith;
 import org.junit.runners.JUnit4;
+import org.openqa.selenium.Capabilities;
+import org.openqa.selenium.WebDriver;
 import org.openqa.selenium.io.TemporaryFilesystem;
 import org.openqa.selenium.remote.DesiredCapabilities;
 
@@ -31,7 +35,8 @@ public class DefaultSessionTest {
 
   @Test
   public void shouldClearTempFsWhenSessionCloses() throws Exception {
-    final DriverFactory factory = new StubDriverFactory();
+    final DriverFactory factory = mock(DriverFactory.class);
+    when(factory.newInstance(any(Capabilities.class))).thenReturn(mock(WebDriver.class));
     final TemporaryFilesystem tempFs = mock(TemporaryFilesystem.class);
 
     Session session = DefaultSession.createSession(factory, tempFs, null, DesiredCapabilities.firefox());

Diff for: java/server/test/org/openqa/selenium/remote/server/SessionCleanerTest.java

@@ -19,7 +19,11 @@
 
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertTrue;
+import static org.mockito.Matchers.any;
 import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.when;
+import static org.mockito.Mockito.withSettings;
 
 import org.junit.Test;
 import org.junit.runner.RunWith;
@@ -29,7 +33,6 @@
 import org.openqa.selenium.WebDriver;
 import org.openqa.selenium.internal.Killable;
 import org.openqa.selenium.remote.DesiredCapabilities;
-import org.openqa.selenium.remote.RemoteWebDriver;
 import org.openqa.selenium.remote.SessionId;
 import org.openqa.selenium.remote.server.testing.StaticTestSessions;
 
@@ -60,7 +63,9 @@ public void testCleanup() throws Exception {
   @Test
   public void testCleanupWithTimedOutKillableDriver() throws Exception {
     Capabilities capabilities = new DesiredCapabilities("foo", "1", Platform.ANY);
-    DriverSessions testSessions = new StaticTestSessions(capabilities, new KillableDriver());
+    WebDriver killableDriver = mock(WebDriver.class,
+                                    withSettings().extraInterfaces(Killable.class));
+    DriverSessions testSessions = new StaticTestSessions(capabilities, killableDriver);
 
     final Session session = testSessions.get(testSessions.newSession(capabilities));
     final CountDownLatch started = new CountDownLatch(1);
@@ -69,13 +74,12 @@ public void testCleanupWithTimedOutKillableDriver() throws Exception {
     new Thread( runnable).start();
     started.await();
 
-    KillableDriver killableDriver = (KillableDriver) session.getDriver();
     assertTrue(session.isInUse());
     SessionCleaner sessionCleaner = new SessionCleaner(testSessions, log, 10, 10);
     waitForAllSessionsToExpire(11);
     sessionCleaner.checkExpiry();
     assertEquals(0, testSessions.getSessions().size());
-    assertTrue(killableDriver.killed);
+    verify((Killable) killableDriver).kill();
     testDone.countDown();
   }
 
@@ -155,36 +159,8 @@ public void testCleanupWithSessionExtension() throws Exception {
   }
 
   private DriverSessions getDriverSessions() {
-    DriverFactory factory = new MyDriverFactory();
+    DriverFactory factory = mock(DriverFactory.class);
+    when(factory.newInstance(any(Capabilities.class))).thenReturn(mock(WebDriver.class));
     return new DefaultDriverSessions(Platform.LINUX, factory);
   }
-
-  class MyDriverFactory implements DriverFactory {
-    @Override
-    public void registerDriver(Capabilities capabilities, Class<? extends WebDriver> implementation) {
-    }
-
-    @Override
-    public void registerDriverProvider(Capabilities capabilities, DriverProvider implementation) {
-    }
-
-    @Override
-    public WebDriver newInstance(Capabilities capabilities) {
-      return mock(WebDriver.class);
-    }
-
-    @Override
-    public boolean hasMappingFor(Capabilities capabilities) {
-      return true;
-    }
-  }
-
-  static class KillableDriver extends RemoteWebDriver implements Killable {
-    boolean killed;
-
-    public void kill() {
-      killed = true;
-    }
-  }
-
 }