net.thucydides.core.reports

Class TestOutcomes

java.lang.Object

net.thucydides.core.reports.TestOutcomes

public class TestOutcomes
extends java.lang.Object

A set of test outcomes, which lets you perform query operations on the test outcomes. In particular, you can filter a set of test outcomes by tag type and by tag values. Since these operations also return TestOutcomes, you can then further drill down into the test outcome sets. The TestOutcomes object will usually return a list of TestOutcome objects. You can also inject statistics and test run history by using the withHistory() method. This will return a list of TestOutcomeWithHistory instances.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	TestOutcomes.OutcomeProportionCounter
class	TestOutcomes.OutcomeProportionStepCounter
class	TestOutcomes.TestOutcomeMatcher

Method Summary

Modifier and Type	Method and Description
boolean	containsTag(TestTag testTag)
OutcomeCounter	count(java.lang.String testType)
OutcomeCounter	count(TestType testType)
TestOutcomes.OutcomeProportionStepCounter	decimalPercentageSteps(java.lang.String testType)
TestOutcomes.TestOutcomeMatcher	findMatchingTags()
TestOutcomes	forRequirement(Requirement requirement)
double	getAverageTestSize()
java.lang.Long	getDuration()
double	getDurationInSeconds()
EnvironmentVariables	getEnvironmentVariables()
TestOutcomes	getErrorTests()
TestOutcomes	getFailingTests() Find the failing test outcomes in this set
java.util.List<java.lang.String>	getFirstClassTagTypes()
TestCoverageFormatter	getFormatted()
TestCoverageFormatter.FormattedPercentageCoverage	getFormattedPercentage()
TestCoverageFormatter.FormattedPercentageCoverage	getFormattedPercentage(java.lang.String testType)
TestCoverageFormatter.FormattedPercentageCoverage	getFormattedPercentage(TestType testType)
TestCoverageFormatter.FormattedPercentageStepCoverage	getFormattedPercentageSteps()
java.lang.String	getLabel()
java.util.List<TestTag>	getMostSpecificTagsOfType(java.lang.String tagType)
java.util.List<? extends TestOutcome>	getOutcomes()
double	getOverallStability()
TestOutcomes	getPassingTests() Find the successful test outcomes in this set
TestOutcomes	getPendingTests() Find the pending or ignored test outcomes in this set
TestOutcomes.OutcomeProportionStepCounter	getPercentSteps()
TestOutcomes.OutcomeProportionCounter	getProportion()
double	getRecentStability()
java.util.List<java.lang.String>	getRequirementTagTypes()
TestResult	getResult()
TestOutcomes	getRootOutcomes()
org.joda.time.DateTime	getStartTime()
int	getStepCount()
java.util.List<java.lang.String>	getTagNames()
java.util.List<TestTag>	getTags()
java.util.List<TestTag>	getTagsOfType(java.lang.String tagType)
java.util.List<TestTag>	getTagsOfTypeExcluding(java.lang.String tagType, java.lang.String excludedTag)
java.util.List<java.lang.String>	getTagTypes()
int	getTestCount()
java.util.List<? extends TestOutcome>	getTests()
int	getTotal()
int	getTotalDataRows()
OutcomeCounter	getTotalTests()
int	getTotalTestScenarios() The total number of test scenarios (a data-driven test is counted as one test scenario).
boolean	hasDataDrivenTests()
TestOutcomes	havingResult(java.lang.String result)
TestOutcomes	havingResult(TestResult result)
static TestOutcomes	of(java.util.List<? extends TestOutcome> outcomes)
TestOutcomes	ofType(TestType testType)
TestOutcomes.OutcomeProportionStepCounter	proportionalStepsOf(java.lang.String testType)
TestOutcomes.OutcomeProportionStepCounter	proportionalStepsOf(TestType testType)
TestOutcomes.OutcomeProportionCounter	proportionOf(java.lang.String testType)
TestOutcomes.OutcomeProportionCounter	proportionOf(TestType testType)
int	successCount(java.lang.String testType)
TestOutcomes	withHistory() Return a copy of the current test outcomes, with test run history and statistics.
TestOutcomes	withLabel(java.lang.String label)
static TestOutcomes	withNoResults()
TestOutcomes	withRequirementsTags()
TestOutcomes	withTag(java.lang.String tagName) Find the test outcomes with a given tag name
TestOutcomes	withTag(TestTag tag)
TestOutcomes	withTags(java.util.List<TestTag> tags)
TestOutcomes	withTagType(java.lang.String tagType) Find the test outcomes with a given tag type

Methods inherited from class java.lang.Object

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

Method Detail

withLabel

public TestOutcomes withLabel(java.lang.String label)

getEnvironmentVariables

public EnvironmentVariables getEnvironmentVariables()

havingResult

public TestOutcomes havingResult(java.lang.String result)

havingResult

public TestOutcomes havingResult(TestResult result)

of

public static TestOutcomes of(java.util.List<? extends TestOutcome> outcomes)

withNoResults

public static TestOutcomes withNoResults()

getLabel

public java.lang.String getLabel()

getTagTypes

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

Returns:

The list of all of the different tag types that appear in the test outcomes.

getFirstClassTagTypes

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

getRequirementTagTypes

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

