Package ch.rswk.util.web.test

Class AbstractWebDriver

java.lang.Object

ch.rswk.util.web.test.AbstractWebDriver

Direct Known Subclasses:

WebDriverTest, WebDriverTest, WebDriverTest

public abstract class AbstractWebDriver
extends Object

AbstractWebDriver contains common setup and utility functions for Selenium WebDrvier based testing, using Chrome and Firefox browsers.

See ChromeDriver and GeckoDriver.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractWebDriver.NukeServlet
protected static final record	AbstractWebDriver.QunitResult

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	ANCHOR_LINK_SELECTOR_FORMAT
private static final String	CHROME_DIR
private static final String	CHROME_DRIVER
private static final String	CHROME_DRIVER_NIX
private static final String	CHROME_DRIVER_WIN
private static final String	CHROME_NIX
private static final String	CHROME_WIN
private static final String	CLOSE_BUTTON_SELECTOR
private static final String	CONFIG_OVERRIDE_QUERY_PARAM
static final Duration	DEFAULT_TIMEOUT
static final org.openqa.selenium.Dimension	DESKTOP_DIMENSIONS
static final String	DRIVER_CHROME
static final String	DRIVER_FIREFOX
protected static Map<String,org.openqa.selenium.WebDriver>	drivers
private static final String	ELEMENT_CLICK_JS
private static final String	FIREFOX_DIR
private static final String	FIREFOX_DRIVER
private static final String	FIREFOX_DRIVER_NIX
private static final String	FIREFOX_DRIVER_WIN
private static final String	FIREFOX_NIX
private static final String	FIREFOX_WIN
private static final String	FORM_INVALID_SELECTOR_FORMAT
private static final String	HEADLESS_OPTION_VAR
private static final org.slf4j.Logger	LOG
static final org.openqa.selenium.Dimension	MOBILE_DIMENSIONS
static final String	NUKE_PATH
private static final String	POST_MESSAGE_FORMAT
private static final String	QUNIT_FAIL_SCREENSHOT_FORMAT
static final String	QUNIT_HTML
private static final String	REMOTE_OPTION_VAR
private static final String	SCREENSHOT_PATH_FORMAT
private static final String	SUBMIT_BUTTON_SELECTOR_FORMAT
static final org.openqa.selenium.Dimension	TABLET_DIMENSIONS
private static final String	TOOL_DIR

Constructor Summary

Constructors

Constructor	Description
AbstractWebDriver()

Method Summary

Modifier and Type	Method	Description
protected static org.openqa.selenium.By	byAnchorLink(String href)
protected static void	clickElement(org.openqa.selenium.WebDriver driver, org.openqa.selenium.WebElement element)
protected static void	clickVisibleCloseButtons(org.openqa.selenium.WebDriver driver)
protected static void	executeScript(org.openqa.selenium.WebDriver driver, String js, Object... args)
protected static void	executeScriptAsync(org.openqa.selenium.WebDriver driver, String js, Object... args)
protected static org.openqa.selenium.WebElement	findSubmitButton(org.openqa.selenium.WebDriver driver, String formId)
protected static org.openqa.selenium.chrome.ChromeOptions	forgeChromeOptions()
protected static org.openqa.selenium.chrome.ChromeOptions	forgeChromeRemoteOptions()
protected static org.openqa.selenium.firefox.FirefoxOptions	forgeFirefoxOptions()
protected static org.openqa.selenium.firefox.FirefoxOptions	forgeFirefoxRemoteOptions()
protected static String	getConfigOverrideQueryParam(com.fasterxml.jackson.databind.JsonNode config)
protected static String	getInputValue(org.openqa.selenium.WebDriver driver, String inputId)
protected static String	getNukeUrl(String url)
protected String	getPostMessageOrigin()
protected static Path	getScreenshotPath(org.openqa.selenium.WebDriver driver, String name)
protected static void	navigateToAnchorLink(org.openqa.selenium.WebDriver driver, String href, org.openqa.selenium.support.ui.FluentWait<org.openqa.selenium.WebDriver> wait)
protected static void	navigateToComponent(String component, org.openqa.selenium.WebDriver driver, org.openqa.selenium.support.ui.FluentWait<org.openqa.selenium.WebDriver> wait)
protected static org.openqa.selenium.chrome.ChromeDriver	newChromeDriver(org.openqa.selenium.chrome.ChromeOptions options)
protected static org.openqa.selenium.firefox.FirefoxDriver	newFirefoxDriver(org.openqa.selenium.firefox.FirefoxOptions options)
protected static org.openqa.selenium.support.ui.FluentWait<org.openqa.selenium.WebDriver>	newFluentWait(org.openqa.selenium.WebDriver driver, Duration timeout)
protected static org.openqa.selenium.By	newInvalidInputSelector(String formId)
protected void	qunit(int noOfAssertions, String driverName, @Nullable Duration timeout, String url)
protected static void	runAndAssertQunit(org.openqa.selenium.WebDriver driver, int expectedAssertions, Duration timeout, String url)
protected static AbstractWebDriver.QunitResult	runQunit(org.openqa.selenium.WebDriver driver, int expectedAssertions, Duration timeout)
protected void	runUiTest(org.openqa.selenium.WebDriver driver, Callable<Void> test, String url, @Nullable org.openqa.selenium.Dimension windowSize)
protected static void	scrollTo(org.openqa.selenium.WebDriver driver, org.openqa.selenium.WebElement element)
protected static void	setScriptTimeout(org.openqa.selenium.WebDriver driver, Duration timeout)
static void	setupDrivers()
protected static void	takeQunitFailedScreenshots(org.openqa.selenium.WebDriver driver, AbstractWebDriver.QunitResult result)
protected static void	takeScreenshot(org.openqa.selenium.WebDriver driver, String name)
static void	teardownDrivers()
protected void	windowPost(org.openqa.selenium.WebDriver driver, String jsObject)

