io.devcon5.pageobjects

Class SeleniumContext

java.lang.Object

io.inkstand.scribble.rules.BaseRule<T>

io.inkstand.scribble.rules.ExternalResource

io.devcon5.pageobjects.SeleniumContext

All Implemented Interfaces:

org.junit.rules.TestRule

public class SeleniumContext
extends io.inkstand.scribble.rules.ExternalResource

Context for running selenium based tests. After initialization, the context is kept as a thread local so that PageObjects may access it to obtain the current state of the driver and test.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SeleniumContext.SeleniumContextBuilder Builder for creating a Selenium test context

Nested classes/interfaces inherited from class io.inkstand.scribble.rules.BaseRule

io.inkstand.scribble.rules.BaseRule.State

Constructor Summary

Constructors

Constructor and Description
SeleniumContext()

Method Summary

Modifier and Type	Method and Description
protected void	after()
protected void	before()
static SeleniumContext.SeleniumContextBuilder	builder() Creates a new context builder for fluent setup and instantiation.
static Optional<SeleniumContext>	currentContext() Returns the current context.
static Optional<org.openqa.selenium.WebDriver>	currentDriver() Returns the currentContext driver.
String	getBaseUrl() The base URL of the application to test
Optional<org.openqa.selenium.WebDriver>	getDriver() Returns the driver of this context.
Duration	getLoginTime() Returns the duration of the login process
boolean	isLoggedIn() Indicates if a user is logged in to the application
void	login(User user) Performs the login action with the specified user
void	logout() Performs the logout action
static String	resolve(String relativePath) Resolves the URL path relative to the base URL.

Methods inherited from class io.inkstand.scribble.rules.ExternalResource

afterClass, apply, beforeClass

Methods inherited from class io.inkstand.scribble.rules.BaseRule

assertStateAfterOrEqual, assertStateBefore, assertStateEquals, doStateTransition, getCurrentState, getOuterRule, isAfterState, isBeforeState, isInState

Methods inherited from class java.lang.Object

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

Constructor Detail

SeleniumContext

public SeleniumContext()

Method Detail

before

protected void before()
               throws Throwable

Overrides:

before in class io.inkstand.scribble.rules.ExternalResource

Throws:

Throwable

after

protected void after()

Overrides:

after in class io.inkstand.scribble.rules.ExternalResource

login

public final void login(User user)

Performs the login action with the specified user

Parameters:

user - the user to login

logout

public final void logout()

Performs the logout action

isLoggedIn

public boolean isLoggedIn()

Indicates if a user is logged in to the application

Returns:

getLoginTime

public Duration getLoginTime()

Returns the duration of the login process

Returns:

getDriver

public Optional<org.openqa.selenium.WebDriver> getDriver()

Returns the driver of this context.

Returns:

may be null if the test is not running.

getBaseUrl

public String getBaseUrl()

The base URL of the application to test

Returns:

the string representing the base URL. All relative URLs (i.e. in the page object model) must be relative to this page

currentContext

public static Optional<SeleniumContext> currentContext()

Returns the current context. The context is only available during test execution

Returns:

an Optional holding the current context.

resolve

public static String resolve(String relativePath)

Resolves the URL path relative to the base URL.

Parameters:

relativePath - the relative path within the application

Returns:

the absolute path of the application's base URL and the relative path

currentDriver

public static Optional<org.openqa.selenium.WebDriver> currentDriver()

Returns the currentContext driver. If this method is invoked outside of a test execution, the returned Optional is empty

Returns:

the optional of a driver

builder

public static SeleniumContext.SeleniumContextBuilder builder()

Creates a new context builder for fluent setup and instantiation.

Returns:

a new builder