Abstract Class: ComponentDriver<T>

Defined in: packages/core/src/drivers/ComponentDriver.ts:27

Base class for all component drivers. It provides the basic functionality to interact with the component

Extended by

• TestEngine
• ContainerDriver
• ListComponentDriver

Type Parameters

T

T extends ScenePart = { }

Implements

• IComponentDriver<T>

Constructors

Constructor

new ComponentDriver<T>(locator, interactor, option?): ComponentDriver<T>

Defined in: packages/core/src/drivers/ComponentDriver.ts:39

Parameters

locator

PartLocator

interactor

Interactor

option?

Partial<IComponentDriverOption<T>>

Returns

ComponentDriver<T>

Properties

commutableOption

readonly commutableOption: IComponentDriverOption<T>

Defined in: packages/core/src/drivers/ComponentDriver.ts:37

Option passed to the constructor includes both universal options which can be shared across all component driver tree, and component specific options which are only applicable to the component.

Commutable option is the option that can be shared across all component driver tree.

---

interactor

readonly interactor: Interactor

Defined in: packages/core/src/drivers/ComponentDriver.ts:41

Accessors

driverName

Get Signature

get abstract driverName(): string

Defined in: packages/core/src/drivers/ComponentDriver.ts:255

Returns

string

---

locator

Get Signature

get locator(): PartLocator

Defined in: packages/core/src/drivers/ComponentDriver.ts:90

Return the locator of the component

Returns

PartLocator

Implementation of

IComponentDriver.locator

---

parts

Get Signature

get parts(): ScenePartDriver<T>

Defined in: packages/core/src/drivers/ComponentDriver.ts:83

Return driver instance of all the named parts

Returns

ScenePartDriver<T>

Implementation of

IComponentDriver.parts

Methods

click()

click(option?): Promise<void>

Defined in: packages/core/src/drivers/ComponentDriver.ts:156

Parameters

option?

Partial<ClickOption>

Returns

Promise<void>

---

enforcePartExistence()

protected enforcePartExistence(partName): Promise<void>

Defined in: packages/core/src/drivers/ComponentDriver.ts:99

Check the specified parts' existences, and throw MissingPartError if any of the part is found not existence. Existence is defined by the part's existence in the DOM regardless of its visibility on the screen

Parameters

partName

Single or array of the names of the parts to be enforced

keyof T | readonly keyof T[]

Returns

Promise<void>

---

exists()

exists(): Promise<boolean>

Defined in: packages/core/src/drivers/ComponentDriver.ts:152

Whether the component exists/attached to the DOM

Returns

Promise<boolean>

true if the component is attached to the DOM, false otherwise

Implementation of

IComponentDriver.exists

---

focus()

focus(option?): Promise<void>

Defined in: packages/core/src/drivers/ComponentDriver.ts:192

Parameters

option?

Partial<FocusOption>

Returns

Promise<void>

---

getAttribute()

getAttribute(attributeName): Promise<Optional<string>>

Defined in: packages/core/src/drivers/ComponentDriver.ts:144

Parameters

attributeName

string

Returns

Promise<Optional<string>>

---

getMissingPartNames()

protected getMissingPartNames(partName): Promise<readonly keyof T[]>

Defined in: packages/core/src/drivers/ComponentDriver.ts:111

Get the names of parts not in the DOM

Parameters

partName

Single or array of the names of the parts to be examined

keyof T | readonly keyof T[]

Returns

Promise<readonly keyof T[]>

---

getText()

getText(): Promise<Optional<string>>

Defined in: packages/core/src/drivers/ComponentDriver.ts:140

Get the combined text content of the component

Returns

Promise<Optional<string>>

If the component exists and has content, it should return the text or otherwise undefined

Implementation of

IComponentDriver.getText

---

hover()

hover(option?): Promise<void>

Defined in: packages/core/src/drivers/ComponentDriver.ts:160

Parameters

option?

Partial<HoverOption>

Returns

Promise<void>

---

innerHTML()

innerHTML(): Promise<string>

Defined in: packages/core/src/drivers/ComponentDriver.ts:242

Get the inner HTML of the component

Returns

Promise<string>

The inner HTML of the component

---

isVisible()

isVisible(): Promise<boolean>

Defined in: packages/core/src/drivers/ComponentDriver.ts:204

