Skip to main content

Headless tests with Firefox WebDriver

Note: If you are new to java and selenium then start with selenium java training videos. 
 
There are times when you don't want a browser popping each time you execute the test. Or you just don't have privilege of having a browser display like in UNIX based system running your CI and not having any display. These are the times when you would find it right to execute your tests in headless browser mode.

What we need -
  • Xvfb: X virtual frame buffer is X11 server which does graphical operation in memory, hence no output is displayed. Wikipedia has more on it.
  • Firefox: World famous open source browser
  • A simple selenium test: As simple as launching Google in Firefox
First we need to install Xvfb and FF on Ubantu as -

sudo apt-get install Xvfb firefox

Not you can start Xvfb as -

Xvfb :1 -screen 0 1024x768x24 &

From manual of Xvfb -

-screen screennum WxHxD
           This option creates screen screennum and sets  its  width,  height,
           and  depth  to W, H, and D respectively.  By default, only screen 0
           exists and has the dimensions 1280x1024x8.
Now comes the selenium test. You need to guide Firefox so that it executes test in Xvfb started in previous steps.
This could be done by setting System level property for Xvfb as -

String Xport = System.getProperty("lmportal.xvfb.id", ":1");

and directing Firefox binary to use Xvfb as -

        FirefoxBinary firefoxBinary = new FirefoxBinary();
        firefoxBinary.setEnvironmentProperty("DISPLAY", Xport);
        WebDriver driver = new FirefoxDriver(firefoxBinary, null);


If Firefox is not installed in standard location - /usr/bin/firefox then you can also specify path to Firefox binary as -

        final File firefoxPath = new File(System.getProperty(
                "lmportal.deploy.firefox.path", "/usr/bin/firefox"));
        FirefoxBinary firefoxBinary = new FirefoxBinary(firefoxPath);
        firefoxBinary.setEnvironmentProperty("DISPLAY", Xport);
        WebDriver driver = new FirefoxDriver(firefoxBinary, null);


Whole test looks as -

On execution, FF will be launched in Xvfb and snap shot of google would be saved in your test directory. Since it is headless execution of test, you would not really see any browser popping on your screen.

To execute headless tests in Chrome, start chrome driver as -

ChromeDriverService chromeDriverService = new ChromeDriverService.Builder()
        .usingDriverExecutable(new File("/home/tarun/Downloads/chromedriver"))
        .usingAnyFreePort().withEnvironment(ImmutableMap.of("DISPLAY", ":1")).build();
chromeDriverService.start();
WebDriver driver = new ChromeDriver(chromeDriverService);

Popular posts from this blog

Using chrome console to test xPath and css selectors

Note: If you are new to java and selenium then start with selenium java training videos .       Since the advent of selenium there have been many plugin to test xPath / css selectors but you don’t need any of them if you have chrome browser. Using Chrome console you can test both xPath and css selectors. Launch website to be tested in chrome browser and hit F-12 and you would see chrome console opened in lower pane of application - Hit escape key and console would open another pane to write element locators - And now you can start writing xPath or css selectors in chrome console and test them - The syntax for writing css id - $$(“ ”) And hit the enter key. If your expression is right then html snippet of the application element corresponding to the css selector would be displayed - If you mouse over the html snippet in chrome console then it would highlight the corresponding element in application - If you want to clean console of previously wri

XPath and single quotes

I had tough time dealing with XPath and single quote. Though W3C recommends using ' to escape it but I never got it working, let me know if any of you get through. Came across this blog and found that “concat” could be used in this situation. So original XPath expression is – //meta[@name=’DESCRIPTION’][@content=’Tester’s Test’] This is some thing which certainly fails as single quote in “Tester’s” marks it at end of string and then XPath blows up, next trial was – //meta[@name=’DESCRIPTION’][@content=’Tester''s Test’] This does not work despite w3c recommendation! And then I used concat function and split the string as – concat(‘Tester’,”’”,’s Test’) NOTICE that single quote is kept in double quote while other characters are kept in single quotes. So XPath looks as – //meta[@name=’DESCRIPTION’][@content=concat(‘Tester’,”’”,’s Test’)] And this works charm.

Return only first or last element from webelements collection

Note: If you are new to java and selenium then start with selenium java training videos .     We often come across situation when there are multiple elements on a page and we probably like to exercise only a few of them using selenium webdriver. May be just first and last element. For example on a search result page we may like to click on only first and last link and not all. This is when Iterables API comes handy. (By the way I am assuming that you have already completed watching selenium training videos :)). Once we have collection of web element then we can use Iterables to get only first or last element as following - Consider that we fetch collection of element as - List< WebElement > webElements = getDriver().findElements(By. id ( "htmlID" ));   Now we can get the first web element from this collection as -  WebElement firstElement = Iterables. getFirst (webElements,  getDriver().findElement(By. id ( "defaultElement" )));   Herein second