org.openqa.selenium.chrome

Class ChromeDriver

java.lang.Object

org.openqa.selenium.remote.RemoteWebDriver

org.openqa.selenium.chrome.ChromeDriver

All Implemented Interfaces:

org.openqa.selenium.HasCapabilities, org.openqa.selenium.html5.LocationContext, org.openqa.selenium.html5.WebStorage, org.openqa.selenium.interactions.HasInputDevices, org.openqa.selenium.internal.FindsByClassName, org.openqa.selenium.internal.FindsByCssSelector, org.openqa.selenium.internal.FindsById, org.openqa.selenium.internal.FindsByLinkText, org.openqa.selenium.internal.FindsByName, org.openqa.selenium.internal.FindsByTagName, org.openqa.selenium.internal.FindsByXPath, org.openqa.selenium.JavascriptExecutor, org.openqa.selenium.SearchContext, org.openqa.selenium.TakesScreenshot, org.openqa.selenium.WebDriver

public class ChromeDriver
extends RemoteWebDriver
implements org.openqa.selenium.html5.LocationContext, org.openqa.selenium.html5.WebStorage

A WebDriver implementation that controls a Chrome browser running on the local machine. This class is provided as a convenience for easily testing the Chrome browser. The control server which each instance communicates with will live and die with the instance.

To avoid unnecessarily restarting the ChromeDriver server with each instance, use a RemoteWebDriver coupled with the desired ChromeDriverService, which is managed separately. For example:

 
 import static org.junit.Assert.assertEquals;
 
 import org.junit.*;
 import org.junit.runner.RunWith;
 import org.junit.runners.JUnit4;
 import org.openqa.selenium.chrome.ChromeDriverService;
 import org.openqa.selenium.remote.DesiredCapabilities;
 import org.openqa.selenium.remote.RemoteWebDriver;
 
 @RunWith(JUnit4.class)
 public class ChromeTest extends TestCase {
 
   private static ChromeDriverService service;
   private WebDriver driver;
 
   @BeforeClass
   public static void createAndStartService() {
     service = new ChromeDriverService.Builder()
         .usingChromeDriverExecutable(new File("path/to/my/chromedriver.exe"))
         .usingAnyFreePort()
         .build();
     service.start();
   }
 
   @AfterClass
   public static void createAndStopService() {
     service.stop();
   }
 
   @Before
   public void createDriver() {
     driver = new RemoteWebDriver(service.getUrl(),
         DesiredCapabilities.chrome());
   }
 
   @After
   public void quitDriver() {
     driver.quit();
   }
 
   @Test
   public void testGoogleSearch() {
     driver.get("http://www.google.com");
     WebElement searchBox = driver.findElement(By.name("q"));
     searchBox.sendKeys("webdriver");
     searchBox.quit();
     assertEquals("webdriver - Google Search", driver.getTitle());
   }
 }
 

Note that unlike ChromeDriver, RemoteWebDriver doesn't directly implement role interfaces such as LocationContext and WebStorage. Therefore, to access that functionality, it needs to be augmented and then cast to the appropriate interface.

See Also:

ChromeDriverService.createDefaultService()

Nested Class Summary

Nested classes/interfaces inherited from class org.openqa.selenium.remote.RemoteWebDriver

RemoteWebDriver.RemoteTargetLocator, RemoteWebDriver.RemoteWebDriverOptions, RemoteWebDriver.When

Nested classes/interfaces inherited from interface org.openqa.selenium.WebDriver

org.openqa.selenium.WebDriver.ImeHandler, org.openqa.selenium.WebDriver.Navigation, org.openqa.selenium.WebDriver.Options, org.openqa.selenium.WebDriver.TargetLocator, org.openqa.selenium.WebDriver.Timeouts, org.openqa.selenium.WebDriver.Window

Constructor Summary

Constructors

Constructor and Description
ChromeDriver() Creates a new ChromeDriver using the default server configuration.
ChromeDriver(org.openqa.selenium.Capabilities capabilities) Creates a new ChromeDriver instance.
ChromeDriver(ChromeDriverService service) Creates a new ChromeDriver instance.
ChromeDriver(ChromeDriverService service, org.openqa.selenium.Capabilities capabilities) Creates a new ChromeDriver instance.
ChromeDriver(ChromeDriverService service, ChromeOptions options) Creates a new ChromeDriver instance with the specified options.
ChromeDriver(ChromeOptions options) Creates a new ChromeDriver instance with the specified options.

