Web Integration Testing

SeedStack provides support to do integration testing of Web applications.

Using a Web launcher

A SeedStack Web integration test is a normal integration test with its default launcher swapped to a Web-oriented launcher.

SeedStack provides a launcher based on the Undertow embedded server in the seed-web-undertow. In addition the dependency used for normal testing (like seed-testing-junit4), add the following dependency:

<dependency>
    <groupId>org.seedstack.seed</groupId>
    <artifactId>seed-web-undertow</artifactId>
    <version>3.13.0</version>
    <scope>test</scope>
</dependency>

dependencies {
    testCompile("org.seedstack.seed:seed-web-undertow:3.13.0")
}

As an example, consider the following Web integration test:

@RunWith(SeedITRunner.class)
@LaunchWithUndertow
public class SomeWebIT {
    @Configuration("runtime.web.baseUrl")
    private String baseUrl;
    
    @Test
    public void someApiTest() {
        expect()
            .statusCode(200)
            .when()
            .get(baseUrl + "/hello");
    }		
}

This test will start the application with Undertow on an available port and test that the API exposed /hello returns a 200 HTTP code when invoked with GET.

Using Arquillian

For advanced Web testing, you can rely on the SeedStack support for Arquillian instead of using a Web launcher. In that case, you loose SeedStack testing features which are replaced by Arquillian testing features.

For Arquillian support, use the following dependency:

<dependency>
    <groupId>org.seedstack.seed</groupId>
    <artifactId>seed-testing-arquillian</artifactId>
    <version>3.13.0</version>
    <scope>test</scope>
</dependency>

dependencies {
    testCompile("org.seedstack.seed:seed-testing-arquillian:3.13.0")
}

Arquillian tests allow you to programmatically define a Web archive (WAR) and test it either from server-side or from client-side:

@RunWith(Arquillian.class)
public class SomeArquillianIT {
    @Deployment
    public static WebArchive createDeployment() {
        // You can use this method to customize the deployed archive
        return ShrinkWrap.create(WebArchive.class);
    }
    
    @Test
    @RunAsClient
    public void someApiTest(@ArquillianResource URL baseURL) {
        expect().statusCode(200).when().get(baseURL.toString() + "hello");
    }		
}

In this example, the test method, named someApiTest, is a client-side test. It is executed in a separate thread and can invoke the deployed Web application through the URL provided by the @ArquillianResource annotated parameter.

The testing framework and the container(s) used for testing depend on the Arquillian configuration and the dependencies present in the classpath.

Below you can find the dependencies needed (in addition to the one above) for testing using JUnit 4 and Tomcat 8 embedded:

<dependencies>
    <dependency>
        <groupId>org.jboss.arquillian.junit</groupId>
        <artifactId>arquillian-junit-container</artifactId>
        <version>${arquillian.version}</version>
        <scope>test</scope>
    </dependency>
    <dependency>
        <groupId>org.jboss.arquillian.container</groupId>
        <artifactId>arquillian-tomcat-embedded-8</artifactId>
        <version>${arquillian-tomcat.version}</version>
        <scope>test</scope>
    </dependency>
    <dependency>
        <groupId>org.apache.tomcat.embed</groupId>
        <artifactId>tomcat-embed-core</artifactId>
        <version>${tomcat.version}</version>
        <scope>test</scope>
    </dependency>
    <dependency>
        <groupId>org.apache.tomcat.embed</groupId>
        <artifactId>tomcat-embed-jasper</artifactId>
        <version>${tomcat.version}</version>
        <scope>test</scope>
    </dependency>
    <dependency>
        <groupId>org.apache.tomcat.embed</groupId>
        <artifactId>tomcat-embed-websocket</artifactId>
        <version>${tomcat.version}</version>
        <scope>test</scope>
    </dependency>
</dependencies>