public class MockServerClient extends AbstractClient implements Closeable
Modifier and Type | Class and Description |
---|---|
static class |
MockServerClient.TYPE |
contextPath, expectationSerializer, host, httpRequestSerializer, logger, nettyHttpClient, port, verificationSequenceSerializer, verificationSerializer
Constructor and Description |
---|
MockServerClient(String host,
int port)
Start the client communicating to a MockServer at the specified host and port
for example:
|
MockServerClient(String host,
int port,
String contextPath)
Start the client communicating to a MockServer at the specified host and port
and contextPath for example:
MockServerClient mockServerClient = new MockServerClient("localhost", 1080, "/mockserver");
|
Modifier and Type | Method and Description |
---|---|
MockServerClient |
clear(HttpRequest httpRequest)
Clear all expectations and logs that match the http
|
MockServerClient |
clear(HttpRequest httpRequest,
MockServerClient.TYPE type)
Clear expectations, logs or both that match the http
|
void |
close() |
MockServerClient |
dumpToLog()
Pretty-print the json for all expectations to the log.
|
MockServerClient |
dumpToLog(HttpRequest httpRequest)
Pretty-print the json for all expectations that match the request to the log.
|
boolean |
isRunning()
Returns whether MockServer is running
|
boolean |
isRunning(int attempts,
long timeout,
TimeUnit timeUnit)
Returns whether MockServer is running, by polling the MockServer a configurable amount of times
|
MockServerClient |
reset()
Reset MockServer by clearing all expectations
|
Expectation[] |
retrieveExistingExpectations(HttpRequest httpRequest)
Retrieve the already setup expectations match the httpRequest parameter, use null for the parameter to retrieve all expectations
|
HttpRequest[] |
retrieveRecordedRequests(HttpRequest httpRequest)
Retrieve the recorded requests that match the httpRequest parameter, use null for the parameter to retrieve all requests
|
MockServerClient |
stop()
Stop MockServer gracefully (only support for Netty and Vert.X versions, not supported for WAR version)
|
MockServerClient |
stop(boolean ignoreFailure) |
MockServerClient |
verify(HttpRequest... httpRequests)
Verify a list of requests have been sent in the order specified for example:
mockServerClient
.verify(
request()
.withPath("/first_request")
.withBody("some_request_body"),
request()
.withPath("/second_request")
.withBody("some_request_body")
);
|
MockServerClient |
verify(HttpRequest httpRequest,
VerificationTimes times)
Verify a request has been sent for example:
mockServerClient
.verify(
request()
.withPath("/some_path")
.withBody("some_request_body"),
VerificationTimes.exactly(3)
);
VerificationTimes supports multiple static factory methods:
once() - verify the request was only received once
exactly(n) - verify the request was only received exactly n times
atLeast(n) - verify the request was only received at least n times
|
MockServerClient |
verifyZeroInteractions()
Verify no requests have been have been sent.
|
ForwardChainExpectation |
when(HttpRequest httpRequest)
Specify an unlimited expectation that will respond regardless of the number of matching http
for example:
mockServerClient
.when(
request()
.withPath("/some_path")
.withBody("some_request_body")
)
.respond(
response()
.withBody("some_response_body")
.withHeaders(
new Header("responseName", "responseValue")
)
);
|
ForwardChainExpectation |
when(HttpRequest httpRequest,
Times times)
Specify an limited expectation that will respond a specified number of times when the http is matched
for example:
mockServerClient
.when(
new HttpRequest()
.withPath("/some_path")
.withBody("some_request_body"),
Times.exactly(5)
)
.respond(
new HttpResponse()
.withBody("some_response_body")
.withHeaders(
new Header("responseName", "responseValue")
)
);
|
ForwardChainExpectation |
when(HttpRequest httpRequest,
Times times,
TimeToLive timeToLive)
Specify an limited expectation that will respond a specified number of times when the http is matched
for example:
mockServerClient
.when(
new HttpRequest()
.withPath("/some_path")
.withBody("some_request_body"),
Times.exactly(5),
TimeToLive.exactly(TimeUnit.SECONDS, 120),
)
.respond(
new HttpResponse()
.withBody("some_response_body")
.withHeaders(
new Header("responseName", "responseValue")
)
);
|
calculatePath, contextPath, formatErrorMessage, remoteAddress, sendRequest
public MockServerClient(String host, int port)
MockServerClient mockServerClient = new MockServerClient("localhost", 1080);
host
- the host for the MockServer to communicate withport
- the port for the MockServer to communicate withpublic MockServerClient(String host, int port, String contextPath)
host
- the host for the MockServer to communicate withport
- the port for the MockServer to communicate withcontextPath
- the context path that the MockServer war is deployed topublic ForwardChainExpectation when(HttpRequest httpRequest)
httpRequest
- the http request that must be matched for this expectation to respondpublic ForwardChainExpectation when(HttpRequest httpRequest, Times times)
httpRequest
- the http request that must be matched for this expectation to respondtimes
- the number of times to respond when this http is matchedpublic ForwardChainExpectation when(HttpRequest httpRequest, Times times, TimeToLive timeToLive)
httpRequest
- the http request that must be matched for this expectation to respondtimes
- the number of times to respond when this http is matchedtimeToLive
- the length of time from when the server receives the expectation that the expectation should be activepublic MockServerClient dumpToLog()
public MockServerClient dumpToLog(HttpRequest httpRequest)
httpRequest
- the http request that is matched against when deciding what to log if null all requests are loggedpublic boolean isRunning()
public boolean isRunning(int attempts, long timeout, TimeUnit timeUnit)
public MockServerClient stop()
public MockServerClient stop(boolean ignoreFailure)
public void close() throws IOException
close
in interface Closeable
close
in interface AutoCloseable
IOException
public MockServerClient reset()
public MockServerClient clear(HttpRequest httpRequest)
httpRequest
- the http request that is matched against when deciding whether to clear each expectation if null all expectations are clearedpublic MockServerClient clear(HttpRequest httpRequest, MockServerClient.TYPE type)
httpRequest
- the http request that is matched against when deciding whether to clear each expectation if null all expectations are clearedtype
- the type to clear, EXPECTATION, LOG or BOTHpublic MockServerClient verify(HttpRequest... httpRequests) throws AssertionError
httpRequests
- the http requests that must be matched for this verification to passAssertionError
- if the request has not been foundpublic MockServerClient verify(HttpRequest httpRequest, VerificationTimes times) throws AssertionError
httpRequest
- the http request that must be matched for this verification to passtimes
- the number of times this request must be matchedAssertionError
- if the request has not been foundpublic MockServerClient verifyZeroInteractions() throws AssertionError
AssertionError
- if any request has been foundpublic HttpRequest[] retrieveRecordedRequests(HttpRequest httpRequest)
httpRequest
- the http request that is matched against when deciding whether to return each request, use null for the parameter to retrieve for all requestspublic Expectation[] retrieveExistingExpectations(HttpRequest httpRequest)
httpRequest
- the http request that is matched against when deciding whether to return each expectation, use null for the parameter to retrieve for all requestsCopyright © 2018. All rights reserved.