Package com.intuit.karate.driver

Class WebDriver

java.lang.Object

com.intuit.karate.driver.WebDriver

All Implemented Interfaces:

Plugin, Driver

Direct Known Subclasses:

AppiumDriver, ChromeWebDriver, GeckoWebDriver, IeWebDriver, MsEdgeDriver, MsWebDriver, SafariWebDriver, WinAppDriver

public abstract class WebDriver
extends Object
implements Driver

Author:

pthomas3

Field Summary

Fields

Modifier and Type	Field	Description
protected Command	command
protected Http	http
protected Logger	logger
protected boolean	open
protected DriverOptions	options
protected Boolean	specCompliant

Fields inherited from interface com.intuit.karate.driver.Driver

METHOD_NAMES

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	WebDriver(DriverOptions options)

Method Summary

Modifier and Type	Method	Description
void	actions(List<Map<String,Object>> actions)
String	attribute(String locator, String name)
void	back()
boolean	checkForSpecCompliance()
Element	clear(String locator)
void	clearCookies()
Element	click(String locator)
void	close()
Map<String,Object>	cookie(String name)
void	cookie(Map<String,Object> cookie)
void	deleteCookie(String name)
void	dialog(boolean accept)
void	dialog(boolean accept, String text)
String	elementId(String locator)
List<String>	elementIds(String locator)
boolean	enabled(String locator)
protected Variable	eval(String expression)
protected Variable	eval(String expression, List args)
Element	focus(String locator)
void	forward()
void	fullscreen()
List<Map>	getCookies()
protected Base64.Decoder	getDecoder()
String	getDialogText()
Map<String,Object>	getDimensions()
protected List<String>	getElementKeys()
Http	getHttp()
protected String	getJsonForFrame(String text)
protected String	getJsonForHandle(String text)
protected String	getJsonForInput(String text)
protected String	getJsonForLegacyInput(String text)
DriverOptions	getOptions()
List<String>	getPages()
String	getSessionId()
String	getTitle()
String	getUrl()
String	html(String locator)
Element	input(String locator, String value)
protected boolean	isCookieError(Response res)
protected boolean	isJavaScriptError(Response res)
protected boolean	isLocatorError(Response res)
boolean	isSpecCompliant()
boolean	isTerminated()
void	maximize()
void	minimize()
byte[]	pdf(Map<String,Object> printOptions)
Map<String,Object>	position(String locator)
Map<String,Object>	position(String locator, boolean relative)
String	property(String locator, String name)
void	quit()
void	refresh()
void	reload()
protected <T> T	retryIfEnabled(String locator, java.util.function.Supplier<T> action)
byte[]	screenshot(boolean embed)
byte[]	screenshot(String locator, boolean embed)
Object	script(String expression)
Element	select(String locator, int index)
Element	select(String locator, String text)
protected String	selectorPayload(String locator)
void	setDimensions(Map<String,Object> map)
void	setUrl(String url)
Driver	submit()
void	switchFrame(int index)
void	switchFrame(String locator)
void	switchPage(int index)
void	switchPage(String titleOrUrl)
String	text(String locator)
Driver	timeout()
Driver	timeout(Integer millis)
String	value(String locator)
Element	value(String locator, String value)
boolean	waitUntil(String expression)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intuit.karate.driver.Driver

above, activate, afterScenario, below, delay, exists, highlight, highlight, highlightAll, highlightAll, input, input, input, keys, leftOf, locate, locateAll, locateAll, methodNames, mouse, mouse, mouse, near, onFailure, optional, retry, retry, retry, rightOf, screenshot, screenshot, script, scriptAll, scriptAll, scroll, setCookies, waitFor, waitForAny, waitForAny, waitForEnabled, waitForResultCount, waitForResultCount, waitForText, waitForUrl, waitUntil, waitUntil

Methods inherited from interface com.intuit.karate.core.Plugin

getRuntime

Field Detail

options

protected final DriverOptions options

command

protected final Command command

http

protected final Http http

open

protected boolean open

specCompliant

protected Boolean specCompliant

logger

protected final Logger logger

Constructor Detail

WebDriver

protected WebDriver(DriverOptions options)

Method Detail

timeout

public Driver timeout(Integer millis)

Specified by:

timeout in interface Driver

timeout

public Driver timeout()

Specified by:

timeout in interface Driver

getSessionId

public String getSessionId()

getHttp

public Http getHttp()

retryIfEnabled

protected <T> T retryIfEnabled(String locator,
                               java.util.function.Supplier<T> action)

isJavaScriptError

protected boolean isJavaScriptError(Response res)

isLocatorError

protected boolean isLocatorError(Response res)

isCookieError

protected boolean isCookieError(Response res)

eval

protected Variable eval(String expression,
                        List args)

eval

protected Variable eval(String expression)

