org.spincast.defaults.testing

Class NoAppWebsocketTestingBase

java.lang.Object

org.spincast.testing.core.SpincastTestBase

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

org.spincast.defaults.testing.AppBasedWebsocketTestingBase<DefaultRequestContext,DefaultWebsocketContext>

org.spincast.defaults.testing.NoAppWebsocketTestingBase

All Implemented Interfaces:

BeforeAfterClassMethodsProvider, RepeatedClassAfterMethodProvider, TestFailureListener

public abstract class NoAppWebsocketTestingBase
extends AppBasedWebsocketTestingBase<DefaultRequestContext,DefaultWebsocketContext>

Base class for WebSocket testing without an App.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	logger

Fields inherited from class org.spincast.defaults.testing.AppBasedWebsocketTestingBase

spincastHttpClientUtils

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

spincastConfig

Constructor Summary

Constructors

Constructor and Description
NoAppWebsocketTestingBase()

Method Summary

Modifier and Type	Method and Description
void	beforeClass() Called before the tests of the class are ran.
protected void	beforeStartServer() Allows some initialization to be run once the Guice context is created, but before the Server is started.
void	beforeTest() Ran before every test.
protected void	clearRoutes()
protected AppTestingConfigs	getAppTestingConfigs() We force test classes to provide information about the required testing configurations.
protected String[]	getMainArgs()
protected Class<? extends SpincastConfig>	getTestingConfigImplClass()
protected boolean	removeSpincastRoutesToo() Should the default Spincast Routes be removed too? Or only the custom ones?
protected void	startApp() Starts the application.
protected void	startServer()

Methods inherited from class org.spincast.defaults.testing.AppBasedWebsocketTestingBase

closeAllWebsocketEndpoints, getExtraOverridingModule2, getExtraOverridingModule3, getSecSocketKey, getServerPingIntervalSeconds, getSpincastHttpClientUtils, getSpincastUndertowConfigImplementation, getWebsocketTestExpectedWebsocketV13AcceptHeaderValue, validateIsNotWebsocketUpgradeHttpResponse, validateIsWebsocketUpgradeHttpResponse, websocket

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

afterClass, CONNECT, CONNECT, CONNECT, createInjector, createTestUrl, createTestUrl, createTestUrl, DELETE, DELETE, DELETE, formatDate, GET, GET, GET, getCookieFactory, getExtraOverridingModule, getExtraPlugins, getExtraPlugins2, getHttpClient, getRouter, getServer, getTestingConfigImplementationClass, HEAD, HEAD, HEAD, isDisableBindCurrentClass, isDisableSllCetificateErrors, OPTIONS, OPTIONS, OPTIONS, parseDate, PATCH, PATCH, PATCH, POST, POST, POST, PUT, PUT, PUT, stopServer, TRACE, TRACE, TRACE, validateCreatedInjector, websocket, websocket

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

addExtraSystemProperties, afterClassLoops, afterTest, beforeClassException, 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

Field Detail

logger

protected final org.slf4j.Logger logger

Constructor Detail

NoAppWebsocketTestingBase

public NoAppWebsocketTestingBase()

Method Detail

getAppTestingConfigs

protected final AppTestingConfigs getAppTestingConfigs()

Description copied from class: AppBasedTestingBase

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

The bindings for those components will be automatically created.

Specified by:

getAppTestingConfigs in class AppBasedTestingBase<DefaultRequestContext,DefaultWebsocketContext>

Returns:

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

getTestingConfigImplClass

protected Class<? extends SpincastConfig> getTestingConfigImplClass()

startApp

protected final void startApp()

Description copied from class: AppBasedTestingBase

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).

Specified by:

startApp in class AppBasedTestingBase<DefaultRequestContext,DefaultWebsocketContext>

getMainArgs

protected String[] getMainArgs()

beforeClass

public void beforeClass()

Description copied from interface: BeforeAfterClassMethodsProvider

Called before the tests of the class are ran.

Specified by:

beforeClass in interface BeforeAfterClassMethodsProvider

Overrides:

beforeClass in class SpincastTestBase

startServer

protected void startServer()

beforeStartServer

protected void beforeStartServer()

Allows some initialization to be run once the Guice context is created, but before the Server is started.

beforeTest

public void beforeTest()

Ran before every test.

Overrides:

beforeTest in class AppBasedWebsocketTestingBase<DefaultRequestContext,DefaultWebsocketContext>

clearRoutes

protected void clearRoutes()

removeSpincastRoutesToo

protected boolean removeSpincastRoutesToo()

Should the default Spincast Routes be removed too? Or only the custom ones?