org.spincast.testing.core

Class AppBasedTestingBase<R extends RequestContext<?>,W extends WebsocketContext<?>>

java.lang.Object

org.spincast.testing.core.SpincastTestBase

org.spincast.testing.core.AppBasedTestingBase<R,W>

All Implemented Interfaces:

BeforeAfterClassMethodsProvider, RepeatedClassAfterMethodProvider, TestFailureListener

public abstract class AppBasedTestingBase<R extends RequestContext<?>,W extends WebsocketContext<?>>
extends SpincastTestBase

Field Summary

Fields inherited from class org.spincast.testing.core.SpincastTestBase

logger, spincastConfig

Constructor Summary

Constructors

Constructor and Description
AppBasedTestingBase()

Method Summary

Modifier and Type	Method and Description
void	afterClass()
protected org.spincast.plugins.httpclient.builders.ConnectRequestBuilder	CONNECT(String path) Starts an Http Client builder for a CONNECT method.
protected org.spincast.plugins.httpclient.builders.ConnectRequestBuilder	CONNECT(String pathOrUrl, boolean isFullUrl) Starts an Http Client builder for a CONNECT method.
protected org.spincast.plugins.httpclient.builders.ConnectRequestBuilder	CONNECT(String pathOrUrl, boolean isFullUrl, boolean isHttps) Starts an Http Client builder for a CONNECT method.
protected com.google.inject.Injector	createInjector() The test class must implement this method to create the Guice injector.
protected String	createTestUrl(String path) Creates an URL to the started HTTP server.
protected String	createTestUrl(String path, boolean https) Creates an URL to the started HTTP server.
protected String	createTestUrl(String pathOrUrl, boolean isFullUrl, boolean isHttps) Creates an URL to the started HTTP server.
protected org.spincast.plugins.httpclient.builders.DeleteRequestBuilder	DELETE(String path) Starts an Http Client builder for a DELETE method.
protected org.spincast.plugins.httpclient.builders.DeleteRequestBuilder	DELETE(String pathOrUrl, boolean isFullUrl) Starts an Http Client builder for a DELETE method.
protected org.spincast.plugins.httpclient.builders.DeleteRequestBuilder	DELETE(String pathOrUrl, boolean isFullUrl, boolean isHttps) Starts an Http Client builder for a DELETE method.
protected String	formatDate(Date date) Format a date so it can be used in a HTTP header.
protected org.spincast.plugins.httpclient.builders.GetRequestBuilder	GET(String path) Starts an Http Client builder for a GET method.
protected org.spincast.plugins.httpclient.builders.GetRequestBuilder	GET(String pathOrUrl, boolean isFullUrl) Starts an Http Client builder for a GET method.
protected org.spincast.plugins.httpclient.builders.GetRequestBuilder	GET(String pathOrUrl, boolean isFullUrl, boolean isHttps) Starts an Http Client builder for a GET method.
protected abstract AppTestingConfigs	getAppTestingConfigs() We force test classes to provide information about the required testing configurations.
protected CookieFactory	getCookieFactory()
protected com.google.inject.Module	getExtraOverridingModule() If an overriding Module is to be added using the Guice tweaker.
protected com.google.inject.Module	getExtraOverridingModule2()
protected List<SpincastPlugin>	getExtraPlugins() The extra required plugins.
protected List<SpincastPlugin>	getExtraPlugins2() The extra required plugins.
protected HttpClient	getHttpClient()
protected Router<R,W>	getRouter()
protected Server	getServer()
protected Class<? extends SpincastConfig>	getTestingConfigImplementationClass() The implementation to use for the SpincastConfig binding, when running tests.
protected org.spincast.plugins.httpclient.builders.HeadRequestBuilder	HEAD(String path) Starts an Http Client builder for a HEAD method.
protected org.spincast.plugins.httpclient.builders.HeadRequestBuilder	HEAD(String pathOrUrl, boolean isFullUrl) Starts an Http Client builder for a HEAD method.
protected org.spincast.plugins.httpclient.builders.HeadRequestBuilder	HEAD(String pathOrUrl, boolean isFullUrl, boolean isHttps) Starts an Http Client builder for a HEAD method.
protected boolean	isDisableBindCurrentClass()
protected boolean	isDisableSllCetificateErrors() By default, for the tests, by disable the SSL certificate errors.
protected org.spincast.plugins.httpclient.builders.OptionsRequestBuilder	OPTIONS(String path) Starts an Http Client builder for a OPTIONS method.
protected org.spincast.plugins.httpclient.builders.OptionsRequestBuilder	OPTIONS(String pathOrUrl, boolean isFullUrl) Starts an Http Client builder for a OPTIONS method.
protected org.spincast.plugins.httpclient.builders.OptionsRequestBuilder	OPTIONS(String pathOrUrl, boolean isFullUrl, boolean isHttps) Starts an Http Client builder for a OPTIONS method.
protected Date	parseDate(String dateHeaderValue) Parse a date from a HTTP header to a Date object.
protected org.spincast.plugins.httpclient.builders.PatchRequestBuilder	PATCH(String path) Starts an Http Client builder for a PATCH method.
protected org.spincast.plugins.httpclient.builders.PatchRequestBuilder	PATCH(String pathOrUrl, boolean isFullUrl) Starts an Http Client builder for a PATCH method.
protected org.spincast.plugins.httpclient.builders.PatchRequestBuilder	PATCH(String pathOrUrl, boolean isFullUrl, boolean isHttps) Starts an Http Client builder for a PATCH method.
protected org.spincast.plugins.httpclient.builders.PostRequestBuilder	POST(String path) Starts an Http Client builder for a POST method.
protected org.spincast.plugins.httpclient.builders.PostRequestBuilder	POST(String pathOrUrl, boolean isFullUrl) Starts an Http Client builder for a POST method.
protected org.spincast.plugins.httpclient.builders.PostRequestBuilder	POST(String pathOrUrl, boolean isFullUrl, boolean isHttps) Starts an Http Client builder for a POST method.
protected org.spincast.plugins.httpclient.builders.PutRequestBuilder	PUT(String path) Starts an Http Client builder for a PUT method.
protected org.spincast.plugins.httpclient.builders.PutRequestBuilder	PUT(String pathOrUrl, boolean isFullUrl) Starts an Http Client builder for a PUT method.
protected org.spincast.plugins.httpclient.builders.PutRequestBuilder	PUT(String pathOrUrl, boolean isFullUrl, boolean isHttps) Starts an Http Client builder for a PUT method.
protected abstract void	startApp() Starts the application.
protected void	stopServer()
protected org.spincast.plugins.httpclient.builders.TraceRequestBuilder	TRACE(String path) Starts an Http Client builder for a TRACE method.
protected org.spincast.plugins.httpclient.builders.TraceRequestBuilder	TRACE(String pathOrUrl, boolean isFullUrl) Starts an Http Client builder for a TRACE method.
protected org.spincast.plugins.httpclient.builders.TraceRequestBuilder	TRACE(String pathOrUrl, boolean isFullUrl, boolean isHttps) Starts an Http Client builder for a TRACE method.
protected void	validateCreatedInjector(com.google.inject.Injector guice) Validates the created Injector, before the dependencies are injected in the test class.
protected WebsocketRequestBuilder	websocket(String path)
protected WebsocketRequestBuilder	websocket(String pathOrUrl, boolean isFullUrl)
protected WebsocketRequestBuilder	websocket(String pathOrUrl, boolean isFullUrl, boolean isHttps)

