Package net.thucydides.core.requirements

Interface RequirementsTagProvider

All Superinterfaces:
TagProvider
All Known Implementing Classes:
FileSystemRequirementsTagProvider, PackageAnnotationBasedTagProvider, PackageRequirementsTagProvider
public interface RequirementsTagProvider
extends TagProvider
A requirements provider returns the set of application requirements in a tree structure. Requirements are mapped to test outcomes using tags: a test outcome satisfying a given requirement needs to be tagged with the name of this requirement. So an implementation of this interface needs to do two things: return a list of top-level requirements (usually with nested child requirements, e.g. capabilities and features), and provide a way to determine what requirement tags need to be associated with each test outcome. The requirements provider implementation also needs to be listed in the corresponding META-INF/services file.

  • Method Details

    • getRequirements

      java.util.List<Requirement> getRequirements()

    • getParentRequirementOf

      java.util.Optional<Requirement> getParentRequirementOf​(TestOutcome testOutcome)

    • getParentRequirementOf

      java.util.Optional<Requirement> getParentRequirementOf​(Requirement requirement)

    • getRequirementFor

      java.util.Optional<Requirement> getRequirementFor​(TestTag testTag)

    • getOverview

      default java.util.Optional<java.lang.String> getOverview()