Package ai.test.sdk

Class TestAiDriver

java.lang.Object

org.openqa.selenium.remote.RemoteWebDriver

ai.test.sdk.TestAiDriver

All Implemented Interfaces:

HasCapabilities, HasInputDevices, Interactive, FindsByClassName, FindsByCssSelector, FindsById, FindsByLinkText, FindsByName, FindsByTagName, FindsByXPath, JavascriptExecutor, SearchContext, TakesScreenshot, WebDriver

public class TestAiDriver
extends RemoteWebDriver

A convenient wrapper around RemoteWebDriver which calls out to Test.ai to improve the accuracy of identified elements.

Author:

Alexander Wu ([email protected])

Nested Class Summary

Nested classes/interfaces inherited from class org.openqa.selenium.remote.RemoteWebDriver

RemoteWebDriver.When

Nested classes/interfaces inherited from interface org.openqa.selenium.WebDriver

WebDriver.ImeHandler, WebDriver.Navigation, WebDriver.Options, WebDriver.TargetLocator, WebDriver.Timeouts, WebDriver.Window

Constructor Summary

Constructors

Constructor	Description
TestAiDriver(RemoteWebDriver driver, String apiKey)	Constructor, creates a new TestAiDriver with the default server url (sdk.test.ai), non-interactive mode, and with training enabled.
TestAiDriver(RemoteWebDriver driver, String apiKey, String serverURL, String testCaseName, boolean train)	Constructor, creates a new TestAiDriver.

Method Summary

Modifier and Type	Method	Description
Object	executeAsyncScript(String script, Object... args)
Object	executeScript(String script, Object... args)
WebElement	findByElementName(String elementName)	Finds an element by elementName.
WebElement	findElement(By locator)
WebElement	findElementByClassName(String using)	Attempts to find an element by class name.
WebElement	findElementByClassName(String using, String elementName)	Attempts to find an element by class name.
WebElement	findElementByCssSelector(String using)	Attempts to find an element by css selector.
WebElement	findElementByCssSelector(String using, String elementName)	Attempts to find an element by css selector.
WebElement	findElementById(String using)	Attempts to find an element by id.
WebElement	findElementById(String using, String elementName)	Attempts to find an element by id.
WebElement	findElementByLinkText(String using)	Attempts to find an element by link text.
WebElement	findElementByLinkText(String using, String elementName)	Attempts to find an element by link text.
WebElement	findElementByName(String using)	Attempts to find an element by name.
WebElement	findElementByName(String using, String elementName)	Attempts to find an element by name.
WebElement	findElementByPartialLinkText(String using)	Attempts to find an element by partial link text.
WebElement	findElementByPartialLinkText(String using, String elementName)	Attempts to find an element by partial link text.
WebElement	findElementByTagName(String using)	Attempts to find an element by tag name.
WebElement	findElementByTagName(String using, String elementName)	Attempts to find an element by tag name.
WebElement	findElementByXPath(String using)	Attempts to find an element by xpath.
WebElement	findElementByXPath(String using, String elementName)	Attempts to find an element by xpath.
List<WebElement>	findElements(By locator)
List<WebElement>	findElementsByClassName(String using)	Attempts to find all elements with the matching class name.
List<WebElement>	findElementsByCssSelector(String using)	Attempts to find all elements with the matching css selector.
List<WebElement>	findElementsById(String using)	Attempts to find all elements with the matching id.
List<WebElement>	findElementsByLinkText(String using)	Attempts to find all elements with the matching link text.
List<WebElement>	findElementsByName(String using)	Attempts to find all elements with the matching name.
List<WebElement>	findElementsByPartialLinkText(String using)	Attempts to find all elements with the matching partial link text.
List<WebElement>	findElementsByTagName(String using)	Attempts to find all elements with the matching tag name.
List<WebElement>	findElementsByXPath(String using)	Attempts to find all elements with the matching xpath.
void	get(String url)	Opens a web browser and directs it to url.
Capabilities	getCapabilities()
CommandExecutor	getCommandExecutor()
String	getCurrentUrl()
ErrorHandler	getErrorHandler()
FileDetector	getFileDetector()
Keyboard	getKeyboard()
Mouse	getMouse()
String	getPageSource()
<X> X	getScreenshotAs(OutputType<X> outputType)
SessionId	getSessionId()
String	getTitle()
String	getWindowHandle()
Set<String>	getWindowHandles()
TestAiDriver	implicitlyWait(long waitTime)	Convenience method, implicitly wait for the specified amount of time.
WebDriver.Options	manage()
WebDriver.Navigation	navigate()
void	perform(Collection<Sequence> actions)
void	quit()
void	resetInputState()
void	setErrorHandler(ErrorHandler handler)
void	setFileDetector(FileDetector detector)
void	setLogLevel(Level level)
WebDriver.TargetLocator	switchTo()
String	toString()