Methods inherited from class org.spincast.testing.core.SpincastTestBase

addExtraSystemProperties, afterClassLoops, afterTest, beforeClass, beforeClassException, beforeTest, createGuiceTweaker, createTestingFilePath, createTestingFilePath, deleteTempDir, getExtraSystemProperties, getGuiceTweakerFromThreadLocal, getInjector, getSpincastConfig, getTestingWritableDir, resetSystemProperties, testFailure

Methods inherited from class java.lang.Object

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

Constructor Detail

AppBasedTestingBase

public AppBasedTestingBase()

Method Detail

createInjector

protected final com.google.inject.Injector createInjector()

Description copied from class: SpincastTestBase

The test class must implement this method to create the Guice injector. It can be done by starting a real application (with a main(...) method) or by creating a custom Injector.

Specified by:

createInjector in class SpincastTestBase

getTestingConfigImplementationClass

protected final Class<? extends SpincastConfig> getTestingConfigImplementationClass()

Description copied from class: SpincastTestBase

The implementation to use for the SpincastConfig binding, when running tests.

Overrides:

getTestingConfigImplementationClass in class SpincastTestBase

isDisableBindCurrentClass

protected final boolean isDisableBindCurrentClass()

Overrides:

isDisableBindCurrentClass in class SpincastTestBase

