Class Fixture<S>

A Fixture is a class used to instantiate each test sub/case at run time. A new instance of the Fixture is created for every single test subcase (i.e. every time the test function is run).

Type Parameters

S extends SubcaseBatchState = SubcaseBatchState

Hierarchy

Fixture

Index

Accessors

params sharedState

Methods

debug eventualAsyncExpectation eventualExpectOK expect expectOK fail info requestDeviceTracked shouldReject shouldResolve shouldThrow skip skipIf trackForCleanup tryTrackForCleanup warn MakeSharedState

Accessors

params

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

Returns unknown
- 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
- Defined in src/common/framework/fixture.ts:98

Methods

debug

debug(msg): void
Log a debug message.
Parameters
- msg: string
Returns void
- 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
- Defined in src/common/framework/fixture.ts:253

eventualExpectOK

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

expect

expect(cond, msg?): boolean
Expect that a condition is true.
Parameters
- cond: boolean
- Optional msg: string
Returns boolean
- Defined in src/common/framework/fixture.ts:350

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
- Defined in src/common/framework/fixture.ts:364

fail

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

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
- Defined in src/common/framework/fixture.ts:212

requestDeviceTracked

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

shouldResolve

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

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
- Defined in src/common/framework/fixture.ts:322

skip

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

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
- Defined in src/common/framework/fixture.ts:222

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
- 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
- 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
- Defined in src/common/framework/fixture.ts:229

`Static` MakeSharedState

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

Class Fixture<S>

Type Parameters

S extends SubcaseBatchState = SubcaseBatchState

Hierarchy

Index

Accessors

Methods

Accessors

params

Returns unknown

sharedState

Returns S

Methods

debug

Parameters

msg: 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

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

fail

Parameters

Optional msg: string

Returns void

info

Parameters

msg: string

Returns void

requestDeviceTracked

Parameters

adapter: GPUAdapter

desc: undefined | GPUDeviceDescriptor = undefined

Returns Promise<GPUDevice>

shouldReject

Parameters

expectedName: string

p: Promise<unknown>

__namedParameters: ExceptionCheckOptions = {}

Returns void

shouldResolve

Parameters

p: Promise<unknown>

Optional msg: string

Returns void

shouldThrow

Parameters

expectedError: string | boolean

fn: (() => void)

Returns void

__namedParameters: ExceptionCheckOptions = {}

Returns void

skip

Parameters

msg: string

Returns never

skipIf

__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