Package net.thucydides.core.requirements.reports

Class RequirementsOutcomes

java.lang.Object

net.thucydides.core.requirements.reports.RequirementsOutcomes

public class RequirementsOutcomes
extends java.lang.Object

A set of test results for a list of high-level requirements.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.Integer	DEFAULT_TESTS_PER_REQUIREMENT

Constructor Summary

Constructors

Constructor	Description
RequirementsOutcomes(java.util.List<Requirement> requirements, TestOutcomes testOutcomes, IssueTracking issueTracking, EnvironmentVariables environmentVariables, java.util.List<? extends RequirementsTagProvider> requirementsTagProviders, ReportNameProvider reportNameProvider, java.lang.String overview)
RequirementsOutcomes(Requirement parentRequirement, java.util.List<Requirement> requirements, TestOutcomes testOutcomes, IssueTracking issueTracking, EnvironmentVariables environmentVariables, java.util.List<? extends RequirementsTagProvider> requirementsTagProviders, ReportNameProvider reportNameProvider, java.lang.String overview)

Method Summary

Modifier and Type	Method	Description
OutcomeCounter	count(java.lang.String testType)
OutcomeCounter	count(TestType testType)
RequirementsOutcomes	filteredByDisplayTag()
java.util.List<RequirementOutcome>	geLeafRequirementOutcomes(java.util.List<RequirementOutcome> outcomes)
java.lang.String	getChildrenType()
int	getCompletedRequirementsCount()
int	getCompromisedRequirementsCount()
int	getErrorRequirementsCount()
int	getEstimatedUnimplementedTests()
int	getFailingRequirementsCount()
int	getFlattenedRequirementCount()
java.util.List<RequirementOutcome>	getFlattenedRequirementOutcomes()
java.util.List<RequirementOutcome>	getFlattenedRequirementOutcomes(java.util.List<RequirementOutcome> outcomes)
RequirementsPercentageFormatter	getFormattedPercentage()
RequirementsPercentageFormatter	getFormattedPercentage(java.lang.String testType)
RequirementsPercentageFormatter	getFormattedPercentage(TestType testType)
java.util.Optional<Requirement>	getGrandparentRequirement()
int	getIgnoredRequirementsCount()
java.util.List<RequirementOutcome>	getLeafRequirementOutcomes()
java.util.Optional<RequirementOutcome>	getOutcomeFor(Requirement requirement)
java.lang.String	getOverview()
java.util.Optional<Requirement>	getParentRequirement()
int	getPendingRequirementsCount()
RequirementsProportionCounter	getProportion()
RequirementsOutcomes	getReleasedRequirementsFor(Release release)
int	getRequirementCount()
java.util.List<RequirementOutcome>	getRequirementOutcomes()
java.util.List<Requirement>	getRequirements()
int	getRequirementsWithoutTestsCount()
int	getSkippedRequirementsCount()
TestOutcomes	getTestOutcomes()
java.util.Optional<TestResult>	getTestResultForTestNamed(java.lang.String name)
OutcomeCounter	getTotal()
int	getTotalRequirements()
int	getTotalTestCount()
java.lang.String	getType()
java.util.List<java.lang.String>	getTypes()
int	getUnsuccessfulRequirementsCount()
RequirementsOutcomes	ofType(java.lang.String type)
RequirementsProportionCounter	proportionOf(java.lang.String testType)
RequirementsProportionCounter	proportionOf(TestType testType)
RequirementOutcome	requirementOutcomeFor(Requirement requirement)
RequirementsOutcomes	requirementsOfType(java.lang.String type)
boolean	shouldPrune(RequirementOutcome requirementOutcome)
java.lang.String	toString()
RequirementsOutcomes	withoutUnrelatedRequirements()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

DEFAULT_TESTS_PER_REQUIREMENT

public static final java.lang.Integer DEFAULT_TESTS_PER_REQUIREMENT

Constructor Details

RequirementsOutcomes

public RequirementsOutcomes(java.util.List<Requirement> requirements,
TestOutcomes testOutcomes,
IssueTracking issueTracking,
EnvironmentVariables environmentVariables,
java.util.List<? extends RequirementsTagProvider> requirementsTagProviders,
ReportNameProvider reportNameProvider,
java.lang.String overview)

