net.serenitybdd.core

Class Serenity

java.lang.Object

net.serenitybdd.core.Serenity

public class Serenity
extends java.lang.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	done() Indicate that the test run using this object is finished, and reports can be generated.
static void	done(boolean closeAllDrivers)
static SessionMap<java.lang.Object,java.lang.Object>	getCurrentSession()
static java.lang.String	getCurrentSessionID()
static java.lang.String	getDefaultProjectKey()
static org.openqa.selenium.firefox.FirefoxProfile	getFirefoxProfile()
static Pages	getPagesFactory()
static StepFactory	getStepFactory()
static StepListener	getStepListener()
static void	ignoredStep(java.lang.String reason)
static void	initialize(java.lang.Object testCase) Initialize Serenity-related fields in the specified object.
static void	initializeTestSession()
static Serenity.SerenityConfigurer	initializeWithNoStepListener(java.lang.Object testCase) Initialize Serenity-related fields in the specified object.
static void	injectScenarioStepsInto(java.lang.Object testCase) Instantiates the @ManagedPages-annotated Pages instance using current WebDriver.
static void	pendingStep(java.lang.String reason)
static java.lang.Object	sessionVariableCalled(java.lang.Object key)
static Serenity.SessionVariableSetter	setSessionVariable(java.lang.Object key)
static boolean	shouldThrowErrorsImmediately()
static void	takeScreenshot()
static void	throwExceptionsImmediately()
static void	useFirefoxProfile(org.openqa.selenium.firefox.FirefoxProfile profile)

Methods inherited from class java.lang.Object

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

Constructor Detail

Serenity

public Serenity()

Method Detail

initialize

public static void initialize(java.lang.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

initializeWithNoStepListener

public static Serenity.SerenityConfigurer initializeWithNoStepListener(java.lang.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

injectScenarioStepsInto

public static void injectScenarioStepsInto(java.lang.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.

done

public static void done(boolean closeAllDrivers)

getCurrentSessionID

public static java.lang.String getCurrentSessionID()

getStepFactory

public static StepFactory getStepFactory()

getStepListener

public static StepListener getStepListener()

initializeTestSession

public static void initializeTestSession()

getCurrentSession

public static SessionMap<java.lang.Object,java.lang.Object> getCurrentSession()

pendingStep

public static void pendingStep(java.lang.String reason)

ignoredStep

public static void ignoredStep(java.lang.String reason)

takeScreenshot

public static void takeScreenshot()

getDefaultProjectKey

public static java.lang.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()

sessionVariableCalled

public static java.lang.Object sessionVariableCalled(java.lang.Object key)

setSessionVariable

public static Serenity.SessionVariableSetter setSessionVariable(java.lang.Object key)

getPagesFactory

public static Pages getPagesFactory()

throwExceptionsImmediately

public static void throwExceptionsImmediately()

shouldThrowErrorsImmediately

public static boolean shouldThrowErrorsImmediately()