jp.vmi.selenium.selenese

Class Runner

java.lang.Object

jp.vmi.selenium.selenese.Runner

All Implemented Interfaces:

HtmlResultHolder, JUnitResultHolder, Context, HighlightHandler, ScreenshotHandler, org.openqa.selenium.internal.WrapsDriver

public class Runner
extends Object
implements Context, ScreenshotHandler, HighlightHandler, JUnitResultHolder, HtmlResultHolder

Provide Java API to run Selenese script.

Constructor Summary

Constructors

Constructor and Description
Runner() Constructor.

Method Summary

Modifier and Type	Method and Description
Result	execute(Selenese selenese) Execute test-suite / test-case.
void	finish() Finish test.
String	getBaseURL() Deprecated.
CollectionMap	getCollectionMap() Get collection map.
CommandFactory	getCommandFactory() Get CommandFactory instance.
CommandListIterator	getCommandListIterator() Get current CommandListIterator.
CookieFilter	getCookieFilter() Get cookie filter.
String	getCurrentBaseURL() Get current base URL.
TestCase	getCurrentTestCase() Get current test-case.
org.openqa.selenium.WebDriver	getDriver() Deprecated.
WebDriverElementFinder	getElementFinder() Get elemnt finder.
Eval	getEval() Get evaluater.
HtmlResult	getHtmlResult() Get HTML result instance.
long	getInitialSpeed() Get initial speed at starting test-suite.
String	getInitialWindowHandle() Get initial window handle.
JUnitResult	getJUnitResult() Get JUnit result instance.
PageInformation	getLatestPageInformation() Get latest page information.
String	getOverridingBaseURL() Get base URL for overriding test-case base URL.
PrintStream	getPrintStream() Get PrintStream for logging.
RollupRules	getRollupRules() Get rollup rules.
long	getSpeed() Get speed for setSpeed command.
SubCommandMap	getSubCommandMap() Get SubCommandMap instance.
int	getTimeout() Get timeout for waiting.
VarsMap	getVarsMap() Get variables map.
org.openqa.selenium.WebDriver	getWrappedDriver()
void	highlight(String locator, HighlightStyle highlightStyle) Highlight and backup specified locator.
boolean	isHighlight() Get locator highlighting.
boolean	isIgnoredScreenshotCommand() Get ignore screenshot command flag.
boolean	isIgnoreScreenshotCommand() Deprecated. use isIgnoredScreenshotCommand()
boolean	isTrue(String expr) Get boolean value of expr.
void	popCommandListIterator() Pop CommandListIterator.
void	prepareWebDriver() Prepare WebDriver.
void	pushCommandListIterator(CommandListIterator commandListIterator) Push CommandListIterator.
void	resetSpeed() Reset speed as initial speed.
Result	run(String... filenames) Run Selenese script files.
Result	run(String filename, InputStream is) Run Selenese script from input stream.
void	setBaseURL(String baseURL) Deprecated. Replaced by setOverridingBaseURL(String)
void	setCookieFilter(CookieFilter cookieFilter) Set cookie filter.
void	setCurrentTestCase(TestCase currentTestCase) Set current test-case.
void	setDriver(org.openqa.selenium.WebDriver driver) Set WebDriver.
void	setHighlight(boolean isHighlight) Set locator highlighting.
void	setHtmlResultDir(String dir) Initialize HTMLResult.
void	setIgnoredScreenshotCommand(boolean isIgnoredScreenshotCommand) Set ignore screenshot command flag.
void	setIgnoreScreenshotCommand(boolean isIgnoredScreenshotCommand) Deprecated. use setIgnoredScreenshotCommand(boolean)
void	setInitialSpeed(long initialSpeed) Set initial speed at starting test-suite.
void	setJUnitResultDir(String dir) Initialize JUnitResult.
void	setLatestPageInformation(PageInformation pageInformation) Set latest page information.
void	setOverridingBaseURL(String overridingBaseURL) Set URL for overriding test-case base URL.
void	setPrintStream(PrintStream ps) Set PrintStream for logging.
void	setScreenshotAllDir(String screenshotAllDir) Set directory for storing screenshots at all commands.
void	setScreenshotDir(String screenshotDir) Set directory for storing screenshots.
void	setScreenshotOnFailDir(String screenshotOnFailDir) Set directory for storing screenshot on fail.
void	setSpeed(long speed) Set speed for setSpeed command.
void	setTimeout(int timeout) Set timeout for waiting.
void	setVarsMap(VarsMap varsMap) Set variables map used for this session.
void	setWebDriverPreparator(WebDriverPreparator preparator) Set WebDriverPreparator.
String	takeScreenshot(String filename) Take screenshot to filename.
String	takeScreenshotAll(String prefix, int index) Take screenshot at all commands if --screenshot-all option specified.
String	takeScreenshotOnFail(String prefix, int index) Take screenshot on fail commands if --screenshot-on-fail option specified.
void	unhighlight() Unhighlight backed up styles.
void	waitSpeed() Wait according to speed setting.

