Class ErrorTest

A test class to help test error scopes and uncapturederror events.

Hierarchy

Fixture
- ErrorTest

Properties

_device

_device: undefined | GPUDevice = undefined

Accessors

device

get device(): GPUDevice
Returns GPUDevice
- Defined in src/webgpu/error_test.ts:11

params

get params(): unknown
Returns the (case+subcase) parameters for this test function invocation.

Returns unknown
Inherited from Fixture.params
- Defined in src/common/framework/fixture.ts:90

sharedState

get sharedState(): S
Gets the test fixture's shared state. This object is shared between subcases within the same testcase.

Returns S
Inherited from Fixture.sharedState
- Defined in src/common/framework/fixture.ts:98

Methods

chunkedPopManyErrorScopes

chunkedPopManyErrorScopes(count): Promise<void>
Pop count error scopes, and assert they all return null. Chunks the awaits so we only Promise.all 200 scopes at a time, instead of stalling on a huge Promise.all all at once. This helps Chromium's "heartbeat" mechanism know that the test is still running (and not hung).
Parameters
- count: number
Returns Promise<void>
- Defined in src/webgpu/error_test.ts:89

debug

debug(msg): void
Log a debug message.
Parameters
- msg: string | (() => string)
Returns void
Inherited from Fixture.debug
- Defined in src/common/framework/fixture.ts:204

eventualAsyncExpectation

eventualAsyncExpectation<T>(fn): void
Wraps an async function, passing it an Error object recording the original stack trace. The async work will be implicitly waited upon before reporting a test status.
Type Parameters
- T
Parameters
- fn: ((niceStack) => Promise<T>)
  - - (niceStack): Promise<T>
    - Parameters
      niceStack: Error
      Returns Promise<T>
Returns void
Inherited from Fixture.eventualAsyncExpectation
- Defined in src/common/framework/fixture.ts:257

eventualExpectOK

eventualExpectOK(error, __namedParameters?): void
Parameters
- error: Promise<undefined | Error | (undefined | Error)[]>
- __namedParameters: {
  mode?: "fail" | "warn";
  } = {}
  - Optional mode?: "fail" | "warn"
Returns void
Inherited from Fixture.eventualExpectOK
- Defined in src/common/framework/fixture.ts:410

expect

expect(cond, msg?): boolean
Expect that a condition is true.

Note: You can pass a boolean condition, or a function that returns a boolean. The advantage to passing a function is that if it's short it is self documenting.

t.expect(size >= maxSize); // prints Expect OK: t.expect(() => size >= maxSize) // prints Expect OK: () => size >= maxSize
Parameters
- cond: boolean | (() => boolean)
- Optional msg: string
Returns boolean
Inherited from Fixture.expect
- Defined in src/common/framework/fixture.ts:362

expectOK

expectOK(error, __namedParameters?): void
If the argument is an Error, fail (or warn). If it's undefined, no-op. If the argument is an array, apply the above behavior on each of elements.
Parameters
- error: undefined | Error | (undefined | Error)[]
- __namedParameters: {
  mode?: "fail" | "warn";
  niceStack?: Error;
  } = {}
  - Optional mode?: "fail" | "warn"
  - Optional niceStack?: Error
Returns void
Inherited from Fixture.expectOK
- Defined in src/common/framework/fixture.ts:382

expectUncapturedError

expectUncapturedError(fn, useOnuncapturederror?): Promise<GPUUncapturedErrorEvent>
Expect an uncapturederror event to occur. Note: this MUST be awaited, because otherwise it could erroneously pass by capturing an error from later in the test.
Parameters
- fn: Function
- useOnuncapturederror: boolean = false
Returns Promise<GPUUncapturedErrorEvent>
- Defined in src/webgpu/error_test.ts:105

fail

fail(msg?): void
Log an error and increase the result status to "ExpectFailed".
Parameters
- Optional msg: string
Returns void
Inherited from Fixture.fail
- Defined in src/common/framework/fixture.ts:238

generateError

generateError(filter): void
Generates an error of the given filter type. For now, the errors are generated by calling a known code-path to cause the error. This can be updated in the future should there be a more direct way to inject errors.
Parameters
- filter: GPUErrorFilter
Returns void
- Defined in src/webgpu/error_test.ts:39

info

info(msg): void
Log an info message. Use sparingly. Use debug() instead if logs are only needed with debug logging enabled.
Parameters
- msg: string
Returns void
Inherited from Fixture.info
- Defined in src/common/framework/fixture.ts:216

init

init(): Promise<void>
Returns Promise<void>
Overrides Fixture.init
- Defined in src/webgpu/error_test.ts:16

isInstanceOfError

isInstanceOfError(filter, error): boolean
Checks whether the error is of the type expected given the filter.
Parameters
- filter: GPUErrorFilter
- error: null | GPUError
Returns boolean
- Defined in src/webgpu/error_test.ts:72

requestDeviceTracked

requestDeviceTracked(adapter, desc?): Promise<GPUDevice>
Call requestDevice() and track the device for cleanup.
Parameters
- adapter: GPUAdapter
- desc: undefined | GPUDeviceDescriptor = undefined
Returns Promise<GPUDevice>
Inherited from Fixture.requestDeviceTracked
- Defined in src/common/framework/fixture.ts:198