getExtraOverridingModule

protected final com.google.inject.Module getExtraOverridingModule()

Description copied from class: SpincastTestBase

If an overriding Module is to be added using the Guice tweaker.

Overrides:

getExtraOverridingModule in class SpincastTestBase

getExtraOverridingModule2

protected com.google.inject.Module getExtraOverridingModule2()

getExtraPlugins

protected final List<SpincastPlugin> getExtraPlugins()

The extra required plugins.

Overrides:

getExtraPlugins in class SpincastTestBase

getExtraPlugins2

protected List<SpincastPlugin> getExtraPlugins2()

The extra required plugins.

validateCreatedInjector

protected void validateCreatedInjector(com.google.inject.Injector guice)

Description copied from class: SpincastTestBase

Validates the created Injector, before the dependencies are injected in the test class.

Overrides:

validateCreatedInjector in class SpincastTestBase

afterClass

public void afterClass()

Specified by:

afterClass in interface BeforeAfterClassMethodsProvider

Overrides:

afterClass in class SpincastTestBase

stopServer

protected void stopServer()

getHttpClient

protected HttpClient getHttpClient()

getRouter

protected Router<R,W> getRouter()

getCookieFactory

protected CookieFactory getCookieFactory()

getServer

protected Server getServer()

createTestUrl

protected String createTestUrl(String path)

Creates an URL to the started HTTP server.

Parameters:

path - the relative path to be appended to the base test URL.

createTestUrl

protected String createTestUrl(String path,
                               boolean https)

Creates an URL to the started HTTP server.

Parameters:

path - the relative path to be appended to the base test URL.

https - if true, "https:" will be used instead of "http:".

createTestUrl

protected String createTestUrl(String pathOrUrl,
                               boolean isFullUrl,
                               boolean isHttps)

Creates an URL to the started HTTP server.

Parameters:

pathOrUrl - a relative path OR a full URL.

isFullUrl - if the 'pathOrUrl' parameter a full URL? If so, it will be used as is. Otherwise it will be appended to the base test URL.

isHttps - if true, "https:" will be used instead of "http:".

websocket

protected WebsocketRequestBuilder websocket(String path)

websocket

protected WebsocketRequestBuilder websocket(String pathOrUrl,
                                            boolean isFullUrl)

websocket

protected WebsocketRequestBuilder websocket(String pathOrUrl,
                                            boolean isFullUrl,
                                            boolean isHttps)

GET

protected org.spincast.plugins.httpclient.builders.GetRequestBuilder GET(String path)

Starts an Http Client builder for a GET method. A cookie store is automatically added.

Parameters:

path - the relative path to be appended to the base test URL.

GET

protected org.spincast.plugins.httpclient.builders.GetRequestBuilder GET(String pathOrUrl,
                                                                         boolean isFullUrl)