RequirementsOutcomes

public RequirementsOutcomes(Requirement parentRequirement,
java.util.List<Requirement> requirements,
TestOutcomes testOutcomes,
IssueTracking issueTracking,
EnvironmentVariables environmentVariables,
java.util.List<? extends RequirementsTagProvider> requirementsTagProviders,
ReportNameProvider reportNameProvider,
java.lang.String overview)

Method Details

requirementOutcomeFor

public RequirementOutcome requirementOutcomeFor(Requirement requirement)

getRequirements

public java.util.List<Requirement> getRequirements()

requirementsOfType

public RequirementsOutcomes requirementsOfType(java.lang.String type)

ofType

public RequirementsOutcomes ofType(java.lang.String type)

getFlattenedRequirementCount

public int getFlattenedRequirementCount()

getParentRequirement

public java.util.Optional<Requirement> getParentRequirement()

getGrandparentRequirement

public java.util.Optional<Requirement> getGrandparentRequirement()

getRequirementCount

public int getRequirementCount()

getRequirementOutcomes

public java.util.List<RequirementOutcome> getRequirementOutcomes()

getType

public java.lang.String getType()

getChildrenType

public java.lang.String getChildrenType()

getTypes

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

getTestOutcomes

public TestOutcomes getTestOutcomes()

getTestResultForTestNamed

public java.util.Optional<TestResult> getTestResultForTestNamed(java.lang.String name)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getCompletedRequirementsCount

public int getCompletedRequirementsCount()

getUnsuccessfulRequirementsCount

public int getUnsuccessfulRequirementsCount()

getErrorRequirementsCount

public int getErrorRequirementsCount()

getFailingRequirementsCount

public int getFailingRequirementsCount()

getPendingRequirementsCount

public int getPendingRequirementsCount()

getCompromisedRequirementsCount

public int getCompromisedRequirementsCount()

getIgnoredRequirementsCount

public int getIgnoredRequirementsCount()

getSkippedRequirementsCount

public int getSkippedRequirementsCount()

getRequirementsWithoutTestsCount

public int getRequirementsWithoutTestsCount()

getTotalRequirements

public int getTotalRequirements()

getFlattenedRequirementOutcomes

public java.util.List<RequirementOutcome> getFlattenedRequirementOutcomes()

getLeafRequirementOutcomes

public java.util.List<RequirementOutcome> getLeafRequirementOutcomes()

geLeafRequirementOutcomes

public java.util.List<RequirementOutcome> geLeafRequirementOutcomes(java.util.List<RequirementOutcome> outcomes)

getFlattenedRequirementOutcomes

public java.util.List<RequirementOutcome> getFlattenedRequirementOutcomes(java.util.List<RequirementOutcome> outcomes)

getTotal

public OutcomeCounter getTotal()

count

public OutcomeCounter count(TestType testType)

count

public OutcomeCounter count(java.lang.String testType)

getTotalTestCount

public int getTotalTestCount()

getFormattedPercentage

public RequirementsPercentageFormatter getFormattedPercentage()

Returns:

Formatted version of the test coverage metrics

getFormattedPercentage

public RequirementsPercentageFormatter getFormattedPercentage(java.lang.String testType)

getFormattedPercentage

public RequirementsPercentageFormatter getFormattedPercentage(TestType testType)

getEstimatedUnimplementedTests

public int getEstimatedUnimplementedTests()

getProportion

public RequirementsProportionCounter getProportion()

proportionOf

public RequirementsProportionCounter proportionOf(java.lang.String testType)

proportionOf

public RequirementsProportionCounter proportionOf(TestType testType)

getReleasedRequirementsFor

public RequirementsOutcomes getReleasedRequirementsFor(Release release)

filteredByDisplayTag

public RequirementsOutcomes filteredByDisplayTag()

withoutUnrelatedRequirements

public RequirementsOutcomes withoutUnrelatedRequirements()

shouldPrune

public boolean shouldPrune(RequirementOutcome requirementOutcome)

getOverview

public java.lang.String getOverview()

getOutcomeFor

public java.util.Optional<RequirementOutcome> getOutcomeFor(Requirement requirement)