shouldReject

shouldReject(expectedName, p, __namedParameters?): void
Expect that the provided promise rejects, with the provided exception name.
Parameters
- expectedName: string
- p: Promise<unknown>
- __namedParameters: ExceptionCheckOptions = {}
Returns void
Inherited from Fixture.shouldReject
- Defined in src/common/framework/fixture.ts:296

shouldResolve

shouldResolve(p, msg?): void
Expect that the provided promise resolves (fulfills).
Parameters
- p: Promise<unknown>
- Optional msg: string
Returns void
Inherited from Fixture.shouldResolve
- Defined in src/common/framework/fixture.ts:279

shouldThrow

shouldThrow(expectedError, fn, __namedParameters?): void
Expect that the provided function throws (if true or string) or not (if false). If a string is provided, expect that the throw exception has that name.

MAINTENANCE_TODO: Change to string | false so the exception name is always checked.
Parameters
- expectedError: string | boolean
- fn: (() => void)
  - - (): void
    - Returns void
- __namedParameters: ExceptionCheckOptions = {}
Returns void
Inherited from Fixture.shouldThrow
- Defined in src/common/framework/fixture.ts:326

skip

skip(msg): never
Throws an exception marking the subcase as skipped.
Parameters
- msg: string
Returns never
Inherited from Fixture.skip
- Defined in src/common/framework/fixture.ts:221

skipIf

skipIf(cond, msg?): void
Throws an exception marking the subcase as skipped if condition is true
Parameters
- cond: boolean
- msg: string | (() => string) = ''
Returns void
Inherited from Fixture.skipIf
- Defined in src/common/framework/fixture.ts:226

trackForCleanup

trackForCleanup<T>(o): T
Tracks an object to be cleaned up after the test finishes.

Usually when creating buffers/textures/query sets, you can use the helpers in GPUTest instead.
Type Parameters
- T extends DestroyableObject | Promise<DestroyableObject>
Parameters
- o: T
Returns T
Inherited from Fixture.trackForCleanup
- Defined in src/common/framework/fixture.ts:158

tryTrackForCleanup

tryTrackForCleanup<T>(o): T
Tracks an object, if it's destroyable, to be cleaned up after the test finishes.
Type Parameters
- T
Parameters
- o: T
Returns T
Inherited from Fixture.tryTrackForCleanup
- Defined in src/common/framework/fixture.ts:183

warn

warn(msg?): void
Log a warning and increase the result status to "Warn".
Parameters
- Optional msg: string
Returns void
Inherited from Fixture.warn
- Defined in src/common/framework/fixture.ts:233

`Static` MakeSharedState

MakeSharedState(recorder, params): SubcaseBatchState
Parameters
- recorder: TestCaseRecorder
- params: TestParams
Returns SubcaseBatchState
Inherited from Fixture.MakeSharedState
- Defined in src/common/framework/fixture.ts:76

Class ErrorTest

Hierarchy

Index

Properties

Accessors

Methods

Properties

_device

Accessors

device

Returns GPUDevice

params

Returns unknown

sharedState

Returns S

Methods

chunkedPopManyErrorScopes

Parameters

count: number

Returns Promise<void>

debug

Parameters

msg: string | (() => string)

Returns void

eventualAsyncExpectation

Type Parameters

T

Parameters

fn: ((niceStack) => Promise<T>)

Parameters

niceStack: Error

Returns Promise<T>

Returns void

eventualExpectOK

Parameters

error: Promise<undefined | Error | (undefined | Error)[]>

__namedParameters: { mode?: "fail" | "warn"; } = {}

Optional mode?: "fail" | "warn"

Returns void

expect

Parameters

cond: boolean | (() => boolean)

Optional msg: string

Returns boolean

expectOK

Parameters

error: undefined | Error | (undefined | Error)[]

__namedParameters: { mode?: "fail" | "warn"; niceStack?: Error; } = {}

Optional mode?: "fail" | "warn"

Optional niceStack?: Error

Returns void

expectUncapturedError

Parameters

fn: Function

useOnuncapturederror: boolean = false

Returns Promise<GPUUncapturedErrorEvent>

fail

Parameters

Optional msg: string

Returns void

generateError

Parameters

filter: GPUErrorFilter

Returns void

info

Parameters

msg: string

Returns void

init

Returns Promise<void>

isInstanceOfError

Parameters

filter: GPUErrorFilter

error: null | GPUError

Returns boolean

requestDeviceTracked

Parameters

adapter: GPUAdapter

desc: undefined | GPUDeviceDescriptor = undefined

Returns Promise<GPUDevice>

__namedParameters: {
mode?: "fail" | "warn";
} = {}

`Optional` mode?: "fail" | "warn"

`Optional` msg: string

__namedParameters: {
mode?: "fail" | "warn";
niceStack?: Error;
} = {}

`Optional` mode?: "fail" | "warn"

`Optional` niceStack?: Error

`Optional` msg: string

`Optional` msg: string

`Optional` msg: string

`Static` MakeSharedState