Methods inherited from class java.lang.Object

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

Field Details

LOG

private static final org.slf4j.Logger LOG

DEFAULT_TIMEOUT

public static final Duration DEFAULT_TIMEOUT

DESKTOP_DIMENSIONS

public static final org.openqa.selenium.Dimension DESKTOP_DIMENSIONS

DRIVER_CHROME

public static final String DRIVER_CHROME

See Also:

• Constant Field Values

DRIVER_FIREFOX

public static final String DRIVER_FIREFOX

See Also:

• Constant Field Values

MOBILE_DIMENSIONS

public static final org.openqa.selenium.Dimension MOBILE_DIMENSIONS

NUKE_PATH

public static final String NUKE_PATH

See Also:

• Constant Field Values

QUNIT_HTML

public static final String QUNIT_HTML

See Also:

• Constant Field Values

TABLET_DIMENSIONS

public static final org.openqa.selenium.Dimension TABLET_DIMENSIONS

ANCHOR_LINK_SELECTOR_FORMAT

private static final String ANCHOR_LINK_SELECTOR_FORMAT

See Also:

• Constant Field Values

CHROME_DRIVER_NIX

private static final String CHROME_DRIVER_NIX

See Also:

• Constant Field Values

CHROME_DRIVER_WIN

private static final String CHROME_DRIVER_WIN

See Also:

• Constant Field Values

CHROME_NIX

private static final String CHROME_NIX

See Also:

• Constant Field Values

CHROME_WIN

private static final String CHROME_WIN

See Also:

• Constant Field Values

CLOSE_BUTTON_SELECTOR

private static final String CLOSE_BUTTON_SELECTOR

See Also:

• Constant Field Values

CONFIG_OVERRIDE_QUERY_PARAM

private static final String CONFIG_OVERRIDE_QUERY_PARAM

See Also:

• Constant Field Values

ELEMENT_CLICK_JS

private static final String ELEMENT_CLICK_JS

See Also:

• Constant Field Values

FIREFOX_DRIVER_NIX

private static final String FIREFOX_DRIVER_NIX

See Also:

• Constant Field Values

FIREFOX_DRIVER_WIN

private static final String FIREFOX_DRIVER_WIN

See Also:

• Constant Field Values

FIREFOX_NIX

private static final String FIREFOX_NIX

See Also:

• Constant Field Values

FIREFOX_WIN

private static final String FIREFOX_WIN

See Also:

• Constant Field Values

FORM_INVALID_SELECTOR_FORMAT

private static final String FORM_INVALID_SELECTOR_FORMAT

See Also:

• Constant Field Values

HEADLESS_OPTION_VAR

private static final String HEADLESS_OPTION_VAR

See Also:

• Constant Field Values

POST_MESSAGE_FORMAT

private static final String POST_MESSAGE_FORMAT

See Also:

• Constant Field Values

QUNIT_FAIL_SCREENSHOT_FORMAT

private static final String QUNIT_FAIL_SCREENSHOT_FORMAT

See Also:

• Constant Field Values

REMOTE_OPTION_VAR

private static final String REMOTE_OPTION_VAR

See Also:

• Constant Field Values

SCREENSHOT_PATH_FORMAT

private static final String SCREENSHOT_PATH_FORMAT

See Also:

• Constant Field Values

SUBMIT_BUTTON_SELECTOR_FORMAT

private static final String SUBMIT_BUTTON_SELECTOR_FORMAT

See Also:

• Constant Field Values

TOOL_DIR

private static final String TOOL_DIR

