You are viewing documentation for Vaadin Framework 8 and related products View documentation for Vaadin Framework 7 ›
Running Tests · Vaadin
Vaadin Testbench - Execution Environment - Running Tests
 Edit This Page

Running Tests

During test development, you usually run the tests from your IDE. After that, you want to have them run by a build system, possibly under a continuous integration system. In the following, we describe how to run tests by Ant and Maven.

Running Tests with Ant

Apache Ant has built-in support for executing JUnit tests; you can use the <junit> task in an Ant script to execute JUnit tests. Note that in earlier versions, you need to enable the support, you need to have the JUnit library junit.jar and its Ant integration library ant-junit.jar in the Ant classpath, as described in the Ant documentation.

The following Ant script allows testing a Vaadin application created with the Vaadin Plugin for Eclipse. It assumes that the test source files are located under a test directory under the current directory and compiles them to the classes directory. The the class path is defined with the classpath reference ID and should contain TestBench and other necessary libraries.

<?xml version="1.0" encoding="UTF-8"?>
<project default="run-tests">
    <path id="classpath">
        <fileset dir="lib">
            <include name="vaadin-testbench-*.jar"/>
            <include name="junit-*.jar"/>

    <!-- This target compiles the JUnit tests. -->
    <target name="compile-tests">
        <mkdir dir="classes" />
        <javac srcdir="test" destdir="classes"
               debug="on" encoding="utf-8"
                <path refid="classpath" />

    <!-- This target calls JUnit -->
    <target name="run-tests" depends="compile-tests">
        <junit fork="yes">
                <path refid="classpath" />
                <pathelement path="classes" />

            <formatter type="brief" usefile="false" />

                <fileset dir="test">
                    <include name="**/**.java" />

You also need to deploy the application to test, and possibly launch a dedicated server for it.

Retrieving TestBench with Ivy

To retrieve TestBench and its dependencies with Ivy in the Ant script, first install Ivy to your Ant installation, if necessary. In the build script, you need to enable Ivy with the namespace declaration and include a target for retrieving the libraries, as follows:

<project xmlns:ivy="antlib:org.apache.ivy.ant"
    <!-- Retrieve dependencies with Ivy -->
    <target name="resolve">
        <ivy:retrieve conf="testing" type="jar,bundle"

    <!-- This target compiles the JUnit tests. -->
    <target name="compile-tests" depends="resolve">

This requires that you have a " testing" configuration in your ivy.xml and that the TestBench dependency are enabled in the configuration.

        <conf name="testing" />

        <!-- TestBench 4 -->
        <dependency org="com.vaadin"
                    conf=nodeploy,testing - ▸ default />

You also need to build and deploy the application to be tested to the server and install the TestBench license key.

Running Tests with Maven

Executing JUnit tests with Vaadin TestBench under Maven requires defining it as a dependency in any POM that needs to execute TestBench tests.

A complete example of a Maven test setup is given in the TestBench demo project available at See the README for further instructions.

Defining TestBench as a Dependency

You need to define the TestBench library as a dependency in the Maven POM of your project as follows:


For instructions on how to create a new Vaadin project with Maven, please see Using Vaadin with Maven.

Running the Tests

To compile and run the tests, simply execute the test lifecycle phase with Maven as follows:

$ mvn test
 T E S T S
Running TestBenchExample
Tests run: 6, Failures: 1, Errors: 0, Skipped: 1, Time elapsed: 36.736 sec <<< FAILURE!

Results :

Failed tests:
      expected:<[5/17/]12> but was:<[17.6.20]12>

Tests run: 6, Failures: 1, Errors: 0, Skipped: 1

The example configuration starts Jetty to run the application that is tested.

If you have screenshot tests enabled, as mentioned in TestBench Demo, you will get failures from screenshot comparison. The failed screenshots are written to the target/testbench/errors folder. To enable comparing them to "expected" screenshots, you need to copy the screenshots to the src/test/resources/screenshots/reference/ folder. See Taking and Comparing Screenshots for more information regarding screenshots.