TestOutcomes (serenity-core 1.6.1 API)

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`
`static class`	`TestOutcomes.TestOutcomeMatcher`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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()`
`java.lang.Integer`	`flagCountFor(Flag flag)`
`TestOutcomes`	`forRequirement(Requirement requirement)`
`double`	`getAverageTestSize()`
`TestOutcomes`	`getCompromisedTests()`
`java.lang.Long`	`getDuration()`
`double`	`getDurationInSeconds()`
`EnvironmentVariables`	`getEnvironmentVariables()`
`TestOutcomes`	`getErrorTests()`
`TestOutcomes`	`getFailingOrErrorTests()`
`TestOutcomes`	`getFailingTests()` Find the failing test outcomes in this set
`java.util.List<java.lang.String>`	`getFirstClassTagTypes()`
`java.util.Map<? extends Flag,java.lang.Integer>`	`getFlagCounts()`
`java.util.Set<? extends Flag>`	`getFlags()`
`TestCoverageFormatter`	`getFormatted()`
`TestCoverageFormatter.FormattedPercentageCoverage`	`getFormattedPercentage()`
`TestCoverageFormatter.FormattedPercentageCoverage`	`getFormattedPercentage(java.lang.String testType)`
`TestCoverageFormatter.FormattedPercentageCoverage`	`getFormattedPercentage(TestType testType)`
`TestCoverageFormatter.FormattedPercentageStepCoverage`	`getFormattedPercentageSteps()`
`java.lang.String`	`getLabel()`
`TestOutcomes`	`getManualTests()`
`java.util.List<TestTag>`	`getMostSpecificTagsOfType(java.lang.String tagType)`
`java.util.List<? extends TestOutcome>`	`getOutcomes()`
`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()`
`java.util.List<java.lang.String>`	`getRequirementTagTypes()`
`TestResult`	`getResult()`
`TestOutcomes`	`getRootOutcomes()`
`java.util.Optional<java.time.ZonedDateTime>`	`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()`
`TestTag`	`getTestTag()`
`int`	`getTotal()`
`int`	`getTotalDataRows()`
`ScenarioOutcomeCounter`	`getTotalScenarios()`
`OutcomeCounter`	`getTotalTests()`
`int`	`getTotalTestScenarios()` The total number of test scenarios (a data-driven test is counted as one test scenario).
`boolean`	`hasDataDrivenTests()`
`boolean`	`haveFlags()`
`TestOutcomes`	`havingResult(java.lang.String result)`
`TestOutcomes`	`havingResult(TestResult result)`
`static TestOutcomes`	`of(java.util.Collection<? 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`	`withCardNumber(java.lang.String issueCardNumber)`
`TestOutcomes`	`withLabel(java.lang.String label)`
`static TestOutcomes`	`withNoResults()`
`TestOutcomes`	`withRequirementsTags()`
`TestOutcomes`	`withResult(TestResult result)`
`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.Collection<? extends TestOutcome> outcomes)

withNoResults

public static TestOutcomes withNoResults()

getFlagCounts

public java.util.Map<? extends Flag,java.lang.Integer> getFlagCounts()

haveFlags
```
public boolean haveFlags()
```

getFlags

public java.util.Set<? extends Flag> getFlags()

flagCountFor

public java.lang.Integer flagCountFor(Flag flag)

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)

getTestTag
```
public TestTag getTestTag()
```

containsTag

public boolean containsTag(TestTag testTag)

getStartTime

public java.util.Optional<java.time.ZonedDateTime> getStartTime()

ofType

public TestOutcomes ofType(TestType testType)

withResult

public TestOutcomes withResult(TestResult result)

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)

withCardNumber

public TestOutcomes withCardNumber(java.lang.String issueCardNumber)

withTags

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

getFailingOrErrorTests

public TestOutcomes getFailingOrErrorTests()

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

getManualTests
```
public TestOutcomes getManualTests()
```

getCompromisedTests

public TestOutcomes getCompromisedTests()

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

getTotalScenarios

public ScenarioOutcomeCounter getTotalScenarios()

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

getTestCount
```
public int getTestCount()
```

hasDataDrivenTests
```
public boolean hasDataDrivenTests()
```

getTotalDataRows
```
public int getTotalDataRows()
```

findMatchingTags

public TestOutcomes.TestOutcomeMatcher findMatchingTags()

Class TestOutcomes

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

withLabel

getEnvironmentVariables

havingResult

havingResult

of

withNoResults

getFlagCounts

haveFlags

getFlags

flagCountFor

getLabel

getTagTypes

getFirstClassTagTypes

getRequirementTagTypes

getTagNames

getTags

getTagsOfType

getMostSpecificTagsOfType

getTagsOfTypeExcluding

getRootOutcomes

forRequirement

getTestTag

containsTag

getStartTime

ofType

withResult

withRequirementsTags

withTagType

withTag

withTag

withCardNumber

withTags

getFailingOrErrorTests

getFailingTests

getErrorTests

getManualTests

getCompromisedTests

getPassingTests

getPendingTests

getTests

getDuration

getDurationInSeconds

getTotal

getTotalTestScenarios

getOutcomes

getResult

getStepCount

successCount

getTotalTests

getTotalScenarios

count

count

getProportion

proportionOf

proportionOf

getPercentSteps

proportionalStepsOf

proportionalStepsOf

decimalPercentageSteps

getFormattedPercentageSteps

getFormattedPercentage

getFormattedPercentage

getFormattedPercentage

getFormatted

getAverageTestSize

getTestCount

hasDataDrivenTests

getTotalDataRows

findMatchingTags