CHROME_DIR

private static final String CHROME_DIR

FIREFOX_DIR

private static final String FIREFOX_DIR

CHROME_DRIVER

private static final String CHROME_DRIVER

FIREFOX_DRIVER

private static final String FIREFOX_DRIVER

drivers

protected static Map<String,org.openqa.selenium.WebDriver> drivers

Constructor Details

AbstractWebDriver

public AbstractWebDriver()

Method Details

setupDrivers

@BeforeAll
public static void setupDrivers()

forgeChromeRemoteOptions

protected static org.openqa.selenium.chrome.ChromeOptions forgeChromeRemoteOptions()

forgeFirefoxRemoteOptions

protected static org.openqa.selenium.firefox.FirefoxOptions forgeFirefoxRemoteOptions()

newChromeDriver

protected static org.openqa.selenium.chrome.ChromeDriver newChromeDriver(org.openqa.selenium.chrome.ChromeOptions options)

forgeChromeOptions

protected static org.openqa.selenium.chrome.ChromeOptions forgeChromeOptions()

newFirefoxDriver

protected static org.openqa.selenium.firefox.FirefoxDriver newFirefoxDriver(org.openqa.selenium.firefox.FirefoxOptions options)

forgeFirefoxOptions

protected static org.openqa.selenium.firefox.FirefoxOptions forgeFirefoxOptions()

teardownDrivers

@AfterAll
public static void teardownDrivers()

qunit

protected void qunit(int noOfAssertions,
 String driverName,
 @Nullable Duration timeout,
 String url)

runAndAssertQunit

protected static void runAndAssertQunit(org.openqa.selenium.WebDriver driver,
 int expectedAssertions,
 Duration timeout,
 String url)

takeQunitFailedScreenshots

protected static void takeQunitFailedScreenshots(org.openqa.selenium.WebDriver driver,
 AbstractWebDriver.QunitResult result)

runQunit

protected static AbstractWebDriver.QunitResult runQunit(org.openqa.selenium.WebDriver driver,
 int expectedAssertions,
 Duration timeout)

runUiTest

protected void runUiTest(org.openqa.selenium.WebDriver driver,
 Callable<Void> test,
 String url,
 @Nullable org.openqa.selenium.Dimension windowSize)

getNukeUrl

protected static String getNukeUrl(String url)

getConfigOverrideQueryParam

protected static String getConfigOverrideQueryParam(com.fasterxml.jackson.databind.JsonNode config)
                                             throws IOException

Throws:

IOException

newFluentWait

protected static org.openqa.selenium.support.ui.FluentWait<org.openqa.selenium.WebDriver> newFluentWait(org.openqa.selenium.WebDriver driver,
 Duration timeout)

windowPost

protected void windowPost(org.openqa.selenium.WebDriver driver,
 String jsObject)

getPostMessageOrigin

protected String getPostMessageOrigin()

clickElement

protected static void clickElement(org.openqa.selenium.WebDriver driver,
 org.openqa.selenium.WebElement element)

clickVisibleCloseButtons

protected static void clickVisibleCloseButtons(org.openqa.selenium.WebDriver driver)

findSubmitButton

protected static org.openqa.selenium.WebElement findSubmitButton(org.openqa.selenium.WebDriver driver,
 String formId)

getInputValue

protected static String getInputValue(org.openqa.selenium.WebDriver driver,
 String inputId)

navigateToAnchorLink

protected static void navigateToAnchorLink(org.openqa.selenium.WebDriver driver,
 String href,
 org.openqa.selenium.support.ui.FluentWait<org.openqa.selenium.WebDriver> wait)

byAnchorLink

protected static org.openqa.selenium.By byAnchorLink(String href)

navigateToComponent

protected static void navigateToComponent(String component,
 org.openqa.selenium.WebDriver driver,
 org.openqa.selenium.support.ui.FluentWait<org.openqa.selenium.WebDriver> wait)

newInvalidInputSelector

protected static org.openqa.selenium.By newInvalidInputSelector(String formId)

scrollTo

protected static void scrollTo(org.openqa.selenium.WebDriver driver,
 org.openqa.selenium.WebElement element)

setScriptTimeout

protected static void setScriptTimeout(org.openqa.selenium.WebDriver driver,
 Duration timeout)

takeScreenshot

protected static void takeScreenshot(org.openqa.selenium.WebDriver driver,
 String name)

getScreenshotPath

protected static Path getScreenshotPath(org.openqa.selenium.WebDriver driver,
 String name)

executeScript

protected static void executeScript(org.openqa.selenium.WebDriver driver,
 String js,
 Object... args)

executeScriptAsync

protected static void executeScriptAsync(org.openqa.selenium.WebDriver driver,
 String js,
 Object... args)