Methods inherited from class org.openqa.selenium.remote.RemoteWebDriver

builder, close

Methods inherited from class java.lang.Object

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

Constructor Details

TestAiDriver

public TestAiDriver(RemoteWebDriver driver,
 String apiKey,
 String serverURL,
 String testCaseName,
 boolean train)
             throws IOException

Constructor, creates a new TestAiDriver.

Parameters:

driver - The selenium driver to wrap

apiKey - Your API key, acquired from sdk.test.ai.

serverURL - The server URL. Set null to use the default of sdk.test.ai.

testCaseName - The test case name to use for interactive mode. Setting this to something other than null enables interactive mode.

train - Set `true` to enable training for each encountered element.

Throws:

IOException - If there was an initialization error.

TestAiDriver

public TestAiDriver(RemoteWebDriver driver,
 String apiKey)
             throws IOException

Constructor, creates a new TestAiDriver with the default server url (sdk.test.ai), non-interactive mode, and with training enabled.

Parameters:

driver - The RemoteWebDriver to wrap

apiKey - Your API key, acquired from sdk.test.ai.

Throws:

IOException - If there was an initialization error.

Method Details

implicitlyWait

public TestAiDriver implicitlyWait(long waitTime)

Convenience method, implicitly wait for the specified amount of time.

Parameters:

waitTime - The number of seconds to implicitly wait.

Returns:

This TestAiDriver, for chaining convenience.

executeAsyncScript

public Object executeAsyncScript(String script,
 Object... args)

Specified by:

executeAsyncScript in interface JavascriptExecutor

Overrides:

executeAsyncScript in class RemoteWebDriver

executeScript

public Object executeScript(String script,
 Object... args)

Specified by:

executeScript in interface JavascriptExecutor

Overrides:

executeScript in class RemoteWebDriver

get

public void get(String url)

Opens a web browser and directs it to url.

Specified by:

get in interface WebDriver

Overrides:

get in class RemoteWebDriver

Parameters:

url - The URL to launch the browser to.

findElement

public WebElement findElement(By locator)

Specified by:

findElement in interface SearchContext

Specified by:

findElement in interface WebDriver

Overrides:

findElement in class RemoteWebDriver

findElements

public List<WebElement> findElements(By locator)

Specified by:

findElements in interface SearchContext

Specified by:

findElements in interface WebDriver

Overrides:

findElements in class RemoteWebDriver

getCapabilities

public Capabilities getCapabilities()

Specified by:

getCapabilities in interface HasCapabilities

Overrides:

getCapabilities in class RemoteWebDriver

getCommandExecutor

public CommandExecutor getCommandExecutor()

Overrides:

getCommandExecutor in class RemoteWebDriver

getCurrentUrl

public String getCurrentUrl()

Specified by:

getCurrentUrl in interface WebDriver

Overrides:

getCurrentUrl in class RemoteWebDriver

getErrorHandler

public ErrorHandler getErrorHandler()

Overrides:

getErrorHandler in class RemoteWebDriver

getFileDetector

public FileDetector getFileDetector()

Overrides:

getFileDetector in class RemoteWebDriver

getKeyboard

public Keyboard getKeyboard()

Specified by:

getKeyboard in interface HasInputDevices

Overrides:

getKeyboard in class RemoteWebDriver

getMouse

public Mouse getMouse()

Specified by:

getMouse in interface HasInputDevices

Overrides:

getMouse in class RemoteWebDriver

getPageSource

public String getPageSource()

Specified by:

getPageSource in interface WebDriver

Overrides:

getPageSource in class RemoteWebDriver

getScreenshotAs

public <X> X getScreenshotAs(OutputType<X> outputType)

Specified by:

getScreenshotAs in interface TakesScreenshot

Overrides:

getScreenshotAs in class RemoteWebDriver

getSessionId

public SessionId getSessionId()

Overrides:

getSessionId in class RemoteWebDriver

getTitle

public String getTitle()

Specified by:

getTitle in interface WebDriver

Overrides:

getTitle in class RemoteWebDriver

getWindowHandle

public String getWindowHandle()

Specified by:

getWindowHandle in interface WebDriver

Overrides:

getWindowHandle in class RemoteWebDriver

getWindowHandles

public Set<String> getWindowHandles()

Specified by:

getWindowHandles in interface WebDriver

Overrides:

getWindowHandles in class RemoteWebDriver

manage

public WebDriver.Options manage()

Specified by:

manage in interface WebDriver

