net.thucydides.core.model

Class TestOutcome

java.lang.Object

net.thucydides.core.model.TestOutcome

public class TestOutcome
extends java.lang.Object

Represents the results of a test (or "scenario") execution. This includes the narrative steps taken during the test, screenshots at each step, the results of each step, and the overall result. A test scenario can be associated with a user story using the UserStory annotation. A TestOutcome is stored after a test is executed. When the aggregate reports are generated, the test outcome files are loaded into memory and processed.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TestOutcome.OptionalElements
static class	TestOutcome.StepCountBuilder
class	TestOutcome.StepReplacer
class	TestOutcome.TitleBuilder

Constructor Summary

Constructors

Constructor and Description
TestOutcome(java.lang.String name) The title is immutable once set.
TestOutcome(java.lang.String name, java.lang.Class<?> testCase)

Method Summary

Modifier and Type	Method and Description
void	addDataFrom(DataTable newDataTable)
void	addFailingExternalStep(java.lang.Throwable testFailureCause)
void	addFailingStepAsSibling(java.util.List<TestStep> testStepList, java.lang.Throwable testFailureCause)
void	addIssues(java.util.List<java.lang.String> issues)
void	addNewExamplesFrom(DataTable table)
void	addRow(DataTableRow dataTableRow)
void	addRow(java.util.Map<java.lang.String,?> data)
void	addTag(TestTag tag)
void	addTags(java.util.List<TestTag> tags)
TestOutcome	addVersion(java.lang.String version)
TestOutcome	addVersions(java.util.List<java.lang.String> versions)
TestOutcome	asManualTest()
void	calculateDynamicFieldValues() Fix the values of synthetic fields for serialization purposes
void	clearForcedResult()
void	clearStartTime()
TestOutcome	copy()
int	countNestedStepsWithResult(TestResult expectedResult, TestType testType)
int	countResults(TestResult expectedResult)
int	countResults(TestResult expectedResult, TestType expectedType)
java.lang.Integer	countTestSteps()
TestStep	currentGroup()
TestStep	currentStep()
boolean	dataIsPredefined()
void	determineTestFailureCause(java.lang.Throwable cause)
void	endGroup() Finish the current group.
boolean	equals(java.lang.Object o)
TestOutcome	forProject(java.lang.String project)
static TestOutcome	forTest(java.lang.String methodName, java.lang.Class<?> testCase) Create a new test outcome instance for a given test class or user story.
static TestOutcome	forTestInStory(java.lang.String testName, java.lang.Class<?> testCase, Story story)
static TestOutcome	forTestInStory(java.lang.String testName, Story story)
java.util.List<java.lang.String>	getAdditionalIssues()
java.util.List<java.lang.String>	getAdditionalVersions()
TestResult	getAnnotatedResult()
java.lang.String	getBackgroundDescription()
java.lang.String	getBackgroundTitle()
java.lang.String	getCompleteName() Returns the name of the test prefixed by the name of the story.
java.lang.String	getDataDrivenSampleScenario()
DataTable	getDataTable()
java.lang.String	getDescription()
com.google.common.base.Optional<java.lang.String>	getDescriptionText() Tests may have a description.
java.lang.String	getDriver()
java.lang.Long	getDuration()
double	getDurationInSeconds()
EnvironmentVariables	getEnvironmentVariables()
java.lang.Integer	getErrorCount()
java.lang.String	getErrorMessage()
java.util.List<java.lang.String>	getExampleFields()
java.lang.Integer	getFailureCount()
ApplicationFeature	getFeature() Get the feature that includes the user story tested by this test.
com.google.common.base.Optional<TestTag>	getFeatureTag()
java.util.List<TestStep>	getFlattenedTestSteps()
java.lang.String	getFormattedIssues()
java.lang.String	getHtmlReport()
java.lang.Integer	getIgnoredCount()
int	getImplementedTestCount()
java.util.List<java.lang.String>	getIssueKeys()
java.util.List<java.lang.String>	getIssues()
java.util.List<TestStep>	getLeafTestSteps()
java.lang.String	getName()
java.lang.Integer	getNestedStepCount()
FailureCause	getNestedTestFailureCause()
double	getOverallStability()
java.lang.String	getPath()
java.lang.String	getPathId()
java.lang.Integer	getPendingCount()
java.lang.String	getProject()
TestOutcome.TitleBuilder	getQualified()
java.lang.String	getQualifiedMethodName()
com.google.common.base.Optional<java.lang.String>	getQualifier()
int	getRecentFailCount()
int	getRecentPassCount()
int	getRecentPendingCount()
double	getRecentStability()
java.lang.Long	getRecentTestRunCount()
java.lang.String	getReportName()
java.lang.String	getReportName(ReportType type)
TestResult	getResult() The outcome of the acceptance test, based on the outcome of the test steps.
java.util.List<ScreenshotAndHtmlSource>	getScreenshotAndHtmlSources()
java.lang.String	getScreenshotReportName()
java.util.List<Screenshot>	getScreenshots()
java.lang.String	getSessionId()
java.lang.String	getSimpleReportName(ReportType type)
java.lang.Integer	getSkippedCount()
java.lang.Integer	getSkippedOrIgnoredCount()
org.joda.time.DateTime	getStartTime()
TestStatistics	getStatistics()
java.lang.Integer	getStepCount()
java.lang.String	getStoryTitle()
java.lang.Integer	getSuccessCount()
java.util.Set<TestTag>	getTags()
com.google.common.base.Optional<java.lang.String>	getTagValue(java.lang.String tagType)
java.lang.Class<?>	getTestCase()
java.lang.String	getTestCaseName()
int	getTestCount()
FailureCause	getTestFailureCause()
java.lang.String	getTestFailureClassname()
java.lang.String	getTestFailureMessage()
org.joda.time.DateTime	getTestRunTimestamp()
java.util.List<TestStep>	getTestSteps() An acceptance test is made up of a series of steps.
java.lang.String	getTitle() Return the human-readable name for this test.
java.lang.String	getTitle(boolean qualified)
java.lang.String	getTitleWithLinks()
TestOutcome.TitleBuilder	getUnqualified()
Story	getUserStory()
java.util.List<java.lang.String>	getVersions()
java.lang.String	getVideoLink() Returns the link to the associated video (e.g.
TestOutcome.OptionalElements	has()
int	hashCode()
boolean	hasIssue(java.lang.String issue)
boolean	hasNonStepFailure()
boolean	hasRestQueries()
boolean	hasScreenshots()
boolean	hasTag(TestTag tag)
TestOutcome	inTestRunTimestamped(org.joda.time.DateTime testRunTimestamp)
boolean	isDataDriven()
java.lang.Boolean	isError()
java.lang.Boolean	isFailure()
boolean	isManual()
java.lang.Boolean	isPending()
void	isRelatedToIssue(java.lang.String issue)
java.lang.Boolean	isSkipped()
boolean	isStartTimeNotDefined()
java.lang.Boolean	isSuccess()
TestStep	lastStep()
void	lastStepFailedWith(StepFailure failure)
void	lastStepFailedWith(java.lang.Throwable testFailureCause)
void	mergeMostRecentSteps(int maxStepsToMerge)
void	moveToNextRow()
void	recordDuration()
TestOutcome	recordStep(TestStep step) Add a test step to this acceptance test.
TestOutcome	recordSteps(java.util.List<TestStep> steps)
TestOutcome.StepReplacer	replace(java.util.List<TestStep> stepsToMerge)
void	resetFailingStepsCausedBy(java.lang.Class<? extends java.lang.Throwable> expected)
void	setAllStepsTo(TestResult result)
void	setAnnotatedResult(TestResult annotatedResult)
void	setBackgroundDescription(java.lang.String description)
void	setBackgroundTitle(java.lang.String title)
void	setDescription(java.lang.String description)
void	setDriver(java.lang.String driver)
void	setDuration(long duration)
void	setEnvironmentVariables(EnvironmentVariables environmentVariables)
void	setSessionId(java.lang.String sessionId)
void	setStartTime(org.joda.time.DateTime startTime)
void	setStatistics(TestStatistics statistics)
void	setTags(java.util.Set<TestTag> tags)
void	setTestFailureCause(FailureCause testFailureCause)
void	setTestFailureClassname(java.lang.String testFailureClassname)
void	setTestFailureMessage(java.lang.String testFailureMessage)
void	setTestRunTimestamp(org.joda.time.DateTime testRunTimestamp)
void	setTitle(java.lang.String title)
void	setUserStory(Story story)
void	startGroup() Turns the current step into a group.
void	startGroup(java.lang.String groupName) Deprecated.
java.lang.String	toJson()
java.lang.String	toString()
boolean	typeCompatibleWith(TestType testType)
void	updateCurrentRowResult(TestResult result)
void	updateOverallResults()
void	useExamplesFrom(DataTable table)
TestOutcome	usingIssueTracking(IssueTracking issueTracking)
TestOutcome	withIssues(java.util.List<java.lang.String> issues)
TestOutcome	withMethodName(java.lang.String methodName)
TestOutcome	withQualifier(java.lang.String qualifier)
TestOutcome	withTags(java.util.Set<TestTag> tags)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TestOutcome

public TestOutcome(java.lang.String name)

The title is immutable once set. For convenience, you can create a test run directly with a title using this constructor.

Parameters:

name - The name of the Java method that implements this test.

TestOutcome

public TestOutcome(java.lang.String name,
                   java.lang.Class<?> testCase)

Method Detail

calculateDynamicFieldValues

public void calculateDynamicFieldValues()

Fix the values of synthetic fields for serialization purposes

usingIssueTracking

public TestOutcome usingIssueTracking(IssueTracking issueTracking)

asManualTest

public TestOutcome asManualTest()

setEnvironmentVariables

public void setEnvironmentVariables(EnvironmentVariables environmentVariables)

getEnvironmentVariables

public EnvironmentVariables getEnvironmentVariables()

copy

public TestOutcome copy()

forTest

public static TestOutcome forTest(java.lang.String methodName,
                                  java.lang.Class<?> testCase)

Create a new test outcome instance for a given test class or user story.

Parameters:

methodName - The name of the Java method implementing this test,

testCase - The JUnit or TestNG test class that contains this test method

Returns:

A new TestOutcome object for this test.

withQualifier

public TestOutcome withQualifier(java.lang.String qualifier)

withIssues

public TestOutcome withIssues(java.util.List<java.lang.String> issues)

withTags

public TestOutcome withTags(java.util.Set<TestTag> tags)

withMethodName

public TestOutcome withMethodName(java.lang.String methodName)

getName

public java.lang.String getName()

Returns:

The name of the Java method implementing this test, if the test is implemented in Java.

forTestInStory

public static TestOutcome forTestInStory(java.lang.String testName,
                                         Story story)

forTestInStory

public static TestOutcome forTestInStory(java.lang.String testName,
                                         java.lang.Class<?> testCase,
                                         Story story)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getTitle

public java.lang.String getTitle()

Return the human-readable name for this test. This is derived from the test name for tests using a Java implementation, or can also be defined using the Title annotation.

Returns:

the human-readable name for this test.

getTitle

public java.lang.String getTitle(boolean qualified)

getUnqualified

public TestOutcome.TitleBuilder getUnqualified()

getQualified

public TestOutcome.TitleBuilder getQualified()

setAllStepsTo

public void setAllStepsTo(TestResult result)

addDataFrom

public void addDataFrom(DataTable newDataTable)

clearForcedResult

public void clearForcedResult()

setDriver

public void setDriver(java.lang.String driver)

getDriver

public java.lang.String getDriver()

resetFailingStepsCausedBy

public void resetFailingStepsCausedBy(java.lang.Class<? extends java.lang.Throwable> expected)

replace

public TestOutcome.StepReplacer replace(java.util.List<TestStep> stepsToMerge)

mergeMostRecentSteps

public void mergeMostRecentSteps(int maxStepsToMerge)

updateOverallResults

public void updateOverallResults()

setDescription

public void setDescription(java.lang.String description)

setBackgroundDescription

public void setBackgroundDescription(java.lang.String description)

setBackgroundTitle

public void setBackgroundTitle(java.lang.String title)

getDescription

public java.lang.String getDescription()

getBackgroundDescription

public java.lang.String getBackgroundDescription()

getBackgroundTitle

public java.lang.String getBackgroundTitle()

getDescriptionText

public com.google.common.base.Optional<java.lang.String> getDescriptionText()

Tests may have a description. This can be defined with the scenarios (e.g. in the .feature files for Cucumber) or defined elsewhere, such as in JIRA for manual tests.

toJson

public java.lang.String toJson()

getTitleWithLinks

public java.lang.String getTitleWithLinks()

getStoryTitle

public java.lang.String getStoryTitle()

getPath

public java.lang.String getPath()

getPathId

public java.lang.String getPathId()

getReportName

public java.lang.String getReportName(ReportType type)

getSimpleReportName

public java.lang.String getSimpleReportName(ReportType type)

getHtmlReport

public java.lang.String getHtmlReport()

getReportName

public java.lang.String getReportName()

getScreenshotReportName

public java.lang.String getScreenshotReportName()

getTestSteps

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

An acceptance test is made up of a series of steps. Each step is in fact a small test, which follows on from the previous one. The outcome of the acceptance test as a whole depends on the outcome of all of the steps.

Returns:

A list of top-level test steps for this test.

hasScreenshots

public boolean hasScreenshots()

hasRestQueries

public boolean hasRestQueries()

getScreenshotAndHtmlSources

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

getScreenshots

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

hasNonStepFailure

public boolean hasNonStepFailure()

getFlattenedTestSteps

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

getLeafTestSteps

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

getResult

public TestResult getResult()

The outcome of the acceptance test, based on the outcome of the test steps. If any steps fail, the test as a whole is considered a failure. If any steps are pending, the test as a whole is considered pending. If all of the steps are ignored, the test will be considered 'ignored'. If all of the tests succeed except the ignored tests, the test is a success. The test result can also be overridden using the 'setResult()' method.

Returns:

The outcome of this test.

recordSteps

public TestOutcome recordSteps(java.util.List<TestStep> steps)

recordStep

public TestOutcome recordStep(TestStep step)

Add a test step to this acceptance test.

Parameters:

step - a completed step to be added to this test outcome.

Returns:

this TestOucome insstance - this is a convenience to allow method chaining.

getFeature

public ApplicationFeature getFeature()

Get the feature that includes the user story tested by this test. If no user story is defined, no feature can be returned, so the method returns null. If a user story has been defined without a class (for example, one that has been reloaded), the feature will be built using the feature name and id in the user story.

Returns:

The Feature defined for this TestOutcome, if any

setTitle

public void setTitle(java.lang.String title)

startGroup

@Deprecated
public void startGroup(java.lang.String groupName)

Deprecated.

Creates a new step with this name and immediately turns it into a step group.

getQualifier

public com.google.common.base.Optional<java.lang.String> getQualifier()

startGroup

public void startGroup()

Turns the current step into a group. Subsequent steps will be added as children of the current step.

endGroup

public void endGroup()

Finish the current group. Subsequent steps will be added after the current step.

currentStep

public TestStep currentStep()

Returns:

The current step is the last step in the step list, or the last step in the children of the current step group.

lastStep

public TestStep lastStep()

currentGroup

public TestStep currentGroup()

setUserStory

public void setUserStory(Story story)

determineTestFailureCause

public void determineTestFailureCause(java.lang.Throwable cause)

setTestFailureCause

public void setTestFailureCause(FailureCause testFailureCause)

setTestFailureClassname

public void setTestFailureClassname(java.lang.String testFailureClassname)

getTestFailureCause

public FailureCause getTestFailureCause()

getNestedTestFailureCause

public FailureCause getNestedTestFailureCause()

getErrorMessage

public java.lang.String getErrorMessage()

setTestFailureMessage

public void setTestFailureMessage(java.lang.String testFailureMessage)

getTestFailureMessage

public java.lang.String getTestFailureMessage()

getTestFailureClassname

public java.lang.String getTestFailureClassname()

setAnnotatedResult

public void setAnnotatedResult(TestResult annotatedResult)

getAnnotatedResult

public TestResult getAnnotatedResult()

getAdditionalVersions

public java.util.List<java.lang.String> getAdditionalVersions()

getAdditionalIssues

public java.util.List<java.lang.String> getAdditionalIssues()

getIssues

public java.util.List<java.lang.String> getIssues()

getVersions

public java.util.List<java.lang.String> getVersions()

getTestCase

public java.lang.Class<?> getTestCase()

getTestCaseName

public java.lang.String getTestCaseName()

addVersion

public TestOutcome addVersion(java.lang.String version)

addVersions

public TestOutcome addVersions(java.util.List<java.lang.String> versions)

forProject

public TestOutcome forProject(java.lang.String project)

getProject

public java.lang.String getProject()

inTestRunTimestamped

public TestOutcome inTestRunTimestamped(org.joda.time.DateTime testRunTimestamp)

setTestRunTimestamp

public void setTestRunTimestamp(org.joda.time.DateTime testRunTimestamp)

addIssues

public void addIssues(java.util.List<java.lang.String> issues)

getFormattedIssues

public java.lang.String getFormattedIssues()

isRelatedToIssue

public void isRelatedToIssue(java.lang.String issue)

addFailingExternalStep

public void addFailingExternalStep(java.lang.Throwable testFailureCause)

addFailingStepAsSibling

public void addFailingStepAsSibling(java.util.List<TestStep> testStepList,
                                    java.lang.Throwable testFailureCause)

lastStepFailedWith

public void lastStepFailedWith(StepFailure failure)

lastStepFailedWith

public void lastStepFailedWith(java.lang.Throwable testFailureCause)

getTags

public java.util.Set<TestTag> getTags()

setTags

public void setTags(java.util.Set<TestTag> tags)

addTags

public void addTags(java.util.List<TestTag> tags)

addTag

public void addTag(TestTag tag)

getIssueKeys

public java.util.List<java.lang.String> getIssueKeys()

getQualifiedMethodName

public java.lang.String getQualifiedMethodName()

getCompleteName

public java.lang.String getCompleteName()

Returns the name of the test prefixed by the name of the story.

useExamplesFrom

public void useExamplesFrom(DataTable table)

addNewExamplesFrom

public void addNewExamplesFrom(DataTable table)

moveToNextRow

public void moveToNextRow()

updateCurrentRowResult

public void updateCurrentRowResult(TestResult result)

dataIsPredefined

public boolean dataIsPredefined()

addRow

public void addRow(java.util.Map<java.lang.String,?> data)

addRow

public void addRow(DataTableRow dataTableRow)

getTestCount

public int getTestCount()

getImplementedTestCount

public int getImplementedTestCount()

countResults

public int countResults(TestResult expectedResult)

countResults

public int countResults(TestResult expectedResult,
                        TestType expectedType)

typeCompatibleWith

public boolean typeCompatibleWith(TestType testType)

countNestedStepsWithResult

public int countNestedStepsWithResult(TestResult expectedResult,
                                      TestType testType)

getTagValue

public com.google.common.base.Optional<java.lang.String> getTagValue(java.lang.String tagType)

hasIssue

public boolean hasIssue(java.lang.String issue)

hasTag

public boolean hasTag(TestTag tag)

setStartTime

public void setStartTime(org.joda.time.DateTime startTime)

clearStartTime

public void clearStartTime()

isManual

public boolean isManual()

isStartTimeNotDefined

public boolean isStartTimeNotDefined()

has

public TestOutcome.OptionalElements has()

getStepCount

public java.lang.Integer getStepCount()

getNestedStepCount

public java.lang.Integer getNestedStepCount()

getSuccessCount

public java.lang.Integer getSuccessCount()

getFailureCount

public java.lang.Integer getFailureCount()

getErrorCount

public java.lang.Integer getErrorCount()

getIgnoredCount

public java.lang.Integer getIgnoredCount()

getSkippedOrIgnoredCount

public java.lang.Integer getSkippedOrIgnoredCount()

getSkippedCount

public java.lang.Integer getSkippedCount()

getPendingCount

public java.lang.Integer getPendingCount()

isSuccess

public java.lang.Boolean isSuccess()

isFailure

public java.lang.Boolean isFailure()

isError

public java.lang.Boolean isError()

isPending

public java.lang.Boolean isPending()

isSkipped

public java.lang.Boolean isSkipped()

getUserStory

public Story getUserStory()

recordDuration

public void recordDuration()

setDuration

public void setDuration(long duration)

getDuration

public java.lang.Long getDuration()

getDurationInSeconds

public double getDurationInSeconds()

Returns:

The total duration of all of the tests in this set in milliseconds.

getVideoLink

public java.lang.String getVideoLink()

Returns the link to the associated video (e.g. from Saucelabs) for this test.

Returns:

a URL.

getSessionId

public java.lang.String getSessionId()

setSessionId

public void setSessionId(java.lang.String sessionId)

countTestSteps

public java.lang.Integer countTestSteps()

setStatistics

public void setStatistics(TestStatistics statistics)

getStatistics

public TestStatistics getStatistics()

getOverallStability

public double getOverallStability()

getRecentStability

public double getRecentStability()

getRecentTestRunCount

public java.lang.Long getRecentTestRunCount()

getRecentPassCount

public int getRecentPassCount()

getRecentFailCount

public int getRecentFailCount()

getRecentPendingCount

public int getRecentPendingCount()

getStartTime

public org.joda.time.DateTime getStartTime()

getTestRunTimestamp

public org.joda.time.DateTime getTestRunTimestamp()

isDataDriven

public boolean isDataDriven()

getExampleFields

public java.util.List<java.lang.String> getExampleFields()

getDataDrivenSampleScenario

public java.lang.String getDataDrivenSampleScenario()

getDataTable

public DataTable getDataTable()

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

getFeatureTag

public com.google.common.base.Optional<TestTag> getFeatureTag()