public.javadoc.org.spincast.testing.defaults.NoAppWebsocketTestingBase.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spincast-website Show documentation

Source code for the https://www.spincast.org website.

There is a newer version: 2.2.0







NoAppWebsocketTestingBase (org.spincast:spincast-framework 1.2.0 API)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help

 Spincast Framework Javadoc



Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








org.spincast.testing.defaults
Class NoAppWebsocketTestingBase



java.lang.Object


org.spincast.testing.core.SpincastTestBase


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


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


org.spincast.testing.defaults.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.testing.defaults.AppBasedWebsocketTestingBase
spincastHttpClientUtils





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








Constructor Summary

Constructors 

Constructor and Description


NoAppWebsocketTestingBase() 









Method Summary

All Methods Instance Methods Concrete Methods 

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
callAppMainMethod()
Starts the application.



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
startServer() 






Methods inherited from class org.spincast.testing.defaults.AppBasedWebsocketTestingBase
closeAllWebsocketEndpoints, getExtraOverridingModule, getExtraOverridingModule3, getSecSocketKey, getServerPingIntervalSeconds, getSpincastHttpClientUtils, getSpincastUndertowConfigImplementation, getWebsocketTestExpectedWebsocketV13AcceptHeaderValue, validateIsNotWebsocketUpgradeHttpResponse, validateIsWebsocketUpgradeHttpResponse, websocket





Methods inherited from class org.spincast.testing.core.AppBasedTestingBase
afterClass, clearPreviousResponseCookies, CONNECT, CONNECT, CONNECT, createInjector, createTestUrl, createTestUrl, createTestUrl, createTestUrl, DELETE, DELETE, DELETE, formatDate, GET, GET, GET, getCookieFactory, getExtraExactBindingsToRemoveBeforePlugins, getExtraPlugins, getGuiceTweakerExtraOverridingModule, getGuiceTweakerExtraPlugins, getHttpClient, getPreviousResponseCookie, getPreviousResponseCookies, getRouter, getServer, getTestingConfigImplementationClass, HEAD, HEAD, HEAD, isDisableBindCurrentClass, isDisableSllCetificateErrors, isIgnoreMethodsAnnotatedWithInjectDuringConfigurationsTweaking, isSetSecureFalseOnCookiesFromBag, OPTIONS, OPTIONS, OPTIONS, parseDate, PATCH, PATCH, PATCH, POST, POST, POST, PUT, PUT, PUT, saveResponseCookies, stopServer, TRACE, TRACE, TRACE, tweakConfigurations, validateCreatedInjector, websocket, websocket





Methods inherited from class org.spincast.testing.core.SpincastTestBase
addExtraSystemProperties, afterClassLoops, afterTest, beforeClassException, createGuiceTweaker, createTestingDir, createTestingFilePath, createTestingFilePath, deleteTestingWritableTempDir, getExtraSystemProperties, getGuiceTweakerFromThreadLocal, getInjector, getSpincastConfig, getTestingWritableTempDir, 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()







callAppMainMethod
protected final void callAppMainMethod()
Description copied from class: AppBasedTestingBase
Starts the application.
 
 In this method, you should call your
 application main() method. 
 

 There is no need to start the 
 Server here, since the target
 application is supposed to do it by itself,
 in general in an "@Inject init()" 
 method!

Specified by:
callAppMainMethod 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 AppBasedTestingBase<DefaultRequestContext,DefaultWebsocketContext>








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?













Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help

 Spincast Framework Javadoc



Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2019. All rights reserved.

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`	`callAppMainMethod()` Starts the application.
`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`	`startServer()`