uk.ac.sheffield.vtts.model

Class TestStep

java.lang.Object

uk.ac.sheffield.vtts.model.Element

uk.ac.sheffield.vtts.model.Named

uk.ac.sheffield.vtts.model.Event

uk.ac.sheffield.vtts.model.TestStep

public class TestStep
extends Event

TestStep represents a single executable test step within a test sequence. Each TestStep represents an instruction to invoke a single Operation in the Protocol of a Service, with particular Input values chosen to trigger a particular Scenario. One TestStep always represents the initial setup or creation of the Service. A TestStep is named according to the Scenario it attempts to trigger and its response is either the response of that Scenario, or "ignore[...]", indicating a refusal. A TestStep is labelled with the name of the State reached after execution. A TestStep may be marked for verification, indicating that any grounding should generate assertions to verify the response, the reached State and any outputs.

Version:

Broker@Cloud 1.0

Author:

Anthony J H Simons

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	initialName The standard name of the initial transition.

Fields inherited from class uk.ac.sheffield.vtts.model.Named

name

Constructor Summary

Constructors

Constructor and Description
TestStep() Creates a default TestStep.
TestStep(java.lang.String name) Creates a named TestStep.

Method Summary

Methods

Modifier and Type	Method and Description
TestStep	addOperation(Operation operation) Adds the Operation exercised by this TestStep.
Operation	getOperation() Returns the Operation exercised by this TestStep.
java.lang.String	getState() Returns the name of the expected target State.
java.lang.Boolean	getVerify() Returns whether this TestStep step is verified, as a Boolean object.
boolean	isFailure() Reports whether this TestStep represents an expected failure case.
boolean	isInitial() Reports whether this TestStep is the initial (empty) TestStep.
boolean	isRefused() Report whether this TestStep was refused.
boolean	isVerify() Reports whether this TestStep step is verified.
void	receive(Grounding grounding) Receive a Grounding generator for grounding this TestStep.
TestStep	recordInputs(Operation attempted) Records a snapshot of the Input bindings of an Operation.
TestStep	recordRefusal() Rename this TestStep to indicate that it was refused.
TestStep	recordResults(Operation executed) Records a snapshot of the Output or Failure bindings of an Operation.
TestStep	setName(java.lang.String name) Sets the name of this TestStep.
TestStep	setState(java.lang.String state) Sets the name of the expected target State.
TestStep	setVerify(boolean value) Sets whether this TestStep step should be verified.

Methods inherited from class uk.ac.sheffield.vtts.model.Event

requestName, responseName, validate

Methods inherited from class uk.ac.sheffield.vtts.model.Named

equals, getName, hashCode, setName, toString

Methods inherited from class uk.ac.sheffield.vtts.model.Element

safeEquals, safeHashCode, semanticError

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

initialName

public static final java.lang.String initialName

The standard name of the initial transition.

See Also:

Constant Field Values

Constructor Detail

TestStep

public TestStep()

Creates a default TestStep.

TestStep

public TestStep(java.lang.String name)

Creates a named TestStep.

Parameters:

name - the name of this TestStep.

Method Detail

setName

public TestStep setName(java.lang.String name)

Sets the name of this TestStep. Like the name of an Event, the name of this TestStep must be in the format: "request/response". Also, sets the name of this TestStep's Operation to be equal to "request".

Overrides:

setName in class Named

Parameters:

name - the name of this TestStep.

Returns:

this Named element.

addOperation

public TestStep addOperation(Operation operation)

Adds the Operation exercised by this TestStep.

Parameters:

operation - the Operation to add.

Returns:

this TestStep.

getOperation

public Operation getOperation()

Returns the Operation exercised by this TestStep.

Returns:

the Operation.

setState

public TestStep setState(java.lang.String state)

Sets the name of the expected target State.

Parameters:

state - the name of the target State.

Returns:

this TestStep.

getState

public java.lang.String getState()

Returns the name of the expected target State.

Returns:

the name of the target State.

setVerify

public TestStep setVerify(boolean value)

Sets whether this TestStep step should be verified. Setting true means that this TestStep step should be verified in the grounding by an assertion that checks: whether the step was accepted or ignored; what the state was after execution; and for accepted steps, whether the outputs were correct. Setting false means that this TestStep step is part of the setup in a longer TestSequence.

Parameters:

value - true or false.

Returns:

this TestStep.

isVerify

public boolean isVerify()

Reports whether this TestStep step is verified.

Returns:

true if this TestStep step is verified.

getVerify

public java.lang.Boolean getVerify()

Returns whether this TestStep step is verified, as a Boolean object.

Returns:

true, or null.

recordInputs

public TestStep recordInputs(Operation attempted)

Records a snapshot of the Input bindings of an Operation. After the Operation has just been attempted, takes a local snapshot of its Input bindings.

Parameters:

attempted - the Operation that was just attempted.

Returns:

this TestStep.

recordResults

public TestStep recordResults(Operation executed)

Records a snapshot of the Output or Failure bindings of an Operation. After the Operation has just been executed, takes a local snapshot of its Output bindings and any Failure bindings.

Parameters:

executed - the Operation that was just executed.

Returns:

this TestStep.

recordRefusal

public TestStep recordRefusal()

Rename this TestStep to indicate that it was refused. Turns the name "request/response" into the name "request/ignore[response]". While the main response is now "ignore", this is subscripted by the original response code, in order to distinguish this ignore-response from others. Without this subscripting, different ignore-responses could accidentally be aliased during TestSequence prefix-merging.

Returns:

this TestStep.

isRefused

public boolean isRefused()

Report whether this TestStep was refused.

Returns:

true, if this TestStep was refused.

isInitial

public boolean isInitial()

Reports whether this TestStep is the initial (empty) TestStep. Checks whether the name of this TestStep is the name of the standard initial transition. This test is used during grounding.

Returns:

true, if this is the initial TestStep.

isFailure

public boolean isFailure()

Reports whether this TestStep represents an expected failure case. Checks whether this TestStep has an Operation that binds a Failure output.

Returns:

true, if this is an expected failure case.

receive

public void receive(Grounding grounding)

Receive a Grounding generator for grounding this TestStep. The actual generator is any class that implements the Grounding interface. Asks the grounding reciprocally to ground this TestStep.

Parameters:

grounding - a Grounding generator.