Starts an Http Client builder for a GET method. A cookie store is automatically added.

Parameters:

pathOrUrl - a relative path or a full URL.

isFullUrl - if the 'pathOrUrl' parameter a full URL? If so, it will be used as is. Otherwise it will be appended to the base test URL.

GET

protected org.spincast.plugins.httpclient.builders.GetRequestBuilder GET(String pathOrUrl,
                                                                         boolean isFullUrl,
                                                                         boolean isHttps)

Starts an Http Client builder for a GET method. A cookie store is automatically added.

Parameters:

pathOrUrl - a relative path or a full URL.

isFullUrl - if the 'pathOrUrl' parameter a full URL? If so, it will be used as is. Otherwise it will be appended to the base test URL.

isHttps - if true, "https:" will be used instead of "http:".

isDisableSllCetificateErrors

protected boolean isDisableSllCetificateErrors()

By default, for the tests, by disable the SSL certificate errors.

POST

protected org.spincast.plugins.httpclient.builders.PostRequestBuilder POST(String path)

Starts an Http Client builder for a POST method. A cookie store is automatically added.

Parameters:

path - the relative path to be appended to the base test URL.

POST

protected org.spincast.plugins.httpclient.builders.PostRequestBuilder POST(String pathOrUrl,
                                                                           boolean isFullUrl)

Starts an Http Client builder for a POST method. A cookie store is automatically added.

Parameters:

pathOrUrl - a relative path or a full URL.

isFullUrl - if the 'pathOrUrl' parameter a full URL? If so, it will be used as is. Otherwise it will be appended to the base test URL.

POST

protected org.spincast.plugins.httpclient.builders.PostRequestBuilder POST(String pathOrUrl,
                                                                           boolean isFullUrl,
                                                                           boolean isHttps)

Starts an Http Client builder for a POST method. A cookie store is automatically added.

Parameters:

pathOrUrl - a relative path or a full URL.

isFullUrl - if the 'pathOrUrl' parameter a full URL? If so, it will be used as is. Otherwise it will be appended to the base test URL.

isHttps - if true, "https:" will be used instead of "http:".

PUT

protected org.spincast.plugins.httpclient.builders.PutRequestBuilder PUT(String path)

Starts an Http Client builder for a PUT method. A cookie store is automatically added.

Parameters:

path - the relative path to be appended to the base test URL.

PUT

protected org.spincast.plugins.httpclient.builders.PutRequestBuilder PUT(String pathOrUrl,
                                                                         boolean isFullUrl)

Starts an Http Client builder for a PUT method. A cookie store is automatically added.

Parameters:

pathOrUrl - a relative path or a full URL.

isFullUrl - if the 'pathOrUrl' parameter a full URL? If so, it will be used as is. Otherwise it will be appended to the base test URL.

PUT

protected org.spincast.plugins.httpclient.builders.PutRequestBuilder PUT(String pathOrUrl,
                                                                         boolean isFullUrl,
                                                                         boolean isHttps)

Starts an Http Client builder for a PUT method. A cookie store is automatically added.

Parameters:

pathOrUrl - a relative path or a full URL.

isFullUrl - if the 'pathOrUrl' parameter a full URL? If so, it will be used as is. Otherwise it will be appended to the base test URL.

isHttps - if true, "https:" will be used instead of "http:".

DELETE

protected org.spincast.plugins.httpclient.builders.DeleteRequestBuilder DELETE(String path)

Starts an Http Client builder for a DELETE method. A cookie store is automatically added.

Parameters:

path - the relative path to be appended to the base test URL.

DELETE

protected org.spincast.plugins.httpclient.builders.DeleteRequestBuilder DELETE(String pathOrUrl,
                                                                               boolean isFullUrl)

Starts an Http Client builder for a DELETE method. A cookie store is automatically added.

Parameters:

pathOrUrl - a relative path or a full URL.

