com.github.tashoyan.httpspy

Class SequencePlan

java.lang.Object

com.github.tashoyan.httpspy.SequencePlan

All Implemented Interfaces:

TestPlan

@NotThreadSafe
public class SequencePlan
extends Object
implements TestPlan

Test plan to check the sequence in which system under test executes requests.

This test plan expects the system under test to send requests in a predefined sequence. If the system under test sends actual requests in a different sequence, then verification step indicates a failure.

Method getResponse(com.github.tashoyan.httpspy.HttpRequest) returns responses in the sequence defined during the test plan build. The system under test may send more actual requests, than the plan expects. In this case, method getResponse(com.github.tashoyan.httpspy.HttpRequest) returns a special response with Internal server error status code for all extra actual requests. Method createMissingResponse(com.github.tashoyan.httpspy.HttpRequest) can be overridden to change this behavior. Finally, verification reports a failure.

Sequence check makes sense only when all requests are serviced by a single thread in HTTP Spy. Therefore, SequencePlan can be used only with the number of servicing threads set to 1.

Concurrency notes. As far as SequencePlan can be used only with one servicing thread, it is not thread safe.

Constructor Summary

Constructors

Constructor and Description
SequencePlan(List<RequestExpectation> requestExpectations, List<HttpResponse> responses) Creates new instance of the test plan.

Method Summary

Modifier and Type	Method and Description
protected HttpResponse	createMissingResponse(HttpRequest actualRequest) Creates a special response when the number of actual requests exceeds the number of request expectations.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

SequencePlan

public SequencePlan(List<RequestExpectation> requestExpectations,
                    List<HttpResponse> responses)

Creates new instance of the test plan.

Parameters:

requestExpectations - The list of request expectations.

responses - The list of responses on actual requests.

Throws:

NullPointerException - requestExpectations is null, responses is null.

IllegalArgumentException - requestExpectations is empty, responses is empty, requestExpectations.size != responses.size.

Method Detail

getResponse

public HttpResponse getResponse(HttpRequest actualRequest)

Description copied from interface: TestPlan

Gets a response for an actual request.

Specified by:

getResponse in interface TestPlan

Parameters:

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

Returns:

Response on the request. Never returns null.

createMissingResponse

protected HttpResponse createMissingResponse(HttpRequest actualRequest)

Creates a special response when the number of actual requests exceeds the number of request expectations.

This implementation responds with Internal server error status code.

Parameters:

actualRequest - Actual request.

Returns:

Response. Never returns null.

Throws:

NullPointerException - actualRequest is null.

verify

public void verify()

Description copied from interface: TestPlan

Verifies actual requests against request expectations.

Specified by:

verify in interface TestPlan

isMultithreaded

public final boolean isMultithreaded()

Description copied from interface: TestPlan

Checks if this test plan supports multiple service threads.

Specified by:

isMultithreaded in interface TestPlan

Returns:

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