kui_shell_test.Common.md

Kui API Documentation - v11.0.0 / @kui-shell/test / Common

Namespace: Common

@kui-shell/test.Common

Table of contents

Interfaces

• BeforeOptions
• ISuite

Variables

• expectedVersion

Functions

• after
• before
• dockerDescribe
• localDescribe
• localIt
• oops
• pDescribe
• pit
• proxyDescribe
• proxyIt
• refresh
• remoteIt
• restart
• setDebugMode

Variables

expectedVersion

• expectedVersion: string = version

non-headless targets in travis use the clients/default version

Defined in

packages/test/src/api/common.ts:577

Functions

after

▸ Const after(ctx, f?): HookFunction

This is the method that will be called when a test completes

Parameters

Name	Type
ctx	ISuite
f?	() => void

Returns

HookFunction

Defined in

packages/test/src/api/common.ts:387

---

before

▸ Const before(ctx, options?): HookFunction

This is the method that will be called before a test begins

Parameters

Name	Type
ctx	ISuite
options?	BeforeOptions

Returns

HookFunction

Defined in

packages/test/src/api/common.ts:288

---

dockerDescribe

▸ Const dockerDescribe(msg, suite): Suite

only execute the test suite in an environment that has docker

Parameters

Name	Type
msg	string
suite	() => void

Returns

Suite

Defined in

packages/test/src/api/common.ts:544

---

localDescribe

▸ Const localDescribe(msg, suite): Suite

only execute the test suite in local

Parameters

Name	Type
msg	string
suite	() => void

Returns

Suite

Defined in

packages/test/src/api/common.ts:539

---

localIt

▸ Const localIt(msg, func): Test

only execute the test in local

Parameters

Name	Type
msg	string
func	Func

Returns

Test

Defined in

packages/test/src/api/common.ts:534

---

oops

▸ Const oops(ctx, wait?): (err: Error) => Promise<unknown>

Parameters

Name	Type	Default value
ctx	ISuite	undefined
wait	boolean	false

Returns

fn

▸ (err): Promise<unknown>

Parameters

Name	Type
err	Error

Returns

Promise<unknown>

Defined in

packages/test/src/api/common.ts:430

---

pDescribe

▸ Const pDescribe(msg, suite): Suite

only execute the test suite in electron or proxy+browser clients

Parameters

Name	Type
msg	string
suite	() => void

Returns

Suite

Defined in

packages/test/src/api/common.ts:562

---

pit

▸ Const pit(msg, func): Test

only execute the test in electron or proxy+browser client

Parameters

Name	Type
msg	string
func	Func

Returns

Test

Defined in

packages/test/src/api/common.ts:572

---

proxyDescribe

▸ Const proxyDescribe(msg, suite): Suite

only execute the test suite in proxy+browser clients

Parameters

Name	Type
msg	string
suite	() => void

Returns

Suite

Defined in

packages/test/src/api/common.ts:557

---

proxyIt

▸ Const proxyIt(msg, func): Test

only execute the test in proxy+browser client

Parameters

Name	Type
msg	string
func	Func

Returns

Test

Defined in

packages/test/src/api/common.ts:567

---

refresh

▸ Const refresh(ctx, wait?, clean?): Promise<void>

reload the app

Parameters

Name	Type	Default value
ctx	ISuite	undefined
wait	boolean	true
clean	boolean	false

Returns

Promise<void>

Defined in

packages/test/src/api/common.ts:253

---

remoteIt

▸ Const remoteIt(msg, func): Test

only execute the test in non-proxy browser

Parameters

Name	Type
msg	string
func	Func

Returns

Test

Defined in

packages/test/src/api/common.ts:552

---

restart

▸ Const restart(ctx): Promise<void>

restart the app

Parameters

Name	Type
ctx	ISuite

Returns

Promise<void>

Defined in

packages/test/src/api/common.ts:234

---

setDebugMode

▸ setDebugMode(): void

Returns

void

Defined in

packages/test/src/api/common.ts:585