net.thucydides.core.model

Class TestStep

java.lang.Object

net.thucydides.core.model.TestStep

public class TestStep
extends java.lang.Object

An acceptance test run is made up of test steps. Test steps can be either concrete steps or groups of steps. Each concrete step should represent an action by the user, and (generally) an expected outcome. A test step is described by a narrative-style phrase (e.g. "the user clicks on the 'Search' button', "the user fills in the registration form', etc.). A screenshot is stored for each step.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TestStep.TestStepBuilder

Constructor Summary

Constructors

Constructor and Description
TestStep()
TestStep(org.joda.time.DateTime startTime, java.lang.String description)
TestStep(java.lang.String description)

Method Summary

Modifier and Type	Method and Description
TestStep	addChildStep(TestStep step)
TestStep	addScreenshot(ScreenshotAndHtmlSource screenshotAndHtmlSource)
TestStep	clone()
boolean	equals(java.lang.Object o)
void	failedWith(java.lang.Throwable cause) Indicate that this step failed with a given error.
static TestStep.TestStepBuilder	forStepCalled(java.lang.String description)
java.util.List<TestStep>	getChildren()
java.lang.String	getDescription()
long	getDuration()
double	getDurationInSeconds()
java.lang.String	getErrorMessage()
FailureCause	getException()
ScreenshotAndHtmlSource	getFirstScreenshot()
java.util.List<? extends TestStep>	getFlattenedSteps()
java.util.Collection<? extends TestStep>	getLeafTestSteps()
FailureCause	getNestedException()
int	getNumber()
RestQuery	getRestQuery()
TestResult	getResult()
int	getScreenshotCount()
java.util.List<ScreenshotAndHtmlSource>	getScreenshots()
java.lang.String	getShortErrorMessage()
long	getStartTime()
boolean	hasChildren()
int	hashCode()
boolean	hasRestQuery()
boolean	hasScreenshots()
boolean	isAGroup()
java.lang.Boolean	isError()
java.lang.Boolean	isFailure()
java.lang.Boolean	isIgnored()
java.lang.Boolean	isPending()
java.lang.Boolean	isSkipped()
java.lang.Boolean	isSuccessful()
boolean	needsScreenshots()
void	recordDuration()
void	recordRestQuery(RestQuery restQuery)
void	removeScreenshot(int index)
int	renumberFrom(int count)
void	setDescription(java.lang.String description)
void	setDuration(long duration)
void	setResult(TestResult result) Each test step has a result, indicating the outcome of this step.
TestStep	startingAt(org.joda.time.DateTime time)
void	testAborted(java.lang.Throwable exception) The test has been aborted (marked as pending or ignored) for a reason described in the exception.
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TestStep

public TestStep()

TestStep

public TestStep(java.lang.String description)

TestStep

public TestStep(org.joda.time.DateTime startTime,
                java.lang.String description)

Method Detail

forStepCalled

public static TestStep.TestStepBuilder forStepCalled(java.lang.String description)

hasScreenshots

public boolean hasScreenshots()

renumberFrom

public int renumberFrom(int count)

recordRestQuery

public void recordRestQuery(RestQuery restQuery)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

startingAt

public TestStep startingAt(org.joda.time.DateTime time)

clone

public TestStep clone()

Overrides:

clone in class java.lang.Object

recordDuration

public void recordDuration()

getNumber

public int getNumber()

setDescription

public void setDescription(java.lang.String description)

getDescription

public java.lang.String getDescription()

getChildren

public java.util.List<TestStep> getChildren()

getScreenshots

public java.util.List<ScreenshotAndHtmlSource> getScreenshots()

hasRestQuery

public boolean hasRestQuery()

getRestQuery

public RestQuery getRestQuery()

getFirstScreenshot

public ScreenshotAndHtmlSource getFirstScreenshot()

needsScreenshots

public boolean needsScreenshots()

setResult

public void setResult(TestResult result)

Each test step has a result, indicating the outcome of this step.

Parameters:

result - The test outcome associated with this step.

getResult

public TestResult getResult()

isSuccessful

public java.lang.Boolean isSuccessful()

isFailure

public java.lang.Boolean isFailure()

isError

public java.lang.Boolean isError()

isIgnored

public java.lang.Boolean isIgnored()

isSkipped

public java.lang.Boolean isSkipped()

isPending

public java.lang.Boolean isPending()

setDuration

public void setDuration(long duration)

getDuration

public long getDuration()

getDurationInSeconds

public double getDurationInSeconds()

failedWith

public void failedWith(java.lang.Throwable cause)

Indicate that this step failed with a given error.

Parameters:

cause - why the test failed.

getErrorMessage

public java.lang.String getErrorMessage()

testAborted

public void testAborted(java.lang.Throwable exception)

The test has been aborted (marked as pending or ignored) for a reason described in the exception.

getShortErrorMessage

public java.lang.String getShortErrorMessage()

getException

public FailureCause getException()

getNestedException

public FailureCause getNestedException()

getFlattenedSteps

public java.util.List<? extends TestStep> getFlattenedSteps()

isAGroup

public boolean isAGroup()

addChildStep

public TestStep addChildStep(TestStep step)

hasChildren

public boolean hasChildren()

getLeafTestSteps

public java.util.Collection<? extends TestStep> getLeafTestSteps()

addScreenshot

public TestStep addScreenshot(ScreenshotAndHtmlSource screenshotAndHtmlSource)

getStartTime

public long getStartTime()

getScreenshotCount

public int getScreenshotCount()

removeScreenshot

public void removeScreenshot(int index)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object