Selenium-Screenshot

Tool to make screenshots of urls and compare them using ImageMagick via IM4Java.

Prerequisites

• Clone repo and type mvn install to build .jar.
• Put built .jar in your local Maven repository or...
• Add repository to pom.xml of your project (only for corporation) :

<repositories>
    <repository>
        <snapshots>enabled</snapshots>
        <id>snapshots</id>
        <name>Snapshots</name>
        <url>.../nexus/content/repositories/snapshots/</url>
    </repository>
</repositories>

• Add Selenium and Selenium-Screenshot as Maven dependency:

<dependency>
    <groupId>org.seleniumhq.selenium</groupId>
    <artifactId>selenium-java</artifactId>
    <version>3.0.1</version>
</dependency>

<dependency>
    <groupId>de.triology</groupId>
    <artifactId>selenium-screenshot</artifactId>
    <version>1.0-SNAPSHOT</version>
</dependency>

• Make sure you have Chromedriver or Firefox Geckodriver on your PATH.
• Install ImageMagick.

Getting Started

• Import selenium WebDriver and the Screenshooter into your Java Class:

import org.openqa.selenium.*;
import de.triology.selenium_screenshot.Screenshooter; 

• Use Screenshooter as follows:

public class SampleMain
{
    public static void main(String[] args)
    {
        // Make sure Chromedriver is on your PATH
        WebDriver webDriver = new ChromeDriver();
        webDriver.manage().window().maximize();

        Screenshooter sshot = new Screenshooter(webDriver);
        /* 
        *  On Windows ImageMagick won't be on your PATH by default after installation.
        *  You cann add it manually.
        *
        *  String ImageMagickPath = "C:\\Programs\\ImageMagick;C:\\Programs\\exiftool";
        *  Screenshooter sshot = new Screenshooter(webDriver, ImageMagickPath);
        */

        webDriver.get("http://im4java.sourceforge.net/install/index.html");

        sshot.makeScreenshot("screenshot/folder","screenshot01.png");

        webDriver.get("http://im4java.sourceforge.net/docs/index.html");

        sshot.makeScreenshot("screenshot/folder","screenshot02");

        int comparisonResult = sshot.compareImages("screenshot/folder","screenshot01","screenshot02.png");

        if (comparisonResult == -1) {
            System.out.println("Screenshots comparison failed");
        } else if (comparisonResult > 0) {
            System.out.println("Screenshots differ in " + comparisonResult + " pixels");
        }

        webDriver.close();
    }
}

• Screenshot folders are relative to project working directory.
• Screenshot name can be "screenshot" or screenshot.png.
• Images are saved as png files.

Known Issues

• IM4Java as used in the Screenshooter can't compare two images with different dimensions.
• Pages with scrollbars will be stuck together view by view (see AShot framework).

TODOs

• Get rid of scrollbar of oversized full pages.
• Find a way to compare images of different dimensions (maybe cut images using ImageMagicks convert and compare parts of same size).
• Future: Build Jenkins plugin to take screenshots automatically during build test phase and present images if there are differences between GUIs of another version.