org.resthub.test

Class AbstractWebTest

java.lang.Object

org.resthub.test.AbstractWebTest

public abstract class AbstractWebTest
extends Object

Base class for your webservice tests, based on Jetty and with preconfigured Spring configuration. By default, a single Jetty server is started for all tests so you should take care of cleanup your data after your tests.

If you want restart Jetty server after each test class, set startServerOnce to false and eventually customize port (in order to avoid Jetty server listening on the same port conflict) in the constructor.

By default it use XML context configuration. In order to use @Configuration class, you should set this.annotationBasedConfig = true and this.contextLocations = "org.mypackage"; in your class constructor.

Usually you will have to redefine the Spring profiles used by your application by calling AbstractWebTest super constructor

Field Summary

Fields

Modifier and Type	Field and Description
protected String	activeProfiles List of Spring profiles (use comma separator) to activate For example "resthub-web-server,resthub-jpa"
protected Boolean	annotationBasedConfig When set to true, activate Spring 3.1 JavaConfig based configuration, by setting context param contextClass to org.springframework.web.context.support.AnnotationConfigWebApplicationContext
protected Client	client RESThub http client used to send test requests
protected String	contextLocations Default Spring contexts imported.
protected static org.slf4j.Logger	logger
protected int	port HTTP port used for running web tests, default is 9797
protected static org.eclipse.jetty.server.Server	reusableServer Jetty reusable embedded server that will run your application
protected String	rootUrl Default rootUrl used to send requests
protected org.eclipse.jetty.server.Server	server Class specific Jetty embedded server that will run your application
protected int	servletContextHandlerOption
protected Boolean	startServerOnce Specify if the embedded Jetty server should run once (true, default value) or for each class (false)
protected Boolean	useOpenEntityManagerInViewFilter Define in OpenEntityManagerInViewFilter should be activated or not.

Constructor Summary

Constructors

Constructor and Description
AbstractWebTest() Default constructor
AbstractWebTest(int port) Constructor allowing to specify HTTP port used to run the server
AbstractWebTest(String activeProfiles) Constructor allowing to specify Spring active profiles
AbstractWebTest(String activeProfiles, int port) Constructor allowing to specify Spring active profiles and HTTP port used to run the server

Method Summary

Methods

Modifier and Type	Method and Description
void	afterClass()
void	beforeClass()
protected org.eclipse.jetty.servlet.ServletContextHandler	customizeContextHandler(org.eclipse.jetty.servlet.ServletContextHandler context) You should override it in order to customize the servlet context handler
Client.RequestHolder	request(String urlSuffix) Send a request to the embedded test webserver

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

port

protected int port

HTTP port used for running web tests, default is 9797

startServerOnce

protected Boolean startServerOnce

Specify if the embedded Jetty server should run once (true, default value) or for each class (false)

reusableServer

protected static org.eclipse.jetty.server.Server reusableServer

Jetty reusable embedded server that will run your application

server

protected org.eclipse.jetty.server.Server server

Class specific Jetty embedded server that will run your application

client

protected Client client

RESThub http client used to send test requests

rootUrl

protected String rootUrl

Default rootUrl used to send requests

contextLocations

protected String contextLocations

Default Spring contexts imported. You should not have to customize this one frequently, prefer using Spring 3.1 profiles in order to control configuration activation.

If you use JavaConfig based configuration, use it to specify the package where belong your @Configuration classes

activeProfiles

protected String activeProfiles

List of Spring profiles (use comma separator) to activate For example "resthub-web-server,resthub-jpa"

annotationBasedConfig

protected Boolean annotationBasedConfig

When set to true, activate Spring 3.1 JavaConfig based configuration, by setting context param contextClass to org.springframework.web.context.support.AnnotationConfigWebApplicationContext

useOpenEntityManagerInViewFilter

protected Boolean useOpenEntityManagerInViewFilter

Define in OpenEntityManagerInViewFilter should be activated or not. Default to false

servletContextHandlerOption

protected int servletContextHandlerOption

logger

protected static final org.slf4j.Logger logger

Constructor Detail

AbstractWebTest

public AbstractWebTest()

Default constructor

AbstractWebTest

public AbstractWebTest(String activeProfiles)

Constructor allowing to specify Spring active profiles

Parameters:

activeProfiles - coma separated list of profiles

AbstractWebTest

public AbstractWebTest(int port)

Constructor allowing to specify HTTP port used to run the server

Parameters:

port - HTTP port used for running web tests, default is 9797

AbstractWebTest

public AbstractWebTest(String activeProfiles,
               int port)

Constructor allowing to specify Spring active profiles and HTTP port used to run the server

Parameters:

activeProfiles - coma separated list of profiles

port - HTTP port used for running web tests, default is 9797

Method Detail

customizeContextHandler

protected org.eclipse.jetty.servlet.ServletContextHandler customizeContextHandler(org.eclipse.jetty.servlet.ServletContextHandler context)
                                                                           throws javax.servlet.ServletException

You should override it in order to customize the servlet context handler

Throws:

javax.servlet.ServletException

request

public Client.RequestHolder request(String urlSuffix)

Send a request to the embedded test webserver

Parameters:

urlSuffix - The end of the request without starting /, for example "todo" urlSuffix will send a request to "http://localhost:9797/todo"

Returns:

The requestHolder that will allow you to build and send the request

beforeClass

public void beforeClass()
                 throws Exception

Throws:

Exception

afterClass

public void afterClass()