Overrides:

manage in class RemoteWebDriver

navigate

public WebDriver.Navigation navigate()

Specified by:

navigate in interface WebDriver

Overrides:

navigate in class RemoteWebDriver

perform

public void perform(Collection<Sequence> actions)

Specified by:

perform in interface Interactive

Overrides:

perform in class RemoteWebDriver

quit

public void quit()

Specified by:

quit in interface WebDriver

Overrides:

quit in class RemoteWebDriver

resetInputState

public void resetInputState()

Specified by:

resetInputState in interface Interactive

Overrides:

resetInputState in class RemoteWebDriver

setErrorHandler

public void setErrorHandler(ErrorHandler handler)

Overrides:

setErrorHandler in class RemoteWebDriver

setFileDetector

public void setFileDetector(FileDetector detector)

Overrides:

setFileDetector in class RemoteWebDriver

setLogLevel

public void setLogLevel(Level level)

Overrides:

setLogLevel in class RemoteWebDriver

switchTo

public WebDriver.TargetLocator switchTo()

Specified by:

switchTo in interface WebDriver

Overrides:

switchTo in class RemoteWebDriver

toString

public String toString()

Overrides:

toString in class RemoteWebDriver

findElementByClassName

public WebElement findElementByClassName(String using,
 String elementName)

Attempts to find an element by class name.

Parameters:

using - The class name of the element to find

elementName - The label name of the element to be classified. Optional, set null to auto generate an element name.

Returns:

The element that was found. Raises an exception otherwise.

findElementByClassName

public WebElement findElementByClassName(String using)

Attempts to find an element by class name.

Specified by:

findElementByClassName in interface FindsByClassName

Overrides:

findElementByClassName in class RemoteWebDriver

Parameters:

using - The class name of the element to find

Returns:

The element that was found. Raises an exception otherwise.

findElementsByClassName

public List<WebElement> findElementsByClassName(String using)

Attempts to find all elements with the matching class name.

Specified by:

findElementsByClassName in interface FindsByClassName

Overrides:

findElementsByClassName in class RemoteWebDriver

Parameters:

using - The class name of the elements to find.

Returns:

A List with any elements that were found, or an empty List if no matches were found.

findElementByCssSelector

public WebElement findElementByCssSelector(String using,
 String elementName)

Attempts to find an element by css selector.

Parameters:

using - The css selector of the element to find

elementName - The label name of the element to be classified. Optional, set null to auto generate an element name.

Returns:

The element that was found. Raises an exception otherwise.

findElementByCssSelector

public WebElement findElementByCssSelector(String using)

Attempts to find an element by css selector.

Specified by:

findElementByCssSelector in interface FindsByCssSelector

Overrides:

findElementByCssSelector in class RemoteWebDriver

Parameters:

using - The css selector of the element to find

Returns:

The element that was found. Raises an exception otherwise.

findElementsByCssSelector

public List<WebElement> findElementsByCssSelector(String using)

Attempts to find all elements with the matching css selector.

Specified by:

findElementsByCssSelector in interface FindsByCssSelector

Overrides:

findElementsByCssSelector in class RemoteWebDriver

Parameters:

using - The css selector of the elements to find.

Returns:

A List with any elements that were found, or an empty List if no matches were found.

findElementById

public WebElement findElementById(String using,
 String elementName)

Attempts to find an element by id.

Parameters:

using - The id of the element to find

elementName - The label name of the element to be classified. Optional, set null to auto generate an element name.

Returns:

The element that was found. Raises an exception otherwise.

findElementById

public WebElement findElementById(String using)

Attempts to find an element by id.

Specified by:

findElementById in interface FindsById

Overrides:

findElementById in class RemoteWebDriver

Parameters:

using - The id of the element to find

Returns:

The element that was found. Raises an exception otherwise.

findElementsById

public List<WebElement> findElementsById(String using)

Attempts to find all elements with the matching id.

Specified by:

findElementsById in interface FindsById

Overrides:

findElementsById in class RemoteWebDriver

Parameters:

using - The id of the elements to find.

Returns:

A List with any elements that were found, or an empty List if no matches were found.

findElementByLinkText

public WebElement findElementByLinkText(String using,
 String elementName)

Attempts to find an element by link text.

Parameters:

using - The link text of the element to find

elementName - The label name of the element to be classified. Optional, set null to auto generate an element name.

Returns:

The element that was found. Raises an exception otherwise.

findElementByLinkText

public WebElement findElementByLinkText(String using)

Attempts to find an element by link text.

Specified by:

findElementByLinkText in interface FindsByLinkText

Overrides:

findElementByLinkText in class RemoteWebDriver

Parameters:

using - The link text of the element to find