Whether the component is visible. Visibility is defined that the component does not have the CSS property display: none, visibility: hidden, or opacity: 0. However this does not check whether the component is within the viewport.

Returns

Promise<boolean>

true if the component is visible, false otherwise

Implementation of

IComponentDriver.isVisible

---

mouseDown()

mouseDown(option?): Promise<void>

Defined in: packages/core/src/drivers/ComponentDriver.ts:168

Parameters

option?

Partial<MouseDownOption>

Returns

Promise<void>

---

mouseEnter()

mouseEnter(option?): Promise<void>

Defined in: packages/core/src/drivers/ComponentDriver.ts:184

Parameters

option?

Partial<MouseEnterOption>

Returns

Promise<void>

---

mouseLeave()

mouseLeave(option?): Promise<void>

Defined in: packages/core/src/drivers/ComponentDriver.ts:188

Parameters

option?

Partial<MouseLeaveOption>

Returns

Promise<void>

---

mouseMove()

mouseMove(option?): Promise<void>

Defined in: packages/core/src/drivers/ComponentDriver.ts:164

Parameters

option?

Partial<MouseMoveOption>

Returns

Promise<void>

---

mouseOut()

mouseOut(option?): Promise<void>

Defined in: packages/core/src/drivers/ComponentDriver.ts:180

Parameters

option?

Partial<MouseOutOption>

Returns

Promise<void>

---

mouseOver()

mouseOver(option?): Promise<void>

Defined in: packages/core/src/drivers/ComponentDriver.ts:176

Parameters

option?

Partial<HoverOption>

Returns

Promise<void>

---

mouseUp()

mouseUp(option?): Promise<void>

Defined in: packages/core/src/drivers/ComponentDriver.ts:172

Parameters

option?

Partial<MouseUpOption>

Returns

Promise<void>

---

overriddenParentLocator()

overriddenParentLocator(): Optional<PartLocator>

Defined in: packages/core/src/drivers/ComponentDriver.ts:61

Usually this should be undefined as the component driver corresponds to a component nested inside the parent DOM, thus the driver's locator would automatically chain with its parent's locator.

When the component is rendered outside the parent's DOM, which usually happens when the component is a modal or popup, supply the PartLocator on how to locate the component with the component's own locator.

Caution of usage: this function is called before the construction of the driver, so it should not use any instance properties

Returns

Optional<PartLocator>

---

overrideLocatorRelativePosition()

overrideLocatorRelativePosition(): Optional<LocatorRelativePosition>

Defined in: packages/core/src/drivers/ComponentDriver.ts:76

Usually this should be undefined when the locator is defined by the ScenePart, thus it reflects the natural relative position of the component

However, in some implementation such as MUI v5 dialog, the actual dialog DOM is rendered outside the parent DOM, and the selector is "siblings", by defining this function, it allows the driver to have the knowledge of the actual relative position instead of offloading the knowledge to the consumer.

Caution of usage: this function is called before the construction of the driver, so it should not use any instance properties

Returns

Optional<LocatorRelativePosition>

---

runtimeCssSelector()

runtimeCssSelector(): Promise<string>

Defined in: packages/core/src/drivers/ComponentDriver.ts:251

Get the runtime CSS selector of the component. This is useful for debugging and testing purposes.

Returns

Promise<string>

The runtime CSS selector of the component

---

waitUntil()

waitUntil<T>(option): Promise<T>

Defined in: packages/core/src/drivers/ComponentDriver.ts:234

Type Parameters

T

T

Parameters

option

WaitUntilOption<T>

Returns

Promise<T>

---

waitUntilComponentState()

waitUntilComponentState(option): Promise<void>

Defined in: packages/core/src/drivers/ComponentDriver.ts:230

Wait until the component is in the expected state such as the component's visibility or existence. If the component has not reached the expected state within the timeout, it will throw an error.

By default it waits until the component is attached to the DOM within 30 seconds.

Parameters

option

Partial<Readonly<WaitForOption>> = defaultWaitForOption

The option to configure the wait behavior

Returns

Promise<void>

Implementation of

IComponentDriver.waitUntilComponentState

---

waitUntilVisible()

waitUntilVisible(timeoutMs): Promise<void>

Defined in: packages/core/src/drivers/ComponentDriver.ts:212

Wait until the component is attached and becomes visible to the DOM.

Parameters

timeoutMs

number = 10000

The number of milliseconds to wait before timing out

Returns

Promise<void>