Desired Capabilities in Selenium WebDriver

What is Desired Capability?

The desired capability is a series of key/value pairs that stores the browser properties like browsername, browser version, the path of the browser driver in the system, etc. to determine the behaviour of the browser at run time.

• Desired capability can also be used to configure the driver instance of Selenium WebDriver.
• We can configure driver instance like FirefoxDriver, ChromeDriver, InternetExplorerDriver by using desired capabilities.

In this tutorial, you will learn-

• What is Desired Capability?
• Why do we need Desired Capabilities?
• Different types of Desired Capabilities Methods
• Example for set capability method

Why do we need Desired Capabilities?

Every Testing scenario should be executed on some specific testing environment. The testing environment can be a web browser,Mobile device, mobile emulator, mobile simulator, etc.

The Desired Capabilities Class helps us to tell the webdriver, which environment we are going to use in our test script.

The setCapability method of the DesiredCapabilities Class, which is explained in the later part of the tutorial, can be used in Selenium Grid. It is used to perform a parallel execution on different machine configurations.

Ex: Grid

It is used to set the browser properties (Ex. Chrome, IE), Platform Name (Ex. Linux, Windows) that are used while executing the test cases.

In the case of mobile automation, as we perform the tests on different varieties of mobile devices, the Mobile Platform (ex. iOS, Android) Platform Version (Ex. 3.x,4.x in Android) can be set.

The above emulator example shows the platform set which is android and the platform version set which is IceCream Sandwich (4.x).

Desired Capabilities are more useful in cases like:

• In mobile application automation, where the browser properties and the device properties can be set.
• In Selenium grid when we want to run the test cases on a different browser with different operating systems and versions.

Different types of Desired Capabilities Methods

Here we will see a different type of desired capabilities methods and see how to use one of this method "setCapability Method".

1. getBrowserName()

public java.lang.String getBrowserName()

1. setBrowserName()

public void setBrowserName(java.lang.String browserName)

1. getVersion()

public java.lang.String getVersion()

1. setVersion()

public void setVersion(java.lang.String version)

1. getPlatform()

public Platform getPlatform()

1. setPlatform()

public Platform setPlatform()

1. getCapability Method

The getCapability method of the DesiredCapabilities class can be used to get the capability that is in use currently in the system.

public java.lang.Object getCapability(java.lang.String capabilityName)

1. setCapabilityMethod

The setCapability() method of the Desired Capabilities class can be used to set the device name, platform version, platform name, absolute path of the app under test (the .apk file of the app(Android) under test), app Activity (in Android) and appPackage(java). 

"setCapability method" in Java has the below declarations:

setCapability : public void setCapability(java.lang.String capabilityName,boolean value)

setCapability  :public void setCapability(java.lang.String capabilityName,java.lang.String value)

setCapability  :public void setCapability(java.lang.String capabilityName,Platform value)

setCapability  :public void setCapability(java.lang.String key,java.lang.Object value)

Example for set capability method

Let us consider an example where we want to run our Test Case on Internet explorer browser to open www.gmail.com website using Selenium Webdriver.

Following is the code.

importorg.openqa.selenium.WebDriver;
importorg.openqa.selenium.ie.InternetExplorerDriver;

public class IEtestforDesiredCapabilities {
  
 public static void main(String[] args) {
  
WebDriver IEdriver = new InternetExplorerDriver();
 driver.manage().window().maximize();
 driver.get("http://gmail.com");
  
 driver.quit();
 }
  
}

Now run this code from Eclipse and check out the console.

Output:

It will throw the following error when above code is executed. The error occurs because the path to the browser driver (IE in the above case) is not set.The browser could not be located by the selenium code. 

The path to the driver executable must be set by the webdriver.ie.driver system property; formore information, see http://code.google.com/p/selenium/wiki/InternetExplorerDriver. The latest version can be downloaded from http://code.google.com/p/selenium/downloads/list

Dec 11, 201212:59:43PM org.openqa.selenium.ie.InternetExplorerDriverServer initializeLib

WARNING: This method of starting the IE driver is deprecated and will be removed in selenium 2.26. Please download the IEDriverServer.exe from http://code.google.com/p/selenium/downloads/list and ensure that it is in your PATH.

Solution:

The solution for the above problem is given in the warning section of the error itself.

• Download the Internet ExplorerDriver standalone server for 32bit or 64bit.
• Save the driver in a suitable location in the system.
• Set the path for the driver using the System.setProperty method.
• It is used to set the IE driver with the webdriver property. It helps to locate the driver executable file that is stored in the system location. (Ex:"C:\IEDriverLocation\IEDriver.exe")

importorg.openqa.selenium.WebDriver;
importorg.openqa.selenium.ie.InternetExplorerDriver;
importorg.openqa.selenium.remote.DesiredCapabilities;

public class IEtestforDesiredCapabilities {
  
 public static void main(String[] args) {

//it is used to define IE capability 
 DesiredCapabilities capabilities = DesiredCapabilities.internetExplorer();
  
capabilities.setCapability(CapabilityType.BROWSER_NAME, "IE");
capabilities.setCapability(InternetExplorerDriver.
  INTRODUCE_FLAKINESS_BY_IGNORING_SECURITY_DOMAINS,true);


System.setProperty("webdriver.ie.driver", "C:\\IEDriverServer.exe");
  
 //it is used to initialize the IE driver
 WebDriver driver = new InternetExplorerDriver(capabilities);
  
 driver.manage().window().maximize();

 driver.get("http://gmail.com");
  
 driver.quit();
 }
  
}

Code Explanation:

In the code above,

• The import statements is to import the required packages for the selenium web driver, required packages for the Internet Explorer driver, packages for the desired capabilities.
• setCapability takes the various capabilities as input variables which are then used by the web driver to launch the application in the desired environment.
• setProperty is used to set the path where the driver is located. Web Driver then locates the required driver.
• Gmail website is opened in the Internet Explorer browser by using "get" method.

Output:

The test case on Internet explorer browser will run successfully using Selenium Webdriver.

Conclusion

The Desired Capabilities class will help to set an environment to define the behaviour of the browser/environment on which the test can be executed.

It helps to launch our application in the desired environment having the capabilities that we desire to use.

This article is contributed by Krithika Ramkumar