Returns:

The element that was found. Raises an exception otherwise.

findElementsByLinkText

public List<WebElement> findElementsByLinkText(String using)

Attempts to find all elements with the matching link text.

Specified by:

findElementsByLinkText in interface FindsByLinkText

Overrides:

findElementsByLinkText in class RemoteWebDriver

Parameters:

using - The link text of the elements to find.

Returns:

A List with any elements that were found, or an empty List if no matches were found.

findElementByName

public WebElement findElementByName(String using,
 String elementName)

Attempts to find an element by name.

Parameters:

using - The name of the element to find

elementName - The label name of the element to be classified. Optional, set null to auto generate an element name.

Returns:

The element that was found. Raises an exception otherwise.

findElementByName

public WebElement findElementByName(String using)

Attempts to find an element by name.

Specified by:

findElementByName in interface FindsByName

Overrides:

findElementByName in class RemoteWebDriver

Parameters:

using - The name of the element to find

Returns:

The element that was found. Raises an exception otherwise.

findElementsByName

public List<WebElement> findElementsByName(String using)

Attempts to find all elements with the matching name.

Specified by:

findElementsByName in interface FindsByName

Overrides:

findElementsByName in class RemoteWebDriver

Parameters:

using - The name of the elements to find.

Returns:

A List with any elements that were found, or an empty List if no matches were found.

findElementByPartialLinkText

public WebElement findElementByPartialLinkText(String using,
 String elementName)

Attempts to find an element by partial link text.

Parameters:

using - The partial link text of the element to find

elementName - The label name of the element to be classified. Optional, set null to auto generate an element name.

Returns:

The element that was found. Raises an exception otherwise.

findElementByPartialLinkText

public WebElement findElementByPartialLinkText(String using)

Attempts to find an element by partial link text.

Specified by:

findElementByPartialLinkText in interface FindsByLinkText

Overrides:

findElementByPartialLinkText in class RemoteWebDriver

Parameters:

using - The partial link text of the element to find

Returns:

The element that was found. Raises an exception otherwise.

findElementsByPartialLinkText

public List<WebElement> findElementsByPartialLinkText(String using)

Attempts to find all elements with the matching partial link text.

Specified by:

findElementsByPartialLinkText in interface FindsByLinkText

Overrides:

findElementsByPartialLinkText in class RemoteWebDriver

Parameters:

using - The partial link text of the elements to find.

Returns:

A List with any elements that were found, or an empty List if no matches were found.

findElementByTagName

public WebElement findElementByTagName(String using,
 String elementName)

Attempts to find an element by tag name.

Parameters:

using - The tag name of the element to find

elementName - The label name of the element to be classified. Optional, set null to auto generate an element name.

Returns:

The element that was found. Raises an exception otherwise.

findElementByTagName

public WebElement findElementByTagName(String using)

Attempts to find an element by tag name.

Specified by:

findElementByTagName in interface FindsByTagName

Overrides:

findElementByTagName in class RemoteWebDriver

Parameters:

using - The tag name of the element to find

Returns:

The element that was found. Raises an exception otherwise.

findElementsByTagName

public List<WebElement> findElementsByTagName(String using)

Attempts to find all elements with the matching tag name.

Specified by:

findElementsByTagName in interface FindsByTagName

Overrides:

findElementsByTagName in class RemoteWebDriver

Parameters:

using - The tag name of the elements to find.

Returns:

A List with any elements that were found, or an empty List if no matches were found.

findElementByXPath

public WebElement findElementByXPath(String using,
 String elementName)

Attempts to find an element by xpath.

Parameters:

using - The xpath of the element to find

elementName - The label name of the element to be classified. Optional, set null to auto generate an element name.

Returns:

The element that was found. Raises an exception otherwise.

findElementByXPath

public WebElement findElementByXPath(String using)

Attempts to find an element by xpath.

Specified by:

findElementByXPath in interface FindsByXPath

Overrides:

findElementByXPath in class RemoteWebDriver

Parameters:

using - The xpath of the element to find

Returns:

The element that was found. Raises an exception otherwise.

findElementsByXPath

public List<WebElement> findElementsByXPath(String using)

Attempts to find all elements with the matching xpath.

Specified by:

findElementsByXPath in interface FindsByXPath

Overrides:

findElementsByXPath in class RemoteWebDriver

Parameters:

using - The xpath of the elements to find.

Returns:

A List with any elements that were found, or an empty List if no matches were found.

findByElementName

public WebElement findByElementName(String elementName)

Finds an element by elementName.

Parameters:

elementName - The label name of the element to be classified.

Returns:

An element associated with elementName. Throws NoSuchElementException otherwise.