com.github.restdriver.clientdriver

Class ClientDriverRule

java.lang.Object

com.github.restdriver.clientdriver.ClientDriverRule

All Implemented Interfaces:

org.junit.rules.TestRule

public final class ClientDriverRule
extends Object
implements org.junit.rules.TestRule

The ClientDriverRule allows a user to specify expectations on the HTTP requests that are made against it.

Constructor Summary

Constructors

Constructor and Description
ClientDriverRule() Creates a new rule with a driver running on a free port.
ClientDriverRule(int port) Creates a new rule with a driver running on the specified port.

Method Summary

Methods

Modifier and Type	Method and Description
ClientDriverExpectation	addExpectation(ClientDriverRequest request, ClientDriverResponse response) Adds an expectation on the ClientDriver to expect the given request and response.
org.junit.runners.model.Statement	apply(org.junit.runners.model.Statement base, org.junit.runner.Description description)
ClientDriverRule	expectResponsesWithin(int timeout, TimeUnit units) When ClientDriver comes to check for unmatched expectations, it will retry for the specified length of time before considering the expectation unmatched.
String	getBaseUrl() The base URL of the underlying ClientDriver.
int	getPort() The port that the underlying ClientDriver is listening too.
void	whenCompleted(ClientDriverCompletedListener listener) The given listener will be registered with the Client Driver and executes once execution has completed.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientDriverRule

public ClientDriverRule()

Creates a new rule with a driver running on a free port.

ClientDriverRule

public ClientDriverRule(int port)

Creates a new rule with a driver running on the specified port.

Parameters:

port - The port on which the driver should listen

Method Detail

apply

public org.junit.runners.model.Statement apply(org.junit.runners.model.Statement base,
                                      org.junit.runner.Description description)

Specified by:

apply in interface org.junit.rules.TestRule

addExpectation

public ClientDriverExpectation addExpectation(ClientDriverRequest request,
                                     ClientDriverResponse response)

Adds an expectation on the ClientDriver to expect the given request and response.

Parameters:

request - The request to expect

response - The response to expect

Returns:

The newly added expectation.

getBaseUrl

public String getBaseUrl()

The base URL of the underlying ClientDriver.

Returns:

The base URL String There is no trailing slash on this.

getPort

public int getPort()

The port that the underlying ClientDriver is listening too.

Returns:

the listening port.

whenCompleted

public void whenCompleted(ClientDriverCompletedListener listener)

The given listener will be registered with the Client Driver and executes once execution has completed.

Parameters:

listener - The listener

expectResponsesWithin

public ClientDriverRule expectResponsesWithin(int timeout,
                                     TimeUnit units)

When ClientDriver comes to check for unmatched expectations, it will retry for the specified length of time before considering the expectation unmatched.

Has the effect of calling ClientDriverResponse.within(long, java.util.concurrent.TimeUnit) against each ClientDriverResponse added as an expectation. (Note that a timeout set explicitly against the ClientDriverResponse overrides the value set here.)

Parameters:

timeout - The timeout expressed in the specified units.

units - The TimeUnit that the timeout is expressed in.