Module com.serenitybdd.serenitymodel

Package net.thucydides.model.domain

Class TestStep

java.lang.Object

net.thucydides.model.domain.TestStep

All Implemented Interfaces:

Cloneable

public class TestStep
extends Object
implements Cloneable

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.

Author:

johnsmart

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TestStep.TestStepBuilder

Field Summary

Fields

Modifier and Type	Field	Description
static final Predicate<TestStep>	COMPROMISED_TESTSTEPS
static final Predicate<TestStep>	ERROR_TESTSTEPS
static final Predicate<TestStep>	FAILING_TESTSTEPS
static final Predicate<TestStep>	IGNORED_TESTSTEPS
static final TestStep	NO_STEP
static final Predicate<TestStep>	SKIPPED_TESTSTEPS
static final Predicate<TestStep>	SUCCESSFUL_TESTSTEPS

Constructor Summary

Constructors

Constructor	Description
TestStep()
TestStep(String description)
TestStep(ZonedDateTime startTime, String description)

Method Summary

Modifier and Type	Method	Description
TestStep	addChildStep(TestStep step)
TestStep	addScreenshot(ScreenshotAndHtmlSource screenshotAndHtmlSource)
TestStep	asManual()
protected List<TestStep>	children()
void	clearException()
TestStep	clone()
protected TestStep	copyOfThisTestStep()
boolean	correspondsToLine(int lineNumber)
boolean	equals(Object o)
void	failedWith(Throwable cause)	Indicate that this step failed with a given error.
static TestStep.TestStepBuilder	forStepCalled(String description)
int	getActualScreenshotCount()
List<ScreenshotAndHtmlSource>	getAllScreenshots()
String	getAllStepsText()
List<TestStep>	getChildren()
String	getConciseErrorMessage()
String	getDescription()
long	getDuration()
double	getDurationInSeconds()
Screenshot	getEarliestScreenshot()
ZonedDateTime	getEndTime()
String	getError()
String	getErrorMessage()
FailureCause	getException()
ExternalLink	getExternalLink()
ScreenshotAndHtmlSource	getFirstScreenshot()
List<? extends TestStep>	getFlattenedSteps()
String	getFormattedDuration()
ScreenshotAndHtmlSource	getLastScreenshot()
Screenshot	getLatestScreenshot()
Collection<? extends TestStep>	getLeafTestSteps()
int	getLevel()
FailureCause	getNestedException()
int	getNumber()
TestResult	getOverallResult()
List<Screenshot>	getRenderedScreenshots()	Returns rendered screenshots of this step and of child steps, in order of appearance, and starting with the earliet screenshot overall with the name of this step.
List<ReportData>	getReportData()
List<ReportData>	getReportEvidence()
RestQuery	getRestQuery()
TestResult	getResult()
int	getScreenshotCount()
List<ScreenshotAndHtmlSource>	getScreenshots()
String	getShortErrorMessage()
ZonedDateTime	getStartTime()
List<Screenshot>	getTopLevelScreenshots()
boolean	hasChildren()
boolean	hasData()
int	hashCode()
boolean	hasMultipleScreenshots()
boolean	hasNestedErrors()
boolean	hasRestQuery()
boolean	hasScreenshots()
boolean	isAGroup()
boolean	isAPrecondition()
Boolean	isCompromised()
Boolean	isError()
Boolean	isFailure()
Boolean	isIgnored()
Boolean	isPending()
Boolean	isSkipped()
Boolean	isSuccessful()
boolean	needsScreenshots()
void	recordDuration()
void	recordDuration(ZonedDateTime time)
TestStep	recordReportData(ReportData reportData)
void	recordRestQuery(RestQuery restQuery)
void	removeScreenshot(int index)
Screenshot	renderedScreenshotOf(ScreenshotAndHtmlSource from, int level)
int	renumberFrom(int count)
void	setDescription(String description)
void	setDuration(long duration)
void	setExternalLink(ExternalLink externalLink)
void	setLineNumber(int lineNumber)
protected void	setNumber(int number)
void	setPrecondition(boolean precondition)
void	setResult(TestResult result)	Each test step has a result, indicating the outcome of this step.
void	setStartTime(ZonedDateTime startTime)
TestStep	startingAt(ZonedDateTime time)
void	testAborted(Throwable exception)	The test has been aborted (marked as pending or ignored) for a reason described in the exception.
String	toString()
TestStep	unrendered()
void	updateOverallResult()
TestStep	withReportData(ReportData reportData)
TestStep	withResult(TestResult annotatedResult)

Methods inherited from class java.lang.Object

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

Field Details

NO_STEP

public static final TestStep NO_STEP

IGNORED_TESTSTEPS

public static final Predicate<TestStep> IGNORED_TESTSTEPS

COMPROMISED_TESTSTEPS

public static final Predicate<TestStep> COMPROMISED_TESTSTEPS

SUCCESSFUL_TESTSTEPS

public static final Predicate<TestStep> SUCCESSFUL_TESTSTEPS

FAILING_TESTSTEPS

public static final Predicate<TestStep> FAILING_TESTSTEPS

