uk.co.spicule.seleniumscripter

Class SeleniumScripter

java.lang.Object

uk.co.spicule.seleniumscripter.SeleniumScripter

public class SeleniumScripter
extends Object

Selenium Scripter, generate selenium scripts from YAML.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SeleniumScripter.StopIteration

Field Summary

Fields

Modifier and Type	Field and Description
static org.slf4j.Logger	LOG

Constructor Summary

Constructors

Constructor and Description
SeleniumScripter(org.openqa.selenium.WebDriver driver)
SeleniumScripter(org.openqa.selenium.WebDriver driver, boolean DEV_MODE)

Method Summary

Modifier and Type	Method and Description
void	dumpStackOperation(Map<String,Object> script) DEV TOOL Dumps the stack of snapshots to a directory, creating a `.html` file for each entry in the stack in the target directory
String	getElementXPath(org.openqa.selenium.WebElement element) Fetch the absolute (unoptimized) xpath of a specified web element.
Map<String,String>	getSnapshots() Return the snapshots stack.
void	runScript(Map<String,Object> script) Run a selenium script.
void	screenshotOperation(Map<String,Object> script) Take a screenshot (rasterize image) of the current page.
void	setOutputPath(String path) Set the path to the directory where operations like `screenshot` and `dumpstack` will start at when determining their file output paths
static List	slice(String slice, List list) Slice an array into a sublist
static String	version()

Methods inherited from class java.lang.Object

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

Field Detail

LOG

public static final org.slf4j.Logger LOG

Constructor Detail

SeleniumScripter

public SeleniumScripter(org.openqa.selenium.WebDriver driver)

SeleniumScripter

public SeleniumScripter(org.openqa.selenium.WebDriver driver,
                        boolean DEV_MODE)

Method Detail

version

public static final String version()

slice

public static List slice(String slice,
                         List list)
                  throws ParseException

Slice an array into a sublist

Parameters:

slice - the slice string which must conform to the pattern `^-{0,1}[0-9]+:-{0,1}[0-9]+$`

list - the list to slice

Returns:

List the sliced list

Throws:

ParseException - occurs when an invalid slice string is specified

getElementXPath

public String getElementXPath(org.openqa.selenium.WebElement element)

Fetch the absolute (unoptimized) xpath of a specified web element.

Parameters:

element - the web element to fetch the path of

Returns:

String the full web element xpath

runScript

public void runScript(Map<String,Object> script)
               throws IOException,
                      AttributeNotFoundException,
                      ParseException,
                      InterruptedException,
                      SeleniumScripter.StopIteration

Run a selenium script.

Parameters:

script - the serialized selenium script

Throws:

IOException - occurs when a snapshot image failed to save to disk

AttributeNotFoundException - occurs when an attribute on a selected element does not exist

ParseException - occurs when one or more required fields are missing or an invalid value is specified

IOException - occurs when screenshots failed to write to persistence

AttributeNotFoundException - occurs when an invalid element attribute is specified

ParseException - occurs when the token parsing fails to complete

InterruptedException - occurs when the process wakes up from a sleep event in a child-instruction

SeleniumScripter.StopIteration - occurs when a break statement is called outside of a loop

setOutputPath

public void setOutputPath(String path)

Set the path to the directory where operations like `screenshot` and `dumpstack` will start at when determining their file output paths

Parameters:

path - the base path to start with

screenshotOperation

public void screenshotOperation(Map<String,Object> script)
                         throws IOException,
                                ParseException

Take a screenshot (rasterize image) of the current page.

Parameters:

script - the screenshot subscript operation

Throws:

IOException - occurs when a screenshot image fails to write to persistence

ParseException - occurs when the tokens failed to parse

dumpStackOperation

public void dumpStackOperation(Map<String,Object> script)
                        throws ParseException,
                               IOException

DEV TOOL Dumps the stack of snapshots to a directory, creating a `.html` file for each entry in the stack in the target directory

Parameters:

script - the dumpscript subscript operation

Throws:

ParseException - occurs when the tokens failed to parse

IOException - occurs when the snapshots failed to write to persistence

getSnapshots

public final Map<String,String> getSnapshots()

Return the snapshots stack.

Returns:

List the list of paths to snapshot images taken