net.thucydides.core.requirements

Class FileSystemRequirementsTagProvider

java.lang.Object

net.thucydides.core.requirements.AbstractRequirementsTagProvider

net.thucydides.core.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) or stories (e.g. for JBehave). By default, the tests

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FEATURE_EXTENSION
static java.lang.String	STORY_EXTENSION

Constructor Summary

Constructors

Constructor and Description
FileSystemRequirementsTagProvider()
FileSystemRequirementsTagProvider(java.lang.String rootDirectory)
FileSystemRequirementsTagProvider(java.lang.String rootDirectory, int level)
FileSystemRequirementsTagProvider(java.lang.String rootDirectory, int level, EnvironmentVariables environmentVariables)

Method Summary

Modifier and Type	Method and Description
static java.lang.String	defaultRootDirectoryPathFrom(EnvironmentVariables environmentVariables)
com.google.common.base.Optional<Requirement>	getParentRequirementOf(TestOutcome testOutcome)
com.google.common.base.Optional<Requirement>	getRequirementFor(TestTag testTag)
java.util.List<Requirement>	getRequirements() We look for file system requirements in the root directory path (by default, 'stories').
static com.google.common.base.Optional<java.lang.String>	getResourceDirectory(EnvironmentVariables environmentVariables)
java.util.Set<java.lang.String>	getRootDirectoryPaths() Find the root directory in the classpath or on the file system from which the requirements will be read.
java.util.Set<TestTag>	getTagsFor(TestOutcome testOutcome) Returns the tags associated with a given test outcome.

Methods inherited from class java.lang.Object

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

Field Detail

STORY_EXTENSION

public static final java.lang.String STORY_EXTENSION

See Also:

Constant Field Values

FEATURE_EXTENSION

public static final java.lang.String FEATURE_EXTENSION

See Also:

Constant Field Values

Constructor Detail

FileSystemRequirementsTagProvider

public FileSystemRequirementsTagProvider()

FileSystemRequirementsTagProvider

public FileSystemRequirementsTagProvider(java.lang.String rootDirectory,
                                         int level)

FileSystemRequirementsTagProvider

public FileSystemRequirementsTagProvider(java.lang.String rootDirectory,
                                         int level,
                                         EnvironmentVariables environmentVariables)

FileSystemRequirementsTagProvider

public FileSystemRequirementsTagProvider(java.lang.String rootDirectory)

Method Detail

defaultRootDirectoryPathFrom

public static java.lang.String defaultRootDirectoryPathFrom(EnvironmentVariables environmentVariables)

getRequirements

public java.util.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

getRootDirectoryPaths

public java.util.Set<java.lang.String> getRootDirectoryPaths()
                                                      throws java.io.IOException

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

Throws:

java.io.IOException

getTagsFor

public java.util.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 com.google.common.base.Optional<Requirement> getParentRequirementOf(TestOutcome testOutcome)

Specified by:

getParentRequirementOf in interface RequirementsTagProvider

getRequirementFor

public com.google.common.base.Optional<Requirement> getRequirementFor(TestTag testTag)

Specified by:

getRequirementFor in interface RequirementsTagProvider

getResourceDirectory

public static com.google.common.base.Optional<java.lang.String> getResourceDirectory(EnvironmentVariables environmentVariables)