isFullUrl - if the 'pathOrUrl' parameter a full URL? If so, it will be used as is. Otherwise it will be appended to the base test URL.

DELETE

protected org.spincast.plugins.httpclient.builders.DeleteRequestBuilder DELETE(String pathOrUrl,
                                                                               boolean isFullUrl,
                                                                               boolean isHttps)

Starts an Http Client builder for a DELETE method. A cookie store is automatically added.

Parameters:

pathOrUrl - a relative path or a full URL.

isFullUrl - if the 'pathOrUrl' parameter a full URL? If so, it will be used as is. Otherwise it will be appended to the base test URL.

isHttps - if true, "https:" will be used instead of "http:".

OPTIONS

protected org.spincast.plugins.httpclient.builders.OptionsRequestBuilder OPTIONS(String path)

Starts an Http Client builder for a OPTIONS method. A cookie store is automatically added.

Parameters:

path - the relative path to be appended to the base test URL.

OPTIONS

protected org.spincast.plugins.httpclient.builders.OptionsRequestBuilder OPTIONS(String pathOrUrl,
                                                                                 boolean isFullUrl)

Starts an Http Client builder for a OPTIONS method. A cookie store is automatically added.

Parameters:

pathOrUrl - a relative path or a full URL.

isFullUrl - if the 'pathOrUrl' parameter a full URL? If so, it will be used as is. Otherwise it will be appended to the base test URL.

OPTIONS

protected org.spincast.plugins.httpclient.builders.OptionsRequestBuilder OPTIONS(String pathOrUrl,
                                                                                 boolean isFullUrl,
                                                                                 boolean isHttps)

Starts an Http Client builder for a OPTIONS method. A cookie store is automatically added.

Parameters:

pathOrUrl - a relative path or a full URL.

isFullUrl - if the 'pathOrUrl' parameter a full URL? If so, it will be used as is. Otherwise it will be appended to the base test URL.

isHttps - if true, "https:" will be used instead of "http:".

TRACE

protected org.spincast.plugins.httpclient.builders.TraceRequestBuilder TRACE(String path)

Starts an Http Client builder for a TRACE method. A cookie store is automatically added.

Parameters:

path - the relative path to be appended to the base test URL.

TRACE

protected org.spincast.plugins.httpclient.builders.TraceRequestBuilder TRACE(String pathOrUrl,
                                                                             boolean isFullUrl)

Starts an Http Client builder for a TRACE method. A cookie store is automatically added.

Parameters:

pathOrUrl - a relative path or a full URL.

isFullUrl - if the 'pathOrUrl' parameter a full URL? If so, it will be used as is. Otherwise it will be appended to the base test URL.

TRACE

protected org.spincast.plugins.httpclient.builders.TraceRequestBuilder TRACE(String pathOrUrl,
                                                                             boolean isFullUrl,
                                                                             boolean isHttps)

Starts an Http Client builder for a TRACE method. A cookie store is automatically added.

Parameters:

pathOrUrl - a relative path or a full URL.

isFullUrl - if the 'pathOrUrl' parameter a full URL? If so, it will be used as is. Otherwise it will be appended to the base test URL.

isHttps - if true, "https:" will be used instead of "http:".

CONNECT

protected org.spincast.plugins.httpclient.builders.ConnectRequestBuilder CONNECT(String path)

Starts an Http Client builder for a CONNECT method. A cookie store is automatically added.

Parameters:

path - the relative path to be appended to the base test URL.

CONNECT

protected org.spincast.plugins.httpclient.builders.ConnectRequestBuilder CONNECT(String pathOrUrl,
                                                                                 boolean isFullUrl)

Starts an Http Client builder for a CONNECT method. A cookie store is automatically added.

Parameters:

pathOrUrl - a relative path or a full URL.

isFullUrl - if the 'pathOrUrl' parameter a full URL? If so, it will be used as is. Otherwise it will be appended to the base test URL.