ERROR_TESTSTEPS

public static final Predicate<TestStep> ERROR_TESTSTEPS

SKIPPED_TESTSTEPS

public static final Predicate<TestStep> SKIPPED_TESTSTEPS

Constructor Details

TestStep

public TestStep()

TestStep

public TestStep(String description)

TestStep

public TestStep(ZonedDateTime startTime,
 String description)

Method Details

setNumber

protected void setNumber(int number)

forStepCalled

public static TestStep.TestStepBuilder forStepCalled(String description)

hasScreenshots

public boolean hasScreenshots()

children

protected List<TestStep> children()

renumberFrom

public int renumberFrom(int count)

recordRestQuery

public void recordRestQuery(RestQuery restQuery)

updateOverallResult

public void updateOverallResult()

setPrecondition

public void setPrecondition(boolean precondition)

withResult

public TestStep withResult(TestResult annotatedResult)

setLineNumber

public void setLineNumber(int lineNumber)

correspondsToLine

public boolean correspondsToLine(int lineNumber)

getExternalLink

public ExternalLink getExternalLink()

setExternalLink

public void setExternalLink(ExternalLink externalLink)

setStartTime

public void setStartTime(ZonedDateTime startTime)

toString

public String toString()

Overrides:

toString in class Object

startingAt

public TestStep startingAt(ZonedDateTime time)

clone

public TestStep clone()

Overrides:

clone in class Object

copyOfThisTestStep

protected TestStep copyOfThisTestStep()

recordDuration

public void recordDuration(ZonedDateTime time)

recordDuration

public void recordDuration()

getNumber

public int getNumber()

setDescription

public void setDescription(String description)

getDescription

public String getDescription()

unrendered

public TestStep unrendered()

getChildren

public List<TestStep> getChildren()

getAllStepsText

public String getAllStepsText()

getScreenshots

public List<ScreenshotAndHtmlSource> getScreenshots()

getAllScreenshots

public List<ScreenshotAndHtmlSource> getAllScreenshots()

getRenderedScreenshots

public List<Screenshot> getRenderedScreenshots()

Returns rendered screenshots of this step and of child steps, in order of appearance, and starting with the earliet screenshot overall with the name of this step.

getTopLevelScreenshots

public List<Screenshot> getTopLevelScreenshots()

renderedScreenshotOf

public Screenshot renderedScreenshotOf(ScreenshotAndHtmlSource from,
 int level)

hasRestQuery

public boolean hasRestQuery()

hasData

public boolean hasData()

getRestQuery

public RestQuery getRestQuery()

getLevel

public int getLevel()

getReportEvidence

public List<ReportData> getReportEvidence()

getReportData

public List<ReportData> getReportData()

getFirstScreenshot

public ScreenshotAndHtmlSource getFirstScreenshot()

getEarliestScreenshot

public Screenshot getEarliestScreenshot()

getLatestScreenshot

public Screenshot getLatestScreenshot()

getLastScreenshot

public ScreenshotAndHtmlSource getLastScreenshot()

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()

getOverallResult

public TestResult getOverallResult()

asManual

public TestStep asManual()

isSuccessful

public Boolean isSuccessful()

isFailure

public Boolean isFailure()

isError

public Boolean isError()

isCompromised

public Boolean isCompromised()

isIgnored

public Boolean isIgnored()

isSkipped

public Boolean isSkipped()

isPending

public Boolean isPending()

isAPrecondition

public boolean isAPrecondition()

setDuration

public void setDuration(long duration)

getDuration

public long getDuration()

getDurationInSeconds

public double getDurationInSeconds()

getFormattedDuration

public String getFormattedDuration()

failedWith

public void failedWith(Throwable cause)

Indicate that this step failed with a given error.

Parameters:

cause - why the test failed.

getError

public String getError()

getErrorMessage

public String getErrorMessage()

getConciseErrorMessage

public String getConciseErrorMessage()

testAborted

public void testAborted(Throwable exception)

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

getShortErrorMessage

public String getShortErrorMessage()

getException

public FailureCause getException()

clearException

public void clearException()

getNestedException

public FailureCause getNestedException()

getFlattenedSteps

public List<? extends TestStep> getFlattenedSteps()

isAGroup

public boolean isAGroup()

hasNestedErrors

public boolean hasNestedErrors()

addChildStep

public TestStep addChildStep(TestStep step)

hasChildren

public boolean hasChildren()

hasMultipleScreenshots

public boolean hasMultipleScreenshots()

getLeafTestSteps

public Collection<? extends TestStep> getLeafTestSteps()

addScreenshot

public TestStep addScreenshot(ScreenshotAndHtmlSource screenshotAndHtmlSource)

getStartTime

public ZonedDateTime getStartTime()

getEndTime

public ZonedDateTime getEndTime()

getActualScreenshotCount

public int getActualScreenshotCount()

getScreenshotCount

public int getScreenshotCount()

removeScreenshot

public void removeScreenshot(int index)

withReportData

public TestStep withReportData(ReportData reportData)

recordReportData

public TestStep recordReportData(ReportData reportData)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object