com.github.tashoyan.httpspy

Interface TestPlan

All Known Implementing Classes:

SequencePlan, StubPlan

@ThreadSafe
public interface TestPlan

Test plan for HTTP Spy.

A test plan provides the following functions:

• Provide responses for actual requests coming to HttpSpy from the system under test
• Provide verification procedure to assert that actual requests match request expectations.

Concurrency notes. Test plan instance can be accessed from multiple threads serving requests inside HttpSpy. All servicing threads invoke getResponse(com.github.tashoyan.httpspy.HttpRequest). Finally, the main test thread invokes verify(). Therefore, thread safety requirements are:

1. Method getResponse(com.github.tashoyan.httpspy.HttpRequest) provides a safe way to concurrently get responses from many threads.
2. Method verify() may have no special mechanism to ensure thread safety. However it should be invoked only after (be means of happens-before relationship) all servicing threads are done their job.

An exception is a test plan that by definition can be used with single servicing thread only. Such test plan is not required to be thread safe.

Method Summary

Modifier and Type	Method and Description
HttpResponse	getResponse(HttpRequest actualRequest) Gets a response for an actual request.
boolean	isMultithreaded() Checks if this test plan supports multiple service threads.
void	verify() Verifies actual requests against request expectations.

Method Detail

getResponse

HttpResponse getResponse(HttpRequest actualRequest)

Gets a response for an actual request.

Parameters:

actualRequest - A request that has been received from the system under test.

Returns:

Response on the request. Never returns null.

Throws:

NullPointerException - actualRequest is null.

verify

void verify()

Verifies actual requests against request expectations.

Throws:

AssertionError - Actual requests do not match request expectations.

isMultithreaded

boolean isMultithreaded()

Checks if this test plan supports multiple service threads.

Returns:

true if multiple service threads can work with this test plan.