CONNECT

protected org.spincast.plugins.httpclient.builders.ConnectRequestBuilder CONNECT(String pathOrUrl,
                                                                                 boolean isFullUrl,
                                                                                 boolean isHttps)

Starts an Http Client builder for a CONNECT method. A cookie store is automatically added.

Parameters:

pathOrUrl - a relative path or a full URL.

isFullUrl - if the 'pathOrUrl' parameter a full URL? If so, it will be used as is. Otherwise it will be appended to the base test URL.

isHttps - if true, "https:" will be used instead of "http:".

PATCH

protected org.spincast.plugins.httpclient.builders.PatchRequestBuilder PATCH(String path)

Starts an Http Client builder for a PATCH method. A cookie store is automatically added.

Parameters:

path - the relative path to be appended to the base test URL.

PATCH

protected org.spincast.plugins.httpclient.builders.PatchRequestBuilder PATCH(String pathOrUrl,
                                                                             boolean isFullUrl)

Starts an Http Client builder for a PATCH method. A cookie store is automatically added.

Parameters:

pathOrUrl - a relative path or a full URL.

isFullUrl - if the 'pathOrUrl' parameter a full URL? If so, it will be used as is. Otherwise it will be appended to the base test URL.

PATCH

protected org.spincast.plugins.httpclient.builders.PatchRequestBuilder PATCH(String pathOrUrl,
                                                                             boolean isFullUrl,
                                                                             boolean isHttps)

Starts an Http Client builder for a PATCH method. A cookie store is automatically added.

Parameters:

pathOrUrl - a relative path or a full URL.

isFullUrl - if the 'pathOrUrl' parameter a full URL? If so, it will be used as is. Otherwise it will be appended to the base test URL.

isHttps - if true, "https:" will be used instead of "http:".

HEAD

protected org.spincast.plugins.httpclient.builders.HeadRequestBuilder HEAD(String path)

Starts an Http Client builder for a HEAD method. A cookie store is automatically added.

Parameters:

path - the relative path to be appended to the base test URL.

HEAD

protected org.spincast.plugins.httpclient.builders.HeadRequestBuilder HEAD(String pathOrUrl,
                                                                           boolean isFullUrl)

Starts an Http Client builder for a HEAD method. A cookie store is automatically added.

Parameters:

pathOrUrl - a relative path or a full URL.

isFullUrl - if the 'pathOrUrl' parameter a full URL? If so, it will be used as is. Otherwise it will be appended to the base test URL.

HEAD

protected org.spincast.plugins.httpclient.builders.HeadRequestBuilder HEAD(String pathOrUrl,
                                                                           boolean isFullUrl,
                                                                           boolean isHttps)

Starts an Http Client builder for a HEAD method. A cookie store is automatically added.

Parameters:

pathOrUrl - a relative path or a full URL.

isFullUrl - if the 'pathOrUrl' parameter a full URL? If so, it will be used as is. Otherwise it will be appended to the base test URL.

isHttps - if true, "https:" will be used instead of "http:".

formatDate

protected String formatDate(Date date)

Format a date so it can be used in a HTTP header.

parseDate

protected Date parseDate(String dateHeaderValue)

Parse a date from a HTTP header to a Date object.

getAppTestingConfigs

protected abstract AppTestingConfigs getAppTestingConfigs()

We force test classes to provide information about the required testing configurations.

The bindings for those components will be automatically created.

Returns:

the testing configs informations or null to disable this process (you will then have to add the required config bindings by yourself).

startApp

protected abstract void startApp()

Starts the application.

In this method, you should call your application main() method.

Returns a boolean to tell if the class calling the Spincast bootstrapper, commonly named "App", should be added to the Guice context or not.

Returning true is common if your test class runs integration tests, since it is probably the calling class that starts the HTTP server. Return false if you don't need any server to be started, but still want the full application Guice context to be created (used in general for unit tests).