Methods inherited from class java.lang.Object

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

Constructor Detail

Runner

public Runner()

Constructor.

Method Detail

getCurrentTestCase

public TestCase getCurrentTestCase()

Description copied from interface: Context

Get current test-case.

Specified by:

getCurrentTestCase in interface Context

Returns:

current test-case.

setCurrentTestCase

public void setCurrentTestCase(TestCase currentTestCase)

Description copied from interface: Context

Set current test-case.

Specified by:

setCurrentTestCase in interface Context

Parameters:

currentTestCase - current test-case.

setPrintStream

public void setPrintStream(PrintStream ps)

Set PrintStream for logging.

Parameters:

ps - PrintStream for logging.

getPrintStream

public PrintStream getPrintStream()

Description copied from interface: Context

Get PrintStream for logging.

Specified by:

getPrintStream in interface Context

Returns:

PrintStram object.

takeScreenshot

public String takeScreenshot(String filename)
                      throws org.openqa.selenium.WebDriverException,
                             UnsupportedOperationException

Description copied from interface: ScreenshotHandler

Take screenshot to filename. (override directory if --screenshot-dir option specified)

Specified by:

takeScreenshot in interface ScreenshotHandler

Parameters:

filename - filename.

Returns:

screenshot image path.

Throws:

UnsupportedOperationException - WebDriver does not supoort capturing screenshot.

org.openqa.selenium.WebDriverException

takeScreenshotAll

public String takeScreenshotAll(String prefix,
                                int index)

Description copied from interface: ScreenshotHandler

Take screenshot at all commands if --screenshot-all option specified.

Specified by:

takeScreenshotAll in interface ScreenshotHandler

Parameters:

prefix - prefix name.

index - command index.

Returns:

screenshot image path.

takeScreenshotOnFail

public String takeScreenshotOnFail(String prefix,
                                   int index)

Description copied from interface: ScreenshotHandler

Take screenshot on fail commands if --screenshot-on-fail option specified.

Specified by:

takeScreenshotOnFail in interface ScreenshotHandler

Parameters:

prefix - prefix name.

index - command index.

Returns:

screenshot image path.

getDriver

@Deprecated
public org.openqa.selenium.WebDriver getDriver()

Deprecated.

Get WebDriver.

Internal use only.

Returns:

WebDriver.

getWrappedDriver

public org.openqa.selenium.WebDriver getWrappedDriver()

Specified by:

getWrappedDriver in interface org.openqa.selenium.internal.WrapsDriver

getInitialWindowHandle

public String getInitialWindowHandle()

Description copied from interface: Context

Get initial window handle.

Specified by:

getInitialWindowHandle in interface Context

Returns:

window handle.

setDriver

public void setDriver(org.openqa.selenium.WebDriver driver)

Set WebDriver.

Parameters:

driver - WebDriver.

prepareWebDriver

public void prepareWebDriver()

Description copied from interface: Context

Prepare WebDriver.

Specified by:

prepareWebDriver in interface Context

setWebDriverPreparator

public void setWebDriverPreparator(WebDriverPreparator preparator)

Set WebDriverPreparator.

Parameters:

preparator - WebDriverPreparator.

setScreenshotDir

public void setScreenshotDir(String screenshotDir)
                      throws IllegalArgumentException

Set directory for storing screenshots.

Parameters:

screenshotDir - directory.

Throws:

IllegalArgumentException - throws if screenshotDir is not directory.

setScreenshotAllDir

public void setScreenshotAllDir(String screenshotAllDir)
                         throws IllegalArgumentException

Set directory for storing screenshots at all commands.

Parameters:

screenshotAllDir - directory.

Throws:

IllegalArgumentException - throws if screenshotAllDir is not directory.

setScreenshotOnFailDir

public void setScreenshotOnFailDir(String screenshotOnFailDir)