Method Summary

Methods

Modifier and Type	Method and Description
org.openqa.selenium.html5.LocalStorage	getLocalStorage()
org.openqa.selenium.html5.SessionStorage	getSessionStorage()
org.openqa.selenium.html5.Location	location()
void	setFileDetector(FileDetector detector)
void	setLocation(org.openqa.selenium.html5.Location location)

Methods inherited from class org.openqa.selenium.remote.RemoteWebDriver

close, execute, execute, executeAsyncScript, executeScript, findElement, findElement, findElementByClassName, findElementByCssSelector, findElementById, findElementByLinkText, findElementByName, findElementByPartialLinkText, findElementByTagName, findElementByXPath, findElements, findElements, findElementsByClassName, findElementsByCssSelector, findElementsById, findElementsByLinkText, findElementsByName, findElementsByPartialLinkText, findElementsByTagName, findElementsByXPath, get, getCapabilities, getCommandExecutor, getCurrentUrl, getElementConverter, getErrorHandler, getExecuteMethod, getFileDetector, getKeyboard, getMouse, getPageSource, getRemoteStatus, getScreenshotAs, getSessionId, getTitle, getWindowHandle, getWindowHandles, log, manage, navigate, quit, setCommandExecutor, setElementConverter, setErrorHandler, setFoundBy, setLogLevel, setSessionId, startClient, startSession, startSession, stopClient, switchTo, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ChromeDriver

public ChromeDriver()

Creates a new ChromeDriver using the default server configuration.

See Also:

ChromeDriver(ChromeDriverService, ChromeOptions)

ChromeDriver

public ChromeDriver(ChromeDriverService service)

Creates a new ChromeDriver instance. The service will be started along with the driver, and shutdown upon calling RemoteWebDriver.quit().

Parameters:

service - The service to use.

See Also:

ChromeDriver(ChromeDriverService, ChromeOptions)

ChromeDriver

public ChromeDriver(org.openqa.selenium.Capabilities capabilities)

Creates a new ChromeDriver instance. The capabilities will be passed to the chromedriver service.

Parameters:

capabilities - The capabilities required from the ChromeDriver.

See Also:

ChromeDriver(ChromeDriverService, Capabilities)

ChromeDriver

public ChromeDriver(ChromeOptions options)

Creates a new ChromeDriver instance with the specified options.

Parameters:

options - The options to use.

See Also:

ChromeDriver(ChromeDriverService, ChromeOptions)

ChromeDriver

public ChromeDriver(ChromeDriverService service,
            ChromeOptions options)

Creates a new ChromeDriver instance with the specified options. The service will be started along with the driver, and shutdown upon calling RemoteWebDriver.quit().

Parameters:

service - The service to use.

options - The options to use.

ChromeDriver

public ChromeDriver(ChromeDriverService service,
            org.openqa.selenium.Capabilities capabilities)

Creates a new ChromeDriver instance. The service will be started along with the driver, and shutdown upon calling RemoteWebDriver.quit().

Parameters:

service - The service to use.

capabilities - The capabilities required from the ChromeDriver.

Method Detail

setFileDetector

public void setFileDetector(FileDetector detector)

Overrides:

setFileDetector in class RemoteWebDriver

getLocalStorage

public org.openqa.selenium.html5.LocalStorage getLocalStorage()

Specified by:

getLocalStorage in interface org.openqa.selenium.html5.WebStorage

getSessionStorage

public org.openqa.selenium.html5.SessionStorage getSessionStorage()

Specified by:

getSessionStorage in interface org.openqa.selenium.html5.WebStorage

location

public org.openqa.selenium.html5.Location location()

Specified by:

location in interface org.openqa.selenium.html5.LocationContext

setLocation

public void setLocation(org.openqa.selenium.html5.Location location)

Specified by:

setLocation in interface org.openqa.selenium.html5.LocationContext