HotTestSeleniumDriver

hotstaq / Modules / HotTestSeleniumDriver

Class: HotTestSeleniumDriver

Runs and executes tests using Selenium.

Hierarchy

• HotTestDriver

  ↳ HotTestSeleniumDriver

Table of contents

Constructors

• constructor

Properties

• browser
• disableGPUAndSandbox
• driver
• headless
• openDevTools
• page
• remoteServer
• session
• windowSize

Methods

• assert
• assertElementValue
• destroy
• findTestElement
• getTestObjectByName
• loadSeleniumDriver
• navigateToUrl
• parseTestObject
• print
• println
• run
• runCommand
• wait
• waitForTestElement

Constructors

constructor

• new HotTestSeleniumDriver(page?)

Parameters

Name	Type	Default value
page	HotTestPage	null

Overrides

HotTestDriver.constructor

Defined in

HotTestSeleniumDriver.ts:58

Properties

browser

• browser: string

The browser to use.

Defined in

HotTestSeleniumDriver.ts:27

---

disableGPUAndSandbox

• disableGPUAndSandbox: boolean

Disable GPU usage and the Chrome Sandbox. Mostly for usage within Docker.

Defined in

HotTestSeleniumDriver.ts:35

---

driver

• driver: WebDriver

The selenium webdriver.

Defined in

HotTestSeleniumDriver.ts:23

---

headless

• headless: boolean

Run the tests headless.

Defined in

HotTestSeleniumDriver.ts:31

---

openDevTools

• openDevTools: boolean

Automatically open the developer tools on start.

Defined in

HotTestSeleniumDriver.ts:39

---

page

• page: HotTestPage

The current page.

Inherited from

HotTestDriver.page

Defined in

HotTestDriver.ts:12

---

remoteServer

• remoteServer: string

Set the remote server to use for testing.

Defined in

HotTestSeleniumDriver.ts:43

---

session

• session: Session

The current selenium session running.

Defined in

HotTestSeleniumDriver.ts:19

---

windowSize

• windowSize: Object

Set the window size on start.

Type declaration

Name	Type	Description
height	number	The height of the window.
width	number	The width of the window.

Defined in

HotTestSeleniumDriver.ts:47

Methods

assert

▸ assert(value, errorMessage?): Promise<any>

An expression to test.

Parameters

Name	Type	Default value
value	any	undefined
errorMessage	string	""

Returns

Promise<any>

Inherited from

HotTestDriver.assert

Defined in

HotTestDriver.ts:106

---

assertElementValue

▸ assertElementValue(name, value, errorMessage?, options?): Promise<any>

An expression to test.

Parameters

Name	Type	Default value
name	string | HotTestElement	undefined
value	any	undefined
errorMessage	string	""
options	HotTestElementOptions	undefined

Returns

Promise<any>

Overrides

HotTestDriver.assertElementValue

Defined in

HotTestSeleniumDriver.ts:330

---

destroy

▸ destroy(): Promise<void>

Disconnect this server or destroy anything associated with this HotTestDriver.

Returns

Promise<void>

Overrides

HotTestDriver.destroy

Defined in

HotTestSeleniumDriver.ts:75

---

findTestElement

▸ findTestElement(name, options?): Promise<WebElement>

Get a test element using selenium webdriver.

Parameters

Name	Type
name	string | HotTestElement
options	HotTestElementOptions

Returns

Promise<WebElement>

Overrides

HotTestDriver.findTestElement

Defined in

HotTestSeleniumDriver.ts:233

---

getTestObjectByName

▸ getTestObjectByName(name): By

Get a test object by it's name. If a * is used, it will be used as a wildcard for the object's name. If a > is used, then the name will be treated as a CSS selector.

Parameters

Name	Type
name	string

Returns

By

Defined in

HotTestSeleniumDriver.ts:178

---

loadSeleniumDriver

▸ loadSeleniumDriver(): Promise<void>

Load the selenium driver.

Returns

Promise<void>

Defined in

HotTestSeleniumDriver.ts:89

---

navigateToUrl

▸ navigateToUrl(url): Promise<void>

Navigate to a url.

Parameters

Name	Type
url	string

Returns

Promise<void>

Overrides

HotTestDriver.navigateToUrl

Defined in

HotTestSeleniumDriver.ts:188

---

parseTestObject

▸ parseTestObject(name): string

Get a test object by it's name. If a * is used, it will be used as a wildcard for the object's name. If a > is used, then the name will be treated as a CSS selector.

Parameters

Name	Type
name	string

Returns

string

Inherited from

HotTestDriver.parseTestObject

Defined in

HotTestDriver.ts:24

---

print

▸ print(message): Promise<void>

Print a message.

Parameters

Name	Type
message	string

Returns

Promise<void>

Inherited from

HotTestDriver.print

Defined in

HotTestDriver.ts:64

---

println

▸ println(message): Promise<void>

Print a message line.

Parameters

Name	Type
message	string

Returns

Promise<void>

Inherited from

HotTestDriver.println

Defined in

HotTestDriver.ts:72

---

run

▸ run(executions): Promise<any[]>

Run a series of test elements.

Parameters

Name	Type
executions	string[] | string[][]

Returns

Promise<any[]>

Inherited from

HotTestDriver.run

Defined in

HotTestDriver.ts:115

---

runCommand

▸ runCommand(testElm, funcName?, valueStr?, options?): Promise<any>

Run a command using Selenium Webdriver.

Parameters

Name	Type	Default value
testElm	string | HotTestElement	undefined
funcName	string	""
valueStr	string	""
options	HotTestElementOptions	undefined

Returns

Promise<any>

Overrides

HotTestDriver.runCommand

Defined in

HotTestSeleniumDriver.ts:275

---

wait

▸ wait(numMilliseconds): Promise<void>

Wait for a number of milliseconds.

Parameters

Name	Type
numMilliseconds	number

Returns

Promise<void>

Inherited from

HotTestDriver.wait

Defined in

HotTestDriver.ts:50

---

waitForTestElement

▸ waitForTestElement(name, options?): Promise<WebElement>

Wait for a test element using Selenium Webdriver.

Parameters

Name	Type
name	string | HotTestElement
options	HotTestElementOptions

Returns

Promise<WebElement>

Overrides

HotTestDriver.waitForTestElement

Defined in

HotTestSeleniumDriver.ts:196