getTagNames

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

Returns:

The list of all the names of the different tags in these test outcomes

getTags

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

Returns:

The list of all the different tags in these test outcomes

getTagsOfType

public java.util.List<TestTag> getTagsOfType(java.lang.String tagType)

Returns:

The list of all the tags associated with a given tag type.

getMostSpecificTagsOfType

public java.util.List<TestTag> getMostSpecificTagsOfType(java.lang.String tagType)

Returns:

The list of all the tags associated with a given tag type.

getTagsOfTypeExcluding

public java.util.List<TestTag> getTagsOfTypeExcluding(java.lang.String tagType,
                                                      java.lang.String excludedTag)

getRootOutcomes

public TestOutcomes getRootOutcomes()

forRequirement

public TestOutcomes forRequirement(Requirement requirement)

containsTag

public boolean containsTag(TestTag testTag)

getStartTime

public org.joda.time.DateTime getStartTime()

ofType

public TestOutcomes ofType(TestType testType)

withRequirementsTags

public TestOutcomes withRequirementsTags()

withTagType

public TestOutcomes withTagType(java.lang.String tagType)

Find the test outcomes with a given tag type

Parameters:

tagType - the tag type we are filtering on

Returns:

A new set of test outcomes for this tag type

withTag

public TestOutcomes withTag(java.lang.String tagName)

Find the test outcomes with a given tag name

Parameters:

tagName - the name of the tag type we are filtering on

Returns:

A new set of test outcomes for this tag name

withTag

public TestOutcomes withTag(TestTag tag)

withTags

public TestOutcomes withTags(java.util.List<TestTag> tags)

withHistory

public TestOutcomes withHistory()

Return a copy of the current test outcomes, with test run history and statistics.

Returns:

a TestOutcome instance containing a list of TestOutcomeWithHistory instances.

getFailingTests

public TestOutcomes getFailingTests()

Find the failing test outcomes in this set

Returns:

A new set of test outcomes containing only the failing tests

getErrorTests

public TestOutcomes getErrorTests()

getPassingTests

public TestOutcomes getPassingTests()

Find the successful test outcomes in this set

Returns:

A new set of test outcomes containing only the successful tests

getPendingTests

public TestOutcomes getPendingTests()

Find the pending or ignored test outcomes in this set

Returns:

A new set of test outcomes containing only the pending or ignored tests

getTests

public java.util.List<? extends TestOutcome> getTests()

Returns:

The list of TestOutcomes contained in this test outcome set.

getDuration

public java.lang.Long getDuration()

Returns:

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

getDurationInSeconds

public double getDurationInSeconds()

Returns:

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

getTotal

public int getTotal()

Returns:

The total number of test runs in this set (including rows in data-driven tests).

getTotalTestScenarios

public int getTotalTestScenarios()

The total number of test scenarios (a data-driven test is counted as one test scenario).

getOutcomes

public java.util.List<? extends TestOutcome> getOutcomes()

getResult

public TestResult getResult()

Returns:

The overall result for the tests in this test outcome set.

getStepCount

public int getStepCount()

Returns:

The total number of nested steps in these test outcomes.

successCount

public int successCount(java.lang.String testType)

Parameters:

testType - 'manual' or 'automated' (this is a string because it is mainly called from the freemarker templates

getTotalTests

public OutcomeCounter getTotalTests()

count

public OutcomeCounter count(java.lang.String testType)

count

public OutcomeCounter count(TestType testType)

getProportion

public TestOutcomes.OutcomeProportionCounter getProportion()

proportionOf

public TestOutcomes.OutcomeProportionCounter proportionOf(java.lang.String testType)

proportionOf

public TestOutcomes.OutcomeProportionCounter proportionOf(TestType testType)

getPercentSteps

public TestOutcomes.OutcomeProportionStepCounter getPercentSteps()

proportionalStepsOf

public TestOutcomes.OutcomeProportionStepCounter proportionalStepsOf(java.lang.String testType)

proportionalStepsOf

public TestOutcomes.OutcomeProportionStepCounter proportionalStepsOf(TestType testType)

decimalPercentageSteps

public TestOutcomes.OutcomeProportionStepCounter decimalPercentageSteps(java.lang.String testType)

getFormattedPercentageSteps

public TestCoverageFormatter.FormattedPercentageStepCoverage getFormattedPercentageSteps()

getFormattedPercentage

public TestCoverageFormatter.FormattedPercentageCoverage getFormattedPercentage()

getFormattedPercentage

public TestCoverageFormatter.FormattedPercentageCoverage getFormattedPercentage(java.lang.String testType)

getFormattedPercentage

public TestCoverageFormatter.FormattedPercentageCoverage getFormattedPercentage(TestType testType)

getFormatted

public TestCoverageFormatter getFormatted()

Returns:

Formatted version of the test coverage metrics

getAverageTestSize

public double getAverageTestSize()

getRecentStability

public double getRecentStability()

getOverallStability

public double getOverallStability()

getTestCount

public int getTestCount()

hasDataDrivenTests

public boolean hasDataDrivenTests()

getTotalDataRows

public int getTotalDataRows()

findMatchingTags

public TestOutcomes.TestOutcomeMatcher findMatchingTags()