Class ContextMock
-
- All Implemented Interfaces:
-
io.javalin.router.EndpointExecutor
@ApiStatus.Experimental() public final class ContextMock implements EndpointExecutorA ContextMock is an in-memory Context instance builder.
Although this implementation can be used in different ways, the most common use case is to build a Context instance within the test scope. We strongly recommend using ContextMock over any reflection based mocking library, as it's way closer to the real implementation.
By default, the request state represents an incoming connection from localhost to the root path. Javalin configuration, request and response states can be modified by using the ContextMockConfigurer interface. Once the state is prepared, you can build a Context instance in two ways:
ContextMock.build with Endpoint instance: to simulate a real request/response cycle (recommended)
ContextMock.execute: to execute non-endpoint related code that requires a Context instance
See docs for more information: https://javalin.io/documentation#context-mock
-
-
Method Summary
Modifier and Type Method Description final ContextMockwithMockConfig(ContextMockConfigurer cfg)Register additional ContextMockConfigurers. final EndpointExecutorbuild(String uri, Body body, ContextMockConfigurer configurer)Build an EndpointExecutor with a uri, Body or/and a configurer. final EndpointExecutorbuild(String uri, Body body)Build an EndpointExecutor with a uri, Body or/and a configurer. final EndpointExecutorbuild(String uri)Build an EndpointExecutor with a uri, Body or/and a configurer. final EndpointExecutorbuild()Build an EndpointExecutor with a uri, Body or/and a configurer. final EndpointExecutorbuild(Body body, ContextMockConfigurer configurer)Build an EndpointExecutor with a Body. final Contextexecute(Consumer<Context> body)Execute a non-endpoint related code that requires Context instance Contextexecute(Endpoint endpoint)Execute this ContextMock without any additional parameters final static ContextMockcreate(ContextMockConfigurer configurer)final static ContextMockcreate()-
-
Method Detail
-
withMockConfig
final ContextMock withMockConfig(ContextMockConfigurer cfg)
Register additional ContextMockConfigurers. Each ContextMock can have multiple configurers, which are applied in registration order.
-
build
@JvmOverloads() final EndpointExecutor build(String uri, Body body, ContextMockConfigurer configurer)
Build an EndpointExecutor with a uri, Body or/and a configurer.
-
build
@JvmOverloads() final EndpointExecutor build(String uri, Body body)
Build an EndpointExecutor with a uri, Body or/and a configurer.
-
build
@JvmOverloads() final EndpointExecutor build(String uri)
Build an EndpointExecutor with a uri, Body or/and a configurer.
-
build
@JvmOverloads() final EndpointExecutor build()
Build an EndpointExecutor with a uri, Body or/and a configurer.
-
build
final EndpointExecutor build(Body body, ContextMockConfigurer configurer)
Build an EndpointExecutor with a Body.
-
execute
final Context execute(Consumer<Context> body)
Execute a non-endpoint related code that requires Context instance
-
execute
Context execute(Endpoint endpoint)
Execute this ContextMock without any additional parameters
-
create
@JvmOverloads() final static ContextMock create(ContextMockConfigurer configurer)
-
create
@JvmOverloads() final static ContextMock create()
-
-
-
-