Module com.serenitybdd.serenitymodel

Package net.thucydides.model.requirements

Class FileSystemRequirementsTagProvider

java.lang.Object

net.thucydides.model.requirements.AbstractRequirementsTagProvider

net.thucydides.model.requirements.FileSystemRequirementsTagProvider

All Implemented Interfaces:

CoreTagProvider, OverridableTagProvider, RequirementsTagProvider, TagProvider

public class FileSystemRequirementsTagProvider
extends AbstractRequirementsTagProvider
implements RequirementsTagProvider, OverridableTagProvider

Load a set of requirements (epics/themes,...) from the directory structure. This will typically be the directory structure containing the tests (for JUnit), stories (JBehave) or features (Cucumber).

Field Summary

Fields inherited from class net.thucydides.model.requirements.AbstractRequirementsTagProvider

environmentVariables, requirementsService, rootDirectory

Constructor Summary

Constructors

Constructor	Description
FileSystemRequirementsTagProvider()
FileSystemRequirementsTagProvider(String rootDirectory)
FileSystemRequirementsTagProvider(String rootDirectory, int level)
FileSystemRequirementsTagProvider(String rootDirectory, int level, EnvironmentVariables environmentVariables)
FileSystemRequirementsTagProvider(String topLevelDirectory, String rootDirectory, int level, EnvironmentVariables environmentVariables)
FileSystemRequirementsTagProvider(String rootDirectory, EnvironmentVariables environmentVariables)
FileSystemRequirementsTagProvider(EnvironmentVariables environmentVariables)
FileSystemRequirementsTagProvider(EnvironmentVariables environmentVariables, String rootDirectoryPath)

Method Summary

Modifier and Type	Method	Description
Requirement	findRequirementByTag(TestTag testTag)
Optional<String>	getOverview()
Optional<Requirement>	getParentRequirementOf(TestOutcome testOutcome)
Optional<Requirement>	getRequirementFor(TestTag testTag)
List<Requirement>	getRequirements()	We look for file system requirements in the root directory path (by default, 'stories').
Set<String>	getRootDirectoryPaths()	Find the root directory in the classpath or on the file system from which the requirements will be read.
Set<TestTag>	getTagsFor(TestOutcome testOutcome)	Returns the tags associated with a given test outcome.
Requirement	readRequirementFrom(File requirementDirectory)
Optional<Requirement>	readRequirementsFromStoryOrFeatureFile(File storyFile)
String	renderMarkdownWithoutTags(String text)

Methods inherited from class net.thucydides.model.requirements.AbstractRequirementsTagProvider

firstRequirementFoundIn, getDefaultRootDirectory, getDefaultType, getDefaultType, getParentRequirementOf, getRequirementTypes, getRequirementTypes, humanReadableVersionOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.thucydides.model.requirements.RequirementsTagProvider

addRequirementTagsTo, getParentRequirementOf

Constructor Details

FileSystemRequirementsTagProvider

public FileSystemRequirementsTagProvider(EnvironmentVariables environmentVariables)

FileSystemRequirementsTagProvider

public FileSystemRequirementsTagProvider(EnvironmentVariables environmentVariables,
 String rootDirectoryPath)

FileSystemRequirementsTagProvider

public FileSystemRequirementsTagProvider()

FileSystemRequirementsTagProvider

public FileSystemRequirementsTagProvider(String rootDirectory,
 int level)

FileSystemRequirementsTagProvider

public FileSystemRequirementsTagProvider(String rootDirectory,
 EnvironmentVariables environmentVariables)

FileSystemRequirementsTagProvider

public FileSystemRequirementsTagProvider(String rootDirectory,
 int level,
 EnvironmentVariables environmentVariables)

FileSystemRequirementsTagProvider

public FileSystemRequirementsTagProvider(String topLevelDirectory,
 String rootDirectory,
 int level,
 EnvironmentVariables environmentVariables)

FileSystemRequirementsTagProvider

public FileSystemRequirementsTagProvider(String rootDirectory)

Method Details

getRequirements

public List<Requirement> getRequirements()

We look for file system requirements in the root directory path (by default, 'stories'). First, we look on the classpath. If we don't find anything on the classpath (e.g. if the task is being run from the Maven plugin), we look in the src/main/resources and src/test/resources directories starting at the working directory.

Specified by:

getRequirements in interface RequirementsTagProvider

Specified by:

getRequirements in class AbstractRequirementsTagProvider

getRootDirectoryPaths

public Set<String> getRootDirectoryPaths()

Find the root directory in the classpath or on the file system from which the requirements will be read.

getTagsFor

public Set<TestTag> getTagsFor(TestOutcome testOutcome)

Description copied from interface: TagProvider

Returns the tags associated with a given test outcome.

Specified by:

getTagsFor in interface TagProvider

Parameters:

testOutcome - the outcome for a specific test

Returns:

the tags associated with a given test outcome.

getParentRequirementOf

public Optional<Requirement> getParentRequirementOf(TestOutcome testOutcome)

Specified by:

getParentRequirementOf in interface RequirementsTagProvider

getRequirementFor

public Optional<Requirement> getRequirementFor(TestTag testTag)

Specified by:

getRequirementFor in interface RequirementsTagProvider

findRequirementByTag

public Requirement findRequirementByTag(TestTag testTag)

renderMarkdownWithoutTags

public String renderMarkdownWithoutTags(String text)

readRequirementFrom

public Requirement readRequirementFrom(File requirementDirectory)

readRequirementsFromStoryOrFeatureFile

public Optional<Requirement> readRequirementsFromStoryOrFeatureFile(File storyFile)

getOverview

public Optional<String> getOverview()

Specified by:

getOverview in interface RequirementsTagProvider