Module com.serenitybdd.serenitymodel

Package net.thucydides.model.requirements

Class RootDirectory

java.lang.Object

net.thucydides.model.requirements.RootDirectory

public class RootDirectory
extends Object

Find the root directory of the requirements hierarchy when using Cucumber or JBehave. This is normally src/test/resources/features or src/test/resources/stories. For multi-module projects, it can be a directory with this name in one of the modules. There should only be one requirements directory in a multi-module project. The easiest approach is to have a dedicated module for the acceptance tests.

You can hard-code this directory using serenity.requirements.dir. Milage may vary for multi-module projects. If you need to override the root directory (e.g. to use src/test/resources/myFeatures), a better way is to set the serenity.features.directory (for Cucumber) or serenity.stories.directory (for JBehave) property to the simple name of the directory (e.g. serenity.features.directory=myFeatures).

Method Summary

Modifier and Type	Method	Description
static RootDirectory	definedIn(EnvironmentVariables environmentVariables)
String	featureDirectoryName()
Optional<Path>	featuresOrStoriesRootDirectory()
Set<String>	getRootDirectoryPaths()	Find the root directory in the classpath or on the file system from which the requirements will be read.
Set<String>	requirementsDirectoryNames()
String	storyDirectoryName()

Methods inherited from class java.lang.Object

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

Method Details

requirementsDirectoryNames

public Set<String> requirementsDirectoryNames()

definedIn

public static RootDirectory definedIn(EnvironmentVariables environmentVariables)

getRootDirectoryPaths

public Set<String> getRootDirectoryPaths()

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

featureDirectoryName

public String featureDirectoryName()

storyDirectoryName

public String storyDirectoryName()

featuresOrStoriesRootDirectory

public Optional<Path> featuresOrStoriesRootDirectory()