getElementKeys

protected List<String> getElementKeys()

getJsonForInput

protected String getJsonForInput(String text)

getJsonForLegacyInput

protected String getJsonForLegacyInput(String text)

getJsonForHandle

protected String getJsonForHandle(String text)

getJsonForFrame

protected String getJsonForFrame(String text)

selectorPayload

protected String selectorPayload(String locator)

elementId

public String elementId(String locator)

Specified by:

elementId in interface Driver

elementIds

public List<String> elementIds(String locator)

Specified by:

elementIds in interface Driver

getOptions

public DriverOptions getOptions()

Specified by:

getOptions in interface Driver

setUrl

public void setUrl(String url)

Specified by:

setUrl in interface Driver

getDimensions

public Map<String,Object> getDimensions()

Specified by:

getDimensions in interface Driver

setDimensions

public void setDimensions(Map<String,Object> map)

Specified by:

setDimensions in interface Driver

refresh

public void refresh()

Specified by:

refresh in interface Driver

reload

public void reload()

Specified by:

reload in interface Driver

back

public void back()

Specified by:

back in interface Driver

forward

public void forward()

Specified by:

forward in interface Driver

maximize

public void maximize()

Specified by:

maximize in interface Driver

minimize

public void minimize()

Specified by:

minimize in interface Driver

fullscreen

public void fullscreen()

Specified by:

fullscreen in interface Driver

focus

public Element focus(String locator)

Specified by:

focus in interface Driver

clear

public Element clear(String locator)

Specified by:

clear in interface Driver

input

public Element input(String locator,
                     String value)

Specified by:

input in interface Driver

click

public Element click(String locator)

Specified by:

click in interface Driver

submit

public Driver submit()

Specified by:

submit in interface Driver

select

public Element select(String locator,
                      String text)

Specified by:

select in interface Driver

select

public Element select(String locator,
                      int index)

Specified by:

select in interface Driver

actions

public void actions(List<Map<String,Object>> actions)

Specified by:

actions in interface Driver

close

public void close()

Specified by:

close in interface Driver

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface Driver

isSpecCompliant

public boolean isSpecCompliant()

checkForSpecCompliance

public boolean checkForSpecCompliance()

quit

public void quit()

Specified by:

quit in interface Driver

getUrl

public String getUrl()

Specified by:

getUrl in interface Driver

html

public String html(String locator)

Specified by:

html in interface Driver

text

public String text(String locator)

Specified by:

text in interface Driver

value

public String value(String locator)

Specified by:

value in interface Driver

value

public Element value(String locator,
                     String value)

Specified by:

value in interface Driver

attribute

public String attribute(String locator,
                        String name)

Specified by:

attribute in interface Driver

property

public String property(String locator,
                       String name)

Specified by:

property in interface Driver

position

public Map<String,Object> position(String locator)

Specified by:

position in interface Driver

position

public Map<String,Object> position(String locator,
                                         boolean relative)

Specified by:

position in interface Driver

enabled

public boolean enabled(String locator)

Specified by:

enabled in interface Driver

waitUntil

public boolean waitUntil(String expression)

Specified by:

waitUntil in interface Driver

script

public Object script(String expression)

Specified by:

script in interface Driver

getTitle

public String getTitle()

Specified by:

getTitle in interface Driver

getCookies

public List<Map> getCookies()

Specified by:

getCookies in interface Driver

cookie

public Map<String,Object> cookie(String name)

Specified by:

cookie in interface Driver

cookie

public void cookie(Map<String,Object> cookie)

Specified by:

cookie in interface Driver

deleteCookie

public void deleteCookie(String name)

Specified by:

deleteCookie in interface Driver

clearCookies

public void clearCookies()

Specified by:

clearCookies in interface Driver

dialog

public void dialog(boolean accept)

Specified by:

dialog in interface Driver

getDialogText

public String getDialogText()

Specified by:

getDialogText in interface Driver

dialog

public void dialog(boolean accept,
                   String text)

Specified by:

dialog in interface Driver

screenshot

public byte[] screenshot(boolean embed)

Specified by:

screenshot in interface Driver

screenshot

public byte[] screenshot(String locator,
                         boolean embed)

Specified by:

screenshot in interface Driver

getPages

public List<String> getPages()

Specified by:

getPages in interface Driver

switchPage

public void switchPage(String titleOrUrl)

Specified by:

switchPage in interface Driver

switchPage

public void switchPage(int index)

Specified by:

switchPage in interface Driver

switchFrame

public void switchFrame(int index)

Specified by:

switchFrame in interface Driver

switchFrame

public void switchFrame(String locator)

Specified by:

switchFrame in interface Driver

getDecoder

protected Base64.Decoder getDecoder()

pdf

public byte[] pdf(Map<String,Object> printOptions)

Specified by:

pdf in interface Driver