Set directory for storing screenshot on fail.

Parameters:

screenshotOnFailDir - directory.

getBaseURL

@Deprecated
public String getBaseURL()

Deprecated.

Get current base URL.

Returns:

base URL.

setBaseURL

@Deprecated
public void setBaseURL(String baseURL)

Deprecated. Replaced by setOverridingBaseURL(String)

Set URL for overriding selenium.base in Selenese script.

Parameters:

baseURL - base URL.

getCurrentBaseURL

public String getCurrentBaseURL()

Description copied from interface: Context

Get current base URL.

Specified by:

getCurrentBaseURL in interface Context

Returns:

base URL.

setOverridingBaseURL

public void setOverridingBaseURL(String overridingBaseURL)

Set URL for overriding test-case base URL.

Parameters:

overridingBaseURL - base URL.

getOverridingBaseURL

public String getOverridingBaseURL()

Description copied from interface: Context

Get base URL for overriding test-case base URL.

Specified by:

getOverridingBaseURL in interface Context

Returns:

base URL.

setIgnoreScreenshotCommand

@Deprecated
public void setIgnoreScreenshotCommand(boolean isIgnoredScreenshotCommand)

Deprecated. use setIgnoredScreenshotCommand(boolean)

Set ignore screenshot command flag.

Parameters:

isIgnoredScreenshotCommand - set true if you want to ignore "captureEntirePageScreenshot"

setIgnoredScreenshotCommand

public void setIgnoredScreenshotCommand(boolean isIgnoredScreenshotCommand)

Set ignore screenshot command flag.

Parameters:

isIgnoredScreenshotCommand - set true if you want to ignore "captureEntirePageScreenshot"

isIgnoreScreenshotCommand

@Deprecated
public boolean isIgnoreScreenshotCommand()

Deprecated. use isIgnoredScreenshotCommand()

Get ignore screenshot command flag.

Returns:

flag to ignore "captureEntirePageScreenshot"

isIgnoredScreenshotCommand

public boolean isIgnoredScreenshotCommand()

Description copied from interface: ScreenshotHandler

Get ignore screenshot command flag.

Specified by:

isIgnoredScreenshotCommand in interface ScreenshotHandler

Returns:

flag to ignore "captureEntirePageScreenshot"

isHighlight

public boolean isHighlight()

Description copied from interface: HighlightHandler

Get locator highlighting.

Specified by:

isHighlight in interface HighlightHandler

Returns:

true if use locator highlighting.

setHighlight

public void setHighlight(boolean isHighlight)

Set locator highlighting.

Parameters:

isHighlight - true if use locator highlighting.

getTimeout

public int getTimeout()

Description copied from interface: Context

Get timeout for waiting. (ms)

Specified by:

getTimeout in interface Context

Returns:

timeout for waiting.

setTimeout

public void setTimeout(int timeout)

Description copied from interface: Context

Set timeout for waiting. (ms)

Specified by:

setTimeout in interface Context

Parameters:

timeout - for waiting.

getInitialSpeed

public long getInitialSpeed()

Get initial speed at starting test-suite. (ms)

Returns:

initial speed.

setInitialSpeed

public void setInitialSpeed(long initialSpeed)

Set initial speed at starting test-suite. (ms)

Parameters:

initialSpeed - initial speed.

resetSpeed

public void resetSpeed()

Description copied from interface: Context

Reset speed as initial speed.

Specified by:

resetSpeed in interface Context

getSpeed

public long getSpeed()

Description copied from interface: Context

Get speed for setSpeed command.

Specified by:

getSpeed in interface Context

Returns:

speed.

setSpeed

public void setSpeed(long speed)

Description copied from interface: Context

Set speed for setSpeed command.

Specified by:

setSpeed in interface Context

Parameters:

speed - speed.

waitSpeed

public void waitSpeed()

Description copied from interface: Context

Wait according to speed setting.

Specified by:

waitSpeed in interface Context

getSubCommandMap

public SubCommandMap getSubCommandMap()

Description copied from interface: Context

Get SubCommandMap instance.

Specified by:

getSubCommandMap in interface Context

Returns:

SubCommandMap instance.

getCommandFactory

public CommandFactory getCommandFactory()

Description copied from interface: Context

Get CommandFactory instance.

Specified by:

getCommandFactory in interface Context

Returns:

CommandFactory instance.

getCommandListIterator

public CommandListIterator getCommandListIterator()

