net.serenitybdd.core

Class Serenity

java.lang.Object

net.serenitybdd.core.Serenity

public class Serenity
extends Object

A utility class that provides services to initialize web testing and reporting-related fields in arbitrary objects. It is designed to help integrate Serenity into other testing tools such as Cucumber.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Serenity.SerenityConfigurer
static class	Serenity.SessionVariableSetter

Constructor Summary

Constructors

Constructor and Description
Serenity()

Method Summary

Modifier and Type	Method and Description
static void	clearCurrentSession()
static void	clearSessionVariable(String key)
static boolean	currentDriverIsDisabled()
static void	done() Indicate that the test run using this object is finished, and reports can be generated.
static void	done(boolean closeAllDrivers)
static SessionMap<Object,Object>	getCurrentSession()
static String	getCurrentSessionID()
static String	getDefaultProjectKey()
static org.openqa.selenium.WebDriver	getDriver()
static org.openqa.selenium.firefox.FirefoxProfile	getFirefoxProfile()
protected static Pages	getPages()
static Pages	getPagesFactory()
static StepFactory	getStepFactory()
static StepListener	getStepListener()
static WebdriverManager	getWebdriverManager()
static boolean	hasASessionVariableCalled(Object key)
static void	ignoredStep(String reason)
static void	initialize(Object testCase) Initialize Serenity-related fields in the specified object.
static void	initializeTestSession()
static Serenity.SerenityConfigurer	initializeWithNoStepListener(Object testCase) Initialize Serenity-related fields in the specified object.
static void	initStepListener()
static void	injectAnnotatedPagesObjectInto(Object testCase) Instantiates the @ManagedPages-annotated Pages instance using current WebDriver.
static void	injectDependenciesInto(Object testCase)
static void	injectDriverInto(Object testCase) Instantiate the @Managed-annotated WebDriver instance with current WebDriver.
static void	injectScenarioStepsInto(Object testCase) Instantiates the @ManagedPages-annotated Pages instance using current WebDriver.
static void	pendingStep(String reason)
static WithTitle	recordReportData()
static void	reportThat(String message, Reportable reportableAction) Perform an arbitrary task and record it as a step in the reports.
static <T> T	sessionVariableCalled(Object key)
static Serenity.SessionVariableSetter	setSessionVariable(Object key)
static boolean	shouldThrowErrorsImmediately()
protected static void	stopUsingMockDriver()
static void	takeScreenshot()
static void	throwExceptionsImmediately()
static void	useFirefoxProfile(org.openqa.selenium.firefox.FirefoxProfile profile)
static WebDriverConfigurer	webdriver()

Methods inherited from class java.lang.Object

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

Constructor Detail

Serenity

public Serenity()

Method Detail

initialize

public static void initialize(Object testCase)

Initialize Serenity-related fields in the specified object. This includes managed WebDriver instances,

Parameters:

testCase - any object (testcase or other) containing injectable Serenity components

injectDependenciesInto

public static void injectDependenciesInto(Object testCase)

initializeWithNoStepListener

public static Serenity.SerenityConfigurer initializeWithNoStepListener(Object testCase)

Initialize Serenity-related fields in the specified object. This includes managed WebDriver instances,

Parameters:

testCase - any object (testcase or other) containing injectable Serenity components

initStepListener

public static void initStepListener()

injectDriverInto

public static void injectDriverInto(Object testCase)

Instantiate the @Managed-annotated WebDriver instance with current WebDriver.

Parameters:

testCase - any object (testcase or other) containing injectable Serenity components

injectScenarioStepsInto

public static void injectScenarioStepsInto(Object testCase)

Instantiates the @ManagedPages-annotated Pages instance using current WebDriver.

Parameters:

testCase - any object (testcase or other) containing injectable Serenity components

injectAnnotatedPagesObjectInto

public static void injectAnnotatedPagesObjectInto(Object testCase)

Instantiates the @ManagedPages-annotated Pages instance using current WebDriver.

Parameters:

testCase - any object (testcase or other) containing injectable Serenity components

done

public static void done()

Indicate that the test run using this object is finished, and reports can be generated.

currentDriverIsDisabled

public static boolean currentDriverIsDisabled()

done

public static void done(boolean closeAllDrivers)

getCurrentSessionID

public static String getCurrentSessionID()

getDriver

public static org.openqa.selenium.WebDriver getDriver()

getPages

protected static Pages getPages()

stopUsingMockDriver

protected static void stopUsingMockDriver()

getWebdriverManager

public static WebdriverManager getWebdriverManager()

getStepFactory

public static StepFactory getStepFactory()

getStepListener

public static StepListener getStepListener()

initializeTestSession

public static void initializeTestSession()

getCurrentSession

public static SessionMap<Object,Object> getCurrentSession()

pendingStep

public static void pendingStep(String reason)

ignoredStep

public static void ignoredStep(String reason)

takeScreenshot

public static void takeScreenshot()

recordReportData

public static WithTitle recordReportData()

getDefaultProjectKey

public static String getDefaultProjectKey()

Returns:

The current working directory name is used as a default project key if no other key is provided.

useFirefoxProfile

public static void useFirefoxProfile(org.openqa.selenium.firefox.FirefoxProfile profile)

getFirefoxProfile

public static org.openqa.selenium.firefox.FirefoxProfile getFirefoxProfile()

hasASessionVariableCalled

public static boolean hasASessionVariableCalled(Object key)

sessionVariableCalled

public static <T> T sessionVariableCalled(Object key)

setSessionVariable

public static Serenity.SessionVariableSetter setSessionVariable(Object key)

clearSessionVariable

public static void clearSessionVariable(String key)

clearCurrentSession

public static void clearCurrentSession()

getPagesFactory

public static Pages getPagesFactory()

throwExceptionsImmediately

public static void throwExceptionsImmediately()

shouldThrowErrorsImmediately

public static boolean shouldThrowErrorsImmediately()

webdriver

public static WebDriverConfigurer webdriver()

reportThat

public static void reportThat(String message,
                              Reportable reportableAction)

Perform an arbitrary task and record it as a step in the reports. Any exceptions that occur will be reported and thrown

Parameters:

message -

reportableAction -