Description copied from interface: Context

Get current CommandListIterator.

Specified by:

getCommandListIterator in interface Context

Returns:

current CommanListIterator.

pushCommandListIterator

public void pushCommandListIterator(CommandListIterator commandListIterator)

Description copied from interface: Context

Push CommandListIterator.

Specified by:

pushCommandListIterator in interface Context

Parameters:

commandListIterator - CommanListIterator.

popCommandListIterator

public void popCommandListIterator()

Description copied from interface: Context

Pop CommandListIterator.

Specified by:

popCommandListIterator in interface Context

getVarsMap

public VarsMap getVarsMap()

Description copied from interface: Context

Get variables map.

Specified by:

getVarsMap in interface Context

Returns:

VarsMap.

setVarsMap

public void setVarsMap(VarsMap varsMap)

Set variables map used for this session.

Parameters:

varsMap - the evaluated variables (state) for the current context.

getCollectionMap

public CollectionMap getCollectionMap()

Description copied from interface: Context

Get collection map.

Specified by:

getCollectionMap in interface Context

Returns:

CollectionMap.

getRollupRules

public RollupRules getRollupRules()

Description copied from interface: Context

Get rollup rules.

Specified by:

getRollupRules in interface Context

Returns:

RollupRules object.

getEval

public Eval getEval()

Description copied from interface: Context

Get evaluater.

Specified by:

getEval in interface Context

Returns:

eval object.

getElementFinder

public WebDriverElementFinder getElementFinder()

Description copied from interface: Context

Get elemnt finder.

Specified by:

getElementFinder in interface Context

Returns:

element finder.

getLatestPageInformation

public PageInformation getLatestPageInformation()

Description copied from interface: Context

Get latest page information.

Specified by:

getLatestPageInformation in interface Context

Returns:

page information.

setLatestPageInformation

public void setLatestPageInformation(PageInformation pageInformation)

Description copied from interface: Context

Set latest page information.

Specified by:

setLatestPageInformation in interface Context

Parameters:

pageInformation - page information.

getCookieFilter

public CookieFilter getCookieFilter()

Description copied from interface: Context

Get cookie filter.

Specified by:

getCookieFilter in interface Context

Returns:

cookie filter.

setCookieFilter

public void setCookieFilter(CookieFilter cookieFilter)

Description copied from interface: Context

Set cookie filter.

Specified by:

setCookieFilter in interface Context

Parameters:

cookieFilter - cookie filter.

execute

public Result execute(Selenese selenese)

Execute test-suite / test-case.

Parameters:

selenese - test-suite or test-case.

Returns:

result.

isTrue

public boolean isTrue(String expr)

Description copied from interface: Context

Get boolean value of expr.

Specified by:

isTrue in interface Context

Parameters:

expr - expression.

Returns:

cast from result of expr to Javascript Boolean.

run

public Result run(String... filenames)

Run Selenese script files.

Parameters:

filenames - Selenese script filenames.

Returns:

result.

run

public Result run(String filename,
                  InputStream is)

Run Selenese script from input stream.

Parameters:

filename - selenese script file. (not open. used for label or generating output filename)

is - input stream of script file. (test-case or test-suite)

Returns:

result.

setJUnitResultDir

public void setJUnitResultDir(String dir)

Initialize JUnitResult.

Parameters:

dir - JUnit result directory.

getJUnitResult

public JUnitResult getJUnitResult()

Description copied from interface: JUnitResultHolder

Get JUnit result instance.

Specified by:

getJUnitResult in interface JUnitResultHolder

Returns:

JUnit result instance.

setHtmlResultDir

public void setHtmlResultDir(String dir)

Initialize HTMLResult.

Parameters:

dir - HTML result directory.

getHtmlResult

public HtmlResult getHtmlResult()

Description copied from interface: HtmlResultHolder

Get HTML result instance.

Specified by:

getHtmlResult in interface HtmlResultHolder

Returns:

HTML result instance.

finish

public void finish()

Finish test. generate index.html for HTML result.

highlight

public void highlight(String locator,
                      HighlightStyle highlightStyle)

Description copied from interface: HighlightHandler

Highlight and backup specified locator.

Specified by:

highlight in interface HighlightHandler

Parameters:

locator - locator.

highlightStyle - highlight style.

unhighlight

public void unhighlight()

Description copied from interface: HighlightHandler

Unhighlight backed up styles.

Specified by:

unhighlight in interface HighlightHandler